#868: The `FileSystemObserver` interface

Visit on Github.

Opened Jun 23, 2023

こんにちは TAG-さん!

I'm requesting a TAG review of the FileSystemObserver interface for the File System specification.

This proposal introduces a FileSystemObserver interface which will much more easily allow a website to be notified of changes to the file system.

The file system is a shared resource that can be modified from several contexts. A Bucket File System (a.k.a. an Origin Private File System, or OPFS) spans numerous agents - tabs, workers, etc - within the same storage key. The local file system also spans across origins and other applications on the host operating system.

Currently, for a given agent to know about modifications to the file system - made either by itself or from some external context - it must poll the file system to detect changes. This is inefficient and does not scale well.

Further details:

  • I have reviewed the TAG's Web Platform Design Principles
  • The group where the incubation/design work on this is being done: whatwg/fs and WICG/file-system-access
  • The group where standardization of this work is intended to be done: whatwg/fs
  • Existing major pieces of multi-stakeholder review or discussion of this design: Developers have enumerated several use cases, discussed various designs, and provided example code for how file paths can be watched with the existing APIs in https://github.com/WICG/file-system-access/issues/72. No discussion with other stakeholders yet
  • Major unresolved issues with or opposition to this design:
  • This work is being funded by: Google

You should also know that...

The proposed interface can be used to observe both files on the user's local device (as specified in WICG/file-system-access) and files in the Bucket File System (as specified in whatwg/fs).

We'd prefer the TAG provide feedback as (please delete all but the desired option):

🐛 open issues in our GitHub repo for each point of feedback

Discussions

2023-12-18

Minutes

Holding comment, Multistakeholder? Current status?

Amy: the use cases in the explainer are not from the user's perspective.

Yves: clearly for developers...

2024-01-london

Minutes

lea shares comment

2024-01-london

Minutes

Sangwhan: I am OK with this

Yves: use case is OK....

Yves: it says on the local file system... def of local file system may be Origin-controlled. Looks OK but depeneds on whether other stakeholders...

Dan: does it have a dependency on local filesystem?

Yves: no.

Sangwhan: no.

Sangwhan: I'm looking at the API to see if it makes sense... API looks good to me.

Dan: please add some wording to encourage continued engagement with additional implementers...

Sangwhan: closes