Adds a ConfigManager and introduces vitest

Signed-off-by: Tyler Smalley <tyler@tailscale.com>

Author: tylersmalley

.github/workflows/test.yml

@@ -26,6 +26,8 @@ jobs:
           key: yarn-cache
       - name: Install dependencies
         run: tool/yarn install --frozen-lockfile --prefer-offline
+      - name: Unit tests
+        run: tool/yarn test
       - name: Lint
         run: tool/yarn lint
       - name: Typescript

.vscode/launch.json

@@ -15,6 +15,17 @@
       },
       "outFiles": ["${workspaceFolder}/dist/**/*.js"],
       "preLaunchTask": "${defaultBuildTask}"
+    },
+    {
+      "type": "node",
+      "request": "launch",
+      "name": "Debug Current Test File",
+      "autoAttachChildProcesses": true,
+      "skipFiles": ["<node_internals>/**", "**/node_modules/**"],
+      "program": "${workspaceRoot}/node_modules/vitest/vitest.mjs",
+      "args": ["run", "${relativeFile}"],
+      "smartStep": true,
+      "console": "integratedTerminal"
     }
   ]
 }

package.json

@@ -278,6 +278,7 @@
     "package": "vsce package --allow-star-activation",
     "precommit": "lint-staged",
     "prepare": "husky install",
+    "test": "vitest",
     "vscode:prepublish": "(yarn run bundle-js & pid1=$!; yarn run bundle-go & pid2=$!; wait $pid1 || exit 1; wait $pid2 || exit 1)",
     "watch": "webpack serve"
   },
@@ -315,6 +316,7 @@
     "ts-loader": "^9.4.4",
     "typescript": "^5.1.6",
     "utf-8-validate": "^6.0.3",
+    "vitest": "^.33.0",
     "vscode-jsonrpc": "^8.1.0",
     "webpack": "^5.88.2",
     "webpack-cli": "^5.1.4",

src/config-manager.test.ts

@@ -0,0 +1,46 @@
+import * as vscode from 'vscode';
+import * as fs from 'fs';
+import * as path from 'path';
+import { test, expect, beforeEach } from 'vitest';
+import { ConfigManager } from './config-manager';
+
+const extensionContext = {
+  globalStoragePath: '/tmp/vscode-tailscale',
+} as vscode.ExtensionContext;
+
+const configPath = path.join(extensionContext.globalStoragePath, 'config.json');
+
+beforeEach(() => {
+  if (fs.existsSync(configPath)) {
+    fs.unlinkSync(configPath);
+  }
+});
+
+test('withContext will create directory if it does not exist', () => {
+  fs.rmSync(extensionContext.globalStoragePath, { recursive: true, force: true });
+  expect(fs.existsSync(extensionContext.globalStoragePath)).toBe(false);
+
+  ConfigManager.withContext(extensionContext);
+  expect(fs.existsSync(extensionContext.globalStoragePath)).toBe(true);
+});
+
+test('withContext returns an initialized ConfigManager', () => {
+  const cm = ConfigManager.withContext(extensionContext);
+  expect(cm.configPath).toBe(configPath);
+});
+
+test('set persists config to disk', () => {
+  const cm = new ConfigManager(configPath);
+  const hosts = {
+    'host-1': {
+      user: 'foo',
+      rootDir: '/',
+    },
+  };
+
+  cm.set('hosts', hosts);
+  expect(cm.get('hosts')).toEqual(hosts);
+
+  const f = fs.readFileSync(configPath, 'utf8');
+  expect(JSON.parse(f)).toEqual({ hosts });
+});

src/config-manager.ts

@@ -0,0 +1,49 @@
+import * as vscode from 'vscode';
+import * as fs from 'fs';
+import * as path from 'path';
+
+interface Host {
+  user: string;
+  rootDir: string;
+}
+
+interface Config {
+  defaultHost?: Host;
+  hosts?: Record<string, Host>;
+}
+
+export class ConfigManager {
+  private config: Config;
+
+  constructor(public readonly configPath: string) {
+    if (fs.existsSync(this.configPath)) {
+      const rawData = fs.readFileSync(this.configPath, 'utf8');
+      this.config = JSON.parse(rawData);
+    } else {
+      this.config = {};
+    }
+  }
+
+  static withContext(context: vscode.ExtensionContext) {
+    const globalStoragePath = context.globalStoragePath;
+
+    if (!fs.existsSync(globalStoragePath)) {
+      fs.mkdirSync(globalStoragePath);
+    }
+
+    return new ConfigManager(path.join(globalStoragePath, 'config.json'));
+  }
+
+  get<K extends keyof Config>(key: K): Config[K] {
+    return this.config[key];
+  }
+
+  set<K extends keyof Config>(key: K, value: Config[K]) {
+    this.config[key] = value;
+    this.saveConfig();
+  }
+
+  private saveConfig() {
+    fs.writeFileSync(this.configPath, JSON.stringify(this.config, null, 2), 'utf8');
+  }
+}

src/extension.ts

@@ -1,5 +1,5 @@
 import * as vscode from 'vscode';
-
+import * as fs from 'fs';
 import { ServePanelProvider } from './serve-panel-provider';
 import { ADMIN_CONSOLE } from './utils/url';
 import { Tailscale } from './tailscale';
@@ -13,6 +13,7 @@ import {
 } from './node-explorer-provider';
 
 import { TSFileSystemProvider } from './ts-file-system-provider';
+import { ConfigManager } from './config-manager';
 
 let tailscaleInstance: Tailscale;
 
@@ -21,6 +22,8 @@ export async function activate(context: vscode.ExtensionContext) {
 
   tailscaleInstance = await Tailscale.withInit(vscode);
 
+  const configManager = ConfigManager.withContext(context);
+
   // walkthrough completion
   tailscaleInstance.serveStatus().then((status) => {
     // assume if we have any BackendState we are installed

vitest.config.ts

@@ -0,0 +1,7 @@
+import { configDefaults, defineConfig } from 'vitest/config';
+
+export default defineConfig({
+  test: {
+    exclude: [...configDefaults.exclude, '**/out/**'],
+  },
+});