@aws-amplify/storage 4.4.3 → 4.4.4-in-app-messaging.35

package/src/providers/axios-http-handler.ts

@@ -1,186 +1,221 @@
-/*
- * Copyright 2017-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
- *
- * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
- * the License. A copy of the License is located at
- *
- *     http://aws.amazon.com/apache2.0/
- *
- * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
- * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
- * and limitations under the License.
- */
-
-import { HttpHandlerOptions } from '@aws-sdk/types';
-import { HttpHandler, HttpRequest, HttpResponse } from '@aws-sdk/protocol-http';
-import { buildQueryString } from '@aws-sdk/querystring-builder';
-import axios, {
-	AxiosRequestConfig,
-	Method,
-	CancelTokenSource,
-	AxiosTransformer,
-} from 'axios';
-import { ConsoleLogger as Logger, Platform } from '@aws-amplify/core';
-import { FetchHttpHandlerOptions } from '@aws-sdk/fetch-http-handler';
-import * as events from 'events';
-
-const logger = new Logger('axios-http-handler');
-export const SEND_UPLOAD_PROGRESS_EVENT = 'sendUploadProgress';
-export const SEND_DOWNLOAD_PROGRESS_EVENT = 'sendDownloadProgress';
-
-function isBlob(body: any): body is Blob {
-	return typeof Blob !== 'undefined' && body instanceof Blob;
-}
-
-const normalizeHeaders = (
-	headers: Record<string, string>,
-	normalizedName: string
-) => {
-	for (const [k, v] of Object.entries(headers)) {
-		if (
-			k !== normalizedName &&
-			k.toUpperCase() === normalizedName.toUpperCase()
-		) {
-			headers[normalizedName] = v;
-			delete headers[k];
-		}
-	}
-};
-
-export const reactNativeRequestTransformer: AxiosTransformer[] = [
-	function(data, headers) {
-		if (isBlob(data)) {
-			normalizeHeaders(headers, 'Content-Type');
-			normalizeHeaders(headers, 'Accept');
-			return data;
-		}
-		// Axios' default transformRequest is an array
-		return axios.defaults.transformRequest[0].call(null, data, headers);
-	},
-];
-
-export class AxiosHttpHandler implements HttpHandler {
-	constructor(
-		private readonly httpOptions: FetchHttpHandlerOptions = {},
-		private readonly emitter?: events.EventEmitter,
-		private readonly cancelTokenSource?: CancelTokenSource
-	) {}
-
-	destroy(): void {
-		// Do nothing. TLS and HTTP/2 connection pooling is handled by the
-		// browser.
-	}
-
-	handle(
-		request: HttpRequest,
-		options: HttpHandlerOptions
-	): Promise<{ response: HttpResponse }> {
-		const requestTimeoutInMs = this.httpOptions.requestTimeout;
-		const emitter = this.emitter;
-
-		let path = request.path;
-		if (request.query) {
-			const queryString = buildQueryString(request.query);
-			if (queryString) {
-				path += `?${queryString}`;
-			}
-		}
-
-		const port = request.port;
-		const url = `${request.protocol}//${request.hostname}${
-			port ? `:${port}` : ''
-		}${path}`;
-
-		const axiosRequest: AxiosRequestConfig = {};
-		axiosRequest.url = url;
-		axiosRequest.method = request.method as Method;
-		axiosRequest.headers = request.headers;
-
-		// The host header is automatically added by the browser and adding it explicitly in the
-		// axios request throws an error https://github.com/aws-amplify/amplify-js/issues/5376
-		// This is because the host header is a forbidden header for the http client to set
-		// see https://developer.mozilla.org/en-US/docs/Glossary/Forbidden_header_name and
-		// https://fetch.spec.whatwg.org/#forbidden-header-name
-		// The reason we are removing this header here instead of in the aws-sdk's client
-		// middleware is that the host header is required to be in the request signature and if
-		// we remove it from the middlewares, then the request fails because the header is added
-		// by the browser but is absent from the signature.
-		delete axiosRequest.headers['host'];
-
-		if (request.body) {
-			axiosRequest.data = request.body;
-		} else {
-			// Fix for https://github.com/aws-amplify/amplify-js/issues/5432
-
-			// If the POST request body is empty but content-type header is set, axios is forcibly removing it
-			// See https://github.com/axios/axios/issues/1535 and refusing to fix it https://github.com/axios/axios/issues/755
-			// This change is a workaround to set the data as null (instead of undefined) to prevent axios from
-			// removing the content-type header. Link for the source code
-			// https://github.com/axios/axios/blob/dc4bc49673943e35280e5df831f5c3d0347a9393/lib/adapters/xhr.js#L121-L123
-
-			if (axiosRequest.headers['Content-Type']) {
-				axiosRequest.data = null;
-			}
-		}
-		if (emitter) {
-			axiosRequest.onUploadProgress = function(event) {
-				emitter.emit(SEND_UPLOAD_PROGRESS_EVENT, event);
-				logger.debug(event);
-			};
-			axiosRequest.onDownloadProgress = function(event) {
-				emitter.emit(SEND_DOWNLOAD_PROGRESS_EVENT, event);
-				logger.debug(event);
-			};
-		}
-		// If a cancel token source is passed down from the provider, allows cancellation of in-flight requests
-		if (this.cancelTokenSource) {
-			axiosRequest.cancelToken = this.cancelTokenSource.token;
-		}
-
-		// From gamma release, aws-sdk now expects all response type to be of blob or streams
-		axiosRequest.responseType = 'blob';
-		
-		// In Axios, Blobs are identified by calling Object.prototype.toString on the object. However, on React Native,
-		// calling Object.prototype.toString on a Blob returns '[object Object]' instead of '[object Blob]', which causes 
-		// Axios to treat Blobs as generic Javascript objects. Therefore we need a to use a custom request transformer
-		// to correctly handle Blob in React Native.
-		if (Platform.isReactNative) {
-			axiosRequest.transformRequest = reactNativeRequestTransformer;
-		}
-
-		const raceOfPromises = [
-			axios
-				.request(axiosRequest)
-				.then(response => {
-					return {
-						response: new HttpResponse({
-							headers: response.headers,
-							statusCode: response.status,
-							body: response.data,
-						}),
-					};
-				})
-				.catch(error => {
-					// Error
-					logger.error(error.message);
-					throw error;
-				}),
-			requestTimeout(requestTimeoutInMs),
-		];
-		return Promise.race(raceOfPromises);
-	}
-}
-
-function requestTimeout(timeoutInMs: number = 0): Promise<never> {
-	return new Promise((resolve, reject) => {
-		if (timeoutInMs) {
-			setTimeout(() => {
-				const timeoutError = new Error(
-					`Request did not complete within ${timeoutInMs} ms`
-				);
-				timeoutError.name = 'TimeoutError';
-				reject(timeoutError);
-			}, timeoutInMs);
-		}
-	});
-}
+/*
+ * Copyright 2017-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
+ * the License. A copy of the License is located at
+ *
+ *     http://aws.amazon.com/apache2.0/
+ *
+ * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+ * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
+ * and limitations under the License.
+ */
+
+import { HttpHandlerOptions } from '@aws-sdk/types';
+import { HttpHandler, HttpRequest, HttpResponse } from '@aws-sdk/protocol-http';
+import { buildQueryString } from '@aws-sdk/querystring-builder';
+import axios, {
+	AxiosRequestConfig,
+	Method,
+	CancelTokenSource,
+	AxiosTransformer,
+} from 'axios';
+import { ConsoleLogger as Logger, Platform } from '@aws-amplify/core';
+import { FetchHttpHandlerOptions } from '@aws-sdk/fetch-http-handler';
+import * as events from 'events';
+import { AWSS3ProviderUploadErrorStrings } from '../common/StorageErrorStrings';
+
+const logger = new Logger('axios-http-handler');
+export const SEND_UPLOAD_PROGRESS_EVENT = 'sendUploadProgress';
+export const SEND_DOWNLOAD_PROGRESS_EVENT = 'sendDownloadProgress';
+
+function isBlob(body: any): body is Blob {
+	return typeof Blob !== 'undefined' && body instanceof Blob;
+}
+
+const normalizeHeaders = (
+	headers: Record<string, string>,
+	normalizedName: string
+) => {
+	for (const [k, v] of Object.entries(headers)) {
+		if (
+			k !== normalizedName &&
+			k.toUpperCase() === normalizedName.toUpperCase()
+		) {
+			headers[normalizedName] = v;
+			delete headers[k];
+		}
+	}
+};
+
+export const reactNativeRequestTransformer: AxiosTransformer[] = [
+	function(data, headers) {
+		if (isBlob(data)) {
+			normalizeHeaders(headers, 'Content-Type');
+			normalizeHeaders(headers, 'Accept');
+			return data;
+		}
+		// Axios' default transformRequest is an array
+		return axios.defaults.transformRequest[0].call(null, data, headers);
+	},
+];
+
+export type AxiosHttpHandlerOptions = HttpHandlerOptions & {
+	cancelTokenSource?: CancelTokenSource;
+	emitter?: events.EventEmitter;
+};
+
+export class AxiosHttpHandler implements HttpHandler {
+	constructor(
+		private readonly httpOptions: FetchHttpHandlerOptions = {},
+		private readonly emitter?: events.EventEmitter,
+		private readonly cancelTokenSource?: CancelTokenSource
+	) {}
+
+	destroy(): void {
+		// Do nothing. TLS and HTTP/2 connection pooling is handled by the
+		// browser.
+	}
+
+	handle(
+		request: HttpRequest,
+		options: AxiosHttpHandlerOptions
+	): Promise<{ response: HttpResponse }> {
+		const requestTimeoutInMs = this.httpOptions.requestTimeout;
+		// prioritize the call specific event emitter, this is useful for multipart upload as each individual parts has
+		// their own event emitter, without having to create s3client for every individual calls.
+		const emitter = options.emitter || this.emitter;
+
+		let path = request.path;
+		if (request.query) {
+			const queryString = buildQueryString(request.query);
+			if (queryString) {
+				path += `?${queryString}`;
+			}
+		}
+
+		const port = request.port;
+		const url = `${request.protocol}//${request.hostname}${
+			port ? `:${port}` : ''
+		}${path}`;
+
+		const axiosRequest: AxiosRequestConfig = {};
+		axiosRequest.url = url;
+		axiosRequest.method = request.method as Method;
+		axiosRequest.headers = request.headers;
+
+		// The host header is automatically added by the browser and adding it explicitly in the
+		// axios request throws an error https://github.com/aws-amplify/amplify-js/issues/5376
+		// This is because the host header is a forbidden header for the http client to set
+		// see https://developer.mozilla.org/en-US/docs/Glossary/Forbidden_header_name and
+		// https://fetch.spec.whatwg.org/#forbidden-header-name
+		// The reason we are removing this header here instead of in the aws-sdk's client
+		// middleware is that the host header is required to be in the request signature and if
+		// we remove it from the middlewares, then the request fails because the header is added
+		// by the browser but is absent from the signature.
+		delete axiosRequest.headers['host'];
+
+		if (request.body) {
+			axiosRequest.data = request.body;
+		} else {
+			// Fix for https://github.com/aws-amplify/amplify-js/issues/5432
+
+			// If the POST request body is empty but content-type header is set, axios is forcibly removing it
+			// See https://github.com/axios/axios/issues/1535 and refusing to fix it https://github.com/axios/axios/issues/755
+			// This change is a workaround to set the data as null (instead of undefined) to prevent axios from
+			// removing the content-type header. Link for the source code
+			// https://github.com/axios/axios/blob/dc4bc49673943e35280e5df831f5c3d0347a9393/lib/adapters/xhr.js#L121-L123
+
+			if (
+				axiosRequest.headers[
+					Object.keys(axiosRequest.headers).find(
+						key => key.toLowerCase() === 'content-type'
+					)
+				]
+			) {
+				axiosRequest.data = null;
+			}
+		}
+		if (emitter) {
+			axiosRequest.onUploadProgress = function(event) {
+				emitter.emit(SEND_UPLOAD_PROGRESS_EVENT, event);
+				logger.debug(event);
+			};
+			axiosRequest.onDownloadProgress = function(event) {
+				emitter.emit(SEND_DOWNLOAD_PROGRESS_EVENT, event);
+				logger.debug(event);
+			};
+		}
+		// If a cancel token source is passed down from the provider, allows cancellation of in-flight requests
+		if (this.cancelTokenSource) {
+			axiosRequest.cancelToken = this.cancelTokenSource.token;
+		}
+
+		if (options.cancelTokenSource) {
+			axiosRequest.cancelToken = options.cancelTokenSource.token;
+		}
+
+		// From gamma release, aws-sdk now expects all response type to be of blob or streams
+		axiosRequest.responseType = 'blob';
+		// In Axios, Blobs are identified by calling Object.prototype.toString on the object. However, on React Native,
+		// calling Object.prototype.toString on a Blob returns '[object Object]' instead of '[object Blob]', which causes
+		// Axios to treat Blobs as generic Javascript objects. Therefore we need a to use a custom request transformer
+		// to correctly handle Blob in React Native.
+		if (Platform.isReactNative) {
+			axiosRequest.transformRequest = reactNativeRequestTransformer;
+		}
+
+		const raceOfPromises = [
+			axios
+				.request(axiosRequest)
+				.then(response => {
+					return {
+						response: new HttpResponse({
+							headers: response.headers,
+							statusCode: response.status,
+							body: response.data,
+						}),
+					};
+				})
+				.catch(error => {
+					// Error
+					if (
+						error.message !==
+						AWSS3ProviderUploadErrorStrings.UPLOAD_PAUSED_MESSAGE
+					) {
+						logger.error(error.message);
+					}
+					// for axios' cancel error, we should re-throw it back so it's not considered an s3client error
+					// if we return empty, or an abitrary error HttpResponse, it will be hard to debug down the line
+					if (axios.isCancel(error)) {
+						throw error;
+					}
+					// otherwise, we should re-construct an HttpResponse from the error, so that it can be passed down to other
+					// aws sdk middleware (e.g retry, clock skew correction, error message serializing)
+					return {
+						response: new HttpResponse({
+							statusCode: error.response?.status,
+							body: error.response?.data,
+							headers: error.response?.headers,
+						}),
+					};
+				}),
+			requestTimeout(requestTimeoutInMs),
+		];
+		return Promise.race(raceOfPromises);
+	}
+}
+
+function requestTimeout(timeoutInMs: number = 0): Promise<never> {
+	return new Promise((resolve, reject) => {
+		if (timeoutInMs) {
+			setTimeout(() => {
+				const timeoutError = new Error(
+					`Request did not complete within ${timeoutInMs} ms`
+				);
+				timeoutError.name = 'TimeoutError';
+				reject(timeoutError);
+			}, timeoutInMs);
+		}
+	});
+}

