193 lines · 7.8 KB · TypeScript
RawDownload
// @effect-diagnostics nodeBuiltinImport:off -- Native extension installation uses isolated filesystem fixtures.import * as NodeFSP from "node:fs/promises";import * as NodeOS from "node:os";import * as NodePath from "node:path";import * as NodeEvents from "node:events";import type { Message, MessageBus } from "dbus-next";import { afterEach, beforeEach, expect, it, vi } from "vite-plus/test";import {  GnomeCaptureSetup,  installGnomeCaptureBundle,  isGnomeCaptureSession,} from "./GnomeCaptureSetup.ts";import { GNOME_CAPTURE_FILES, GNOME_CAPTURE_UUID } from "./gnomeCaptureBundle.ts"; let dataHome: string;const bundle = NodePath.resolve(import.meta.dirname, "../../gnome-extension");const installedPath = () => NodePath.join(dataHome, "gnome-shell/extensions", GNOME_CAPTURE_UUID);beforeEach(async () => {  dataHome = await NodeFSP.mkdtemp(NodePath.join(NodeOS.tmpdir(), "t3-gnome-setup-test-"));});afterEach(async () => {  await NodeFSP.rm(dataHome, { recursive: true, force: true });}); function fixture(  options: {    state?: number;    version?: number;    shell?: string;    enabled?: boolean;    accepted?: boolean;    error?: string;  } = {},) {  const call = vi.fn(async (message: Message) => ({    body: [      message.member === "GetAll"        ? {            ShellVersion: { value: options.shell ?? "50.0" },            UserExtensionsEnabled: { value: options.enabled ?? true },          }        : message.member === "GetExtensionInfo"          ? {              ...(options.state === undefined ? {} : { state: { value: options.state } }),              ...(options.version === undefined ? {} : { version: { value: options.version } }),              error: { value: options.error ?? "" },            }          : (options.accepted ?? true),    ],  }));  const disconnect = vi.fn();  const bus = Object.assign(new NodeEvents.EventEmitter(), { call, disconnect });  return {    setup: new GnomeCaptureSetup({ bundle, dataHome }, bus as unknown as MessageBus),    call,    disconnect,    bus,  };} it("installs exactly the bundled payload offline and leaves other extensions alone", async () => {  const other = NodePath.join(dataHome, "gnome-shell/extensions/other@example");  await NodeFSP.mkdir(other, { recursive: true });  await NodeFSP.writeFile(NodePath.join(other, "keep.txt"), "keep");  await installGnomeCaptureBundle({ bundle, dataHome });  expect((await NodeFSP.readdir(installedPath())).sort()).toEqual([...GNOME_CAPTURE_FILES].sort());  for (const file of GNOME_CAPTURE_FILES) {    expect(await NodeFSP.readFile(NodePath.join(installedPath(), file))).toEqual(      await NodeFSP.readFile(NodePath.join(bundle, file)),    );  }  expect(await NodeFSP.readFile(NodePath.join(other, "keep.txt"), "utf8")).toBe("keep");}); it("preserves the replaced extension as a recoverable backup", async () => {  await installGnomeCaptureBundle({ bundle, dataHome });  await NodeFSP.writeFile(NodePath.join(installedPath(), "custom.txt"), "local change");  await installGnomeCaptureBundle({ bundle, dataHome });  const backups = NodePath.join(dataHome, "t3code/extension-backups");  const [backup] = await NodeFSP.readdir(backups);  expect(    await NodeFSP.readFile(      NodePath.join(backups, backup!, GNOME_CAPTURE_UUID, "custom.txt"),      "utf8",    ),  ).toBe("local change");}); it("does not damage an installed extension if a bundled file is missing", async () => {  await installGnomeCaptureBundle({ bundle, dataHome });  const incomplete = NodePath.join(dataHome, "incomplete");  await NodeFSP.mkdir(incomplete);  await NodeFSP.copyFile(    NodePath.join(bundle, "metadata.json"),    NodePath.join(incomplete, "metadata.json"),  );  await expect(installGnomeCaptureBundle({ bundle: incomplete, dataHome })).rejects.toThrow();  expect(await NodeFSP.readFile(NodePath.join(installedPath(), "extension.js"))).toEqual(    await NodeFSP.readFile(NodePath.join(bundle, "extension.js")),  );  expect(await NodeFSP.readdir(NodePath.dirname(installedPath()))).toEqual([GNOME_CAPTURE_UUID]);}); it("refuses to replace symlinks or downgrade a newer extension", async () => {  await NodeFSP.mkdir(NodePath.dirname(installedPath()), { recursive: true });  await NodeFSP.symlink(bundle, installedPath());  await expect(installGnomeCaptureBundle({ bundle, dataHome })).rejects.toThrow(    "regular directory",  );  await NodeFSP.unlink(installedPath());  await installGnomeCaptureBundle({ bundle, dataHome });  await NodeFSP.writeFile(    NodePath.join(installedPath(), "metadata.json"),    JSON.stringify({ uuid: GNOME_CAPTURE_UUID, version: 99, "shell-version": ["50"] }),  );  await expect(installGnomeCaptureBundle({ bundle, dataHome })).rejects.toThrow("newer extension");}); it.each([  [{}, "not-installed"],  [{ state: 2, version: 2 }, "disabled"],  [{ state: 1, version: 2 }, "enabled"],  [{ state: 1, version: 1 }, "update-required"],  [{ state: 2, version: 2, enabled: false }, "extensions-disabled"],  [{ state: 3, version: 2, error: "Load failed" }, "error"],  [{ shell: "51.0" }, "unsupported"],] as const)("reports GNOME setup state %j", async (options, status) => {  const { setup, call } = fixture(options);  expect((await setup.state()).status).toBe(status);  expect(call.mock.calls.map(([message]) => message.member).sort()).toEqual([    "GetAll",    "GetExtensionInfo",  ]);  setup.close();}); it("requires login for local installs and updates until the new version is loaded", async () => {  await installGnomeCaptureBundle({ bundle, dataHome });  for (const options of [{}, { state: 1, version: 1 }]) {    const { setup } = fixture(options);    expect((await setup.state()).status).toBe("restart-required");    setup.close();  }  const { setup } = fixture({ state: 2, version: 2 });  expect((await setup.state()).status).toBe("disabled");  setup.close();}); it("installs only on explicit action without invoking remote installation", async () => {  const { setup, call } = fixture();  await setup.perform("install-extension");  expect(await NodeFSP.readdir(installedPath())).toHaveLength(GNOME_CAPTURE_FILES.length);  expect(    call.mock.calls.every(([message]) => ["GetAll", "GetExtensionInfo"].includes(message.member)),  ).toBe(true);  setup.close();}); it("enables and disables only the capture UUID", async () => {  const { setup, call } = fixture({ state: 2, version: 2 });  await setup.perform("enable-extension");  await setup.perform("disable-extension");  for (const member of ["EnableExtension", "DisableExtension"]) {    expect(call.mock.calls.find(([message]) => message.member === member)?.[0]).toMatchObject({      destination: "org.gnome.Shell",      path: "/org/gnome/Shell",      signature: "s",      body: [GNOME_CAPTURE_UUID],    });  }  setup.close();}); it("never changes the global user-extensions preference", async () => {  const { setup, call } = fixture({ state: 2, version: 2, enabled: false });  await expect(setup.perform("enable-extension")).rejects.toThrow("GNOME has disabled");  expect(call.mock.calls.every(([message]) => message.member.startsWith("Get"))).toBe(true);  setup.close();}); it("surfaces desktop rejection and disconnect as actionable failures", async () => {  const { setup, bus } = fixture({ state: 2, version: 2, accepted: false });  await expect(setup.perform("enable-extension")).rejects.toThrow("Sign out");  bus.emit("error", new Error("Session bus disconnected"));  expect(await setup.state()).toEqual({ status: "error", message: "Session bus disconnected" });  setup.close();}); it("does not offer host extension installation in another desktop or sandbox", () => {  expect(isGnomeCaptureSession({ XDG_CURRENT_DESKTOP: "ubuntu:GNOME" })).toBe(true);  expect(isGnomeCaptureSession({ XDG_CURRENT_DESKTOP: "niri", GDMSESSION: "gnome" })).toBe(false);  expect(isGnomeCaptureSession({ XDG_CURRENT_DESKTOP: "GNOME", FLATPAK_ID: "com.t3" })).toBe(false);});