Add a storage key comparison algorithm #134
Conversation
This PR adds and exports an algorithm for comparing two storage keys. This will be useful for non-storage APIs that want to partition state using storage keys. Also, adding my name to the 'Acknowledgments' section since I forgot to do this with my previous commit. :D
storage.bs
Outdated
| @@ -229,6 +229,17 @@ settings object</a> <var>environment</var>, run these steps: | |||
| <li><p>Return <var>key</var>. | |||
| </ol> | |||
|
|
|||
| <p>To determine whether a <a>storage key</a> <var>A</var> | |||
| <dfn export for="storage key" id=concept-storage-key-equals lt=equal>equals</dfn> <var>B</var>, run | |||
There was a problem hiding this comment.
Let's repeat "a storage key" in front of B for maximum clarity.
There was a problem hiding this comment.
Also no need to include an ID here. For new things we let Bikeshed generate one.
There was a problem hiding this comment.
I modeled it off of this: https://github.com/whatwg/url/blob/main/url.bs#L1144-L1146
There they didn't repeat the type for B, but I agree that it's helpful for maximum clarity. Also, manually adding the id lets us prepend concept to it, which seems like something that's done in a lot of places (without the id specified, bikeshed makes it storage-key-equals). I'm happy to drop it, though.
There was a problem hiding this comment.
Yeah, concept- is a legacy pre-Bikeshed thing.
Also, always fun to have your own code come back to bite you. I can fix that one.
storage.bs
Outdated
| these steps: | ||
|
|
||
| <ol> | ||
| <li><p>If <var>A</var>'s <a for="storage key">origin</a> is not <a lt="same origin">same-origin</a> |
There was a problem hiding this comment.
"same origin" sans hyphen is what we typically use.
There was a problem hiding this comment.
I modeled this after https://github.com/whatwg/url/blob/main/url.bs#L2730-L2731, but it looks like "same origin with" is indeed much more commonly used in places like https://html.spec.whatwg.org/multipage/origin.html. Will change!
|
Thanks for the review @annevk, all changes should now be addressed |
|
Thank you! |
This PR adds and exports an algorithm for comparing two storage keys. This will be useful for non-storage APIs that want to partition state using storage keys.
Also, adding my name to the 'Acknowledgments' section since I forgot to do this with my previous PR. :D
Fixes #133
I don't think tests or implementation bugs are needed for this change since this PR doesn't change any existing functionality.
Preview | Diff