Merge pull request #8 from dabapps/feature-allow-acl-as-a-passthrough

Feature allow acl as a passthrough

src/actions.ts

@@ -4,14 +4,15 @@ import {
   ActionSet,
   BeginAction,
   FailureAction,
+  FileAndACL,
   FileUploadOptions,
   SuccessAction,
 } from './types';
 import { uploadFileToS3 } from './upload-file-to-s3';
 
 export const uploadFileWithLoading = <S>(
   actionSet: ActionSet,
-  file: File,
+  file: File | FileAndACL,
   dispatch: ThunkDispatch<S, unknown, AnyAction>
 ) => {
   dispatch({ type: actionSet.REQUEST });
@@ -30,7 +31,7 @@ export const uploadFileWithLoading = <S>(
 export const createFileUploadAction = <S>(
   actionSet: ActionSet,
   options?: FileUploadOptions
-) => (files: ReadonlyArray<File>) => (
+) => (files: ReadonlyArray<File | FileAndACL>) => (
   dispatch: ThunkDispatch<S, unknown, AnyAction>
 ) => {
   dispatch<BeginAction>({

src/types.ts

@@ -50,6 +50,11 @@ export interface UploadState {
   error: undefined | ReadonlyArray<unknown>;
 }
 
+export interface FileAndACL {
+  file: File;
+  acl: 'private' | 'public-read' | 'public-read-write' | 'authenticated-read';
+}
+
 export interface BeginAction extends Action {
   payload: number;
 }

src/upload-file-to-s3.ts

@@ -1,7 +1,7 @@
 import axios, { AxiosResponse } from 'axios';
 import * as Cookies from 'js-cookie';
 import { POST } from './constants';
-import { UploadData, UploadFormFieldsAndFile } from './types';
+import { FileAndACL, UploadData, UploadFormFieldsAndFile } from './types';
 
 export const configureFormData = (data: UploadFormFieldsAndFile) => {
   const formData = new FormData();
@@ -51,23 +51,38 @@ export const uploadFileToSignedUrl = (
     });
 };
 
-export const getUploadForm = (file: File): Promise<UploadData> => {
+const isFile = (file: File | FileAndACL): file is File =>
+  file && !('acl' in file);
+
+export const getUploadForm = (file: File | FileAndACL): Promise<UploadData> => {
+  const data = isFile(file)
+    ? {
+        filename: file.name,
+      }
+    : {
+        acl: file.acl,
+        filename: file.file.name,
+      };
+
   return axios
     .request({
       method: POST,
       url: '/api/s3-file-uploads/',
       headers: {
         'X-CSRFToken': Cookies.get('csrftoken'),
       },
-      data: {
-        filename: file.name,
-      },
+      data,
     })
     .then((uploadResponse: AxiosResponse<UploadData>) => {
-      return uploadFileToSignedUrl(uploadResponse.data, file);
+      return uploadFileToSignedUrl(
+        uploadResponse.data,
+        isFile(file) ? file : file.file
+      );
     });
 };
 
-export const uploadFileToS3 = (file: File): Promise<UploadData> => {
+export const uploadFileToS3 = (
+  file: File | FileAndACL
+): Promise<UploadData> => {
   return getUploadForm(file);
 };

tests/actions.ts

@@ -5,6 +5,7 @@ import { MockPromise } from './helpers/mock-promise';
 import {
   createActionSet,
   createFileUploadAction,
+  FileAndACL,
   FileUploadOptions,
 } from '../src';
 import { uploadFileWithLoading } from '../src/actions';
@@ -14,7 +15,7 @@ describe('upload actions', () => {
   const mockUploadFileToS3 = jest
     .spyOn(requests, 'uploadFileToS3')
     .mockImplementation(
-      (file: File) =>
+      (file: File | FileAndACL) =>
         new MockPromise({ arguments: [file], thenCalls: [], catchCalls: [] })
     );
 

tests/helpers/stubs.ts

@@ -1,4 +1,5 @@
 import { UploadData, UploadForm, UploadFormFields } from '../../src/types';
+import { FileAndACL } from '../../src/types';
 
 export const mockedUploadFormFields: UploadFormFields = {
   AWSAccessKeyId: 'aaaaaa',
@@ -25,3 +26,8 @@ export const mockedUploadData: UploadData = {
 };
 
 export const mockedFile = new File([], 'llama');
+
+export const mockedFileAndACL: FileAndACL = {
+  file: new File([], 'drama'),
+  acl: 'public-read',
+};

tests/update-file-to-s3.ts

@@ -3,7 +3,11 @@ jest.mock('axios', () => ({ default: mockAxios }));
 
 import { uploadFileToS3 } from '../src';
 import * as requests from '../src/upload-file-to-s3';
-import { mockedFile, mockedUploadData } from './helpers/stubs';
+import {
+  mockedFile,
+  mockedFileAndACL,
+  mockedUploadData,
+} from './helpers/stubs';
 
 describe('Django S3 File Upload', () => {
   beforeEach(() => {
@@ -59,6 +63,48 @@ describe('Django S3 File Upload', () => {
         mockedUploadData,
         mockedFile
       );
+
+      spyOnUploadFileToSignedUrl.mockRestore();
+    });
+    it('should make an axios request and then call uploadFileToSignedUrl with ACL data included', () => {
+      requests.getUploadForm(mockedFileAndACL);
+      // Get the request calls
+      const { requestCalls } = mockAxios;
+
+      // Check that it was called
+      expect(requestCalls.length).toBe(1);
+
+      expect(requestCalls[0].arguments).toEqual([
+        {
+          method: 'POST',
+          url: '/api/s3-file-uploads/',
+          headers: {
+            'X-CSRFToken': undefined,
+          },
+          data: {
+            filename: 'drama',
+            acl: 'public-read',
+          },
+        },
+      ]);
+
+      // Get the .then calls
+      const { thenCalls } = requestCalls[0];
+
+      const spyOnUploadFileToSignedUrl = jest.spyOn(
+        requests,
+        'uploadFileToSignedUrl'
+      );
+
+      // Manually trigger .then
+      thenCalls[0].arguments[0]({ data: mockedUploadData });
+      expect(spyOnUploadFileToSignedUrl).toHaveBeenCalledTimes(1);
+      expect(spyOnUploadFileToSignedUrl).toHaveBeenCalledWith(
+        mockedUploadData,
+        mockedFileAndACL.file
+      );
+
+      spyOnUploadFileToSignedUrl.mockRestore();
     });
   });