Update data and config paths to match platform defaults (#1047)

Going forward for new installations, config and data files will be stored at the platform default paths, as defined by [env-paths](https://www.npmjs.com/package/env-paths). For backwards compatibility, if the `~/.waveterm` or `WAVETERM_HOME` directory exists and contains valid data, it will be used. If this check fails, then `WAVETERM_DATA_HOME` and `WAVETERM_CONFIG_HOME` will be used. If these are not defined, then `XDG_DATA_HOME` and `XDG_CONFIG_HOME` will be used. Finally, if none of these are defined, the [env-paths](https://www.npmjs.com/package/env-paths) defaults will be used. As with the existing app, dev instances will write to `waveterm-dev` directories, while all others will write to `waveterm`.
wavetermdev · Oct 22, 2024 · 33f05c6 · 33f05c6
1 parent 39fff9e
commit 33f05c6
Show file tree

Hide file tree

Showing 26 changed files with 241 additions and 105 deletions.
diff --git a/Taskfile.yml b/Taskfile.yml
@@ -184,8 +184,8 @@ tasks:
     generate:
         desc: Generate Typescript bindings for the Go backend.
         cmds:
-            - go run cmd/generatets/main-generatets.go
-            - go run cmd/generatego/main-generatego.go
+            - NO_PANIC=1 go run cmd/generatets/main-generatets.go
+            - NO_PANIC=1 go run cmd/generatego/main-generatego.go
         sources:
             - "cmd/generatego/*.go"
             - "cmd/generatets/*.go"

diff --git a/cmd/server/main-server.go b/cmd/server/main-server.go
@@ -182,7 +182,7 @@ func main() {
 		log.Printf("error validating service map: %v\n", err)
 		return
 	}
-	err = wavebase.EnsureWaveHomeDir()
+	err = wavebase.EnsureWaveDataDir()
 	if err != nil {
 		log.Printf("error ensuring wave home dir: %v\n", err)
 		return
@@ -192,14 +192,14 @@ func main() {
 		log.Printf("error ensuring wave db dir: %v\n", err)
 		return
 	}
-	err = wconfig.EnsureWaveConfigDir()
+	err = wavebase.EnsureWaveConfigDir()
 	if err != nil {
 		log.Printf("error ensuring wave config dir: %v\n", err)
 		return
 	}
 
 	// TODO: rather than ensure this dir exists, we should let the editor recursively create parent dirs on save
-	err = wconfig.EnsureWavePresetsDir()
+	err = wavebase.EnsureWavePresetsDir()
 	if err != nil {
 		log.Printf("error ensuring wave presets dir: %v\n", err)
 		return
@@ -216,7 +216,8 @@ func main() {
 		}
 	}()
 	log.Printf("wave version: %s (%s)\n", WaveVersion, BuildTime)
-	log.Printf("wave home dir: %s\n", wavebase.GetWaveHomeDir())
+	log.Printf("wave data dir: %s\n", wavebase.GetWaveDataDir())
+	log.Printf("wave config dir: %s\n", wavebase.GetWaveConfigDir())
 	err = filestore.InitFilestore()
 	if err != nil {
 		log.Printf("error initializing filestore: %v\n", err)

diff --git a/emain/docsite.ts b/emain/docsite.ts
@@ -1,6 +1,6 @@
-import { getWebServerEndpoint } from "@/util/endpoints";
-import { fetch } from "@/util/fetchutil";
 import { ipcMain } from "electron";
+import { getWebServerEndpoint } from "../frontend/util/endpoints";
+import { fetch } from "../frontend/util/fetchutil";
 
 const docsiteWebUrl = "https://docs.waveterm.dev/";
 let docsiteUrl: string;

diff --git a/emain/emain-viewmgr.ts b/emain/emain-viewmgr.ts
@@ -1,21 +1,21 @@
 // Copyright 2024, Command Line Inc.
 // SPDX-License-Identifier: Apache-2.0
 
-import { ClientService, FileService, ObjectService, WindowService } from "@/app/store/services";
 import * as electron from "electron";
+import * as path from "path";
+import { debounce } from "throttle-debounce";
+import { ClientService, FileService, ObjectService, WindowService } from "../frontend/app/store/services";
+import * as keyutil from "../frontend/util/keyutil";
+import { configureAuthKeyRequestInjection } from "./authkey";
+import { getGlobalIsQuitting, getGlobalIsStarting, setWasActive, setWasInFg } from "./emain-activity";
 import {
     delay,
     ensureBoundsAreVisible,
     handleCtrlShiftFocus,
     handleCtrlShiftState,
     shFrameNavHandler,
     shNavHandler,
-} from "emain/emain-util";
-import * as keyutil from "frontend/util/keyutil";
-import * as path from "path";
-import { debounce } from "throttle-debounce";
-import { configureAuthKeyRequestInjection } from "./authkey";
-import { getGlobalIsQuitting, getGlobalIsStarting, setWasActive, setWasInFg } from "./emain-activity";
+} from "./emain-util";
 import { getElectronAppBasePath, isDevVite } from "./platform";
 import { updater } from "./updater";
 

diff --git a/emain/emain-wavesrv.ts b/emain/emain-wavesrv.ts
@@ -1,15 +1,23 @@
 // Copyright 2024, Command Line Inc.
 // SPDX-License-Identifier: Apache-2.0
 
-import { WebServerEndpointVarName, WSServerEndpointVarName } from "@/util/endpoints";
 import * as electron from "electron";
-import { AuthKey, AuthKeyEnv } from "emain/authkey";
-import { setForceQuit } from "emain/emain-activity";
-import { WaveAppPathVarName } from "emain/emain-util";
-import { getElectronAppUnpackedBasePath, getWaveSrvCwd, getWaveSrvPath } from "emain/platform";
-import { updater } from "emain/updater";
 import * as child_process from "node:child_process";
 import * as readline from "readline";
+import { WebServerEndpointVarName, WSServerEndpointVarName } from "../frontend/util/endpoints";
+import { AuthKey, AuthKeyEnv } from "./authkey";
+import { setForceQuit } from "./emain-activity";
+import { WaveAppPathVarName } from "./emain-util";
+import {
+    getElectronAppUnpackedBasePath,
+    getWaveConfigDir,
+    getWaveDataDir,
+    getWaveSrvCwd,
+    getWaveSrvPath,
+    WaveConfigHomeVarName,
+    WaveDataHomeVarName,
+} from "./platform";
+import { updater } from "./updater";
 
 export const WaveSrvReadySignalPidVarName = "WAVETERM_READY_SIGNAL_PID";
 
@@ -50,6 +58,8 @@ export function runWaveSrv(handleWSEvent: (evtMsg: WSEventType) => void): Promis
     envCopy[WaveAppPathVarName] = getElectronAppUnpackedBasePath();
     envCopy[WaveSrvReadySignalPidVarName] = process.pid.toString();
     envCopy[AuthKeyEnv] = AuthKey;
+    envCopy[WaveDataHomeVarName] = getWaveDataDir();
+    envCopy[WaveConfigHomeVarName] = getWaveConfigDir();
     const waveSrvCmd = getWaveSrvPath();
     console.log("trying to run local server", waveSrvCmd);
     const proc = child_process.spawn(getWaveSrvPath(), {

diff --git a/emain/emain-wsh.ts b/emain/emain-wsh.ts
@@ -2,8 +2,8 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import { Notification } from "electron";
-import { getWaveWindowById } from "emain/emain-viewmgr";
 import { RpcResponseHelper, WshClient } from "../frontend/app/store/wshclient";
+import { getWaveWindowById } from "./emain-viewmgr";
 import { getWebContentsByBlockId, webGetSelector } from "./emain-web";
 
 export class ElectronWshClientType extends WshClient {

diff --git a/emain/emain.ts b/emain/emain.ts
@@ -2,6 +2,23 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import * as electron from "electron";
+import { FastAverageColor } from "fast-average-color";
+import fs from "fs";
+import * as child_process from "node:child_process";
+import * as path from "path";
+import { PNG } from "pngjs";
+import { sprintf } from "sprintf-js";
+import { Readable } from "stream";
+import * as util from "util";
+import winston from "winston";
+import * as services from "../frontend/app/store/services";
+import { initElectronWshrpc, shutdownWshrpc } from "../frontend/app/store/wshrpcutil";
+import { getWebServerEndpoint } from "../frontend/util/endpoints";
+import { fetch } from "../frontend/util/fetchutil";
+import * as keyutil from "../frontend/util/keyutil";
+import { fireAndForget } from "../frontend/util/util";
+import { AuthKey, configureAuthKeyRequestInjection } from "./authkey";
+import { initDocsite } from "./docsite";
 import {
     getActivityState,
     getForceQuit,
@@ -12,8 +29,8 @@ import {
     setGlobalIsStarting,
     setWasActive,
     setWasInFg,
-} from "emain/emain-activity";
-import { handleCtrlShiftState } from "emain/emain-util";
+} from "./emain-activity";
+import { handleCtrlShiftState } from "./emain-util";
 import {
     createBrowserWindow,
     ensureHotSpareTab,
@@ -25,32 +42,16 @@ import {
     getWaveWindowByWebContentsId,
     setActiveTab,
     setMaxTabCacheSize,
-} from "emain/emain-viewmgr";
-import { getIsWaveSrvDead, getWaveSrvProc, getWaveSrvReady, getWaveVersion, runWaveSrv } from "emain/emain-wavesrv";
-import { FastAverageColor } from "fast-average-color";
-import fs from "fs";
-import * as child_process from "node:child_process";
-import * as path from "path";
-import { PNG } from "pngjs";
-import { sprintf } from "sprintf-js";
-import { Readable } from "stream";
-import * as util from "util";
-import winston from "winston";
-import * as services from "../frontend/app/store/services";
-import { initElectronWshrpc, shutdownWshrpc } from "../frontend/app/store/wshrpcutil";
-import { getWebServerEndpoint } from "../frontend/util/endpoints";
-import { fetch } from "../frontend/util/fetchutil";
-import * as keyutil from "../frontend/util/keyutil";
-import { fireAndForget } from "../frontend/util/util";
-import { AuthKey, configureAuthKeyRequestInjection } from "./authkey";
-import { initDocsite } from "./docsite";
+} from "./emain-viewmgr";
+import { getIsWaveSrvDead, getWaveSrvProc, getWaveSrvReady, getWaveVersion, runWaveSrv } from "./emain-wavesrv";
 import { ElectronWshClient, initElectronWshClient } from "./emain-wsh";
 import { getLaunchSettings } from "./launchsettings";
 import { getAppMenu } from "./menu";
 import {
     getElectronAppBasePath,
     getElectronAppUnpackedBasePath,
-    getWaveHomeDir,
+    getWaveConfigDir,
+    getWaveDataDir,
     isDev,
     unameArch,
     unamePlatform,
@@ -59,15 +60,17 @@ import { configureAutoUpdater, updater } from "./updater";
 
 const electronApp = electron.app;
 
+const waveDataDir = getWaveDataDir();
+const waveConfigDir = getWaveConfigDir();
+
 electron.nativeTheme.themeSource = "dark";
 
 let webviewFocusId: number = null; // set to the getWebContentsId of the webview that has focus (null if not focused)
 let webviewKeys: string[] = []; // the keys to trap when webview has focus
-const waveHome = getWaveHomeDir();
 const oldConsoleLog = console.log;
 
 const loggerTransports: winston.transport[] = [
-    new winston.transports.File({ filename: path.join(getWaveHomeDir(), "waveapp.log"), level: "info" }),
+    new winston.transports.File({ filename: path.join(waveDataDir, "waveapp.log"), level: "info" }),
 ];
 if (isDev) {
     loggerTransports.push(new winston.transports.Console());
@@ -91,8 +94,9 @@ function log(...msg: any[]) {
 console.log = log;
 console.log(
     sprintf(
-        "waveterm-app starting, WAVETERM_HOME=%s, electronpath=%s gopath=%s arch=%s/%s",
-        waveHome,
+        "waveterm-app starting, data_dir=%s, config_dir=%s electronpath=%s gopath=%s arch=%s/%s",
+        waveDataDir,
+        waveConfigDir,
         getElectronAppBasePath(),
         getElectronAppUnpackedBasePath(),
         unamePlatform,
@@ -676,10 +680,6 @@ async function appMain() {
         electronApp.quit();
         return;
     }
-    const waveHomeDir = getWaveHomeDir();
-    if (!fs.existsSync(waveHomeDir)) {
-        fs.mkdirSync(waveHomeDir);
-    }
     makeAppMenu();
     try {
         await runWaveSrv(handleWSEvent);

diff --git a/emain/launchsettings.ts b/emain/launchsettings.ts
@@ -1,14 +1,14 @@
 import fs from "fs";
 import path from "path";
-import { getWaveHomeDir } from "./platform";
+import { getWaveConfigDir } from "./platform";
 
 /**
  * Get settings directly from the Wave Home directory on launch.
  * Only use this when the app is first starting up. Otherwise, prefer the settings.GetFullConfig function.
  * @returns The initial launch settings for the application.
  */
 export function getLaunchSettings(): SettingsType {
-    const settingsPath = path.join(getWaveHomeDir(), "config", "settings.json");
+    const settingsPath = path.join(getWaveConfigDir(), "settings.json");
     try {
         const settingsContents = fs.readFileSync(settingsPath, "utf8");
         return JSON.parse(settingsContents);

diff --git a/emain/menu.ts b/emain/menu.ts
@@ -2,8 +2,8 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import * as electron from "electron";
-import { clearTabCache, getFocusedWaveWindow } from "emain/emain-viewmgr";
 import { fireAndForget } from "../frontend/util/util";
+import { clearTabCache, getFocusedWaveWindow } from "./emain-viewmgr";
 import { unamePlatform } from "./platform";
 import { updater } from "./updater";