microsoft / sqlops-dataprotocolclient

Azure Data Studio Data Protocol Client

Description

This repo is for the dataprotocol-client package, which is used by Azure Data Studio extensions wishing to implement certain core features, such as a Query Provider.

This is done through an implementation on top of the VS Code Language Client. This package is used to set up the features and messages that will then be implemented by the backing language server (such as SQL Tools Service). You can see further descriptions of the messages defined here

Currently, this package is NOT published to npm or any other package manager. Instead, extensions will reference the Github releases directly. These releases point to commits out of the release branch, which contains the compiled JS sources that extensions will be using at runtime.

See the wiki for more information.

Build and Run From Source

git clone https://github.com/Microsoft/sqlops-dataprotocolclient.git
cd sqlops-dataprotocolclient
yarn
yarn run watch

Create a release

See the wiki for instructions on making and releasing new changes.

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.

sqlops-dataprotocolclient's Issues

Need documentation on repo usage/process

Would like to propose adding some documentation in Readme/Wiki about:

• What's the goal/requirements of this repository?
• When should one update the code in this repository?
• Who is the customer/end user of releases?
• Release timeline and how are releases validated.

vscode-languageclient 3.5.0 is broken

This dependency is broken and doesn't compile under typescript.

Provider event handlers only allow a single handler to be registered

Event handlers such as ConnectionProvider#registerOnConnectionComplete only accept a single event handler. Any new event handler overwrites the existing one. Which means extensions aren't able to use these register... functions on an existing provider without breaking the app (since generally these are supposed to be used by the creator of the provider to handle events coming from core and process them)

Master won't compile

Running yarn from master gives the following error:

src/main.ts(381,23): error TS2694: Namespace ''sqlops'' has no exported member 'SyntaxParseParams'.
src/protocol.ts(388,45): error TS2694: Namespace ''sqlops'' has no exported member 'SyntaxParseParams'.
npm ERR! code ELIFECYCLE
npm ERR! errno 2
npm ERR! [email protected] compile: tsc -p ./src
npm ERR! Exit status 2
npm ERR!
npm ERR! Failed at the [email protected] compile script.
npm ERR! This is probably not a problem with npm. There is likely additional logging output above

This repo is missing important files

There are important files that Microsoft projects should all have that are not present in this repository. A pull request has been opened to add the missing file(s). When the pr is merged this issue will be closed automatically.

Microsoft teams can learn more about this effort and share feedback within the open source guidance available internally.

Merge this pull request

OnConnectionChanged parameter type differs from ADS version

Here we defined the parameter for onConnectionChanged to have an "ownerUri" property, but the corresponding type in ADS of ChangedConnectionInfo has connectionUri.

Since extensions are typically only going to be using the azdata typings this shouldn't be the case, and could easily lead to providers sending the wrong values.