|
| 1 | +""" |
| 2 | +Provides Clojure specific instantiation of the LanguageServer class. Contains various configurations and settings specific to Clojure. |
| 3 | +""" |
| 4 | + |
| 5 | +import asyncio |
| 6 | +import json |
| 7 | +import logging |
| 8 | +import os |
| 9 | +import stat |
| 10 | +import pathlib |
| 11 | +from contextlib import asynccontextmanager |
| 12 | +from typing import AsyncIterator |
| 13 | + |
| 14 | +from multilspy.multilspy_logger import MultilspyLogger |
| 15 | +from multilspy.language_server import LanguageServer |
| 16 | +from multilspy.lsp_protocol_handler.server import ProcessLaunchInfo |
| 17 | +from multilspy.lsp_protocol_handler.lsp_types import InitializeParams |
| 18 | +from multilspy.multilspy_config import MultilspyConfig |
| 19 | +from multilspy.multilspy_utils import FileUtils |
| 20 | +from multilspy.multilspy_utils import PlatformUtils |
| 21 | + |
| 22 | + |
| 23 | +class ClojureLSP(LanguageServer): |
| 24 | + """ |
| 25 | + Provides a clojure-lsp specific instantiation of the LanguageServer class. Contains various configurations and settings specific to clojure. |
| 26 | + """ |
| 27 | + |
| 28 | + def __init__(self, config: MultilspyConfig, logger: MultilspyLogger, repository_root_path: str): |
| 29 | + """ |
| 30 | + Creates a ClojureLSP instance. This class is not meant to be instantiated directly. Use LanguageServer.create() instead. |
| 31 | + """ |
| 32 | + clojure_lsp_executable_path = self.setup_runtime_dependencies(logger, config) |
| 33 | + super().__init__( |
| 34 | + config, |
| 35 | + logger, |
| 36 | + repository_root_path, |
| 37 | + ProcessLaunchInfo(cmd=clojure_lsp_executable_path, cwd=repository_root_path), |
| 38 | + "clojure", |
| 39 | + ) |
| 40 | + self.server_ready = asyncio.Event() |
| 41 | + self.initialize_searcher_command_available = asyncio.Event() |
| 42 | + self.resolve_main_method_available = asyncio.Event() |
| 43 | + self.service_ready_event = asyncio.Event() |
| 44 | + |
| 45 | + def setup_runtime_dependencies(self, logger: MultilspyLogger, config: MultilspyConfig) -> str: |
| 46 | + """ |
| 47 | + Setup runtime dependencies for clojure-lsp. |
| 48 | + """ |
| 49 | + platform_id = PlatformUtils.get_platform_id() |
| 50 | + |
| 51 | + with open(os.path.join(os.path.dirname(__file__), "runtime_dependencies.json"), "r", encoding="utf-8") as f: |
| 52 | + d = json.load(f) |
| 53 | + del d["_description"] |
| 54 | + |
| 55 | + runtime_dependencies = d["runtimeDependencies"] |
| 56 | + runtime_dependencies = [ |
| 57 | + dependency for dependency in runtime_dependencies if dependency["platformId"] == platform_id.value |
| 58 | + ] |
| 59 | + assert len(runtime_dependencies) == 1 |
| 60 | + dependency = runtime_dependencies[0] |
| 61 | + |
| 62 | + clojurelsp_ls_dir = os.path.join(os.path.dirname(__file__), "static", "clojure-lsp") |
| 63 | + clojurelsp_executable_path = os.path.join(clojurelsp_ls_dir, dependency["binaryName"]) |
| 64 | + if not os.path.exists(clojurelsp_ls_dir): |
| 65 | + os.makedirs(clojurelsp_ls_dir) |
| 66 | + FileUtils.download_and_extract_archive( |
| 67 | + logger, dependency["url"], clojurelsp_ls_dir, dependency["archiveType"] |
| 68 | + ) |
| 69 | + assert os.path.exists(clojurelsp_executable_path) |
| 70 | + os.chmod(clojurelsp_executable_path, stat.S_IEXEC) |
| 71 | + |
| 72 | + return clojurelsp_executable_path |
| 73 | + |
| 74 | + def _get_initialize_params(self, repository_absolute_path: str) -> InitializeParams: |
| 75 | + """ |
| 76 | + Returns the init params for clojure-lsp. |
| 77 | + """ |
| 78 | + with open(os.path.join(os.path.dirname(__file__), "initialize_params.json"), "r", encoding="utf-8") as f: |
| 79 | + d = json.load(f) |
| 80 | + |
| 81 | + del d["_description"] |
| 82 | + |
| 83 | + d["processId"] = os.getpid() |
| 84 | + assert d["rootPath"] == "$rootPath" |
| 85 | + d["rootPath"] = repository_absolute_path |
| 86 | + |
| 87 | + assert d["rootUri"] == "$rootUri" |
| 88 | + d["rootUri"] = pathlib.Path(repository_absolute_path).as_uri() |
| 89 | + |
| 90 | + assert d["workspaceFolders"][0]["uri"] == "$uri" |
| 91 | + d["workspaceFolders"][0]["uri"] = pathlib.Path(repository_absolute_path).as_uri() |
| 92 | + |
| 93 | + assert d["workspaceFolders"][0]["name"] == "$name" |
| 94 | + d["workspaceFolders"][0]["name"] = os.path.basename(repository_absolute_path) |
| 95 | + |
| 96 | + return d |
| 97 | + |
| 98 | + @asynccontextmanager |
| 99 | + async def start_server(self) -> AsyncIterator["ClojureLSP"]: |
| 100 | + """ |
| 101 | + Starts the Clojure Language Server, waits for the server to be ready and yields the LanguageServer instance. |
| 102 | +
|
| 103 | + Usage: |
| 104 | + ``` |
| 105 | + async with lsp.start_server(): |
| 106 | + # LanguageServer has been initialized and ready to serve requests |
| 107 | + await lsp.request_definition(...) |
| 108 | + await lsp.request_references(...) |
| 109 | + # Shutdown the LanguageServer on exit from scope |
| 110 | + # LanguageServer has been shutdown |
| 111 | + """ |
| 112 | + |
| 113 | + async def register_capability_handler(params): |
| 114 | + assert "registrations" in params |
| 115 | + for registration in params["registrations"]: |
| 116 | + if registration["method"] == "workspace/executeCommand": |
| 117 | + self.initialize_searcher_command_available.set() |
| 118 | + self.resolve_main_method_available.set() |
| 119 | + return |
| 120 | + |
| 121 | + async def lang_status_handler(params): |
| 122 | + # TODO: Should we wait for |
| 123 | + # server -> client: {'jsonrpc': '2.0', 'method': 'language/status', 'params': {'type': 'ProjectStatus', 'message': 'OK'}} |
| 124 | + # Before proceeding? |
| 125 | + if params["type"] == "ServiceReady" and params["message"] == "ServiceReady": |
| 126 | + self.service_ready_event.set() |
| 127 | + |
| 128 | + async def execute_client_command_handler(params): |
| 129 | + return [] |
| 130 | + |
| 131 | + async def do_nothing(params): |
| 132 | + return |
| 133 | + |
| 134 | + async def check_experimental_status(params): |
| 135 | + if params["quiescent"] == True: |
| 136 | + self.server_ready.set() |
| 137 | + |
| 138 | + async def window_log_message(msg): |
| 139 | + self.logger.log(f"LSP: window/logMessage: {msg}", logging.INFO) |
| 140 | + |
| 141 | + self.server.on_request("client/registerCapability", register_capability_handler) |
| 142 | + self.server.on_notification("language/status", lang_status_handler) |
| 143 | + self.server.on_notification("window/logMessage", window_log_message) |
| 144 | + self.server.on_request("workspace/executeClientCommand", execute_client_command_handler) |
| 145 | + self.server.on_notification("$/progress", do_nothing) |
| 146 | + self.server.on_notification("textDocument/publishDiagnostics", do_nothing) |
| 147 | + self.server.on_notification("language/actionableNotification", do_nothing) |
| 148 | + self.server.on_notification("experimental/serverStatus", check_experimental_status) |
| 149 | + |
| 150 | + async with super().start_server(): |
| 151 | + self.logger.log("Starting clojure-lsp server process", logging.INFO) |
| 152 | + await self.server.start() |
| 153 | + initialize_params = self._get_initialize_params(self.repository_root_path) |
| 154 | + |
| 155 | + self.logger.log( |
| 156 | + "Sending initialize request from LSP client to LSP server and awaiting response", |
| 157 | + logging.INFO, |
| 158 | + ) |
| 159 | + init_response = await self.server.send.initialize(initialize_params) |
| 160 | + assert init_response["capabilities"]["textDocumentSync"]["change"] == 2 |
| 161 | + assert "completionProvider" in init_response["capabilities"] |
| 162 | + # Clojure-lsp completion provider capabilities are more flexible than other servers |
| 163 | + completion_provider = init_response["capabilities"]["completionProvider"] |
| 164 | + assert completion_provider["resolveProvider"] == True |
| 165 | + assert "triggerCharacters" in completion_provider |
| 166 | + self.server.notify.initialized({}) |
| 167 | + # after initialize, Clojure-lsp is ready to serve |
| 168 | + self.server_ready.set() |
| 169 | + self.completions_available.set() |
| 170 | + |
| 171 | + yield self |
| 172 | + |
| 173 | + await self.server.shutdown() |
| 174 | + await self.server.stop() |
0 commit comments