package/src/types/AWSS3Provider.ts

@@ -7,12 +7,29 @@ import {
 	DeleteObjectCommandOutput,
 } from '@aws-sdk/client-s3';
 import { StorageOptions, StorageAccessLevel } from './Storage';
+import {
+	UploadTaskCompleteEvent,
+	UploadTaskProgressEvent,
+} from '../providers/AWSS3UploadTask';
+import { UploadTask } from './Provider';
 
 type ListObjectsCommandOutputContent = _Object;
 
+export interface FileMetadata {
+	bucket: string;
+	fileName: string;
+	key: string;
+	// Unix timestamp in ms
+	lastTouched: number;
+	uploadId: string;
+}
+
 export type CommonStorageOptions = Omit<
 	StorageOptions,
-	'credentials' | 'region' | 'bucket' | 'dangerouslyConnectToHttpEndpointForTesting'
+	| 'credentials'
+	| 'region'
+	| 'bucket'
+	| 'dangerouslyConnectToHttpEndpointForTesting'
 >;
 
 export type S3ProviderGetConfig = CommonStorageOptions & {
@@ -32,9 +49,11 @@ export type S3ProviderGetConfig = CommonStorageOptions & {
 	SSECustomerKeyMD5?: GetObjectRequest['SSECustomerKeyMD5'];
 };
 
-export type S3ProviderGetOuput<T> = T extends { download: true } ? GetObjectCommandOutput : string;
+export type S3ProviderGetOuput<T> = T extends { download: true }
+	? GetObjectCommandOutput
+	: string;
 
-export type S3ProviderPutConfig = CommonStorageOptions & {
+type _S3ProviderPutConfig = {
 	progressCallback?: (progress: any) => any;
 	provider?: 'AWSS3';
 	track?: boolean;
@@ -53,13 +72,27 @@ export type S3ProviderPutConfig = CommonStorageOptions & {
 	metadata?: PutObjectRequest['Metadata'];
 	tagging?: PutObjectRequest['Tagging'];
 	useAccelerateEndpoint?: boolean;
+	resumable?: boolean;
 };
 
-export interface S3ProviderPutOutput {
-	key: string;
-}
+export type ResumableUploadConfig = {
+	resumable: true;
+	progressCallback?: (progress: UploadTaskProgressEvent) => any;
+	completeCallback?: (event: UploadTaskCompleteEvent) => any;
+	errorCallback?: (err: any) => any;
+};
 
-export type S3ProviderRemoveConfig = CommonStorageOptions & { bucket?: string; provider?: 'AWSS3' };
+export type S3ProviderPutConfig = CommonStorageOptions &
+	(
+		| _S3ProviderPutConfig
+		// discriminated union so users won't be able to add resumable specific callbacks without the resumable flag
+		| (_S3ProviderPutConfig & ResumableUploadConfig)
+	);
+
+export type S3ProviderRemoveConfig = CommonStorageOptions & {
+	bucket?: string;
+	provider?: 'AWSS3';
+};
 
 export type S3ProviderRemoveOutput = DeleteObjectCommandOutput;
 
@@ -110,3 +143,11 @@ export type S3ProviderCopyConfig = Omit<CommonStorageOptions, 'level'> & {
 export type S3ProviderCopyOutput = {
 	key: string;
 };
+
+export type PutResult = {
+	key: string;
+};
+
+export type S3ProviderPutOutput<T> = T extends { resumable: true }
+	? UploadTask
+	: Promise<PutResult>;

package/src/types/Provider.ts

@@ -18,7 +18,11 @@ export interface StorageProvider {
 	cancel?(request: Promise<any>): void;
 
 	// copy object from src to dest
-	copy?(src: StorageCopySource, dest: StorageCopyDestination, config?): Promise<any>;
+	copy?(
+		src: StorageCopySource,
+		dest: StorageCopyDestination,
+		config?
+	): Promise<any>;
 
 	// configure your provider
 	configure(config: object): object;
@@ -27,7 +31,7 @@ export interface StorageProvider {
 	get(key: string, options?): Promise<string | Object>;
 
 	// upload storage object
-	put(key: string, object, options?): Promise<Object>;
+	put(key: string, object, options?): Promise<Object> | UploadTask;
 
 	// remove object
 	remove(key: string, options?): Promise<any>;
@@ -42,9 +46,20 @@ export interface StorageProvider {
 	getProviderName(): string;
 }
 
+export interface UploadTask {
+	resume(): any;
+	pause(): any;
+	percent: number;
+	isInProgress: boolean;
+}
+
 export interface StorageProviderWithCopy extends StorageProvider {
 	// copy object from src to dest
-	copy(src: StorageCopySource, dest: StorageCopyDestination, config?): Promise<any>;
+	copy(
+		src: StorageCopySource,
+		dest: StorageCopyDestination,
+		config?
+	): Promise<any>;
 }
 
 export type StorageProviderApi = 'copy' | 'get' | 'put' | 'remove' | 'list';

package/src/types/Storage.ts

@@ -21,10 +21,10 @@ import {
 	AWSS3Provider,
 	StorageProviderWithCopy,
 	S3ProviderGetOuput,
-	S3ProviderPutOutput,
 	S3ProviderRemoveOutput,
 	S3ProviderListOutput,
 	S3ProviderCopyOutput,
+	S3ProviderPutOutput,
 } from '../';
 
 type Tail<T extends any[]> = ((...t: T) => void) extends (
@@ -124,40 +124,40 @@ type PickProviderOutput<
 	api extends StorageProviderApi
 > = T extends StorageProvider
 	? T['getProviderName'] extends 'AWSS3'
-		? Promise<DefaultOutput>
+		? DefaultOutput
 		: T extends StorageProviderWithCopy
 		? ReturnType<T[api]>
 		: ReturnType<T[Exclude<api, 'copy'>]>
 	: T extends { provider: string }
 	? T extends { provider: 'AWSS3' }
-		? Promise<DefaultOutput>
+		? DefaultOutput
 		: Promise<any>
-	: Promise<DefaultOutput>;
+	: DefaultOutput;
 
 export type StorageGetOutput<
 	T extends StorageProvider | Record<string, any>
-> = PickProviderOutput<S3ProviderGetOuput<T>, T, 'get'>;
+> = PickProviderOutput<Promise<S3ProviderGetOuput<T>>, T, 'get'>;
 
 export type StoragePutOutput<T> = PickProviderOutput<
-	S3ProviderPutOutput,
+	S3ProviderPutOutput<T>,
 	T,
 	'put'
 >;
 
 export type StorageRemoveOutput<T> = PickProviderOutput<
-	S3ProviderRemoveOutput,
+	Promise<S3ProviderRemoveOutput>,
 	T,
 	'remove'
 >;
 
 export type StorageListOutput<T> = PickProviderOutput<
-	S3ProviderListOutput,
+	Promise<S3ProviderListOutput>,
 	T,
 	'list'
 >;
 
 export type StorageCopyOutput<T> = PickProviderOutput<
-	S3ProviderCopyOutput,
+	Promise<S3ProviderCopyOutput>,
 	T,
 	'copy'
 >;