refactor so call to doFormDataPatch isn't duplicated

Author: eviljeff

src/util/submit-addon.js

@@ -206,7 +206,11 @@ export default class Client {
     }
   }
 
-  async doAfterSubmit(addonId, newVersionId, editUrl) {
+  async doAfterSubmit(addonId, newVersionId, editUrl, patchData) {
+    if (patchData && patchData.version) {
+      log.info(`Submitting ${Object.keys(patchData.version)} to version`);
+      await this.doFormDataPatch(patchData.version, addonId, newVersionId);
+    }
     if (this.approvalCheckTimeout > 0) {
       const fileUrl = new URL(
         await this.waitForApproval(addonId, newVersionId),
@@ -379,29 +383,20 @@ export default class Client {
       version: { id: newVersionId, edit_url: editUrl },
     } = await this.doNewAddonSubmit(uploadUuid, metaDataJson);
 
-    if (patchData && patchData.version) {
-      log.info('Submitting source zip');
-      await this.doFormDataPatch(patchData.version, addonId, newVersionId);
-    }
-
     await saveIdToFileFunc(savedIdPath, addonId);
     log.info(`Generated extension ID: ${addonId}.`);
     log.info('You must add the following to your manifest:');
     log.info(`"browser_specific_settings": {"gecko": {"id": "${addonId}"}}`);
 
-    return this.doAfterSubmit(addonId, newVersionId, editUrl);
+    return this.doAfterSubmit(addonId, newVersionId, editUrl, patchData);
   }
 
   async putVersion(uploadUuid, addonId, metaDataJson, patchData) {
     const {
       version: { id: newVersionId, edit_url: editUrl },
     } = await this.doNewAddonOrVersionSubmit(addonId, uploadUuid, metaDataJson);
 
-    if (patchData && patchData.version) {
-      log.info('Submitting source zip');
-      await this.doFormDataPatch(patchData.version, addonId, newVersionId);
-    }
-    return this.doAfterSubmit(addonId, newVersionId, editUrl);
+    return this.doAfterSubmit(addonId, newVersionId, editUrl, patchData);
   }
 }
 

tests/unit/test-util/test.submit-addon.js

@@ -1005,63 +1005,50 @@ describe('util.submit-addon', () => {
         await client.putVersion(uploadUuid, `${addonId}`, {});
       });
 
-      describe('doFormDataPatch called correctly', () => {
+      describe('doAfterSubmit', () => {
+        const downloadUrl = 'https://a.download/url';
+        const newVersionId = sampleVersionDetail.id;
+        const editUrl = sampleVersionDetail.editUrl;
         const patchData = { version: { source: 'somesource' } };
-        const metaDataJson = { some: 'metadata' };
-        const newVersionId = 123456;
-        const editUrl = 'http://some/url';
-        const stubbedClient = new Client(clientDefaults);
-
-        const submitResponse = {
-          guid: addonId,
-          version: { id: newVersionId, edit_url: editUrl },
-        };
-        sinon
-          .stub(stubbedClient, 'doNewAddonOrVersionSubmit')
-          .resolves(submitResponse);
-        sinon.stub(stubbedClient, 'doNewAddonSubmit').resolves(submitResponse);
-        sinon.stub(stubbedClient, 'doAfterSubmit').resolves();
 
+        let approvalStub;
+        let downloadStub;
         let doFormDataPatchStub;
 
         before(() => {
+          approvalStub = sinon
+            .stub(client, 'waitForApproval')
+            .resolves(downloadUrl);
+          downloadStub = sinon.stub(client, 'downloadSignedFile').resolves();
           doFormDataPatchStub = sinon
-            .stub(stubbedClient, 'doFormDataPatch')
+            .stub(client, 'doFormDataPatch')
             .resolves();
         });
 
         afterEach(() => {
-          doFormDataPatchStub.reset();
+          approvalStub.resetHistory();
+          downloadStub.resetHistory();
+          doFormDataPatchStub.resetHistory();
         });
 
-        it('calls doFormDataPatch if patchData.version is defined for postNewAddon', async () => {
-          const saveIdToFileStub = sinon.stub().resolves();
-          const savedIdPath = 'some/saved/id/path';
-          await stubbedClient.postNewAddon(
-            uploadUuid,
-            savedIdPath,
-            metaDataJson,
-            patchData,
-            saveIdToFileStub,
-          );
+        it('skips download if approval timeout is 0', async () => {
+          client.approvalCheckTimeout = 0;
+          await client.doAfterSubmit(addonId, newVersionId, editUrl);
+          sinon.assert.notCalled(approvalStub);
+          sinon.assert.notCalled(downloadStub);
+        });
 
-          sinon.assert.calledWith(
-            doFormDataPatchStub,
-            patchData.version,
-            addonId,
-            newVersionId,
-          );
+        it('downloads the signed xpi if approval timeout > 0', async () => {
+          client.approvalCheckTimeout = 1;
+          await client.doAfterSubmit(addonId, newVersionId, editUrl);
+          sinon.assert.calledWith(approvalStub, addonId, newVersionId);
+          sinon.assert.calledWith(downloadStub, new URL(downloadUrl), addonId);
         });
 
-        it('calls doFormDataPatch if patchData.version is defined for putVersion', async () => {
-          await stubbedClient.putVersion(
-            uploadUuid,
-            addonId,
-            metaDataJson,
-            patchData,
-          );
+        it('calls doFormDataPatch if patchData.version is defined', async () => {
+          client.approvalCheckTimeout = 0;
+          await client.doAfterSubmit(addonId, newVersionId, editUrl, patchData);
 
-          sinon.assert.called(doFormDataPatchStub);
           sinon.assert.calledWith(
             doFormDataPatchStub,
             patchData.version,
@@ -1070,53 +1057,13 @@ describe('util.submit-addon', () => {
           );
         });
 
-        it('does not call doFormDataPatch is patchData.version is undefined for postNewAddon', async () => {
-          const saveIdToFileStub = sinon.stub().resolves();
-          const savedIdPath = 'some/saved/id/path';
-          await stubbedClient.postNewAddon(
-            uploadUuid,
-            savedIdPath,
-            metaDataJson,
-            {},
-            saveIdToFileStub,
-          );
-
-          sinon.assert.notCalled(doFormDataPatchStub);
-        });
-
-        it('does not call doFormDataPatch is patchData.version is undefined for putVersion', async () => {
-          await stubbedClient.putVersion(uploadUuid, addonId, metaDataJson);
-
-          sinon.assert.notCalled(doFormDataPatchStub);
-        });
-      });
-
-      describe('doAfterSubmit', () => {
-        const downloadUrl = 'https://a.download/url';
-        let approvalStub;
-        let downloadStub;
-        const newVersionId = sampleVersionDetail.id;
-        const editUrl = sampleVersionDetail.editUrl;
-
-        before(() => {
-          approvalStub = sinon
-            .stub(client, 'waitForApproval')
-            .resolves(downloadUrl);
-          downloadStub = sinon.stub(client, 'downloadSignedFile').resolves();
-        });
-
-        it('skips download if approval timeout is 0', async () => {
+        it('does not call doFormDataPatch is patchData.version is undefined', async () => {
           client.approvalCheckTimeout = 0;
-          await client.doAfterSubmit(addonId, newVersionId, editUrl);
-          sinon.assert.notCalled(approvalStub);
-          sinon.assert.notCalled(downloadStub);
-        });
+          await client.doAfterSubmit(addonId, newVersionId, editUrl, {
+            version: undefined,
+          });
 
-        it('downloads the signed xpi if approval timeout > 0', async () => {
-          client.approvalCheckTimeout = 1;
-          await client.doAfterSubmit(addonId, newVersionId, editUrl);
-          sinon.assert.calledWith(approvalStub, addonId, newVersionId);
-          sinon.assert.calledWith(downloadStub, new URL(downloadUrl), addonId);
+          sinon.assert.notCalled(doFormDataPatchStub);
         });
       });
     });