Add asynchronous scheduled actions to re-save entities

This is used in the domain transfer and delete flows, both of which are
asynchronous flows that have implicit default actions that will be taken at some
point in the future. This CL adds scheduled re-saves to take place soon after
those default actions would become effective, so that they can be re-saved
quickly if so.

Unfortunately the redemption grace period on our TLDs is 35 days, which exceeds
the 30 day maximum task ETA in App Engine, so these won't actually fire.  That's
fine though; the deletion is actually effective as of 5 days, and this is just
removing the grace period.

-------------
Created by MOE: https://github.com/google/moe
MOE_MIGRATED_REVID=201345274

java/google/registry/batch/BatchModule.java

@@ -14,19 +14,26 @@
 
 package google.registry.batch;
 
+import static google.registry.flows.async.AsyncFlowEnqueuer.PARAM_REQUESTED_TIME;
+import static google.registry.flows.async.AsyncFlowEnqueuer.PARAM_RESOURCE_KEY;
 import static google.registry.request.RequestParameters.extractOptionalBooleanParameter;
 import static google.registry.request.RequestParameters.extractOptionalIntParameter;
 import static google.registry.request.RequestParameters.extractOptionalParameter;
+import static google.registry.request.RequestParameters.extractRequiredDatetimeParameter;
+import static google.registry.request.RequestParameters.extractRequiredParameter;
 
 import com.google.api.services.bigquery.model.TableFieldSchema;
 import com.google.common.collect.ImmutableList;
+import com.googlecode.objectify.Key;
 import dagger.Module;
 import dagger.Provides;
 import dagger.multibindings.IntoMap;
 import dagger.multibindings.StringKey;
+import google.registry.model.ImmutableObject;
 import google.registry.request.Parameter;
 import java.util.Optional;
 import javax.servlet.http.HttpServletRequest;
+import org.joda.time.DateTime;
 
 /**
  * Dagger module for injecting common settings for batch actions.
@@ -70,4 +77,16 @@ public class BatchModule {
   static Optional<Boolean> provideForce(HttpServletRequest req) {
     return extractOptionalBooleanParameter(req, "force");
   }
+
+  @Provides
+  @Parameter(PARAM_RESOURCE_KEY)
+  static Key<ImmutableObject> provideResourceKey(HttpServletRequest req) {
+    return Key.create(extractRequiredParameter(req, PARAM_RESOURCE_KEY));
+  }
+
+  @Provides
+  @Parameter(PARAM_REQUESTED_TIME)
+  static DateTime provideRequestedTime(HttpServletRequest req) {
+    return extractRequiredDatetimeParameter(req, PARAM_REQUESTED_TIME);
+  }
 }

java/google/registry/batch/ResaveEntityAction.java

@@ -0,0 +1,74 @@
+// Copyright 2018 The Nomulus 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.batch;
+
+import static google.registry.flows.async.AsyncFlowEnqueuer.PARAM_REQUESTED_TIME;
+import static google.registry.flows.async.AsyncFlowEnqueuer.PARAM_RESOURCE_KEY;
+import static google.registry.model.ofy.ObjectifyService.ofy;
+
+import com.google.common.flogger.FluentLogger;
+import com.googlecode.objectify.Key;
+import google.registry.model.EppResource;
+import google.registry.model.ImmutableObject;
+import google.registry.request.Action;
+import google.registry.request.Action.Method;
+import google.registry.request.Parameter;
+import google.registry.request.Response;
+import google.registry.request.auth.Auth;
+import google.registry.util.Clock;
+import javax.inject.Inject;
+import org.joda.time.DateTime;
+
+/**
+ * An action that re-saves a given entity, typically after a certain amount of time has passed.
+ *
+ * <p>{@link EppResource}s will be projected forward to the current time.
+ */
+@Action(path = "/_dr/task/resaveEntity", auth = Auth.AUTH_INTERNAL_OR_ADMIN, method = Method.POST)
+public class ResaveEntityAction implements Runnable {
+
+  private static final FluentLogger logger = FluentLogger.forEnclosingClass();
+
+  private final Key<ImmutableObject> resourceKey;
+  private final DateTime requestedTime;
+  private final Clock clock;
+  private final Response response;
+
+  @Inject
+  ResaveEntityAction(
+      @Parameter(PARAM_RESOURCE_KEY) Key<ImmutableObject> resourceKey,
+      @Parameter(PARAM_REQUESTED_TIME) DateTime requestedTime,
+      Clock clock,
+      Response response) {
+    this.resourceKey = resourceKey;
+    this.requestedTime = requestedTime;
+    this.clock = clock;
+    this.response = response;
+  }
+
+  @Override
+  public void run() {
+    logger.atInfo().log(
+        "Re-saving entity %s which was enqueued at %s.", resourceKey, requestedTime);
+    ofy().transact(() -> {
+      ImmutableObject entity = ofy().load().key(resourceKey).now();
+      ofy().save().entity(
+          (entity instanceof EppResource)
+              ? ((EppResource) entity).cloneProjectedAtTime(clock.nowUtc()) : entity
+      );
+    });
+    response.setPayload("Entity re-saved.");
+  }
+}

