Add shared session watch APIs by toliaqat · Pull Request #2415 · github/copilot-sdk

toliaqat · 2026-08-26T19:40:57Z

Summary

generate the additive Node and Rust sessions.watch({ sessionId }) RPC surface from Runtime schema commit 7c34f30aa270d2a6214d1aa0274fc1afd4c9790d (SHA-256 dec3e7be93b7a3ca023eff9f6e90e9858bb6305d15f547d0e599283828a9b310)
add passive SharedSessionWatch handles with immutable read-only metadata, ordered replay/live session.event delivery, idempotent sessions.close, and no interactive or lane-credential surface
propagate the exact connection-scoped { type: "session.disconnected", sessionId } terminal lifecycle signal and atomically clean up watch routing after preceding events
make client shutdown classify watch entries in the router so concurrent disconnect cleanup cannot select session.destroy
document and test the generated payload, replay registration, passive surface, terminal propagation, close cleanup, and shutdown cleanup

Validation

Node focused watch/lifecycle tests (3 passed)
Node typecheck
Node lint (existing unrelated warnings only)
Rust focused watch/shutdown tests (2 passed)
Rust generated watch payload test
Rust lifecycle-union test
Rust clippy with all features/targets
Rust nightly format check

Runtime and publication dependency

The generated API is pinned to the main-based schema-only Runtime commit above. Execution and normal package-backed regeneration remain blocked until a new @github/copilot publication carries Runtime PR github/copilot-agent-runtime#17282 (0179092d8c319b60b4b8cb7df0b0829c095adb4f) together with sessions.watch and the hand-written session.disconnected lifecycle union. The lifecycle variant is intentionally absent from generated/api.schema.json.

Expose passive shared-session watch handles for Node and Rust, with generated RPC types, ordered event routing, lifecycle cleanup, and tests. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Copilot

Pull request overview

Adds passive shared-session watch APIs for Node.js and Rust, including event replay, lifecycle handling, cleanup, documentation, and generated RPC types.

Changes:

Adds read-only shared-session watch handles and sessions.watch integration.
Propagates session.disconnected lifecycle events and cleans up routing.
Updates generated schemas, tests, documentation, and line-ending rules.

Show a summary per file

File	Description
`.gitattributes`	Standardizes Node.js and Rust line endings.
`nodejs/README.md`	Documents shared-session watching.
`nodejs/src/client.ts`	Implements watch creation and cleanup.
`nodejs/src/generated/rpc.ts`	Adds generated watch RPC types.
`nodejs/src/generated/session-events.ts`	Refreshes generated event types.
`nodejs/src/index.ts`	Exports watch and lifecycle APIs.
`nodejs/src/session.ts`	Adds the passive watch handle.
`nodejs/src/types.ts`	Adds disconnected lifecycle typing.
`nodejs/test/client.test.ts`	Tests watch behavior and payloads.
`rust/README.md`	Documents Rust watch usage.
`rust/src/generated/api_types.rs`	Refreshes generated RPC payload types.
`rust/src/generated/rpc.rs`	Adds the generated watch RPC method.
`rust/src/generated/session_events.rs`	Refreshes generated event types.
`rust/src/handler.rs`	Updates permission-context example.
`rust/src/lib.rs`	Tracks watches and lifecycle cleanup.
`rust/src/router.rs`	Makes the session router cloneable.
`rust/src/session.rs`	Updates permission-context fixtures.
`rust/src/types.rs`	Adds disconnected lifecycle support.
`rust/src/watch.rs`	Implements Rust shared-session watches.
`rust/tests/api_types_test.rs`	Tests credential-free payload shapes.
`rust/tests/session_test.rs`	Tests replay, disconnect, and close behavior.

Review details

💡 Configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Files reviewed: 16/21 changed files
Comments generated: 3
Review effort level: Balanced

Guard the hand-authored Node and Rust lifecycle unions against silent drift from the Runtime notification contract. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Regenerate the watch RPC from the accepted contract while preserving the SDK's published CLI schema surface and removing unrelated newer Runtime event/type drift. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: be0a255d-04f8-4830-888a-59f54ad1e607

Keep the generated watch API additive against the SDK's pinned CLI schema and leave repository-wide line-ending policy unchanged. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: be0a255d-04f8-4830-888a-59f54ad1e607

Route disconnect cleanup in the ordered session notification task and store watch classification with router entries so shutdown always uses sessions.close without racing terminal cleanup. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: be0a255d-04f8-4830-888a-59f54ad1e607

