feat: WebFrameMain.collectJavaScriptCallStack() #44204

samuelmaddock · 2024-10-11T14:35:50Z

Description of Change

Adds WebFrameMain.collectJavaScriptCallStack() to allow accessing the JavaScript call stack of unresponsive renderers. This is available in Chromium as part of the Crash Reporting API.

With this API, a dialog shown when a renderer becomes unresponsive could have an option to copy the stack trace. This would help application developers figure out why their website might be stuck on long-running JavaScript.

I've marked the API as experimental given that the proposal is still a draft.

Here's an example of the output from a fiddle gist:

Renderer unresponsive
 
    at startInfiniteLoop (<anonymous>:5:5)
    at HTMLHtmlElement.clickHandler (<anonymous>:11:5)

Checklist

PR description included and stakeholders cc'd
npm test passes
tests are changed or added
relevant documentation, tutorials, templates and examples are changed or added
PR release notes describe the change in a way relevant to app developers, and are capitalized, punctuated, and past tense.

Release Notes

Notes: Added WebFrameMain.collectJavaScriptCallStack() for accessing the JavaScript call stack of unresponsive renderers.

docs/api/web-frame-main.md

samuelmaddock · 2024-11-12T22:02:46Z

If we have the APIs to be able to collect a call stack at any time, let’s expose that!

Updated the API to do just that. cc @nornagon

There are still some requirements to be able to collect the call stack:

JavaScript must be running. Otherwise the RequestInterrupt never resolves.
The webpage owner needs to enable the document-policy header defined by the crash reporting API
The origin trial needs to be enabled or the DocumentPolicyIncludeJSCallStacksInCrashReports chromium flag.

deepak1556 · 2024-11-13T14:58:25Z

docs/api/web-frame-main.md

+#### `frame.collectJavaScriptCallStack()` _Experimental_
+
+Returns `Promise<string> | Promise<void>` - A promise that resolves with the currently running JavaScript call
+stack. If no JavaScript runs, the promise will never resolve. If the call stack is unable to be collected, it


If no JavaScript runs, the promise will never resolve

Just curious, what is the better way to determine this case ? would checking for current stack position against the threads stack base address help ?

Naively, would providing a timeout argument be helpful to provide users with an escape hatch?

would checking for current stack position against the threads stack base address help ?

I think this would be best left as feedback (or a CL) upstream so it can be fixed there. We should mention this in https://issues.chromium.org/issues/40268201

javascript_call_stack_collector.cc is specifically where RequestInterrupt is invoked.

Naively, would providing a timeout argument be helpful to provide users with an escape hatch?

If a fix cannot be applied upstream, I think we should consider this. My thinking is we merge this as experimental for now and revisit after seeing results from usage.

deepak1556

LGTM 👍

deepak1556 · 2024-11-18T07:16:14Z

spec/index.js

