sailfork / t3code-github / apps/ server/ src/ preview/ PreviewBrowserHost.test.ts

import { describe, expect, it } from "@effect/vitest";
import * as HostProcess from "@t3tools/shared/HostProcess";
import * as Effect from "effect/Effect";
import * as Sink from "effect/Sink";
import * as Stream from "effect/Stream";
import { ChildProcessSpawner } from "effect/process";

import * as PreviewBrowserHost from "./PreviewBrowserHost.ts";

// What `ldd` printed for the pinned headless shell in a bare debian:trixie-slim container.
const LDD_IN_BARE_DEBIAN = `\tlinux-vdso.so.1 (0x00007ffd2d1f8000)
\tlibdl.so.2 => /lib/x86_64-linux-gnu/libdl.so.2 (0x00007f0c1b6a1000)
\tlibglib-2.0.so.0 => not found
\tlibnss3.so => not found
\tlibX11.so.6 => not found
\tlibc.so.6 => /lib/x86_64-linux-gnu/libc.so.6 (0x00007f0c1b4c0000)
`;

// Chrome's own abort on Ubuntu 26.04 with unprivileged user namespaces restricted.

const LOADER_ERROR =
  "chrome-headless-shell: error while loading shared libraries: libglib-2.0.so.0: cannot open shared object file: No such file or directory";

const hostReporting = (output: { readonly version: string; readonly ldd: string }) => {
  const commands: Array<string> = [];
  const spawner = ChildProcessSpawner.make((command) =>
    Effect.sync(() => {
      const { command: name, args } = command as unknown as {
        readonly command: string;
        readonly args: ReadonlyArray<string>;
      };
      commands.push([name, ...args].join(" "));
      return ChildProcessSpawner.makeHandle({
        pid: ChildProcessSpawner.ProcessId(1),
        exitCode: Effect.succeed(ChildProcessSpawner.ExitCode(0)),
        isRunning: Effect.succeed(false),
        kill: () => Effect.void,
        unref: Effect.succeed(Effect.void),
        stdin: Sink.drain,
        stdout: Stream.empty,
        stderr: Stream.empty,
        all: Stream.make(new TextEncoder().encode(name === "ldd" ? output.ldd : output.version)),
        getInputFd: () => Sink.drain,
        getOutputFd: () => Stream.empty,
      });
    }),
  );
  return { spawner, commands };
};

const diagnose = (input: {
  platform: NodeJS.Platform;
  output: string;
  ldd: string;
  version?: string;
  uid?: number;
}) => {
  const { spawner, commands } = hostReporting({
    ldd: input.ldd,
    version: input.version ?? LOADER_ERROR,
  });
  return PreviewBrowserHost.diagnoseLaunchFailure({
    executable: "/home/me/.t3/tools/chrome-headless-shell/linux64/154/chrome-headless-shell",
    output: input.output,
    setupCommand: "sudo t3 browser setup",
  }).pipe(
    Effect.provideService(ChildProcessSpawner.ChildProcessSpawner, spawner),
    Effect.provideService(HostProcess.Platform, input.platform),
    Effect.provideService(HostProcess.UserId, input.uid ?? 1000),
    Effect.map((error) => ({ error, commands })),
  );
};

describe("diagnoseLaunchFailure", () => {
  it.effect("explains how to restart a root server without Chrome's sandbox", () =>
    Effect.gen(function* () {
      const { error, commands } = yield* diagnose({
        platform: "linux",
        uid: 0,
        output: PreviewBrowserHost.NO_SANDBOX_SIGNATURE,
        ldd: "",
      });
      expect(error).toBeInstanceOf(PreviewBrowserHost.PreviewBrowserRootError);
      expect(error?.message).toContain("T3 server is running as root");
      expect(error?.message).toContain("T3 server's environment and restart the server");
      expect(error?.message).toContain("T3CODE_SERVER_BROWSER_SANDBOX=0 t3 serve");
      expect(error?.message).toContain("Environment=T3CODE_SERVER_BROWSER_SANDBOX=0");
      expect(error?.message).toContain("this disables Chrome's sandbox");
      expect(commands).toEqual([]);
    }),
  );

  it.effect("keeps host setup guidance for a nonroot sandbox failure", () =>
    Effect.gen(function* () {
      const { error } = yield* diagnose({
        platform: "linux",
        output: PreviewBrowserHost.NO_SANDBOX_SIGNATURE,
        ldd: "",
      });
      expect(error).toBeInstanceOf(PreviewBrowserHost.PreviewBrowserSandboxError);
      expect(error?.message).toContain("Run `sudo t3 browser setup` on the host");
    }),
  );

  it.effect("names every library the loader cannot find", () =>
    Effect.gen(function* () {
      const { error } = yield* diagnose({
        platform: "linux",
        output: "error while loading shared libraries: libglib-2.0.so.0",
        ldd: LDD_IN_BARE_DEBIAN,
      });
      expect(error).toMatchObject({
        _tag: "PreviewBrowserLibrariesError",
        libraries: ["libglib-2.0.so.0", "libnss3.so", "libX11.so.6"],
      });
      expect(error?.message).toContain("Run `sudo t3 browser setup` on the host");
    }),
  );

  it.effect("trusts the browser's own start over ldd", () =>
    Effect.gen(function* () {
      // NixOS: ldd lists libraries that nix-ld still provides to the real loader.
      const { error } = yield* diagnose({
        platform: "linux",
        output: "crashed",
        ldd: LDD_IN_BARE_DEBIAN,
        version: "Google Chrome for Testing 154.0.8037.92\n",
      });
      expect(error).toBeUndefined();
    }),
  );
});