WICG / file-system-access

Expose the file system on the user’s device, so Web apps can interoperate with the user’s native applications.
https://wicg.github.io/file-system-access/
Other
654 stars 65 forks source link

Reading from a file seems rather unlike existing prior art like `fetch`? #433

Open benlesh opened 9 months ago

benlesh commented 9 months ago

While I understand that fetch generally has fewer ways of getting http responses than something dealing with opening and reading files, this API -- with regards to reading files in particular -- is surprisingly divergent, IMO. I personally found the initial example to be a bit hard to follow, where I was bouncing around inside the code to figure out what was being read, what happens when it's read, and what's initializing the read.

I guess I would have expected something like fetch and how you read the body:

const response = await fetch('/some/image.png');

if (!response.ok) {
  throw new Error('Not good');
}

const reader = await response.body.getReader();

for await (const data of reader) {
  // do things with binary data here.
}

Where a file read that aligns more with the existing API might look like:

const files = await showOpenFilePicker(/* options */);

for (const file of files) {
  console.log(`Reading ${file.name}`);

  // Get a reader
  const fileReader = await file.content.getReader();

  // Read the binary data
  for await (const data of fileReader) {
    // do something with binary data here
  }
}
a-sully commented 9 months ago

One thing I'll mention before addressing your feedback...

I personally found the initial example to be a bit hard to follow, where I was bouncing around inside the code to figure out what was being read, what happens when it's read, and what's initializing the read.

The getFile() method is specified over in https://github.com/whatwg/fs (here). So

While I understand that fetch generally has fewer ways of getting http responses than something dealing with opening and reading files, this API -- with regards to reading files in particular -- is surprisingly divergent, IMO.

The prior art this API builds on is FileSystemFileEntry.file() which returns (via a callback, since it predates promises) a File. File extends Blob, from which you can (among other things) get a ReadableStream (which is what response.body gets you)

const readableStream = (await fileHandle.getFile()).stream()