Pac-Man/web.build.ts

import { $ } from "bun";
import { existsSync, promises as fs } from "fs";
import { platform } from "os";
import { dirname, join, relative, resolve } from "path";
import { match, P } from "ts-pattern";
import { configure, getConsoleSink, getLogger } from "@logtape/logtape";

// Constants
const TAILWIND_UPDATE_WINDOW_DAYS = 60; // 2 months

await configure({
  sinks: { console: getConsoleSink() },
  loggers: [
    { category: "web", lowestLevel: "debug", sinks: ["console"] },
    {
      category: ["logtape", "meta"],
      lowestLevel: "warning",
      sinks: ["console"],
    },
  ],
});

const logger = getLogger("web");

type Os =
  | { type: "linux"; wsl: boolean }
  | { type: "windows" }
  | { type: "macos" };

const os: Os = match(platform())
  .with("win32", () => ({ type: "windows" as const }))
  .with("linux", () => ({
    type: "linux" as const,
    // We detect WSL by checking for the presence of the WSLInterop file.
    // This is a semi-standard method of detecting WSL, which is more than workable for this already hacky script.
    wsl: existsSync("/proc/sys/fs/binfmt_misc/WSLInterop"),
  }))
  .with("darwin", () => ({ type: "macos" as const }))
  .otherwise(() => {
    throw new Error(`Unsupported platform: ${platform()}`);
  });

/**
 * Build the application with Emscripten, generate the CSS, and copy the files into 'dist'.
 *
 * @param release - Whether to build in release mode.
 * @param env - The environment variables to inject into build commands.
 */
async function build(release: boolean, env: Record<string, string> | null) {
  logger.info(
    `Building for 'wasm32-unknown-emscripten' for ${
      release ? "release" : "debug"
    }`
  );
  await $`cargo build --target=wasm32-unknown-emscripten ${
    release ? "--release" : ""
  }`.env(env ?? undefined);

  // Download the Tailwind CSS CLI for rendering the CSS
  const tailwindExecutable = match(
    await downloadTailwind(process.cwd(), {
      version: "latest",
      force: false,
    })
  )
    .with({ path: P.select() }, (path) => path)
    .with({ err: P.select() }, (err) => {
      throw new Error(err);
    })
    .exhaustive();

  logger.debug(`Invoking ${tailwindExecutable}...`);
  await $`${tailwindExecutable} --minify --input styles.css --output build.css --cwd assets/site`;

  const buildType = release ? "release" : "debug";
  const siteFolder = resolve("assets/site");
  const outputFolder = resolve(`target/wasm32-unknown-emscripten/${buildType}`);
  const dist = resolve("dist");

  // The files to copy into 'dist'
  const files = [
    ...["index.html", "favicon.ico", "build.css", "TerminalVector.ttf"].map(
      (file) => ({
        src: join(siteFolder, file),
        dest: join(dist, file),
        optional: false,
      })
    ),
    ...["pacman.wasm", "pacman.js", "deps/pacman.data"].map((file) => ({
      src: join(outputFolder, file),
      dest: join(dist, file.split("/").pop() || file),
      optional: false,
    })),
    {
      src: join(outputFolder, "pacman.wasm.map"),
      dest: join(dist, "pacman.wasm.map"),
      optional: true,
    },
  ];

  // Create required destination folders
  await Promise.all(
    // Get the dirname of files, remove duplicates
    [...new Set(files.map(({ dest }) => dirname(dest)))]
      // Create the folders
      .map(async (dir) => {
        // If the folder doesn't exist, create it
        if (!(await fs.exists(dir))) {
          logger.debug(`Creating folder ${dir}`);
          await fs.mkdir(dir, { recursive: true });
        }
      })
  );

  // Copy the files to the dist folder
  logger.debug("Copying files into dist");
  await Promise.all(
    files.map(async ({ optional, src, dest }) => {
      match({ optional, exists: await fs.exists(src) })
        // If optional and doesn't exist, skip
        .with({ optional: true, exists: false }, () => {
          logger.debug(
            `Optional file ${os.type === "windows" ? "\\" : "/"}${relative(
              process.cwd(),
              src
            )} does not exist, skipping...`
          );
        })
        // If not optional and doesn't exist, throw an error
        .with({ optional: false, exists: false }, () => {
          throw new Error(`Required file ${src} does not exist`);
        })
        // Otherwise, copy the file
        .otherwise(async () => await fs.copyFile(src, dest));
    })
  );
}