Resolve conflicts preserving both the shared session watch API surface and main's GitHub token provider work: - nodejs/src/client.ts: keep both sharedSessionWatches.clear() and githubTokenProviders.clear() in stop() and forceStop(). - rust/src/lib.rs: keep register/unregister_watch_session alongside main's register/retire_github_token_provider, and pass main's new required github_token_registry argument to router.ensure_started(). - rust/src/lib.rs: keep main's github_token_registry.clear() in force_stop(). - rust/src/types.rs: union both test import lists (SessionLifecycleEventType + PermissionResponseCapability). - rust/tests/session_test.rs: keep both new test sets. Also address PR review feedback: - nodejs/test/client.test.ts: replace the unreachable if (false) block (CodeQL) with a reachable compile-time PassiveWatch type assertion that still fails to compile if send/abort appear on SharedSessionWatch. - nodejs/src/session.ts: wrap replay dispatch in the same try/catch used for live delivery so a throwing handler cannot drop remaining replay events or prevent on() from returning its unsubscribe function. - rust/tests/session_test.rs: bound the final watch.events().recv() with timeout(TIMEOUT, ...) so a cleanup regression fails instead of hanging. - nodejs/src/client.ts: wrap an over-length if condition to satisfy prettier. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

+                                    }
+                                }
+                                Ok(_) => {}
+                                Err(e) => {


github-actions · 2026-08-27T03:02:53Z

Cross-SDK Consistency Review

This PR adds the sessions.watch / watchSharedSession API surface to Node.js/TypeScript and Rust, but the feature is not yet present in the remaining four SDK implementations:

SDK	Status
Node.js/TypeScript	✅ Added in this PR
Rust	✅ Added in this PR
Python	❌ Missing
Go	❌ Missing
.NET	❌ Missing
Java	❌ Missing

New API surface introduced

RPC call: sessions.watch({ sessionId }) → returns { sessionId, metadata, readOnly }
Client method: watchSharedSession(sessionId) → passive SharedSessionWatch handle
Handle surface: sessionId, metadata, readOnly, on(event => ...), close()
Lifecycle signal: session.disconnected terminal event propagated through the existing lifecycle channel
Shutdown cleanup: client shutdown iterates and closes all active watch handles

Suggestions for follow-up

The following equivalent APIs would be the natural parallel additions:

Python: watch_shared_session(session_id: str) -> SharedSessionWatch (async context manager)
Go: WatchSharedSession(ctx context.Context, sessionID string) (*SharedSessionWatch, error)
.NET: WatchSharedSessionAsync(string sessionId) -> Task<SharedSessionWatch>
Java: watchSharedSession(String sessionId) -> CompletableFuture<SharedSessionWatch>

Since the PR description explicitly notes that execution is blocked on a future @github/copilot publication (Runtime PR #17282), it is reasonable to defer the other-language implementations until the runtime dependency lands. Tracking the gap now so the missing SDKs can be updated in the same follow-on cycle would keep the release consistent.

No blocking issues — this is informational to help plan the cross-SDK rollout.

Generated by SDK Consistency Review Agent for #2415 · sonnet46 26 AIC · ⌖ 5.5 AIC · ⊞ 6.6K · ◷

Add shared session watch APIs

a0d81b0

Expose passive shared-session watch handles for Node and Rust, with generated RPC types, ordered event routing, lifecycle cleanup, and tests. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Copilot AI balanced review requested due to automatic review settings August 26, 2026 19:40

toliaqat requested a review from a team as a code owner August 26, 2026 19:40

Copilot started reviewing on behalf of toliaqat August 26, 2026 19:41 View session

github-advanced-security Bot found potential problems Aug 26, 2026

View reviewed changes

Comment thread nodejs/test/client.test.ts Fixed

This comment has been minimized.

Sign in to view

Copilot AI reviewed Aug 26, 2026

View reviewed changes

Comment thread rust/src/lib.rs Outdated

Comment thread rust/tests/session_test.rs Outdated

Comment thread nodejs/src/session.ts

toliaqat and others added 2 commits August 26, 2026 12:50

Pin shared watch lifecycle variants

ab59d44

Guard the hand-authored Node and Rust lifecycle unions against silent drift from the Runtime notification contract. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

This comment has been minimized.

Sign in to view

toliaqat and others added 2 commits August 26, 2026 14:07

github-advanced-security Bot found potential problems Aug 27, 2026

View reviewed changes

Comment thread rust/src/router.rs

}

}

Ok(_) => {}

Err(e) => {

Navigation Menu

Uh oh!

Add shared session watch APIs - #2415

Add shared session watch APIs#2415
toliaqat wants to merge 6 commits into
mainfrom
toliaqat-expose-shared-watch-api

toliaqat commented Aug 26, 2026 •

edited

Loading

Uh oh!

Uh oh!

This comment has been minimized.

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

This comment has been minimized.

This comment has been minimized.

github-actions Bot commented Aug 27, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Conversation

toliaqat commented Aug 26, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Validation

Runtime and publication dependency

Uh oh!

Uh oh!

This comment has been minimized.

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Review details

Uh oh!

Uh oh!

Uh oh!

Uh oh!

This comment has been minimized.

This comment has been minimized.

github-actions Bot commented Aug 27, 2026

Cross-SDK Consistency Review

New API surface introduced

Suggestions for follow-up

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

toliaqat commented Aug 26, 2026 •

edited

Loading