1976074 - Ship Reporting API

Status: RESOLVED FIXED

(Core :: DOM: Core & HTML, enhancement)

Comment 1

[Hsin-Yi Tsai (she/her)[:hsinyi]]

Remove bug 1909705 from the blocking dependency after Simon's investigation.

Comment 2

[Simon Farre [:sfarre]]

Attachment: Bug 1976074 - Ship reporting API r=#dom-core!

Flip the prefererences involved for Reporting API to true,
enabling the feature by default.

Enable the prefererences

Comment 3

[Pulsebot]

Pushed by [e-mail]:
https://github.com/mozilla-firefox/firefox/commit/a40063cf6972
https://hg.mozilla.org/integration/autoland/rev/ed59d3d0bc56
Ship reporting API r=dom-core,smaug,webidl

Comment 4

[Pulsebot]

Pushed by [e-mail]:
https://github.com/mozilla-firefox/firefox/commit/32847a6b9e79
https://hg.mozilla.org/integration/autoland/rev/b635dba5b7a8
Revert "Bug 1976074 - Ship reporting API r=dom-core,smaug,webidl" for causing mochitest plain failures on test_serviceworker_interfaces

Comment 5

[Cosmin Sabou [:CosminS]]

Backed out for causing mochitest plain failures on test_serviceworker_interfaces

Push with failures

Failure log

Backout link

Comment 6

[Simon Farre [:sfarre]]

test_serviceworker_interfaces.js needs the same as was added to test_interfaces.js

Comment 7

[Simon Farre [:sfarre]]

Try run: https://treeherder.mozilla.org/jobs?repo=try&landoCommitID=175771

What's exposed and not exposed is a bit of a mess, and the choices made in the patch is for webcompat reasons, to behave as close as possible (at the moment) with what's already in the wild.

https://docs.google.com/spreadsheets/d/1FzI56hgqGQwnR-F-yHSU6vTBUPfce8w7SiFYJQIE2Z4/edit?gid=0#gid=0 (invite needed) shows the different webidl configurations

Comment 8

[Pascal Chevrel:pascalc]

Simon, this looks like a feature activation. Is a release note needed for 149? Thanks

Comment 9

[Simon Farre [:sfarre]]

(In reply to Pascal Chevrel:pascalc from comment #8)

Simon, this looks like a feature activation. Is a release note needed for 149? Thanks

Yes, it will be needed. Could you be so kind to remind me what you need for me?

Comment 10

[Pascal Chevrel:pascalc]

(In reply to Simon Farre [:sfarre] from comment #9)

(In reply to Pascal Chevrel:pascalc from comment #8)

Simon, this looks like a feature activation. Is a release note needed for 149? Thanks

Yes, it will be needed. Could you be so kind to remind me what you need for me?

You can follow the steps documented at https://wiki.mozilla.org/Release_Management/Release_Notes_Nomination#How_to_nominate_a_bug_for_release_notes_addition?

Comment 11

[Simon Farre [:sfarre]]

[Why is this notable]: Enables Reporting API by default.
[Affects Firefox for Android]: Support is intended for all platforms.
[Suggested wording]: The Reporting API provides a generic reporting mechanism for web applications to use to make reports available based on various platform features (for example Content Security Policy, Permissions-Policy, or feature deprecation reports) in a consistent manner. With 149 it gets enabled by default.
[Links]: Reporting API and how it is used is documented at https://developer.mozilla.org/en-US/docs/Web/API/Reporting_API

Comment 12

[Pulsebot]

Pushed by [e-mail]:
https://github.com/mozilla-firefox/firefox/commit/6058e9da8eb0
https://hg.mozilla.org/integration/autoland/rev/279ee54637b1
Ship reporting API r=dom-core,smaug,webidl,dom-worker-reviewers,edenchuang

Comment 13

[Cristian Tuns]

https://hg.mozilla.org/mozilla-central/rev/279ee54637b1

Comment 14

[Pascal Chevrel:pascalc]

Is there a release note wording suggestion? I have no idea what this API is used for and this bug comment #0 is empty, no information either on the meta bug.

Comment 15

[Simon Farre [:sfarre]]

(In reply to Pascal Chevrel:pascalc from comment #14)

Is there a release note wording suggestion? I have no idea what this API is used for and this bug comment #0 is empty, no information either on the meta bug.

I can provide one, could you give me an example of other release note wordings, so that I could cargo cult the concept?

The MDN link provides:
"The Reporting API provides a generic reporting mechanism for web applications to use to make reports available based on various platform features (for example Content Security Policy, Permissions-Policy, or feature deprecation reports) in a consistent manner." - though I'm not sure if that's what you're looking for?

I followed the link and filled out a minimal example in comment 11, maybe there's more you would need?

Comment 16

[Simon Farre [:sfarre]]

(In reply to Pascal Chevrel:pascalc from comment #14)

Is there a release note wording suggestion? I have no idea what this API is used for and this bug comment #0 is empty, no information either on the meta bug.

Updated the previous comment 11 with the suggested wording! Thanks for the reminder.

Comment 17

[Pascal Chevrel:pascalc]

Note added to 149 nightly and beta notes with this wording:

The new Reporting API provides a generic reporting mechanism for web applications to use to make reports available based on various platform features (for example Content Security Policy, Permissions-Policy, or feature deprecation reports) in a consistent manner.

I am keeping the relnote-firefox? flag set until we include this note in our final 149 release notes, thanks.

Comment 18

[Hamish Willee]

FF149 MDN work for this can be tracked in https://github.com/mdn/content/issues/43221

FYI @pascal note that the release note description is overly general in that it describes the purpose of the reporting API, but not the features of the API that Firefox actually implements. In FF149 this provides support for reporting CSP and Integrity-Policy violations (in scripts but not styles) but not permission policy or deprecation policy violations. For MDN note I did https://github.com/mdn/content/pull/43523

Note though, that MDN pretends that browser vendors obey the spec and return dictionaries, rather than Reports with a body property that is derived from a ReportBody interface. That means you might not want to mention the report types as I do, and instead just mention their type string:

This allows report objects of type "csp-violation" and "integrity-violation" to be reported in violating pages using a {{domxref("ReportingObserver")}}.

Note, tagging you with request info just so you see this.

Comment 19

[Pascal Chevrel:pascalc]

I think it is OK to have a generic note in our release notes for end users as it links to MDN where details of our implementation are explained and we also link to the developper release notes for 149.