java/google/registry/env/common/backend/WEB-INF/web.xml

@@ -298,6 +298,12 @@
     <url-pattern>/_dr/task/resaveAllEppResources</url-pattern>
   </servlet-mapping>
 
+  <!--  Action to re-save a given entity. -->
+  <servlet-mapping>
+    <servlet-name>backend-servlet</servlet-name>
+    <url-pattern>/_dr/task/resaveEntity</url-pattern>
+  </servlet-mapping>
+
   <!--
     Deletes contacts and hosts enqueued for asynchronous deletion if they are
     not referenced by any domain.

java/google/registry/env/common/default/WEB-INF/queue.xml

@@ -212,6 +212,13 @@
     </retry-parameters>
   </queue>
 
+  <!-- Queue for async actions that should be run at some point in the future. -->
+  <queue>
+    <name>async-actions</name>
+    <rate>1/s</rate>
+    <max-concurrent-requests>5</max-concurrent-requests>
+  </queue>
+
   <!-- The load[0-9] queues are used for load-testing, and can be safely deleted
        in any environment that doesn't require load-testing. -->
   <queue>

java/google/registry/flows/async/AsyncFlowEnqueuer.java

@@ -14,6 +14,10 @@
 
 package google.registry.flows.async;
 
+import static com.google.common.base.Preconditions.checkArgument;
+import static google.registry.util.DateTimeUtils.isBeforeOrAt;
+
+import com.google.appengine.api.modules.ModulesService;
 import com.google.appengine.api.taskqueue.Queue;
 import com.google.appengine.api.taskqueue.TaskOptions;
 import com.google.appengine.api.taskqueue.TaskOptions.Method;
@@ -23,6 +27,7 @@ import com.google.common.flogger.FluentLogger;
 import com.googlecode.objectify.Key;
 import google.registry.config.RegistryConfig.Config;
 import google.registry.model.EppResource;
+import google.registry.model.ImmutableObject;
 import google.registry.model.eppcommon.Trid;
 import google.registry.model.host.HostResource;
 import google.registry.util.Retrier;
