Refactor update snapshot view servlet into a Daggerized Action

------------- Created by MOE: https://github.com/google/moe MOE_MIGRATED_REVID=120224051
2025-05-20 11:19:35 +02:00 · 2016-04-19 06:47:25 -07:00 · 2016-04-19 06:47:25 -07:00 · c5d09227c5
commit c5d09227c5
parent 4fbf613955
8 changed files with 68 additions and 121 deletions
--- a/java/com/google/domain/registry/export/UpdateSnapshotViewAction.java
+++ b/java/com/google/domain/registry/export/UpdateSnapshotViewAction.java
@ -0,0 +1,113 @@
+// 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 com.google.domain.registry.export;
+import static com.google.domain.registry.request.Action.Method.POST;
+
+import com.google.api.client.googleapis.json.GoogleJsonResponseException;
+import com.google.api.services.bigquery.Bigquery;
+import com.google.api.services.bigquery.model.Table;
+import com.google.api.services.bigquery.model.TableReference;
+import com.google.api.services.bigquery.model.ViewDefinition;
+import com.google.appengine.api.taskqueue.TaskOptions;
+import com.google.appengine.api.taskqueue.TaskOptions.Method;
+import com.google.domain.registry.bigquery.BigqueryFactory;
+import com.google.domain.registry.config.RegistryEnvironment;
+import com.google.domain.registry.request.Action;
+import com.google.domain.registry.request.Parameter;
+import com.google.domain.registry.util.FormattingLogger;
+import com.google.domain.registry.util.SqlTemplate;
+
+import java.io.IOException;
+
+import javax.inject.Inject;
+
+/** Update a well-known view to point at a certain datastore snapshot table in BigQuery. */
+@Action(path = UpdateSnapshotViewAction.PATH, method = POST)
+public class UpdateSnapshotViewAction implements Runnable {
+
+  private static final RegistryEnvironment ENVIRONMENT = RegistryEnvironment.get();
+
+  /** Headers for passing parameters into the servlet. */
+  static final String SNAPSHOT_DATASET_ID_PARAM = "dataset";
+  static final String SNAPSHOT_TABLE_ID_PARAM = "table";
+  static final String SNAPSHOT_KIND_PARAM = "kind";
+
+  /** Servlet-specific details needed for enqueuing tasks against itself. */
+  static final String QUEUE = "export-snapshot-update-view";  // See queue.xml.
+  static final String PATH = "/_dr/task/updateSnapshotView";  // See web.xml.
+
+  private static final FormattingLogger logger = FormattingLogger.getLoggerForCallerClass();
+
+  @Inject @Parameter(SNAPSHOT_DATASET_ID_PARAM) String datasetId;
+  @Inject @Parameter(SNAPSHOT_TABLE_ID_PARAM) String tableId;
+  @Inject @Parameter(SNAPSHOT_KIND_PARAM) String kindName;
+  @Inject BigqueryFactory bigqueryFactory;
+  @Inject UpdateSnapshotViewAction() {}
+
+  /** Create a task for updating a snapshot view.  */
+  public static TaskOptions createViewUpdateTask(
+      String datasetId, String tableId, String kindName) {
+    return TaskOptions.Builder.withUrl(PATH)
+        .method(Method.POST)
+        .param(SNAPSHOT_DATASET_ID_PARAM, datasetId)
+        .param(SNAPSHOT_TABLE_ID_PARAM, tableId)
+        .param(SNAPSHOT_KIND_PARAM, kindName);
+  }
+
+  @Override
+  public void run() {
+    try {
+      updateSnapshotView(datasetId, tableId, kindName);
+    } catch (Throwable e) {
+      throw new RuntimeException("Error in update snapshot view action.", e);
+    }
+  }
+
+  private void updateSnapshotView(String datasetId, String tableId, String kindName)
+      throws IOException {
+    String projectId = ENVIRONMENT.config().getProjectId();
+    Bigquery bigquery =
+        bigqueryFactory.create(projectId, ENVIRONMENT.config().getLatestSnapshotDataset());
+
+    updateTable(bigquery, new Table()
+        .setTableReference(new TableReference()
+            .setProjectId(projectId)
+            .setDatasetId(ENVIRONMENT.config().getLatestSnapshotDataset())
+            .setTableId(kindName))
+        .setView(new ViewDefinition().setQuery(
+            SqlTemplate.create("SELECT * FROM [%DATASET%.%TABLE%]")
+                .put("DATASET", datasetId)
+                .put("TABLE", tableId)
+                .build())));
+
+    String message = String.format(
+        "Updated view %s:%s to point at snapshot table %s:%s.",
+        ENVIRONMENT.config().getLatestSnapshotDataset(), kindName, datasetId, tableId);
+    logger.info(message);
+  }
+
+  private static void updateTable(Bigquery bigquery, Table table) throws IOException {
+    TableReference ref = table.getTableReference();
+    try {
+      bigquery.tables()
+          .update(ref.getProjectId(), ref.getDatasetId(), ref.getTableId(), table)
+          .execute();
+    } catch (GoogleJsonResponseException e) {
+      if (e.getDetails().getCode() == 404) {
+        bigquery.tables().insert(ref.getProjectId(), ref.getDatasetId(), table).execute();
+      }
+    }
+  }
+}