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

Jump to bottom

Retry prepareUploadParts on fail for @uppy/aws-s3-multipart #3224

Merged
merged 8 commits into from Oct 1, 2021
Merged

Retry prepareUploadParts on fail for @uppy/aws-s3-multipart #3224

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
56a85ee
Use `retryable` to retry `prepareUploadParts`
Murderlon Sep 22, 2021
428b4fc
Correctly handle errors in prepareUploadParts
Murderlon Sep 23, 2021
fb2971c
Refactor tests to async/await
Murderlon Sep 23, 2021
2286afb
Throw error in prepareUploadParts
Murderlon Sep 23, 2021
2a1ac74
Remove unnecessary try/catch block
Murderlon Sep 23, 2021
de883a8
Use `async` instead of `Promise`
Murderlon Sep 27, 2021
6014cc4
Update docs about retrying
Murderlon Sep 28, 2021
2ed4fa5
Apply suggestions from code review
Murderlon Oct 1, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
14 changes: 8 additions & 6 deletions packages/@uppy/aws-s3-multipart/src/MultipartUploader.js
View file
Open in desktop
Expand Up @@ -244,18 +244,20 @@ class MultipartUploader {
async #prepareUploadParts (candidates) {
this.lockedCandidatesForBatch.push(...candidates)

const result = await this.options.prepareUploadParts({
key: this.key,
uploadId: this.uploadId,
partNumbers: candidates.map((index) => index + 1),
const result = await this.#retryable({
attempt: () => this.options.prepareUploadParts({
key: this.key,
uploadId: this.uploadId,
partNumbers: candidates.map((index) => index + 1),
}),
})

const valid = typeof result?.presignedUrls === 'object'
if (!valid) {
if (typeof result?.presignedUrls !== 'object') {
throw new TypeError(
'AwsS3/Multipart: Got incorrect result from `prepareUploadParts()`, expected an object `{ presignedUrls }`.'
)
}

return result
}

Expand Down
140 changes: 98 additions & 42 deletions packages/@uppy/aws-s3-multipart/src/index.test.js
View file
Open in desktop
Expand Up @@ -52,28 +52,32 @@ describe('AwsS3Multipart', () => {
}),
completeMultipartUpload: jest.fn(() => Promise.resolve({ location: 'test' })),
abortMultipartUpload: jest.fn(),
prepareUploadParts: jest.fn(() => {
prepareUploadParts: jest.fn(() => new Promise((resolve) => {
Murderlon marked this conversation as resolved.
Show resolved Hide resolved
const presignedUrls = {}
const possiblePartNumbers = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10]
possiblePartNumbers.forEach((partNumber) => {
presignedUrls[
partNumber
] = `https://bucket.s3.us-east-2.amazonaws.com/test/upload/multitest.dat?partNumber=${partNumber}&uploadId=6aeb1980f3fc7ce0b5454d25b71992&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIATEST%2F20210729%2Fus-east-2%2Fs3%2Faws4_request&X-Amz-Date=20210729T014044Z&X-Amz-Expires=600&X-Amz-SignedHeaders=host&X-Amz-Signature=test`
})
return { presignedUrls }
}),
return resolve({ presignedUrls })
})),
})
awsS3Multipart = core.getPlugin('AwsS3Multipart')
})

