Skip to content

Build your personal knowledge base with Trilium Notes

1.9 KB
Raw Blame
import type { Application } from "express";
import supertest from "supertest";
import { beforeAll, describe, expect, it } from "vitest";

import buildApp from "../../src/app.js";
import sql from "../../src/services/sql.js";
import { createNote, login } from "./utils.js";

let app: Application;
let token: string;

/**
 * ETAPI opens a CLS context per request and stamps it with the "etapi" componentId. That stamp
 * lands on every entity change the request produces, which is how the frontend update message
 * tells an external write apart from one the client made itself.
 */
describe("etapi/cls-context", () => {
    beforeAll(async () => {
        app = await buildApp();
        token = await login(app);
    });

    it("stamps every entity change of an ETAPI write with the etapi componentId", async () => {
        const noteId = await createNote(app, token);

        const componentIds = sql.getColumn<string>(
            `SELECT DISTINCT componentId FROM entity_changes
             WHERE (entityName = 'notes' AND entityId = ?)
                OR (entityName = 'branches' AND entityId LIKE ?)`,
            [noteId, `%${noteId}`]
        );

        expect(componentIds).toEqual(["etapi"]);
    });

    it("does not carry a context over from a request that failed", async () => {
        const failed = await supertest(app)
            .post("/etapi/create-note")
            .auth("etapi", token, { type: "basic" })
            .send({ parentNoteId: "root", title: "Bad", type: "text" });
        expect(failed.status).toBeGreaterThanOrEqual(400);

        // The next write still gets its own context, rather than the failed one or none at all.
        const noteId = await createNote(app, token);
        const componentId = sql.getValue<string>(
            "SELECT componentId FROM entity_changes WHERE entityName = 'notes' AND entityId = ?",
            [noteId]
        );

        expect(componentId).toBe("etapi");
    });
});