New DNR properties #34214

rebloor · 2024-06-17T02:47:33Z

Description

Summary

Adds and updates documentation in support of Bug 1894128
[DNR] Replace MAX_NUMBER_OF_DYNAMIC_AND_SESSION_RULES including:

release note
new pages for MAX_NUMBER_OF_DYNAMIC_RULES and MAX_NUMBER_OF_SESSION_RULES
relevant update where MAX_NUMBER_OF_DYNAMIC_AND_SESSION_RULES is mentioned

Related issues and pull requests

BCD changes in mdn/browser-compat-data#23400

github-actions · 2024-06-17T02:49:02Z

Preview URLs (9 pages)

Flaws (4)

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

URL: /en-US/docs/Mozilla/Firefox/Releases/128
Title: Firefox 128 for developers
Flaw count: 2

macros:
- /en-US/docs/Web/API/MediaKeys/getStatusForPolicy does not exist
broken_links:
- Can't resolve /en-US/docs/Web/HTTP/Headers/Priority

URL: /en-US/docs/Mozilla/Add-ons/WebExtensions/API/declarativeNetRequest/MAX_NUMBER_OF_DYNAMIC_RULES
Title: declarativeNetRequest.MAX_NUMBER_OF_DYNAMIC_RULES
Flaw count: 1

bad_bcd_queries:
- No BCD data for query: webextensions.api.declarativeNetRequest.MAX_NUMBER_OF_DYNAMIC_RULES

URL: /en-US/docs/Mozilla/Add-ons/WebExtensions/API/declarativeNetRequest/MAX_NUMBER_OF_SESSION_RULES
Title: declarativeNetRequest.MAX_NUMBER_OF_SESSION_RULES
Flaw count: 1

bad_bcd_queries:
- No BCD data for query: webextensions.api.declarativeNetRequest.MAX_NUMBER_OF_SESSION_RULES

External URLs (2)

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

https://bugzil.la/1894128 (1 time) (Note! This may be a new URL 👀)

URL: /en-US/docs/Mozilla/Add-ons/WebExtensions/API/declarativeNetRequest/MAX_NUMBER_OF_DYNAMIC_AND_SESSION_RULES
Title: declarativeNetRequest.MAX_NUMBER_OF_DYNAMIC_AND_SESSION_RULES

https://developer.chrome.com/docs/extensions/reference/api/declarativeNetRequest (1 time) (Note! This may be a new URL 👀)

(comment last updated: 2024-07-10 04:16:17)

...mozilla/add-ons/webextensions/api/declarativenetrequest/max_number_of_dynamic_rules/index.md

...mozilla/add-ons/webextensions/api/declarativenetrequest/max_number_of_session_rules/index.md

dotproto · 2024-06-17T18:33:07Z

files/en-us/mozilla/add-ons/webextensions/api/declarativenetrequest/index.md

-The number of dynamic and session-scoped rules an extension can add is limited to the value of {{WebExtAPIRef("declarativeNetRequest.MAX_NUMBER_OF_DYNAMIC_AND_SESSION_RULES","MAX_NUMBER_OF_DYNAMIC_AND_SESSION_RULES")}}.
+The number of dynamic and session-scoped rules an extension can add is limited to:
+
+- Up to Chrome 119 and Firefox 127, the value of {{WebExtAPIRef("declarativeNetRequest.MAX_NUMBER_OF_DYNAMIC_AND_SESSION_RULES","MAX_NUMBER_OF_DYNAMIC_AND_SESSION_RULES")}}.


Should we mention here (and in other similar text on other pages) that this value is also used in Safari? It appears that they have a 30,000 rule limit.

dotproto · 2024-06-17T19:29:15Z

I also just realized that MAX_NUMBER_OF_UNSAFE_SESSION_RULES and MAX_NUMBER_OF_UNSAFE_DYNAMIC_RULES aren't included in this PR. Even though they're only supported by Chromium. We should probably cover them even though they're only supported by Chrome.

rebloor · 2024-06-18T02:55:06Z

I also just realized that MAX_NUMBER_OF_UNSAFE_SESSION_RULES and MAX_NUMBER_OF_UNSAFE_DYNAMIC_RULES aren't included in this PR. Even though they're only supported by Chromium. We should probably cover them even though they're only supported by Chrome.

@dotproto Sorry, I should've included my note from the BCD here also i.e. MAX_NUMBER_OF_UNSAFE_DYNAMIC_RULES and MAX_NUMBER_OF_UNSAFE_SESSION_RULES - new entries, excluding documentation links as these haven't been implemented in Firefox yet (to be implemented in bug 1894119)

