mirror of
https://github.com/google/nomulus.git
synced 2025-05-02 04:57: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
88 lines
3.8 KiB
Java
88 lines
3.8 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.host;
|
|
|
|
import static google.registry.model.EppResourceUtils.queryDomainsUsingResource;
|
|
import static google.registry.model.ofy.ObjectifyService.ofy;
|
|
|
|
import com.google.common.base.Predicate;
|
|
import com.google.common.collect.ImmutableMap;
|
|
import com.google.common.collect.Iterables;
|
|
import com.googlecode.objectify.Key;
|
|
import google.registry.config.RegistryEnvironment;
|
|
import google.registry.flows.EppException;
|
|
import google.registry.flows.ResourceAsyncDeleteFlow;
|
|
import google.registry.flows.async.AsyncFlowUtils;
|
|
import google.registry.flows.async.DeleteEppResourceAction;
|
|
import google.registry.flows.async.DeleteHostResourceAction;
|
|
import google.registry.model.domain.DomainBase;
|
|
import google.registry.model.host.HostCommand.Delete;
|
|
import google.registry.model.host.HostResource;
|
|
import google.registry.model.host.HostResource.Builder;
|
|
import google.registry.model.reporting.HistoryEntry;
|
|
import javax.inject.Inject;
|
|
|
|
/**
|
|
* An EPP flow that deletes a host resource.
|
|
*
|
|
* @error {@link google.registry.flows.ResourceAsyncDeleteFlow.ResourceToDeleteIsReferencedException}
|
|
* @error {@link google.registry.flows.ResourceFlowUtils.ResourceNotOwnedException}
|
|
* @error {@link google.registry.flows.ResourceMutateFlow.ResourceToMutateDoesNotExistException}
|
|
* @error {@link google.registry.flows.SingleResourceFlow.ResourceStatusProhibitsOperationException}
|
|
*/
|
|
public class HostDeleteFlow extends ResourceAsyncDeleteFlow<HostResource, Builder, Delete> {
|
|
|
|
/** In {@link #isLinkedForFailfast}, check this (arbitrary) number of resources from the query. */
|
|
private static final int FAILFAST_CHECK_COUNT = 5;
|
|
|
|
@Inject HostDeleteFlow() {}
|
|
|
|
@Override
|
|
protected boolean isLinkedForFailfast(final Key<HostResource> key) {
|
|
// Query for the first few linked domains, and if found, actually load them. The query is
|
|
// eventually consistent and so might be very stale, but the direct load will not be stale,
|
|
// just non-transactional. If we find at least one actual reference then we can reliably
|
|
// fail. If we don't find any, we can't trust the query and need to do the full mapreduce.
|
|
return Iterables.any(
|
|
ofy().load().keys(
|
|
queryDomainsUsingResource(
|
|
HostResource.class, key, now, FAILFAST_CHECK_COUNT)).values(),
|
|
new Predicate<DomainBase>() {
|
|
@Override
|
|
public boolean apply(DomainBase domain) {
|
|
return domain.getNameservers().contains(key);
|
|
}});
|
|
}
|
|
|
|
/** Enqueues a host resource deletion on the mapreduce queue. */
|
|
@Override
|
|
protected final void enqueueTasks() throws EppException {
|
|
AsyncFlowUtils.enqueueMapreduceAction(
|
|
DeleteHostResourceAction.class,
|
|
ImmutableMap.of(
|
|
DeleteEppResourceAction.PARAM_RESOURCE_KEY,
|
|
Key.create(existingResource).getString(),
|
|
DeleteEppResourceAction.PARAM_REQUESTING_CLIENT_ID,
|
|
getClientId(),
|
|
DeleteEppResourceAction.PARAM_IS_SUPERUSER,
|
|
Boolean.toString(isSuperuser)),
|
|
RegistryEnvironment.get().config().getAsyncDeleteFlowMapreduceDelay());
|
|
}
|
|
|
|
@Override
|
|
protected final HistoryEntry.Type getHistoryEntryType() {
|
|
return HistoryEntry.Type.HOST_PENDING_DELETE;
|
|
}
|
|
}
|