-
Notifications
You must be signed in to change notification settings - Fork 2.1k
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.
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
fix(storage): Fix MD5 calculation #13458
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
131 changes: 131 additions & 0 deletions
131
packages/storage/__tests__/providers/s3/utils/md5.native.test.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,131 @@ | ||
import { Buffer } from 'buffer'; | ||
|
||
import { Md5 } from '@smithy/md5-js'; | ||
|
||
import { calculateContentMd5 } from '../../../../src/providers/s3/utils/md5.native'; | ||
import { toBase64 } from '../../../../src/providers/s3/utils/client/utils'; | ||
|
||
jest.mock('@smithy/md5-js'); | ||
jest.mock('../../../../src/providers/s3/utils/client/utils'); | ||
jest.mock('buffer'); | ||
|
||
interface MockFileReader { | ||
error?: any; | ||
result?: any; | ||
onload?(): void; | ||
onabort?(): void; | ||
onerror?(): void; | ||
readAsArrayBuffer?(): void; | ||
readAsDataURL?(): void; | ||
} | ||
|
||
// The FileReader in React Native 0.71 did not support `readAsArrayBuffer`. This native implementation accomodates this | ||
// by attempting to use `readAsArrayBuffer` and changing the file reading strategy if it throws an error. | ||
// TODO: This file should be removable when we drop support for React Native 0.71 | ||
describe('calculateContentMd5 (native)', () => { | ||
const stringContent = 'string-content'; | ||
const base64data = 'base-64-data'; | ||
const fileReaderResult = new ArrayBuffer(8); | ||
const fileReaderBase64Result = `data:foo/bar;base64,${base64data}`; | ||
const fileReaderError = new Error(); | ||
// assert mocks | ||
const mockBufferFrom = Buffer.from as jest.Mock; | ||
const mockToBase64 = toBase64 as jest.Mock; | ||
const mockMd5 = Md5 as jest.Mock; | ||
// create mocks | ||
const mockSuccessfulFileReader: MockFileReader = { | ||
readAsArrayBuffer: jest.fn(() => { | ||
mockSuccessfulFileReader.result = fileReaderResult; | ||
mockSuccessfulFileReader.onload?.(); | ||
}), | ||
}; | ||
const mockAbortedFileReader: MockFileReader = { | ||
readAsArrayBuffer: jest.fn(() => { | ||
mockAbortedFileReader.onabort?.(); | ||
}), | ||
}; | ||
const mockFailedFileReader: MockFileReader = { | ||
readAsArrayBuffer: jest.fn(() => { | ||
mockFailedFileReader.error = fileReaderError; | ||
mockFailedFileReader.onerror?.(); | ||
}), | ||
}; | ||
const mockPartialFileReader: MockFileReader = { | ||
readAsArrayBuffer: jest.fn(() => { | ||
throw new Error('Not implemented'); | ||
}), | ||
readAsDataURL: jest.fn(() => { | ||
mockPartialFileReader.result = fileReaderBase64Result; | ||
mockPartialFileReader.onload?.(); | ||
}), | ||
}; | ||
|
||
beforeAll(() => { | ||
mockBufferFrom.mockReturnValue(fileReaderResult); | ||
}); | ||
|
||
afterEach(() => { | ||
jest.clearAllMocks(); | ||
mockMd5.mockReset(); | ||
}); | ||
|
||
it('calculates MD5 for content type: string', async () => { | ||
await calculateContentMd5(stringContent); | ||
const [mockMd5Instance] = mockMd5.mock.instances; | ||
expect(mockMd5Instance.update.mock.calls[0][0]).toBe(stringContent); | ||
expect(mockToBase64).toHaveBeenCalled(); | ||
}); | ||
|
||
it.each([ | ||
{ type: 'ArrayBuffer view', content: new Uint8Array() }, | ||
{ type: 'ArrayBuffer', content: new ArrayBuffer(8) }, | ||
{ type: 'Blob', content: new Blob([stringContent]) }, | ||
])('calculates MD5 for content type: $type', async ({ content }) => { | ||
Object.defineProperty(global, 'FileReader', { | ||
writable: true, | ||
value: jest.fn(() => mockSuccessfulFileReader), | ||
}); | ||
await calculateContentMd5(content); | ||
const [mockMd5Instance] = mockMd5.mock.instances; | ||
expect(mockMd5Instance.update.mock.calls[0][0]).toBe(fileReaderResult); | ||
expect(mockSuccessfulFileReader.readAsArrayBuffer).toHaveBeenCalled(); | ||
expect(mockToBase64).toHaveBeenCalled(); | ||
}); | ||
|
||
it('rejects on file reader abort', async () => { | ||
Object.defineProperty(global, 'FileReader', { | ||
writable: true, | ||
value: jest.fn(() => mockAbortedFileReader), | ||
}); | ||
await expect( | ||
calculateContentMd5(new Blob([stringContent])), | ||
).rejects.toThrow('Read aborted'); | ||
expect(mockAbortedFileReader.readAsArrayBuffer).toHaveBeenCalled(); | ||
expect(mockToBase64).not.toHaveBeenCalled(); | ||
}); | ||
|
||
it('rejects on file reader error', async () => { | ||
Object.defineProperty(global, 'FileReader', { | ||
writable: true, | ||
value: jest.fn(() => mockFailedFileReader), | ||
}); | ||
await expect( | ||
calculateContentMd5(new Blob([stringContent])), | ||
).rejects.toThrow(fileReaderError); | ||
expect(mockFailedFileReader.readAsArrayBuffer).toHaveBeenCalled(); | ||
expect(mockToBase64).not.toHaveBeenCalled(); | ||
}); | ||
|
||
it('tries again using a different strategy if readAsArrayBuffer is unavailable', async () => { | ||
Object.defineProperty(global, 'FileReader', { | ||
writable: true, | ||
value: jest.fn(() => mockPartialFileReader), | ||
}); | ||
await calculateContentMd5(new Blob([stringContent])); | ||
const [mockMd5Instance] = mockMd5.mock.instances; | ||
expect(mockMd5Instance.update.mock.calls[0][0]).toBe(fileReaderResult); | ||
expect(mockPartialFileReader.readAsDataURL).toHaveBeenCalled(); | ||
expect(mockBufferFrom).toHaveBeenCalledWith(base64data, 'base64'); | ||
expect(mockToBase64).toHaveBeenCalled(); | ||
}); | ||
}); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,95 @@ | ||
import { Md5 } from '@smithy/md5-js'; | ||
|
||
import { calculateContentMd5 } from '../../../../src/providers/s3/utils/md5'; | ||
import { toBase64 } from '../../../../src/providers/s3/utils/client/utils'; | ||
|
||
jest.mock('@smithy/md5-js'); | ||
jest.mock('../../../../src/providers/s3/utils/client/utils'); | ||
|
||
interface MockFileReader { | ||
error?: any; | ||
result?: any; | ||
onload?(): void; | ||
onabort?(): void; | ||
onerror?(): void; | ||
readAsArrayBuffer?(): void; | ||
} | ||
|
||
describe('calculateContentMd5', () => { | ||
const stringContent = 'string-content'; | ||
const fileReaderResult = new ArrayBuffer(8); | ||
const fileReaderError = new Error(); | ||
// assert mocks | ||
const mockToBase64 = toBase64 as jest.Mock; | ||
const mockMd5 = Md5 as jest.Mock; | ||
// create mocks | ||
const mockSuccessfulFileReader: MockFileReader = { | ||
readAsArrayBuffer: jest.fn(() => { | ||
mockSuccessfulFileReader.result = fileReaderResult; | ||
mockSuccessfulFileReader.onload?.(); | ||
}), | ||
}; | ||
const mockAbortedFileReader: MockFileReader = { | ||
readAsArrayBuffer: jest.fn(() => { | ||
mockAbortedFileReader.onabort?.(); | ||
}), | ||
}; | ||
const mockFailedFileReader: MockFileReader = { | ||
readAsArrayBuffer: jest.fn(() => { | ||
mockFailedFileReader.error = fileReaderError; | ||
mockFailedFileReader.onerror?.(); | ||
}), | ||
}; | ||
|
||
afterEach(() => { | ||
jest.clearAllMocks(); | ||
mockMd5.mockReset(); | ||
}); | ||
|
||
it('calculates MD5 for content type: string', async () => { | ||
await calculateContentMd5(stringContent); | ||
const [mockMd5Instance] = mockMd5.mock.instances; | ||
expect(mockMd5Instance.update.mock.calls[0][0]).toBe(stringContent); | ||
expect(mockToBase64).toHaveBeenCalled(); | ||
}); | ||
|
||
it.each([ | ||
{ type: 'ArrayBuffer view', content: new Uint8Array() }, | ||
{ type: 'ArrayBuffer', content: new ArrayBuffer(8) }, | ||
{ type: 'Blob', content: new Blob([stringContent]) }, | ||
])('calculates MD5 for content type: $type', async ({ content }) => { | ||
Object.defineProperty(global, 'FileReader', { | ||
writable: true, | ||
value: jest.fn(() => mockSuccessfulFileReader), | ||
}); | ||
await calculateContentMd5(content); | ||
const [mockMd5Instance] = mockMd5.mock.instances; | ||
expect(mockMd5Instance.update.mock.calls[0][0]).toBe(fileReaderResult); | ||
expect(mockSuccessfulFileReader.readAsArrayBuffer).toHaveBeenCalled(); | ||
expect(mockToBase64).toHaveBeenCalled(); | ||
}); | ||
|
||
it('rejects on file reader abort', async () => { | ||
Object.defineProperty(global, 'FileReader', { | ||
writable: true, | ||
value: jest.fn(() => mockAbortedFileReader), | ||
}); | ||
await expect( | ||
calculateContentMd5(new Blob([stringContent])), | ||
).rejects.toThrow('Read aborted'); | ||
expect(mockAbortedFileReader.readAsArrayBuffer).toHaveBeenCalled(); | ||
expect(mockToBase64).not.toHaveBeenCalled(); | ||
}); | ||
|
||
it('rejects on file reader error', async () => { | ||
Object.defineProperty(global, 'FileReader', { | ||
writable: true, | ||
value: jest.fn(() => mockFailedFileReader), | ||
}); | ||
await expect( | ||
calculateContentMd5(new Blob([stringContent])), | ||
).rejects.toThrow(fileReaderError); | ||
expect(mockFailedFileReader.readAsArrayBuffer).toHaveBeenCalled(); | ||
expect(mockToBase64).not.toHaveBeenCalled(); | ||
}); | ||
}); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for the thorough testing on this PR ❤️
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
+++