Break the circular dependency pings/index.ts > pings/maker.ts

Author: Dexterp37

glean/src/core/pings/index.ts

@@ -75,7 +75,17 @@ class PingType implements CommonPingData {
       }
 
       const identifier = generateUUIDv4();
-      await collectAndStorePing(identifier, this, correctedReason);
+      await collectAndStorePing(
+        Glean.metricsDatabase,
+        Glean.eventsDatabase,
+        Glean.pingsDatabase,
+        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+        Glean.applicationId!,
+        identifier,
+        this,
+        correctedReason,
+        Glean.debugOptions
+      );
       return;
     });
   }

glean/src/core/pings/maker.ts

@@ -9,20 +9,24 @@ import { Lifetime } from "../metrics/index.js";
 import TimeUnit from "../metrics/time_unit.js";
 import { ClientInfo, PingInfo, PingPayload } from "../pings/ping_payload.js";
 import PingType from "../pings/index.js";
-import Glean from "../glean.js";
 import CoreEvents from "../events/index.js";
+import MetricsDatabase from "../metrics/database.js";
+import EventsDatabase from "../metrics/events_database.js";
+import { DebugOptions } from "../debug_options.js";
+import PingsDatabase from "./database.js";
 
 // The moment the current Glean.js session started.
 const GLEAN_START_TIME = new Date();
 
 /**
  * Gets, and then increments, the sequence number for a given ping.
  *
+ * @param metricsDatabase The metrics database.
  * @param ping The ping for which we want to get the sequence number.
  *
  * @returns The current number (before incrementing).
  */
