mirror of
https://github.com/google/nomulus.git
synced 2025-04-30 12:07:51 +02:00
5098b03af4
This change replaces all Ref objects in the code with Key objects. These are
stored in datastore as the same object (raw datastore keys), so this is not
a model change.
Our best practices doc says to use Keys not Refs because:
* The .get() method obscures what's actually going on
- Much harder to visually audit the code for datastore loads
- Hard to distinguish Ref<T> get()'s from Optional get()'s and Supplier get()'s
* Implicit ofy().load() offers much less control
- Antipattern for ultimate goal of making Ofy injectable
- Can't control cache use or batch loading without making ofy() explicit anyway
* Serialization behavior is surprising and could be quite dangerous/incorrect
- Can lead to serialization errors. If it actually worked "as intended",
it would lead to a Ref<> on a serialized object being replaced upon
deserialization with a stale copy of the old value, which could potentially
break all kinds of transactional expectations
* Having both Ref<T> and Key<T> introduces extra boilerplate everywhere
- E.g. helper methods all need to have Ref and Key overloads, or you need to
call .key() to get the Key<T> for every Ref<T> you want to pass in
- Creating a Ref<T> is more cumbersome, since it doesn't have all the create()
overloads that Key<T> has, only create(Key<T>) and create(Entity) - no way to
create directly from kind+ID/name, raw Key, websafe key string, etc.
(Note that Refs are treated specially by Objectify's @Load method and Keys are not;
we don't use that feature, but it is the one advantage Refs have over Keys.)
The direct impetus for this change is that I am trying to audit our use of memcache,
and the implicit .get() calls to datastore were making that very hard.
-------------
Created by MOE: https://github.com/google/moe
MOE_MIGRATED_REVID=131965491
84 lines
3.2 KiB
Java
84 lines
3.2 KiB
Java
// Copyright 2016 The Domain Registry Authors. All Rights Reserved.
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
package google.registry.flows;
|
|
|
|
import static google.registry.model.eppoutput.Result.Code.SuccessWithActionPending;
|
|
import static google.registry.model.ofy.ObjectifyService.ofy;
|
|
|
|
import com.googlecode.objectify.Key;
|
|
import com.googlecode.objectify.Work;
|
|
import google.registry.flows.EppException.AssociationProhibitsOperationException;
|
|
import google.registry.model.EppResource;
|
|
import google.registry.model.EppResource.Builder;
|
|
import google.registry.model.eppcommon.StatusValue;
|
|
import google.registry.model.eppinput.ResourceCommand.SingleResourceCommand;
|
|
import google.registry.model.eppoutput.Result.Code;
|
|
import google.registry.model.index.ForeignKeyIndex;
|
|
|
|
/**
|
|
* An EPP flow that deletes a resource asynchronously (i.e. via mapreduce).
|
|
*
|
|
* @param <R> the resource type being changed
|
|
* @param <B> a builder for the resource
|
|
* @param <C> the command type, marshalled directly from the epp xml
|
|
*/
|
|
public abstract class ResourceAsyncDeleteFlow
|
|
<R extends EppResource, B extends Builder<R, ?>, C extends SingleResourceCommand>
|
|
extends ResourceDeleteFlow<R, C> {
|
|
|
|
@Override
|
|
public void failfast() throws ResourceToDeleteIsReferencedException {
|
|
// Enter a transactionless context briefly.
|
|
boolean isLinked = ofy().doTransactionless(new Work<Boolean>() {
|
|
@Override
|
|
public Boolean run() {
|
|
ForeignKeyIndex<R> fki = ForeignKeyIndex.load(resourceClass, targetId, now);
|
|
if (fki == null) {
|
|
// Don't failfast on non-existence. We could, but that would duplicate code paths in a way
|
|
// that would be hard to reason about, and there's no real gain in doing so.
|
|
return false;
|
|
}
|
|
return isLinkedForFailfast(fki.getResourceKey());
|
|
}
|
|
});
|
|
if (isLinked) {
|
|
throw new ResourceToDeleteIsReferencedException();
|
|
}
|
|
}
|
|
|
|
/** Subclasses must override this to check if the supplied key has incoming links. */
|
|
protected abstract boolean isLinkedForFailfast(Key<R> key);
|
|
|
|
@Override
|
|
protected final R createOrMutateResource() {
|
|
@SuppressWarnings("unchecked")
|
|
B builder = (B) existingResource.asBuilder().addStatusValue(StatusValue.PENDING_DELETE);
|
|
return builder.build();
|
|
}
|
|
|
|
/** Subclasses can override this to return a different success result code. */
|
|
@Override
|
|
protected Code getDeleteResultCode() {
|
|
return SuccessWithActionPending;
|
|
}
|
|
|
|
/** Resource to be deleted has active incoming references. */
|
|
public static class ResourceToDeleteIsReferencedException
|
|
extends AssociationProhibitsOperationException {
|
|
public ResourceToDeleteIsReferencedException() {
|
|
super("Resource to be deleted has active incoming references");
|
|
}
|
|
}
|
|
}
|