Self-hosted, plugin-based server management.
TypeScript dockerhomelabpluginsrdpremote-desktopself-hostedserver-managementsftpsshterminaltermixvnc
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
const state = vi.hoisted(() => ({ electron: false }));
const axiosMethods = vi.hoisted(() => ({
get: vi.fn(),
postForm: vi.fn(),
}));
vi.mock("@/main-axios", () => ({
authApi: {
defaults: { baseURL: "http://server:8080/" },
...axiosMethods,
},
createRemoteOriginApiInstance: vi.fn(),
}));
vi.mock("@/lib/electron", () => ({ isElectron: () => state.electron }));
vi.mock("@/lib/device-id", () => ({ getDeviceId: () => "device-1" }));
vi.mock("@/lib/base-path", () => ({ getBasePath: () => "" }));
import {
createPluginApi,
pluginFetch,
pluginWsUrl,
} from "@/lib/plugin-transport";
const fetchMock = vi.fn(async () => new Response("ok"));
beforeEach(() => {
state.electron = false;
fetchMock.mockClear();
vi.stubGlobal("fetch", fetchMock);
});
afterEach(() => {
vi.unstubAllGlobals();
localStorage.clear();
});
describe("pluginFetch", () => {
it("fetches the plugin's own mount point with the session cookie", async () => {
await pluginFetch("ai", "chat/stream", {
method: "POST",
headers: { "Content-Type": "application/json" },
body: "{}",
});
const [url, init] = fetchMock.mock.calls[0] as unknown as [
string,
RequestInit,
];
expect(url).toBe("http://server:8080/plugin-api/ai/chat/stream");
expect(init.credentials).toBe("include");
expect(init.method).toBe("POST");
const headers = init.headers as Headers;
expect(headers.get("content-type")).toBe("application/json");
expect(headers.get("x-termix-device-id")).toBe("device-1");
expect(headers.get("authorization")).toBeNull();
});
it("sends the stored token in the desktop app, like the shared client", async () => {
state.electron = true;
localStorage.setItem("jwt", "token-1");
await pluginFetch("ai", "/status");
const [url, init] = fetchMock.mock.calls[0] as unknown as [
string,
RequestInit,
];
expect(url).toBe("http://server:8080/plugin-api/ai/status");
const headers = init.headers as Headers;
expect(headers.get("x-electron-app")).toBe("true");
expect(headers.get("authorization")).toBe("Bearer token-1");
});
});
describe("createPluginApi", () => {
it("puts the plugin's mount point in front of request and form paths", () => {
const api = createPluginApi("file-manager");
const form = new FormData();
api.get("/listFiles");
api.postForm("uploadFileStream", form);
expect(axiosMethods.get).toHaveBeenCalledWith(
"/plugin-api/file-manager/listFiles",
);
expect(axiosMethods.postForm).toHaveBeenCalledWith(
"/plugin-api/file-manager/uploadFileStream",
form,
);
});
});
describe("pluginWsUrl in the browser", () => {
it("sends a socket ticket, since the cookie can fail behind a proxy", async () => {
fetchMock.mockResolvedValueOnce(
new Response(JSON.stringify({ ticket: "ticket-1" })),
);
const target = await pluginWsUrl("ssh-terminal", "/terminal");
const [url, init] = fetchMock.mock.calls[0] as unknown as [
string,
RequestInit,
];
expect(url).toBe("http://server:8080/users/ws-ticket");
expect(init.method).toBe("POST");
expect(init.credentials).toBe("include");
expect(target?.url).toBe(
`ws://${window.location.host}/plugin-ws/ssh-terminal/terminal`,
);
expect(target?.protocols).toEqual(["termix.jwt.ticket-1"]);
});
it("goes through the Vite proxy in dev on any port", async () => {
vi.stubEnv("NODE_ENV", "development");
try {
fetchMock.mockResolvedValueOnce(
new Response(JSON.stringify({ ticket: "ticket-1" })),
);
const target = await pluginWsUrl("ssh-terminal", "/terminal");
expect(target?.url).toBe(
`ws://${window.location.host}/__termix_api/30001/plugin-ws/ssh-terminal/terminal`,
);
} finally {
vi.unstubAllEnvs();
}
});
it("falls back to the cookie alone for a guest", async () => {
fetchMock.mockResolvedValueOnce(new Response("{}", { status: 401 }));
const target = await pluginWsUrl("ssh-terminal", "/terminal");
expect(target?.protocols).toEqual([]);
});
it("falls back when the server is older and has no ticket route", async () => {
fetchMock.mockRejectedValueOnce(new Error("offline"));
const target = await pluginWsUrl("ssh-terminal", "/terminal");
expect(target?.protocols).toEqual([]);
});
});