Embed static copy of docsite for help view (#949)

This will take the latest artifact from the waveterm-docs repo and embed
it in the app binary. When the help view is launched, it will be served
from our backend. If the embedded copy doesn't exist, such as in
unpackaged versions of the app or in locally packaged versions, it will
use the hosted site instead.

There is a sibling PR in the docs repository to build the embedded
version of the app (strips out some external links, removes Algolia
DocSearch, updates the baseUrl)
wavetermdev/waveterm-docs#46

Author: esimkowitz

.github/workflows/build-helper.yml

@@ -11,6 +11,7 @@ on:
 env:
     GO_VERSION: "1.22"
     NODE_VERSION: "20"
+    STATIC_DOCSITE_PATH: docsite
 jobs:
     runbuild:
         permissions:
@@ -110,6 +111,15 @@ jobs:
                   smctl windows certsync
               shell: cmd
 
+            - name: Download waveterm-docs static site
+              uses: dawidd6/action-download-artifact@v6
+              with:
+                  github_token: ${{secrets.GITHUB_TOKEN}}
+                  workflow: build-embedded.yml
+                  repo: wavetermdev/waveterm-docs
+                  name: static-site
+                  path: ${{env.STATIC_DOCSITE_PATH}}
+
             # Build and upload packages
             - name: Build (not Windows)
               if: matrix.platform != 'windows'
@@ -121,13 +131,15 @@ jobs:
                   APPLE_ID: ${{ matrix.platform == 'darwin' && secrets.PROD_MACOS_NOTARIZATION_APPLE_ID_2 }}
                   APPLE_APP_SPECIFIC_PASSWORD: ${{ matrix.platform == 'darwin' && secrets.PROD_MACOS_NOTARIZATION_PWD_2 }}
                   APPLE_TEAM_ID: ${{ matrix.platform == 'darwin' && secrets.PROD_MACOS_NOTARIZATION_TEAM_ID_2 }}
+                  STATIC_DOCSITE_PATH: ${{env.STATIC_DOCSITE_PATH}}
             - name: Build (Windows only)
               if: matrix.platform == 'windows'
               run: task package
               env:
                   USE_SYSTEM_FPM: true # Ensure that the installed version of FPM is used rather than the bundled one.
                   CSC_LINK: ${{ steps.variables.outputs.SM_CLIENT_CERT_FILE }}
                   CSC_KEY_PASSWORD: ${{ secrets.SM_CLIENT_CERT_PASSWORD }}
+                  STATIC_DOCSITE_PATH: ${{env.STATIC_DOCSITE_PATH}}
               shell: powershell # electron-builder's Windows code signing package has some compatibility issues with pwsh, so we need to use Windows Powershell
             - name: Upload to S3 staging
               run: task artifacts:upload

electron-builder.config.cjs

@@ -34,6 +34,7 @@ const config = {
     },
     asarUnpack: [
         "dist/bin/**/*", // wavesrv and wsh binaries
+        "dist/docsite/**/*", // the static docsite
     ],
     mac: {
         target: [
@@ -86,6 +87,14 @@ const config = {
         provider: "generic",
         url: "https://dl.waveterm.dev/releases-w2",
     },
+    beforePack: () => {
+        const staticSourcePath = process.env.STATIC_DOCSITE_PATH;
+        const staticDestPath = "dist/docsite";
+        if (staticSourcePath) {
+            console.log(`Static docsite path is specified, copying from "${staticSourcePath}" to "${staticDestPath}"`);
+            fs.cpSync(staticSourcePath, staticDestPath, { recursive: true });
+        }
+    },
     afterPack: (context) => {
         // This is a workaround to restore file permissions to the wavesrv binaries on macOS after packaging the universal binary.
         if (context.electronPlatformName === "darwin" && context.arch === Arch.universal) {

emain/docsite.ts

@@ -0,0 +1,27 @@
+import { getWebServerEndpoint } from "@/util/endpoints";
+import { fetch } from "@/util/fetchutil";
+import { ipcMain } from "electron";
+
+const docsiteWebUrl = "https://docs.waveterm.dev/";
+let docsiteUrl: string;
+
+ipcMain.on("get-docsite-url", (event) => {
+    event.returnValue = docsiteUrl;
+});
+
+export async function initDocsite() {
+    const docsiteEmbeddedUrl = getWebServerEndpoint() + "/docsite/";
+    try {
+        const response = await fetch(docsiteEmbeddedUrl);
+        if (response.ok) {
+            console.log("Embedded docsite is running, using embedded version for help view");
+            docsiteUrl = docsiteEmbeddedUrl;
+        } else {
+            console.log("Embedded docsite is not running, using web version for help view", response);
+            docsiteUrl = docsiteWebUrl;
+        }
+    } catch (error) {
+        console.log("Failed to fetch docsite url, using web version for help view", error);
+        docsiteUrl = docsiteWebUrl;
+    }
+}

emain/emain.ts

@@ -20,12 +20,13 @@ import { fetch } from "../frontend/util/fetchutil";
 import * as keyutil from "../frontend/util/keyutil";
 import { fireAndForget } from "../frontend/util/util";
 import { AuthKey, AuthKeyEnv, configureAuthKeyRequestInjection } from "./authkey";
+import { initDocsite } from "./docsite";
 import { ElectronWshClient, initElectronWshClient } from "./emain-wsh";
 import { getLaunchSettings } from "./launchsettings";
 import { getAppMenu } from "./menu";
 import {
     getElectronAppBasePath,
-    getGoAppBasePath,
+    getElectronAppUnpackedBasePath,
     getWaveHomeDir,
     getWaveSrvCwd,
     getWaveSrvPath,
@@ -95,7 +96,7 @@ console.log(
         "waveterm-app starting, WAVETERM_HOME=%s, electronpath=%s gopath=%s arch=%s/%s",
         waveHome,
         getElectronAppBasePath(),
-        getGoAppBasePath(),
+        getElectronAppUnpackedBasePath(),
         unamePlatform,
         unameArch
     )
@@ -155,7 +156,7 @@ function runWaveSrv(): Promise<boolean> {
         pReject = argReject;
     });
     const envCopy = { ...process.env };
-    envCopy[WaveAppPathVarName] = getGoAppBasePath();
+    envCopy[WaveAppPathVarName] = getElectronAppUnpackedBasePath();
     envCopy[WaveSrvReadySignalPidVarName] = process.pid.toString();
     envCopy[AuthKeyEnv] = AuthKey;
     const waveSrvCmd = getWaveSrvPath();
@@ -871,6 +872,7 @@ async function appMain() {
     await electronApp.whenReady();
     configureAuthKeyRequestInjection(electron.session.defaultSession);
     await relaunchBrowserWindows();
+    await initDocsite();
     setTimeout(runActiveTimer, 5000); // start active timer, wait 5s just to be safe
     try {
         initElectronWshClient();

emain/platform.ts

@@ -50,7 +50,7 @@ function getElectronAppBasePath(): string {
     return path.dirname(import.meta.dirname);
 }
 
-function getGoAppBasePath(): string {
+function getElectronAppUnpackedBasePath(): string {
     return getElectronAppBasePath().replace("app.asar", "app.asar.unpacked");
 }
 
@@ -59,10 +59,10 @@ const wavesrvBinName = `wavesrv.${unameArch}`;
 function getWaveSrvPath(): string {
     if (process.platform === "win32") {
         const winBinName = `${wavesrvBinName}.exe`;
-        const appPath = path.join(getGoAppBasePath(), "bin", winBinName);
+        const appPath = path.join(getElectronAppUnpackedBasePath(), "bin", winBinName);
         return `${appPath}`;
     }
-    return path.join(getGoAppBasePath(), "bin", wavesrvBinName);
+    return path.join(getElectronAppUnpackedBasePath(), "bin", wavesrvBinName);
 }
 
 function getWaveSrvCwd(): string {
@@ -71,7 +71,7 @@ function getWaveSrvCwd(): string {
 
 export {
     getElectronAppBasePath,
-    getGoAppBasePath,
+    getElectronAppUnpackedBasePath,
     getWaveHomeDir,
     getWaveSrvCwd,
     getWaveSrvPath,

emain/preload.ts

@@ -11,6 +11,7 @@ contextBridge.exposeInMainWorld("api", {
     getUserName: () => ipcRenderer.sendSync("get-user-name"),
     getHostName: () => ipcRenderer.sendSync("get-host-name"),
     getAboutModalDetails: () => ipcRenderer.sendSync("get-about-modal-details"),
+    getDocsiteUrl: () => ipcRenderer.sendSync("get-docsite-url"),
     openNewWindow: () => ipcRenderer.send("open-new-window"),
     showContextMenu: (menu, position) => ipcRenderer.send("contextmenu-show", menu, position),
     onContextMenuClick: (callback) => ipcRenderer.on("contextmenu-click", (_event, id) => callback(id)),

frontend/app/view/helpview/helpview.less

@@ -3,15 +3,10 @@
 
 .help-view {
     width: 100%;
-    padding: 0 5px;
-
-    .title {
-        font-weight: bold;
-    }
-
-    code {
-        font: var(--fixed-font);
-        background-color: var(--highlight-bg-color);
-        padding: 0 5px;
+    height: 100%;
+    .docsite-webview {
+        width: 100%;
+        height: 100%;
+        border: 0;
     }
 }