feat(vscode): Add debug options to override the server path

Author: armsnyder

vscode-extension/package.json

@@ -84,6 +84,16 @@
             "verbose"
           ],
           "description": "Enables tracing of the underlying LSP requests and responses. This results in highly verbose logs (especially the document sync messages) and is not recommended for use outside development and troubleshooting contexts."
+        },
+        "gdshader.danger.serverPathOverride": {
+          "type": "string",
+          "default": "",
+          "description": "Intended for debugging only. The path to the GDShader language server executable."
+        },
+        "gdshader.danger.disableSafetyCheck": {
+          "type": "boolean",
+          "default": false,
+          "description": "Intended for debugging only. Disables the validation of the GDShader language server executable."
         }
       }
     },

vscode-extension/src/config.js

@@ -0,0 +1,43 @@
+/**
+ * MIT License
+ *
+ * Copyright (c) 2025 Adam Snyder
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+const vscode = require("vscode");
+
+/**
+ * @typedef Configuration
+ * @property {string} serverPathOverride
+ * @property {boolean} disableSafetyCheck
+ */
+
+/** @returns {Configuration} */
+function getConfiguration() {
+  const config = vscode.workspace.getConfiguration("gdshader.danger");
+  return {
+    serverPathOverride: config.get("serverPathOverride") ?? "",
+    disableSafetyCheck: config.get("disableSafetyCheck") ?? false,
+  };
+}
+
+module.exports = {
+  getConfiguration,
+};

vscode-extension/src/server/load.js

@@ -44,11 +44,11 @@ const { downloadAndExtractServerArchive } = require("./download");
 
 /** @param {import('vscode').ExtensionContext} context @returns {Promise<boolean>} */
 async function hasRequiredFiles(context) {
-  if (!(await fileExists(getBinPath(context)))) {
+  if (!(await fileExists(await getBinPath(context)))) {
     return false;
   }
   if (shouldValidateBinarySignature()) {
-    return await fileExists(getSignaturePath(context));
+    return await fileExists(await getSignaturePath(context));
   }
   return true;
 }

vscode-extension/src/server/storage.js

@@ -22,14 +22,11 @@
  * SOFTWARE.
  */
 const { logger } = require("../log");
+const { getConfiguration } = require("../config");
 const { join } = require("node:path");
 const { platform } = require("node:os");
 const { rm, stat } = require("node:fs/promises");
 
-function getBinName() {
-  return `gdshader-language-server${platform() === "win32" ? ".exe" : ""}`;
-}
-
 /** @param {import('vscode').ExtensionContext} context @returns {string} */
 function getBinCacheDir(context) {
   return join(context.globalStorageUri.fsPath, "bin");
@@ -40,14 +37,29 @@ function getBinDir(context) {
   return join(getBinCacheDir(context), context.extension.packageJSON.version);
 }
 
-/** @param {import('vscode').ExtensionContext} context @returns {string} */
-function getBinPath(context) {
-  return join(getBinDir(context), getBinName());
+/** @param {import('vscode').ExtensionContext} context @returns {Promise<string>} */
+async function getBinPath(context) {
+  const { serverPathOverride } = getConfiguration();
+
+  if (serverPathOverride) {
+    if (!(await fileExists(serverPathOverride))) {
+      throw new Error(
+        `Server path override does not exist: ${serverPathOverride}`,
+      );
+    }
+    logger().warn(`Using server path override: ${serverPathOverride}`);
+    return serverPathOverride;
+  }
+
+  return join(
+    getBinDir(context),
+    `gdshader-language-server${platform() === "win32" ? ".exe" : ""}`,
+  );
 }
 
-/** @param {import('vscode').ExtensionContext} context @returns {string} */
-function getSignaturePath(context) {
-  return getBinPath(context) + ".sig";
+/** @param {import('vscode').ExtensionContext} context @returns {Promise<string>} */
+async function getSignaturePath(context) {
+  return (await getBinPath(context)) + ".sig";
 }
 
 /** @param {import('vscode').ExtensionContext} context @returns {Promise<void>} */
@@ -72,7 +84,6 @@ async function fileExists(path) {
 }
 
 module.exports = {
-  getBinName,
   getBinCacheDir,
   getBinDir,
   getBinPath,

vscode-extension/src/server/validate.js

@@ -27,11 +27,20 @@ const { platform } = require("node:os");
 const { join } = require("node:path");
 const { createVerify } = require("node:crypto");
 const { getBinPath, getSignaturePath } = require("./storage");
+const { getConfiguration } = require("../config");
+const { logger } = require("../log");
 
 function shouldValidateBinarySignature() {
   // MacOS has validation built-in with Gatekeeper, and the MacOS archives do
   // not include signature files.
-  return platform() !== "darwin";
+  if (platform() === "darwin") {
+    return false;
+  }
+  if (getConfiguration().disableSafetyCheck) {
+    logger().warn("Safety check is disabled. This is not recommended.");
+    return false;
+  }
+  return true;
 }
 
 /** @param {import('vscode').ExtensionContext} context @returns {Promise<void>} */
@@ -40,14 +49,15 @@ async function validateBinarySignature(context) {
   const pubKey = await readFile(publicKeyPath, "utf8");
 
   const signature = Buffer.from(
-    (await readFile(getSignaturePath(context), "utf8")).trim(),
+    (await readFile(await getSignaturePath(context), "utf8")).trim(),
     "base64",
   );
 
   const verify = createVerify("sha256");
+  const binPath = await getBinPath(context);
 
   await new Promise((/** @type {(_?: void) => void} */ resolve, reject) => {
-    const stream = createReadStream(getBinPath(context));
+    const stream = createReadStream(binPath);
     stream.on("data", (chunk) => verify.update(chunk));
     stream.on("error", reject);
     stream.on("end", () => {