Move built client files to client_bundle folder to make embedding them into the server binary cleaner.

Author: zefhemel

.air.toml

@@ -4,9 +4,9 @@ tmp_dir = "tmp"
 [build]
   args_bin = []
   bin = "silverbullet"
-  cmd = "deno task build && go build"
+  cmd = "make"
   # delay = 10000
-  exclude_dir = ["node_modules", "website", "scripts", "dist_client_bundle", "dist_base_fs_bundle", "dist"]
+  exclude_dir = ["node_modules", "website", "scripts", "client_bundle", "dist"]
   exclude_file = ["public_version.ts"]
   exclude_regex = ["_test.go", ".test.ts"]
   exclude_unchanged = false

.gitignore

@@ -1,7 +1,7 @@
 .env
 .DS_Store
-dist_client_bundle
-dist_base_fs_bundle
+client_bundle/client
+client_bundle/base_fs
 dist
 *.js.map
 website_build
@@ -17,4 +17,4 @@ deploy.json
 tmp_playground
 /public_version.ts
 tmp
-*.ipynb
+.idea

Makefile

@@ -1,13 +1,13 @@
 build:
-	# Build frontend
+	# Build client
 	deno task build
 	# Build plug-compile
 	deno task build-plug-compile
-	# Build backend
+	# Build server
 	go build
 
 clean:
-	deno task clean
+	rm -rf  client_bundle/{base_fs,client} dist public_version.ts
 	rm -f silverbullet
 
 check:

build_client.ts

@@ -7,7 +7,7 @@ import { patchDenoLibJS } from "./client/plugos/plug_compile.ts";
 import { denoPlugins } from "@luca/esbuild-deno-loader";
 import * as esbuild from "esbuild";
 
-// This builds the client and puts it into dist_client_bundle/
+// This builds the client and puts it into client_bundle/client
 
 export async function bundleAll(): Promise<void> {
   await buildCopyBundleAssets();
@@ -50,8 +50,8 @@ export async function copyAssets(dist: string) {
 }
 
 async function buildCopyBundleAssets() {
-  await Deno.mkdir("dist_client_bundle", { recursive: true });
-  await Deno.mkdir("dist_base_fs_bundle", { recursive: true });
+  await Deno.mkdir("client_bundle/client", { recursive: true });
+  await Deno.mkdir("client_bundle/base_fs", { recursive: true });
 
   console.log("Now ESBuilding the client and service workers...");
 
@@ -66,7 +66,7 @@ async function buildCopyBundleAssets() {
         out: "service_worker",
       },
     ],
-    outdir: "dist_client_bundle",
+    outdir: "client_bundle/client",
     absWorkingDir: Deno.cwd(),
     bundle: true,
     treeShaking: true,
@@ -89,11 +89,13 @@ async function buildCopyBundleAssets() {
   }
 
   // Patch the service_worker {{CACHE_NAME}}
-  let swCode = await Deno.readTextFile("dist_client_bundle/service_worker.js");
+  let swCode = await Deno.readTextFile(
+    "client_bundle/client/service_worker.js",
+  );
   swCode = swCode.replaceAll("{{CACHE_NAME}}", `cache-${Date.now()}`);
-  await Deno.writeTextFile("dist_client_bundle/service_worker.js", swCode);
+  await Deno.writeTextFile("client_bundle/client/service_worker.js", swCode);
 
-  await copyAssets("dist_client_bundle/.client");
+  await copyAssets("client_bundle/client/.client");
 
   console.log("Built!");
 }

build_plugs_libraries.ts

@@ -7,7 +7,7 @@ import { fileURLToPath } from "node:url";
 import { copy } from "@std/fs";
 import { version } from "./version.ts";
 