/**
 * Download the Tailwind CSS CLI to the specified directory.
 * @param dir - The directory to download the Tailwind CSS CLI to.
 * @returns The path to the downloaded Tailwind CSS CLI, or an error message if the download fails.
 */
async function downloadTailwind(
  dir: string,
  options?: Partial<{
    version: string; // The version of Tailwind CSS to download. If not specified, the latest version will be downloaded.
    force: boolean; // Whether to force the download even if the file already exists.
  }>
): Promise<{ path: string } | { err: string }> {
  const asset = match(os)
    .with({ type: "linux" }, () => "tailwindcss-linux-x64")
    .with({ type: "macos" }, () => "tailwindcss-macos-arm64")
    .with({ type: "windows" }, () => "tailwindcss-windows-x64.exe")
    .exhaustive();

  const version = options?.version ?? "latest";
  const force = options?.force ?? false;

  const url =
    version === "latest" || version == null
      ? `https://github.com/tailwindlabs/tailwindcss/releases/latest/download/${asset}`
      : `https://github.com/tailwindlabs/tailwindcss/releases/download/${version}/${asset}`;

  // If the GITHUB_TOKEN environment variable is set, use it for Bearer authentication
  const headers: Record<string, string> = {};
  if (process.env.GITHUB_TOKEN) {
    headers.Authorization = `Bearer ${process.env.GITHUB_TOKEN}`;
  }

  // Check if the file already exists
  const path = join(dir, asset);
  const exists = await fs.exists(path);

  // Check if we should download based on timestamps
  let shouldDownload = force || !exists;

  if (exists && !force) {
    try {
      const fileStats = await fs.stat(path);
      const fileModifiedTime = fileStats.mtime;
      const now = new Date();

      // Check if file is older than the update window
      const updateWindowAgo = new Date(
        now.getTime() - TAILWIND_UPDATE_WINDOW_DAYS * 24 * 60 * 60 * 1000
      );

      if (fileModifiedTime < updateWindowAgo) {
        logger.debug(
          `File is older than ${TAILWIND_UPDATE_WINDOW_DAYS} days, checking for updates...`
        );
        shouldDownload = true;
      } else {
        logger.debug(
          `File is recent (${fileModifiedTime.toISOString()}), checking if newer version available...`
        );
      }
    } catch (error) {
      logger.debug(
        `Error checking file timestamp: ${error}, will download anyway`
      );
      shouldDownload = true;
    }
  }

  // If we need to download, check the server's last-modified header
  if (shouldDownload) {
    const response = await fetch(url, {
      headers,
      method: "HEAD",
      redirect: "follow",
    });

    if (response.ok) {
      const lastModified = response.headers.get("last-modified");
      if (lastModified) {
        const serverTime = new Date(lastModified);
        const now = new Date();

        // If server timestamp is in the future, something is wrong - download anyway
        if (serverTime > now) {
          logger.debug(
            `Server timestamp is in the future (${serverTime.toISOString()}), downloading anyway`
          );
          shouldDownload = true;
        } else if (exists) {
          // Compare with local file timestamp (both in UTC)
          const fileStats = await fs.stat(path);
          const fileModifiedTime = new Date(fileStats.mtime.getTime());

          if (serverTime > fileModifiedTime) {
            logger.debug(
              `Server has newer version (${serverTime.toISOString()} vs local ${fileModifiedTime.toISOString()})`
            );
            shouldDownload = true;
          } else {
            logger.debug(
              `Local file is up to date (${fileModifiedTime.toISOString()})`
            );
            shouldDownload = false;
          }
        }
      } else {
        logger.debug(
          `No last-modified header available, downloading to be safe`
        );
        shouldDownload = true;
      }
    } else {
      logger.debug(
        `Failed to check server headers: ${response.status} ${response.statusText}`
      );
      shouldDownload = true;
    }
  }

  if (exists && !shouldDownload) {
    const displayPath = match(relative(process.cwd(), path))
      // If the path is not a subpath of cwd, display the absolute path
      .with(P.string.startsWith(".."), (_relative) => path)
      // Otherwise, display the relative path
      .otherwise((relative) => relative);

    logger.debug(
      `Tailwind CSS CLI already exists and is up to date at ${displayPath}`
    );
    return { path };
  }

  if (exists) {
    const displayPath = match(relative(process.cwd(), path))
      // If the path is not a subpath of cwd, display the absolute path
      .with(P.string.startsWith(".."), (_relative) => path)
      // Otherwise, display the relative path
      .otherwise((relative) => relative);

    if (force) {
      logger.debug(`Overwriting Tailwind CSS CLI at ${displayPath}`);
    } else {
      logger.debug(`Downloading updated Tailwind CSS CLI to ${displayPath}`);
    }
  } else {
    logger.debug(`Downloading Tailwind CSS CLI to ${path}`);
  }

  try {
    logger.debug(`Fetching ${url}...`);
    const response = await fetch(url, { headers });

    if (!response.ok) {
      return {
        err: `Failed to download Tailwind CSS: ${response.status} ${response.statusText} for '${url}'`,
      };
    } else if (!response.body) {
      return { err: `No response body received for '${url}'` };
    }

    // Validate Content-Length if available
    const contentLength = response.headers.get("content-length");
    if (contentLength) {
      const expectedSize = parseInt(contentLength, 10);
      if (isNaN(expectedSize)) {
        return { err: `Invalid Content-Length header: ${contentLength}` };
      }
      logger.debug(`Expected file size: ${expectedSize} bytes`);
    }

    logger.debug(`Writing to ${path}...`);
    await fs.mkdir(dir, { recursive: true });

    const file = Bun.file(path);
    const writer = file.writer();

    const reader = response.body.getReader();
    let downloadedBytes = 0;

    try {
      while (true) {
        const { done, value } = await reader.read();
        if (done) break;
        writer.write(value);
        downloadedBytes += value.length;
      }
    } finally {
      reader.releaseLock();
      await writer.end();
    }

    // Validate downloaded file size
    if (contentLength) {
      const expectedSize = parseInt(contentLength, 10);
      const actualSize = downloadedBytes;

      if (actualSize !== expectedSize) {
        // Clean up the corrupted file
        try {
          await fs.unlink(path);
        } catch (unlinkError) {
          logger.debug(
            `Warning: Failed to clean up corrupted file: ${unlinkError}`
          );
        }

        return {
          err: `File size mismatch: expected ${expectedSize} bytes, got ${actualSize} bytes. File may be corrupted.`,
        };
      }

      logger.debug(`File size validation passed: ${actualSize} bytes`);
    }

    // Make the file executable on Unix-like systems
    if (os.type !== "windows") {
      await $`chmod +x ${path}`;
    }

    // Ensure file is not locked; sometimes the runtime is too fast and the file is executed before the lock is released
    const timeout = Date.now() + 2500; // 2.5s timeout
    do {
      try {
        if ((await fs.stat(path)).size > 0) break;
      } catch {
        // File might not be ready yet
        logger.debug(`File ${path} is not ready yet, waiting...`);
      }
      await new Promise((resolve) => setTimeout(resolve, 10));
    } while (Date.now() < timeout);

    // All done!
    return { path };
  } catch (error) {
    return {
      err: `Download failed: ${
        error instanceof Error ? error.message : String(error)
      }`,
    };
  }
}

