Storage AWSS3Provider typescript improvement (#8590)

Added Typescript type improvements for AWSS3Provider
Changes are only for internal modules

Author: jamesaucode

packages/storage/__tests__/providers/AWSS3Provider-unit-test.ts

@@ -11,13 +11,13 @@
  * and limitations under the License.
  */
 import StorageProvider from '../../src/providers/AWSS3Provider';
-import { Logger, Hub, Credentials } from '@aws-amplify/core';
+import { Logger, Hub, Credentials, ICredentials } from '@aws-amplify/core';
 import * as formatURL from '@aws-sdk/util-format-url';
 import { S3Client, ListObjectsCommand } from '@aws-sdk/client-s3';
 import { S3RequestPresigner } from '@aws-sdk/s3-request-presigner';
 import * as events from 'events';
 
-import { S3CopySource, S3CopyDestination } from '../../src/types';
+import { S3CopySource, S3CopyDestination, StorageOptions, S3ProviderGetConfig } from '../../src/types';
 /**
  * NOTE - These test cases use Hub.dispatch but they should
  * actually be using dispatchStorageEvent from Storage
@@ -46,19 +46,19 @@ S3RequestPresigner.prototype.presign = jest.fn(async (request, expires) => {
 	return (Promise as any).resolve();
 });
 
-const credentials = {
+const credentials: ICredentials = {
 	accessKeyId: 'accessKeyId',
 	sessionToken: 'sessionToken',
 	secretAccessKey: 'secretAccessKey',
 	identityId: 'identityId',
 	authenticated: true,
 };
 
-const options = {
+const options: StorageOptions = {
 	bucket: 'bucket',
 	region: 'region',
 	credentials,
-	level: 'level',
+	level: 'public',
 };
 
 const options_no_cred = {
@@ -139,7 +139,7 @@ describe('StorageProvider test', () => {
 			jest.spyOn(formatURL, 'formatUrl').mockReturnValueOnce('url');
 
 			expect.assertions(3);
-			expect(await storage.get('key', { downloaded: false })).toBe('url');
+			expect(await storage.get('key', { download: false })).toBe('url');
 			expect(spyon.mock.calls[0][0].path).toEqual('/public/key');
 			expect(spyon.mock.calls[0][0].hostname).toEqual(options.bucket + '.s3.' + options.region + '.amazonaws.com');
 		});
@@ -241,27 +241,20 @@ describe('StorageProvider test', () => {
 				on: jest.fn(),
 				removeAllListeners: mockRemoveAllListeners,
 			};
-			jest
-				.spyOn(events, 'EventEmitter')
-				.mockImplementationOnce(() => mockEventEmitter);
+			jest.spyOn(events, 'EventEmitter').mockImplementationOnce(() => mockEventEmitter);
 			const downloadOptionsWithProgressCallback = Object.assign({}, options, {
 				download: true,
 				progressCallback: mockCallback,
 			});
 			const storage = new StorageProvider();
 			storage.configure(downloadOptionsWithProgressCallback);
-			const spyon = jest
-				.spyOn(S3Client.prototype, 'send')
-				.mockImplementationOnce(async params => {
-					return { Body: [1, 2] };
-				});
+			const spyon = jest.spyOn(S3Client.prototype, 'send').mockImplementationOnce(async params => {
+				return { Body: [1, 2] };
+			});
 			expect(await storage.get('key', { download: true })).toEqual({
 				Body: [1, 2],
 			});
-			expect(mockEventEmitter.on).toBeCalledWith(
-				'sendDownloadProgress',
-				expect.any(Function)
-			);
+			expect(mockEventEmitter.on).toBeCalledWith('sendDownloadProgress', expect.any(Function));
 			// Get the anonymous function called by the emitter
 			const emitterOnFn = mockEventEmitter.on.mock.calls[0][1];
 			// Manully invoke it for testing
@@ -280,25 +273,18 @@ describe('StorageProvider test', () => {
 				on: jest.fn(),
 				removeAllListeners: jest.fn(),
 			};
-			jest
-				.spyOn(events, 'EventEmitter')
-				.mockImplementationOnce(() => mockEventEmitter);
+			jest.spyOn(events, 'EventEmitter').mockImplementationOnce(() => mockEventEmitter);
 			const downloadOptionsWithProgressCallback = Object.assign({}, options);
 			const storage = new StorageProvider();
 			storage.configure(downloadOptionsWithProgressCallback);
-			jest
-				.spyOn(S3Client.prototype, 'send')
-				.mockImplementationOnce(async params => {
-					return { Body: [1, 2] };
-				});
+			jest.spyOn(S3Client.prototype, 'send').mockImplementationOnce(async params => {
+				return { Body: [1, 2] };
+			});
 			await storage.get('key', {
 				download: true,
-				progressCallback: 'this is not a function',
+				progressCallback: ('this is not a function' as unknown) as S3ProviderGetConfig['progressCallback'], // this is intentional
 			});
-			expect(loggerSpy).toHaveBeenCalledWith(
-				'WARN',
-				'progressCallback should be a function, not a string'
-			);
+			expect(loggerSpy).toHaveBeenCalledWith('WARN', 'progressCallback should be a function, not a string');
 		});
 
 		test('get object with download with failure', async () => {
@@ -472,7 +458,7 @@ describe('StorageProvider test', () => {
 				});
 			});
 
-			await storage.get('key', { downloaded: false });
+			await storage.get('key', { download: false });
 
 			const curCredSpyOn2 = jest.spyOn(Credentials, 'get').mockImplementationOnce(() => {
 				return new Promise((res, rej) => {
@@ -482,7 +468,7 @@ describe('StorageProvider test', () => {
 				});
 			});
 
-			await storage.get('key', { downloaded: false });
+			await storage.get('key', { download: false });
 
 			expect(curCredSpyOn.mock.calls.length).toBe(2);
 
@@ -667,18 +653,13 @@ describe('StorageProvider test', () => {
 				emit: jest.fn(),
 				on: jest.fn(),
 			};
-			jest
-				.spyOn(events, 'EventEmitter')
-				.mockImplementationOnce(() => mockEventEmitter);
+			jest.spyOn(events, 'EventEmitter').mockImplementationOnce(() => mockEventEmitter);
 			const storage = new StorageProvider();
 			storage.configure(options);
 			await storage.put('key', 'object', {
 				progressCallback: mockCallback,
 			});
-			expect(mockEventEmitter.on).toBeCalledWith(
-				'sendUploadProgress',
-				expect.any(Function)
-			);
+			expect(mockEventEmitter.on).toBeCalledWith('sendUploadProgress', expect.any(Function));
 			const emitterOnFn = mockEventEmitter.on.mock.calls[0][1];
 			// Manually invoke for testing
 			emitterOnFn('arg');
@@ -698,18 +679,13 @@ describe('StorageProvider test', () => {
 				emit: jest.fn(),
 				on: jest.fn(),
 			};
-			jest
-				.spyOn(events, 'EventEmitter')
-				.mockImplementationOnce(() => mockEventEmitter);
+			jest.spyOn(events, 'EventEmitter').mockImplementationOnce(() => mockEventEmitter);
 			const storage = new StorageProvider();
 			storage.configure(options);
 			await storage.put('key', 'object', {
-				progressCallback: 'hello',
+				progressCallback: ('hello' as unknown) as S3ProviderGetConfig['progressCallback'], // this is intentional
 			});
-			expect(loggerSpy).toHaveBeenCalledWith(
-				'WARN',
-				'progressCallback should be a function, not a string'
-			);
+			expect(loggerSpy).toHaveBeenCalledWith('WARN', 'progressCallback should be a function, not a string');
 		});
 
 		test('credentials not ok', async () => {
@@ -1012,7 +988,9 @@ describe('StorageProvider test', () => {
 			storage.configure(options);
 			const spyon = jest.spyOn(S3Client.prototype, 'send');
 
-			expect(await storage.copy({ key: 'src' }, { key: 'dest' })).toEqual({ key: 'dest' });
+			expect(await storage.copy({ key: 'src' }, { key: 'dest' })).toEqual({
+				key: 'dest',
+			});
 			expect(spyon.mock.calls[0][0].input).toStrictEqual({
 				Bucket: 'bucket',
 				// Should default to public if no level is specified
@@ -1032,7 +1010,10 @@ describe('StorageProvider test', () => {
 
 			// No src key
 			await expect(
-				storage.copy({ level: 'public' } as S3CopySource, { key: 'dest', level: 'public' })
+				storage.copy({ level: 'public' } as S3CopySource, {
+					key: 'dest',
+					level: 'public',
+				})
 			).rejects.toThrowError('source param should be an object with the property "key" with value of type string');
 
 			// wrong key type
@@ -1053,7 +1034,9 @@ describe('StorageProvider test', () => {
 
 			// No dest key
 			await expect(
-				storage.copy({ key: 'src', level: 'public' }, { level: 'public' } as S3CopyDestination)
+				storage.copy({ key: 'src', level: 'public' }, {
+					level: 'public',
+				} as S3CopyDestination)
 			).rejects.toThrowError('destination param should be an object with the property "key" with value of type string');
 
 			// wrong key type