web-api: Add support for overriding token when using fileUploadV2 (#…

…1723)
slackapi · Jan 16, 2024 · e29f6a1 · e29f6a1
1 parent d53ef02
commit e29f6a1
Show file tree

Hide file tree

Showing 4 changed files with 58 additions and 6 deletions.
diff --git a/packages/web-api/src/WebClient.spec.js b/packages/web-api/src/WebClient.spec.js
@@ -1413,8 +1413,13 @@ describe('WebClient', function () {
   });
 
   describe('fetchAllUploadURLExternal', () => {
-
-    const client = new WebClient(token);
+    let client;
+    beforeEach(() => {
+      client = new WebClient(token);
+    });
+    afterEach(() => {
+      client = null;
+    });
     it('makes calls to files.getUploadURLExternal for each fileUpload', async () => {
       const testFileUploads = [{
         channel_id: 'C1234',
@@ -1430,11 +1435,33 @@ describe('WebClient', function () {
       await client.fetchAllUploadURLExternal(testFileUploads);
       assert.isTrue(spy.calledOnce);
     });
+    it('honours overriden token provided as an argument', async () => {
+      const tokenOverride = 'overriden-token';
+      const testFileUploads = [{
+        channel_id: 'C1234',
+        filename: 'test-txt.txt',
+        initial_comment: 'Doo ba doo here is the: test-txt.txt',
+        title: 'Spaghetti test-txt.txt',
+        data: Buffer.from('Here is a txt file'),
+        length: 18,
+        token: tokenOverride,
+      }];
+
+      var spy = sinon.spy();
+      client.files.getUploadURLExternal = spy;
+      await client.fetchAllUploadURLExternal(testFileUploads);
+      assert.isTrue(spy.calledWith(sinon.match({ token: tokenOverride })), 'token override not passed through to underlying `files.getUploadURLExternal` API method');
+    });
   });
 
   describe('completeFileUploads', () => {
-    const client = new WebClient(token);
-
+    let client;
+    beforeEach(() => {
+      client = new WebClient(token);
+    });
+    afterEach(() => {
+      client = null;
+    });
     it('rejects with an error when missing required file id', async () => {
       const invalidTestFileUploadsToComplete = [{
         channel_id: 'C1234',
@@ -1447,7 +1474,7 @@ describe('WebClient', function () {
       // should reject because of missing file_id
       try {
         const res = await client.completeFileUploads(invalidTestFileUploadsToComplete);
-        assert.fail('Should haave errored but did not');
+        assert.fail('Should have errored but did not');
       } catch (err) {
         assert.equal(err.message, 'Missing required file id for file upload completion');
       }
@@ -1467,6 +1494,22 @@ describe('WebClient', function () {
       await client.completeFileUploads(testFileUploadsToComplete);
       assert.isTrue(spy.calledOnce);
     });
+    it('honours overriden token provided as an argument', async () => {
+      const tokenOverride = 'overriden-token';
+      const testFileUploadsToComplete = [{
+        channel_id: 'C1234',
+        file_id: 'test',
+        filename: 'test-txt.txt',
+        initial_comment: 'Doo ba doo here is the: test-txt.txt',
+        title: 'Spaghetti test-txt.txt',
+        token: tokenOverride,
+      }];
+
+      var spy = sinon.spy();
+      client.files.completeUploadExternal = spy;
+      await client.completeFileUploads(testFileUploadsToComplete);
+      assert.isTrue(spy.calledWith(sinon.match({ token: tokenOverride })), 'token override not passed through to underlying `files.completeUploadExternal` API method');
+    });
   });
 
   describe('postFileUploadsToExternalURL', () => {

diff --git a/packages/web-api/src/WebClient.ts b/packages/web-api/src/WebClient.ts
@@ -441,6 +441,9 @@ export class WebClient extends Methods {
         alt_text: upload.alt_text,
         snippet_type: upload.snippet_type,
       } as FilesGetUploadURLExternalArguments;
+      if ('token' in upload) {
+        options.token = upload.token;
+      }
 
       return this.files.getUploadURLExternal(options);
     }));

diff --git a/packages/web-api/src/file-upload.ts b/packages/web-api/src/file-upload.ts
@@ -38,6 +38,9 @@ export async function getFileUploadJob(
   if ('thread_ts' in options) {
     fileUploadJob.thread_ts = options.thread_ts;
   }
+  if ('token' in options) {
+    fileUploadJob.token = options.token;
+  }
   if ('content' in options) {
     return {
       content: options.content,
@@ -217,6 +220,9 @@ Record<string, FilesCompleteUploadExternalArguments> {
         if (thread_ts) {
           toComplete[compareString].thread_ts = upload.thread_ts;
         }
+        if ('token' in upload) {
+          toComplete[compareString].token = upload.token;
+        }
       } else {
         toComplete[compareString].files.push({
           id: file_id,

diff --git a/packages/web-api/src/types/request/files.ts b/packages/web-api/src/types/request/files.ts
@@ -149,7 +149,7 @@ export type FilesUploadV2Arguments = FileUploadV2 & TokenOverridable & {
 
 // Helper type intended for internal use in filesUploadV2 client method
 // Includes additional metadata required to complete a single file upload job
-export type FileUploadV2Job = FileUploadV2 &
+export type FileUploadV2Job = FileUploadV2 & TokenOverridable &
 Pick<FilesGetUploadURLExternalResponse, 'file_id' | 'upload_url' | 'error'> & {
   length?: number;
   data?: Buffer;