I've done this because there have been some comments made in the past about potential problems of including documentation for features not included in Firefox.

Co-authored-by: Simeon Vincent <svincent@gmail.com>

pepelsbey

Looks good from the editorial perspective. Thanks!

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

Co-authored-by: Vadim Makeev <hi@pepelsbey.dev>

github-actions · 2024-06-26T09:36:35Z

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

github-actions · 2024-07-08T02:55:41Z

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

Rob--W · 2024-07-08T05:10:08Z

files/en-us/mozilla/add-ons/webextensions/api/declarativenetrequest/updatedynamicrules/index.md

@@ -12,7 +12,9 @@ Modifies the set of dynamic rules for the extension. The rules with IDs listed i
 - This update happens as an atomic operation: either all specified rules are added and removed, or an error is returned.
 - These rules are persisted across browser sessions and across extension updates.
 - Static rules specified as part of the extension package can not be removed using this function.
- {{WebExtAPIRef("declarativeNetRequest.MAX_NUMBER_OF_DYNAMIC_AND_SESSION_RULES")}} is the maximum number of dynamic and session rules an extension can add.
+- The number of rules that can be added is limited:
+  - In Safari and up to Chrome 119 and Firefox 127, to the value of {{WebExtAPIRef("declarativeNetRequest.MAX_NUMBER_OF_DYNAMIC_AND_SESSION_RULES","MAX_NUMBER_OF_DYNAMIC_AND_SESSION_RULES")}} for the combined total of dynamic and session-scoped rules.


In Firefox and Safari, the quotas have always been separate, never together. This feedback also applies to the other part of your PR.

Rob--W · 2024-07-08T10:48:07Z

...ons/webextensions/api/declarativenetrequest/max_number_of_dynamic_and_session_rules/index.md


-In Firefox, each ruleset has its own quota.
+In Chrome and Safari, this limit is enforced for the combined total of dynamic and session-scoped rules.


In Chrome this was only combined until 119, from 120 they are separate (and that is why the constant was deprecated in Chrome). https://developer.chrome.com/docs/extensions/reference/api/declarativeNetRequest#session-rules

@Rob--W I've added a clarification to the comment about the deprecation. However, wouldn't it be most accurate to say that the property is deprecated and the limit superseded, given the limit here is 30,000 but the limits on the separate properties are 30,00 and 5000 which presumably means that from 120 rather than a combined 30,000 dynamic and session rules you can now set up 35,000 e.g. 30000+5000?

@Rob--W I've added a clarification to the comment about the deprecation. However, wouldn't it be most accurate to say that the property is deprecated and the limit superseded, given the limit here is 30,000 but the limits on the separate properties are 30,00 and 5000 which presumably means that from 120 rather than a combined 30,000 dynamic and session rules you can now set up 35,000 e.g. 30000+5000?

