From c83f8431d90c57660b59698d8faa1e9a167cb4c6 Mon Sep 17 00:00:00 2001 From: Jimmy Cai Date: Mon, 16 Nov 2026 14:43:14 +0100 Subject: [PATCH] feat: add --ensure-wrapper to download the wrapper JAR ahead of time `main.mjs --ensure-wrapper` downloads the RumbleDB wrapper JAR unless it is cached, prints the java command that starts it, and exits; with code 1 when the JAR cannot be resolved. Images and clients that ship the bundled server, such as the JupyterLab extension, can then download the JAR before the server first needs it. It replaces the ensure-wrapper.mjs testing script, an unbundled entry point whose chunk names change between releases. --- .changeset/ensure-wrapper-flag.md | 5 +++ packages/language-server/README.md | 6 ++++ packages/language-server/package.json | 1 - .../rumble/executable/ensure-wrapper.ts | 11 ------ .../integrations/rumble/executable/index.ts | 14 ++++++++ packages/language-server/src/main.ts | 7 +++- .../tests/wrapper/ensure-wrapper.test.ts | 35 +++++++++++++++++++ packages/language-server/tsdown.config.ts | 1 - 8 files changed, 66 insertions(+), 14 deletions(-) create mode 100644 .changeset/ensure-wrapper-flag.md delete mode 100644 packages/language-server/src/integrations/rumble/executable/ensure-wrapper.ts create mode 100644 packages/language-server/tests/wrapper/ensure-wrapper.test.ts diff --git a/.changeset/ensure-wrapper-flag.md b/.changeset/ensure-wrapper-flag.md new file mode 100644 index 00000000..e321a43b --- /dev/null +++ b/.changeset/ensure-wrapper-flag.md @@ -0,0 +1,5 @@ +--- +"jsoniq-language-server": minor +--- + +Add `--ensure-wrapper` to the server, which downloads the RumbleDB wrapper JAR unless it is cached, prints the command that starts it, and exits. Run it to download the JAR ahead of time, for example when building an image: `node dist/bundled/main.mjs --ensure-wrapper`. It replaces the `dist/integrations/rumble/executable/ensure-wrapper.mjs` script. diff --git a/packages/language-server/README.md b/packages/language-server/README.md index 2d70ed5a..05eb7087 100644 --- a/packages/language-server/README.md +++ b/packages/language-server/README.md @@ -26,6 +26,12 @@ Type-checking diagnostics, inferred types and running queries come from RumbleDB The wrapper JAR is too large to ship in the npm package. The server downloads it from GitHub Releases when it is first needed, checks its SHA-256 against the bundled manifest, and caches it. Set `JSONIQ_LSP_CACHE_DIR` to control where it is stored. To use another wrapper JAR, such as one you built yourself, set `JSONIQ_LSP_WRAPPER_JAR` to its path. +To download the JAR ahead of time, for example when building an image, run the server with `--ensure-wrapper`. It downloads the JAR unless it is cached, prints the command that starts it, and exits: + +```sh +node node_modules/jsoniq-language-server/dist/bundled/main.mjs --ensure-wrapper +``` + If you don't want any of this, set `wrapper.enabled` to `false` (see below) and the server runs on the parser alone. ## Configuration diff --git a/packages/language-server/package.json b/packages/language-server/package.json index 65d2299a..a9427047 100644 --- a/packages/language-server/package.json +++ b/packages/language-server/package.json @@ -42,7 +42,6 @@ "start": "node ./dist/main.mjs", "test": "vitest run tests", "clean": "rm -rf dist", - "ensure-wrapper": "node ./dist/integrations/rumble/executable/ensure-wrapper.mjs", "lint": "oxlint", "lint:fix": "oxlint --fix", "fmt": "oxfmt", diff --git a/packages/language-server/src/integrations/rumble/executable/ensure-wrapper.ts b/packages/language-server/src/integrations/rumble/executable/ensure-wrapper.ts deleted file mode 100644 index d0ac9d79..00000000 --- a/packages/language-server/src/integrations/rumble/executable/ensure-wrapper.ts +++ /dev/null @@ -1,11 +0,0 @@ -import { resolveWrapperLaunchConfig } from "./index.js"; - -/// For testing purposes, allow running this file directly to see the resolved launch config -resolveWrapperLaunchConfig() - .then((config) => { - console.log("Resolved wrapper launch config:", config); - }) - .catch((error) => { - console.error("Error resolving wrapper launch config:", error); - process.exit(1); - }); diff --git a/packages/language-server/src/integrations/rumble/executable/index.ts b/packages/language-server/src/integrations/rumble/executable/index.ts index bf405e60..900ed45a 100644 --- a/packages/language-server/src/integrations/rumble/executable/index.ts +++ b/packages/language-server/src/integrations/rumble/executable/index.ts @@ -33,6 +33,20 @@ export async function resolveWrapperLaunchConfig( }; } +/** + * `main.mjs --ensure-wrapper`: downloads the wrapper JAR unless it is cached, and prints the command that starts it. + * Exits with code 1 when the JAR cannot be resolved. + */ +export async function ensureWrapper(): Promise { + try { + const { args } = await resolveWrapperLaunchConfig(); + console.log(["java", ...args].join(" ")); + } catch (error) { + console.error(error instanceof Error ? error.message : String(error)); + process.exitCode = 1; + } +} + async function resolveLaunchConfig( options: WrapperResolutionOptions, ): Promise { diff --git a/packages/language-server/src/main.ts b/packages/language-server/src/main.ts index 9bd9ad29..b8bd4756 100644 --- a/packages/language-server/src/main.ts +++ b/packages/language-server/src/main.ts @@ -1,5 +1,10 @@ import { startServer } from "./app/server.js"; +import { ensureWrapper } from "./integrations/rumble/executable/index.js"; export type { ClientConfiguration } from "./app/server.js"; export type { LakehouseFormats } from "./app/configuration.js"; -startServer(); +if (process.argv.includes("--ensure-wrapper")) { + await ensureWrapper(); +} else { + startServer(); +} diff --git a/packages/language-server/tests/wrapper/ensure-wrapper.test.ts b/packages/language-server/tests/wrapper/ensure-wrapper.test.ts new file mode 100644 index 00000000..203ac68d --- /dev/null +++ b/packages/language-server/tests/wrapper/ensure-wrapper.test.ts @@ -0,0 +1,35 @@ +import { fileURLToPath } from "node:url"; + +import { ensureWrapper } from "server/integrations/rumble/executable/index.js"; +import { afterEach, describe, expect, it, vi } from "vitest"; + +describe("ensure wrapper", () => { + afterEach(() => { + vi.unstubAllEnvs(); + vi.restoreAllMocks(); + process.exitCode = undefined; + }); + + it("prints the command that starts the wrapper", async () => { + const jarPath = fileURLToPath(import.meta.url); + vi.stubEnv("JSONIQ_LSP_WRAPPER_JAR", jarPath); + const log = vi.spyOn(console, "log").mockImplementation(() => {}); + + await ensureWrapper(); + + const command: string = log.mock.calls[0]?.[0]; + expect(command).toMatch(/^java /); + expect(command).toContain(`-jar ${jarPath} --daemon`); + expect(process.exitCode).toBeUndefined(); + }); + + it("exits with code 1 when the wrapper cannot be resolved", async () => { + vi.stubEnv("JSONIQ_LSP_WRAPPER_JAR", "/missing/wrapper.jar"); + const error = vi.spyOn(console, "error").mockImplementation(() => {}); + + await ensureWrapper(); + + expect(error).toHaveBeenCalledWith(expect.stringContaining("/missing/wrapper.jar")); + expect(process.exitCode).toBe(1); + }); +}); diff --git a/packages/language-server/tsdown.config.ts b/packages/language-server/tsdown.config.ts index c8015bc2..8fe39c94 100644 --- a/packages/language-server/tsdown.config.ts +++ b/packages/language-server/tsdown.config.ts @@ -8,7 +8,6 @@ export default defineConfig([ "src/main.ts", "src/lsp/protocol/notifications/index.ts", "src/lsp/protocol/requests/index.ts", - "src/integrations/rumble/executable/ensure-wrapper.ts", ], root: "src", outDir: "dist",