Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename the Origin Private File System to the Bucket File System #129

Merged
merged 3 commits into from
Jun 19, 2023

Conversation

a-sully
Copy link
Collaborator

@a-sully a-sully commented Jun 14, 2023

Fixes #92


Preview | Diff

@a-sully
Copy link
Collaborator Author

a-sully commented Jun 14, 2023

@tomayac
Copy link
Contributor

tomayac commented Jun 15, 2023

Since the publicized name in blogs etc. has been origin private file system, I wonder what we do "brand"-wise. Would it be fair to keep saying "origin private file system" in general, and then more concretely say that "the origin private file system can contain one or multiple bucket file systems"?

@a-sully
Copy link
Collaborator Author

a-sully commented Jun 15, 2023

I think it's fine to continue to refer to it publicly as the Origin Private File System, which at this point seems to have some name recognition and has even crept into interfaces such as sqlite3 WASM. But from the perspective of the spec, we probably should use the more specific term? Developers presumably look at MDN rather than the spec itself anyways, and MDN could have a note explaining the discrepancy

Alternatively we could just leave things as they are (or perhaps make the minimal change of saying "an OPFS" instead of "the OPFS", to imply that there could be multiple per origin)

"the origin private file system can contain one or multiple bucket file systems"

I wouldn't suggest framing it this way, since it makes it seem like an OPFS contains several file systems. An origin (or more accurately, a storage key) can contain several buckets, and therefore several file systems (one per bucket)

@annevk annevk requested a review from szewai June 16, 2023 06:28
Copy link
Member

@annevk annevk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good modulo nit.

index.bs Outdated

The <dfn export>origin private file system</dfn> is a [=storage endpoint=] whose
The <dfn export>bucket file system</dfn> is a [=storage endpoint=] whose
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should keep the existing ID. (For the other <dfn> change I don't think it matters since we introduced it two days ago, but this is much more likely to be referenced already.)

And FWIW, in my opinion it's fine if the ID has a different name from what it identifies. It nicely shows the specification has evolved.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done. I was ready to update all the refs anyways (see WICG/file-system-access#416) but it is nice to see the evolution :)

@tomayac
Copy link
Contributor

tomayac commented Jun 16, 2023

I think it's fine to continue to refer to it publicly as the Origin Private File System, which at this point seems to have some name recognition and has even crept into interfaces such as sqlite3 WASM. But from the perspective of the spec, we probably should use the more specific term? Developers presumably look at MDN rather than the spec itself anyways, and MDN could have a note explaining the discrepancy

FYI, @chrisdavidmills helps us with documenting this on MDN.

Alternatively we could just leave things as they are (or perhaps make the minimal change of saying "an OPFS" instead of "the OPFS", to imply that there could be multiple per origin)

This makes sense to me, and is a minimal change.

I wouldn't suggest framing it this way, since it makes it seem like an OPFS contains several file systems. An origin (or more accurately, a storage key) can contain several buckets, and therefore several file systems (one per bucket)

This may be a stupid question, but calling it Bucket File System sort of implies we have agreement on Storage Buckets (deep-link to the relevant OPFS section)?! Yet it seems like Mozilla's suggested "worth prototyping" position from mozilla/standards-positions#475 is stalled on WICG/storage-buckets#36, and WebKit's not published a position yet looking at WebKit/standards-positions#181.

@annevk
Copy link
Member

annevk commented Jun 16, 2023

No, Bucket here refers to Storage Standard terminology. Not the Storage Buckets APIs.

@tomayac
Copy link
Contributor

tomayac commented Jun 16, 2023

No, Bucket here refers to Storage Standard terminology. Not the Storage Buckets APIs.

Thank you! I see, as per this definition, which the Storage Buckets API also references. It's just a bit confusing that there's also a StorageBucket.

@annevk
Copy link
Member

annevk commented Jun 16, 2023

Well, that's an API instance of that concept, so it's quite logical in a way.

@annevk annevk merged commit 69c51d3 into whatwg:main Jun 19, 2023
@a-sully a-sully deleted the rename-opfs branch June 20, 2023 16:40
a-sully added a commit to WICG/file-system-access that referenced this pull request Jun 20, 2023
whatwg/fs#129 renames the Origin Private File System to the Bucket File System

See whatwg/fs#92 for context
github-actions bot added a commit to WICG/file-system-access that referenced this pull request Jun 20, 2023
… File System

whatwg/fs#129 renames the Origin Private File System to the Bucket File System

See whatwg/fs#92 for context

SHA: 3700ab8
Reason: push, by @a-sully

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

Consider renaming " the Origin Private File System" in anticipation of Storage Buckets
3 participants