[fix]: clean up cdp session event handlers#2288
Open
seanmcguire12 wants to merge 8 commits into
Open
Conversation
🦋 Changeset detectedLatest commit: 5e7d04a The changes in this PR will be included in the next version bump. This PR includes changesets to release 3 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
Contributor
There was a problem hiding this comment.
1 issue found across 3 files
Confidence score: 3/5
- In
packages/core/lib/v3/understudy/cdp.ts, theTarget.targetDestroyedcleanup currently exits after the first matching session, so other session-bound handlers on the same target can remain attached and keep receiving events unexpectedly; this can cause stale callbacks/memory leaks and cross-session side effects after a target closes — update the cleanup to continue iterating and remove handlers for all sessions tied to that target before merging.
Architecture diagram
sequenceDiagram
participant Chrome as Chrome DevTools (CDP)
participant Connection as CdpConnection
participant Handlers as eventHandlers Map
participant Sessions as sessions Map
participant GlobalHandler as Root event handler
participant OtherSession as CdpSession (session-b)
Note over Chrome,OtherSession: Session attach and handler registration
Chrome->>Connection: Target.attachedToTarget (sessionId: "session-a")
Connection->>Sessions: store session metadata
Connection-->>Chrome: ack
Connection->>Connection: session.on("Fetch.requestPaused", handler)
Connection->>Handlers: set key "session-a:Fetch.requestPaused"
Connection->>Connection: session.on("Network.requestWillBeSent", handler)
Connection->>Handlers: set key "session-a:Network.requestWillBeSent"
Note over Chrome,OtherSession: Another session attaches (to verify preservation)
Chrome->>Connection: Target.attachedToTarget (sessionId: "session-b")
Connection->>Sessions: store session-b metadata
Connection->>Connection: otherSession.on("Fetch.requestPaused", handler)
Connection->>Handlers: set key "session-b:Fetch.requestPaused"
GlobalHandler->>Connection: on("Target.targetCreated", rootHandler)
Connection->>Handlers: set key "Target.targetCreated" (root-level, no prefix)
Note over Chrome,GlobalHandler: --- Detach triggers cleanup ---
Chrome->>Connection: Target.detachedFromTarget (sessionId: "session-a", targetId: "target-a")
Connection->>Connection: NEW: clearSessionEventHandlers("session-a")
Connection->>Handlers: delete keys starting with "session-a:"
Handlers-->>Connection: removed "session-a:Fetch.requestPaused" & "session-a:Network.requestWillBeSent"
Connection->>Sessions: delete session-a metadata
Connection-->>Chrome: ack
Chrome->>Connection: Target.targetCreated (target-b) [root event]
Connection->>Handlers: lookup "Target.targetCreated"
Handlers-->>Connection: rootHandler
Connection->>GlobalHandler: invoke root handler
GlobalHandler-->>Connection: done
Note over Connection,Handlers: Verify other session handlers remain
alt Other handler preserved
Connection->>Handlers: check key "session-b:Fetch.requestPaused"
Handlers-->>Connection: still present
end
Note over Chrome,GlobalHandler: --- Alternative: Target.targetDestroyed ---
Chrome->>Connection: Target.targetDestroyed (targetId: "target-b")
Connection->>Sessions: find sessionId for targetId "target-b"
Sessions-->>Connection: "session-b"
Connection->>Connection: NEW: clearSessionEventHandlers("session-b")
Connection->>Handlers: delete keys starting with "session-b:"
Handlers-->>Connection: removed "session-b:Fetch.requestPaused"
Connection->>Sessions: delete session-b metadata
Reply with feedback, questions, or to request a fix.
Re-trigger cubic
4ceadba to
1d7e608
Compare
Member
Author
Contributor
|
@seanmcguire12 I have started the AI code review. It will take a few minutes to complete. |
Contributor
There was a problem hiding this comment.
1 issue found across 3 files
Confidence score: 3/5
- In
packages/core/lib/v3/understudy/cdp.ts, theTarget.targetDestroyedcleanup path for mapped sessions can drop session state without rejecting pendingsend/dispatch waiters, which can leave CDP calls hanging and cause user-visible stalls or timeouts. Mirror the teardown behavior used in theT...branch so pending promises are explicitly rejected before removing handlers, then add a regression test for destroyed-session in-flight requests before merging.
Architecture diagram
sequenceDiagram
participant Chrome as CDP Agent
participant Conn as CdpConnection
participant Handlers as eventHandlers Map
participant Sessions as sessions/maps
Note over Chrome,Sessions: Target.detachedFromTarget Flow
Chrome->>Conn: "Target.detachedFromTarget" (sessionId, targetId)
Conn->>Conn: Extract sessionId
Conn->>Conn: NEW: clearSessionEventHandlers(sessionId)
Conn->>Handlers: Iterate keys starting with `${sessionId}:`
Handlers-->>Conn: Delete all matching entries
Conn->>Sessions: Remove sessionId from sessions map
Conn->>Sessions: Remove sessionId from sessionToTarget map
Conn->>Sessions: Remove sessionId from latestCdpCallEvent map
Conn-->>Chrome: (event processed)
Note over Chrome,Sessions: Target.targetDestroyed Flow
Chrome->>Conn: "Target.targetDestroyed" (targetId)
Conn->>Conn: Find all sessionIds for targetId
loop For each sessionId mapped to this target
Conn->>Conn: NEW: clearSessionEventHandlers(sessionId)
Conn->>Handlers: Delete `${sessionId}:*` keys
Conn->>Sessions: Delete sessionId from sessions map
Conn->>Sessions: Delete sessionId from sessionToTarget map
Conn->>Sessions: Delete sessionId from latestCdpCallEvent map
end
Conn-->>Chrome: (event processed)
Reply with feedback, questions, or to request a fix.
Re-trigger cubic
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
why
CdpSession.on(...)stores session scoped listeners on the rootCdpConnectionunder keys like${sessionId}:${event}. when chrome sendsTarget.detachedFromTarget,CdpConnectionremoves session metadata, but the actual event handlers were not being removedthis was problematic because stale handler functions remained reachable for the lifetime of the root connection. this could cause memory to grow, particularly for long sessions with a lot of attach/detach churn
what changed
added
CdpConnection.clearSessionEventHandlers(sessionId), which:Target.detachedFromTargetorTarget.targetDestroyedfirestest plan
added tests in
packages/core/dist/esm/tests/unit/cdp-connection-close.test.js, which verify:Target.targetDestroyedfiresSummary by cubic
Fixes memory leaks and prevents hangs by cleaning up CDP session event handlers and rejecting pending work when targets detach or are destroyed. Aligns with Linear STG-2415.
clearSessionEventHandlers(sessionId)to remove${sessionId}:*listeners.rejectSessionPendingWork(sessionId, targetId)to reject in-flight.sendcalls and session dispatch waiters withPageNotFoundError.Target.detachedFromTargetandTarget.targetDestroyed: call both methods and delete affected sessions/mappings (for destroyed targets, all sessions mapped to the target). Tests cover cleanup across detach/destroy, multiple sessions per target, rejection of pending work, and preservation of other sessions and root-level handlers.Written for commit 5e7d04a. Summary will update on new commits.