@@ -44,29 +49,62 @@ public final class AsyncFlowEnqueuer {
   public static final String PARAM_REQUESTED_TIME = "requestedTime";
 
   /** The task queue names used by async flows. */
+  public static final String QUEUE_ASYNC_ACTIONS = "async-actions";
   public static final String QUEUE_ASYNC_DELETE = "async-delete-pull";
   public static final String QUEUE_ASYNC_HOST_RENAME = "async-host-rename-pull";
 
+  public static final String PATH_RESAVE_ENTITY = "/_dr/task/resaveEntity";
+
   private static final FluentLogger logger = FluentLogger.forEnclosingClass();
+  private static final Duration MAX_ASYNC_ETA = Duration.standardDays(30);
 
   private final Duration asyncDeleteDelay;
+  private final Queue asyncActionsPushQueue;
   private final Queue asyncDeletePullQueue;
   private final Queue asyncDnsRefreshPullQueue;
+  private final ModulesService modulesService;
   private final Retrier retrier;
 
   @VisibleForTesting
   @Inject
   public AsyncFlowEnqueuer(
+      @Named(QUEUE_ASYNC_ACTIONS) Queue asyncActionsPushQueue,
       @Named(QUEUE_ASYNC_DELETE) Queue asyncDeletePullQueue,
       @Named(QUEUE_ASYNC_HOST_RENAME) Queue asyncDnsRefreshPullQueue,
       @Config("asyncDeleteFlowMapreduceDelay") Duration asyncDeleteDelay,
+      ModulesService modulesService,
       Retrier retrier) {
+    this.asyncActionsPushQueue = asyncActionsPushQueue;
     this.asyncDeletePullQueue = asyncDeletePullQueue;
     this.asyncDnsRefreshPullQueue = asyncDnsRefreshPullQueue;
     this.asyncDeleteDelay = asyncDeleteDelay;
+    this.modulesService = modulesService;
     this.retrier = retrier;
   }
 
+  /** Enqueues a task to asynchronously re-save an entity at some point in the future. */
+  public void enqueueAsyncResave(
+      ImmutableObject entityToResave, DateTime now, DateTime whenToResave) {
+    checkArgument(isBeforeOrAt(now, whenToResave), "Can't enqueue a resave to run in the past");
+    Key<ImmutableObject> entityKey = Key.create(entityToResave);
+    Duration etaDuration = new Duration(now, whenToResave);
+    if (etaDuration.isLongerThan(MAX_ASYNC_ETA)) {
+      logger.atInfo().log("Ignoring async re-save of %s; %s is past the ETA threshold of %s.",
+          entityKey, whenToResave, MAX_ASYNC_ETA);
+      return;
+    }
+    logger.atInfo().log("Enqueuing async re-save of %s to run at %s.", entityKey, whenToResave);
+    String backendHostname = modulesService.getVersionHostname("backend", null);
+    TaskOptions task =
+        TaskOptions.Builder.withUrl(PATH_RESAVE_ENTITY)
+            .method(Method.POST)
+            .header("Host", backendHostname)
+            .countdownMillis(etaDuration.getMillis())
+            .param(PARAM_RESOURCE_KEY, entityKey.getString())
+            .param(PARAM_REQUESTED_TIME, now.toString());
+    addTaskToQueueWithRetry(asyncActionsPushQueue, task);
+  }
+
   /** Enqueues a task to asynchronously delete a contact or host, by key. */
   public void enqueueAsyncDelete(
       EppResource resourceToDelete,

java/google/registry/flows/async/AsyncFlowsModule.java

@@ -14,11 +14,12 @@
 
 package google.registry.flows.async;
 
+import static com.google.appengine.api.taskqueue.QueueFactory.getQueue;
+import static google.registry.flows.async.AsyncFlowEnqueuer.QUEUE_ASYNC_ACTIONS;
 import static google.registry.flows.async.AsyncFlowEnqueuer.QUEUE_ASYNC_DELETE;
 import static google.registry.flows.async.AsyncFlowEnqueuer.QUEUE_ASYNC_HOST_RENAME;
 
 import com.google.appengine.api.taskqueue.Queue;
-import com.google.appengine.api.taskqueue.QueueFactory;
 import dagger.Module;
 import dagger.Provides;
 import javax.inject.Named;
@@ -27,15 +28,21 @@ import javax.inject.Named;
 @Module
 public final class AsyncFlowsModule {
 
+  @Provides
+  @Named(QUEUE_ASYNC_ACTIONS)
+  static Queue provideAsyncActionsPushQueue() {
+    return getQueue(QUEUE_ASYNC_ACTIONS);
+  }
+
   @Provides
   @Named(QUEUE_ASYNC_DELETE)
   static Queue provideAsyncDeletePullQueue() {
-    return QueueFactory.getQueue(QUEUE_ASYNC_DELETE);
+    return getQueue(QUEUE_ASYNC_DELETE);
   }
 
   @Provides
   @Named(QUEUE_ASYNC_HOST_RENAME)
   static Queue provideAsyncHostRenamePullQueue() {
-    return QueueFactory.getQueue(QUEUE_ASYNC_HOST_RENAME);
+    return getQueue(QUEUE_ASYNC_HOST_RENAME);
   }
 }

java/google/registry/flows/domain/DomainDeleteFlow.java

@@ -51,6 +51,7 @@ import google.registry.flows.FlowModule.TargetId;
 import google.registry.flows.SessionMetadata;
 import google.registry.flows.TransactionalFlow;
 import google.registry.flows.annotations.ReportingSpec;
+import google.registry.flows.async.AsyncFlowEnqueuer;
 import google.registry.flows.custom.DomainDeleteFlowCustomLogic;
 import google.registry.flows.custom.DomainDeleteFlowCustomLogic.AfterValidationParameters;
 import google.registry.flows.custom.DomainDeleteFlowCustomLogic.BeforeResponseParameters;
@@ -127,6 +128,7 @@ public final class DomainDeleteFlow implements TransactionalFlow {
   @Inject HistoryEntry.Builder historyBuilder;
   @Inject DnsQueue dnsQueue;
   @Inject Trid trid;
+  @Inject AsyncFlowEnqueuer asyncFlowEnqueuer;
   @Inject EppResponse.Builder responseBuilder;
   @Inject DomainDeleteFlowCustomLogic flowCustomLogic;
   @Inject DomainDeleteFlow() {}
@@ -179,16 +181,19 @@ public final class DomainDeleteFlow implements TransactionalFlow {
       builder.setDeletionTime(now).setStatusValues(null);
     } else {
       DateTime deletionTime = now.plus(durationUntilDelete);
+      DateTime redemptionTime = now.plus(redemptionGracePeriodLength);
       PollMessage.OneTime deletePollMessage =
           createDeletePollMessage(existingDomain, historyEntry, deletionTime);
       entitiesToSave.add(deletePollMessage);
+      asyncFlowEnqueuer.enqueueAsyncResave(existingDomain, now, deletionTime);
+      asyncFlowEnqueuer.enqueueAsyncResave(existingDomain, now, redemptionTime);
       builder.setDeletionTime(deletionTime)
           .setStatusValues(ImmutableSet.of(StatusValue.PENDING_DELETE))
           // Clear out all old grace periods and add REDEMPTION, which does not include a key to a
           // billing event because there isn't one for a domain delete.
           .setGracePeriods(ImmutableSet.of(GracePeriod.createWithoutBillingEvent(
               GracePeriodStatus.REDEMPTION,
-              now.plus(redemptionGracePeriodLength),
+              redemptionTime,
               clientId)))
           .setDeletePollMessage(Key.create(deletePollMessage));
       // Note: The expiration time is unchanged, so if it's before the new deletion time, there will

java/google/registry/flows/domain/DomainTransferRequestFlow.java

@@ -42,6 +42,7 @@ import google.registry.flows.FlowModule.Superuser;
 import google.registry.flows.FlowModule.TargetId;
 import google.registry.flows.TransactionalFlow;
 import google.registry.flows.annotations.ReportingSpec;
+import google.registry.flows.async.AsyncFlowEnqueuer;
 import google.registry.flows.exceptions.AlreadyPendingTransferException;
 import google.registry.flows.exceptions.InvalidTransferPeriodValueException;
 import google.registry.flows.exceptions.ObjectAlreadySponsoredException;
@@ -125,6 +126,7 @@ public final class DomainTransferRequestFlow implements TransactionalFlow {
   @Inject @Superuser boolean isSuperuser;
   @Inject HistoryEntry.Builder historyBuilder;
   @Inject Trid trid;
+  @Inject AsyncFlowEnqueuer asyncFlowEnqueuer;
   @Inject EppResponse.Builder responseBuilder;
   @Inject DomainPricingLogic pricingLogic;
   @Inject DomainTransferRequestFlow() {}
@@ -224,6 +226,7 @@ public final class DomainTransferRequestFlow implements TransactionalFlow {
         .setTransferData(pendingTransferData)
         .addStatusValue(StatusValue.PENDING_TRANSFER)
         .build();
+    asyncFlowEnqueuer.enqueueAsyncResave(newDomain, now, automaticTransferTime);
     ofy().save()
         .entities(new ImmutableSet.Builder<>()
             .add(newDomain, historyEntry, requestPollMessage)