[TECHDEBT]: Remove _SPECIAL_PROPERTIES hack in lsp_engine.py #1378
Labels
enhancement
New feature or request
Comments
Closed
Merged
gueniai
added a commit
that referenced
this issue
Jan 15, 2025
This PR implements `LSPEngine`, a `TranspileEngine` that leverages the Language Server Protocol to launch and communicate with a pluggable transpiler, implemented as a LSP server. In our prototype, we used the existing LSP `CodeAction` mechanism with `CodeActionKind.Refactor.` This design works well when using VSCode as a client, but is not ideal for batch transpile: - it does not provide a deterministic way to identify the command for transpiling to databricks - it requires 2 interactions with the server for each file (1 to fetch the command, 1 to execute it) - the transpile result is sent asynchronously, which complicates the client engine's job - the transpile errors are sent asynchronously, which complicates the client engine's job For those reasons, this PR chooses a different design, relying on LSP custom capabilities. The `LSPEngine` supports a "document/transpileToDatabricks" capability, that the server must register during initialization. Once the registration is done, the LSPEngine can then safely invoke that capability, which returns all the results in a single response (changes and errors). This mechanism is tested successfully against a test LSPServer (which for transpiling, simply sets the content to uppercase). Worth noting, this PR works around a limitation (bug ?) in the lsprotocol Python library, where custom capability messages are incorrectly serialized. This is considered tech debt, for which an issue has been created: #1378 Fixes #1299 Requires #1364 Requires #1390 Supersedes #1354 --------- Co-authored-by: Guenia Izquierdo Delgado <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Is there an existing issue for this?
Category of feature request
Transpile
Problem statement
Transpile Document Request is not serialized properly OOTB by lsprotocol. To work around the issue, lsp_engine extends the _SPECIAL_PROPERTIES private data structure. This is ugly and risky.
Proposed Solution
Implement a custom serialization hook.
Additional Context
No response
The text was updated successfully, but these errors were encountered: