Refactor: Define Webview RPC Contracts Using JSON-RPC syntax to added typings #19613
Conversation
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
…import handling and error management
…quest and notification types for improved communication and state management
…n structure - Updated VscodeWebviewProvider to utilize sendRequest and sendNotification for theme, state, and localization retrieval. - Refactored ConnectionDialogStateProvider to replace call with sendRequest for getting connection display names. - Modified CommandBar and QueryResultPane to use sendRequest for saving results and loading rows. - Enhanced table plugins to adopt sendRequest for clipboard operations and filter management. - Updated SchemaDesignerStateProvider to utilize sendRequest for initializing and managing schema sessions. - Introduced new request types in sharedInterfaces for better type safety and clarity in RPC communication.
…otification structure for improved communication and state management
aasimkhan30
requested review from
kburtram,
caohai,
laurenastrid1,
lewis-sanchez and
Benjin
as code owners
aasimkhan30
commented
Jun 16, 2025
src/reactviews/common/rpc.ts
Outdated
There was a problem hiding this comment.
Please review this file more carefully as it actually defines the new architecture.
aasimkhan30
commented
Jun 16, 2025
There was a problem hiding this comment.
Please review this file more carefully as it actually defines the new architecture.
… banned imports in tests
…ity and maintainability
…fication types for improved clarity and maintainability
PR Changes
|
caohai
reviewed
Jun 16, 2025
Benjin
approved these changes
Jun 16, 2025
| @@ -4,7 +4,7 @@ | |||
| *--------------------------------------------------------------------------------------------*/ | |||
|
|
|||
| import { ExpandParams } from "./expandNodeRequest"; | |||
| import { RequestType } from "vscode-jsonrpc"; | |||
| import { RequestType } from "vscode-languageclient"; | |||
There was a problem hiding this comment.
Keeping it consistent with other mssql contracts.
…c to improve clarity and consistency in request resolution
…roved accessibility in ReactWebviewBaseController
…e arrow function syntax for improved consistency and readability
caohai
reviewed
Jun 17, 2025
caohai
reviewed
Jun 17, 2025
…n registerCommonRequestHandlers
…rs in registerCommonRequestHandlers
caohai
approved these changes
Jun 17, 2025
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.
Pull Request Template – vscode-mssql
Description
This PR updates our webview communication to follow a more structured JSON-RPC style by introducing strongly typed contracts.
We now support bidirectional communication between webviews and their controllers via:
onRequestsendRequestonNotificationsendNotificationThis change brings our webview architecture closer to the existing STS ↔ extension communication model. It unifies the syntax, improves type safety, and makes development and debugging much easier.
One of the biggest benefits is improved discoverability. You can now easily trace who is calling or handling a request just by checking the references of the request type:
In this screenshot,
GetPlatformRequestclearly shows both the caller and the handler, making things more maintainable.I'll explore a similar pattern for refactoring reducers in a future PR.
Code Changes Checklist
npm run test)Reviewers: Please read our reviewer guidelines