Update Feature-Policy to Permissions-Policy by chrisdavidmills · Pull Request #22439 · mdn/content

chrisdavidmills · 2022-11-21T06:31:58Z

Description

This PR aims to do the work of migrating the existing Feature-Policy docs over toPermissions-Policy, as described in #22347

See my research document at https://docs.google.com/document/d/14xHANU3n43PfJR_dCpEwVCiVYv12BAfGqOICNvd79R4/edit#heading=h.mahbkxhoku5t for a list of the Permissions-Policy directives I am intending to implement on MDN as part of this work. This gives us parity with what was previously documented under Feature-Policy, but it adds a few more that are known to be supported, and it removes mention of some that were obviously being worked on at some point, but never seem to have gotten any traction.

Also see the equivalent BCD changes at mdn/browser-compat-data#18250

Notes:

I found a note at https://w3c.github.io/permissions/#powerful-features, which has questioned my understanding of the fundamental way in which these policies work. It says "However, requesting permission to use any other feature will be automatically denied because they are not listed in the allow attribute.". I thought the behavior of all features that weren't explicitly listed was governed by the default allowlist value? This note doesn't sound right to me.

Motivation

Additional details

Related issues and pull requests

github-actions · 2022-11-21T06:34:49Z

Preview URLs (120 pages)

Flaws (43)

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

URL: /en-US/docs/Web/Security/Same-origin_policy
Title: Same-origin policy
Flaw count: 1

macros:
- /en-US/docs/Web/API/URLUtils/href does not exist

URL: /en-US/docs/Web/API/XMLHttpRequest
Title: XMLHttpRequest
Flaw count: 1

macros:
- /en-US/docs/Web/API/XMLHttpRequestUpload does not exist

URL: /en-US/docs/Web/API/Screen_Capture_API
Title: Screen Capture API
Flaw count: 3

macros:
- /en-US/docs/Web/API/MediaTrackConstraints/cursor redirects to /en-US/docs/Web/API/MediaTrackConstraints
- /en-US/docs/Web/API/MediaTrackSupportedConstraints/cursor redirects to /en-US/docs/Web/API/MediaTrackSupportedConstraints
- /en-US/docs/Web/API/MediaTrackConstraints/cursor redirects to /en-US/docs/Web/API/MediaTrackConstraints

URL: /en-US/docs/Web/API/Screen_Capture_API/Using_Screen_Capture
Title: Using the Screen Capture API
Flaw count: 3

macros:
- /en-US/docs/Web/API/MediaTrackConstraints/cursor redirects to /en-US/docs/Web/API/MediaTrackConstraints
- The fourth to sixth parameters of 'EmbedLiveSample' are deprecated
broken_links:
- Can't resolve /en-US/docs/Web/API/WebRTC_API/Taking_still_photos

URL: /en-US/docs/Web/API/WebXR_Device_API
Title: WebXR Device API
Flaw count: 1

macros:
- /en-US/docs/Web/API/XRPermissionStatus does not exist

URL: /en-US/docs/Web/API/Navigator/requestMIDIAccess
Title: Navigator.requestMIDIAccess()
Flaw count: 1

broken_links:
- Can't resolve /en-US/docs/Web/HTTP/Feature_Policy

URL: /en-US/docs/Web/API/Navigator/requestMediaKeySystemAccess
Title: Navigator.requestMediaKeySystemAccess()
Flaw count: 1

macros:
- /en-US/docs/Web/API/MediaKeySystemConfiguration redirects to /en-US/docs/Web/API/MediaKeySystemAccess/getConfiguration

URL: /en-US/docs/Web/API/FeaturePolicy/getAllowlistForFeature
Title: FeaturePolicy.getAllowlistForFeature()
Flaw count: 1

broken_links:
- Can't resolve /en-US/docs/Web/HTTP/Permissions_Policy/#allowlists

URL: /en-US/docs/Web/API/Fullscreen_API
Title: Fullscreen API
Flaw count: 1

broken_links:
- Link points to the page it's already on

URL: /en-US/docs/Web/API/CredentialsContainer/get
Title: CredentialsContainer.get()
Flaw count: 1

macros:
- /en-US/docs/Web/API/CredentialRequestOptions does not exist

URL: /en-US/docs/Web/API/Payment_Request_API
Title: Payment Request API
Flaw count: 1

