homeio

1import { readFile } from "node:fs/promises";
2import path from "node:path";
3import { describe, expect, it } from "vitest";
4import { NGINX_UPSTREAM_KEEPALIVE_MS } from "@/lib/server/http/keep-alive";
5
6async function readScript(scriptName: string) {
7  return readFile(path.join(process.cwd(), "scripts", scriptName), "utf8");
8}
9
10describe("reverse proxy scripts", () => {
11  it.each(["install.sh", "update.sh"])(
12    "%s keeps nginx's upstream keep-alive shorter than Homeio's",
13    async (scriptName) => {
14      const script = await readScript(scriptName);
15
16      // lib/server/http/keep-alive.ts relies on this value: Homeio must be the
17      // side that keeps idle connections longer, or visitors get 502s.
18      expect(script).toContain(`keepalive_timeout ${NGINX_UPSTREAM_KEEPALIVE_MS / 1000}s;`);
19      // A pool too small makes nginx open a new connection per request under load.
20      expect(script).toContain("keepalive 128;");
21    },
22  );
23
24  it.each(["install.sh", "update.sh"])(
25    "%s raises nginx's connection limits before testing the config",
26    async (scriptName) => {
27      const script = await readScript(scriptName);
28
29      expect(script).toContain("tune_nginx_limits() {");
30      expect(script).toContain("local worker_connections=4096");
31      expect(script).toMatch(/\ttune_nginx_limits\n\tnginx -t\n/);
32    },
33  );
34
35  it.each(["install.sh", "update.sh"])(
36    "%s makes nginx ask Homeio before streaming an upload",
37    async (scriptName) => {
38      const script = await readScript(scriptName);
39      const uploadLocation = script.slice(script.indexOf("location = /api/v1/files/upload {"));
40
41      // The Go upload server never sees the middleware: without this check a
42      // demo visitor could write files, and a logged-out cookie kept uploading.
43      expect(uploadLocation.slice(0, uploadLocation.indexOf("}"))).toContain(
44        "auth_request /__homeio_upload_authorize;",
45      );
46      expect(script).toContain("proxy_pass http://homeio_backend/api/v1/files/upload/authorize;");
47      expect(script).toContain("proxy_pass_request_body off;");
48    },
49  );
50
51  it.each(["install.sh", "update.sh"])(
52    "%s gives the upload socket a runtime directory of its own",
53    async (scriptName) => {
54      const script = await readScript(scriptName);
55      const goServer = await readFile(path.join(process.cwd(), "services/upload-server/main.go"), "utf8");
56      const socket = "/run/home-server-upload/upload.sock";
57
58      // Shared with the DBus helper, the directory took whichever mode started
59      // last and vanished whenever either service stopped.
60      expect(script).toContain("RuntimeDirectory=home-server-upload");
61      expect(script).toContain(`Environment=UPLOAD_SERVER_ADDR=${socket}`);
62      expect(script).toContain(`proxy_pass http://unix:${socket}:/upload;`);
63      expect(goServer).toContain(`"${socket}"`);
64    },
65  );
66});
67