trilium/spec/support/etapi.ts

import child_process from "child_process";
import kill from "tree-kill";

let etapiAuthToken: string | undefined;

const getEtapiAuthorizationHeader = (): string =>
  "Basic " + Buffer.from(`etapi:${etapiAuthToken}`).toString("base64");

const PORT: string = "9999";
const HOST: string = "http://localhost:" + PORT;

type SpecDefinitionsFunc = () => void;

function describeEtapi(
  description: string,
  specDefinitions: SpecDefinitionsFunc
): void {
  describe(description, () => {
    let appProcess: ReturnType<typeof child_process.spawn>;

    beforeAll(async () => {
      appProcess = child_process.spawn("npm", ["run", "start-test-server"]);
      if (!appProcess) {
        throw new Error("Failed to start the Trilium process.");
      }

      await new Promise<void>((res) => {
        appProcess.stdout!.on("data", (data) => {
          console.log("Trilium: " + data.toString().trim());

          if (data.toString().includes("Listening on port")) {
            res();
          }
        });
      });

      await fetch(`${HOST}/api/setup/new-document`, { method: "POST" });

      const formData = new URLSearchParams();
      formData.append("password1", "1234");
      formData.append("password2", "1234");

      await fetch(`${HOST}/set-password`, { method: "POST", body: formData });

      etapiAuthToken = (
        await (
          await fetch(`${HOST}/etapi/auth/login`, {
            method: "POST",
            headers: {
              "Content-Type": "application/json",
            },
            body: JSON.stringify({ password: "1234" }),
          })
        ).json()
      ).authToken;
    });

    afterAll(() => {
      console.log(
        "Attempting to kill the Trilium process as part of the cleanup..."
      );
      if (!appProcess.pid) {
        console.log("Trilium process not found. Cannot kill.");
        return;
      }

      kill(appProcess.pid, "SIGKILL", (error) => {
        if (error) {
          console.error("Failed to kill the Trilium process.", error);
        }
        console.log("Trilium process killed.");
      });
    });

    specDefinitions();
  });
}

async function getEtapiResponse(url: string): Promise<Response> {
  return await fetch(`${HOST}/etapi/${url}`, {
    method: "GET",
    headers: {
      Authorization: getEtapiAuthorizationHeader(),
    },
  });
}

async function getEtapi(url: string): Promise<any> {
  const response = await getEtapiResponse(url);
  return await processEtapiResponse(response);
}

async function getEtapiContent(url: string): Promise<Response> {
  const response = await fetch(`${HOST}/etapi/${url}`, {
    method: "GET",
    headers: {
      Authorization: getEtapiAuthorizationHeader(),
    },
  });

  checkStatus(response);

  return response;
}

async function postEtapi(
  url: string,
  data: Record<string, unknown> = {}
): Promise<any> {
  const response = await fetch(`${HOST}/etapi/${url}`, {
    method: "POST",
    headers: {
      "Content-Type": "application/json",
      Authorization: getEtapiAuthorizationHeader(),
    },
    body: JSON.stringify(data),
  });
  return await processEtapiResponse(response);
}

async function postEtapiContent(
  url: string,
  data: BodyInit
): Promise<Response> {
  const response = await fetch(`${HOST}/etapi/${url}`, {
    method: "POST",
    headers: {
      "Content-Type": "application/octet-stream",
      Authorization: getEtapiAuthorizationHeader(),
    },
    body: data,
  });

  checkStatus(response);

  return response;
}

async function putEtapi(
  url: string,
  data: Record<string, unknown> = {}
): Promise<any> {
  const response = await fetch(`${HOST}/etapi/${url}`, {
    method: "PUT",
    headers: {
      "Content-Type": "application/json",
      Authorization: getEtapiAuthorizationHeader(),
    },
    body: JSON.stringify(data),
  });
  return await processEtapiResponse(response);
}

async function putEtapiContent(
  url: string,
  data?: BodyInit
): Promise<Response> {
  const response = await fetch(`${HOST}/etapi/${url}`, {
    method: "PUT",
    headers: {
      "Content-Type": "application/octet-stream",
      Authorization: getEtapiAuthorizationHeader(),
    },
    body: data,
  });

  checkStatus(response);

  return response;
}

async function patchEtapi(
  url: string,
  data: Record<string, unknown> = {}
): Promise<any> {
  const response = await fetch(`${HOST}/etapi/${url}`, {
    method: "PATCH",
    headers: {
      "Content-Type": "application/json",
      Authorization: getEtapiAuthorizationHeader(),
    },
    body: JSON.stringify(data),
  });
  return await processEtapiResponse(response);
}

async function deleteEtapi(url: string): Promise<any> {
  const response = await fetch(`${HOST}/etapi/${url}`, {
    method: "DELETE",
    headers: {
      Authorization: getEtapiAuthorizationHeader(),
    },
  });
  return await processEtapiResponse(response);
}

async function processEtapiResponse(response: Response): Promise<any> {
  const text = await response.text();

  if (response.status < 200 || response.status >= 300) {
    throw new Error(`ETAPI error ${response.status}: ${text}`);
  }

  return text?.trim() ? JSON.parse(text) : null;
}

function checkStatus(response: Response): void {
  if (response.status < 200 || response.status >= 300) {
    throw new Error(`ETAPI error ${response.status}`);
  }
}

export {
  describeEtapi,
  getEtapi,
  getEtapiResponse,
  getEtapiContent,
  postEtapi,
  postEtapiContent,
  putEtapi,
  putEtapiContent,
  patchEtapi,
  deleteEtapi,
};