mirror of
https://github.com/google/nomulus.git
synced 2025-07-08 20:23:24 +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
243 lines
11 KiB
Java
243 lines
11 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.rde;
|
|
|
|
import static com.google.common.io.BaseEncoding.base16;
|
|
import static google.registry.testing.DatastoreHelper.generateNewContactHostRoid;
|
|
import static google.registry.testing.DatastoreHelper.generateNewDomainRoid;
|
|
import static google.registry.testing.DatastoreHelper.persistResource;
|
|
import static google.registry.testing.DatastoreHelper.persistResourceWithCommitLog;
|
|
import static google.registry.testing.DatastoreHelper.persistSimpleResource;
|
|
import static google.registry.util.DateTimeUtils.END_OF_TIME;
|
|
import static org.joda.money.CurrencyUnit.USD;
|
|
|
|
import com.google.common.collect.ImmutableList;
|
|
import com.google.common.collect.ImmutableSet;
|
|
import com.google.common.net.InetAddresses;
|
|
import com.googlecode.objectify.Key;
|
|
import google.registry.model.billing.BillingEvent;
|
|
import google.registry.model.billing.BillingEvent.Flag;
|
|
import google.registry.model.billing.BillingEvent.Reason;
|
|
import google.registry.model.contact.ContactAddress;
|
|
import google.registry.model.contact.ContactPhoneNumber;
|
|
import google.registry.model.contact.ContactResource;
|
|
import google.registry.model.contact.PostalInfo;
|
|
import google.registry.model.domain.DesignatedContact;
|
|
import google.registry.model.domain.DomainAuthInfo;
|
|
import google.registry.model.domain.DomainResource;
|
|
import google.registry.model.domain.GracePeriod;
|
|
import google.registry.model.domain.rgp.GracePeriodStatus;
|
|
import google.registry.model.domain.secdns.DelegationSignerData;
|
|
import google.registry.model.eppcommon.AuthInfo.PasswordAuth;
|
|
import google.registry.model.eppcommon.StatusValue;
|
|
import google.registry.model.eppcommon.Trid;
|
|
import google.registry.model.host.HostResource;
|
|
import google.registry.model.poll.PollMessage;
|
|
import google.registry.model.poll.PollMessage.Autorenew;
|
|
import google.registry.model.reporting.HistoryEntry;
|
|
import google.registry.model.transfer.TransferData;
|
|
import google.registry.model.transfer.TransferData.TransferServerApproveEntity;
|
|
import google.registry.model.transfer.TransferStatus;
|
|
import google.registry.testing.FakeClock;
|
|
import google.registry.util.Idn;
|
|
import org.joda.money.Money;
|
|
import org.joda.time.DateTime;
|
|
|
|
/** Utility class for creating {@code EppResource} entities that'll successfully marshal. */
|
|
final class RdeFixtures {
|
|
|
|
static DomainResource makeDomainResource(FakeClock clock, String tld) {
|
|
DomainResource domain = new DomainResource.Builder()
|
|
.setFullyQualifiedDomainName("example." + tld)
|
|
.setRepoId(generateNewDomainRoid(tld))
|
|
.setRegistrant(Key.create(
|
|
makeContactResource(clock,
|
|
"5372808-ERL", "(◕‿◕) nevermore", "prophet@evil.みんな")))
|
|
.build();
|
|
HistoryEntry historyEntry =
|
|
persistResource(new HistoryEntry.Builder().setParent(domain).build());
|
|
clock.advanceOneMilli();
|
|
BillingEvent.OneTime billingEvent = persistResourceWithCommitLog(
|
|
new BillingEvent.OneTime.Builder()
|
|
.setReason(Reason.CREATE)
|
|
.setTargetId("example." + tld)
|
|
.setClientId("TheRegistrar")
|
|
.setCost(Money.of(USD, 26))
|
|
.setPeriodYears(2)
|
|
.setEventTime(DateTime.parse("1910-01-01T00:00:00Z"))
|
|
.setBillingTime(DateTime.parse("1910-01-01T00:00:00Z"))
|
|
.setParent(historyEntry)
|
|
.build());
|
|
domain = domain.asBuilder()
|
|
.setAuthInfo(DomainAuthInfo.create(PasswordAuth.create("secret")))
|
|
.setContacts(ImmutableSet.of(
|
|
DesignatedContact.create(DesignatedContact.Type.ADMIN, Key.create(
|
|
makeContactResource(clock, "5372808-IRL",
|
|
"be that word our sign in parting", "BOFH@cat.みんな"))),
|
|
DesignatedContact.create(DesignatedContact.Type.TECH, Key.create(
|
|
makeContactResource(clock, "5372808-TRL",
|
|
"bird or fiend!? i shrieked upstarting", "bog@cat.みんな")))))
|
|
.setCreationClientId("TheRegistrar")
|
|
.setCurrentSponsorClientId("TheRegistrar")
|
|
.setCreationTimeForTest(clock.nowUtc())
|
|
.setDsData(ImmutableSet.of(DelegationSignerData.create(
|
|
123, 200, 230, base16().decode("1234567890"))))
|
|
.setFullyQualifiedDomainName(Idn.toASCII("love." + tld))
|
|
.setLastTransferTime(DateTime.parse("1910-01-01T00:00:00Z"))
|
|
.setLastEppUpdateClientId("IntoTheTempest")
|
|
.setLastEppUpdateTime(clock.nowUtc())
|
|
.setIdnTableName("extended_latin")
|
|
.setNameservers(ImmutableSet.of(
|
|
Key.create(
|
|
makeHostResource(clock, "bird.or.devil.みんな", "1.2.3.4")),
|
|
Key.create(
|
|
makeHostResource(
|
|
clock, "ns2.cat.みんな", "bad:f00d:cafe::15:beef"))))
|
|
.setRegistrationExpirationTime(DateTime.parse("1930-01-01T00:00:00Z"))
|
|
.setGracePeriods(ImmutableSet.of(
|
|
GracePeriod.forBillingEvent(GracePeriodStatus.RENEW,
|
|
persistResource(
|
|
new BillingEvent.OneTime.Builder()
|
|
.setReason(Reason.RENEW)
|
|
.setTargetId("love." + tld)
|
|
.setClientId("TheRegistrar")
|
|
.setCost(Money.of(USD, 456))
|
|
.setPeriodYears(2)
|
|
.setEventTime(DateTime.parse("1920-01-01T00:00:00Z"))
|
|
.setBillingTime(DateTime.parse("1920-01-01T00:00:00Z"))
|
|
.setParent(historyEntry)
|
|
.build())),
|
|
GracePeriod.create(
|
|
GracePeriodStatus.TRANSFER, DateTime.parse("1920-01-01T00:00:00Z"), "foo", null)))
|
|
.setSubordinateHosts(ImmutableSet.of("home.by.horror.haunted"))
|
|
.setStatusValues(ImmutableSet.of(
|
|
StatusValue.CLIENT_DELETE_PROHIBITED,
|
|
StatusValue.CLIENT_RENEW_PROHIBITED,
|
|
StatusValue.CLIENT_TRANSFER_PROHIBITED,
|
|
StatusValue.SERVER_UPDATE_PROHIBITED))
|
|
.setAutorenewBillingEvent(
|
|
Key.create(persistResource(
|
|
new BillingEvent.Recurring.Builder()
|
|
.setReason(Reason.RENEW)
|
|
.setFlags(ImmutableSet.of(Flag.AUTO_RENEW))
|
|
.setTargetId(tld)
|
|
.setClientId("TheRegistrar")
|
|
.setEventTime(END_OF_TIME)
|
|
.setRecurrenceEndTime(END_OF_TIME)
|
|
.setParent(historyEntry)
|
|
.build())))
|
|
.setAutorenewPollMessage(
|
|
Key.create(persistSimpleResource(
|
|
new PollMessage.Autorenew.Builder()
|
|
.setTargetId(tld)
|
|
.setClientId("TheRegistrar")
|
|
.setEventTime(END_OF_TIME)
|
|
.setAutorenewEndTime(END_OF_TIME)
|
|
.setMsg("Domain was auto-renewed.")
|
|
.setParent(historyEntry)
|
|
.build())))
|
|
.setTransferData(new TransferData.Builder()
|
|
.setExtendedRegistrationYears(1)
|
|
.setGainingClientId("gaining")
|
|
.setLosingClientId("losing")
|
|
.setPendingTransferExpirationTime(DateTime.parse("1925-04-20T00:00:00Z"))
|
|
.setServerApproveBillingEvent(Key.create(billingEvent))
|
|
.setServerApproveAutorenewEvent(
|
|
Key.create(persistResource(
|
|
new BillingEvent.Recurring.Builder()
|
|
.setReason(Reason.RENEW)
|
|
.setFlags(ImmutableSet.of(Flag.AUTO_RENEW))
|
|
.setTargetId("example." + tld)
|
|
.setClientId("TheRegistrar")
|
|
.setEventTime(END_OF_TIME)
|
|
.setRecurrenceEndTime(END_OF_TIME)
|
|
.setParent(historyEntry)
|
|
.build())))
|
|
.setServerApproveAutorenewPollMessage(Key.create(persistResource(
|
|
new Autorenew.Builder()
|
|
.setTargetId("example." + tld)
|
|
.setClientId("TheRegistrar")
|
|
.setEventTime(END_OF_TIME)
|
|
.setAutorenewEndTime(END_OF_TIME)
|
|
.setMsg("Domain was auto-renewed.")
|
|
.setParent(historyEntry)
|
|
.build())))
|
|
.setServerApproveEntities(ImmutableSet.<Key<? extends TransferServerApproveEntity>>of(
|
|
Key.create(billingEvent)))
|
|
.setTransferRequestTime(DateTime.parse("1919-01-01T00:00:00Z"))
|
|
.setTransferStatus(TransferStatus.PENDING)
|
|
.setTransferRequestTrid(Trid.create("client trid"))
|
|
.build())
|
|
.build();
|
|
clock.advanceOneMilli();
|
|
return persistResourceWithCommitLog(domain);
|
|
}
|
|
|
|
static ContactResource makeContactResource(
|
|
FakeClock clock, String id, String name, String email) {
|
|
clock.advanceOneMilli();
|
|
return persistResourceWithCommitLog(
|
|
new ContactResource.Builder()
|
|
.setContactId(id)
|
|
.setRepoId(generateNewContactHostRoid())
|
|
.setEmailAddress(email)
|
|
.setStatusValues(ImmutableSet.of(StatusValue.OK))
|
|
.setCurrentSponsorClientId("GetTheeBack")
|
|
.setCreationClientId("GetTheeBack")
|
|
.setCreationTimeForTest(clock.nowUtc())
|
|
.setInternationalizedPostalInfo(new PostalInfo.Builder()
|
|
.setType(PostalInfo.Type.INTERNATIONALIZED)
|
|
.setName(name)
|
|
.setOrg("DOGE INCORPORATED")
|
|
.setAddress(new ContactAddress.Builder()
|
|
.setStreet(ImmutableList.of("123 Example Boulevard"))
|
|
.setCity("KOKOMO")
|
|
.setState("BM")
|
|
.setZip("31337")
|
|
.setCountryCode("US")
|
|
.build())
|
|
.build())
|
|
.setVoiceNumber(
|
|
new ContactPhoneNumber.Builder()
|
|
.setPhoneNumber("+1.5558675309")
|
|
.build())
|
|
.setFaxNumber(
|
|
new ContactPhoneNumber.Builder()
|
|
.setPhoneNumber("+1.5558675310")
|
|
.build())
|
|
.build());
|
|
}
|
|
|
|
static HostResource makeHostResource(FakeClock clock, String fqhn, String ip) {
|
|
clock.advanceOneMilli();
|
|
return persistResourceWithCommitLog(
|
|
new HostResource.Builder()
|
|
.setRepoId(generateNewContactHostRoid())
|
|
.setCreationClientId("LawyerCat")
|
|
.setCreationTimeForTest(clock.nowUtc())
|
|
.setCurrentSponsorClientId("BusinessCat")
|
|
.setFullyQualifiedHostName(Idn.toASCII(fqhn))
|
|
.setInetAddresses(ImmutableSet.of(InetAddresses.forString(ip)))
|
|
.setLastTransferTime(DateTime.parse("1910-01-01T00:00:00Z"))
|
|
.setLastEppUpdateClientId("CeilingCat")
|
|
.setLastEppUpdateTime(clock.nowUtc())
|
|
.setStatusValues(ImmutableSet.of(
|
|
StatusValue.OK,
|
|
StatusValue.PENDING_UPDATE))
|
|
.build());
|
|
}
|
|
|
|
private RdeFixtures() {}
|
|
}
|