mirror of
https://github.com/google/nomulus.git
synced 2025-05-01 20:47:52 +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
80 lines
2.7 KiB
Java
80 lines
2.7 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.async;
|
|
|
|
import static google.registry.flows.ResourceFlowUtils.handlePendingTransferOnDelete;
|
|
|
|
import com.googlecode.objectify.Key;
|
|
import google.registry.model.contact.ContactResource;
|
|
import google.registry.model.domain.DomainBase;
|
|
import google.registry.model.reporting.HistoryEntry;
|
|
import google.registry.model.reporting.HistoryEntry.Type;
|
|
import google.registry.request.Action;
|
|
import javax.inject.Inject;
|
|
import org.joda.time.DateTime;
|
|
|
|
/**
|
|
* A mapreduce to delete the specified ContactResource, but ONLY if it is not referred to by any
|
|
* existing DomainBase entity.
|
|
*/
|
|
@Action(path = "/_dr/task/deleteContactResource")
|
|
public class DeleteContactResourceAction extends DeleteEppResourceAction<ContactResource> {
|
|
|
|
@Inject
|
|
public DeleteContactResourceAction() {
|
|
super(
|
|
new DeleteContactResourceMapper(),
|
|
new DeleteContactResourceReducer());
|
|
}
|
|
|
|
/** An async deletion mapper for {@link ContactResource}. */
|
|
public static class DeleteContactResourceMapper extends DeleteEppResourceMapper<ContactResource> {
|
|
|
|
private static final long serialVersionUID = -5904009575877950342L;
|
|
|
|
@Override
|
|
protected boolean isLinked(
|
|
DomainBase domain, Key<ContactResource> targetResourceKey) {
|
|
return domain.getReferencedContacts().contains(targetResourceKey);
|
|
}
|
|
}
|
|
|
|
/** An async deletion reducer for {@link ContactResource}. */
|
|
public static class DeleteContactResourceReducer
|
|
extends DeleteEppResourceReducer<ContactResource> {
|
|
|
|
private static final long serialVersionUID = -7633644054441045215L;
|
|
|
|
@Override
|
|
protected Type getHistoryType(boolean successfulDelete) {
|
|
return successfulDelete
|
|
? HistoryEntry.Type.CONTACT_DELETE
|
|
: HistoryEntry.Type.CONTACT_DELETE_FAILURE;
|
|
}
|
|
|
|
@Override
|
|
protected void performDeleteTasks(
|
|
ContactResource targetResource,
|
|
ContactResource deletedResource,
|
|
DateTime deletionTime,
|
|
HistoryEntry historyEntryForDelete) {
|
|
handlePendingTransferOnDelete(
|
|
targetResource,
|
|
deletedResource,
|
|
deletionTime,
|
|
historyEntryForDelete);
|
|
}
|
|
}
|
|
}
|