mirror of
https://github.com/google/nomulus
synced 2026-08-20 14:16:19 +00:00
cgoldfederandBen McIlwain
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
76 lines
2.9 KiB
Java
76 lines
2.9 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.model.index;
|
|
|
|
import static com.google.common.truth.Truth.assertThat;
|
|
import static google.registry.model.ofy.ObjectifyService.ofy;
|
|
import static google.registry.testing.DatastoreHelper.createTld;
|
|
import static google.registry.testing.DatastoreHelper.persistActiveContact;
|
|
import static google.registry.testing.DatastoreHelper.persistResource;
|
|
|
|
import com.google.common.collect.ImmutableList;
|
|
import com.google.common.collect.Iterables;
|
|
import com.googlecode.objectify.Key;
|
|
import google.registry.config.RegistryEnvironment;
|
|
import google.registry.model.EntityTestCase;
|
|
import google.registry.model.contact.ContactResource;
|
|
import org.junit.Before;
|
|
import org.junit.Test;
|
|
|
|
/** Unit tests for {@link EppResourceIndex}. */
|
|
public class EppResourceIndexTest extends EntityTestCase {
|
|
|
|
ContactResource contact;
|
|
|
|
@Before
|
|
public void setUp() throws Exception {
|
|
createTld("tld");
|
|
// The DatastoreHelper here creates the EppResourceIndex for us.
|
|
contact = persistActiveContact("abcd1357");
|
|
}
|
|
|
|
@Test
|
|
public void testPersistence() throws Exception {
|
|
EppResourceIndex loadedIndex = Iterables.getOnlyElement(getEppResourceIndexObjects());
|
|
assertThat(ofy().load().key(loadedIndex.reference).now()).isEqualTo(contact);
|
|
}
|
|
|
|
@Test
|
|
public void testIndexing() throws Exception {
|
|
verifyIndexing(Iterables.getOnlyElement(getEppResourceIndexObjects()), "kind");
|
|
}
|
|
|
|
@Test
|
|
public void testIdempotentOnUpdate() throws Exception {
|
|
contact = persistResource(contact.asBuilder().setEmailAddress("abc@def.fake").build());
|
|
EppResourceIndex loadedIndex = Iterables.getOnlyElement(getEppResourceIndexObjects());
|
|
assertThat(ofy().load().key(loadedIndex.reference).now()).isEqualTo(contact);
|
|
}
|
|
|
|
/**
|
|
* Returns all EppResourceIndex objects across all buckets.
|
|
*/
|
|
private ImmutableList<EppResourceIndex> getEppResourceIndexObjects() {
|
|
int numBuckets = RegistryEnvironment.get().config().getEppResourceIndexBucketCount();
|
|
ImmutableList.Builder<EppResourceIndex> indexEntities = ImmutableList.builder();
|
|
for (int i = 0; i < numBuckets; i++) {
|
|
indexEntities.addAll(ofy().load()
|
|
.type(EppResourceIndex.class)
|
|
.ancestor(Key.create(EppResourceIndexBucket.class, i + 1)));
|
|
}
|
|
return indexEntities.build();
|
|
}
|
|
}
|