dify/web/service/use-app-asset.ts
yyh 12ca422c8a
fix(app-assets): restore atomic batch upload for nested folder targets
The previous nested folder upload flow bypassed the backend batch-upload
contract when parentId was set. Instead of creating the whole metadata
tree in one backend operation, the frontend recursively called
createFolder/getFileUploadUrl for each node.

That introduced two regressions for uploads into subfolders:

- consistency regression: mid-sequence failures could leave partially
  created folder trees under the destination folder
- performance regression: metadata creation degraded from a single
  batch request to O(files + folders) round-trips before file bytes
  were uploaded

This change moves nested uploads back to the original batch semantics:

- add optional parent_id support to app asset batch-upload payload
- create the whole nested tree under the target parent in
  AppAssetService.batch_create_from_tree
- pass parentId through useBatchUpload instead of using per-node
  createFolder/getFileUploadUrl calls
- remove the now-unnecessary useBatchUploadOperation wrapper
- add a backend unit test covering batch tree creation under an
  existing parent folder

After this change, both root uploads and subfolder uploads use the same
single-request metadata creation path, preserving atomic tree creation
semantics and avoiding avoidable metadata round-trips.
2026-03-26 15:16:55 +08:00

328 lines
8.7 KiB
TypeScript

import type {
AppAssetNode,
BatchUploadNodeInput,
BatchUploadNodeOutput,
CreateFolderPayload,
GetFileUploadUrlPayload,
MoveNodePayload,
RenameNodePayload,
ReorderNodePayload,
UpdateFileContentPayload,
} from '@/types/app-asset'
import {
useMutation,
useQueryClient,
} from '@tanstack/react-query'
import { consoleClient, consoleQuery } from '@/service/client'
import { upload } from './base'
import { uploadToPresignedUrl } from './upload-to-presigned-url'
export function appAssetTreeOptions(appId: string) {
return consoleQuery.appAsset.tree.queryOptions({
input: { params: { appId } },
})
}
export function appAssetFileContentOptions(appId: string, nodeId: string) {
return consoleQuery.appAsset.getFileContent.queryOptions({
input: { params: { appId, nodeId } },
select: (data) => {
try {
return JSON.parse(data.content)
}
catch {
return { content: data.content }
}
},
})
}
export function appAssetFileDownloadUrlOptions(appId: string, nodeId: string) {
return consoleQuery.appAsset.getFileDownloadUrl.queryOptions({
input: { params: { appId, nodeId } },
})
}
export const useCreateAppAssetFolder = () => {
const queryClient = useQueryClient()
return useMutation({
mutationKey: consoleQuery.appAsset.createFolder.mutationKey(),
mutationFn: ({ appId, payload }: { appId: string, payload: CreateFolderPayload }) => {
return consoleClient.appAsset.createFolder({
params: { appId },
body: payload,
})
},
onSuccess: (_, variables) => {
queryClient.invalidateQueries({
queryKey: consoleQuery.appAsset.tree.key({ type: 'query', input: { params: { appId: variables.appId } } }),
})
},
})
}
export const useUpdateAppAssetFileContent = () => {
return useMutation({
mutationKey: consoleQuery.appAsset.updateFileContent.mutationKey(),
mutationFn: ({
appId,
nodeId,
payload,
}: {
appId: string
nodeId: string
payload: UpdateFileContentPayload
}) => {
return consoleClient.appAsset.updateFileContent({
params: { appId, nodeId },
body: { content: JSON.stringify(payload) },
})
},
})
}
export const useUpdateAppAssetFileByUpload = () => {
const queryClient = useQueryClient()
return useMutation({
mutationFn: async ({
appId,
nodeId,
file,
onProgress,
}: {
appId: string
nodeId: string
file: File
onProgress?: (progress: number) => void
}): Promise<AppAssetNode> => {
const formData = new FormData()
formData.append('file', file)
const xhr = new XMLHttpRequest()
return upload(
{
xhr,
method: 'PUT',
data: formData,
onprogress: onProgress
? (e) => {
if (e.lengthComputable)
onProgress(Math.round((e.loaded / e.total) * 100))
}
: undefined,
},
false,
`/apps/${appId}/assets/files/${nodeId}`,
) as Promise<AppAssetNode>
},
onSuccess: (_, variables) => {
queryClient.invalidateQueries({
queryKey: consoleQuery.appAsset.getFileContent.key({
type: 'query',
input: { params: { appId: variables.appId, nodeId: variables.nodeId } },
}),
})
},
})
}
export const useDeleteAppAssetNode = () => {
const queryClient = useQueryClient()
return useMutation({
mutationKey: consoleQuery.appAsset.deleteNode.mutationKey(),
mutationFn: ({ appId, nodeId }: { appId: string, nodeId: string }) => {
return consoleClient.appAsset.deleteNode({
params: { appId, nodeId },
})
},
onSuccess: (_, variables) => {
queryClient.invalidateQueries({
queryKey: consoleQuery.appAsset.tree.key({ type: 'query', input: { params: { appId: variables.appId } } }),
})
},
})
}
export const useRenameAppAssetNode = () => {
const queryClient = useQueryClient()
return useMutation({
mutationKey: consoleQuery.appAsset.renameNode.mutationKey(),
mutationFn: ({
appId,
nodeId,
payload,
}: {
appId: string
nodeId: string
payload: RenameNodePayload
}) => {
return consoleClient.appAsset.renameNode({
params: { appId, nodeId },
body: payload,
})
},
onSuccess: (_, variables) => {
queryClient.invalidateQueries({
queryKey: consoleQuery.appAsset.tree.key({ type: 'query', input: { params: { appId: variables.appId } } }),
})
},
})
}
export const useMoveAppAssetNode = () => {
const queryClient = useQueryClient()
return useMutation({
mutationKey: consoleQuery.appAsset.moveNode.mutationKey(),
mutationFn: ({
appId,
nodeId,
payload,
}: {
appId: string
nodeId: string
payload: MoveNodePayload
}) => {
return consoleClient.appAsset.moveNode({
params: { appId, nodeId },
body: payload,
})
},
onSuccess: (_, variables) => {
queryClient.invalidateQueries({
queryKey: consoleQuery.appAsset.tree.key({ type: 'query', input: { params: { appId: variables.appId } } }),
})
},
})
}
export const useReorderAppAssetNode = () => {
const queryClient = useQueryClient()
return useMutation({
mutationKey: consoleQuery.appAsset.reorderNode.mutationKey(),
mutationFn: ({
appId,
nodeId,
payload,
}: {
appId: string
nodeId: string
payload: ReorderNodePayload
}) => {
return consoleClient.appAsset.reorderNode({
params: { appId, nodeId },
body: payload,
})
},
onSuccess: (_, variables) => {
queryClient.invalidateQueries({
queryKey: consoleQuery.appAsset.tree.key({ type: 'query', input: { params: { appId: variables.appId } } }),
})
},
})
}
export const useUploadFileWithPresignedUrl = () => {
const queryClient = useQueryClient()
return useMutation({
mutationKey: consoleQuery.appAsset.getFileUploadUrl.mutationKey(),
mutationFn: async ({
appId,
file,
parentId,
onProgress,
}: {
appId: string
file: File
parentId?: string | null
onProgress?: (progress: number) => void
}): Promise<AppAssetNode> => {
const payload: GetFileUploadUrlPayload = {
name: file.name,
size: file.size,
parent_id: parentId,
}
const { node, upload_url } = await consoleClient.appAsset.getFileUploadUrl({
params: { appId },
body: payload,
})
await uploadToPresignedUrl({
file,
uploadUrl: upload_url,
onProgress,
})
return node
},
onSettled: (_, __, variables) => {
queryClient.invalidateQueries({
queryKey: consoleQuery.appAsset.tree.key({ type: 'query', input: { params: { appId: variables.appId } } }),
})
},
})
}
export const useBatchUpload = () => {
const queryClient = useQueryClient()
return useMutation({
mutationKey: consoleQuery.appAsset.batchUpload.mutationKey(),
mutationFn: async ({
appId,
tree,
files,
parentId,
onProgress,
}: {
appId: string
tree: BatchUploadNodeInput[]
files: Map<string, File>
parentId?: string | null
onProgress?: (uploaded: number, total: number) => void
}): Promise<BatchUploadNodeOutput[]> => {
const response = await consoleClient.appAsset.batchUpload({
params: { appId },
body: { children: tree, parent_id: parentId },
})
const uploadTasks: Array<{ path: string, file: File, url: string }> = []
const extractUploads = (nodes: BatchUploadNodeOutput[], pathPrefix: string = '') => {
for (const node of nodes) {
const currentPath = pathPrefix ? `${pathPrefix}/${node.name}` : node.name
if (node.upload_url) {
const file = files.get(currentPath)
if (file)
uploadTasks.push({ path: currentPath, file, url: node.upload_url })
}
if (node.children && node.children.length > 0)
extractUploads(node.children, currentPath)
}
}
extractUploads(response.children)
let completed = 0
const total = uploadTasks.length
await Promise.all(
uploadTasks.map(async (task) => {
await uploadToPresignedUrl({
file: task.file,
uploadUrl: task.url,
})
completed++
onProgress?.(completed, total)
}),
)
return response.children
},
onSettled: (_, __, variables) => {
queryClient.invalidateQueries({
queryKey: consoleQuery.appAsset.tree.key({ type: 'query', input: { params: { appId: variables.appId } } }),
})
},
})
}