Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(storage): add path support to copy API #13104

Merged
merged 8 commits into from
Mar 20, 2024
Merged

feat(storage): add path support to copy API #13104

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
4d36d56
feat(storage): add path supp to copy API
Mar 13, 2024
873a161
address feedback
Mar 15, 2024
93662a6
Merge branch 'gen2-storage' of github.com:aws-amplify/amplify-js into…
Mar 18, 2024
0e1e4ce
address feedback
Mar 18, 2024
a6b4b76
Merge branch 'gen2-storage' of github.com:aws-amplify/amplify-js into…
Mar 19, 2024
276ceee
update copy tests with leading /
Mar 19, 2024
4a9a9dd
address feedback
Mar 20, 2024
8fa5d2f
increase bundle size
Mar 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
299 changes: 193 additions & 106 deletions packages/storage/__tests__/providers/s3/apis/copy.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,13 @@

import { AWSCredentials } from '@aws-amplify/core/internals/utils';
import { Amplify } from '@aws-amplify/core';
import { StorageError } from '../../../../src/';
import { StorageValidationErrorCode } from '../../../../src/errors/types/validation';
import { copyObject } from '../../../../src/providers/s3/utils/client';
import { copy } from '../../../../src/providers/s3/apis';
import {
CopySourceOptions,
CopyDestinationOptions,
CopySourceOptionsKey,
CopyDestinationOptionsKey,
} from '../../../../src/providers/s3/types';