-// This builds all built-in plugs and libraries and puts them into dist_base_fs_bundle/
+// This builds all built-in plugs and libraries and puts them into client_bundle/base_fs
 
 if (import.meta.main) {
   await updateVersionFile();
@@ -20,13 +20,13 @@ if (import.meta.main) {
     `./plugs/${name}/${name}.plug.yaml`
   );
 
-  const plugBundlePath = "dist_base_fs_bundle";
+  const plugBundlePath = "client_bundle/base_fs";
   const targetDir = path.join(plugBundlePath, "_plug");
   Deno.mkdirSync(targetDir, { recursive: true });
   Deno.mkdirSync("dist", { recursive: true });
 
   // Copy Library files
-  await copy("libraries/Library", "dist_base_fs_bundle/Library", {
+  await copy("libraries/Library", `${plugBundlePath}/Library`, {
     overwrite: true,
   });
 

client_bundle/bundle.go

@@ -0,0 +1,10 @@
+package client_bundle
+
+// Files in this folder are generated as part of the build process (except this one)
+// The sole purpose of this file is to embed these generated client files into the server binary
+
+import "embed"
+
+//go:embed base_fs/*
+//go:embed client/*
+var BundledFiles embed.FS

deno.json

@@ -2,11 +2,9 @@
   "name": "@silverbulletmd/silverbullet",
   "version": "2.0.0",
   "tasks": {
-    "build": "deno task clean && deno run -A build_plugs_libraries.ts && deno run -A build_client.ts",
+    "build": "make clean && deno run -A build_plugs_libraries.ts && deno run -A build_client.ts",
     "build-production": "deno task build --production",
     "build-plug-compile": "deno run -A build_plug_compile.ts",
-    "clean": "rm -rf dist_client_bundle dist_base_fs_bundle dist public_version.ts",
-    "deep-clean-mac": "rm -f deno.lock && rm -rf $HOME/Library/Caches/deno && deno task clean",
     "check": "find . -name '*.ts*' -not -path \"*/node_modules/*\" | xargs deno check",
     "checks": "deno task check && deno task lint && deno task test",
     "lint": "deno lint --fix",
@@ -15,17 +13,29 @@
     "plugs": "deno run -A build_plugs_libraries.ts"
   },
   "publish": {
-    "exclude": ["website", "CHANGELOG.md", "**/*.md"]
+    "exclude": [
+      "website",
+      "CHANGELOG.md",
+      "**/*.md"
+    ]
   },
   "lint": {
-    "exclude": ["dist", "dist_client_bundle", "dist_base_fs_bundle"],
+    "exclude": [
+      "dist",
+      "client_bundle"
+    ],
     "rules": {
-      "exclude": ["no-explicit-any", "no-slow-types", "jsx-boolean-value"]
+      "exclude": [
+        "no-explicit-any",
+        "no-slow-types",
+        "jsx-boolean-value"
+      ]
     }
   },
   "fmt": {
     "exclude": [
       "dist*",
+      "client_bundle/*",
       "website",
       "**/*.md",
       "**/*.html",
@@ -34,7 +44,12 @@
     ]
   },
   "compilerOptions": {
-    "lib": ["dom", "dom.iterable", "dom.asynciterable", "deno.ns"],
+    "lib": [
+      "dom",
+      "dom.iterable",
+      "dom.asynciterable",
+      "deno.ns"
+    ],
     "jsx": "react-jsx",
     "jsxImportSource": "npm:preact@10.26.4"
   },

server/cmd/server.go

@@ -2,6 +2,7 @@ package cmd
 
 import (
 	_ "embed"
+	"errors"
 	"fmt"
 	"io/fs"
 	"log"
@@ -150,8 +151,8 @@ func buildConfig(bundledFiles fs.FS, args []string) *server.ServerConfig {
 		}
 	}
 
-	serverConfig.ClientBundle = server.NewReadOnlyFallthroughSpacePrimitives(bundledFiles, "dist_client_bundle", bundlePathDate, nil)
-	rootSpaceConfig.SpacePrimitives = server.NewReadOnlyFallthroughSpacePrimitives(bundledFiles, "dist_base_fs_bundle", bundlePathDate, spacePrimitives)
+	serverConfig.ClientBundle = server.NewReadOnlyFallthroughSpacePrimitives(bundledFiles, "client", bundlePathDate, nil)
+	rootSpaceConfig.SpacePrimitives = server.NewReadOnlyFallthroughSpacePrimitives(bundledFiles, "base_fs", bundlePathDate, spacePrimitives)
 
 	if serverConfig.BindHost == "127.0.0.1" {
 		log.Println("SilverBullet will only be available locally, to allow outside connections, pass -L0.0.0.0 as a flag, and put a TLS terminator on top.")
@@ -197,7 +198,7 @@ func ensureIndexAndConfig(rootSpaceConfig *server.SpaceConfig) {
 	// Now let's check for a CONFIG.md
 	configPagePath := "CONFIG.md"
 	_, err = rootSpaceConfig.SpacePrimitives.GetFileMeta(configPagePath)
-	if err == server.ErrNotFound {
+	if errors.Is(err, server.ErrNotFound) {
 		log.Printf("Config page %s does not yet exist, creating...", configPagePath)
 		if _, err := rootSpaceConfig.SpacePrimitives.WriteFile(configPagePath, configPageContent, nil); err != nil {
 			log.Fatalf("Could not write config page %s: %v", configPagePath, err)

server/proxy.go

@@ -70,7 +70,7 @@ func proxyHandler(w http.ResponseWriter, r *http.Request) {
 		}
 	}
 
-	// Make the request
+	// TODO: Replaced with specifically configured client
 	client := http.DefaultClient
 
 	resp, err := client.Do(req)
@@ -90,5 +90,7 @@ func proxyHandler(w http.ResponseWriter, r *http.Request) {
 
 	// Set status code and copy body
 	w.WriteHeader(resp.StatusCode)
-	io.Copy(w, resp.Body)
+	if _, err := io.Copy(w, resp.Body); err != nil {
+		log.Printf("Proxy: failed to copy response body: %v", err)
+	}
 }

silverbullet.go

@@ -1,22 +1,17 @@
 package main
 
 import (
-	"embed"
+	_ "embed"
 
+	"github.com/silverbulletmd/silverbullet/client_bundle"
 	"github.com/silverbulletmd/silverbullet/server/cmd"
 )
 
-// Embed client files, plugs and version files into the binary
-//
-//go:embed dist_client_bundle/*
-//go:embed dist_base_fs_bundle/*
-var bundledFiles embed.FS
-
 //go:embed public_version.ts
-var versionFileText string
+var VersionFileText string
 
 func main() {
-	c := cmd.ServerCommand(bundledFiles)
-	c.AddCommand(cmd.VersionCommand(versionFileText), cmd.UpgradeCommand(), cmd.UpgradeEdgeCommand())
+	c := cmd.ServerCommand(client_bundle.BundledFiles)
+	c.AddCommand(cmd.VersionCommand(VersionFileText), cmd.UpgradeCommand(), cmd.UpgradeEdgeCommand())
 	c.Execute()
 }