feat: add multi-root workspace support (#41)

Author: juleswritescode

.vscode/launch.json

@@ -85,6 +85,34 @@
       ],
       "outFiles": ["${workspaceFolder}/out/**/*.js"],
       "sourceMapRenames": true
+    },
+    {
+      "name": "🧩 Debug Extension (Multi-Root Workspace)",
+      "type": "extensionHost",
+      "request": "launch",
+      "args": [
+        "--disable-extensions",
+        "--extensionDevelopmentKind=node",
+        "--extensionDevelopmentPath=${workspaceFolder}",
+        "--log=supabase.postgrestools:debug",
+        "${workspaceFolder}/test/fixtures/multi-root/test.code-workspace"
+      ],
+      "outFiles": ["${workspaceFolder}/out/**/*.js"],
+      "sourceMapRenames": true
+    },
+    {
+      "name": "🧩 Debug Extension (Multi-Root Workspace With Overwrites)",
+      "type": "extensionHost",
+      "request": "launch",
+      "args": [
+        "--disable-extensions",
+        "--extensionDevelopmentKind=node",
+        "--extensionDevelopmentPath=${workspaceFolder}",
+        "--log=supabase.postgrestools:debug",
+        "${workspaceFolder}/test/fixtures/multi-root-with-overwrites/test.code-workspace"
+      ],
+      "outFiles": ["${workspaceFolder}/out/**/*.js"],
+      "sourceMapRenames": true
     }
   ]
 }

README.md

@@ -60,6 +60,15 @@ The extension adds seven commands to your VS Code Command Palette. They are all
 - `PostgresTools: Restart` runs stop and start in succession.
 - `PostgresTools: Copy Latest Server Logfile` copies the latest server log file to your currently opened repo. The log file is meant to be attached to GitHub issues, it can sometimes help us to debug.
 
+## Multi-Root Workspaces
+
+You can use the extension in a multi-root workspace setting, but there are a few caveats:
+
+- You should use at least version 0.8.0 of the binary. You can upgrade it in your `package.json` or run `PostgresTools: Hard Reset (..)`.
+- You can specify a `postgrestools.bin` and a `postgrestools.configFile` in your `.code-workspace` file, but you need to use an absolute path. The binary and the setting will then be used for all your workspace folders.
+- If you don't specify a config file, the binary will look for a `postgrestools.jsonc` file at the every workspace folder's root level. If the file isn't there, the extension will be disabled for the folder. The individual `configFile` settings of the folders are ignored.
+- The binary will currently only change database connections when a new file is opened, not when you alternate focus between two files. So, you might get linting/completions from a different database than you'd expect. For now, you can simply reopen the file, but we'll fix this soon 🙌
+
 ## Troubleshooting
 
 1. First, try restarting the extension via the `PostgresTools: Hard Reset (...)` command mentioned above.

package-lock.json

@@ -11,7 +11,8 @@
     "url": "https://github.com/supabase-community/postgres-language-server"
   },
   "engines": {
-    "vscode": "^1.96.2"
+    "vscode": "^1.96.2",
+    "node": "^18"
   },
   "icon": "icon.png",
   "categories": [
@@ -123,6 +124,7 @@
   },
   "devDependencies": {
     "@types/node": "20.17.23",
+    "@types/semver": "7.7.0",
     "@types/vscode": "^1.96.2",
     "@typescript-eslint/eslint-plugin": "^8.22.0",
     "@typescript-eslint/parser": "^8.22.0",
@@ -131,6 +133,7 @@
     "typescript": "^5.7.3"
   },
   "dependencies": {
+    "semver": "7.7.2",
     "vscode-languageclient": "9.0.1",
     "vscode-uri": "3.1.0"
   }

package.json

@@ -1,15 +1,15 @@
 import { Uri, window } from "vscode";
 import { logger } from "./logger";
 import { delimiter, dirname, join } from "node:path";
