storage.session quota enforcement #35629

rebloor · 2024-08-29T00:21:01Z

Description

Provides a release note for the enforcement of the session.storage quota in Firefox Nightly 131. Addresses the documentation requirements of Bug 1908925 storage.session quota is not enforced.

github-actions · 2024-08-29T00:22:32Z

Preview URLs (9 pages)

Flaws (1)

Note! 8 documents with no flaws that don't need to be listed. 🎉

URL: /en-US/docs/Mozilla/Add-ons/WebExtensions/API/storage/session/QUOTA_BYTES
Title: storage.session.QUOTA_BYTES
Flaw count: 1

bad_bcd_queries:
- No BCD data for query: webextensions.api.storage.session.QUOTA_BYTES

External URLs (4)

URL: /en-US/docs/Mozilla/Add-ons/WebExtensions/API/storage/StorageArea/getBytesInUse
Title: StorageArea.getBytesInUse()

https://bugzil.la/1385832 (2 times) (Note! This may be a new URL 👀)

URL: /en-US/docs/Mozilla/Firefox/Releases/131
Title: Firefox 131 for developers

https://bugzil.la/1409262 (2 times) (Note! This may be a new URL 👀)
https://bugzil.la/1908925 (2 times) (Note! This may be a new URL 👀)
https://bugzil.la/1915688 (1 time) (Note! This may be a new URL 👀)

(comment last updated: 2024-10-01 23:03:28)

zombie

lgtm, thanks

Rob--W

The bug did not only introduce enforcement of the quota, but also support for the storage.session.getBytesInUse method and the storage.session.QUOTA_BYTES constant.

Could you update the docs and BCD?

files/en-us/mozilla/firefox/releases/131/index.md

Co-authored-by: Rob Wu <[email protected]>

Rob--W · 2024-09-02T18:35:25Z

files/en-us/mozilla/add-ons/webextensions/api/storage/session/quota_bytes/index.md

+
+{{AddonSidebar}}
+
+The maximum amount of data (in bytes) that can be stored in session storage. The amount of data in session storage is the sum of the size of every value (as measured by the StructuredCloneHolder) plus the sum of every key's length.


Suggested change

The maximum amount of data (in bytes) that can be stored in session storage. The amount of data in session storage is the sum of the size of every value (as measured by the StructuredCloneHolder) plus the sum of every key's length.

The maximum amount of data (in bytes) that can be stored in session storage.

StructuredCloneHolder is an internal inplementation detail. Let's drop it.

May make sense to refer to getBytesInUse to query hoe much quota is used.

Rob--W · 2024-09-02T18:36:28Z

files/en-us/mozilla/add-ons/webextensions/api/storage/session/quota_bytes/index.md

+
+{{Compat}}
+
+<!--


Let's drop this whole section.

Rob--W · 2024-09-02T18:41:11Z

files/en-us/mozilla/add-ons/webextensions/api/storage/storagearea/getbytesinuse/index.md

