Add unlock fields to RegistryLocks (#408)

* Add unlock fields to RegistryLocks

This will make it easier to reason around inter-connected registry lock
objects (like when we add dependent roids). It will make it easier to
answer the question of "Have all locks associated with this host/contact
roid been unlocked?", as well as the question of "Was the last lock
object associated with this domain unlocked?"

* Responses to CR

* Make the DAO API more specific

* whoops, undo rename

core/src/main/java/google/registry/model/registry/RegistryLockDao.java

@@ -49,7 +49,7 @@ public final class RegistryLockDao {
   }
 
   /** Returns all lock objects that this registrar has created. */
-  public static ImmutableList<RegistryLock> getByRegistrarId(String registrarId) {
+  public static ImmutableList<RegistryLock> getLockedDomainsByRegistrarId(String registrarId) {
     return jpaTm()
         .transact(
             () ->
@@ -58,7 +58,9 @@ public final class RegistryLockDao {
                         .getEntityManager()
                         .createQuery(
                             "SELECT lock FROM RegistryLock lock WHERE"
-                                + " lock.registrarId = :registrarId",
+                                + " lock.registrarId = :registrarId "
+                                + "AND lock.lockCompletionTimestamp IS NOT NULL "
+                                + "AND lock.unlockCompletionTimestamp IS NULL",
                             RegistryLock.class)
                         .setParameter("registrarId", registrarId)
                         .getResultList()));

core/src/main/java/google/registry/schema/domain/RegistryLock.java

@@ -21,13 +21,12 @@ import static google.registry.util.PreconditionsUtils.checkArgumentNotNull;
 import google.registry.model.Buildable;
 import google.registry.model.CreateAutoTimestamp;
 import google.registry.model.ImmutableObject;
+import google.registry.model.UpdateAutoTimestamp;
 import google.registry.util.DateTimeUtils;
 import java.time.ZonedDateTime;
 import java.util.Optional;
 import javax.persistence.Column;
 import javax.persistence.Entity;
-import javax.persistence.EnumType;
-import javax.persistence.Enumerated;
 import javax.persistence.GeneratedValue;
 import javax.persistence.GenerationType;
 import javax.persistence.Id;
@@ -70,12 +69,6 @@ import org.joda.time.DateTime;
     })
 public final class RegistryLock extends ImmutableObject implements Buildable {
 
-  /** Describes the action taken by the user. */
-  public enum Action {
-    LOCK,
-    UNLOCK
-  }
-
   @Id
   @GeneratedValue(strategy = GenerationType.IDENTITY)
   @Column(nullable = false)
@@ -99,28 +92,26 @@ public final class RegistryLock extends ImmutableObject implements Buildable {
   /** The POC that performed the action, or null if it was a superuser. */
   private String registrarPocId;
 
-  /**
-   * Lock action is immutable and describes whether the action performed was a lock or an unlock.
-   */
-  @Enumerated(EnumType.STRING)
+  /** When the lock is first requested. */
   @Column(nullable = false)
-  private Action action;
+  private CreateAutoTimestamp lockRequestTimestamp = CreateAutoTimestamp.create(null);
 
-  /** Creation timestamp is when the lock/unlock is first requested. */
-  @Column(nullable = false)
-  private CreateAutoTimestamp creationTimestamp = CreateAutoTimestamp.create(null);
+  /** When the unlock is first requested. */
+  private ZonedDateTime unlockRequestTimestamp;
 
   /**
-   * Completion timestamp is when the user has verified the lock/unlock, when this object de facto
-   * becomes immutable. If this field is null, it means that the lock has not been verified yet (and
-   * thus not been put into effect).
+   * When the user has verified the lock. If this field is null, it means the lock has not been
+   * verified yet (and thus not been put into effect).
    */
-  private ZonedDateTime completionTimestamp;
+  private ZonedDateTime lockCompletionTimestamp;
 
   /**
-   * The user must provide the random verification code in order to complete the lock and move the
-   * status from PENDING to COMPLETED.
+   * When the user has verified the unlock of this lock. If this field is null, it means the unlock
+   * action has not been verified yet (and has not been put into effect).
    */
+  private ZonedDateTime unlockCompletionTimestamp;
+
+  /** The user must provide the random verification code in order to complete the action. */
   @Column(nullable = false)
   private String verificationCode;
 
@@ -131,6 +122,9 @@ public final class RegistryLock extends ImmutableObject implements Buildable {
   @Column(nullable = false)
   private boolean isSuperuser;
 
+  /** Time that this entity was last updated. */
+  private UpdateAutoTimestamp lastUpdateTimestamp;
+
   public String getRepoId() {
     return repoId;
   }
@@ -147,17 +141,25 @@ public final class RegistryLock extends ImmutableObject implements Buildable {
     return registrarPocId;
   }
 
-  public Action getAction() {
-    return action;
+  public DateTime getLockRequestTimestamp() {
+    return lockRequestTimestamp.getTimestamp();
   }
 
-  public DateTime getCreationTimestamp() {
-    return creationTimestamp.getTimestamp();
+  /** Returns the unlock request timestamp or null if an unlock has not been requested yet. */
+  public Optional<DateTime> getUnlockRequestTimestamp() {
+    return Optional.ofNullable(unlockRequestTimestamp).map(DateTimeUtils::toJodaDateTime);
   }
 
   /** Returns the completion timestamp, or empty if this lock has not been completed yet. */
-  public Optional<DateTime> getCompletionTimestamp() {
-    return Optional.ofNullable(completionTimestamp).map(DateTimeUtils::toJodaDateTime);
+  public Optional<DateTime> getLockCompletionTimestamp() {
+    return Optional.ofNullable(lockCompletionTimestamp).map(DateTimeUtils::toJodaDateTime);
+  }
+
+  /**
+   * Returns the unlock completion timestamp, or empty if this unlock has not been completed yet.
+   */
+  public Optional<DateTime> getUnlockCompletionTimestamp() {
+    return Optional.ofNullable(unlockCompletionTimestamp).map(DateTimeUtils::toJodaDateTime);
   }
 
   public String getVerificationCode() {
@@ -168,16 +170,16 @@ public final class RegistryLock extends ImmutableObject implements Buildable {
     return isSuperuser;
   }
 
+  public DateTime getLastUpdateTimestamp() {
+    return lastUpdateTimestamp.getTimestamp();
+  }
+
   public Long getRevisionId() {
     return revisionId;
   }
 
-  public void setCompletionTimestamp(DateTime dateTime) {
-    this.completionTimestamp = toZonedDateTime(dateTime);
-  }
-
-  public boolean isVerified() {
-    return completionTimestamp != null;
+  public boolean isLocked() {
+    return lockCompletionTimestamp != null && unlockCompletionTimestamp == null;
   }
 
   @Override
@@ -198,8 +200,7 @@ public final class RegistryLock extends ImmutableObject implements Buildable {
       checkArgumentNotNull(getInstance().repoId, "Repo ID cannot be null");
       checkArgumentNotNull(getInstance().domainName, "Domain name cannot be null");
       checkArgumentNotNull(getInstance().registrarId, "Registrar ID cannot be null");
-      checkArgumentNotNull(getInstance().action, "Action cannot be null");
-      checkArgumentNotNull(getInstance().verificationCode, "Verification codecannot be null");
+      checkArgumentNotNull(getInstance().verificationCode, "Verification code cannot be null");
       checkArgument(
           getInstance().registrarPocId != null || getInstance().isSuperuser,
           "Registrar POC ID must be provided if superuser is false");
@@ -226,18 +227,18 @@ public final class RegistryLock extends ImmutableObject implements Buildable {
       return this;
     }
 
-    public Builder setAction(Action action) {
-      getInstance().action = action;
+    public Builder setUnlockRequestTimestamp(DateTime unlockRequestTimestamp) {
+      getInstance().unlockRequestTimestamp = toZonedDateTime(unlockRequestTimestamp);
       return this;
     }
 
-    public Builder setCreationTimestamp(CreateAutoTimestamp creationTimestamp) {
-      getInstance().creationTimestamp = creationTimestamp;
+    public Builder setLockCompletionTimestamp(DateTime lockCompletionTimestamp) {
+      getInstance().lockCompletionTimestamp = toZonedDateTime(lockCompletionTimestamp);
       return this;
     }
 
-    public Builder setCompletionTimestamp(DateTime lockTimestamp) {
-      getInstance().completionTimestamp = toZonedDateTime(lockTimestamp);
+    public Builder setUnlockCompletionTimestamp(DateTime unlockCompletionTimestamp) {
+      getInstance().unlockCompletionTimestamp = toZonedDateTime(unlockCompletionTimestamp);
       return this;
     }
 

core/src/main/java/google/registry/ui/server/registrar/RegistryLockGetAction.java

@@ -149,11 +149,9 @@ public final class RegistryLockGetAction implements JsonGetAction {
   }
 
   private ImmutableList<ImmutableMap<String, ?>> getLockedDomains(String clientId) {
-    ImmutableList<RegistryLock> locks =
-        RegistryLockDao.getByRegistrarId(clientId).stream()
-            .filter(RegistryLock::isVerified)
-            .collect(toImmutableList());
-    return locks.stream().map(this::lockToMap).collect(toImmutableList());
+    return RegistryLockDao.getLockedDomainsByRegistrarId(clientId).stream()
+        .map(this::lockToMap)
+        .collect(toImmutableList());
   }
 
   private ImmutableMap<String, ?> lockToMap(RegistryLock lock) {
@@ -161,7 +159,7 @@ public final class RegistryLockGetAction implements JsonGetAction {
         FULLY_QUALIFIED_DOMAIN_NAME_PARAM,
         lock.getDomainName(),
         LOCKED_TIME_PARAM,
-        lock.getCompletionTimestamp().map(DateTime::toString).orElse(""),
+        lock.getLockCompletionTimestamp().map(DateTime::toString).orElse(""),
         LOCKED_BY_PARAM,
         lock.isSuperuser() ? "admin" : lock.getRegistrarPocId());
   }