it('Calls the prepareUploadParts function totalChunks / limit times', (done) => {
it('Calls the prepareUploadParts function totalChunks / limit times', async () => {
const scope = nock(
'https://bucket.s3.us-east-2.amazonaws.com'
).defaultReplyHeaders({
'access-control-allow-method': 'PUT',
'access-control-allow-origin': '*',
'access-control-expose-headers': 'ETag',
})
// 6MB file will give us 2 chunks, so there will be 2 PUT and 2 OPTIONS
// calls to the presigned URL from 1 prepareUploadParts calls
const fileSize = 5 * MB + 1 * MB

scope
.options((uri) => uri.includes('test/upload/multitest.dat'))
.reply(200, '')
Expand All @@ -87,9 +91,6 @@ describe('AwsS3Multipart', () => {
.put((uri) => uri.includes('test/upload/multitest.dat'))
.reply(200, '', { ETag: 'test2' })

// 6MB file will give us 2 chunks, so there will be 2 PUT and 2 OPTIONS
// calls to the presigned URL from 1 prepareUploadParts calls
const fileSize = 5 * MB + 1 * MB
core.addFile({
source: 'jest',
name: 'multitest.dat',
Expand All @@ -98,23 +99,31 @@ describe('AwsS3Multipart', () => {
type: 'application/octet-stream',
}),
})
core.upload().then(() => {
expect(
awsS3Multipart.opts.prepareUploadParts.mock.calls.length
).toEqual(1)
scope.done()
done()
})

await core.upload()

expect(
awsS3Multipart.opts.prepareUploadParts.mock.calls.length
).toEqual(1)

scope.done()
})

it('Calls prepareUploadParts with a Math.ceil(limit / 2) minimum, instead of one at a time for the remaining chunks after the first limit batch', (done) => {
it('Calls prepareUploadParts with a Math.ceil(limit / 2) minimum, instead of one at a time for the remaining chunks after the first limit batch', async () => {
const scope = nock(
'https://bucket.s3.us-east-2.amazonaws.com'
).defaultReplyHeaders({
'access-control-allow-method': 'PUT',
'access-control-allow-origin': '*',
'access-control-expose-headers': 'ETag',
})
// 50MB file will give us 10 chunks, so there will be 10 PUT and 10 OPTIONS
// calls to the presigned URL from 3 prepareUploadParts calls
//
// The first prepareUploadParts call will be for 5 parts, the second
// will be for 3 parts, the third will be for 2 parts.
const fileSize = 50 * MB

scope
.options((uri) => uri.includes('test/upload/multitest.dat'))
.reply(200, '')
Expand All @@ -123,12 +132,6 @@ describe('AwsS3Multipart', () => {
.reply(200, '', { ETag: 'test' })
scope.persist()

// 50MB file will give us 10 chunks, so there will be 10 PUT and 10 OPTIONS
// calls to the presigned URL from 3 prepareUploadParts calls
//
// The first prepareUploadParts call will be for 5 parts, the second
// will be for 3 parts, the third will be for 2 parts.
const fileSize = 50 * MB
core.addFile({
source: 'jest',
name: 'multitest.dat',
Expand All @@ -137,28 +140,81 @@ describe('AwsS3Multipart', () => {
type: 'application/octet-stream',
}),
})
core.upload().then(() => {
expect(
awsS3Multipart.opts.prepareUploadParts.mock.calls.length
).toEqual(3)
expect(awsS3Multipart.opts.prepareUploadParts.mock.calls[0][1].partNumbers).toEqual([1, 2, 3, 4, 5])
expect(awsS3Multipart.opts.prepareUploadParts.mock.calls[1][1].partNumbers).toEqual([6, 7, 8])
expect(awsS3Multipart.opts.prepareUploadParts.mock.calls[2][1].partNumbers).toEqual([9, 10])
const completeCall = awsS3Multipart.opts.completeMultipartUpload.mock.calls[0][1]
expect(completeCall.parts).toEqual([
{ ETag: 'test', PartNumber: 1 },
{ ETag: 'test', PartNumber: 2 },
{ ETag: 'test', PartNumber: 3 },
{ ETag: 'test', PartNumber: 4 },
{ ETag: 'test', PartNumber: 5 },
{ ETag: 'test', PartNumber: 6 },
{ ETag: 'test', PartNumber: 7 },
{ ETag: 'test', PartNumber: 8 },
{ ETag: 'test', PartNumber: 9 },
{ ETag: 'test', PartNumber: 10 },
])
done()

await core.upload()

expect(awsS3Multipart.opts.prepareUploadParts.mock.calls.length).toEqual(3)
expect(awsS3Multipart.opts.prepareUploadParts.mock.calls[0][1].partNumbers).toEqual([1, 2, 3, 4, 5])
expect(awsS3Multipart.opts.prepareUploadParts.mock.calls[1][1].partNumbers).toEqual([6, 7, 8])
expect(awsS3Multipart.opts.prepareUploadParts.mock.calls[2][1].partNumbers).toEqual([9, 10])

const completeCall = awsS3Multipart.opts.completeMultipartUpload.mock.calls[0][1]

expect(completeCall.parts).toEqual([
{ ETag: 'test', PartNumber: 1 },
{ ETag: 'test', PartNumber: 2 },
{ ETag: 'test', PartNumber: 3 },
{ ETag: 'test', PartNumber: 4 },
{ ETag: 'test', PartNumber: 5 },
{ ETag: 'test', PartNumber: 6 },
{ ETag: 'test', PartNumber: 7 },
{ ETag: 'test', PartNumber: 8 },
{ ETag: 'test', PartNumber: 9 },
{ ETag: 'test', PartNumber: 10 },
])
})
})

describe('MultipartUploader', () => {
let core
let awsS3Multipart

beforeEach(() => {
core = new Core()
core.use(AwsS3Multipart, {
createMultipartUpload: jest.fn(() => {
return {
uploadId: '6aeb1980f3fc7ce0b5454d25b71992',
key: 'test/upload/multitest.dat',
}
}),
completeMultipartUpload: jest.fn(() => Promise.resolve({ location: 'test' })),
Murderlon marked this conversation as resolved.
Show resolved Hide resolved
abortMultipartUpload: jest.fn(),
prepareUploadParts: jest
.fn(() => new Promise((resolve) => {
const presignedUrls = {}
const possiblePartNumbers = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10]

possiblePartNumbers.forEach((partNumber) => {
presignedUrls[
partNumber
] = `https://bucket.s3.us-east-2.amazonaws.com/test/upload/multitest.dat?partNumber=${partNumber}&uploadId=6aeb1980f3fc7ce0b5454d25b71992&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIATEST%2F20210729%2Fus-east-2%2Fs3%2Faws4_request&X-Amz-Date=20210729T014044Z&X-Amz-Expires=600&X-Amz-SignedHeaders=host&X-Amz-Signature=test`
})

return resolve({ presignedUrls })
}))
// This runs first and only once
// eslint-disable-next-line prefer-promise-reject-errors
.mockImplementationOnce(() => Promise.reject({ source: { status: 500 } })),
})
awsS3Multipart = core.getPlugin('AwsS3Multipart')
})

it('retries prepareUploadParts when it fails once', async () => {
const fileSize = 5 * MB + 1 * MB

core.addFile({
source: 'jest',
name: 'multitest.dat',
type: 'application/octet-stream',
data: new File([Buffer.alloc(fileSize)], {
type: 'application/octet-stream',
}),
})

await core.upload()

expect(awsS3Multipart.opts.prepareUploadParts.mock.calls.length).toEqual(2)
})
})
})