lecodes-cli 2.4.6 → 2.4.8

package/src/hosts/desktopRenderer.ts

@@ -2,7 +2,7 @@ import { execFileSync, spawn, spawnSync } from "node:child_process"
 import { copyFileSync, existsSync, mkdirSync, mkdtempSync, readdirSync, readFileSync, rmSync, statSync, writeFileSync, linkSync } from "node:fs"
 import { homedir, tmpdir } from "node:os"
 import { delimiter, join, resolve } from "node:path"
-import { cachedArtifactSha, downloadReleaseArchive, fetchReleaseProduct, macPlatformKey, semverNewer, type ManifestVersion } from "./releases"
+import { cachedArtifactSha, downloadReleaseArchive, fetchReleaseProduct, macPlatformKey, newestForPlatform, semverNewer, type ManifestFile, type ManifestVersion } from "./releases"
 import { CliError, note, warnErr } from "../cli"
 import { makeStackDemangler } from "../compile/nativeStack"
 
@@ -237,10 +237,12 @@ export const resolveDesktopExe = async (renderer: DesktopRenderer = "gl"): Promi
   return exe
 }
 
-/** Which native host runs a bundle: the desktop (a window, a GPU, pixels) or the windowless server
+/** Which native host runs a bundle: the desktop (a window, a GPU, pixels), the windowless server
  *  (hosts/desktop lecodes-server: the same engine on Filament's NOOP backend — the dedicated
- *  multiplayer server, a headless client, an offline simulation run; no UI hit-test, no pixels). */
-export type HostKind = "desktop" | "server"
+ *  multiplayer server, a headless client, an offline simulation run; no UI hit-test, no pixels), or
+ *  the bake tool (lecodes-bake: that windowless host with the lightmap bake built in and the optional
+ *  engines — physics, 2D, audio, net, navmesh — left out; `lecodes lightmap bake` runs the app in it). */
+export type HostKind = "desktop" | "server" | "bake"
 
 const serverExeName = () => (process.platform === "win32" ? "lecodes-server.exe" : "lecodes-server")
 
@@ -266,8 +268,106 @@ export const resolveServerExe = async (renderer: DesktopRenderer = "gl"): Promis
   return exe
 }
 
+/*
+ * The lightmap bake's host, lecodes-bake (hosts/desktop CREATOR_DESKTOP_BAKE): the bake is NOT in the
+ * shipped desktop / server hosts, it is a tool binary of its own — published as the release product
+ * "bake" (scripts/release/*, platform keys windows-x64 / linux-x64: the bake traces on Vulkan ray query
+ * or OptiX, neither of which a Mac has) from the same build machine and VERSION as the desktop host.
+ * Resolution: LECODES_BAKE_EXE → the cached build of the desktop host's selected version (the one
+ * `render --desktop` runs: the bake then comes from the same release as the engine the level renders
+ * with) → the newest cached one when the manifest is out of reach → a download: that version when
+ * the manifest carries a bake for it, else the newest bake published for this platform (the selected
+ * desktop may predate the first bake release). Cache: ~/.lecodes/bake/bake-<version>/, beside matc's
+ * and cmgen's. The renderer (gl / vulkan) does not apply: one binary, on Filament's NOOP backend.
+ */
+
+const bakeExeName = () => (process.platform === "win32" ? "lecodes-bake.exe" : "lecodes-bake")
+
+const bakePlatformKey = (): string => {
+  if (process.platform === "win32") return "windows-x64"
+  if (process.platform === "linux") return "linux-x64"
+  throw new CliError(`The lightmap bake host (lecodes-bake) isn't available on ${process.platform}: the bake traces with Vulkan ray query or OptiX — run it on Windows or Linux.`)
+}
+
+const bakeCacheRoot = () => join(homedir(), ".lecodes", "bake")
+
+/** Locate lecodes-bake inside a cache / stage dir (the archive nests a `lecodes-bake/` folder). */
+const findBakeExe = (dir: string): string | null => {
+  for (const entry of readdirSync(dir, { withFileTypes: true })) {
+    const p = join(dir, entry.name)
+    if (entry.isFile() && entry.name === bakeExeName()) return p
+    if (entry.isDirectory()) { const found = findBakeExe(p); if (found) return found }
+  }
+  return null
+}
+
+/** Versions with a working lecodes-bake in the cache, newest first. */
+export const installedBakeVersions = (): string[] => {
+  try {
+    return readdirSync(bakeCacheRoot(), { withFileTypes: true })
+      .filter((e) => e.isDirectory() && e.name.startsWith("bake-"))
+      .map((e) => e.name.slice("bake-".length))
+      .filter((v) => findBakeExe(join(bakeCacheRoot(), `bake-${v}`)) !== null)
+      .sort(semverNewer)
+  } catch {
+    return []
+  }
+}
+
+/** The lightmap bake's host binary (see the block comment above). */
+export const resolveBakeExe = async (): Promise<string> => {
+  const override = process.env.LECODES_BAKE_EXE
+  if (override) {
+    if (!existsSync(override)) throw new CliError(`LECODES_BAKE_EXE points at "${override}" which doesn't exist.`)
+    return resolve(override)
+  }
+  const key = bakePlatformKey()
+  const selected = selectedDesktopVersion()
+  const cachedDir = (version: string) => join(bakeCacheRoot(), `bake-${version}`)
+  const cachedSelected = existsSync(cachedDir(selected)) ? findBakeExe(cachedDir(selected)) : null
+  if (cachedSelected) return cachedSelected
+  let pick: { version: string, file: ManifestFile } | null
+  try {
+    const { versions } = await fetchReleaseProduct("bake", "lightmap bake host (lecodes-bake)")
+    const exact = versions.find((v) => v.version === selected)?.files[key]
+    pick = exact ? { version: selected, file: exact } : newestForPlatform(versions, key)
+  } catch (e) {
+    // Offline, or a manifest without the product yet: any cached bake host still bakes.
+    const newest = installedBakeVersions()[0]
+    if (newest) {
+      warnErr(`${e instanceof Error ? e.message : String(e)}\n  Using the cached lightmap bake host ${newest}.`)
+      return findBakeExe(cachedDir(newest))!
+    }
+    throw new CliError(
+      `${e instanceof Error ? e.message : String(e)}\n` +
+      "  The lightmap bake runs in lecodes-bake, downloaded from the release manifest on first use. Point LECODES_BAKE_EXE at a local build " +
+      "(hosts/desktop: build.ps1 -Bake → build-bake/lecodes-bake.exe; build.sh with CREATOR_DESKTOP_BAKE=ON → build-bake-linux/lecodes-bake).",
+    )
+  }
+  if (!pick) {
+    throw new CliError(
+      `The lightmap bake host (lecodes-bake) isn't published for ${key} yet. Point LECODES_BAKE_EXE at a local build ` +
+      "(hosts/desktop: build.ps1 -Bake → build-bake/lecodes-bake.exe; build.sh with CREATOR_DESKTOP_BAKE=ON → build-bake-linux/lecodes-bake).",
+    )
+  }
+  const dir = cachedDir(pick.version)
+  let exe = existsSync(dir) ? findBakeExe(dir) : null
+  if (!exe) {
+    if (pick.version !== selected) note(`No lightmap bake host is published for LeCodes Desktop ${selected} — using lecodes-bake ${pick.version}.`)
+    note(`Downloading the lightmap bake host (lecodes-bake ${pick.version} [${key}], ${(pick.file.size / 1024 / 1024).toFixed(1)} MB)…`)
+    await downloadReleaseArchive(pick.file, {
+      cacheRoot: bakeCacheRoot(),
+      dest: dir,
+      validate: (d) => (findBakeExe(d) ? null : "The downloaded archive doesn't contain the lecodes-bake binary."),
+    })
+    exe = findBakeExe(dir)
+    if (!exe) throw new CliError(`Bake host cache at ${dir} is broken — delete the folder and retry.`)
+  }
+  return exe
+}
+
 const resolveHostExe = (host: HostKind | undefined, renderer: DesktopRenderer | undefined): Promise<string> =>
