feat(s3): add disa le store gey to uplaoder (#291)

filestack · Oct 7, 2019 · 2cf27fd · 2cf27fd
1 parent a9fa2f7
commit 2cf27fd
Show file tree

Hide file tree

Showing 4 changed files with 97 additions and 7 deletions.
diff --git a/manual_tests/upload_new.ts b/manual_tests/upload_new.ts
@@ -26,7 +26,7 @@ import * as Path from 'path';
 const createFile = (size = 44320) => Buffer.alloc(size);
 // Sentry.init({ dsn: 'DSN' });
 
-const fs = new Client('APIKEY');
+const fs = new Client('APEkwxKMZTsWNIP0XQsv2z');
 fs.on('upload.error', (e) => {
   console.log('uploadError', e);
 });
@@ -47,9 +47,7 @@ fs.on('upload.error', (e) => {
 // });
 
 try {
-  fs.upload(createFile(), {}, {
-    filename: 'HR-mary-oo',
-  }).then((res) => {
+  fs.upload('./upload.js').then((res) => {
     console.info('Upload done!', res);
   });
 } catch (e) {

diff --git a/src/lib/api/upload/uploaders/s3.spec.ts b/src/lib/api/upload/uploaders/s3.spec.ts
@@ -368,6 +368,83 @@ describe('Api/Upload/Uploaders/S3', () => {
       expect(mockComplete).toHaveBeenCalledWith(expect.objectContaining(testSecurity));
 
     });
+
+    it('should respect disableStorageKey option', async () => {
+      const u = new S3Uploader({
+        disableStorageKey: true,
+        path: '/test/',
+      });
+
+      u.setUrl(testHost);
+      u.setApikey(testApikey);
+      u.addFile(getSmallTestFile());
+
+      const res = await u.execute();
+      expect(res[0].status).toEqual('test_status');
+
+      const storageKeyExpect = {
+        store: {
+          location: 's3',
+          path: '/test/test.txt',
+        },
+      };
+
+      expect(mockStart).toHaveBeenCalledWith(expect.objectContaining(storageKeyExpect));
+      expect(mockUpload).toHaveBeenCalledWith(expect.objectContaining(storageKeyExpect));
+      expect(mockComplete).toHaveBeenCalledWith(expect.objectContaining(storageKeyExpect));
+
+    });
+
+    it('should respect disableStorageKey option when path is missing', async () => {
+      const u = new S3Uploader({
+        disableStorageKey: true,
+      });
+
+      u.setUrl(testHost);
+      u.setApikey(testApikey);
+      u.addFile(getSmallTestFile());
+
+      const res = await u.execute();
+      expect(res[0].status).toEqual('test_status');
+
+      const storageKeyExpect = {
+        store: {
+          location: 's3',
+          path: '/test.txt',
+        },
+      };
+
+      expect(mockStart).toHaveBeenCalledWith(expect.objectContaining(storageKeyExpect));
+      expect(mockUpload).toHaveBeenCalledWith(expect.objectContaining(storageKeyExpect));
+      expect(mockComplete).toHaveBeenCalledWith(expect.objectContaining(storageKeyExpect));
+
+    });
+
+    it('should respect disableStorageKey option when path has missing /', async () => {
+      const u = new S3Uploader({
+        disableStorageKey: true,
+        path: '/test',
+      });
+
+      u.setUrl(testHost);
+      u.setApikey(testApikey);
+      u.addFile(getSmallTestFile());
+
+      const res = await u.execute();
+      expect(res[0].status).toEqual('test_status');
+
+      const storageKeyExpect = {
+        store: {
+          location: 's3',
+          path: '/test/test.txt',
+        },
+      };
+
+      expect(mockStart).toHaveBeenCalledWith(expect.objectContaining(storageKeyExpect));
+      expect(mockUpload).toHaveBeenCalledWith(expect.objectContaining(storageKeyExpect));
+      expect(mockComplete).toHaveBeenCalledWith(expect.objectContaining(storageKeyExpect));
+    });
+
   });
 
   describe('Upload modes', () => {

diff --git a/src/lib/api/upload/uploaders/s3.ts b/src/lib/api/upload/uploaders/s3.ts
@@ -185,11 +185,25 @@ export class S3Uploader extends UploaderAbstract {
    * @returns
    * @memberof S3Uploader
    */
-  private getStoreOptions() {
-    return {
+  private getStoreOptions(id: string): StoreUploadOptions {
+    let options = {
       location: DEFAULT_STORE_LOCATION, // this parameter is required, if not set use default one
       ...this.storeOptions,
     };
+
+    if (this.storeOptions.disableStorageKey) {
+      const payload = this.getPayloadById(id);
+
+      if (options.path && options.path.substr(-1) !== '/') {
+        options.path = `${options.path}/`;
+      }
+
+      options.path = `${options.path ? options.path : '/'}${payload.file.name}`;
+
+      delete options.disableStorageKey;
+    }
+
+    return options;
   }
 
   /**
@@ -217,7 +231,7 @@ export class S3Uploader extends UploaderAbstract {
 
     return {
       ...filterObject(fields, requiredFields),
-      store: this.getStoreOptions(),
+      store: this.getStoreOptions(id),
     };
   }
 

diff --git a/src/lib/filelink.ts b/src/lib/filelink.ts
@@ -165,6 +165,7 @@ export interface StoreBaseParams {
   container?: string;
   region?: string;
   access?: string;
+  disableStorageKey?: boolean;
 }
 
 /**