version-source to upload-source-code; reword helptext;

versionSource in submit-addon.js to submissionSource;
versionPatchData to patchData.version

Author: eviljeff

src/cmd/sign.js

@@ -40,7 +40,7 @@ export default function sign(
     verbose,
     channel,
     amoMetadata,
-    versionSource,
+    uploadSourceCode,
     webextVersion,
   },
   {
@@ -153,7 +153,7 @@ export default function sign(
           validationCheckTimeout: timeout,
           approvalCheckTimeout:
             approvalTimeout !== undefined ? approvalTimeout : timeout,
-          versionSource,
+          submissionSource: uploadSourceCode,
         });
       } else {
         const {

src/program.js

@@ -601,10 +601,13 @@ Example: $0 --help run.
             'Only used with `use-submission-api`',
           type: 'string',
         },
-        'version-source': {
+        'upload-source-code': {
           describe:
-            'Path to a zip file containing human readable source code for a version. ' +
-            'Only used with `use-submission-api`',
+            'Path to an archive file containing human readable source code of this submission, ' +
+            'if the code in --source-dir has been processed to make it unreadable. ' +
+            'See https://extensionworkshop.com/documentation/publish/source-code-submission/ for ' +
+            'details. Only used with `use-submission-api`',
+          type: 'string',
         },
       },
     )

src/util/submit-addon.js

