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

perf: speed up folder tree creation during upload #10057

Merged
merged 2 commits into from
Nov 24, 2023
Merged
Show file tree
Hide file tree
Changes from all 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
6 changes: 6 additions & 0 deletions changelog/unreleased/enhancement-upload-folder-tree-creation
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
Enhancement: Folder tree creation during upload

The performance of the folder tree creation during upload has been improved.

https://github.com/owncloud/web/pull/10057
https://github.com/owncloud/web/issues/9817
6 changes: 6 additions & 0 deletions changelog/unreleased/enhancement-upload-preparation-time
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
Enhancement: Upload preparation time

The performance of the preparation time before each upload has been improved.

https://github.com/owncloud/web/pull/9552
https://github.com/owncloud/web/issues/9817
84 changes: 45 additions & 39 deletions packages/web-app-files/src/HandleUpload.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import Uppy, { UppyFile } from '@uppy/core'
import BasePlugin from '@uppy/core/lib/BasePlugin.js'
import filesize from 'filesize'
import { dirname, join } from 'path'
import { basename, dirname, join } from 'path'
import * as uuid from 'uuid'
import { Language } from 'vue3-gettext'
import { Ref, unref } from 'vue'
Expand Down Expand Up @@ -269,82 +269,88 @@ export class HandleUpload extends BasePlugin {
const space = this.space
const { id: currentFolderId, path: currentFolderPath } = this.currentFolder

const createdFolders = []
const failedFolders = []
const routeName = filesToUpload[0].meta.routeName
const routeDriveAliasAndItem = filesToUpload[0].meta.routeDriveAliasAndItem
const routeShareId = filesToUpload[0].meta.routeShareId

for (const file of filesToUpload) {
const directory = file.meta.relativeFolder
const failedFolders: string[] = []
const directoryTree: Record<string, any> = {}
const topLevelIds: Record<string, string> = {}

if (!directory || createdFolders.includes(directory)) {
continue
for (const file of filesToUpload.filter(({ meta }) => !!meta.relativeFolder)) {
const folders = file.meta.relativeFolder.split('/').filter(Boolean)
let current = directoryTree
if (folders.length <= 1) {
topLevelIds[file.meta.relativeFolder] = file.meta.topLevelFolderId
}
for (const folder of folders) {
current[folder] = current[folder] || {}
current = current[folder]
}
}

const folders = directory.split('/')
let createdSubFolders = ''
for (const subFolder of folders) {
if (!subFolder) {
continue
}

const folderToCreate = `${createdSubFolders}/${subFolder}`
if (createdFolders.includes(folderToCreate)) {
createdSubFolders += `/${subFolder}`
createdFolders.push(createdSubFolders)
continue
}

if (failedFolders.includes(folderToCreate)) {
// only care about top level folders, no need to go deeper
break
}
const createDirectoryLevel = async (current: Record<string, any>, path = '') => {
if (path) {
const isRoot = path.split('/').length <= 1
path = urlJoin(path, { leadingSlash: true })
const uploadId = !isRoot ? uuid.v4() : topLevelIds[path]
const relativeFolder = dirname(path) === '/' ? '' : dirname(path)

const uploadId = createdSubFolders ? uuid.v4() : file.meta.topLevelFolderId
const uppyResource = {
id: uuid.v4(),
name: subFolder,
name: basename(path),
isFolder: true,
type: 'folder',
meta: {
// current space & folder
spaceId: space.id,
spaceName: space.name,
driveAlias: space.driveAlias,
driveType: space.driveType,
currentFolder: currentFolderPath,
currentFolderId,
// upload data
relativeFolder: createdSubFolders,
relativeFolder,
uploadId,
// route data
routeName: file.meta.routeName,
routeDriveAliasAndItem: file.meta.routeDriveAliasAndItem,
routeShareId: file.meta.routeShareId
routeName,
routeDriveAliasAndItem,
routeShareId
}
}

if (failedFolders.includes(relativeFolder)) {
// return if top level folder failed to create
return
}

this.uppyService.publish('addedForUpload', [uppyResource])

try {
const folder = await webdav.createFolder(space, {
path: join(currentFolderPath, folderToCreate)
path: urlJoin(currentFolderPath, path),
fetchFolder: isRoot
})
this.uppyService.publish('uploadSuccess', {
...uppyResource,
meta: { ...uppyResource.meta, fileId: folder?.fileId }
})

createdSubFolders += `/${subFolder}`
createdFolders.push(createdSubFolders)
} catch (error) {
if (error.statusCode !== 405) {
console.error(error)
failedFolders.push(folderToCreate)
failedFolders.push(path)
this.uppyService.publish('uploadError', { file: uppyResource, error })
}
}
}

const foldersToBeCreated = Object.keys(current)
const promises = []
for (const folder of foldersToBeCreated) {
promises.push(createDirectoryLevel(current[folder], join(path, folder)))
}
return Promise.allSettled(promises)
}

await createDirectoryLevel(directoryTree)

let filesToRemove: string[] = []
if (failedFolders.length) {
// remove files of folders that could not be created
Expand Down
3 changes: 2 additions & 1 deletion packages/web-app-files/tests/unit/HandleUpload.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,8 @@ describe('HandleUpload', () => {
)
expect(mocks.opts.clientService.webdav.createFolder).toHaveBeenCalledTimes(1)
expect(mocks.opts.clientService.webdav.createFolder).toHaveBeenCalledWith(mocks.opts.space, {
path: relativeFolder
path: relativeFolder,
fetchFolder: true
})
expect(result.length).toBe(1)
})
Expand Down
9 changes: 7 additions & 2 deletions packages/web-client/src/webdav/createFolder.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,16 @@ export const CreateFolderFactory = (
{ accessToken }: WebDavOptions
) => {
return {
async createFolder(space: SpaceResource, { path }: { path?: string }): Promise<FolderResource> {
async createFolder(
space: SpaceResource,
{ path, fetchFolder = true }: { path?: string; fetchFolder?: boolean }
): Promise<FolderResource> {
const headers = buildAuthHeader(unref(accessToken), space)
await dav.mkcol(urlJoin(space.webDavPath, path, { leadingSlash: true }), { headers })

return getFileInfoFactory.getFileInfo(space, { path })
if (fetchFolder) {
return getFileInfoFactory.getFileInfo(space, { path })
}
}
}
}