-export async function getSequenceNumber(ping: PingType): Promise<number> {
+export async function getSequenceNumber(metricsDatabase: MetricsDatabase, ping: PingType): Promise<number> {
   const seq = new CounterMetricType({
     category: "",
     name: `${ping.name}#sequence`,
@@ -31,7 +35,7 @@ export async function getSequenceNumber(ping: PingType): Promise<number> {
     disabled: false
   });
 
-  const currentSeqData = await Glean.metricsDatabase.getMetric(PING_INFO_STORAGE, seq);
+  const currentSeqData = await metricsDatabase.getMetric(PING_INFO_STORAGE, seq);
   await CounterMetricType._private_addUndispatched(seq, 1);
 
   if (currentSeqData) {
@@ -53,11 +57,12 @@ export async function getSequenceNumber(ping: PingType): Promise<number> {
  * Gets the formatted start and end times for this ping
  * and updates for the next ping.
  *
+ * @param metricsDatabase The metrics database.
  * @param ping The ping for which we want to get the times.
  *
  * @returns An object containing start and times in their payload format.
  */
-export async function getStartEndTimes(ping: PingType): Promise<{ startTime: string, endTime: string }> {
+export async function getStartEndTimes(metricsDatabase: MetricsDatabase, ping: PingType): Promise<{ startTime: string, endTime: string }> {
   const start = new DatetimeMetricType({
     category: "",
     name: `${ping.name}#start`,
@@ -68,7 +73,7 @@ export async function getStartEndTimes(ping: PingType): Promise<{ startTime: str
 
   // "startTime" is the time the ping was generated the last time.
   // If not available, we use the date the Glean object was initialized.
-  const startTimeData = await Glean.metricsDatabase.getMetric(PING_INFO_STORAGE, start);
+  const startTimeData = await metricsDatabase.getMetric(PING_INFO_STORAGE, start);
   let startTime: DatetimeMetric;
   if (startTimeData) {
     startTime = new DatetimeMetric(startTimeData);
@@ -90,14 +95,15 @@ export async function getStartEndTimes(ping: PingType): Promise<{ startTime: str
 /**
  * Builds the `ping_info` section of a ping.
  *
+ * @param metricsDatabase The metrics database.
  * @param ping The ping to build the `ping_info` section for.
  * @param reason The reason for submitting this ping.
  *
  * @returns The final `ping_info` section in its payload format.
  */
-export async function buildPingInfoSection(ping: PingType, reason?: string): Promise<PingInfo> {
-  const seq = await getSequenceNumber(ping);
-  const { startTime, endTime } = await getStartEndTimes(ping);
+export async function buildPingInfoSection(metricsDatabase: MetricsDatabase, ping: PingType, reason?: string): Promise<PingInfo> {
+  const seq = await getSequenceNumber(metricsDatabase, ping);
+  const { startTime, endTime } = await getStartEndTimes(metricsDatabase, ping);
 
   const pingInfo: PingInfo = {
     seq,
@@ -115,12 +121,13 @@ export async function buildPingInfoSection(ping: PingType, reason?: string): Pro
 /**
  * Builds the `client_info` section of a ping.
  *
+ * @param metricsDatabase The metrics database.
  * @param ping The ping to build the `client_info` section for.
  *
  * @returns The final `client_info` section in its payload format.
  */
-export async function buildClientInfoSection(ping: PingType): Promise<ClientInfo> {
-  let clientInfo = await Glean.metricsDatabase.getPingMetrics(CLIENT_INFO_STORAGE, true);
+export async function buildClientInfoSection(metricsDatabase: MetricsDatabase, ping: PingType): Promise<ClientInfo> {
+  let clientInfo = await metricsDatabase.getPingMetrics(CLIENT_INFO_STORAGE, true);
   if (!clientInfo) {
     // TODO: Watch Bug 1685705 and change behaviour in here accordingly.
     console.warn("Empty client info data. Will submit anyways.");
@@ -151,18 +158,20 @@ export async function buildClientInfoSection(ping: PingType): Promise<ClientInfo
  * - [X-Debug-ID]
  * - [X-Source-Tags]
  *
+ * @param debugOptions The debug options.
+ * 
  * @returns An object containing all the headers and their values
  *          or `undefined` in case no custom headers were set.
  */
-export function getPingHeaders(): Record<string, string> | undefined {
+export function getPingHeaders(debugOptions?: DebugOptions): Record<string, string> | undefined {
   const headers: Record<string, string> = {};
 
-  if (Glean.debugViewTag) {
-    headers["X-Debug-ID"] = Glean.debugViewTag;
+  if (debugOptions?.debugViewTag) {
+    headers["X-Debug-ID"] = debugOptions.debugViewTag;
   }
 
-  if (Glean.sourceTags) {
-    headers["X-Source-Tags"] = Glean.sourceTags;
+  if (debugOptions?.sourceTags) {
+    headers["X-Source-Tags"] = debugOptions.sourceTags.toString();
   }
 
   if (Object.keys(headers).length > 0) {
@@ -173,15 +182,17 @@ export function getPingHeaders(): Record<string, string> | undefined {
 /**
  * Collects a snapshot for the given ping from storage and attach required meta information.
  *
+ * @param metricsDatabase The metrics database.
+ * @param eventsDatabase The events database.
  * @param ping The ping to collect for.
  * @param reason An optional reason code to include in the ping.
  *
  * @returns A fully assembled JSON representation of the ping payload.
  *          If there is no data stored for the ping, `undefined` is returned.
  */
-export async function collectPing(ping: PingType, reason?: string): Promise<PingPayload | undefined> {
-  const metricsData = await Glean.metricsDatabase.getPingMetrics(ping.name, true);
-  const eventsData = await Glean.eventsDatabase.getPingEvents(ping.name, true);
+export async function collectPing(metricsDatabase: MetricsDatabase, eventsDatabase: EventsDatabase, ping: PingType, reason?: string): Promise<PingPayload | undefined> {
+  const metricsData = await metricsDatabase.getPingMetrics(ping.name, true);
+  const eventsData = await eventsDatabase.getPingEvents(ping.name, true);
   if (!metricsData && !eventsData && !ping.sendIfEmpty) {
     console.info(`Storage for ${ping.name} empty. Bailing out.`);
     return;
@@ -191,8 +202,8 @@ export async function collectPing(ping: PingType, reason?: string): Promise<Ping
 
   const metrics = metricsData ? { metrics: metricsData } : {};
   const events = eventsData ? { events: eventsData } : {};
-  const pingInfo = await buildPingInfoSection(ping, reason);
-  const clientInfo = await buildClientInfoSection(ping);
+  const pingInfo = await buildPingInfoSection(metricsDatabase, ping, reason);
+  const clientInfo = await buildClientInfoSection(metricsDatabase, ping);
   return {
     ...metrics,
     ...events,
@@ -204,18 +215,17 @@ export async function collectPing(ping: PingType, reason?: string): Promise<Ping
 /**
  * Build a pings submition path.
  *
+ * @param applicationId The application id.
  * @param identifier The pings UUID identifier.
  * @param ping  The ping to build a path for.
  *
  * @returns The final submission path.
  */
-export function makePath(identifier: string, ping: PingType): string {
+export function makePath(applicationId: string, identifier: string, ping: PingType): string {
   // We are sure that the applicationId is not `undefined` at this point,
   // this function is only called when submitting a ping
   // and that function return early when Glean is not initialized.
-  //
-  // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-  return `/submit/${Glean.applicationId!}/${ping.name}/${GLEAN_SCHEMA_VERSION}/${identifier}`;
+  return `/submit/${applicationId}/${ping.name}/${GLEAN_SCHEMA_VERSION}/${identifier}`;
 }
 
 /**
@@ -225,14 +235,19 @@ export function makePath(identifier: string, ping: PingType): string {
  * This event is triggered **after** logging the ping, which happens if `logPings` is set.
  * We will log the payload before it suffers any change by plugins listening to this event.
  *
+ * @param metricsDatabase The metrics database.
+ * @param eventsDatabase The events database.
+ * @param pingsDatabase The pings database.
+ * @param applicationId The user-provided application id.
  * @param identifier The pings UUID identifier.
  * @param ping The ping to submit.
  * @param reason An optional reason code to include in the ping.
+ * @param debugOptions The debug options.
  *
  * @returns A promise that is resolved once collection and storing is done.
  */
-export async function collectAndStorePing(identifier: string, ping: PingType, reason?: string): Promise<void> {
-  const collectedPayload = await collectPing(ping, reason);
+export async function collectAndStorePing(metricsDatabase: MetricsDatabase, eventsDatabase: EventsDatabase, pingsDatabase: PingsDatabase, applicationId: string, identifier: string, ping: PingType, reason?: string, debugOptions?: DebugOptions): Promise<void> {
+  const collectedPayload = await collectPing(metricsDatabase, eventsDatabase, ping, reason);
   if (!collectedPayload) {
     return;
   }
@@ -251,13 +266,13 @@ export async function collectAndStorePing(identifier: string, ping: PingType, re
     return;
   }
 
-  if (Glean.logPings) {
+  if (debugOptions?.logPings) {
     console.info(JSON.stringify(collectedPayload, null, 2));
   }
   const finalPayload = modifiedPayload ? modifiedPayload : collectedPayload;
-  const headers = getPingHeaders();
-  return Glean.pingsDatabase.recordPing(
-    makePath(identifier, ping),
+  const headers = getPingHeaders(debugOptions);
+  return pingsDatabase.recordPing(
+    makePath(applicationId, identifier, ping),
     identifier,
     finalPayload,
     headers