Specify "origin private file system"-ness on a FileSystemHandle #110
Conversation
index.bs
Outdated
| 1. Let |isInOriginPrivateFileSystem| be whether | ||
| [=this=] [=FileSystemHandle/is in an origin private file system=]. |
There was a problem hiding this comment.
Alternatively we could specify "origin private file system"-ness on the file system locator so that it can be checked in parallel, but that seemed less easy to understand
| A {{FileSystemHandle}} | ||
| <dfn for=FileSystemHandle export>is in an origin private file system</dfn> | ||
| if the first [=list/item=] of its [=FileSystemHandle/locator=]'s | ||
| [=file system locator/path=] is the empty string. |
There was a problem hiding this comment.
Another option here is to define "the root directory of the origin private file system" and check whether the handle "resolves" to that, but that doesn't set us up well for a multi-OPFS future (#92)
Eventually it would be nice to use Storage Buckets here, but I think this is the best we can do for now
There was a problem hiding this comment.
Just kidding, I just realized that I've been confusing the incubating Storage Buckets API with the already-specified storage bucket concept.
We could give a "file system root" the option to be/have a "storage bucket" (or bottle?), but there's currently no way to get a bucket from the current environment AFAICT? Sorry, I'm not as familiar with how this model is intended to work and I don't have all the context for the issues listed here https://wicg.github.io/storage-buckets/#storage-bucket-getdirectory @evanstade @ayuishii
There was a problem hiding this comment.
OPFS is a storage endpoint and there's one storage bottle inside a storage bucket for each storage endpoint. (The endpoint is like a class, whereas the bottle is an instance of that class.) A storage shelf equates to a storage partition defined by a StorageKey. So a shelf contains buckets which contains bottles.
The issue mentioned in the storage buckets spec is that we need a version of this algorithm which works for any bucket. You'll notice if you drill down into "obtain a local storage bottle map" that it currently assumes the "default" bucket. This just means passing an additional parameter.
We do not currently have a way to go from bottle to bucket for any storage endpoint.
There was a problem hiding this comment.
Thanks for the clarification @estade. I filed #112 to track making getDirectory() work for non-default buckets. Addressing whatwg/storage#2 seems like a prerequisite for adding another parameter to "obtain a local storage bottle map"?
We do not currently have a way to go from bottle to bucket for any storage endpoint.
We just need some way to tie a FileSystemHandle to its root (i.e. two files of the same "file system path" must be considered different if they're from different buckets). There's one OPFS instance per storage bucket, though since there's also only one "fileSystem" bottle per bucket, then using the bottle would also work... though currently, it seems like it's only possible to get a "storage bottle map" and not the storage bottle itself. It seems a bit clumsy to associate a "storage bottle map" with each "file system locator"
Which raises the question of... why don't we just point to the directory entry at map["root"] directly? That would essentially make every "file system locator" a relative path, which on one hand could improve the hand-waviness of the recently-added "locate an entry" and "get the locator" methods, but on the other hand re-raises some of the questions of #59 (i.e. what happens if a root is deleted or moved? #9 (comment))
So, for now at least, I'd prefer to keep "file system locators" absolute and find a way to point to a bottle/bucket :)
There was a problem hiding this comment.
I don't think there's any reason not to have a way to retrieve a bottle. We do have ways to get a bucket, but they're currently specified here instead of in the storage spec.
There was a problem hiding this comment.
I think if we define OPFS in terms of https://storage.spec.whatwg.org/#obtain-a-local-storage-bottle-map you could make this rely less on magic. But that's a more substantial overhaul.
There was a problem hiding this comment.
Ack. I'll leave this PR as just specifying OPFS-ness on a FileSystemHandle, then we can leave better defining the OPFS itself (in terms of the Storage spec) to a follow-up
| A {{FileSystemHandle}} | ||
| <dfn for=FileSystemHandle export>is in an origin private file system</dfn> | ||
| if the first [=list/item=] of its [=FileSystemHandle/locator=]'s | ||
| [=file system locator/path=] is the empty string. |
There was a problem hiding this comment.
I think if we define OPFS in terms of https://storage.spec.whatwg.org/#obtain-a-local-storage-bottle-map you could make this rely less on magic. But that's a more substantial overhaul.
Fixes 103 Gives a FileSystemHandle an "is in an origin private file system" predicate which checks for the empty string in its path
Fixes #103
Related to #92 and #109
Gives a FileSystemHandle an "is in an origin private file system" predicate which checks for the empty string in its path
Preview | Diff