-
Notifications
You must be signed in to change notification settings - Fork 271
Add crash report storage feature #3816
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Draft
ddbeck
wants to merge
4
commits into
web-platform-dx:main
Choose a base branch
from
ddbeck:crash-report-storage
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| name: Crash report storage | ||
| description: The `window.crashReport` object is a key-value store to record information about your application's state. If there's a crash, then the data in the key-value store is sent to your crash reporting endpoint, to help you pinpoint the cause of the crash. | ||
| spec: https://wicg.github.io/crash-reporting/#crash-report-storage | ||
| compat_features: | ||
| - api.CrashReportContext | ||
| - api.CrashReportContext.delete | ||
| - api.CrashReportContext.initialize | ||
| - api.CrashReportContext.set | ||
| - api.Window.crashReport | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| # Generated from: reporting-crashes-storage.yml | ||
| # Do not edit this file by hand. Edit the source file instead! | ||
|
|
||
| status: | ||
| baseline: false | ||
| support: | ||
| chrome: "145" | ||
| chrome_android: "145" | ||
| edge: "145" | ||
| compat_features: | ||
| - api.CrashReportContext | ||
| - api.CrashReportContext.delete | ||
| - api.CrashReportContext.initialize | ||
| - api.CrashReportContext.set | ||
| - api.Window.crashReport |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| name: Crash reporting | ||
| description: Crash reporting sends a report to a URL nominated by the `Reporting-Endpoints` header when a user is unable to continue using the page because the browser or tab crashed. | ||
| spec: https://wicg.github.io/crash-reporting/ | ||
| # This was first implemented in Chrome 72 via the now-deprecated `Report-To` | ||
| # header. Crash reporting thus predates `Reporting-Endpoints`. This somewhat | ||
| # strangely makes the `http.headers.Reporting-Endpoints` the de facto inception | ||
| # key for this feature. We can't (yet) overlap keys, so this status override is | ||
| # required for now. Further reading: | ||
| # - https://chromestatus.com/feature/6683949661159424 | ||
| # - https://bugzilla.mozilla.org/show_bug.cgi?id=1860588 | ||
| # - https://bugs.webkit.org/show_bug.cgi?id=269925 | ||
| status: | ||
| baseline: false | ||
| support: | ||
| chrome: "96" | ||
| chrome_android: "96" | ||
| edge: "96" | ||
| firefox: "149" | ||
| firefox_android: "149" | ||
| compat_features: | ||
| # Include this key when https://github.com/web-platform-dx/web-features/issues/1173 is resolved: | ||
| # - http.headers.Reporting-Endpoints | ||
| # This key appeared later, allowing developers to opt-in to receiving _only_ | ||
| # those reports, so it's excluded from the status calculation. | ||
| - http.headers.Reporting-Endpoints.crash-reporting |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| # Generated from: reporting-crashes.yml | ||
| # Do not edit this file by hand. Edit the source file instead! | ||
|
|
||
| status: | ||
| baseline: low | ||
| baseline_low_date: 2026-03-24 | ||
| support: | ||
| chrome: "96" | ||
| chrome_android: "96" | ||
| edge: "96" | ||
| firefox: "149" | ||
| firefox_android: "149" | ||
| safari: "16.4" | ||
| safari_ios: "16.4" | ||
| compat_features: | ||
| - http.headers.Reporting-Endpoints |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this API builds on top of the Reporting API, which should likely be named here.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
After re-reading a few resources, my understanding is now that:
The Reporting API is the higher-level feature, which basically consists in defining a
Reporting-Endpointsheader to say where the browser should send (multiple types of) reports to.That's https://web-platform-dx.github.io/web-features-explorer/features/reporting/
On top of this, the Crash Reporting API was defined. It's an extension of the Reporting API that's specifically made for reporting crashes, and which defines that reports contain data such as
reason,stack,is_top_level,visibility_state, andcrash_report_api.Spec: https://wicg.github.io/crash-reporting/
We don't have a feature in the repo for this.
The
window.crashReportobject, which seems to be and extension of the Crash Reporting API that lets developers also send their own custom data along with a crash report, but creating a map of key/value pairsSpec: https://wicg.github.io/crash-reporting/#crash-report-storage
That's the new
crash-report-storagefeature you're proposing here.I'm not 100% confident that 2 and 3 are separate things, but they do seem this way to me.
That said, I don't know if there are BCD keys for 2.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If there are no practical benefits to creating a feature for 2 and 3, then we should at least revise the description to broaden the language so it encompasses the Crash Reporting API too.