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.

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

@uppy/core: improve performance of validating & uploading files #4402

Merged
merged 21 commits into from
Apr 15, 2023
Merged
Show file tree
Hide file tree
Changes from 16 commits
Commits
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
4 changes: 2 additions & 2 deletions e2e/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -45,11 +45,11 @@
"@uppy/zoom": "workspace:^"
},
"devDependencies": {
"cypress": "^10.0.0",
"cypress": "^12.9.0",
"cypress-terminal-report": "^4.1.2",
"deep-freeze": "^0.0.1",
"execa": "^6.1.0",
"parcel": "^2.0.1",
"parcel": "2.0.0-nightly.1278",
"prompts": "^2.4.2",
"react": "^18.1.0",
"react-dom": "^18.1.0",
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
"@babel/preset-env": "^7.14.7",
"@babel/register": "^7.10.5",
"@babel/types": "^7.17.0",
"@parcel/transformer-vue": "2.7.0",
"@parcel/transformer-vue": "2.8.4-nightly.2903+5b901a317",
"@types/jasmine": "file:./private/@types/jasmine",
"@types/jasminewd2": "file:./private/@types/jasmine",
"@typescript-eslint/eslint-plugin": "^5.0.0",
Expand Down
28 changes: 19 additions & 9 deletions packages/@uppy/aws-s3-multipart/src/MultipartUploader.js
Original file line number Diff line number Diff line change
Expand Up @@ -70,19 +70,29 @@ class MultipartUploader {

// Upload zero-sized files in one zero-sized chunk
if (this.#data.size === 0) {
this.#chunks = [this.#data]
this.#data.onProgress = this.#onPartProgress(0)
this.#data.onComplete = this.#onPartComplete(0)
this.#chunks = [{
getData: () => this.#data,
onProgress: this.#onPartProgress(0),
onComplete: this.#onPartComplete(0),
}]
} else {
const arraySize = Math.ceil(fileSize / chunkSize)
this.#chunks = Array(arraySize)
let j = 0
for (let i = 0; i < fileSize; i += chunkSize) {

for (let i = 0, j = 0; i < fileSize; i += chunkSize, j++) {
const end = Math.min(fileSize, i + chunkSize)
const chunk = this.#data.slice(i, end)
chunk.onProgress = this.#onPartProgress(j)
chunk.onComplete = this.#onPartComplete(j)
this.#chunks[j++] = chunk

// Defer data fetching/slicing until we actually need the data, because it's slow if we have a lot of files
const getData = () => {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We need to remember to port these to #4205, right?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes, seems like that pr will get a merge conflict once we merge this

const i2 = i
return this.#data.slice(i2, end)
}

this.#chunks[j] = {
getData,
onProgress: this.#onPartProgress(j),
onComplete: this.#onPartComplete(j),
}
}
}

Expand Down
73 changes: 34 additions & 39 deletions packages/@uppy/aws-s3-multipart/src/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import EventTracker from '@uppy/utils/lib/EventTracker'
import emitSocketProgress from '@uppy/utils/lib/emitSocketProgress'
import getSocketHost from '@uppy/utils/lib/getSocketHost'
import { RateLimitedQueue } from '@uppy/utils/lib/RateLimitedQueue'

import { filterNonFailedFiles, filterFilesToEmitUploadStarted } from '@uppy/utils/lib/fileFilters'
import { createAbortError } from '@uppy/utils/lib/AbortController'
import packageJson from '../package.json'
import MultipartUploader from './MultipartUploader.js'
Expand Down Expand Up @@ -200,17 +200,23 @@ class HTTPCommunicationQueue {
return this.#sendCompletionRequest(file, { key, uploadId, parts, signal }).abortOn(signal)
}

