Refactor EppMetrics into the EppMetric value type

This change refactors EppMetrics from the mutable self-exporting thing that it
was into a real value type EppMetric, and delegates exporting functionality to the
BigQueryMetricsEnqueuer.

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

javatests/google/registry/flows/EppControllerTest.java

@@ -26,7 +26,8 @@ import google.registry.model.eppoutput.EppOutput;
 import google.registry.model.eppoutput.EppResponse;
 import google.registry.model.eppoutput.Result;
 import google.registry.model.eppoutput.Result.Code;
-import google.registry.monitoring.whitebox.EppMetrics;
+import google.registry.monitoring.whitebox.BigQueryMetricsEnqueuer;
+import google.registry.monitoring.whitebox.EppMetric;
 import google.registry.testing.AppEngineRule;
 import google.registry.testing.FakeClock;
 import google.registry.testing.ShardableTestCase;
@@ -49,7 +50,9 @@ public class EppControllerTest extends ShardableTestCase {
 
   @Mock SessionMetadata sessionMetadata;
   @Mock TransportCredentials transportCredentials;
-  @Mock EppMetrics eppMetrics;
+  @Mock EppMetric.Builder eppMetricBuilder;
+  @Mock EppMetric eppMetric;
+  @Mock BigQueryMetricsEnqueuer metricsEnqueuer;
   @Mock FlowComponent.Builder flowComponentBuilder;
   @Mock FlowComponent flowComponent;
   @Mock FlowRunner flowRunner;
@@ -71,9 +74,11 @@ public class EppControllerTest extends ShardableTestCase {
     when(eppOutput.getResponse()).thenReturn(eppResponse);
     when(eppResponse.getResult()).thenReturn(result);
     when(result.getCode()).thenReturn(Code.SuccessWithNoMessages);
+    when(eppMetricBuilder.build()).thenReturn(eppMetric);
 
     eppController = new EppController();
-    eppController.metrics = eppMetrics;
+    eppController.metric = eppMetricBuilder;
+    eppController.bigQueryMetricsEnqueuer = metricsEnqueuer;
     eppController.clock = new FakeClock();
     eppController.flowComponentBuilder = flowComponentBuilder;
   }
@@ -96,10 +101,11 @@ public class EppControllerTest extends ShardableTestCase {
         false,
         new byte[0]);
 
-    verify(eppMetrics).setClientId("foo");
-    verify(eppMetrics).setPrivilegeLevel("NORMAL");
-    verify(eppMetrics).setEppStatus(Code.SyntaxError);
-    verify(eppMetrics).export();
+    verify(eppMetricBuilder).setClientId("foo");
+    verify(eppMetricBuilder).setPrivilegeLevel("NORMAL");
+    verify(eppMetricBuilder).setStatus(Code.SyntaxError);
+    verify(eppMetricBuilder).build();
+    verify(metricsEnqueuer).export(eppMetric);
   }
 
   @Test
@@ -115,11 +121,12 @@ public class EppControllerTest extends ShardableTestCase {
         true,
         domainCreateXml.getBytes(UTF_8));
 
-    verify(eppMetrics).setClientId("foo");
-    verify(eppMetrics).setPrivilegeLevel("SUPERUSER");
-    verify(eppMetrics).setEppStatus(Code.SuccessWithNoMessages);
-    verify(eppMetrics).setCommandName("Create");
-    verify(eppMetrics).setEppTarget("example.tld");
-    verify(eppMetrics).export();
+    verify(eppMetricBuilder).setClientId("foo");
+    verify(eppMetricBuilder).setPrivilegeLevel("SUPERUSER");
+    verify(eppMetricBuilder).setStatus(Code.SuccessWithNoMessages);
+    verify(eppMetricBuilder).setCommandName("Create");
+    verify(eppMetricBuilder).setEppTarget("example.tld");
+    verify(eppMetricBuilder).build();
+    verify(metricsEnqueuer).export(eppMetric);
   }
 }

javatests/google/registry/flows/EppTestComponent.java

@@ -16,11 +16,13 @@ package google.registry.flows;
 
 import static org.mockito.Mockito.mock;
 
+import com.google.appengine.api.modules.ModulesService;
 import dagger.Component;
 import dagger.Module;
 import dagger.Provides;
 import dagger.Subcomponent;
-import google.registry.monitoring.whitebox.EppMetrics;
+import google.registry.monitoring.whitebox.BigQueryMetricsEnqueuer;
+import google.registry.monitoring.whitebox.EppMetric;
 import google.registry.request.RequestScope;
 import google.registry.testing.FakeClock;
 import google.registry.util.Clock;
