[Tech Debt] Replace done() with async/await

Author: levinmr

test/actions/action.test.js

@@ -41,12 +41,10 @@ describe("Action", () => {
         }
       }
 
-      beforeEach((done) => {
+      beforeEach(async () => {
         promiseExecuted = false;
         subject = new SuccessfulTestAction();
-        subject.execute(context).then(() => {
-          done();
-        });
+        await subject.execute(context);
       });
 
       it("executes the strategy and awaits", () => {
@@ -66,13 +64,11 @@ describe("Action", () => {
         }
       }
 
-      beforeEach((done) => {
+      beforeEach(async () => {
         promiseExecuted = false;
         errorlogSpy.resetHistory();
         subject = new UnsuccessfulTestAction();
-        subject.execute(context).catch(() => {
-          done();
-        });
+        await subject.execute(context).catch(() => {});
       });
 
       it("executes the strategy and awaits", () => {

test/google_analytics/query_authorizer.test.js

@@ -39,42 +39,42 @@ describe("GoogleAnalyticsQueryAuthorizer", () => {
       appConfig.key_file = undefined;
     });
 
-    it("should resolve a query with the auth prop set to an authorized JWT", () => {
-      return subject.authorizeQuery(query, appConfig).then((query) => {
+    it("should resolve a query with the auth prop set to an authorized JWT", async () => {
+      await subject.authorizeQuery(query, appConfig).then((query) => {
         expect(query.abc).to.equal(123);
         expect(query.auth).to.not.be.undefined;
         expect(query.auth).to.be.an.instanceof(googleapis.Auth.JWT);
       });
     });
 
-    it("should create a JWT with the proper scopes", () => {
-      return subject.authorizeQuery({}, appConfig).then((query) => {
+    it("should create a JWT with the proper scopes", async () => {
+      await subject.authorizeQuery({}, appConfig).then((query) => {
         expect(query.auth.initArguments[3]).to.deep.equal([
           "https://www.googleapis.com/auth/analytics.readonly",
         ]);
       });
     });
 
-    it("should authorize the JWT and resolve if it is valid", () => {
+    it("should authorize the JWT and resolve if it is valid", async () => {
       let jwtAuthorized = false;
       googleapis.Auth.JWT.prototype.authorize = (callback) => {
         jwtAuthorized = true;
         callback(null, {});
       };
 
-      return subject.authorizeQuery({}, appConfig).then(() => {
+      await subject.authorizeQuery({}, appConfig).then(() => {
         expect(jwtAuthorized).to.equal(true);
       });
     });
 
-    it("should authorize the JWT and reject if it is invalid", () => {
+    it("should authorize the JWT and reject if it is invalid", async () => {
       let jwtAuthorized = false;
       googleapis.Auth.JWT.prototype.authorize = (callback) => {
         jwtAuthorized = true;
         callback(new Error("Failed to authorize"));
       };
 
-      return subject.authorizeQuery({}, appConfig).catch((err) => {
+      await subject.authorizeQuery({}, appConfig).catch((err) => {
         expect(jwtAuthorized).to.equal(true);
         expect(err.message).to.equal("Failed to authorize");
       });

test/process_results/result_formatter.test.js

@@ -25,10 +25,10 @@ describe("ResultFormatter", () => {
       });
     });
 
-    it("should format results into JSON if the format is 'json'", () => {
+    it("should format results into JSON if the format is 'json'", async () => {
       const result = analyticsDataProcessor.processData({ report, data });
 
-      return ResultFormatter.formatResult(result, { format: "json" }).then(
+      await ResultFormatter.formatResult(result, { format: "json" }).then(
         (formattedResult) => {
           const json = JSON.parse(formattedResult);
           json.data.forEach((row, index) => {
@@ -46,10 +46,10 @@ describe("ResultFormatter", () => {
       );
     });
 
-    it("should remove the data attribute for JSON if options.slim is true", () => {
+    it("should remove the data attribute for JSON if options.slim is true", async () => {
       const result = analyticsDataProcessor.processData({ report, data });
 
-      return ResultFormatter.formatResult(result, {
+      await ResultFormatter.formatResult(result, {
         format: "json",
         slim: true,
       }).then((formattedResult) => {
@@ -58,19 +58,19 @@ describe("ResultFormatter", () => {
       });
     });
 
-    it("should reject if the data cannot be JSON stringified", () => {
+    it("should reject if the data cannot be JSON stringified", async () => {
       const array = [];
       array[0] = array;
 
-      return ResultFormatter.formatResult(array).catch((e) => {
+      await ResultFormatter.formatResult(array).catch((e) => {
         expect(e).to.match(/TypeError: Converting circular structure to JSON/);
       });
     });
 
-    it("should format results into CSV if the format is 'csv'", () => {
+    it("should format results into CSV if the format is 'csv'", async () => {
       const result = analyticsDataProcessor.processData({ report, data });
 
-      return ResultFormatter.formatResult(result, {
+      await ResultFormatter.formatResult(result, {
         format: "csv",
         slim: true,
       }).then((formattedResult) => {
@@ -89,10 +89,10 @@ describe("ResultFormatter", () => {
       });
     });
 
-    it("should throw an error if the format is unsupported", () => {
+    it("should throw an error if the format is unsupported", async () => {
       const result = analyticsDataProcessor.processData({ report, data });
 
-      return ResultFormatter.formatResult(result, {
+      await ResultFormatter.formatResult(result, {
         format: "xml",
         slim: true,
       }).catch((e) => {

test/processor.test.js

@@ -19,11 +19,9 @@ describe("Processor", () => {
       };
       const context = {};
 
-      beforeEach((done) => {
+      beforeEach(async () => {
         subject = new Processor([action]);
-        subject.processChain(context).then(() => {
-          done();
-        });
+        await subject.processChain(context);
       });
 
       it("calls execute on the action", () => {
@@ -40,11 +38,9 @@ describe("Processor", () => {
       };
       const context = {};
 
-      beforeEach((done) => {
+      beforeEach(async () => {
         subject = new Processor([action]);
-        subject.processChain(context).then(() => {
-          done();
-        });
+        await subject.processChain(context);
       });
 
       it("does not call execute on the action", () => {
@@ -67,11 +63,9 @@ describe("Processor", () => {
       };
       const context = {};
 
-      beforeEach((done) => {
+      beforeEach(async () => {
         subject = new Processor([action1, action2]);
-        subject.processChain(context).then(() => {
-          done();
-        });
+        await subject.processChain(context);
       });
 
       it("calls execute on each action", () => {

test/publish/disk.test.js

@@ -18,7 +18,7 @@ describe("DiskPublisher", () => {
 
   describe(".publish({ name, data, format, directory })", () => {
     context("when the format is json", () => {
-      it("should write the results to <output>/<report name>.json", (done) => {
+      it("should write the results to <output>/<report name>.json", async () => {
         const options = { output: "path/to/output", formats: ["json"] };
         const report = { name: "report-name" };
         const results = "I'm the results";
@@ -31,22 +31,19 @@ describe("DiskPublisher", () => {
           return null;
         };
 
-        DiskPublisher.publish({
+        await DiskPublisher.publish({
           name: report.name,
           data: results,
           format: options.formats[0],
           directory: options.output,
-        })
-          .then(() => {
-            expect(fileWritten).to.be.true;
-            done();
-          })
-          .catch(done);
+        }).then(() => {
+          expect(fileWritten).to.be.true;
+        });
       });
     });
 
     context("when the format is csv", () => {
-      it("should write the results to <output>/<report name>.csv", () => {
+      it("should write the results to <output>/<report name>.csv", async () => {
         const options = { output: "path/to/output", formats: ["csv"] };
         const report = { name: "report-name" };
         const results = "I'm the results";
@@ -59,7 +56,7 @@ describe("DiskPublisher", () => {
           return null;
         };
 
-        return DiskPublisher.publish({
+        await DiskPublisher.publish({
           name: report.name,
           data: results,
           format: options.formats[0],