Handle potential missing point stack execution points

[markerikson]

This PR:

• bumps the protocol package to 0.63 to pick up the types changes for getPointStack
• Tweaks the logic in some caches to handle pointStackFrame.point becoming optional

I think, based on https://github.com/replayio/backend/pull/8924 and https://github.com/replayio/backend/pull/8925 , that this will only ever occur if the frame just has an EnterFrame point and no meaningful frame steps. However, I don't know often that will occur in practice.

The code compiles, and I think the logic tweaks make sense reading it.

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
devtools	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Nov 9, 2023 8:08pm

[replay-io]

E2E Tests

Status	In Progress ↗︎
Commit	ca88571
Results	⚠️ 21 Flaky breakpoints-01: Test basic breakpoint functionality breakpoints-02: Test unhandled divergence while evaluating at a breakpoint breakpoints-03: Test stepping forward through breakpoints when rewound before the first one breakpoints-04: catch, finally, generators, and async/await console_warp-01: should support warping to console messages cypress-04: Test Step buttons and menu item inspector-computed-01: Basic computed styles can be viewed inspector-elements-01: Basic DOM tree node display inspector-rules-01: Basic CSS rules should be viewed logpoints-01: log-points appear in the correct order and allow time warping logpoints-10: too-many-points-to-find UX logpoints-11: too-many-points-to-run-analysis UX node_logpoint-01: Basic node logpoints node_worker-01: make sure node workers don't cause crashes object_preview-02: should allow objects in scope to be inspected react_devtools-01: Basic RDT behavior (FF) react_devtools-02: RDT integrations (Chromium) restart debugging session scopes_rerender: Test that scopes are rerendered sourcemap_stacktrace: Test that stacktraces are sourcemapped stacking: Element highlighter selects the correct element when they overlap ✅ 68 Passed authenticated/test-suites/library-test-runs authenticated/test-suites/library-tests-list breakpoints-05: Test interaction of breakpoints with debugger statements breakpoints-06: Test log point in a sourcemapped file breakpoints-07: rewind and seek using command bar and console messages breakpoints-08: should be temporarily disabled console_async: support console evaluations in async frames console_dock_node: Should show the correct docking behavior for recordings without video console_dock: Should show the correct docking behavior for recordings with video console_errors: Test that errors and warnings from various sources are shown in the console console_eval: support console evaluations console_warp-02: support pausing, warping, stepping and evaluating console messages console-expressions-01: should cache input eager eval and terminal expressions per instance cypress-01: Basic Test Suites panel functionality cypress-02: Test Step timeline behavior cypress-03: Test Step interactions cypress-05: Test DOM node preview on user action step hover fe-1875 :: verify that steps go to the right point in time file-search-01: should search files focus_mode-01: should filter messages as regions based on the active focus mode highlighter: element highlighter works everywhere inspector-elements-02_node-picker: element picker and iframe behavior inspector-elements-03: Nested node picker and selection behavior inspector-elements-04: Keyboard shortcuts should select the right DOM nodes inspector-rules-02: Sourcemapped rules should be viewed inspector-rules-03: Shorthand CSS rules should be viewed jump-to-code-01: Test basic jumping functionality logpoints-02: conditional log-points logpoints-03_chromium: should display event properties in the console logpoints-03: should display event properties in the console logpoints-04: should display exceptions in the console logpoints-05: should auto-complete based on log point location logpoints-06: should be temporarily disabled logpoints-07: should use the correct scope in auto-complete logpoints-08: should support jumping directly to a hit point via the capsule input logpoints-09: should support pending edits network-01: should filter requests by type and text network-02: should show details for the selected request network-03: should sync and display the current time in relation to the network requests node_console-01: Basic node console behavior node_console-02: uncaught exceptions should show up node_control_flow: catch, finally, generators, and async/await node_logpoint-02: Node exception logpoints node_object_preview: Showing console objects in node node_spawn: Basic subprocess spawning node_stepping-01: Test stepping in async frames and async call stacks object_preview-01: expressions in the console after time warping object_preview-03: Test previews when switching between frames and stepping object_preview-04: Test scope mapping and switching between generated/original sources object_preview-05: Should support logging objects as values object_preview-06: HTML elements playwright-01: Basic Test Suites panel functionality playwright-02: Test Step timeline behavior playwright-03: Test Step interactions quick_open_modal-01: Test basic searching functionality react_devtools-01: Basic RDT behavior (Chromium) react_devtools-03: process and display multiple React versions in page react_devtools-04: Component selection is maintained when seeking to a new point redux_devtools: Test Redux DevTools. repaint: repaints the screen screen when stepping over code that modifies the DOM resizable-panels-01: Left side Toolbar should be collapsible stepping-01: Test basic step-over/back functionality stepping-02: Test fixes for some simple stepping bugs stepping-03: Stepping past the beginning or end of a frame should act like a step-out stepping-04: Test stepping in a frame other than the top frame stepping-05_chromium: Test stepping in pretty-printed code stepping-05: Test stepping in pretty-printed code stepping-06: Test stepping in async frames and async call stacks