async uploadChunk (file, partNumber, body, signal) {
async uploadChunk (file, partNumber, chunk, signal) {
throwIfAborted(signal)
const { uploadId, key } = await this.getUploadId(file, signal)
throwIfAborted(signal)
for (;;) {
const signature = await this.#fetchSignature(file, { uploadId, key, partNumber, body, signal }).abortOn(signal)
const chunkData = chunk.getData()
const { onProgress, onComplete } = chunk

const signature = await this.#fetchSignature(file, {
uploadId, key, partNumber, body: chunkData, signal,
}).abortOn(signal)

throwIfAborted(signal)
try {
return {
PartNumber: partNumber,
...await this.#uploadPartBytes(signature, body, signal).abortOn(signal),
...await this.#uploadPartBytes({ signature, body: chunkData, onProgress, onComplete, signal }).abortOn(signal),
}
} catch (err) {
if (!await this.#shouldRetry(err)) throw err
Expand Down Expand Up @@ -258,8 +264,6 @@ export default class AwsS3Multipart extends BasePlugin {
}
}

this.upload = this.upload.bind(this)

/**
* Simultaneous upload limiting is shared across all uploads with this plugin.
*
Expand Down Expand Up @@ -369,7 +373,7 @@ export default class AwsS3Multipart extends BasePlugin {
.then(assertServerError)
}

static async uploadPartBytes ({ url, expires, headers }, body, signal) {
static async uploadPartBytes ({ signature: { url, expires, headers }, body, onProgress, onComplete, signal }) {
throwIfAborted(signal)

if (url == null) {
Expand Down Expand Up @@ -397,7 +401,7 @@ export default class AwsS3Multipart extends BasePlugin {
}
signal.addEventListener('abort', onabort)

xhr.upload.addEventListener('progress', body.onProgress)
xhr.upload.addEventListener('progress', onProgress)

xhr.addEventListener('abort', () => {
cleanup()
Expand Down Expand Up @@ -427,7 +431,7 @@ export default class AwsS3Multipart extends BasePlugin {
return
}

body.onProgress?.(body.size)
onProgress?.(body.size)

// NOTE This must be allowed by CORS.
const etag = ev.target.getResponseHeader('ETag')
Expand All @@ -437,7 +441,7 @@ export default class AwsS3Multipart extends BasePlugin {
return
}

body.onComplete?.(etag)
onComplete?.(etag)
resolve({
ETag: etag,
})
Expand Down Expand Up @@ -466,8 +470,10 @@ export default class AwsS3Multipart extends BasePlugin {
})
}

uploadFile (file) {
#uploadFile (file) {
return new Promise((resolve, reject) => {
const getFile = () => this.uppy.getFile(file.id) || file

const onProgress = (bytesUploaded, bytesTotal) => {
this.uppy.emit('upload-progress', file, {
uploader: this,
Expand All @@ -485,7 +491,6 @@ export default class AwsS3Multipart extends BasePlugin {
}

const onSuccess = (result) => {
const uploadObject = upload // eslint-disable-line no-use-before-define
const uploadResp = {
body: {
...result,
Expand All @@ -495,23 +500,17 @@ export default class AwsS3Multipart extends BasePlugin {

this.resetUploaderReferences(file.id)

const cFile = this.uppy.getFile(file.id)
this.uppy.emit('upload-success', cFile || file, uploadResp)
this.uppy.emit('upload-success', getFile(), uploadResp)

if (result.location) {
this.uppy.log(`Download ${file.name} from ${result.location}`)
}

resolve(uploadObject)
resolve()
}

const onPartComplete = (part) => {
const cFile = this.uppy.getFile(file.id)
if (!cFile) {
return
}

this.uppy.emit('s3-multipart:part-uploaded', cFile, part)
this.uppy.emit('s3-multipart:part-uploaded', getFile(), part)
}

const upload = new MultipartUploader(file.data, {
Expand Down Expand Up @@ -564,11 +563,7 @@ export default class AwsS3Multipart extends BasePlugin {
upload.start()
})

// Don't double-emit upload-started for Golden Retriever-restored files that were already started
if (!file.progress.uploadStarted || !file.isRestored) {
upload.start()
this.uppy.emit('upload-started', file)
}
upload.start()
})
}

Expand Down Expand Up @@ -597,14 +592,9 @@ export default class AwsS3Multipart extends BasePlugin {

// NOTE! Keep this duplicated code in sync with other plugins
// TODO we should probably abstract this into a common function
async uploadRemote (file) {
async #uploadRemote (file) {
this.resetUploaderReferences(file.id)

// Don't double-emit upload-started for Golden Retriever-restored files that were already started
if (!file.progress.uploadStarted || !file.isRestored) {
this.uppy.emit('upload-started', file)
}

try {
if (file.serverToken) {
return await this.connectToServerSocket(file)
Expand Down Expand Up @@ -733,15 +723,20 @@ export default class AwsS3Multipart extends BasePlugin {
})
}

async upload (fileIDs) {
#upload = async (fileIDs) => {
if (fileIDs.length === 0) return undefined

const promises = fileIDs.map((id) => {
const file = this.uppy.getFile(id)
const files = this.uppy.getFilesByIds(fileIDs)

const filesFiltered = filterNonFailedFiles(files)
const filesToEmit = filterFilesToEmitUploadStarted(filesFiltered)
this.uppy.emit('upload-start', filesToEmit)

const promises = filesFiltered.map((file) => {
if (file.isRemote) {
return this.uploadRemote(file)
return this.#uploadRemote(file)
}
return this.uploadFile(file)
return this.#uploadFile(file)
})

return Promise.all(promises)
Expand Down Expand Up @@ -810,7 +805,7 @@ export default class AwsS3Multipart extends BasePlugin {
},
})
this.uppy.addPreProcessor(this.#setCompanionHeaders)
this.uppy.addUploader(this.upload)
this.uppy.addUploader(this.#upload)
}

uninstall () {
Expand All @@ -822,6 +817,6 @@ export default class AwsS3Multipart extends BasePlugin {
},
})
this.uppy.removePreProcessor(this.#setCompanionHeaders)
this.uppy.removeUploader(this.upload)
this.uppy.removeUploader(this.#upload)
}
}
12 changes: 7 additions & 5 deletions packages/@uppy/aws-s3/src/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@
import BasePlugin from '@uppy/core/lib/BasePlugin.js'
import { RateLimitedQueue, internalRateLimitedQueue } from '@uppy/utils/lib/RateLimitedQueue'
import { RequestClient } from '@uppy/companion-client'
import { filterNonFailedFiles, filterFilesToEmitUploadStarted } from '@uppy/utils/lib/fileFilters'

import packageJson from '../package.json'
import MiniXHRUpload from './MiniXHRUpload.js'
Expand Down Expand Up @@ -163,7 +164,7 @@ export default class AwsS3 extends BasePlugin {
.then(assertServerError)
}

#handleUpload = (fileIDs) => {
#handleUpload = async (fileIDs) => {
/**
* keep track of `getUploadParameters()` responses
* so we can cancel the calls individually using just a file ID
Expand All @@ -178,10 +179,11 @@ export default class AwsS3 extends BasePlugin {
}
this.uppy.on('file-removed', onremove)

fileIDs.forEach((id) => {
const file = this.uppy.getFile(id)
this.uppy.emit('upload-started', file)
})
const files = this.uppy.getFilesByIds(fileIDs)

const filesFiltered = filterNonFailedFiles(files)
const filesToEmit = filterFilesToEmitUploadStarted(filesFiltered)
this.uppy.emit('upload-start', filesToEmit)

const getUploadParameters = this.#requests.wrapPromiseFunction((file) => {
return this.opts.getUploadParameters(file)
Expand Down
Loading