@@ -371,17 +371,17 @@ export default class Client {
     uploadUuid,
     savedIdPath,
     metaDataJson,
-    versionPatchData,
+    patchData,
     saveIdToFileFunc = saveIdToFile,
   ) {
     const {
       guid: addonId,
       version: { id: newVersionId, edit_url: editUrl },
     } = await this.doNewAddonSubmit(uploadUuid, metaDataJson);
 
-    if (versionPatchData) {
+    if (patchData && patchData.version) {
       log.info('Submitting source zip');
-      await this.doFormDataPatch(versionPatchData, addonId, newVersionId);
+      await this.doFormDataPatch(patchData.version, addonId, newVersionId);
     }
 
     await saveIdToFileFunc(savedIdPath, addonId);
@@ -392,14 +392,14 @@ export default class Client {
     return this.doAfterSubmit(addonId, newVersionId, editUrl);
   }
 
-  async putVersion(uploadUuid, addonId, metaDataJson, versionPatchData) {
+  async putVersion(uploadUuid, addonId, metaDataJson, patchData) {
     const {
       version: { id: newVersionId, edit_url: editUrl },
     } = await this.doNewAddonOrVersionSubmit(addonId, uploadUuid, metaDataJson);
 
-    if (versionPatchData) {
+    if (patchData && patchData.version) {
       log.info('Submitting source zip');
-      await this.doFormDataPatch(versionPatchData, addonId, newVersionId);
+      await this.doFormDataPatch(patchData.version, addonId, newVersionId);
     }
     return this.doAfterSubmit(addonId, newVersionId, editUrl);
   }
@@ -419,7 +419,7 @@ export async function signAddon({
   savedIdPath,
   savedUploadUuidPath,
   metaDataJson = {},
-  versionSource,
+  submissionSource,
   userAgentString,
   SubmitClient = Client,
   ApiAuthClass = JwtApiAuth,
@@ -456,9 +456,11 @@ export async function signAddon({
     savedUploadUuidPath,
   );
   // if we have a source file we need to upload we patch after the create
-  const versionPatchData = versionSource
-    ? { source: client.fileFromSync(versionSource) }
-    : undefined;
+  const patchData = {
+    version: submissionSource
+      ? { source: client.fileFromSync(submissionSource) }
+      : undefined,
+  };
 
   // We specifically need to know if `id` has not been passed as a parameter because
   // it's the indication that a new add-on should be created, rather than a new version.
@@ -467,11 +469,11 @@ export async function signAddon({
       uploadUuid,
       savedIdPath,
       metaDataJson,
-      versionPatchData,
+      patchData,
     );
   }
 
-  return client.putVersion(uploadUuid, id, metaDataJson, versionPatchData);
+  return client.putVersion(uploadUuid, id, metaDataJson, patchData);
 }
 
 export async function saveIdToFile(filePath, id) {

tests/unit/test-cmd/test.sign.js

@@ -384,20 +384,20 @@ describe('sign', () => {
       });
     }));
 
-  it('passes the versionSource parameter to submissionAPI signer', () =>
+  it('passes the uploadSourceCode parameter to submissionAPI signer as submissionSource', () =>
     withTempDir((tmpDir) => {
       const stubs = getStubs();
-      const versionSource = 'path/to/source.zip';
+      const uploadSourceCode = 'path/to/source.zip';
       return sign(tmpDir, stubs, {
         extraArgs: {
-          versionSource,
+          uploadSourceCode,
           useSubmissionApi: true,
           channel: 'unlisted',
         },
       }).then(() => {
         sinon.assert.called(stubs.signingOptions.submitAddon);
         sinon.assert.calledWithMatch(stubs.signingOptions.submitAddon, {
-          versionSource,
+          submissionSource: uploadSourceCode,
         });
       });
     }));

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

@@ -195,39 +195,39 @@ describe('util.submit-addon', () => {
       );
     });
 
-    it('includes source data to be patched if versionSource defined for new addon', async () => {
-      const versionSource = 'path/to/source/zip';
+    it('includes source data to be patched if submissionSource defined for new addon', async () => {
+      const submissionSource = 'path/to/source/zip';
       await signAddon({
         ...signAddonDefaults,
-        versionSource,
+        submissionSource,
       });
 
-      sinon.assert.calledWith(fileFromSyncStub, versionSource);
+      sinon.assert.calledWith(fileFromSyncStub, submissionSource);
       sinon.assert.calledWith(
         postNewAddonStub,
         uploadUuid,
         signAddonDefaults.savedIdPath,
         {},
-        { source: fakeFileFromSync },
+        { version: { source: fakeFileFromSync } },
       );
     });
 
-    it('includes source data to be patched if versionSource defined for new version', async () => {
-      const versionSource = 'path/to/source/zip';
+    it('includes source data to be patched if submissionSource defined for new version', async () => {
+      const submissionSource = 'path/to/source/zip';
       const id = '@thisID';
       await signAddon({
         ...signAddonDefaults,
-        versionSource,
+        submissionSource,
         id,
       });
 
-      sinon.assert.calledWith(fileFromSyncStub, versionSource);
+      sinon.assert.calledWith(fileFromSyncStub, submissionSource);
       sinon.assert.calledWith(
         putVersionStub,
         uploadUuid,
         id,
         {},
-        { source: fakeFileFromSync },
+        { version: { source: fakeFileFromSync } },
       );
     });
   });
@@ -1006,7 +1006,7 @@ describe('util.submit-addon', () => {
       });
 
       describe('doFormDataPatch called correctly', () => {
-        const versionPatchData = { source: 'somesource' };
+        const patchData = { version: { source: 'somesource' } };
         const metaDataJson = { some: 'metadata' };
         const newVersionId = 123456;
         const editUrl = 'http://some/url';
@@ -1034,57 +1034,57 @@ describe('util.submit-addon', () => {
           doFormDataPatchStub.reset();
         });
 
-        it('calls doFormDataPatch if versionPatchData is defined for postNewAddon', async () => {
+        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,
-            versionPatchData,
+            patchData,
             saveIdToFileStub,
           );
 
           sinon.assert.calledWith(
             doFormDataPatchStub,
-            versionPatchData,
+            patchData.version,
             addonId,
             newVersionId,
           );
         });
 
-        it('calls doFormDataPatch if versionPatchData is defined for putVersion', async () => {
+        it('calls doFormDataPatch if patchData.version is defined for putVersion', async () => {
           await stubbedClient.putVersion(
             uploadUuid,
             addonId,
             metaDataJson,
-            versionPatchData,
+            patchData,
           );
 
           sinon.assert.called(doFormDataPatchStub);
           sinon.assert.calledWith(
             doFormDataPatchStub,
-            versionPatchData,
+            patchData.version,
             addonId,
             newVersionId,
           );
         });
 
-        it('does not call doFormDataPatch is versionPatchData is undefined for postNewAddon', async () => {
+        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,
-            undefined,
+            {},
             saveIdToFileStub,
           );
 
           sinon.assert.notCalled(doFormDataPatchStub);
         });
 
-        it('does not call doFormDataPatch is versionPatchData is undefined for putVersion', async () => {
+        it('does not call doFormDataPatch is patchData.version is undefined for putVersion', async () => {
           await stubbedClient.putVersion(uploadUuid, addonId, metaDataJson);
 
           sinon.assert.notCalled(doFormDataPatchStub);