@@ -23,16 +24,14 @@ let gettingSpace = browser.storage.<storageType>.getBytesInUse(
 )
 ```

-`<storageType>` can only be {{WebExtAPIRef("storage.sync")}}, not {{WebExtAPIRef("storage.local")}} because of [this bug](https://bugzil.la/1385832).


<storageType> refers to the fragment in the code sample. Let's keep it but refer to all formats that are supported. For example, see https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/storage/StorageArea/remove

While looking at other docs I noticed that "writable" should be dropped from https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/storage/StorageArea/get . Let's drop it (managed storage is not writable).

Rob--W

Approved provided that the one comment in getBytesInUse gets addressed. Feel free to request another review.

Rob--W · 2024-09-02T23:01:01Z

files/en-us/mozilla/add-ons/webextensions/api/storage/storagearea/getbytesinuse/index.md

-`<storageType>` can only be {{WebExtAPIRef("storage.sync")}}, not {{WebExtAPIRef("storage.local")}} because of [this bug](https://bugzil.la/1385832).
+Where `<storageType>` is one of the storage types — {{WebExtAPIRef("storage.sync", "sync")}}, {{WebExtAPIRef("storage.local", "local")}}, {{WebExtAPIRef("storage.session", "session")}}, or {{WebExtAPIRef("storage.managed", "managed")}}.
+
+In Firefox, `<storageType>` can't be {{WebExtAPIRef("storage.local")}}, because of [bug 1385832](https://bugzil.la/1385832), and {{WebExtAPIRef("storage.managed")}} isn't supported.


The current phrasing misleadingly claims that storage.managed is unsupported in Firefox. That is not the case. Another potential interpretation is that it is somehow related to the previous claim about storage.local.

To avoid confusion, consider dropping the mention of "managed" from getBytesInUse above.

Note that support is limited:

Firefox does not offer a storage.managed.getBytesInUse method.

Chrome does have a method, but its resolved value is always 0, as seen in this unit test: https://source.chromium.org/chromium/chromium/src/+/main:chrome/test/data/extensions/api_test/settings/managed_storage/background.js;drc=4a8573cb240df29b0e4d9820303538fb28e31d84

Not the best wording - followed your suggestion and added the info about Chrome to the BCD

github-actions · 2024-09-20T02:41:01Z

This pull request has merge conflicts that must be resolved before it can be merged.

Rob--W

Approved with the minor issue addressed.

files/en-us/mozilla/add-ons/webextensions/api/storage/storagearea/getbytesinuse/index.md

Co-authored-by: Rob Wu <[email protected]>

dipikabh · 2024-10-01T13:59:04Z

Hi @rebloor, @Rob--W, is this PR ready to be merged?
We're readying the files to publish the release notes for Firefox 131.

github-actions · 2024-10-01T17:00:03Z

This pull request has merge conflicts that must be resolved before it can be merged.

Rob--W · 2024-10-01T18:27:17Z

Yes I approved and it is ready from the data perspective. There is a merge conflict now though...

rebloor added 2 commits August 29, 2024 12:16

storage.session quota enforcement release note

ab70d3d

Added bug ref

1e7b281

rebloor added the Content:WebExt WebExtensions docs label Aug 29, 2024

rebloor requested a review from dotproto August 29, 2024 00:21

rebloor self-assigned this Aug 29, 2024

rebloor requested a review from a team as a code owner August 29, 2024 00:21

rebloor requested review from dipikabh and removed request for a team August 29, 2024 00:21

github-actions bot added Content:Firefox Content in the Mozilla/Firefox subtree size/xs [PR only] 0-5 LoC changed and removed Content:WebExt WebExtensions docs labels Aug 29, 2024

Rob--W requested review from zombie and removed request for dipikabh August 29, 2024 07:10

zombie approved these changes Aug 29, 2024

View reviewed changes

Rob--W requested changes Aug 29, 2024

View reviewed changes

files/en-us/mozilla/firefox/releases/131/index.md Outdated Show resolved Hide resolved

rebloor and others added 2 commits August 31, 2024 05:05

134 release bug link

562d27a

Co-authored-by: Rob Wu <[email protected]>

Additional features from the bug fix

4b90cce

rebloor requested a review from a team as a code owner September 2, 2024 09:00

github-actions bot added Content:WebExt WebExtensions docs size/m [PR only] 51-500 LoC changed and removed size/xs [PR only] 0-5 LoC changed labels Sep 2, 2024

rebloor changed the title ~~storage.session quota enforcement release note~~ storage.session quota enforcement Sep 2, 2024

rebloor requested a review from Rob--W September 2, 2024 09:02

Rob--W requested changes Sep 2, 2024

View reviewed changes

rebloor mentioned this pull request Sep 2, 2024

Storage Updates mdn/browser-compat-data#24272

Merged

Updates from feedback

f785e27

rebloor requested a review from Rob--W September 2, 2024 22:39

Rob--W approved these changes Sep 2, 2024

View reviewed changes

Clarification

a972d1a

github-actions bot added the merge conflicts 🚧 [PR only] label Sep 20, 2024

Merge branch 'main' into storage.session-quota-enforcement

277dacb

github-actions bot removed the merge conflicts 🚧 [PR only] label Sep 20, 2024

Rob--W approved these changes Sep 20, 2024

View reviewed changes

files/en-us/mozilla/add-ons/webextensions/api/storage/storagearea/getbytesinuse/index.md Outdated Show resolved Hide resolved

rebloor and others added 3 commits September 21, 2024 05:41

Apply suggestions from review

07e5cf4

Co-authored-by: Rob Wu <[email protected]>

Merge branch 'main' into storage.session-quota-enforcement

ed3e7cf

getBytesInUse support details update

ad5b3a8

Rob--W approved these changes Sep 24, 2024

View reviewed changes

github-actions bot added the merge conflicts 🚧 [PR only] label Oct 1, 2024

Merge branch 'main' into storage.session-quota-enforcement

802ecf8

github-actions bot removed the merge conflicts 🚧 [PR only] label Oct 1, 2024

rebloor merged commit dd98fd4 into mdn:main Oct 1, 2024
8 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

storage.session quota enforcement #35629

storage.session quota enforcement #35629

rebloor commented Aug 29, 2024

github-actions bot commented Aug 29, 2024 •

edited

Loading

zombie left a comment •

edited

Loading

Rob--W left a comment

Rob--W Sep 2, 2024

Rob--W Sep 2, 2024

Rob--W Sep 2, 2024

Rob--W left a comment

Rob--W Sep 2, 2024

rebloor Sep 3, 2024

github-actions bot commented Sep 20, 2024

Rob--W left a comment

dipikabh commented Oct 1, 2024

github-actions bot commented Oct 1, 2024

Rob--W commented Oct 1, 2024


		{{AddonSidebar}}

		The maximum amount of data (in bytes) that can be stored in session storage. The amount of data in session storage is the sum of the size of every value (as measured by the StructuredCloneHolder) plus the sum of every key's length.


		{{Compat}}

		<!--

storage.session quota enforcement #35629

storage.session quota enforcement #35629

Conversation

rebloor commented Aug 29, 2024

Description

github-actions bot commented Aug 29, 2024 • edited Loading

zombie left a comment • edited Loading

Choose a reason for hiding this comment

Rob--W left a comment

Choose a reason for hiding this comment

Rob--W Sep 2, 2024

Choose a reason for hiding this comment

Rob--W Sep 2, 2024

Choose a reason for hiding this comment

Rob--W Sep 2, 2024

Choose a reason for hiding this comment

Rob--W left a comment

Choose a reason for hiding this comment

Rob--W Sep 2, 2024

Choose a reason for hiding this comment

rebloor Sep 3, 2024

Choose a reason for hiding this comment

github-actions bot commented Sep 20, 2024

Rob--W left a comment

Choose a reason for hiding this comment

dipikabh commented Oct 1, 2024

github-actions bot commented Oct 1, 2024

Rob--W commented Oct 1, 2024

github-actions bot commented Aug 29, 2024 •

edited

Loading

zombie left a comment •

edited

Loading