If all requirements have been met, then an extension in Chrome 120+ can have 5000 session rules (like Firefox) and 30000 safe dynamic rules. The max number of dynamic rules in Chrome is 30000, but that is limited to "safe" rules (https://developer.chrome.com/docs/extensions/reference/api/declarativeNetRequest#safe_rules) a concept that Firefox hasn't implemented yet. If an extension wants other kinds of rules, such as redirect rules, then they are bound to MAX_NUMBER_OF_UNSAFE_DYNAMIC_RULES, capped at 5000.

So if an extension wants to have many redirect (or modifyHeaders) rules, they can have at most 5000+5000 dynamic and session rules, combined 10000. Combined means that the individual quotas have to be maximized, it is not possible to have 4999 session rules and 5001 ("unsafe") dynamic rules.

@Rob--W does this get any closer to the reality of what MAX_NUMBER_OF_DYNAMIC_AND_SESSION_RULES means/ment:

until Firefox 126, this property had a value of 5000 and indicated that an extension could create up to 5000 dynamic rules and up to 5000 session-scope rules. This property was deprecated in Firefox 126, and the limits are now defined separately for each rule type by MAX_NUMBER_OF_DYNAMIC_RULES and MAX_NUMBER_OF_SESSION_RULES.

until Chrome 119, this property had a value of 30,000 and indicated that an extension could create any combination of dynamic and session-scope up to 30,000. This property was deprecated in Chrome 120. See rule limits in the Chrome documentation for information on limits in Chrome 120 and higher.

in Safari, this property has a value of 30,000 ad indicates an extension can create any combination of dynamic and session-scope rules up to 30,000.

That is correct for Safari.

Almost correct - until Chrome 119 the limit was 5000.

…o DNR-properties

* DNR properties changes * Note re-chrome deprecation of MAX_NUMBER_OF_DYNAMIC_AND_SESSION_RULES * Additional notes Merged with failing Active LTS due to the absence of MDN pages added with mdn/content#34214

New DNR properties

c0e4fe1

rebloor added the Content:WebExt WebExtensions docs label Jun 17, 2024

rebloor requested a review from dotproto June 17, 2024 02:47

rebloor self-assigned this Jun 17, 2024

rebloor requested review from a team as code owners June 17, 2024 02:47

rebloor requested review from pepelsbey and removed request for a team June 17, 2024 02:47

github-actions bot added Content:Firefox Content in the Mozilla/Firefox subtree size/m [PR only] 51-500 LoC changed labels Jun 17, 2024

rebloor mentioned this pull request Jun 17, 2024

DNR properties changes mdn/browser-compat-data#23400

Merged

dotproto requested changes Jun 17, 2024

View reviewed changes

rebloor and others added 2 commits June 18, 2024 14:57

Suggestions from review

ad35d53

Co-authored-by: Simeon Vincent <svincent@gmail.com>

Further info re Safari plus various fixes

888459f

pepelsbey approved these changes Jun 21, 2024

View reviewed changes

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

rebloor and others added 2 commits June 22, 2024 05:34

Feedback on the release note

63e1e1e

Co-authored-by: Vadim Makeev <hi@pepelsbey.dev>

Merge branch 'main' into DNR-properties

26306e9

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

Merge branch 'main' into DNR-properties

ac45046

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

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

Rob--W reviewed Jul 8, 2024

View reviewed changes

Clarification

a87ce48

Rob--W reviewed Jul 8, 2024

View reviewed changes

Deprecation clarification

67cd62a

Merge branch 'main' into DNR-properties

75e475f

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

rebloor added 2 commits July 10, 2024 16:13

Dynamic and session rules property clarification

49a9e7a

Merge branch 'DNR-properties' of ssh://github.com/rebloor/content int…

9281083

…o DNR-properties

rebloor requested a review from Rob--W July 11, 2024 02:16

Rob--W approved these changes Jul 11, 2024

View reviewed changes

dotproto approved these changes Jul 12, 2024

View reviewed changes

rebloor merged commit 787fd07 into mdn:main Jul 13, 2024
8 checks passed

rebloor deleted the DNR-properties branch July 13, 2024 17:20

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

New DNR properties #34214

New DNR properties #34214

rebloor commented Jun 17, 2024

github-actions bot commented Jun 17, 2024 •

edited

Loading

dotproto Jun 17, 2024

dotproto commented Jun 17, 2024

rebloor commented Jun 18, 2024

pepelsbey left a comment

github-actions bot commented Jun 26, 2024

github-actions bot commented Jul 8, 2024

Rob--W Jul 8, 2024

Rob--W Jul 8, 2024

rebloor Jul 8, 2024 •

edited

Loading

Rob--W Jul 8, 2024

rebloor Jul 9, 2024

xeenon Jul 9, 2024

Rob--W Jul 9, 2024


		In Firefox, each ruleset has its own quota.
		In Chrome and Safari, this limit is enforced for the combined total of dynamic and session-scoped rules.

New DNR properties #34214

New DNR properties #34214

Conversation

rebloor commented Jun 17, 2024

Description

Summary

Related issues and pull requests

github-actions bot commented Jun 17, 2024 • edited Loading

dotproto Jun 17, 2024

Choose a reason for hiding this comment

dotproto commented Jun 17, 2024

rebloor commented Jun 18, 2024

pepelsbey left a comment

Choose a reason for hiding this comment

github-actions bot commented Jun 26, 2024

github-actions bot commented Jul 8, 2024

Rob--W Jul 8, 2024

Choose a reason for hiding this comment

Rob--W Jul 8, 2024

Choose a reason for hiding this comment

rebloor Jul 8, 2024 • edited Loading

Choose a reason for hiding this comment

Rob--W Jul 8, 2024

Choose a reason for hiding this comment

rebloor Jul 9, 2024

Choose a reason for hiding this comment

xeenon Jul 9, 2024

Choose a reason for hiding this comment

Rob--W Jul 9, 2024

Choose a reason for hiding this comment

github-actions bot commented Jun 17, 2024 •

edited

Loading

rebloor Jul 8, 2024 •

edited

Loading