docs(webview): sync webview-ext migration manual with merged package#779
Merged
Conversation
…s and new options bag requirements
…s and new options bag requirements
…rosoft/vscode-documentdb into dev/tnaum/webview-migrations # Conflicts: # docs/ai-and-plans/PRs/766-webview-ext-package-redesign/webview-ext-migration-manual.md
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the internal webview migration manual to match the merged @microsoft/vscode-ext-webview host-wiring API and the DocumentDB integration patterns introduced in PR #766.
Changes:
- Updates the rename map and samples to pass
trpc(frominitWebviewTrpc<...>()) intoWebviewController/openWebview, and to include the requiredisBundled: booleanoption. - Refreshes the telemetry adapter sample to reflect
parseErrorenrichment and aborted-call handling viagetInvocationSignal. - Tweaks React hook wrapper example to return
TrpcClient<AppRouter>explicitly and notes optional logging (rpcConcurrencyLogger) in options.
Contributor
✅ Code Quality Checks
This comment is updated automatically on each push. |
languy
approved these changes
Jul 6, 2026
Contributor
📦 Build Size Report
Download artifact · updated automatically on each push. |
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
Brings the internal
webview-ext-migration-manual.mdback in sync with the@microsoft/vscode-ext-webviewpackage as it landed in PR #766. The manual had drifted from the merged host-wiring API; this updates the rename map, code samples, and checklist to match the shipped code.Changes
trpcreplacescreateCallerFactoryin the options bag (Path A / Path B / rename map / checklist).createCallerFactoryis retained in the package but is now@deprecated; the caller factory is read off theinitWebviewTrpc<...>()instance so it can never be mismatched with the router.isBundled: booleanis now a required option — added to allWebviewController/openWebviewsamples.WithTelemetryis now a package-exported generic (FrameworkWithTelemetry<T, ITelemetryContext>), not a locally-definedOmit<...>type.documentDbTelemetryRunnersample updated to reflect the real adapter:parseError-based error enrichment plus aborted-call handling viagetInvocationSignal(R766-C02).useTrpcClientwrapper return type (TrpcClient<AppRouter>), thelogger: rpcConcurrencyLoggeroption, and thetrpcre-export.attachTrpcsection's explicitcreateCallerFactoryargument as-is — the low-level primitive still takes it.Notes
Docs-only change to an internal working note under
docs/ai-and-plans/; no source, tests, or localization are affected. File is Prettier-clean.