-import { CONSTANTS } from "./constants";
+import { CONSTANTS, OperatingMode } from "./constants";
 import { fileExists } from "./utils";
 import { createRequire } from "node:module";
 import { getConfig } from "./config";
 import { downloadPglt, getDownloadedBinary } from "./downloader";
 
 export interface BinaryFindStrategy {
   name: string;
-  find(path: Uri): Promise<Uri | null>;
+  find(path?: Uri): Promise<Uri | null>;
 }
 
 /**
@@ -34,7 +34,7 @@ export interface BinaryFindStrategy {
  */
 export const vsCodeSettingsStrategy: BinaryFindStrategy = {
   name: "VSCode Settings Strategy",
-  async find(path: Uri) {
+  async find(path?: Uri) {
     logger.debug("Trying to find PostgresTools binary via VSCode Settings");
 
     type BinSetting = string | Record<string, string> | undefined;
@@ -69,9 +69,30 @@ export const vsCodeSettingsStrategy: BinaryFindStrategy = {
     if (typeof binSetting === "string") {
       logger.debug("Binary Setting is a string", { binSetting });
 
-      const resolvedPath = binSetting.startsWith(".")
-        ? Uri.joinPath(path, binSetting).fsPath
-        : binSetting;
+      let resolvedPath: string;
+
+      if (binSetting.startsWith(".")) {
+        if (CONSTANTS.operatingMode === OperatingMode.MultiRoot) {
+          window.showErrorMessage(
+            "Relative paths for the postgrestools binary in a multi-root workspace setting are not supported. Please use an absolute path in your `*.code-workspace` file."
+          );
+          return null;
+        } else if (path) {
+          resolvedPath = Uri.joinPath(path, binSetting).fsPath;
+        } else {
+          // can't really happen.
+          logger.error(
+            `User picked a relative path for setting and is not in multi-root workspace mode. Somehow, we couldn't form a path to the binary.`
+          );
+          return null;
+        }
+      } else {
+        resolvedPath = binSetting;
+      }
+
+      if (!resolvedPath) {
+        return null;
+      }
 
       logger.debug("Looking for binary at path", { resolvedPath });
 
@@ -98,7 +119,7 @@ export const vsCodeSettingsStrategy: BinaryFindStrategy = {
  */
 export const nodeModulesStrategy: BinaryFindStrategy = {
   name: "Node Modules Strategy",
-  async find(path: Uri) {
+  async find(path?: Uri) {
     logger.debug("Trying to find PostgresTools binary in Node Modules");
 
     if (!path) {
@@ -178,7 +199,7 @@ export const nodeModulesStrategy: BinaryFindStrategy = {
 
 export const yarnPnpStrategy: BinaryFindStrategy = {
   name: "Yarn PnP Strategy",
-  async find(path: Uri) {
+  async find(path?: Uri) {
     logger.debug("Trying to find PostgresTools binary in Yarn Plug'n'Play");
 
     if (!path) {

src/binary-finder-strategies.ts

@@ -58,9 +58,47 @@ const LOCAL_STRATEGIES: Strategy[] = [
       }),
   },
 ];
+const GLOBAL_STRATEGIES: Strategy[] = [
+  {
+    label: "VSCode Settings",
+    strategy: vsCodeSettingsStrategy,
+    onSuccess: (uri) =>
+      logger.debug(`Found Binary in VSCode Settings (postgrestools.bin)`, {
+        path: uri.fsPath,
+      }),
+  },
+  {
+    label: "PATH Environment Variable",
+    strategy: pathEnvironmentVariableStrategy,
+    onSuccess: (uri) =>
+      logger.debug(`Found Binary in PATH Environment Variable`, {
+        path: uri.fsPath,
+      }),
+  },
+  {
+    label: "Downloaded Binary",
+    strategy: downloadPgltStrategy,
+    onSuccess: (uri) =>
+      logger.debug(`Found downloaded binary`, {
+        path: uri.fsPath,
+      }),
+  },
+];
 
 export class BinaryFinder {
-  static async find(path: Uri) {
+  static async findGlobally() {
+    logger.info("Using Global Strategies to find binary");
+    const binary = await this.attemptFind(GLOBAL_STRATEGIES);
+
+    if (!binary) {
+      logger.debug("Unable to find binary globally.");
+    }
+
+    return binary;
+  }
+
+  static async findLocally(path: Uri) {
+    logger.info("Using Local Strategies to find binary");
     const binary = await this.attemptFind(LOCAL_STRATEGIES, path);
 
     if (!binary) {
@@ -70,7 +108,7 @@ export class BinaryFinder {
     return binary;
   }
 
-  private static async attemptFind(strategies: Strategy[], path: Uri) {
+  private static async attemptFind(strategies: Strategy[], path?: Uri) {
     for (const { strategy, onSuccess, condition, label } of strategies) {
       if (condition && !(await condition(path))) {
         continue;

src/binary-finder.ts

@@ -88,7 +88,7 @@ export class UserFacingCommands {
       logdir = Uri.file(process.env.PGT_LOG_PATH);
     } else {
       /*
-       * Looks are placed at different locations based on the platform.
+       * Logs are placed at different locations based on the platform.
        * Linux: /home/alice/.cache/pgt
        * Win: C:\Users\Alice\AppData\Local\supabase-community\pgt\cache
        * Mac: /Users/Alice/Library/Caches/dev.supabase-community.pgt

src/commands.ts

@@ -34,9 +34,6 @@ export const getConfig = <T>(
   return workspace.getConfiguration("postgrestools", options.scope).get<T>(key);
 };
 
-/**
- * TODO: Can the "state.activeProject" also refer to a workspace, or just to a workspace-folder?
- */
 export const isEnabledForFolder = (folder: WorkspaceFolder): boolean => {
   return !!getConfig<boolean>("enabled", { scope: folder.uri });
 };

src/config.ts

@@ -89,8 +89,42 @@ const listenForConfigurationChanges = () => {
  */
 const listenForActiveTextEditorChange = () => {
   state.context.subscriptions.push(
-    window.onDidChangeActiveTextEditor((editor) => {
+    window.onDidChangeActiveTextEditor(async () => {
+      const editor = window.activeTextEditor;
+      logger.debug(`User changed active text editor.`);
+
       updateHidden(editor);
+
+      const documentUri = editor?.document.uri;
+      if (!documentUri) {
+        logger.debug(
+          `User changed active text editor, but document uri could not be found.`
+        );
+        return;
+      }
+
+      const folder = workspace.getWorkspaceFolder(documentUri);
+      if (!folder) {
+        logger.debug(
+          `User changed active text editor, but matching workspace folder could not be found.`,
+          { uri: documentUri }
+        );
+        return;
+      }
+
+      const matchingProject = state.allProjects?.get(folder.uri);
+      if (!matchingProject) {
+        logger.debug(
+          `User changed active text editor, but matching project could not be found.`,
+          { uri: folder.uri, projects: state.allProjects }
+        );
+        return;
+      }
+
+      logger.debug(`Found matching active project.`, {
+        project: matchingProject.path,
+      });
+      state.activeProject = matchingProject;
     })
   );
 

src/extension.ts

@@ -5,6 +5,7 @@ import { logger } from "./logger";
 import { state } from "./state";
 import { createExtension, destroyExtension } from "./extension";
 import { getConfig, getFullConfig } from "./config";
+import { CONSTANTS } from "./constants";
 
 // This method is called when your extension is activated
 // Your extension is activated the very first time the command is executed
@@ -18,6 +19,7 @@ export async function activate(context: vscode.ExtensionContext) {
   const config = getFullConfig();
 
   logger.info(`Starting with config…`, { config });
+  logger.info(`In mode…`, { mode: CONSTANTS.operatingMode });
 
   await createExtension();
 }