/**
 * Checks to see if the Emscripten SDK is activated for a Windows or *nix machine by looking for a .exe file and the equivalent file on Linux/macOS. Returns both results for handling.
 * @param emsdkDir - The directory containing the Emscripten SDK.
 * @returns A record of environment variables.
 */
async function checkEmsdkType(
  emsdkDir: string
): Promise<{ windows: boolean; nix: boolean }> {
  const binary = resolve(join(emsdkDir, "upstream", "bin", "clang"));

  return {
    windows: await fs.exists(binary + ".exe"),
    nix: await fs.exists(binary),
  };
}

/**
 * Activate the Emscripten SDK environment variables.
 * Technically, this doesn't actually activate the environment variables for the current shell,
 * it just runs the environment sourcing script and returns the environment variables for future command invocations.
 * @param emsdkDir - The directory containing the Emscripten SDK.
 * @returns A record of environment variables.
 */
async function activateEmsdk(
  emsdkDir: string
): Promise<{ vars: Record<string, string> | null } | { err: string }> {
  // If the EMSDK environment variable is set already & the path specified exists, return nothing
  if (process.env.EMSDK && (await fs.exists(resolve(process.env.EMSDK)))) {
    logger.debug(
      "Emscripten SDK already activated in environment, using existing configuration"
    );
    return { vars: null };
  }

  // Check if the emsdk directory exists
  if (!(await fs.exists(emsdkDir))) {
    return {
      err: `Emscripten SDK directory not found at ${emsdkDir}. Please install or clone 'emsdk' and try again.`,
    };
  }

  // Check if the emsdk directory is activated/installed properly for the current OS
  match({
    os: os,
    ...(await checkEmsdkType(emsdkDir)),
  })
    // If the Emscripten SDK is not activated/installed properly, exit with an error
    .with(
      {
        nix: false,
        windows: false,
      },
      () => {
        return {
          err: "Emscripten SDK does not appear to be activated/installed properly.",
        };
      }
    )
    // If the Emscripten SDK is activated for Windows, but is currently running on a *nix OS, exit with an error
    .with(
      {
        nix: false,
        windows: true,
        os: { type: P.not("windows") },
      },
      () => {
        return {
          err: "Emscripten SDK appears to be activated for Windows, but is currently running on a *nix OS.",
        };
      }
    )
    // If the Emscripten SDK is activated for *nix, but is currently running on a Windows OS, exit with an error
    .with(
      {
        nix: true,
        windows: false,
        os: { type: "windows" },
      },
      () => {
        return {
          err: "Emscripten SDK appears to be activated for *nix, but is currently running on a Windows OS.",
        };
      }
    );

  // Determine the environment script to use based on the OS
  const envScript = match(os)
    .with({ type: "windows" }, () => join(emsdkDir, "emsdk_env.bat"))
    .with({ type: P.union("linux", "macos") }, () =>
      join(emsdkDir, "emsdk_env.sh")
    )
    .exhaustive();

  // Run the environment script and capture the output
  const { stdout, stderr, exitCode } = await match(os)
    .with({ type: "windows" }, () =>
      // run the script, ignore it's output ('>nul'), then print the environment variables ('set')
      $`cmd /c "${envScript} >nul && set"`.quiet()
    )
    .with({ type: P.union("linux", "macos") }, () =>
      // run the script with bash, ignore it's output ('> /dev/null'), then print the environment variables ('env')
      $`bash -c "source '${envScript}' && env"`.quiet()
    )
    .exhaustive();

  if (exitCode !== 0) {
    return { err: stderr.toString() };
  }

  // Parse the output into a record of environment variables
  const vars = Object.fromEntries(
    stdout
      .toString()
      .split(os.type === "windows" ? /\r?\n/ : "\n") // Split output into lines, handling Windows CRLF vs *nix LF
      .map((line) => line.split("=", 2)) // Parse each line as KEY=VALUE (limit to 2 parts)
      .filter(([k, v]) => k && v) // Keep only valid key-value pairs (both parts exist)
  );

  return { vars };
}

async function main() {
  // Print the OS detected
  logger.debug(
    "OS Detected: " +
      match(os)
        .with({ type: "windows" }, () => "Windows")
        .with({ type: "linux" }, ({ wsl: isWsl }) =>
          isWsl ? "Linux (via WSL)" : "Linux"
        )
        .with({ type: "macos" }, () => "macOS")
        .exhaustive()
  );

  const release = process.env.RELEASE !== "0";
  const emsdkDir = resolve("./emsdk");

  // Activate the Emscripten SDK (returns null if already activated)
  const vars = match(await activateEmsdk(emsdkDir))
    .with({ vars: P.select() }, (vars) => vars)
    .with({ err: P.any }, ({ err }) => {
      logger.debug("Error activating Emscripten SDK: " + err);
      process.exit(1);
    })
    .exhaustive();

  // Build the application
  await build(release, vars);
}

/**
 * Main entry point.
 */
main().catch((err) => {
  console.error({ msg: "fatal error", error: err });
  process.exit(1);
});