macros:
- /en-US/docs/Web/API/AddressErrors does not exist

URL: /en-US/docs/Web/API/HTMLIFrameElement
Title: HTMLIFrameElement
Flaw count: 22

macros:
- /en-US/docs/Web/API/HTMLIFrameElement/align does not exist
- /en-US/docs/Web/API/HTMLIFrameElement/allow does not exist
- /en-US/docs/Web/API/HTMLIFrameElement/allowfullscreen does not exist
- /en-US/docs/Web/API/HTMLIFrameElement/frameBorder does not exist
- /en-US/docs/Web/API/HTMLIFrameElement/height does not exist
- and 7 more flaws omitted
bad_bcd_links:
- no explanation!
- no explanation!
- no explanation!
- no explanation!
- no explanation!
- and 5 more flaws omitted

URL: /en-US/docs/Web/API/Picture-in-Picture_API
Title: Picture-in-Picture API
Flaw count: 1

macros:
- /en-US/docs/Web/API/PictureInPictureWindow/onresize redirects to /en-US/docs/Web/API/PictureInPictureWindow/resize_event

URL: /en-US/docs/Web/HTTP/Headers/Permissions-Policy
Title: Permissions-Policy
Flaw count: 2

broken_links:
- No need for the pathname in anchor links if it's the same page
- Can't resolve /en-US/docs/Web/API/Audio_Output_Devices_API

URL: /en-US/docs/Web/HTTP/Headers/Permissions-Policy/display-capture
Title: Permissions-Policy: display-capture
Flaw count: 1

bad_bcd_queries:
- No BCD data for query: http.headers.Permissions-Policy.display-capture

URL: /en-US/docs/Web/HTTP/Headers/Permissions-Policy/usb
Title: Permissions-Policy: usb
Flaw count: 1

macros:
- /en-US/docs/Web/API/Navigator/usb does not exist

URL: /en-US/docs/Web/Media/Autoplay_guide
Title: Autoplay guide for media and Web Audio APIs
Flaw count: 1

macros:
- /en-US/docs/Web/API/HTMLMediaElement/allowedToPlay does not exist

External URLs (11)

URL: /en-US/docs/Web/API/XMLHttpRequest
Title: XMLHttpRequest

https://datatracker.ietf.org/doc/html/rfc7540 (1 time)
https://web.dev/xhr2/ (1 time)

URL: /en-US/docs/Web/API/AmbientLightSensor/illuminance
Title: AmbientLightSensor.illuminance

https://en.wikipedia.org/wiki/Lux (1 time)

URL: /en-US/docs/Web/HTTP/Headers/Permissions-Policy
Title: Permissions-Policy

https://wicg.github.io/webusb/ (1 time) (Note! This may be a new URL 👀)

URL: /en-US/docs/Web/HTTP/Headers/Permissions-Policy/execution-while-not-rendered
Title: Permissions-Policy: execution-while-not-rendered

https://developer.chrome.com/blog/page-lifecycle-api (1 time) (Note! This may be a new URL 👀)

URL: /en-US/docs/Web/HTTP/Headers/Permissions-Policy/execution-while-out-of-viewport
Title: Permissions-Policy: execution-while-out-of-viewport

https://developer.chrome.com/blog/page-lifecycle-api (1 time) (Note! This may be a new URL 👀)

URL: /en-US/docs/Web/HTTP/Headers/Content-Security-Policy
Title: Content-Security-Policy

https://w3c.github.io/trusted-types/dist/spec/ (2 times) (Note! This may be a new URL 👀)

URL: /en-US/docs/Web/HTTP/Permissions_Policy
Title: Permissions Policy

https://chromestatus.com/features (1 time) (Note! This may be a new URL 👀)
https://developer.chrome.com/en/docs/privacy-sandbox/permissions-policy/ (1 time) (Note! This may be a new URL 👀)
https://w3c.github.io/permissions-registry/ (1 time) (Note! This may be a new URL 👀)
https://w3c.github.io/permissions/ (1 time) (Note! This may be a new URL 👀)

(comment last updated: 2022-12-12 11:50:01)

… the http pages

github-actions · 2022-11-22T17:08:32Z

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

hamishwillee · 2022-12-06T01:12:32Z

 To use this sensor, the user must grant permission to the `'accelerometer'`, `'gyroscope'`, and `'magnetometer'` device sensors through the [Permissions API](/en-US/docs/Web/API/Permissions_API).