jest.mock('../../../../src/providers/s3/utils/client');
Expand Down Expand Up @@ -63,121 +65,177 @@ describe('copy API', () => {
},
});
});
describe('Happy Path Cases:', () => {
beforeEach(() => {
mockCopyObject.mockImplementation(() => {
return {
Metadata: { key: 'value' },
};

describe('Happy Cases', () => {
describe('With key', () => {
beforeEach(() => {
mockCopyObject.mockImplementation(() => {
return {
Metadata: { key: 'value' },
};
});
});
afterEach(() => {
jest.clearAllMocks();
});
[
{
source: { accessLevel: 'guest' },
destination: { accessLevel: 'guest' },
expectedSourceKey: `${bucket}/public/${sourceKey}`,
expectedDestinationKey: `public/${destinationKey}`,
},
{
source: { accessLevel: 'guest' },
destination: { accessLevel: 'private' },
expectedSourceKey: `${bucket}/public/${sourceKey}`,
expectedDestinationKey: `private/${defaultIdentityId}/${destinationKey}`,
},
{
source: { accessLevel: 'guest' },
destination: { accessLevel: 'protected' },
expectedSourceKey: `${bucket}/public/${sourceKey}`,
expectedDestinationKey: `protected/${defaultIdentityId}/${destinationKey}`,
},
{
source: { accessLevel: 'private' },
destination: { accessLevel: 'guest' },
expectedSourceKey: `${bucket}/private/${defaultIdentityId}/${sourceKey}`,
expectedDestinationKey: `public/${destinationKey}`,
},
{
source: { accessLevel: 'private' },
destination: { accessLevel: 'private' },
expectedSourceKey: `${bucket}/private/${defaultIdentityId}/${sourceKey}`,
expectedDestinationKey: `private/${defaultIdentityId}/${destinationKey}`,
},
{
source: { accessLevel: 'private' },
destination: { accessLevel: 'protected' },
expectedSourceKey: `${bucket}/private/${defaultIdentityId}/${sourceKey}`,
expectedDestinationKey: `protected/${defaultIdentityId}/${destinationKey}`,
},
{
source: { accessLevel: 'protected' },
destination: { accessLevel: 'guest' },
expectedSourceKey: `${bucket}/protected/${defaultIdentityId}/${sourceKey}`,
expectedDestinationKey: `public/${destinationKey}`,
},
{
source: { accessLevel: 'protected' },
destination: { accessLevel: 'private' },
expectedSourceKey: `${bucket}/protected/${defaultIdentityId}/${sourceKey}`,
expectedDestinationKey: `private/${defaultIdentityId}/${destinationKey}`,
},
{
source: { accessLevel: 'protected' },
destination: { accessLevel: 'protected' },
expectedSourceKey: `${bucket}/protected/${defaultIdentityId}/${sourceKey}`,
expectedDestinationKey: `protected/${defaultIdentityId}/${destinationKey}`,
},
{
source: { accessLevel: 'protected', targetIdentityId },
destination: { accessLevel: 'guest' },
expectedSourceKey: `${bucket}/protected/${targetIdentityId}/${sourceKey}`,
expectedDestinationKey: `public/${destinationKey}`,
},
{
source: { accessLevel: 'protected', targetIdentityId },
destination: { accessLevel: 'private' },
expectedSourceKey: `${bucket}/protected/${targetIdentityId}/${sourceKey}`,
expectedDestinationKey: `private/${defaultIdentityId}/${destinationKey}`,
},
{
source: { accessLevel: 'protected', targetIdentityId },
destination: { accessLevel: 'protected' },
expectedSourceKey: `${bucket}/protected/${targetIdentityId}/${sourceKey}`,
expectedDestinationKey: `protected/${defaultIdentityId}/${destinationKey}`,
},
].forEach(
({
source,
destination,
expectedSourceKey,
expectedDestinationKey,
}) => {
const targetIdentityIdMsg = source?.targetIdentityId
? `with targetIdentityId`
: '';
it(`should copy ${source.accessLevel} ${targetIdentityIdMsg} -> ${destination.accessLevel}`, async () => {
expect(
await copy({
source: {
...(source as CopySourceOptionsKey),
key: sourceKey,
},
destination: {
...(destination as CopyDestinationOptionsKey),
key: destinationKey,
},
}),
).toEqual(copyResult);
expect(copyObject).toHaveBeenCalledTimes(1);
expect(copyObject).toHaveBeenCalledWith(copyObjectClientConfig, {
...copyObjectClientBaseParams,
CopySource: expectedSourceKey,
Key: expectedDestinationKey,
});
});
},
);
});
afterEach(() => {
jest.clearAllMocks();
});
[
{
source: { accessLevel: 'guest' },
destination: { accessLevel: 'guest' },
expectedSourceKey: `${bucket}/public/${sourceKey}`,
expectedDestinationKey: `public/${destinationKey}`,
},
{
source: { accessLevel: 'guest' },
destination: { accessLevel: 'private' },
expectedSourceKey: `${bucket}/public/${sourceKey}`,
expectedDestinationKey: `private/${defaultIdentityId}/${destinationKey}`,
},
{
source: { accessLevel: 'guest' },
destination: { accessLevel: 'protected' },
expectedSourceKey: `${bucket}/public/${sourceKey}`,
expectedDestinationKey: `protected/${defaultIdentityId}/${destinationKey}`,
},
{
source: { accessLevel: 'private' },
destination: { accessLevel: 'guest' },
expectedSourceKey: `${bucket}/private/${defaultIdentityId}/${sourceKey}`,
expectedDestinationKey: `public/${destinationKey}`,
},
{
source: { accessLevel: 'private' },
destination: { accessLevel: 'private' },
expectedSourceKey: `${bucket}/private/${defaultIdentityId}/${sourceKey}`,
expectedDestinationKey: `private/${defaultIdentityId}/${destinationKey}`,
},
{
source: { accessLevel: 'private' },
destination: { accessLevel: 'protected' },
expectedSourceKey: `${bucket}/private/${defaultIdentityId}/${sourceKey}`,
expectedDestinationKey: `protected/${defaultIdentityId}/${destinationKey}`,
},
{
source: { accessLevel: 'protected' },
destination: { accessLevel: 'guest' },
expectedSourceKey: `${bucket}/protected/${defaultIdentityId}/${sourceKey}`,
expectedDestinationKey: `public/${destinationKey}`,
},
{
source: { accessLevel: 'protected' },
destination: { accessLevel: 'private' },
expectedSourceKey: `${bucket}/protected/${defaultIdentityId}/${sourceKey}`,
expectedDestinationKey: `private/${defaultIdentityId}/${destinationKey}`,
},
{
source: { accessLevel: 'protected' },
destination: { accessLevel: 'protected' },
expectedSourceKey: `${bucket}/protected/${defaultIdentityId}/${sourceKey}`,
expectedDestinationKey: `protected/${defaultIdentityId}/${destinationKey}`,
},
{
source: { accessLevel: 'protected', targetIdentityId },
destination: { accessLevel: 'guest' },
expectedSourceKey: `${bucket}/protected/${targetIdentityId}/${sourceKey}`,
expectedDestinationKey: `public/${destinationKey}`,
},
{
source: { accessLevel: 'protected', targetIdentityId },
destination: { accessLevel: 'private' },
expectedSourceKey: `${bucket}/protected/${targetIdentityId}/${sourceKey}`,
expectedDestinationKey: `private/${defaultIdentityId}/${destinationKey}`,
},
{
source: { accessLevel: 'protected', targetIdentityId },
destination: { accessLevel: 'protected' },
expectedSourceKey: `${bucket}/protected/${targetIdentityId}/${sourceKey}`,
expectedDestinationKey: `protected/${defaultIdentityId}/${destinationKey}`,
},
].forEach(
({ source, destination, expectedSourceKey, expectedDestinationKey }) => {
const targetIdentityIdMsg = source?.targetIdentityId
? `with targetIdentityId`
: '';
it(`should copy ${source.accessLevel} ${targetIdentityIdMsg} -> ${destination.accessLevel}`, async () => {
expect.assertions(3);

describe('With path', () => {
beforeEach(() => {
mockCopyObject.mockImplementation(() => {
return {
Metadata: { key: 'value' },
};
});
});
afterEach(() => {
jest.clearAllMocks();
});

test.each([
{
sourcePath: 'sourcePathAsString',
expectedSourcePath: 'sourcePathAsString',
destinationPath: 'destinationPathAsString',
expectedDestinationPath: 'destinationPathAsString',
},
{
sourcePath: () => 'sourcePathAsFunction',
expectedSourcePath: 'sourcePathAsFunction',
destinationPath: () => 'destinationPathAsFunction',
expectedDestinationPath: 'destinationPathAsFunction',
},
])(
'should copy $sourcePath -> $destinationPath',
async ({
sourcePath,
expectedSourcePath,
destinationPath,
expectedDestinationPath,
}) => {
expect(
await copy({
source: {
...(source as CopySourceOptions),
key: sourceKey,
},
destination: {
...(destination as CopyDestinationOptions),
key: destinationKey,
},
source: { path: sourcePath },
destination: { path: destinationPath },
}),
).toEqual(copyResult);
).toEqual({ path: expectedDestinationPath });
expect(copyObject).toHaveBeenCalledTimes(1);
expect(copyObject).toHaveBeenCalledWith(copyObjectClientConfig, {
...copyObjectClientBaseParams,
CopySource: expectedSourceKey,
Key: expectedDestinationKey,
CopySource: `${bucket}/${expectedSourcePath}`,
Key: expectedDestinationPath,
});
});
},
);
},
);
});
});

describe('Error Path Cases:', () => {
describe('Error Cases:', () => {
afterEach(() => {
jest.clearAllMocks();
});
Expand Down Expand Up @@ -206,5 +264,34 @@ describe('copy API', () => {
expect(error.$metadata.httpStatusCode).toBe(404);
}
});

it('should return a path not found error when source uses path and destination uses key', async () => {
expect.assertions(2);
try {
// @ts-expect-error
await copy({
source: { path: 'sourcePath' },
destination: { key: 'destinationKey' },
});
} catch (error: any) {
expect(error).toBeInstanceOf(StorageError);
// source uses path so destination expects path as well
expect(error.name).toBe(StorageValidationErrorCode.NoDestinationPath);
}
});

it('should return a key not found error when source uses key and destination uses path', async () => {
expect.assertions(2);
try {
// @ts-expect-error
await copy({
source: { key: 'sourcePath' },
destination: { path: 'destinationKey' },
});
} catch (error: any) {
expect(error).toBeInstanceOf(StorageError);
expect(error.name).toBe(StorageValidationErrorCode.NoDestinationKey);
}
});
});
});
8 changes: 8 additions & 0 deletions packages/storage/src/errors/types/validation.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ export enum StorageValidationErrorCode {
NoKey = 'NoKey',
NoSourceKey = 'NoSourceKey',
NoDestinationKey = 'NoDestinationKey',
NoSourcePath = 'NoSourcePath',
NoDestinationPath = 'NoDestinationPath',
NoBucket = 'NoBucket',
NoRegion = 'NoRegion',
InvalidStorageOperationInput = 'InvalidStorageOperationInput',
Expand All @@ -35,6 +37,12 @@ export const validationErrorMap: AmplifyErrorMap<StorageValidationErrorCode> = {
[StorageValidationErrorCode.NoDestinationKey]: {
message: 'Missing destination key in copy api call.',
},
[StorageValidationErrorCode.NoSourcePath]: {
message: 'Missing source path in copy api call.',
},
[StorageValidationErrorCode.NoDestinationPath]: {
message: 'Missing destination path in copy api call.',
},
[StorageValidationErrorCode.NoBucket]: {
message: 'Missing bucket name while accessing object.',
},
Expand Down
Loading
Loading