Bug 1695884 - Put PingType in a standalone file (#183)

Add entry to CHANGELOG.md

Author: ChinYing-Li

CHANGELOG.md

@@ -4,6 +4,7 @@
 
 * [#173](https://github.com/mozilla/glean.js/pull/173): Drop Node.js support from webext entry points
 * [#155](https://github.com/mozilla/glean.js/pull/155): Allow to define custom uploaders in the configuration.
+* [#183](https://github.com/mozilla/glean.js/pull/183): Put PingType in a standalone file
 
 # v0.7.0 (2021-03-26)
 

glean/src/core/internal_pings.ts

@@ -3,7 +3,7 @@
  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
 
 import { DELETION_REQUEST_PING_NAME } from "./constants.js";
-import PingType from "./pings/index.js";
+import PingType from "./pings/pingtype.js";
 
 /**
  * Glean-provided pings, all enabled by default.

glean/src/core/pings/index.ts

@@ -2,11 +2,6 @@
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
 
-import { DELETION_REQUEST_PING_NAME } from "../constants.js";
-import { generateUUIDv4 } from "../utils.js";
-import collectAndStorePing from "../pings/maker.js";
-import Glean from "../glean.js";
-
 /**
  * The common set of data for creating a new ping.
  */
@@ -21,64 +16,4 @@ interface CommonPingData {
   readonly reasonCodes?: string[]
 }
 
-/**
- * Stores information about a ping.
- *
- * This is required so that given metric data queued on disk we can send
- * pings with the correct settings, e.g. whether it has a client_id.
- */
-class PingType implements CommonPingData {
-  readonly name: string;
-  readonly includeClientId: boolean;
-  readonly sendIfEmpty: boolean;
-  readonly reasonCodes: string[];
-
-  constructor (meta: CommonPingData) {
-    this.name = meta.name;
-    this.includeClientId = meta.includeClientId;
-    this.sendIfEmpty = meta.sendIfEmpty;
-    this.reasonCodes = meta.reasonCodes ?? [];
-  }
-
-  private isDeletionRequest(): boolean {
-    return this.name === DELETION_REQUEST_PING_NAME;
-  }
-
-  /**
-   * Collects and submits a ping for eventual uploading.
-   *
-   * The ping content is assembled as soon as possible, but upload is not
-   * guaranteed to happen immediately, as that depends on the upload policies.
-   *
-   * If the ping currently contains no content, it will not be sent,
-   * unless it is configured to be sent if empty.
-   *
-   * @param reason The reason the ping was triggered. Included in the
-   *               `ping_info.reason` part of the payload.
-   */
-  submit(reason?: string): void {
-    Glean.dispatcher.launch(async () => {
-      if (!Glean.initialized) {
-        console.info("Glean must be initialized before submitting pings.");
-        return;
-      }
-
-      if (!Glean.isUploadEnabled() && !this.isDeletionRequest()) {
-        console.info("Glean disabled: not submitting pings. Glean may still submit the deletion-request ping.");
-        return;
-      }
-  
-      let correctedReason = reason;
-      if (reason && !this.reasonCodes.includes(reason)) {
-        console.error(`Invalid reason code ${reason} from ${this.name}. Ignoring.`);
-        correctedReason = undefined;
-      }
-  
-      const identifier = generateUUIDv4();
-      await collectAndStorePing(identifier, this, correctedReason);
-      return;
-    });
-  }
-}
-
-export default PingType;
+export default CommonPingData;

glean/src/core/pings/maker.ts

@@ -8,7 +8,7 @@ import DatetimeMetricType, { DatetimeMetric } from "../metrics/types/datetime.js
 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 PingType from "../pings/pingtype.js";
 import Glean from "../glean.js";
 import CoreEvents from "../events/index.js";
 

glean/src/core/pings/pingtype.ts

@@ -0,0 +1,71 @@
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+import {DELETION_REQUEST_PING_NAME} from "../constants";
+import Glean from "../glean";
+import {generateUUIDv4} from "../utils";
+import collectAndStorePing from "./maker";
+import CommonPingData from "./index";
+
+/**
+ * Stores information about a ping.
+ *
+ * This is required so that given metric data queued on disk we can send
+ * pings with the correct settings, e.g. whether it has a client_id.
+ */
+class PingType implements CommonPingData {
+  readonly name: string;
+  readonly includeClientId: boolean;
+  readonly sendIfEmpty: boolean;
+  readonly reasonCodes: string[];
+
+  constructor (meta: CommonPingData) {
+    this.name = meta.name;
+    this.includeClientId = meta.includeClientId;
+    this.sendIfEmpty = meta.sendIfEmpty;
+    this.reasonCodes = meta.reasonCodes ?? [];
+  }
+
+  private isDeletionRequest(): boolean {
+    return this.name === DELETION_REQUEST_PING_NAME;
+  }
+
+  /**
+   * Collects and submits a ping for eventual uploading.
+   *
+   * The ping content is assembled as soon as possible, but upload is not
+   * guaranteed to happen immediately, as that depends on the upload policies.
+   *
+   * If the ping currently contains no content, it will not be sent,
+   * unless it is configured to be sent if empty.
+   *
+   * @param reason The reason the ping was triggered. Included in the
+   *               `ping_info.reason` part of the payload.
+   */
+  submit(reason?: string): void {
+    Glean.dispatcher.launch(async () => {
+      if (!Glean.initialized) {
+        console.info("Glean must be initialized before submitting pings.");
+        return;
+      }
+
+      if (!Glean.isUploadEnabled() && !this.isDeletionRequest()) {
+        console.info("Glean disabled: not submitting pings. Glean may still submit the deletion-request ping.");
+        return;
+      }
+
+      let correctedReason = reason;
+      if (reason && !this.reasonCodes.includes(reason)) {
+        console.error(`Invalid reason code ${reason} from ${this.name}. Ignoring.`);
+        correctedReason = undefined;
+      }
+
+      const identifier = generateUUIDv4();
+      await collectAndStorePing(identifier, this, correctedReason);
+      return;
+    });
+  }
+}
+
+export default PingType;

glean/src/index/qt.ts

@@ -8,7 +8,7 @@ import { ConfigurationInterface } from "../core/config.js";
 import platform from "../platform/qt/index.js";
 
 // Private Glean types to export.
-import PingType from "../core/pings/index.js";
+import PingType from "../core/pings/pingtype.js";
 import BooleanMetricType from "../core/metrics/types/boolean.js";
 import CounterMetricType from "../core/metrics/types/counter.js";
 import DatetimeMetricType from "../core/metrics/types/datetime.js";

glean/tests/core/glean.spec.ts

@@ -11,7 +11,7 @@ import Glean from "../../src/core/glean";
 import { Lifetime } from "../../src/core/metrics";
 import StringMetricType from "../../src/core/metrics/types/string";
 import CounterMetricType from "../../src/core/metrics/types/counter";
-import PingType from "../../src/core/pings";
+import PingType from "../../src/core/pings/pingtype";
 import { isObject, JSONObject } from "../../src/core/utils";
 import TestPlatform from "../../src/platform/qt";
 import Plugin from "../../src/plugins";

glean/tests/core/metrics/labeled.spec.ts

@@ -11,7 +11,7 @@ import BooleanMetricType from "../../../src/core/metrics/types/boolean";
 import CounterMetricType from "../../../src/core/metrics/types/counter";
 import LabeledMetricType from "../../../src/core/metrics/types/labeled";
 import StringMetricType from "../../../src/core/metrics/types/string";
-import PingType from "../../../src/core/pings";
+import PingType from "../../../src/core/pings/pingtype";
 import { JSONObject } from "../../../src/core/utils";
 
 const sandbox = sinon.createSandbox();

glean/tests/core/pings/index.spec.ts

@@ -5,7 +5,7 @@
 import assert from "assert";
 import sinon from "sinon";
 
-import PingType from "../../../src/core/pings";
+import PingType from "../../../src/core/pings/pingtype";
 import CounterMetricType from "../../../src/core/metrics/types/counter";
 import { Lifetime } from "../../../src/core/metrics";
 import Glean from "../../../src/core/glean";

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

@@ -5,7 +5,7 @@
 import assert from "assert";
 import sinon from "sinon";
 
-import PingType from "../../../src/core/pings";
+import PingType from "../../../src/core/pings/pingtype";
 import * as PingMaker from "../../../src/core/pings/maker";
 import Glean from "../../../src/core/glean";
 import CoreEvents from "../../../src/core/events";