Add declarativeNetRequest #18403

rebloor · 2022-12-09T15:27:00Z

Adding the declarativeNetRequest API.

Complement the content addition in #22644

core content
confirm core content release versions
add detail for additions and deprecations

Rob--W · 2022-12-09T16:52:24Z

Please take a look at #14942 and merge the feedback from the other PR with this one. In particular, pay attention to the support state of Safari for the individual APIs.

rebloor · 2022-12-12T02:11:03Z

@Rob--W "In particular, pay attention to the support state of Safari for the individual APIs." Where can I find more details?

Rob--W · 2022-12-12T17:51:32Z

@Rob--W "In particular, pay attention to the support state of Safari for the individual APIs." Where can I find more details?

The files in the linked PR itself, at safari and safari_ios.

rebloor · 2022-12-12T22:22:59Z

@Rob--W "The files in the linked PR itself, at safari and safari_ios." They all say "false", but the 15 release notes say this was added there.

Elchi3 · 2023-01-11T11:45:08Z

There is this PR and then there is #14942. Should someone review this PR or what is the plan here? Do you need help with this by BCD maintainers or are you sorting this out yourself? @rebloor @Rob--W

Rob--W · 2023-01-11T12:05:12Z

There is this PR and then there is #14942. Should someone review this PR or what is the plan here? Do you need help with this by BCD maintainers or are you sorting this out yourself? @rebloor @Rob--W

I and @rpl are planning to review both PRs. I think that just mine suffices here, and Luca and I will take care of the one in the MDN repo.

Rob--W

I need to confirm with Apple folks about the support state of individual APIs, methods and events. The PR here lists much more than just https://github.com/w3c/webextensions/blob/main/interfaces/safari/WebExtensionAPIDeclarativeNetRequest.idl

The DNR API is declarative, and therefore it's probably worth mentioning each property of rule.condition and rule.action. This is because we should not assume a property to be supported unless explicitly confirmed to be supported.

For example, I would consider adding a note to isUrlFilterCaseInsensitive and/or regexFilter, because of their volatile status (see mdn/content#22644 (comment) and mdn/content#22644 (comment) ).

webextensions/api/declarativeNetRequest.json

Rob--W · 2023-01-23T16:18:53Z

webextensions/api/declarativeNetRequest.json

+            "__compat": {
+              "support": {
+                "chrome": {
+                  "version_added": "86"


Add an entry or notes that clarify that the "append" operation was only supported (for requestHeaders) starting from Chrome 108. For details, see https://bugs.chromium.org/p/chromium/issues/detail?id=1117475#c7

webextensions/api/declarativeNetRequest.json

Rob--W · 2023-01-23T16:28:32Z

webextensions/api/declarativeNetRequest.json

+              "safari_ios": "mirror"
+            }
+          },
+          "callback": {


Let's drop the callback part. The onRuleMatchedDebug key here specifies support for the event, which implies that there is some listener. Individual event properties can be specified directly under it, without another dummy "callback".

webextensions/api/declarativeNetRequest.json

Rob--W · 2023-01-23T16:34:52Z

webextensions/api/declarativeNetRequest.json

+              "safari_ios": "mirror"
+            }
+          },
+          "options": {


Why did you add an entry for options? The options parameter is required and it is not possible to implement an updateDynamicRules API without an options parameter.

@Rob--W because the way the Chrome documentation appears to work is that everything that doesn't have a specific release identified was released in 84 and the documentation for updateDynamicRules shows that options with added in 87.

@Rob--W given your comments, I have assumed the information about adding options in 87 is incorrect and have removed it from the BCD, retaining 84 as the release that introduced updateDynamicRules.

The API was introduced in 84, but a breaking change to the syntax was introduced in 87.
https://bugs.chromium.org/p/chromium/issues/detail?id=1131746 has details. If you'd like to be complete, you could add that it was supported from 84 - 86 with a different syntax, and 87+ with the current format.

Since it has been over 2 years now, I think that it's fine to mention 87+ as supported version.

Rob--W · 2023-01-23T16:37:18Z

webextensions/api/declarativeNetRequest.json

+              "safari_ios": "mirror"
+            }
+          },
+          "options": {


Similarly as above: Why is options documented for updateEnabledRulesets? If there is no reason, delete it.

Also as above, deleted and retained 84 as the release version for updateEnabledRulesets.

webextensions/api/declarativeNetRequest.json

Co-authored-by: Rob Wu <rob@robwu.nl>

- requestHeaders note about the "append" operation in Chrome 108 - removed callback from onRuleMatchedDebug - added options and includeOtherExtensions to testMatchOutcome - removed options from updateDynamicRules and updateEnabledRulesets - added extensionId to MatchedRule

Rob--W · 2023-01-27T20:53:05Z

webextensions/api/declarativeNetRequest.json

+          },
+          "request": {
+            "__compat": {
+              "support": {
+                "chrome": {
+                  "version_added": "103"
+                },
+                "edge": "mirror",
+                "firefox": {
+                  "version_added": false
+                },
+                "firefox_android": "mirror",
+                "opera": "mirror",
+                "safari": {
+                  "version_added": false
+                },
+                "safari_ios": "mirror"
+              }
+            }
+          }


