feat: add gen2 path parameter to getProperties and getUrl

packages/aws-amplify/package.json

@@ -479,7 +479,7 @@
 			"name": "[Storage] getUrl (S3)",
 			"path": "./dist/esm/storage/index.mjs",
 			"import": "{ getUrl }",
-			"limit": "14.50 kB"
+			"limit": "14.60 kB"
 		},
 		{
 			"name": "[Storage] list (S3)",

packages/storage/__tests__/providers/s3/apis/getProperties.test.ts

@@ -5,7 +5,10 @@ import { headObject } from '../../../../src/providers/s3/utils/client';
 import { getProperties } from '../../../../src/providers/s3';
 import { AWSCredentials } from '@aws-amplify/core/internals/utils';
 import { Amplify } from '@aws-amplify/core';
-import { GetPropertiesOptions } from '../../../../src/providers/s3/types';
+import {
+	GetPropertiesOptionsKey,
+	GetPropertiesOptionsPath,
+} from '../../../../src/providers/s3/types';
 
 jest.mock('../../../../src/providers/s3/utils/client');
 jest.mock('@aws-amplify/core', () => ({
@@ -30,10 +33,12 @@ const credentials: AWSCredentials = {
 	sessionToken: 'sessionToken',
 	secretAccessKey: 'secretAccessKey',
 };
+const key = 'key';
+const path = 'path';
 const targetIdentityId = 'targetIdentityId';
 const defaultIdentityId = 'defaultIdentityId';
 
-describe('getProperties api', () => {
+describe('getProperties with key', () => {
 	beforeAll(() => {
 		mockFetchAuthSession.mockResolvedValue({
 			credentials,
@@ -48,9 +53,9 @@ describe('getProperties api', () => {
 			},
 		});
 	});
-	describe('getProperties happy path ', () => {
+	describe('Happy cases: With key', () => {
 		const expected = {
-			key: 'key',
+			key,
 			size: '100',
 			contentType: 'text/plain',
 			eTag: 'etag',
@@ -63,7 +68,6 @@ describe('getProperties api', () => {
 			region: 'region',
 			userAgentValue: expect.any(String),
 		};
-		const key = 'key';
 		beforeEach(() => {
 			mockHeadObject.mockReturnValueOnce({
 				ContentLength: '100',
@@ -77,7 +81,7 @@ describe('getProperties api', () => {
 		afterEach(() => {
 			jest.clearAllMocks();
 		});
-		[
+		test.each([
 			{
 				expectedKey: `public/${key}`,
 			},
@@ -97,30 +101,133 @@ describe('getProperties api', () => {
 				options: { accessLevel: 'protected', targetIdentityId },
 				expectedKey: `protected/${targetIdentityId}/${key}`,
 			},
-		].forEach(({ options, expectedKey }) => {
-			const accessLevelMsg = options?.accessLevel ?? 'default';
-			const targetIdentityIdMsg = options?.targetIdentityId
-				? `and targetIdentityId`
-				: '';
-			it(`should getProperties with ${accessLevelMsg} accessLevel ${targetIdentityIdMsg}`, async () => {
+		])(
+			'should getProperties with key $expectedKey',
+			async ({ options, expectedKey }) => {
 				const headObjectOptions = {
 					Bucket: 'bucket',
 					Key: expectedKey,
 				};
-				expect.assertions(3);
 				expect(
 					await getProperties({
 						key,
-						options: options as GetPropertiesOptions,
+						options: options as GetPropertiesOptionsKey,
 					}),
 				).toEqual(expected);
 				expect(headObject).toHaveBeenCalledTimes(1);
 				expect(headObject).toHaveBeenCalledWith(config, headObjectOptions);
+			},
+		);
+	});
+
+	describe('Error cases :  With key', () => {
+		afterEach(() => {
+			jest.clearAllMocks();
+		});
+		it('getProperties should return a not found error', async () => {
+			mockHeadObject.mockRejectedValueOnce(
+				Object.assign(new Error(), {
+					$metadata: { httpStatusCode: 404 },
+					name: 'NotFound',
+				}),
+			);
+			expect.assertions(3);
+			try {
+				await getProperties({ key });
+			} catch (error: any) {
+				expect(headObject).toHaveBeenCalledTimes(1);
+				expect(headObject).toHaveBeenCalledWith(
+					{
+						credentials,
+						region: 'region',
+						userAgentValue: expect.any(String),
+					},
+					{
+						Bucket: 'bucket',
+						Key: `public/${key}`,
+					},
+				);
+				expect(error.$metadata.httpStatusCode).toBe(404);
+			}
+		});
+	});
+});
+
+describe('Happy cases: With path', () => {
+	beforeAll(() => {
+		mockFetchAuthSession.mockResolvedValue({
+			credentials,
+			identityId: defaultIdentityId,
+		});
+		mockGetConfig.mockReturnValue({
+			Storage: {
+				S3: {
+					bucket,
+					region,
+				},
+			},
+		});
+	});
+	describe('getProperties with path', () => {
+		const expected = {
+			path,
+			size: '100',
+			contentType: 'text/plain',
+			eTag: 'etag',
+			metadata: { key: 'value' },
+			lastModified: 'last-modified',
+			versionId: 'version-id',
+		};
+		const config = {
+			credentials,
+			region: 'region',
+			useAccelerateEndpoint: true,
+			userAgentValue: expect.any(String),
+		};
+		beforeEach(() => {
+			mockHeadObject.mockReturnValueOnce({
+				ContentLength: '100',
+				ContentType: 'text/plain',
+				ETag: 'etag',
+				LastModified: 'last-modified',
+				Metadata: { key: 'value' },
+				VersionId: 'version-id',
 			});
 		});
+		afterEach(() => {
+			jest.clearAllMocks();
+		});
+		test.each([
+			{
+				testPath: path,
+				expectedKey: path,
+			},
+			{
+				testPath: () => path,
+				expectedKey: path,
+			},
+		])(
+			'should getProperties with path $path and expectedKey $expectedKey',
+			async ({ testPath, expectedKey }) => {
+				const headObjectOptions = {
+					Bucket: 'bucket',
+					Key: expectedKey,
+				};
+				expect(
+					await getProperties({
+						path: testPath,
+						options: {
+							useAccelerateEndpoint: true,
+						} as GetPropertiesOptionsPath,
+					}),
+				).toEqual(expected);
+				expect(headObject).toHaveBeenCalledTimes(1);
+				expect(headObject).toHaveBeenCalledWith(config, headObjectOptions);
+			},
+		);
 	});
 
-	describe('getProperties error path', () => {
+	describe('Error cases :  With path', () => {
 		afterEach(() => {
 			jest.clearAllMocks();
 		});
@@ -133,7 +240,7 @@ describe('getProperties api', () => {
 			);
 			expect.assertions(3);
 			try {
-				await getProperties({ key: 'keyed' });
+				await getProperties({ path });
 			} catch (error: any) {
 				expect(headObject).toHaveBeenCalledTimes(1);
 				expect(headObject).toHaveBeenCalledWith(
@@ -144,7 +251,7 @@ describe('getProperties api', () => {
 					},
 					{
 						Bucket: 'bucket',
-						Key: 'public/keyed',
+						Key: path,
 					},
 				);
 				expect(error.$metadata.httpStatusCode).toBe(404);