-  host === "server" ? resolveServerExe(renderer) : resolveDesktopExe(renderer)
+  host === "bake" ? resolveBakeExe() : host === "server" ? resolveServerExe(renderer) : resolveDesktopExe(renderer)
 
 /** `lecodes desktop update`: move the render host to the newest published release (never below the
  *  CLI's pin — a manifest that somehow regressed under it is an error, not a downgrade). Saves the
@@ -422,8 +522,8 @@ export type DesktopRenderOptions = {
   /** Which host binary to run (see DesktopRenderer). Must match the renderer the bundle's shaders
    *  were staged for — resolve it once per command and pass the same value to both. */
   renderer?: DesktopRenderer
-  /** The hidden desktop host (default: pixels, a PNG) or the windowless server host (no pixels — the
-   *  run is judged by its output alone; `outPng` is ignored). */
+  /** The hidden desktop host (default: pixels, a PNG) or a windowless one — the server, or the lightmap
+   *  bake's lecodes-bake (no pixels: the run is judged by its output alone; `outPng` is ignored). */
   host?: HostKind
   width: number
   height: number
@@ -561,13 +661,14 @@ export const runDesktopDev = async (url: string, opts: DesktopWindowOpts = {}):
 }
 
 /** Run a compiled bundle in the hidden desktop host and dump the final frame as a PNG — or, with
- *  `host: "server"`, in the windowless host, which paints nothing: the outcome is its output. */
+ *  `host: "server"` / `"bake"`, in a windowless host, which paints nothing: the outcome is its output. */
 export const runDesktopRender = async (
   js: string,
   resources: { name: string, absPath?: string }[],
   opts: DesktopRenderOptions,
 ): Promise<DesktopRenderOutcome> => {
-  const server = opts.host === "server"
+  const server = opts.host === "server" || opts.host === "bake"   // windowless: no PNG
+  const what = opts.host === "bake" ? "bake" : server ? "server" : "desktop"
   // macOS: the in-repo Metal host (hosts/desktop, phase 11) carries the headless render contract like
   // the other two platforms (CREATOR_HIDDEN / CREATOR_DUMP_PNG / CREATOR_SCRIPT); the old Swift shell
   // did not — a cached one is refused by its missing lecodes-server, not here.
@@ -614,7 +715,7 @@ export const runDesktopRender = async (
         child.kill()
         fail(new CliError(`The native render timed out after ${opts.timeoutMs}ms (raise --timeout, or lower --frames).`))
       }, opts.timeoutMs)
-      child.on("error", (e) => { clearTimeout(killer); fail(new CliError(`Can't run the ${server ? "server" : "desktop"} host: ${e.message}`)) })
+      child.on("error", (e) => { clearTimeout(killer); fail(new CliError(`Can't run the ${what} host: ${e.message}`)) })
       child.on("exit", (code) => {
         clearTimeout(killer)
         const output = demangle(chunks.join(""))
@@ -624,7 +725,7 @@ export const runDesktopRender = async (
         const detail = tail.length > 0 ? `\n${tail}` : ""
         fail(new CliError(code === 0
           ? `The renderer exited cleanly but produced no PNG — did the app open a screen?${detail}`
-          : `The ${server ? "server host" : "renderer"} exited with code ${code}.${detail}`))
+          : `The ${server ? `${what} host` : "renderer"} exited with code ${code}.${detail}`))
       })
     })
   } finally {