The positional request parameter is a required part of the API and does not need to be documented separately.

Suggested change

},

"request": {

"__compat": {

"support": {

"chrome": {

"version_added": "103"

},

"edge": "mirror",

"firefox": {

"version_added": false

},

"firefox_android": "mirror",

"opera": "mirror",

"safari": {

"version_added": false

},

"safari_ios": "mirror"

}

}

}

Rob--W · 2023-01-27T20:55:08Z

webextensions/api/declarativeNetRequest.json

+              "safari_ios": "mirror"
+            }
+          },
+          "includeOtherExtensions": {


Let's put this includeOtherExtensions option under options, since it is part of it.

In another API I asked for the options to be removed, but in this case not all implementations support options, so we have to keep options to be able to show when the positonal parameter is supported and when not. And since the options entry then exists, for clarity we have to put the members of the options dictionary under it.

Rob--W · 2023-01-27T20:57:19Z

webextensions/api/declarativeNetRequest.json

+              "safari_ios": "mirror"
+            }
+          },
+          "extensionActionOptions": {


Remove the separate entry for this. The setExtensionActionOptions method takes one dictionary, and any options underneath are part of the positional parameter that is documented as options (not extensionActionOptions) at https://developer.chrome.com/docs/extensions/reference/declarativeNetRequest/#method-setExtensionActionOptions

I've renamed this option as we need to retain the entry to note that tabUpdate was added in 89.

- removed `request` from `testMatchOutcome` - moved `includeOtherExtensions` under `options` in `testMatchOutcome` - renamed `extensionActionOptions` to `option` under `setExtensionActionOptions`

webextensions/manifest/permissions.json

webextensions/api/declarativeNetRequest.json

xeenon · 2023-02-09T20:28:16Z

webextensions/api/declarativeNetRequest.json

+                  "firefox_android": "mirror",
+                  "opera": "mirror",
+                  "safari": {
+                    "version_added": "15"


onRuleMatchedDebug and related are not supported by Safari. We do support this, along with timeStamp, in getMatchedRules results, but I don't see that above.

Suggested change

"version_added": "15"

"version_added": false

Rob--W · 2023-02-09T20:28:22Z

@rebloor By the way, when Timothy says "supported in Safari Technology Preview", write "preview" in the version, per https://github.com/mdn/browser-compat-data/blob/main/docs/data-guidelines/index.md#choosing-preview-values

webextensions/api/declarativeNetRequest.json

Co-authored-by: Rob Wu <rob@robwu.nl>

…aders supported from 15)

rebloor · 2023-02-10T16:38:06Z

@xeenon thanks for providing these details, when you have a moment could you check and see whether I've missed anything

xeenon

The dfa193b commit should be reverted. preview is correct for ModifyHeaderInfo.

xeenon · 2023-02-10T18:55:18Z

@rebloor Looks good. One thing that was missed in MatchedRule, Safari does not support that.

We do support getMatchesRules() which in Chrome returns MatchedRuleInfo, but in Safari is returning a result more like hybrid of MatchedRuleInfo and MatchedRuleInfoDebug with a subset of RequestDetails as request that just includes url. We also only include the match in the result array if the extension has host permissions for the domain of the matched URL.

But I'm seeing now we have a bug, because we put tabId, timeStamp and url inside request when only url should be inside and tabId and timeStamp should be top level. On top of missing the wrapper object RulesMatchedDetails. I'll file a bug to get that fixed.

Here is an example of what shipping Safari returns for getMatchesRules():

[{
    "request": {
        "url": "https://example.com",
        "tabId": 1,
        "timeStamp": 1676055129451
    }
}]

It should look more like RulesMatchedDetails with MatchedRuleInfo plus MatchedRuleInfoDebug, for example:

{
    "rulesMatchedInfo": [{
        "request": {
            "url": "https://example.com"
        },
        "tabId": 1,
        "timeStamp": 1676055129451
    }]
}

I'm not sure how this deviation between Chrome and Safari should be handled (on top of the bad bug). It might just be best to say "preview" for getMatchedRules() or add a Note and mark it as partial implementation in 15.4 until this bug is fixed?

rebloor · 2023-02-12T16:02:06Z

@xeenon

The dfa193b commit should be reverted. preview is correct for ModifyHeaderInfo.

Following advice from @Rob--W BCD for ModifyHeaderInfo has been removed and it's BCD will be represented by BCD for RuleAction.requestHeaders & RuleAction.responseHeaders BCD on MDN.

rebloor · 2023-02-12T16:11:47Z

@xeenon

One thing that was missed in MatchedRule, Safari does not support that.

Updated in c41c06a

rebloor · 2023-02-12T16:14:36Z

@xeenon for the getMatchesRules() issue, do you have a public bug reference?

Rob--W

I think that the PR is good to merge.

All Firefox APIs are currently marked as "version_added": false despite there being an implementation behind a preference. We can change their status in a follow-up PR. I'm considering to use "version_added": "preview" for that, according to the guidelines at https://github.com/mdn/browser-compat-data/blob/main/docs/data-guidelines/index.md#choosing-preview-values . Does that sound reasonable?

rebloor · 2023-02-14T22:29:45Z

@Rob--W my understanding is that we document features behind a preference using flag, like this:

Add declarativeNetRequest

fcf739a

rebloor added the data:webext 🎲 Compat data for Browser Extensions. https://developer.mozilla.org/Add-ons/WebExtensions label Dec 9, 2022

rebloor requested review from Rob--W and lucacasonato December 9, 2022 15:27

rebloor self-assigned this Dec 9, 2022

rebloor added 2 commits December 12, 2022 13:48

Merge branch 'main' into add-declarativeNetRequest

8bddd19

Some deprecation and addition details

cba568b

Merge branch 'main' into add-declarativeNetRequest

568a206

Chrome support details

b97239f

rebloor marked this pull request as ready for review December 12, 2022 22:23

Rob--W suggested changes Jan 23, 2023

View reviewed changes

rebloor and others added 3 commits January 27, 2023 05:57

Suggestions from review

cba7358

Co-authored-by: Rob Wu <rob@robwu.nl>

Correct Safari support in sub-features

324ce7c

rebloor requested a review from Rob--W January 27, 2023 17:23

Rob--W suggested changes Jan 27, 2023

View reviewed changes

Feedback update:

05dc02f

- removed `request` from `testMatchOutcome` - moved `includeOtherExtensions` under `options` in `testMatchOutcome` - renamed `extensionActionOptions` to `option` under `setExtensionActionOptions`

rebloor requested a review from Rob--W January 29, 2023 15:33

rebloor added 4 commits February 1, 2023 16:03

Added ResourceType types

0743faa

Added onRuleMatchedDebug request properties

7b1574c

Removed xbl from ResourceType in webRequest & declarativeNetRequest

9c104b3

declarativeNetRequest.ResourceType Chrome support update

a748490

xeenon reviewed Feb 9, 2023

View reviewed changes

webextensions/manifest/permissions.json Outdated Show resolved Hide resolved

xeenon reviewed Feb 9, 2023

View reviewed changes

webextensions/manifest/permissions.json Outdated Show resolved Hide resolved

xeenon reviewed Feb 9, 2023

View reviewed changes

webextensions/api/declarativeNetRequest.json Outdated Show resolved Hide resolved

xeenon reviewed Feb 9, 2023

View reviewed changes

webextensions/api/declarativeNetRequest.json Outdated Show resolved Hide resolved

xeenon reviewed Feb 9, 2023

View reviewed changes

webextensions/api/declarativeNetRequest.json Outdated Show resolved Hide resolved

xeenon reviewed Feb 9, 2023

View reviewed changes

webextensions/api/declarativeNetRequest.json Outdated Show resolved Hide resolved

xeenon reviewed Feb 9, 2023

View reviewed changes

webextensions/api/declarativeNetRequest.json Outdated Show resolved Hide resolved

xeenon reviewed Feb 9, 2023

View reviewed changes

webextensions/api/declarativeNetRequest.json Outdated Show resolved Hide resolved

xeenon reviewed Feb 9, 2023

View reviewed changes

webextensions/api/declarativeNetRequest.json Outdated Show resolved Hide resolved

xeenon reviewed Feb 9, 2023

View reviewed changes

webextensions/api/declarativeNetRequest.json Outdated Show resolved Hide resolved

rebloor commented Feb 10, 2023

View reviewed changes

webextensions/api/declarativeNetRequest.json Outdated Show resolved Hide resolved

rebloor and others added 5 commits February 11, 2023 04:33

Apply updates from Apple review

ed13b41

Further Safari updates

99a53c9

Co-authored-by: Rob Wu <rob@robwu.nl>

Added Safari preview details

9782981

Revert ModifyHeaderInfo support to Safari 15 (as RuleAction.requestHe…

dfa193b

…aders supported from 15)

Merge branch 'main' into add-declarativeNetRequest

428a7e1

xeenon reviewed Feb 10, 2023

View reviewed changes

Removed ModifyHeaderInfo and expanded RuleAction.responseHeaders

6b25270

MatchedRule not supported by Safari

c41c06a

Merge branch 'main' into add-declarativeNetRequest

65958a4

Rob--W approved these changes Feb 14, 2023

View reviewed changes

rebloor merged commit e3eb956 into mdn:main Feb 14, 2023

Rob--W mentioned this pull request Feb 14, 2023

Web Extensions Declarative Net Request WIP #14942

Closed

rebloor deleted the add-declarativeNetRequest branch February 14, 2023 22:32

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add declarativeNetRequest #18403

Add declarativeNetRequest #18403

rebloor commented Dec 9, 2022 •

edited

Loading

Rob--W commented Dec 9, 2022

rebloor commented Dec 12, 2022

Rob--W commented Dec 12, 2022

rebloor commented Dec 12, 2022

Elchi3 commented Jan 11, 2023

Rob--W commented Jan 11, 2023

Rob--W left a comment

Rob--W Jan 23, 2023

Rob--W Jan 23, 2023

Rob--W Jan 23, 2023

rebloor Jan 27, 2023

rebloor Jan 27, 2023

Rob--W Jan 27, 2023

Rob--W Jan 23, 2023

rebloor Jan 27, 2023

Rob--W Jan 27, 2023

Rob--W Jan 27, 2023

Rob--W Jan 27, 2023

rebloor Jan 28, 2023

xeenon Feb 9, 2023 •

edited

Loading

rebloor Feb 10, 2023

Rob--W commented Feb 9, 2023

rebloor commented Feb 10, 2023

xeenon left a comment •

edited

Loading

xeenon commented Feb 10, 2023 •

edited

Loading

rebloor commented Feb 12, 2023

rebloor commented Feb 12, 2023

rebloor commented Feb 12, 2023

Rob--W left a comment

rebloor commented Feb 14, 2023 •

edited

Loading

Add declarativeNetRequest #18403

Add declarativeNetRequest #18403

Conversation

rebloor commented Dec 9, 2022 • edited Loading

Rob--W commented Dec 9, 2022

rebloor commented Dec 12, 2022

Rob--W commented Dec 12, 2022

rebloor commented Dec 12, 2022

Elchi3 commented Jan 11, 2023

Rob--W commented Jan 11, 2023

Rob--W left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

xeenon Feb 9, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Rob--W commented Feb 9, 2023

rebloor commented Feb 10, 2023

xeenon left a comment • edited Loading

Choose a reason for hiding this comment

xeenon commented Feb 10, 2023 • edited Loading

rebloor commented Feb 12, 2023

rebloor commented Feb 12, 2023

rebloor commented Feb 12, 2023

Rob--W left a comment

Choose a reason for hiding this comment

rebloor commented Feb 14, 2023 • edited Loading

rebloor commented Dec 9, 2022 •

edited

Loading

xeenon Feb 9, 2023 •

edited

Loading

xeenon left a comment •

edited

Loading

xeenon commented Feb 10, 2023 •

edited

Loading

rebloor commented Feb 14, 2023 •

edited

Loading