fix(build): update github release assets properly MONGOSH-606 (#672)

Author: rose-m

packages/build/src/github-repo.spec.ts

@@ -197,49 +197,55 @@ describe('GithubRepo', () => {
       });
     });
 
-    it('fails if no release can be found', async() => {
-      const release = {
-        name: 'release',
-        tag: 'v0.8.0',
-        notes: ''
-      };
-      getReleaseByTag.resolves(undefined);
-      try {
-        await githubRepo.uploadReleaseAsset(release, {
-          path: 'path',
-          contentType: 'xyz'
-        });
-      } catch (e) {
-        return expect(e.message).to.contain('Could not look up release for tag');
-      }
-      expect.fail('Expected error');
-    });
-
-    it('ignores already exists error', async() => {
+    it('updates an existing asset', async() => {
       const release = {
         name: 'release',
         tag: 'v0.8.0',
         notes: ''
       };
       getReleaseByTag.resolves({
-        upload_url: 'url'
+        upload_url: 'url',
+        assets: [
+          {
+            id: 1,
+            name: path.basename(__filename),
+            url: 'assetUrl'
+          }
+        ]
       });
-      octoRequest.rejects(new ExistsError());
 
       await githubRepo.uploadReleaseAsset(release, {
         path: __filename,
         contentType: 'xyz'
       });
       expect(octoRequest).to.have.been.calledWith({
-        method: 'POST',
-        url: 'url',
+        method: 'PATCH',
+        url: 'assetUrl',
         headers: {
           'content-type': 'xyz'
         },
         name: path.basename(__filename),
         data: await fs.readFile(__filename)
       });
     });
+
+    it('fails if no release can be found', async() => {
+      const release = {
+        name: 'release',
+        tag: 'v0.8.0',
+        notes: ''
+      };
+      getReleaseByTag.resolves(undefined);
+      try {
+        await githubRepo.uploadReleaseAsset(release, {
+          path: 'path',
+          contentType: 'xyz'
+        });
+      } catch (e) {
+        return expect(e.message).to.contain('Could not look up release for tag');
+      }
+      expect.fail('Expected error');
+    });
   });
 
   describe('releaseToGithub', () => {

packages/build/src/github-repo.ts

@@ -31,6 +31,13 @@ type ReleaseDetails = {
   draft: boolean;
   upload_url: string;
   id: number;
+  assets?: ReleaseAsset[]
+};
+
+type ReleaseAsset = {
+  id: number;
+  name: string;
+  url: string;
 };
 
 export class GithubRepo {
@@ -96,12 +103,7 @@ export class GithubRepo {
 
   /**
    * Uploads an asset for a Github release, if the assets already exists
-   * the operation fails silently.
-   *
-   * @param {Release} release
-   * @param {Asset} asset
-   * @returns {Promise<void>}
-   * @memberof GithubRepo
+   * it will be updated.
    */
   async uploadReleaseAsset(release: Release, asset: Asset): Promise<void> {
     const releaseDetails = await this.getReleaseByTag(release.tag);
@@ -110,18 +112,25 @@ export class GithubRepo {
       throw new Error(`Could not look up release for tag ${release.tag}`);
     }
 
+    const assetName = path.basename(asset.path);
+    const existingAsset = releaseDetails.assets?.find(a => a.name === assetName);
+
     const params = {
-      method: 'POST',
-      url: releaseDetails.upload_url,
+      ...(existingAsset ? {
+        method: 'PATCH',
+        url: existingAsset.url
+      } : {
+        method: 'POST',
+        url: releaseDetails.upload_url
+      }),
       headers: {
         'content-type': asset.contentType
       },
-      name: path.basename(asset.path),
+      name: assetName,
       data: await fs.readFile(asset.path)
     };
 
-    await this.octokit.request(params)
-      .catch(this._ignoreAlreadyExistsError());
+    await this.octokit.request(params);
   }
 
   /**