Snapshot Tests

Status	In Progress ↗︎
Commit	ca88571
Results	✅ 100 Passed display an overflow message scroll position should be restored when switching between sources should add this keyword to the list of suggestions should add true/false keywords to the list of suggestions should allow log point badge colors to be toggled should auto-suggestion text based on the current expression should be able to toggle side filter menu open and closed should be filterable should be filterable on complex content should be searchable should be searchable on complex content should copy arrays should copy dates should copy deep arrays should copy deep objects and their nested properties should copy errors should copy functions should copy html elements and text should copy maps should copy objects should copy primitive client values should copy regular expressions should copy sets should disable syntax highlight for long lines should display list of messages should display toggleable stack for errors should display toggleable stack for exceptions should display toggleable stack for traces should display toggleable stack for warnings should escape object expressions in terminal expressions should evaluate terminal expressions at an execution point should evaluate terminal expressions without an execution point should expand and collapse sources should expand and contract line height when log points are added and removed should expand and inspect arrays should expand and inspect objects should find matches in multiple sources should gracefully handle invalid remote analysis should handle too many points to find should handle too many points to run analysis should hide node_modules (and unpkg) if toggled should hide results when search is closed, and remember previous search string if re-opened should include log points in search results should include log points when filtering data should include or exclude external modules as requested should log events in the console should not allow saving log points with invalid conditional should not allow saving log points with invalid content should not allow submitting an invalid terminal expression should not erase break point when logging is toggled should not erase log point content when breaking is toggled should open a source and scroll to the correct line should overflow long log point text (without wrapping) should properly bucket properties for an overflowing array should re-focus the search input when CMD+F is used again should re-focus the terminal input when search input is hidden should refine string tokens to avoid unnecessarily escaping quotation marks should remember filter toggle preferences between reloads should remember search results count per source should render and inspect a Promise should render and inspect a Proxy should render and inspect arrays should render and inspect functions should render and inspect HTML elements should render and inspect maps should render and inspect objects should render and inspect regular expressions should render and inspect sets should render dates should render errors should render getters and setters correctly should render headers for complex data correctly should render nested, recursive values (as ellipses) without crashing should render primitive data correctly should render search results properly for lines with multiple breakable column positions should render sections correctly should render simple values should reset collapsed state if search changes should run local analysis for log points should run remote analysis for log points should scroll to line and column should show a button to clear terminal expressions should show different background color and edit icon when log point disabled should show error object stacks by default should show preview popup for instance properties should show the context menu on top of other messages and the current time indicator should show/hide object and array previews when toggled should suggest type-ahead options from prototype objects as well should support break points should support conditional log points should support continue to next and previous functionality should support custom badge styles for log points should support fuzzy file search should support jumping to a line in the active source file should support new lines in log points should support seeking to a message execution point should support setting focus range via the context menu should support terminal expressions with line breaks should support text search in the active source file should update the current time when the next/previous log point buttons are clicked

[replay-delta]

2 snapshot changes from primary branch

[hbenl]

We should return; if frame.point is not set - otherwise the debugger will step in the top frame rather than the selected frame.

[markerikson]

Okay, yeah, that's what I was wondering.

[socket-security]

Updated dependencies detected. Learn more about Socket for GitHub ↗︎

Packages	Version	New capabilities	Transitives	Size	Publisher
@replayio/protocol	0.60.0...0.63.0, 0.62.0...0.63.0	None	+0/-0	558 kB	dmiller_replay

[markerikson]

Talked with Josh about this.

One example where this could happen is class B extends class A, where A has a constructor but B does not. (This occurs in our doc_rr_error.html E2E example.) In that case, there's technically a constructor for B on the stack but it has no code associated with it, so you can't pause there.

In practice, any "top" or "bottom" stack frame (no matter which way you visualize the stack in your head) should have an execution point because there should be actual code involved.

For the Redux and React usage cases, we should never run into that scenario, because we're looking at user code frames that should have actual code.

[markerikson]

Added further comments clarifying the situation here.

[bvaughn]

One example where this could happen is class B extends class A, where A has a constructor but B does not. (This occurs in our doc_rr_error.html E2E example.) In that case, there's technically a constructor for B on the stack but it has no code associated with it, so you can't pause there.

This is the kind of thing that's great to capture in unit tests somewhere. I don't have a ton of context (just kind of drive by skimming this thing) but I wonder if there's an opportunity for us to add a test or two here?