+// Enable features required by tests.
+app.commandLine.appendSwitch('enable-features', [
+  // spec/api-web-frame-main-spec.ts
+  'DocumentPolicyIncludeJSCallStacksInCrashReports'


Any reason to not enable this feature by default DocumentPolicyIncludeJSCallStacksInCrashReports in the runtime ? Users are still required to opt-in respective documents via the policy header, just wondering if there is necessity to control the feature behind two runtime feature flags. Maybe in our case just the document policy is sufficient, thoughts ?

Having this enabled by default would make it easier to automatically use this in the Sentry Electron SDK without the risk of clobbering users existing enable-features switch.

I didn't consider this given the early API availability in Chromium. It's estimated to be in origin trial until Chromium 132 and there hasn't been significant feedback by standards committees based on information provided in the Chrome Status page.

Assuming it's fully rolled out in Chromium 133, we could expect to not require the flag by Feb 4, 2025.

Maybe in our case just the document policy is sufficient, thoughts?

I'm not against it if folks are okay with this.

Sounds good, we can revisit this again.

There's more discussion about it here: #45356 (comment)

VerteDinde

From a code implementation side, this looks good to me - the diff is relatively small and low-risk 👍 Approved pending API working group approval

erickzhao

API LGTM

itsananderson

API LGTM

deepak1556 · 2024-11-25T12:26:06Z

PR should be good to merge, can you rebase on latest main

This reverts commit e0612bc.

release-clerk · 2024-12-03T04:32:27Z

Release Notes Persisted

Added WebFrameMain.collectJavaScriptCallStack() for accessing the JavaScript call stack of unresponsive renderers.

trop · 2024-12-03T04:33:09Z

I have automatically backported this PR to "33-x-y", please check out #44937

trop · 2024-12-03T04:33:16Z

I have automatically backported this PR to "34-x-y", please check out #44938

electron-cation bot added the new-pr 🌱 PR opened recently label Oct 11, 2024

samuelmaddock added the target/33-x-y PR should also be added to the "33-x-y" branch. label Oct 11, 2024

samuelmaddock force-pushed the feat/crash-call-stack branch from 64e2d5c to 9824088 Compare October 11, 2024 15:21

samuelmaddock added the semver/minor backwards-compatible functionality label Oct 11, 2024

electron-cation bot added the api-review/requested 🗳 label Oct 11, 2024

samuelmaddock marked this pull request as ready for review October 11, 2024 15:31

nornagon reviewed Oct 11, 2024

View reviewed changes

docs/api/web-frame-main.md Outdated Show resolved Hide resolved

github-actions bot added the target/34-x-y PR should also be added to the "34-x-y" branch. label Oct 15, 2024

electron-cation bot removed the new-pr 🌱 PR opened recently label Oct 18, 2024

samuelmaddock added the wip ⚒ label Oct 28, 2024

samuelmaddock mentioned this pull request Nov 12, 2024

feat(server): Add Reporting API server helpers getsentry/sentry-javascript#14044

Open

samuelmaddock force-pushed the feat/crash-call-stack branch from 9824088 to 5006bb8 Compare November 12, 2024 21:58

samuelmaddock removed the wip ⚒ label Nov 12, 2024

samuelmaddock requested review from deepak1556, nornagon and itsananderson November 12, 2024 22:03

samuelmaddock changed the title ~~feat: WebFrameMain.unresponsiveDocumentJSCallStack~~ feat: WebFrameMain.collectJavaScriptCallStack() Nov 12, 2024

deepak1556 reviewed Nov 13, 2024

View reviewed changes

deepak1556 approved these changes Nov 13, 2024

View reviewed changes

deepak1556 reviewed Nov 18, 2024

View reviewed changes

VerteDinde approved these changes Nov 18, 2024

View reviewed changes

erickzhao approved these changes Nov 21, 2024

View reviewed changes

itsananderson approved these changes Nov 22, 2024

View reviewed changes

electron-cation bot added api-review/approved ✅ and removed api-review/requested 🗳 labels Nov 22, 2024

samuelmaddock added 3 commits December 2, 2024 11:03

feat: WebFrameMain.unresponsiveDocumentJSCallStack

ca53c7b

Revert "feat: WebFrameMain.unresponsiveDocumentJSCallStack"

38b58b3

This reverts commit e0612bc.

feat: frame.collectJavaScriptCallStack()

d2d75d5

samuelmaddock added 2 commits December 2, 2024 11:03

feat: frame.collectJavaScriptCallStack()

7e50296

Update web-frame-main.md

0abc73f

samuelmaddock force-pushed the feat/crash-call-stack branch from 7bb871e to 0abc73f Compare December 2, 2024 16:03

deepak1556 approved these changes Dec 3, 2024

View reviewed changes

deepak1556 merged commit 2222920 into main Dec 3, 2024
53 checks passed

deepak1556 deleted the feat/crash-call-stack branch December 3, 2024 04:32

This was referenced Dec 3, 2024

feat: WebFrameMain.collectJavaScriptCallStack() #44937

Merged

feat: WebFrameMain.collectJavaScriptCallStack() #44938

Merged

trop bot added in-flight/33-x-y and removed target/33-x-y PR should also be added to the "33-x-y" branch. labels Dec 3, 2024

trop bot added in-flight/34-x-y merged/33-x-y PR was merged to the "33-x-y" branch. merged/34-x-y PR was merged to the "34-x-y" branch. and removed target/34-x-y PR should also be added to the "34-x-y" branch. in-flight/33-x-y in-flight/34-x-y labels Dec 3, 2024

GarboMuffin mentioned this pull request Jan 14, 2025

Show better error message when window gets stuck in infinite loop TurboWarp/desktop#1113

Open

mlaurencin mentioned this pull request Mar 4, 2025

chore: add Electron 35 blog post electron/website#761

Merged

5 tasks

feat: WebFrameMain.collectJavaScriptCallStack() #44204

feat: WebFrameMain.collectJavaScriptCallStack() #44204

Conversation

samuelmaddock commented Oct 11, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description of Change

Checklist

Release Notes

Uh oh!

Uh oh!

samuelmaddock commented Nov 12, 2024

Uh oh!

deepak1556 Nov 13, 2024

Choose a reason for hiding this comment

Uh oh!

erickzhao Nov 18, 2024

Choose a reason for hiding this comment

Uh oh!

samuelmaddock Nov 21, 2024 • 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!

deepak1556 left a comment

Choose a reason for hiding this comment

Uh oh!

deepak1556 Nov 18, 2024

Choose a reason for hiding this comment

Uh oh!

timfish Nov 18, 2024

Choose a reason for hiding this comment

Uh oh!

samuelmaddock Nov 18, 2024

Choose a reason for hiding this comment

Uh oh!

deepak1556 Nov 19, 2024

Choose a reason for hiding this comment

Uh oh!

nikwen Feb 4, 2025

Choose a reason for hiding this comment

Uh oh!

VerteDinde left a comment

Choose a reason for hiding this comment

Uh oh!

erickzhao left a comment

Choose a reason for hiding this comment

Uh oh!

itsananderson left a comment

Choose a reason for hiding this comment

Uh oh!

deepak1556 commented Nov 25, 2024

Uh oh!

Uh oh!

release-clerk bot commented Dec 3, 2024

Uh oh!

trop bot commented Dec 3, 2024

Uh oh!

trop bot commented Dec 3, 2024

Uh oh!

Uh oh!

samuelmaddock commented Oct 11, 2024 •

edited

Loading

samuelmaddock Nov 21, 2024 •

edited

Loading