Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
@uppy/utils: modernize
getDroppedFiles (#3534)
`webkitGetAsEntry` is a non-standard/deprecated API, replacing it with `getAsFileSystemHandle` when available. This also work around a Chromium bug with symlinks. Fixes: #3505.
- Loading branch information
Showing
6 changed files
with
81 additions
and
53 deletions.
There are no files selected for viewing
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 @@ | ||
| ./cat.jpg |
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 @@ | ||
| ./cat.jpg |
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
99 changes: 52 additions & 47 deletions
99
packages/@uppy/utils/src/getDroppedFiles/utils/webkitGetAsEntryApi/index.js
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 |
|---|---|---|
| @@ -1,56 +1,61 @@ | ||
| import getRelativePath from './getRelativePath.js' | ||
| import getFilesAndDirectoriesFromDirectory from './getFilesAndDirectoriesFromDirectory.js' | ||
| import toArray from '../../../toArray.js' | ||
|
|
||
| export default function webkitGetAsEntryApi (dataTransfer, logDropError) { | ||
| const files = [] | ||
|
|
||
| const rootPromises = [] | ||
|
|
||
| /** | ||
| * Returns a resolved promise, when :files array is enhanced | ||
| * | ||
| * @param {(FileSystemFileEntry|FileSystemDirectoryEntry)} entry | ||
| * @returns {Promise} - empty promise that resolves when :files is enhanced with a file | ||
| */ | ||
| const createPromiseToAddFileOrParseDirectory = (entry) => new Promise((resolve) => { | ||
| // This is a base call | ||
| if (entry.isFile) { | ||
| // Creates a new File object which can be used to read the file. | ||
| entry.file( | ||
| (file) => { | ||
| // eslint-disable-next-line no-param-reassign | ||
| file.relativePath = getRelativePath(entry) | ||
| files.push(file) | ||
| resolve() | ||
| }, | ||
| // Make sure we resolve on error anyway, it's fine if only one file couldn't be read! | ||
| (error) => { | ||
| logDropError(error) | ||
| resolve() | ||
| }, | ||
| ) | ||
| // This is a recursive call | ||
| } else if (entry.isDirectory) { | ||
| /** | ||
| * Interop between deprecated webkitGetAsEntry and standard getAsFileSystemHandle. | ||
| */ | ||
| function getAsFileSystemHandleFromEntry (entry, logDropError) { | ||
| if (entry == null) return entry | ||
| return { | ||
| // eslint-disable-next-line no-nested-ternary | ||
| kind: entry.isFile ? 'file' : entry.isDirectory ? 'directory' : undefined, | ||
| getFile () { | ||
| return new Promise((resolve, reject) => entry.file(resolve, reject)) | ||
| }, | ||
| async* values () { | ||
| // If the file is a directory. | ||
| const directoryReader = entry.createReader() | ||
| getFilesAndDirectoriesFromDirectory(directoryReader, [], logDropError, { | ||
| onSuccess: (entries) => resolve(Promise.all( | ||
| entries.map(createPromiseToAddFileOrParseDirectory), | ||
| )), | ||
| const entries = await new Promise(resolve => { | ||
| getFilesAndDirectoriesFromDirectory(directoryReader, [], logDropError, { | ||
| onSuccess: (dirEntries) => resolve(dirEntries.map(file => getAsFileSystemHandleFromEntry(file, logDropError))), | ||
| }) | ||
| }) | ||
| } | ||
| }) | ||
| yield* entries | ||
| }, | ||
| } | ||
| } | ||
|
|
||
| async function* createPromiseToAddFileOrParseDirectory (entry) { | ||
| // For each dropped item, - make sure it's a file/directory, and start deepening in! | ||
| toArray(dataTransfer.items) | ||
| .forEach((item) => { | ||
| const entry = item.webkitGetAsEntry() | ||
| // :entry can be null when we drop the url e.g. | ||
| if (entry) { | ||
| rootPromises.push(createPromiseToAddFileOrParseDirectory(entry)) | ||
| } | ||
| }) | ||
| if (entry.kind === 'file') { | ||
| const file = await entry.getFile() | ||
| if (file !== null) { | ||
| file.relativePath = getRelativePath(entry) | ||
| yield file | ||
| } | ||
| } else if (entry.kind === 'directory') { | ||
| for await (const handle of entry.values()) { | ||
| yield* createPromiseToAddFileOrParseDirectory(handle) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| return Promise.all(rootPromises) | ||
| .then(() => files) | ||
| export default async function* getFilesFromDataTransfer (dataTransfer, logDropError) { | ||
| for (const item of dataTransfer.items) { | ||
| const lastResortFile = item.getAsFile() // Chromium bug, see https://github.com/transloadit/uppy/issues/3505. | ||
| const entry = await item.getAsFileSystemHandle?.() | ||
| ?? getAsFileSystemHandleFromEntry(item.webkitGetAsEntry(), logDropError) | ||
| // :entry can be null when we drop the url e.g. | ||
| if (entry != null) { | ||
| try { | ||
| yield* createPromiseToAddFileOrParseDirectory(entry, logDropError) | ||
| } catch (err) { | ||
| if (lastResortFile) { | ||
| yield lastResortFile | ||
| } else { | ||
| logDropError(err) | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } |