feat: support optional message provenance across all SDKs - #2564
Open
aurokin wants to merge 1 commit into
Open
Conversation
Expose optional source in all six high-level SDK send APIs and preserve it through cloning and send-and-wait paths. Add a handwritten Rust typed-RPC builder, wire regressions, local runtime coverage, and documentation of acknowledgement and reply semantics. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Contributor
SDK Consistency ReviewReviewed PR #2564, which adds an optional message provenance Result: ✅ Consistent across all six SDKs.
Observations:
No API naming or behavioral inconsistencies found. Nice job keeping this feature addition uniform across the entire SDK surface.
|
Contributor
There was a problem hiding this comment.
Copilot review overview
🟢 Approval recommended
The implementation consistently forwards and omits provenance as specified, with comprehensive cross-SDK regression coverage.
Review tier: Balanced
Findings: None
What changed in this PR
Exposes optional message provenance across all six SDKs while preserving existing send behavior.
Changes:
- Adds
sourceto high-level send APIs and Rust typed RPC. - Preserves source through cloning and send-and-wait paths.
- Adds cross-language serialization, omission, delivery-mode, and runtime tests plus documentation.
| File | Description |
|---|---|
rust/src/types.rs |
Adds source option and builder. |
rust/src/session.rs |
Forwards source to JSON-RPC. |
rust/src/rpc.rs |
Adds typed-request source builder. |
rust/tests/session_test.rs |
Tests Rust wire behavior. |
rust/tests/api_types_test.rs |
Tests typed request serialization. |
rust/tests/e2e/copilot_request_handler.rs |
Tests runtime propagation. |
python/copilot/session.py |
Adds source keyword forwarding. |
python/test_session.py |
Tests Python send paths. |
nodejs/src/types.ts |
Adds TypeScript source option. |
nodejs/src/session.ts |
Forwards source in requests. |
nodejs/test/session-source.test.ts |
Tests Node.js serialization. |
go/types.go |
Adds source fields. |
go/session.go |
Forwards source when sending. |
go/session_test.go |
Tests Go send paths. |
dotnet/src/Types.cs |
Adds cloneable source property. |
dotnet/src/Session.cs |
Serializes source in requests. |
dotnet/test/Unit/CloneTests.cs |
Tests source cloning. |
dotnet/test/Unit/ClientSessionLifetimeTests.cs |
Tests .NET send behavior. |
java/sdk/src/main/java/com/github/copilot/rpc/MessageOptions.java |
Adds source accessors and cloning. |
java/sdk/src/main/java/com/github/copilot/rpc/SendMessageRequest.java |
Adds wire source field. |
java/sdk/src/main/java/com/github/copilot/CopilotSession.java |
Copies source into requests. |
java/sdk/src/test/java/com/github/copilot/MessageSourceTest.java |
Tests Java provenance behavior. |
docs/features/steering-and-queueing.md |
Documents provenance semantics. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
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.
Summary
Fixes #2563.
Expose the runtime's existing
sourcefield through the high-level send APIs in all six SDKs. This lets applications forward agent-originated messages without losing their provenance.MessageOptions.sourcesource=onsendandsend_and_waitMessageOptions.Source *stringMessageOptions.SourceMessageOptions.getSource()/setSource(...)MessageOptions.source/with_source(...), plus handwrittenrpc::SendRequest::with_source(...)Source is omitted when unset and forwarded unchanged when supplied. Clone and send-and-wait paths preserve it. Billing, delivery modes, attachments, display prompts, tracing, and correlation defaults remain unchanged. Generated files, schema visibility, dependencies, and CLI pins are untouched.
The shared steering documentation distinguishes provenance, delivery urgency, and response expectations. A successful high-level
sendacknowledgement returns a message ID and confirms acceptance, not recipient consumption. An accepted message should not be automatically resent merely because no visible reply appears.Validation
Targeted validation completed locally on macOS arm64:
session-source.test.tsandsession-send-and-wait.test.ts; typecheck, declaration emission, ESLint, and Prettier passedtest_session.py; Ruff and ty passedgo vet .passedmvn verify -pl sdk -Pskip-test-harness -Dtest=MessageSourceTest,MessageAttachmentTest,ConfigCloneTest -DskipITs: 60 tests passed, including 16 provenance tests covering both delivery modes; Checkstyle, scoped Spotless, and Java 25 overlay verification passedsession_testandapi_types_test; all test targets compiled; all-target Clippy, formatting, and rustdoc passedThe Rust local-runtime regression also executed against official standalone Copilot CLI 1.0.83. Its eight cases cover high-level and typed-RPC sends, enqueue and immediate delivery, and supplied and omitted source. The test uses synthetic inference and verifies the resulting
user.messageprovenance and correlation.Fresh code-review passes found no significant issues in the final six-language change set. The subsequent documentation-only acknowledgement clarification was reviewed separately.
Limits
Full E2E suites and cross-platform execution were not run. The new non-Rust regressions exercise request serialization and loopback transport, not live model sessions.
This is SDK passthrough, not an end-to-end remote-provenance guarantee. Mission Control currently accepts and locally echoes source but drops it from remote HTTP delivery. No remote transport redesign or consumer-app integration is included.