UploadAapter -> Uploader

Author: brizental

src/upload/index.ts

@@ -5,7 +5,7 @@
 import { GLEAN_VERSION } from "../constants";
 import Glean from "glean";
 import { Observer as PingsDatabaseObserver, PingInternalRepresentation } from "pings/database";
-import UploadAdapter from "upload/adapter";
+import Uploader from "upload/uploader";
 
 interface QueuedPing extends PingInternalRepresentation {
   identifier: string
@@ -154,7 +154,7 @@ class PingUploader implements PingsDatabaseObserver {
     }
 
     const finalPing = this.preparePingForUpload(ping);
-    const result = await UploadAdapter.post(
+    const result = await Uploader.post(
       new URL(ping.path, Glean.serverEndpoint),
       finalPing.payload,
       finalPing.headers

src/upload/adapter/browser.ts renamed to src/upload/uploader/browser.ts

@@ -3,9 +3,9 @@
  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
 
 import { UploadResult, UploadResultStatus } from "upload";
-import { UploadAdapter } from ".";
+import { Uploader } from ".";
 
-class BrowserUploadAdapter extends UploadAdapter {
+class BrowserUploader extends Uploader {
   async post(url: URL, body: string, headers: Record<string, string> = {}): Promise<UploadResult> {
     const controller = new AbortController();
     const timeout = setTimeout(() => controller.abort(), this.defaultTimeout);
@@ -51,4 +51,4 @@ class BrowserUploadAdapter extends UploadAdapter {
   }
 }
 
-export default new BrowserUploadAdapter();
+export default new BrowserUploader();

src/upload/adapter/index.ts renamed to src/upload/uploader/index.ts

@@ -7,7 +7,7 @@ import { UploadResult, UploadResultStatus } from "upload";
 /**
  * Uploader interface, actualy uploading logic varies per platform.
  */
-export abstract class UploadAdapter {
+export abstract class Uploader {
   // The timeout, in seconds, to use for all operations with the server.
   protected defaultTimeout = 10_000;
 
@@ -24,7 +24,7 @@ export abstract class UploadAdapter {
 }
 
 // Default export for tests sake.
-class MockUploadAdapter extends UploadAdapter {
+class MockUploader extends Uploader {
   post(): Promise<UploadResult> {
     const result: UploadResult = {
       result: UploadResultStatus.Success,
@@ -34,4 +34,4 @@ class MockUploadAdapter extends UploadAdapter {
   }
 }
 
-export default new MockUploadAdapter();
+export default new MockUploader();

tests/upload/index.spec.ts

@@ -8,7 +8,7 @@ import { v4 as UUIDv4 } from "uuid";
 
 import Glean from "glean";
 import PingUploader, { UploadResultStatus } from "upload";
-import UploadAdapter from "upload/adapter";
+import Uploader from "upload/uploader";
 
 const sandbox = sinon.createSandbox();
 
@@ -97,7 +97,7 @@ describe("PingUploader", function() {
   });
 
   it("if multiple pings are enqueued subsequently, we don't attempt to upload each ping more than once", async function () {
-    const spy = sandbox.spy(UploadAdapter, "post");
+    const spy = sandbox.spy(Uploader, "post");
     await fillUpPingsDatabase(100);
     await waitForGleanUploader();
     assert.strictEqual(spy.callCount, 100);
@@ -132,7 +132,7 @@ describe("PingUploader", function() {
 
   it("correctly deletes pings when upload is unrecoverably unsuccesfull", async function() {
     // Always return unrecoverable failure response from upload attempt.
-    sandbox.stub(UploadAdapter, "post").callsFake(() => Promise.resolve({
+    sandbox.stub(Uploader, "post").callsFake(() => Promise.resolve({
       status: 400,
       result: UploadResultStatus.Success
     }));
@@ -145,7 +145,7 @@ describe("PingUploader", function() {
 
   it("correctly re-enqueues pings when upload is recovarbly unsuccesfull", async function() {
     // Always return recoverable failure response from upload attempt.
-    sandbox.stub(UploadAdapter, "post").callsFake(() => Promise.resolve({
+    sandbox.stub(Uploader, "post").callsFake(() => Promise.resolve({
       status: 500,
       result: UploadResultStatus.Success
     }));
@@ -182,7 +182,7 @@ describe("PingUploader", function() {
 
   it("maximum of recoverable errors is enforced", async function () {
     // Always return recoverable failure response from upload attempt.
-    const stub = sandbox.stub(UploadAdapter, "post").callsFake(() => Promise.resolve({
+    const stub = sandbox.stub(Uploader, "post").callsFake(() => Promise.resolve({
       status: 500,
       result: UploadResultStatus.Success
     }));

tests/upload/adapter.spec.ts renamed to tests/upload/uploader.spec.ts

@@ -7,7 +7,7 @@ import assert from "assert";
 import sinon from "sinon";
 
 import { UploadResultStatus } from "upload";
-import BrowserUploadAdapter from "upload/adapter/browser";
+import BrowserUploader from "upload/uploader/browser";
 import { JSONObject } from "utils";
 
 const sandbox = sinon.createSandbox();
@@ -54,7 +54,7 @@ function createResponse(status: number): Response {
   return new Response("", { status });
 }
 
-describe("UploadAdapter/browser", function () {
+describe("Uploader/browser", function () {
   afterEach(async function () {
     sandbox.restore();
   });
@@ -64,15 +64,15 @@ describe("UploadAdapter/browser", function () {
     for (const [index, status] of [200, 400, 500].entries()) {
       stub.onCall(index).returns(Promise.resolve(createResponse(status)));
       assert.deepStrictEqual(
-        await BrowserUploadAdapter.post(new URL("htpps://localhost:8080"), ""),
+        await BrowserUploader.post(new URL("htpps://localhost:8080"), ""),
         { status: status, result: UploadResultStatus.Success });
     }
   });
 
   it("doesn't throw if upload action throws", async function () {
     sandbox.stub(global, "fetch").callsFake(() => Promise.reject());
     assert.deepStrictEqual(
-      await BrowserUploadAdapter.post(new URL("htpps://localhost:8080"), ""),
+      await BrowserUploader.post(new URL("htpps://localhost:8080"), ""),
       { result: UploadResultStatus.RecoverableFailure }
     );
   });