Skip to content

feat: adding object url checks #13810

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

Merged
merged 2 commits into from
Sep 17, 2024
Merged

feat: adding object url checks #13810

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6b89836
feat: adding object url checks
scyrizales-amz Sep 13, 2024
4f47ef6
fix: update bundle sizes
scyrizales-amz Sep 16, 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
8 changes: 4 additions & 4 deletions packages/aws-amplify/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -467,19 +467,19 @@
"name": "[Storage] downloadData (S3)",
"path": "./dist/esm/storage/index.mjs",
"import": "{ downloadData }",
"limit": "15.93 kB"
"limit": "16.1 kB"
},
{
"name": "[Storage] getProperties (S3)",
"path": "./dist/esm/storage/index.mjs",
"import": "{ getProperties }",
"limit": "15.20 kB"
"limit": "15.35 kB"
},
{
"name": "[Storage] getUrl (S3)",
"path": "./dist/esm/storage/index.mjs",
"import": "{ getUrl }",
"limit": "16.43 kB"
"limit": "16.55 kB"
},
{
"name": "[Storage] list (S3)",
Expand All @@ -491,7 +491,7 @@
"name": "[Storage] remove (S3)",
"path": "./dist/esm/storage/index.mjs",
"import": "{ remove }",
"limit": "15.05 kB"
"limit": "15.20 kB"
},
{
"name": "[Storage] uploadData (S3)",
Expand Down
93 changes: 93 additions & 0 deletions packages/storage/__tests__/providers/s3/utils/client/s3Data/abortMutipartUpload.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
import { HttpResponse } from '@aws-amplify/core/internals/aws-client-utils';

import { s3TransferHandler } from '../../../../../../src/providers/s3/utils/client/runtime/s3TransferHandler/fetch';
import { abortMultipartUpload } from '../../../../../../src/providers/s3/utils/client/s3data';
import { validateObjectUrl } from '../../../../../../src/providers/s3/utils/validateObjectUrl';
import {
DEFAULT_RESPONSE_HEADERS,
defaultConfig,
expectedMetadata,
} from '../S3/cases/shared';
import { IntegrityError } from '../../../../../../src/errors/IntegrityError';

jest.mock('../../../../../../src/providers/s3/utils/validateObjectUrl');
jest.mock(
'../../../../../../src/providers/s3/utils/client/runtime/s3TransferHandler/fetch',
);

const mockS3TransferHandler = s3TransferHandler as jest.Mock;
const mockBinaryResponse = ({
status,
headers,
body,
}: {
status: number;
headers: Record<string, string>;
body: string;
}): HttpResponse => {
const responseBody = {
json: async (): Promise<any> => {
throw new Error(
'Parsing response to JSON is not implemented. Please use response.text() instead.',
);
},
blob: async () => new Blob([body], { type: 'plain/text' }),
text: async () => body,
} as HttpResponse['body'];

return {
statusCode: status,
headers,
body: responseBody,
} as any;
};

const abortMultipartUploadSuccessResponse = {
status: 200,
headers: {
...DEFAULT_RESPONSE_HEADERS,
'x-amz-version-id': 'versionId',
etag: 'etag',
},
body: '',
};

describe('serializeAbortMultipartUploadRequest', () => {
const mockIsValidObjectUrl = jest.mocked(validateObjectUrl);
beforeEach(() => {
mockS3TransferHandler.mockReset();
});

it('should pass when objectUrl is durable', async () => {
expect.assertions(1);
mockS3TransferHandler.mockResolvedValue(
mockBinaryResponse(abortMultipartUploadSuccessResponse as any),
);
const output = await abortMultipartUpload(defaultConfig, {
Bucket: 'bucket',
Key: 'key',
UploadId: 'upload-id',
});
expect(output).toEqual({
$metadata: expect.objectContaining(expectedMetadata),
});
});

it('should fail when objectUrl is NOT durable', async () => {
expect.assertions(1);
mockS3TransferHandler.mockResolvedValue(
mockBinaryResponse(abortMultipartUploadSuccessResponse as any),
);
const integrityError = new IntegrityError();
mockIsValidObjectUrl.mockImplementationOnce(() => {
throw integrityError;
});
expect(
abortMultipartUpload(defaultConfig, {
Bucket: 'bucket',
Key: 'key',
UploadId: 'upload-id',
}),
).rejects.toThrow(integrityError);
});
});
92 changes: 92 additions & 0 deletions packages/storage/__tests__/providers/s3/utils/client/s3Data/deleteObject.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
import { HttpResponse } from '@aws-amplify/core/internals/aws-client-utils';

import { s3TransferHandler } from '../../../../../../src/providers/s3/utils/client/runtime/s3TransferHandler/fetch';
import { deleteObject } from '../../../../../../src/providers/s3/utils/client/s3data';
import { validateObjectUrl } from '../../../../../../src/providers/s3/utils/validateObjectUrl';
import {
DEFAULT_RESPONSE_HEADERS,
defaultConfig,
expectedMetadata,
} from '../S3/cases/shared';
import { IntegrityError } from '../../../../../../src/errors/IntegrityError';

jest.mock('../../../../../../src/providers/s3/utils/validateObjectUrl');
jest.mock(
'../../../../../../src/providers/s3/utils/client/runtime/s3TransferHandler/fetch',
);

const mockS3TransferHandler = s3TransferHandler as jest.Mock;
const mockBinaryResponse = ({
status,
headers,
body,
}: {
status: number;
headers: Record<string, string>;
body: string;
}): HttpResponse => {
const responseBody = {
json: async (): Promise<any> => {
throw new Error(
'Parsing response to JSON is not implemented. Please use response.text() instead.',
);
},
blob: async () => new Blob([body], { type: 'plain/text' }),
text: async () => body,
} as HttpResponse['body'];

return {
statusCode: status,
headers,
body: responseBody,
} as any;
};

const deleteObjectSuccessResponse = {
status: 200,
headers: {
...DEFAULT_RESPONSE_HEADERS,
'x-amz-version-id': 'versionId',
etag: 'etag',
},
body: '',
};

describe('serializeDeleteObjectRequest', () => {
const mockIsValidObjectUrl = jest.mocked(validateObjectUrl);
beforeEach(() => {
mockS3TransferHandler.mockReset();
});

it('should pass when objectUrl is durable', async () => {
expect.assertions(1);
mockS3TransferHandler.mockResolvedValue(
mockBinaryResponse(deleteObjectSuccessResponse as any),
);
const output = await deleteObject(defaultConfig, {
Bucket: 'bucket',
Key: 'key',
});
expect(output).toEqual({
$metadata: expect.objectContaining(expectedMetadata),
VersionId: 'versionId',
});
});

it('should fail when objectUrl is NOT durable', async () => {
expect.assertions(1);
mockS3TransferHandler.mockResolvedValue(
mockBinaryResponse(deleteObjectSuccessResponse as any),
);
const integrityError = new IntegrityError();
mockIsValidObjectUrl.mockImplementationOnce(() => {
throw integrityError;
});
expect(
deleteObject(defaultConfig, {
Bucket: 'bucket',
Key: 'key',
}),
).rejects.toThrow(integrityError);
});
});
98 changes: 98 additions & 0 deletions packages/storage/__tests__/providers/s3/utils/client/s3Data/getObject.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,98 @@
import { HttpResponse } from '@aws-amplify/core/internals/aws-client-utils';

import { s3TransferHandler } from '../../../../../../src/providers/s3/utils/client/runtime/s3TransferHandler/fetch';
import { getObject } from '../../../../../../src/providers/s3/utils/client/s3data';
import { validateObjectUrl } from '../../../../../../src/providers/s3/utils/validateObjectUrl';
import {
DEFAULT_RESPONSE_HEADERS,
defaultConfig,
expectedMetadata,
} from '../S3/cases/shared';
import { IntegrityError } from '../../../../../../src/errors/IntegrityError';

jest.mock('../../../../../../src/providers/s3/utils/validateObjectUrl');
jest.mock(
'../../../../../../src/providers/s3/utils/client/runtime/s3TransferHandler/fetch',
);

const mockS3TransferHandler = s3TransferHandler as jest.Mock;
const mockBinaryResponse = ({
status,
headers,
body,
}: {
status: number;
headers: Record<string, string>;
body: string;
}): HttpResponse => {
const responseBody = {
json: async (): Promise<any> => {
throw new Error(
'Parsing response to JSON is not implemented. Please use response.text() instead.',
);
},
blob: async () => new Blob([body], { type: 'plain/text' }),
text: async () => body,
} as HttpResponse['body'];

return {
statusCode: status,
headers,
body: responseBody,
} as any;
};

const getObjectSuccessResponse = {
status: 200,
headers: {
...DEFAULT_RESPONSE_HEADERS,
'x-amz-version-id': 'versionId',
etag: 'etag',
},
body: '',
};

describe('serializeGetObjectRequest', () => {
const mockIsValidObjectUrl = jest.mocked(validateObjectUrl);
beforeEach(() => {
mockS3TransferHandler.mockReset();
});

it('should pass when objectUrl is durable', async () => {
expect.assertions(1);
mockS3TransferHandler.mockResolvedValue(
mockBinaryResponse(getObjectSuccessResponse as any),
);
const output = await getObject(defaultConfig, {
Bucket: 'bucket',
Key: 'key',
});
expect(output).toEqual({
$metadata: expect.objectContaining(expectedMetadata),
ETag: 'etag',
VersionId: 'versionId',
Body: expect.objectContaining({
text: expect.any(Function),
blob: expect.any(Function),
json: expect.any(Function),
}),
});
});

it('should fail when objectUrl is NOT durable', async () => {
expect.assertions(1);
mockS3TransferHandler.mockResolvedValue(
mockBinaryResponse(getObjectSuccessResponse as any),
);
const integrityError = new IntegrityError();
mockIsValidObjectUrl.mockImplementationOnce(() => {
throw integrityError;
});
expect(
getObject(defaultConfig, {
Bucket: 'bucket',
Key: 'key',
}),
).rejects.toThrow(integrityError);
});
});
Loading
Loading