Create more generic helper for faking glean restarts

- create testing util that restarts glean by creating a new instance of
  the `EventsDatabase`
- update existing and new tests to use new restart helper

Author: rosahbruno

glean/src/core/testing/index.ts

@@ -3,7 +3,7 @@
  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
 
 import type { ConfigurationInterface } from "../config";
-import { testInitializeGlean, testUninitializeGlean } from "./utils.js";
+import { testInitializeGlean, testRestartGlean, testUninitializeGlean } from "./utils.js";
 
 /**
  * Test-only API
@@ -29,3 +29,5 @@ export async function testResetGlean(
   await testUninitializeGlean(clearStores);
   await testInitializeGlean(applicationId, uploadEnabled, config);
 }
+
+export { testRestartGlean };

glean/src/core/testing/utils.ts

@@ -7,6 +7,7 @@ import type { ConfigurationInterface } from "../config.js";
 import { Context } from "../context.js";
 import { testResetEvents } from "../events/utils.js";
 import Glean from "../glean.js";
+import EventsDatabase from "../metrics/events_database/index.js";
 
 /**
  * Test-only API
@@ -64,3 +65,25 @@ export async function testUninitializeGlean(clearStores = true): Promise<void> {
     Glean.preInitSourceTags = undefined;
   }
 }
+
+/**
+ * Test-only API
+ *
+ * Fakes a restart by creating a new instance of the events database which will
+ * log a `glean.restarted` event.
+ *
+ * If you do not move the clock forward, an error will be logged.
+ *
+ * @param timeOffset How far ahead to move clock before restarting. Some events just need
+ *        a future time, others need a specific future time. The default time is 1 minute.
+ * @returns New instance of `EventsDatabase` since we "restarted" it.
+ */
+export async function testRestartGlean(timeOffset: number = 1000 * 60): Promise<EventsDatabase> {
+  // Move the clock to look like Glean was really restarted.
+  Context.startTime.setTime(Context.startTime.getTime() + timeOffset);
+
+  // Fake a restart.
+  const db = new EventsDatabase();
+  await db.initialize();
+  return db;
+}

glean/tests/unit/core/metrics/events_database.spec.ts

@@ -7,20 +7,29 @@ import type { SinonFakeTimers } from "sinon";
 import sinon from "sinon";
 
 import { Lifetime } from "../../../../src/core/metrics/lifetime";
-import EventsDatabase, { getGleanRestartedEventMetric } from "../../../../src/core/metrics/events_database";
-import { InternalEventMetricType as EventMetricType} from "../../../../src/core/metrics/types/event";
+import EventsDatabase, {
+  getGleanRestartedEventMetric,
+} from "../../../../src/core/metrics/events_database";
+import { InternalEventMetricType as EventMetricType } from "../../../../src/core/metrics/types/event";
 import type { JSONObject } from "../../../../src/core/utils";
 import CounterMetricType from "../../../../src/core/metrics/types/counter";
 import { generateReservedMetricIdentifiers } from "../../../../src/core/metrics/database";
-import { InternalPingType as PingType} from "../../../../src/core/pings/ping_type";
+import { InternalPingType as PingType } from "../../../../src/core/pings/ping_type";
 import { Context } from "../../../../src/core/context";
 import { RecordedEvent } from "../../../../src/core/metrics/events_database/recorded_event";
-import { EVENTS_PING_NAME, GLEAN_EXECUTION_COUNTER_EXTRA_KEY } from "../../../../src/core/constants";
+import {
+  EVENTS_PING_NAME,
+  GLEAN_EXECUTION_COUNTER_EXTRA_KEY,
+} from "../../../../src/core/constants";
 import { collectPing } from "../../../../src/core/pings/maker";
 import { ErrorType } from "../../../../src/core/error/error_type";
 import { testResetGlean } from "../../../../src/core/testing";
 import type { Event } from "../../../../src/core/metrics/events_database/recorded_event";
