feat: copy latest server log file (#36)

Author: juleswritescode

.vscode/launch.json

@@ -72,20 +72,6 @@
  "outFiles": ["${workspaceFolder}/out/**/*.js"],
  "sourceMapRenames": true
  },
- {
- "name": "🧩 Debug Extension (Workspace With Settings)",
- "type": "extensionHost",
- "request": "launch",
- "args": [
- "--disable-extensions",
- "--extensionDevelopmentKind=node",
- "--extensionDevelopmentPath=${workspaceFolder}",
- "--log=supabase.postgrestools:debug",
- "${workspaceFolder}/test/fixtures/workspace-with-settings"
- ],
- "outFiles": ["${workspaceFolder}/out/**/*.js"],
- "sourceMapRenames": true
- },
  {
  "name": "🧩 Debug Extension (Yarn PnP Strategy)",
  "type": "extensionHost",

README.md

@@ -51,18 +51,20 @@ You should find your remote database settings at `https://supabase.com/dashboard
 
 ## Useful Commands
 
-The extension adds six commands to your VS Code Command Palette. They are all prefixed by `PostgresTools`.
+The extension adds seven commands to your VS Code Command Palette. They are all prefixed by `PostgresTools`.
 
 - `PostgresTools: Hard Reset (Delete All Temp and Global Binaries)` is your troubleshooting weapon. It will basically remove all binaries that were copied and downloaded _by the extension_ (not those you have installed or copied yourself). The extension will then again search for a server binary via the strategies mentioned in [the setup](#setting-up-the-lsp-server).
 - `PostgresTools: Download Server` lets you select and download the server binary. It'll be the matching version for your machine. If you set `postgrestools.allowDownloadPrereleases` to true in yor VS Code settings, you'll be able to select prereleases.
-- `PostgresTools: Get Current Version` will print the current version if the LSP server is running.
+- `PostgresTools: Get Current Version` will print the current version and the strategy with which the server binary was found.
 - `PostgresTools: Start` and `PostgresTools: Stop` will stop or start the LSP server and the client.
 - `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.
 
 ## Troubleshooting
 
 1. First, try restarting the extension via the `PostgresTools: Hard Reset (...)` command mentioned above.
 2. Open your VS Code Terminal, select the tab `Output`, and select one of the `postgrestools` extensions on the right. You might see what went wrong in the logs.
+3. If you want to open a GitHub issue, it can sometimes help us if you attach the LSP server log file. We provide the `PostgresTools: Copy Latest Server Logfile` command to make that as easy as possible.
 
 ## FAQ
 

package-lock.json

@@ -2,7 +2,7 @@
  "name": "postgrestools",
  "publisher": "Supabase",
  "description": "Postgres Language Server right in your IDE.",
- "version": "1.2.0",
+ "version": "1.2.1",
  "repository": {
  "type": "git",
  "url": "https://github.com/supabase-community/postgrestools-vscode"
@@ -54,6 +54,10 @@
  {
  "title": "PostgresTools: Get Current Version",
  "command": "postgrestools.currentVersion"
+ },
+ {
+ "title": "PostgresTools: Copy Latest Server Logfile",
+ "command": "postgrestools.copyLatestLogfile"
  }
  ],
  "configuration": {

package.json

@@ -1,14 +1,17 @@
-import { window } from "vscode";
+import { Uri, window, workspace } from "vscode";
 import { downloadPglt, getDownloadedBinary } from "./downloader";
 import { restart, start, stop } from "./lifecycle";
 import { logger } from "./logger";
 import { state } from "./state";
 import {
  clearGlobalBinaries,
  clearTemporaryBinaries,
+ dirExists,
  getVersion,
 } from "./utils";
 import { Releases } from "./releases";
+import { join } from "path";
+import os from "node:os";
 
 /**
  * These commands are exposed to the user via the Command Palette.
@@ -75,4 +78,131 @@ export class UserFacingCommands {
  );
  }
  }
+
+ static async copyLatestLogfile() {
+ logger.info("Starting to copy latest log file…");
+
+ let logdir;
+
+ if (process.env.PGT_LOG_PATH) {
+ logdir = Uri.file(process.env.PGT_LOG_PATH);
+ } else {
+ /*
+ * Looks 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
+ */
+ switch (process.platform) {
+ case "darwin": {
+ logdir = Uri.file(
+ join(
+ os.homedir(),
+ "Library",
+ "Caches",
+ "dev.supabase-community.pgt"
+ )
+ );
+ break;
+ }
+ case "linux": {
+ logdir = Uri.file(join(os.homedir(), ".cache", "pgt"));
+ break;
+ }
+ case "win32": {
+ logdir = Uri.file(
+ join(
+ os.homedir(),
+ "AppData",
+ "Local",
+ "supabase-community",
+ "pgt",
+ "cache"
+ )
+ );
+ break;
+ }
+ default: {
+ window.showErrorMessage(
+ `Unsupported Platform: ${process.platform}. PostgresTools only runs on linux, darwin and windows.`
+ );
+ return;
+ }
+ }
+ }
+
+ logger.info("Determined log directory location", {
+ logdir: logdir.fsPath,
+ });
+
+ if (!(await dirExists(logdir))) {
+ window.showErrorMessage(`Did not find expected log directory.`);
+ return;
+ }
+
+ const logFiles = await workspace.fs
+ .readDirectory(logdir)
+ .then((files) => files.filter(([name]) => name.startsWith("server.log")));
+
+ if (logFiles.length === 0) {
+ window.showErrorMessage(`No log files found in log directory.`);
+ return;
+ }
+
+ logger.info(`Found ${logFiles.length} log files.`);
+
+ if (!state.activeProject) {
+ window.showErrorMessage(
+ `No active project, can't determine a location to copy the log file.`
+ );
+ return;
+ }
+
+ logFiles.sort((a, b) => {
+ const [dateA, idxA] = getDatePartsFromLogFile(a[0]);
+ const [dateB, idxB] = getDatePartsFromLogFile(b[0]);
+
+ if (dateA.getTime() === dateB.getTime()) {
+ return idxB - idxA;
+ } else {
+ return dateB.getTime() - dateA.getTime();
+ }
+ });
+
+ const [latestFilename] = logFiles[0];
+
+ logger.info(`Identified latest log file.`, {
+ filename: latestFilename,
+ });
+
+ try {
+ const target = Uri.joinPath(state.activeProject.path, "server.log");
+
+ await workspace.fs.copy(Uri.joinPath(logdir, latestFilename), target);
+
+ window.showInformationMessage(`Copied log file to ${target.fsPath}.`);
+ } catch (err) {
+ logger.error(`Error copying log file: ${err}`);
+ window.showErrorMessage(
+ `Error copying log file. View Output for more information.`
+ );
+ }
+ }
+}
+
+/** Expected format is server.log.2025-01-01-17 */
+function getDatePartsFromLogFile(filename: string): [Date, number] {
+ try {
+ const last = filename.split(".").pop()!;
+ const [year, month, day, idx] = last.split("-");
+
+ if (!year || !month || !day || !idx || Number.isNaN(+idx)) {
+ throw new Error();
+ }
+
+ return [new Date(`${year}-${month}-${day}`), +idx];
+ } catch {
+ logger.warn(`Unexpected log file name: ${filename}`);
+ return [new Date(0), 999];
+ }
 }

src/commands.ts

@@ -47,6 +47,10 @@ const registerUserFacingCommands = () => {
  commands.registerCommand(
  "postgrestools.currentVersion",
  UserFacingCommands.currentVersion
+ ),
+ commands.registerCommand(
+ "postgrestools.copyLatestLogfile",
+ UserFacingCommands.copyLatestLogfile
  )
  );
 

src/extension.ts

@@ -218,6 +218,7 @@ export const createActiveSession = async () => {
  return;
  }
 
+ state.activeProject = activeProject;
  state.activeSession = await createSession(activeProject);
 
  try {

src/session.ts

@@ -1,4 +1,5 @@
 {
+ "postgrestools.configFile": "./configs/postgrestools.jsonc",
  "postgrestools.bin": "./bin/postgrestools"
  // "postgrestools.bin": "/bin/postgrestools"
 }