Modify the CHANGELOG

Author: ChinYing-Li

CHANGELOG.md

@@ -2,7 +2,7 @@
 
 [Full changelog](https://github.com/mozilla/glean.js/compare/v0.17.0...main)
 
-* [#534](https://github.com/mozilla/glean.js/pull/534): Refactor Uploader into abstract class for external use
+* [#534](https://github.com/mozilla/glean.js/pull/534): Expose `Uploader` base class through `@mozilla/glean/<platform>/uploader` entry point.
 
 # v0.17.0 (2021-07-16)
 

glean/src/core/upload/index.ts

@@ -90,7 +90,7 @@ class PingUploader implements PingsDatabaseObserver {
     this.queue = [];
     this.status = PingUploaderStatus.Idle;
     // Initialize the ping uploader with either the platform defaults or a custom
-    // provided uploader from the configuration object.npm
+    // provided uploader from the configuration object.
     this.uploader = config.httpClient ? config.httpClient : platform.uploader;
     this.platformInfo = platform.info;
     this.serverEndpoint = config.serverEndpoint;
@@ -251,16 +251,17 @@ class PingUploader implements PingsDatabaseObserver {
    * @returns Whether or not to retry the upload attempt.
    */
   private async processPingUploadResponse(identifier: string, response: UploadResult): Promise<boolean> {
-    if (response.status && response.status >= 200 && response.status < 300) {
-      log(LOG_TAG, `Ping ${identifier} succesfully sent ${response.status}.`, LoggingLevel.Info);
+    const { status, result } = response;
+    if (status && status >= 200 && status < 300) {
+      log(LOG_TAG, `Ping ${identifier} succesfully sent ${status}.`, LoggingLevel.Info);
       await this.pingsDatabase.deletePing(identifier);
       return false;
     }
 
-    if (response.result === UploadResultStatus.UnrecoverableFailure || (response.status && response.status >= 400 && response.status < 500)) {
+    if (result === UploadResultStatus.UnrecoverableFailure || (status && status >= 400 && status < 500)) {
       log(
         LOG_TAG,
-        `Unrecoverable upload failure while attempting to send ping ${identifier}. Error was: ${response.status ?? "no status"}.`,
+        `Unrecoverable upload failure while attempting to send ping ${identifier}. Error was: ${status ?? "no status"}.`,
         LoggingLevel.Warn
       );
       await this.pingsDatabase.deletePing(identifier);
@@ -271,7 +272,7 @@ class PingUploader implements PingsDatabaseObserver {
       LOG_TAG,
       [
         `Recoverable upload failure while attempting to send ping ${identifier}, will retry.`,
-        `Error was ${response.status ?? "no status"}.`
+        `Error was ${status ?? "no status"}.`
       ],
       LoggingLevel.Warn
     );

glean/src/core/upload/uploader.ts

@@ -29,15 +29,12 @@ export const enum UploadResultStatus {
  * The result of an attempted ping upload.
  */
 export class UploadResult {
-  // The status is only present if `result` is UploadResultStatus.Success
-  readonly status?: number;
-  // The status of an upload attempt
-  readonly result: UploadResultStatus;
-
-  constructor(result: UploadResultStatus, status?: number) {
-    this.result = result;
-    this.status = status;
-  }
+  constructor(
+    // The status of an upload attempt
+    readonly result: UploadResultStatus,
+    // The status is only present if `result` is UploadResultStatus.Success
+    readonly status?: number
+  ) {}
 }
 
 /**

glean/tests/unit/platform/qt/uploader.spec.ts

@@ -7,7 +7,7 @@ import assert from "assert";
 import sinon from "sinon";
 
 import QtUploader from "../../../../src/platform/qt/uploader";
-import {DEFAULT_UPLOAD_TIMEOUT_MS, UploadResult, UploadResultStatus} from "../../../../src/core/upload/uploader";
+import { DEFAULT_UPLOAD_TIMEOUT_MS, UploadResult, UploadResultStatus } from "../../../../src/core/upload/uploader";
 
 describe("Uploader/Qt", function () {
   let server: sinon.SinonFakeServer;

glean/tests/unit/platform/webext/uploader.spec.ts

@@ -8,7 +8,7 @@ import sinon from "sinon";
 
 import BrowserUploader from "../../../../src/platform/webext/uploader";
 import type { JSONObject } from "../../../../src/core/utils";
-import {UploadResult, UploadResultStatus} from "../../../../src/core/upload/uploader";
+import { UploadResult, UploadResultStatus } from "../../../../src/core/upload/uploader";
 
 const sandbox = sinon.createSandbox();
 

samples/web-extension/typescript/package.json

@@ -21,12 +21,12 @@
     "@types/mocha": "^8.2.3",
     "@types/node": "^16.3.2",
     "mocha": "^9.0.2",
-    "strip-ansi": "^7.0.0",
     "ts-loader": "^9.2.3",
-    "ts-node": "^10.1.0",
     "typescript": "^4.3.5",
     "web-ext-types": "^3.2.1",
     "webpack": "^5.44.0",
-    "webpack-cli": "^4.7.2"
+    "webpack-cli": "^4.7.2",
+    "ts-node": "^10.1.0",
+    "strip-ansi": "^7.0.0"
   }
 }