-import { testInitializeGlean, testUninitializeGlean } from "../../../../src/core/testing/utils";
+import {
+  testInitializeGlean,
+  testRestartGlean,
+  testUninitializeGlean,
+} from "../../../../src/core/testing/utils";
 import { WaitableUploader } from "../../../utils";
 import type { PingPayload } from "../../../../src/core/pings/ping_payload";
 
@@ -334,10 +343,7 @@ describe("EventsDatabase", function() {
     }));
 
     // Move the clock forward by one minute to look like Glean was really restarted.
-    Context.startTime.setTime(Context.startTime.getTime() + 1000 * 60);
-    // Fake a re-start.
-    const db2 = new EventsDatabase();
-    await db2.initialize();
+    const db2 = await testRestartGlean();
 
     for (const store of stores) {
       const snapshot = await db2.getPingEvents(store, true);
@@ -373,10 +379,7 @@ describe("EventsDatabase", function() {
       }));
 
       // Move the clock forward by one minute.
-      Context.startTime.setTime(Context.startTime.getTime() + 1000 * 60);
-      // Fake a re-start.
-      db = new EventsDatabase();
-      await db.initialize();
+      db = await testRestartGlean();
     }
 
     const snapshot = await db.getPingEvents("store", true);
@@ -577,10 +580,7 @@ describe("EventsDatabase", function() {
 
     // Move the clock forward by one hour.
     const restartedTimeOffset = 1000 * 60 * 60;
-    Context.startTime.setTime(firstStartTime.getTime() + restartedTimeOffset);
-    // Product is rebooted.
-    db = new EventsDatabase();
-    await db.initialize();
+    db = await testRestartGlean(restartedTimeOffset);
 
     // New events are recorded.
     await db.record(event, new RecordedEvent({
@@ -647,10 +647,7 @@ describe("EventsDatabase", function() {
 
     // Move the clock forward by one hour.
     const restartedTimeOffset = 1000 * 60 * 60;
-    Context.startTime.setTime(firstStartTime.getTime() + restartedTimeOffset);
-    // Product is rebooted.
-    db = new EventsDatabase();
-    await db.initialize();
+    db = await testRestartGlean(restartedTimeOffset);
 
     // New set of events are recorded
     await db.record(event, new RecordedEvent({
@@ -665,10 +662,7 @@ describe("EventsDatabase", function() {
     }));
 
     // Move the clock forward by one more hour.
-    Context.startTime.setTime(firstStartTime.getTime() + restartedTimeOffset * 2);
-    // Product is rebooted.
-    db = new EventsDatabase();
-    await db.initialize();
+    db = await testRestartGlean(restartedTimeOffset);
 
     // New set of events are recorded
     await db.record(event, new RecordedEvent({

glean/tests/unit/core/pings/maker.spec.ts

@@ -5,7 +5,7 @@
 import assert from "assert";
 import sinon from "sinon";
 
-import { InternalPingType as PingType} from "../../../../src/core/pings/ping_type";
+import { InternalPingType as PingType } from "../../../../src/core/pings/ping_type";
 import * as PingMaker from "../../../../src/core/pings/maker";
 import Glean from "../../../../src/core/glean";
 import CoreEvents from "../../../../src/core/events";
@@ -15,7 +15,11 @@ import { Context } from "../../../../src/core/context";
 import { stopGleanUploader } from "../../../utils";
 import EventMetricType from "../../../../src/core/metrics/types/event";
 import { Lifetime } from "../../../../src/core/metrics/lifetime";
-import { testInitializeGlean, testUninitializeGlean } from "../../../../src/core/testing/utils";
+import {
+  testInitializeGlean,
+  testRestartGlean,
+  testUninitializeGlean,
+} from "../../../../src/core/testing/utils";
 import { testResetGlean } from "../../../../src/core/testing";
 import type { ExtraMap } from "../../../../src/core/metrics/events_database/recorded_event";
 
@@ -296,8 +300,7 @@ describe("PingMaker", function() {
     };
 
     const triggerRestartedEvent = async () => {
-      // Easiest way to simulate a restart and create a `glean.restarted` event
-      await testResetGlean(testAppId, true, undefined, false);
+      await testRestartGlean();
     };
 
     // Record events