mirror of
https://github.com/google/nomulus.git
synced 2025-05-02 13:07:50 +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
120 lines
5.3 KiB
Java
120 lines
5.3 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.index.DomainApplicationIndex.createUpdatedInstance;
|
|
import static google.registry.model.index.DomainApplicationIndex.createWithSpecifiedKeys;
|
|
import static google.registry.model.index.DomainApplicationIndex.loadActiveApplicationsByDomainName;
|
|
import static google.registry.testing.DatastoreHelper.createTld;
|
|
import static google.registry.testing.DatastoreHelper.newDomainApplication;
|
|
import static google.registry.testing.DatastoreHelper.persistResource;
|
|
import static google.registry.testing.DatastoreHelper.persistSimpleResource;
|
|
|
|
import com.google.common.collect.ImmutableSet;
|
|
import com.googlecode.objectify.Key;
|
|
import google.registry.model.EntityTestCase;
|
|
import google.registry.model.domain.DomainApplication;
|
|
import google.registry.testing.ExceptionRule;
|
|
import org.joda.time.DateTime;
|
|
import org.junit.Before;
|
|
import org.junit.Rule;
|
|
import org.junit.Test;
|
|
|
|
/** Unit tests for {@link DomainApplicationIndex}. */
|
|
public class DomainApplicationIndexTest extends EntityTestCase {
|
|
|
|
@Rule
|
|
public final ExceptionRule thrown = new ExceptionRule();
|
|
|
|
@Before
|
|
public void init() throws Exception {
|
|
createTld("com");
|
|
}
|
|
|
|
@Test
|
|
public void testFailure_create_nullReferences() {
|
|
thrown.expect(IllegalArgumentException.class, "Keys must not be null or empty.");
|
|
DomainApplicationIndex.createWithSpecifiedKeys("blah.com", null);
|
|
}
|
|
|
|
@Test
|
|
public void testFailure_create_emptyReferences() {
|
|
thrown.expect(IllegalArgumentException.class, "Keys must not be null or empty.");
|
|
createWithSpecifiedKeys("blah.com", ImmutableSet.<Key<DomainApplication>>of());
|
|
}
|
|
|
|
@Test
|
|
public void testSuccess_singleApplication() {
|
|
DomainApplication application = persistSimpleResource(newDomainApplication("example.com"));
|
|
persistResource(createUpdatedInstance(application));
|
|
DomainApplicationIndex savedIndex = DomainApplicationIndex.load("example.com");
|
|
assertThat(savedIndex).isNotNull();
|
|
assertThat(savedIndex.getKeys()).containsExactly(Key.create(application));
|
|
assertThat(loadActiveApplicationsByDomainName("example.com", DateTime.now()))
|
|
.containsExactly(application);
|
|
}
|
|
|
|
@Test
|
|
public void testSuccess_noApplications() {
|
|
assertThat(DomainApplicationIndex.load("example.com")).isNull();
|
|
assertThat(loadActiveApplicationsByDomainName("example.com", DateTime.now())).isEmpty();
|
|
}
|
|
|
|
@Test
|
|
public void testSuccess_multipleApplications() {
|
|
DomainApplication application1 = persistSimpleResource(newDomainApplication("example.com"));
|
|
DomainApplication application2 = persistSimpleResource(newDomainApplication("example.com"));
|
|
DomainApplication application3 = persistSimpleResource(newDomainApplication("example.com"));
|
|
persistResource(createUpdatedInstance(application1));
|
|
persistResource(createUpdatedInstance(application2));
|
|
persistResource(createUpdatedInstance(application3));
|
|
DomainApplicationIndex savedIndex = DomainApplicationIndex.load("example.com");
|
|
assertThat(savedIndex).isNotNull();
|
|
assertThat(savedIndex.getKeys()).containsExactly(
|
|
Key.create(application1), Key.create(application2), Key.create(application3));
|
|
assertThat(loadActiveApplicationsByDomainName("example.com", DateTime.now()))
|
|
.containsExactly(application1, application2, application3);
|
|
}
|
|
|
|
@Test
|
|
public void testSuccess_doesntStoreSameApplicationMultipleTimes() {
|
|
DomainApplication application1 = persistSimpleResource(newDomainApplication("example.com"));
|
|
DomainApplication application2 = persistSimpleResource(newDomainApplication("example.com"));
|
|
persistResource(createUpdatedInstance(application1));
|
|
persistResource(createUpdatedInstance(application2));
|
|
persistResource(createUpdatedInstance(application1));
|
|
assertThat(loadActiveApplicationsByDomainName("example.com", DateTime.now()))
|
|
.containsExactly(application1, application2);
|
|
}
|
|
|
|
@Test
|
|
public void testSuccess_doesntIncludePastApplications() {
|
|
DomainApplication application1 = persistSimpleResource(newDomainApplication("example.com"));
|
|
DomainApplication application2 =
|
|
persistSimpleResource(
|
|
newDomainApplication("example.com")
|
|
.asBuilder()
|
|
.setDeletionTime(DateTime.now().minusDays(30))
|
|
.build());
|
|
persistResource(createUpdatedInstance(application1));
|
|
persistResource(createUpdatedInstance(application2));
|
|
DomainApplicationIndex savedIndex =
|
|
DomainApplicationIndex.load(application1.getFullyQualifiedDomainName());
|
|
assertThat(savedIndex.getKeys()).hasSize(2);
|
|
assertThat(loadActiveApplicationsByDomainName("example.com", DateTime.now()))
|
|
.containsExactly(application1);
|
|
}
|
|
}
|