@@ -40,11 +42,15 @@ interface EppTestComponent {
   @Module
   static class FakesAndMocksModule {
     final FakeClock clock;
-    final EppMetrics metrics;
+    final EppMetric.Builder metrics;
+    final BigQueryMetricsEnqueuer metricsEnqueuer;
+    final ModulesService modulesService;
 
     FakesAndMocksModule(FakeClock clock) {
       this.clock = clock;
-      this.metrics = mock(EppMetrics.class);
+      this.metrics = mock(EppMetric.Builder.class);
+      this.modulesService = mock(ModulesService.class);
+      this.metricsEnqueuer = mock(BigQueryMetricsEnqueuer.class);
     }
 
     @Provides
@@ -53,9 +59,19 @@ interface EppTestComponent {
     }
 
     @Provides
-    EppMetrics provideMetrics() {
+    EppMetric.Builder provideMetrics() {
       return metrics;
     }
+
+    @Provides
+    ModulesService provideModulesService() {
+      return modulesService;
+    }
+
+    @Provides
+    BigQueryMetricsEnqueuer provideBigQueryMetricsEnqueuer() {
+      return metricsEnqueuer;
+    }
   }
 
   /** Subcomponent for request scoped injections. */

javatests/google/registry/flows/FlowRunnerTest.java

@@ -35,7 +35,7 @@ import google.registry.model.eppcommon.Trid;
 import google.registry.model.eppinput.EppInput;
 import google.registry.model.eppoutput.EppOutput;
 import google.registry.model.eppoutput.EppResponse;
-import google.registry.monitoring.whitebox.EppMetrics;
+import google.registry.monitoring.whitebox.EppMetric;
 import google.registry.testing.AppEngineRule;
 import google.registry.testing.FakeClock;
 import google.registry.testing.FakeHttpSession;
@@ -91,7 +91,7 @@ public class FlowRunnerTest extends ShardableTestCase {
     flowRunner.isDryRun = false;
     flowRunner.isSuperuser = false;
     flowRunner.isTransactional = false;
-    flowRunner.metrics = mock(EppMetrics.class);
+    flowRunner.metric = mock(EppMetric.Builder.class);
     flowRunner.sessionMetadata =
         new StatelessRequestSessionMetadata("TheRegistrar", ImmutableSet.<String>of());
     flowRunner.trid = Trid.create("client-123", "server-456");
@@ -113,7 +113,7 @@ public class FlowRunnerTest extends ShardableTestCase {
   public void testRun_notIsTransactional_callsMetricIncrementAttempts() throws Exception {
     flowRunner.run();
 
-    verify(flowRunner.metrics).incrementAttempts();
+    verify(flowRunner.metric).incrementAttempts();
   }
 
   @Test
@@ -121,7 +121,7 @@ public class FlowRunnerTest extends ShardableTestCase {
     flowRunner.isTransactional = true;
     flowRunner.run();
 
-    verify(flowRunner.metrics).incrementAttempts();
+    verify(flowRunner.metric).incrementAttempts();
   }
 
   @Test

javatests/google/registry/monitoring/whitebox/BUILD

@@ -23,6 +23,7 @@ java_library(
         "//third_party/java/appengine:appengine-api-testonly",
         "//third_party/java/appengine:appengine-stubs",
         "//third_party/java/appengine:appengine-testing",
+        "//third_party/java/auto:auto_value",
         "//third_party/java/joda_money",
         "//third_party/java/joda_time",
         "//third_party/java/junit",

javatests/google/registry/monitoring/whitebox/BigQueryMetricsEnqueuerTest.java

@@ -0,0 +1,111 @@
+// 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.monitoring.whitebox;
+
+import static google.registry.bigquery.BigqueryUtils.toBigqueryTimestamp;
+import static google.registry.testing.TaskQueueHelper.assertTasksEnqueued;
+import static org.mockito.Mockito.when;
+
+import com.google.api.services.bigquery.model.TableFieldSchema;
+import com.google.appengine.api.modules.ModulesService;
+import com.google.auto.value.AutoValue;
+import com.google.common.collect.ImmutableList;
+import com.google.common.collect.ImmutableMap;
+import google.registry.testing.AppEngineRule;
+import google.registry.testing.InjectRule;
+import google.registry.testing.TaskQueueHelper.TaskMatcher;
+import org.joda.time.DateTime;
+import org.junit.Before;
+import org.junit.Rule;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.mockito.Matchers;
+import org.mockito.Mock;
+import org.mockito.runners.MockitoJUnitRunner;
+
+/** Unit tests for {@link BigQueryMetricsEnqueuer}. */
+@RunWith(MockitoJUnitRunner.class)
+public class BigQueryMetricsEnqueuerTest {
+
+  @Rule
+  public final InjectRule inject = new InjectRule();
+
+  @Rule
+  public final AppEngineRule appEngine = AppEngineRule.builder()
+      .withDatastore()
+      .withLocalModules()
+      .withTaskQueue()
+      .build();
+
+  @Mock ModulesService modulesService;
+
+  private BigQueryMetricsEnqueuer enqueuer;
+
+  @Before
+  public void setUp() {
+    enqueuer = new BigQueryMetricsEnqueuer();
+    enqueuer.modulesService = modulesService;
+    when(modulesService.getVersionHostname(Matchers.anyString(), Matchers.anyString()))
+        .thenReturn("1.backend.test.localhost");
+  }
+
+  @Test
+  public void testExport() throws Exception {
+    TestMetric metric =
+        TestMetric.create(
+            DateTime.parse("1984-12-18TZ"), DateTime.parse("1984-12-18TZ").plusMillis(1));
+
+    enqueuer.export(metric, "laffo");
+
+    assertTasksEnqueued("bigquery-streaming-metrics",
+        new TaskMatcher()
+            .url("/_dr/task/metrics")
+            .header("Host", "1.backend.test.localhost")
+            .param("tableId", "test")
+            .param("startTime", "472176000.000000")
+            .param("endTime", "472176000.001000")
+            .param("insertId", "laffo"));
+  }
+
+  /** A stub implementation of {@link BigQueryMetric}. */
+  @AutoValue
+  abstract static class TestMetric implements BigQueryMetric {
+
+    static TestMetric create(DateTime startTimestamp, DateTime endTimestamp) {
+      return new AutoValue_BigQueryMetricsEnqueuerTest_TestMetric(startTimestamp, endTimestamp);
+    }
+
+    @Override
+    public String getTableId() {
+      return "test";
+    }
+
+    @Override
+    public ImmutableList<TableFieldSchema> getSchemaFields() {
+      return null;
+    }
+
+    @Override
+    public ImmutableMap<String, String> getBigQueryRowEncoding() {
+      return ImmutableMap.of(
+          "startTime", toBigqueryTimestamp(getStartTimestamp()),
+          "endTime", toBigqueryTimestamp(getEndTimestamp()));
+    }
+
+    abstract DateTime getStartTimestamp();
+
+    abstract DateTime getEndTimestamp();
+  }
+}

javatests/google/registry/monitoring/whitebox/MetricsTest.java

@@ -1,69 +0,0 @@
-// 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.monitoring.whitebox;
-
-import static google.registry.testing.TaskQueueHelper.assertTasksEnqueued;
-
-import com.google.common.base.Suppliers;
-import google.registry.testing.AppEngineRule;
-import google.registry.testing.FakeClock;
-import google.registry.testing.InjectRule;
-import google.registry.testing.TaskQueueHelper.TaskMatcher;
-import org.joda.time.DateTime;
-import org.junit.Before;
-import org.junit.Rule;
-import org.junit.Test;
-import org.junit.runner.RunWith;
-import org.mockito.runners.MockitoJUnitRunner;
-
-/** Unit tests for {@link Metrics}. */
-@RunWith(MockitoJUnitRunner.class)
-public class MetricsTest {
-
-  @Rule
-  public final InjectRule inject = new InjectRule();
-
-  @Rule
-  public final AppEngineRule appEngine = AppEngineRule.builder()
-      .withDatastore()
-      .withLocalModules()
-      .withTaskQueue()
-      .build();
-
-  private final FakeClock clock = new FakeClock(DateTime.parse("1984-12-18TZ"));
-
-  @Before
-  public void before() throws Exception {
-    inject.setStaticField(Metrics.class, "clock", clock);
-    inject.setStaticField(Metrics.class, "idGenerator", Suppliers.ofInstance("laffo"));
-  }
-
-  @Test
-  public void testExport() throws Exception {
-    class TestMetric extends Metrics {}
-    Metrics metrics = new TestMetric();
-    clock.advanceOneMilli();
-    metrics.setTableId("test");
-    metrics.export();
-    assertTasksEnqueued("bigquery-streaming-metrics",
-        new TaskMatcher()
-            .url("/_dr/task/metrics")
-            .header("Host", "1.backend.test.localhost")
-            .param("tableId", "test")
-            .param("startTime", "472176000.000000")
-            .param("endTime", "472176000.001000")
-            .param("insertId", "laffo"));
-  }
-}