-If a feature policy blocks use of a feature it is because your code is inconsistent with the policies set on your server. This is not something that would ever be shown to a user. The {{httpheader('Feature-Policy')}} HTTP header article contains implementation instructions.
+If a Permissions Policy blocks use of a feature it is because your code is inconsistent with the policies set on your server. This is not something that would ever be shown to a user. Our [Permissions Policy](/en-US/docs/Web/HTTP/Permissions_Policy) article contains implementation instructions.


So, FWIW, I do not like this note, because I don't know what ". This is not something that would ever be shown to a user." means/the intent.

It is worth saying that this might be blocked though and rolling out everywhere. Something like:

This feature may be blocked by a server Permissions Policy.

... unless there is a nuance I am missing that needs to be captured?

Yeah, this note is pretty crappy. I've updated all such instances with

This feature may be blocked by a Permissions Policy set on your server.

Or some slight variation of it.

hamishwillee · 2022-12-06T01:12:50Z

 To use this sensor, the user must grant permission to the `'accelerometer'`, device sensor through the [Permissions API](/en-US/docs/Web/API/Permissions_API).

-If a feature policy blocks the use of a feature, it is because your code is inconsistent with the policies set on your server. This is not something that would ever be shown to a user. The {{httpheader('Feature-Policy')}} HTTP header article contains implementation instructions.
+If a Permissions Policy blocks the use of a feature, it is because your code is inconsistent with the policies set on your server. This is not something that would ever be shown to a user. Our [Permissions Policy](/en-US/docs/Web/HTTP/Permissions_Policy) article contains implementation instructions.


See comment in https://github.com/mdn/content/pull/22439/files#r1040290515

Updated as per comment above.

hamishwillee · 2022-12-08T23:15:48Z

@chrisdavidmills I have fixed the merge issues, and re-reviewed.

Great job of integrating the suggestions.
Some minor nits/comments added.
Moved out of draft and approved.

Once you've had a chance to look I'd be happy to merge. It's a mammoth PR so I can imagine I have missed things, but I am also sure it is way better than what preceded it.

github-actions · 2022-12-11T06:45:45Z

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

caugner · 2022-12-12T10:07:15Z

@yin1999 Would you have a chance to look into this error? 🙏

yin1999 · 2022-12-12T10:09:07Z

@yin1999 Would you have a chance to look into this error? 🙏

I'll have a look on it

yin1999 · 2022-12-12T11:30:40Z

@yin1999 Would you have a chance to look into this error? 🙏

I'll have a look on it

Hi @caugner, I found the problem:

