Merge branch 'next' into next-api-v6

aws-amplify · Aug 31, 2023 · daeac44 · daeac44
2 parents c2912f0 + fbac776
commit daeac44
Show file tree

Hide file tree

Showing 17 changed files with 61 additions and 40 deletions.
diff --git a/packages/storage/__tests__/providers/s3/utils/client/S3/functional-test.ts b/packages/storage/__tests__/providers/s3/utils/client/S3/functional-test.ts
@@ -71,7 +71,7 @@ describe('S3 APIs functional test', () => {
 				if (caseType === 'happy case') {
 					fail(`${name} ${caseType} should succeed: ${e}`);
 				} else {
-					expect(e).toBeInstanceOf(Error);
+					expect(e).toBeInstanceOf(StorageError);
 					expect(e).toEqual(expect.objectContaining(outputOrError));
 				}
 			}

diff --git a/packages/storage/src/errors/StorageError.ts b/packages/storage/src/errors/StorageError.ts
@@ -1,19 +1,8 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
-import { AmplifyError, ErrorParams, ServiceError } from '@aws-amplify/core/internals/utils';
+import { AmplifyError, ErrorParams } from '@aws-amplify/core/internals/utils';
 
 export class StorageError extends AmplifyError {
-	static fromServiceError(error: Error, statusCode: number): ServiceError {
-		const storageError = new StorageError({
-			name: error.name,
-			message: error.message,
-		});
-		if (statusCode === 404) {
-			storageError.recoverySuggestion =
-				'Please add the object with this key to the bucket as the key is not found.';
-		}
-		throw storageError;
-	}
 	constructor(params: ErrorParams) {
 		super(params);
 

diff --git a/packages/storage/src/index.ts b/packages/storage/src/index.ts
@@ -12,3 +12,4 @@ export {
 } from './providers/s3';
 // TODO[AllanZhengYP]: support isCancelError in Node.js with node-fetch
 export { isCancelError } from './errors/CanceledError';
+export { StorageError } from './errors/StorageError';
diff --git a/packages/storage/src/providers/s3/utils/client/abortMultipartUpload.ts b/packages/storage/src/providers/s3/utils/client/abortMultipartUpload.ts
@@ -13,10 +13,11 @@ import type { AbortMultipartUploadCommandInput } from './types';
 
 import { defaultConfig } from './base';
 import {
-	validateS3RequiredParameter,
+	buildStorageServiceError,
 	parseXmlError,
 	s3TransferHandler,
 	serializePathnameObjectKey,
+	validateS3RequiredParameter,
 } from './utils';
 
 export type AbortMultipartUploadInput = Pick<
@@ -48,8 +49,8 @@ const abortMultipartUploadDeserializer = async (
 	response: HttpResponse
 ): Promise<AbortMultipartUploadOutput> => {
 	if (response.statusCode >= 300) {
-		const error = await parseXmlError(response);
-		throw error;
+		const error = (await parseXmlError(response)) as Error;
+		throw buildStorageServiceError(error, response.statusCode);
 	} else {
 		return {
 			$metadata: parseMetadata(response),

diff --git a/packages/storage/src/providers/s3/utils/client/completeMultipartUpload.ts b/packages/storage/src/providers/s3/utils/client/completeMultipartUpload.ts
@@ -16,6 +16,7 @@ import type {
 } from './types';
 import { defaultConfig } from './base';
 import {
+	buildStorageServiceError,
 	map,
 	parseXmlBody,
 	parseXmlError,
@@ -87,12 +88,11 @@ const serializeCompletedPartList = (input: CompletedPart): string => {
 const parseXmlBodyOrThrow = async (response: HttpResponse): Promise<any> => {
 	const parsed = await parseXmlBody(response); // Handles empty body case
 	if (parsed.Code !== undefined && parsed.Message !== undefined) {
-		const error = await parseXmlError({
+		const error = (await parseXmlError({
 			...response,
 			statusCode: 500, // To workaround the >=300 status code check common to other APIs.
-		});
-		error!.$metadata.httpStatusCode = response.statusCode;
-		throw error;
+		})) as Error;
+		throw buildStorageServiceError(error, response.statusCode);
 	}
 	return parsed;
 };
@@ -101,8 +101,8 @@ const completeMultipartUploadDeserializer = async (
 	response: HttpResponse
 ): Promise<CompleteMultipartUploadOutput> => {
 	if (response.statusCode >= 300) {
-		const error = await parseXmlError(response);
-		throw error;
+		const error = (await parseXmlError(response)) as Error;
+		throw buildStorageServiceError(error, response.statusCode);
 	} else {
 		const parsed = await parseXmlBodyOrThrow(response);
 		const contents = map(parsed, {

diff --git a/packages/storage/src/providers/s3/utils/client/copyObject.ts b/packages/storage/src/providers/s3/utils/client/copyObject.ts
@@ -10,8 +10,8 @@ import {
 import { composeServiceApi } from '@aws-amplify/core/internals/aws-client-utils/composers';
 import type { CopyObjectCommandInput, CopyObjectCommandOutput } from './types';
 import { defaultConfig } from './base';
-import { StorageError } from '../../../../errors/StorageError';
 import {
+	buildStorageServiceError,
 	parseXmlBody,
 	parseXmlError,
 	s3TransferHandler,
@@ -64,9 +64,8 @@ const copyObjectDeserializer = async (
 	response: HttpResponse
 ): Promise<CopyObjectOutput> => {
 	if (response.statusCode >= 300) {
-		// error is always set when statusCode >= 300
 		const error = (await parseXmlError(response)) as Error;
-		throw StorageError.fromServiceError(error, response.statusCode);
+		throw buildStorageServiceError(error, response.statusCode);
 	} else {
 		await parseXmlBody(response);
 		return {

diff --git a/packages/storage/src/providers/s3/utils/client/createMultipartUpload.ts b/packages/storage/src/providers/s3/utils/client/createMultipartUpload.ts
@@ -16,6 +16,7 @@ import type { PutObjectInput } from './putObject';
 
 import { defaultConfig } from './base';
 import {
+	buildStorageServiceError,
 	validateS3RequiredParameter,
 	map,
 	parseXmlBody,
@@ -55,8 +56,8 @@ const createMultipartUploadDeserializer = async (
 	response: HttpResponse
 ): Promise<CreateMultipartUploadOutput> => {
 	if (response.statusCode >= 300) {
-		const error = await parseXmlError(response);
-		throw error;
+		const error = (await parseXmlError(response)) as Error;
+		throw buildStorageServiceError(error, response.statusCode);
 	} else {
 		const parsed = await parseXmlBody(response);
 		const contents = map(parsed, {

diff --git a/packages/storage/src/providers/s3/utils/client/deleteObject.ts b/packages/storage/src/providers/s3/utils/client/deleteObject.ts
@@ -15,6 +15,7 @@ import type {
 
 import { defaultConfig } from './base';
 import {
+	buildStorageServiceError,
 	deserializeBoolean,
 	map,
 	parseXmlError,
@@ -51,7 +52,7 @@ const deleteObjectDeserializer = async (
 	if (response.statusCode >= 300) {
 		// error is always set when statusCode >= 300
 		const error = (await parseXmlError(response)) as Error;
-		throw StorageError.fromServiceError(error, response.statusCode);
+		throw buildStorageServiceError(error, response.statusCode);
 	} else {
 		const content = map(response.headers, {
 			DeleteMarker: ['x-amz-delete-marker', deserializeBoolean],

diff --git a/packages/storage/src/providers/s3/utils/client/getObject.ts b/packages/storage/src/providers/s3/utils/client/getObject.ts
@@ -20,6 +20,7 @@ import type {
 	GetObjectCommandOutput,
 } from './types';
 import {
+	buildStorageServiceError,
 	deserializeBoolean,
 	deserializeMetadata,
 	deserializeNumber,
@@ -56,8 +57,8 @@ const getObjectDeserializer = async (
 	response: HttpResponse
 ): Promise<GetObjectOutput> => {
 	if (response.statusCode >= 300) {
-		const error = await parseXmlError(response);
-		throw error;
+		const error = (await parseXmlError(response)) as Error;
+		throw buildStorageServiceError(error, response.statusCode);
 	} else if (!response.body) {
 		throw new Error('Got empty response body.');
 	} else {

diff --git a/packages/storage/src/providers/s3/utils/client/headObject.ts b/packages/storage/src/providers/s3/utils/client/headObject.ts
@@ -12,6 +12,7 @@ import { defaultConfig } from './base';
 import type { HeadObjectCommandInput, HeadObjectCommandOutput } from './types';
 
 import {
+	buildStorageServiceError,
 	deserializeMetadata,
 	deserializeNumber,
 	deserializeTimestamp,
@@ -56,7 +57,7 @@ const headObjectDeserializer = async (
 	if (response.statusCode >= 300) {
 		// error is always set when statusCode >= 300
 		const error = (await parseXmlError(response)) as Error;
-		throw StorageError.fromServiceError(error, response.statusCode);
+		throw buildStorageServiceError(error, response.statusCode);
 	} else {
 		const contents = {
 			...map(response.headers, {

diff --git a/packages/storage/src/providers/s3/utils/client/listObjectsV2.ts b/packages/storage/src/providers/s3/utils/client/listObjectsV2.ts
@@ -15,6 +15,7 @@ import type {
 import { defaultConfig } from './base';
 import {
 	assignStringVariables,
+	buildStorageServiceError,
 	deserializeBoolean,
 	deserializeNumber,
 	deserializeTimestamp,
@@ -24,7 +25,6 @@ import {
 	parseXmlError,
 	s3TransferHandler,
 } from './utils';
-import { StorageError } from '../../../../errors/StorageError';
 
 export type ListObjectsV2Input = ListObjectsV2CommandInput;
 
@@ -63,7 +63,7 @@ const listObjectsV2Deserializer = async (
 	if (response.statusCode >= 300) {
 		// error is always set when statusCode >= 300
 		const error = (await parseXmlError(response)) as Error;
-		throw StorageError.fromServiceError(error, response.statusCode);
+		throw buildStorageServiceError(error, response.statusCode);
 	} else {
 		const parsed = await parseXmlBody(response);
 		const contents = map(parsed, {

diff --git a/packages/storage/src/providers/s3/utils/client/listParts.ts b/packages/storage/src/providers/s3/utils/client/listParts.ts
@@ -15,6 +15,7 @@ import type {
 } from './types';
 import { defaultConfig } from './base';
 import {
+	buildStorageServiceError,
 	emptyArrayGuard,
 	map,
 	parseXmlBody,
@@ -58,8 +59,8 @@ const listPartsDeserializer = async (
 	response: HttpResponse
 ): Promise<ListPartsOutput> => {
 	if (response.statusCode >= 300) {
-		const error = await parseXmlError(response);
-		throw error;
+		const error = (await parseXmlError(response)) as Error;
+		throw buildStorageServiceError(error, response.statusCode);
 	} else {
 		const parsed = await parseXmlBody(response);
 		const contents = map(parsed, {

diff --git a/packages/storage/src/providers/s3/utils/client/putObject.ts b/packages/storage/src/providers/s3/utils/client/putObject.ts
@@ -12,6 +12,7 @@ import { composeServiceApi } from '@aws-amplify/core/internals/aws-client-utils/
 import { defaultConfig } from './base';
 import type { PutObjectCommandInput, PutObjectCommandOutput } from './types';
 import {
+	buildStorageServiceError,
 	validateS3RequiredParameter,
 	assignStringVariables,
 	map,
@@ -70,8 +71,8 @@ const putObjectDeserializer = async (
 	response: HttpResponse
 ): Promise<PutObjectOutput> => {
 	if (response.statusCode >= 300) {
-		const error = await parseXmlError(response);
-		throw error;
+		const error = (await parseXmlError(response)) as Error;
+		throw buildStorageServiceError(error, response.statusCode);
 	} else {
 		return {
 			...map(response.headers, {

diff --git a/packages/storage/src/providers/s3/utils/client/uploadPart.ts b/packages/storage/src/providers/s3/utils/client/uploadPart.ts
@@ -12,6 +12,7 @@ import { composeServiceApi } from '@aws-amplify/core/internals/aws-client-utils/
 import { defaultConfig } from './base';
 import type { UploadPartCommandInput, UploadPartCommandOutput } from './types';
 import {
+	buildStorageServiceError,
 	validateS3RequiredParameter,
 	assignStringVariables,
 	map,
@@ -61,8 +62,8 @@ const uploadPartDeserializer = async (
 	response: HttpResponse
 ): Promise<UploadPartOutput> => {
 	if (response.statusCode >= 300) {
-		const error = await parseXmlError(response);
-		throw error;
+		const error = (await parseXmlError(response)) as Error;
+		throw buildStorageServiceError(error, response.statusCode);
 	} else {
 		return {
 			...map(response.headers, {

diff --git a/packages/storage/src/providers/s3/utils/client/utils/deserializeHelpers.ts b/packages/storage/src/providers/s3/utils/client/utils/deserializeHelpers.ts
@@ -2,6 +2,9 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import { Headers } from '@aws-amplify/core/internals/aws-client-utils';
+import { ServiceError } from '@aws-amplify/core/internals/utils';
+
+import { StorageError } from '../../../../../errors/StorageError';
 
 type PropertyNameWithStringValue = string;
 type PropertyNameWithSubsequentDeserializer<T> = [string, (arg: any) => T];
@@ -133,3 +136,23 @@ export const deserializeMetadata = (
 		}, {} as any);
 	return Object.keys(deserialized).length > 0 ? deserialized : undefined;
 };
+
+/**
+ * Internal-only method to create a new StorageError from a service error.
+ *
+ * @internal
+ */
+export const buildStorageServiceError = (
+	error: Error,
+	statusCode: number
+): ServiceError => {
+	const storageError = new StorageError({
+		name: error.name,
+		message: error.message,
+	});
+	if (statusCode === 404) {
+		storageError.recoverySuggestion =
+			'Please add the object with this key to the bucket as the key is not found.';
+	}
+	return storageError;
+};
diff --git a/packages/storage/src/providers/s3/utils/client/utils/index.ts b/packages/storage/src/providers/s3/utils/client/utils/index.ts
@@ -12,6 +12,7 @@ export {
 	utf8Encode,
 } from '../runtime';
 export {
+	buildStorageServiceError,
 	deserializeBoolean,
 	deserializeMetadata,
 	deserializeNumber,

diff --git a/packages/storage/src/types/params.ts b/packages/storage/src/types/params.ts
@@ -7,7 +7,7 @@ export type StorageOptions =
 	| { accessLevel?: 'guest' | 'private' }
 	| {
 			accessLevel: 'protected';
-			targetIdentityId: string;
+			targetIdentityId?: string;
 	  };
 
 export type StorageOperationRequest<Options extends StorageOptions> = {