When we pass --paginate param, the response of second paginated api call for this PR will not contain files field (all the file changes are listed in the first api call). So the command fails. (Tested in #22897)

I've created #22898 to fix this.

…cy-to-permissions-policy

chrisdavidmills · 2022-12-12T11:51:51Z

@caugner @yin1999 This is the best news I've had all day. Thank you so much for fixing this <3

yin1999 · 2022-12-12T11:55:02Z

@caugner @yin1999 This is the best news I've had all day. Thank you so much for fixing this <3

Apology for I haven't tested the workflow on a PR that has more than 100 commits.

caugner · 2022-12-12T11:59:43Z

Apology for I haven't tested the workflow on a PR that has more than 100 commits.

No worries, thanks for the quick fix! 🎉

hamishwillee · 2022-12-12T20:23:48Z

Let us all bow before @chrisdavidmills !

chrisdavidmills · 2022-12-13T06:46:46Z

@hamishwillee awesome, just awesome!

chrisdavidmills requested review from a team as code owners November 21, 2022 06:31

chrisdavidmills requested review from teoli2003 and removed request for a team November 21, 2022 06:31

github-actions Bot added the Content:HTTP HTTP docs label Nov 21, 2022

chrisdavidmills marked this pull request as draft November 21, 2022 06:32

github-actions Bot added Content:Glossary Glossary entries Content:HTML Hypertext Markup Language docs Content:Media Media docs Content:Other Any docs not covered by another "Content:" label Content:WebAPI Web API docs labels Nov 21, 2022

chrisdavidmills added 8 commits November 21, 2022 15:58

move both feature-policy trees, update much of the terminology

513e90f

manual redirect fix

4951a42

rewrite permissions policy main guide and update references to it and…

7b88f75

… the http pages

fix redirect file

b3f5a03

one more small content fix, try to fix redirects again

e7d40d5

fix redirect

cabf2fe

revert to previous working redirects file

15d540b

remove the redirect that keeps failing altogether?!?

58ac7be

chrisdavidmills force-pushed the change-feature-policy-to-permissions-policy branch from 4bfa476 to 58ac7be Compare November 21, 2022 15:58

chrisdavidmills added 2 commits November 21, 2022 16:12

empty commit to force build

6fd4f56

add missing directives, delete directives we dont need, update pages

42a4cb6

github-actions Bot added the rebase needed 🚧 label Nov 22, 2022

caugner mentioned this pull request Nov 30, 2022

chore(HTTPSidebar): update Feature-Policy to Permissions-Policy mdn/yari#7644

Merged

hamishwillee reviewed Dec 6, 2022

View reviewed changes

Comment thread files/en-us/mozilla/firefox/experimental_features/index.md Outdated

hamishwillee reviewed Dec 6, 2022

View reviewed changes

Comment thread files/en-us/web/api/absoluteorientationsensor/absoluteorientationsensor/index.md

hamishwillee reviewed Dec 6, 2022

View reviewed changes

hamishwillee requested review from schalkneethling and sideshowbarker and removed request for a team December 8, 2022 23:14

hamishwillee approved these changes Dec 8, 2022

View reviewed changes

github-actions Bot added the rebase needed 🚧 label Dec 11, 2022

sideshowbarker removed their request for review December 11, 2022 07:27

chrisdavidmills added 2 commits December 12, 2022 07:06

fix merge conflict

c52d7bd

Merge branch 'main' into change-feature-policy-to-permissions-policy

c13d8e7

github-actions Bot removed the rebase needed 🚧 label Dec 12, 2022

Final few fixes for hamishwillee comments

2cfc24f

yin1999 mentioned this pull request Dec 12, 2022

fix(ci): do not paginate for fetching file changes #22898

Merged

Merge remote-tracking branch 'upstream/main' into change-feature-poli…

7998a14

…cy-to-permissions-policy

hamishwillee merged commit af967bb into mdn:main Dec 12, 2022

chrisdavidmills deleted the change-feature-policy-to-permissions-policy branch December 13, 2022 06:46

This was referenced Dec 14, 2022

Intent to document: Permissions-Policy #22347

Closed

Feature Policy Changed to Permissions Policy #1831

Closed

Permissions API - update to docs needed #13003

Closed

Josh-Cena mentioned this pull request Dec 23, 2022

"Feature-Policy": execution-while-not-rendered and execution-while-out-of-viewport documentation needs to be written #13556

Closed

leon-win mentioned this pull request Dec 8, 2023

[ru] remove obsolete orphaned/Web/HTTP/Feature_Policy/Using_Feature_Policy mdn/translated-content#17332

Merged

Conversation

chrisdavidmills commented Nov 21, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Motivation

Additional details

Related issues and pull requests

Uh oh!

github-actions Bot commented Nov 21, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Nov 22, 2022

Uh oh!

Uh oh!

Uh oh!

hamishwillee Dec 6, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

chrisdavidmills Dec 6, 2022

Choose a reason for hiding this comment

Uh oh!

hamishwillee Dec 6, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

chrisdavidmills Dec 6, 2022

Choose a reason for hiding this comment

Uh oh!

hamishwillee commented Dec 8, 2022

Uh oh!

github-actions Bot commented Dec 11, 2022

Uh oh!

caugner commented Dec 12, 2022

Uh oh!

yin1999 commented Dec 12, 2022

Uh oh!

yin1999 commented Dec 12, 2022

Uh oh!

chrisdavidmills commented Dec 12, 2022

Uh oh!

yin1999 commented Dec 12, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

caugner commented Dec 12, 2022

Uh oh!

hamishwillee commented Dec 12, 2022

Uh oh!

chrisdavidmills commented Dec 13, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

chrisdavidmills commented Nov 21, 2022 •

edited

Loading

github-actions Bot commented Nov 21, 2022 •

edited

Loading

hamishwillee Dec 6, 2022 •

edited

Loading

hamishwillee Dec 6, 2022 •

edited

Loading

yin1999 commented Dec 12, 2022 •

edited

Loading