homeio

1import { readdirSync, readFileSync } from "node:fs";
2import { join } from "node:path";
3import { describe, expect, it } from "vitest";
4
5const REPO_ROOT = join(import.meta.dirname, "..", "..");
6const SOURCE_ROOTS = ["app", "components", "hooks", "lib", "modules"];
7const FEATURE_MODULES = [
8  "modules/apps",
9  "modules/files",
10  "modules/settings",
11  "modules/system",
12];
13const SOURCE_FILE_PATTERN = /\.(ts|tsx)$/;
14const CURRENT_TEST_FILE = join(
15  REPO_ROOT,
16  "modules",
17  "__tests__",
18  "architecture-boundaries.test.ts",
19);
20
21function isTestFile(filePath: string) {
22  return (
23    filePath.includes("/__tests__/") ||
24    filePath.endsWith(".test.ts") ||
25    filePath.endsWith(".test.tsx")
26  );
27}
28
29function listSourceFiles(root: string): string[] {
30  const entries = readdirSync(root, { withFileTypes: true });
31  const files: string[] = [];
32
33  for (const entry of entries) {
34    const entryPath = join(root, entry.name);
35
36    if (entry.isDirectory()) {
37      files.push(...listSourceFiles(entryPath));
38      continue;
39    }
40
41    if (SOURCE_FILE_PATTERN.test(entry.name)) {
42      files.push(entryPath);
43    }
44  }
45
46  return files;
47}
48
49function readImports(filePath: string): string {
50  return readFileSync(filePath, "utf8");
51}
52
53describe("module boundaries", () => {
54  it("does not import feature code from the legacy desktop bucket", () => {
55    const files = SOURCE_ROOTS
56      .flatMap((root) => listSourceFiles(join(REPO_ROOT, root)))
57      .filter((filePath) => filePath !== CURRENT_TEST_FILE);
58
59    const offenders = files.filter((filePath) =>
60      readImports(filePath).includes('from "@/components/desktop/')
61    );
62
63    expect(offenders).toEqual([]);
64  });
65
66  it("keeps feature modules independent from shell internals", () => {
67    const files = FEATURE_MODULES.flatMap((root) => listSourceFiles(join(REPO_ROOT, root)));
68
69    const offenders = files.filter((filePath) =>
70      readImports(filePath).includes('from "@/modules/shell/')
71    );
72
73    expect(offenders).toEqual([]);
74  });
75
76  it("keeps feature-owned hooks out of the top-level hooks bucket", () => {
77    const files = SOURCE_ROOTS
78      .flatMap((root) => listSourceFiles(join(REPO_ROOT, root)))
79      .filter((filePath) => filePath !== CURRENT_TEST_FILE);
80
81    const offenders = files.filter((filePath) => {
82      const source = readImports(filePath);
83
84      return (
85        source.includes('from "@/hooks/useInstalledApps"') ||
86        source.includes('from "@/hooks/useStoreActions"') ||
87        source.includes('from "@/hooks/useStoreApp"') ||
88        source.includes('from "@/hooks/useStoreCatalog"') ||
89        source.includes('from "@/hooks/useStoreOperation"') ||
90        source.includes('from "@/hooks/useFiles"') ||
91        source.includes('from "@/hooks/useLocalFolderShares"') ||
92        source.includes('from "@/hooks/useNetworkShares"') ||
93        source.includes('from "@/hooks/useTrashActions"') ||
94        source.includes('from "@/hooks/useSettingsBackend"') ||
95        source.includes('from "@/hooks/useDesktopAppearance"') ||
96        source.includes('from "@/hooks/useRebootRecovery"') ||
97        source.includes('from "@/hooks/useTerminalCommand"') ||
98        source.includes('from "@/hooks/useCurrentWeather"') ||
99        source.includes('from "@/hooks/useDockerInfo"') ||
100        source.includes('from "@/hooks/useDockerStats"') ||
101        source.includes('from "@/hooks/useNetworkActions"') ||
102        source.includes('from "@/hooks/useNetworkEventsSse"') ||
103        source.includes('from "@/hooks/useNetworkStatus"') ||
104        source.includes('from "@/hooks/useSystemMetrics"') ||
105        source.includes('from "@/hooks/useSystemSse"') ||
106        source.includes('from "@/hooks/useSystemUpdateStatus"') ||
107        source.includes('from "@/hooks/useUserLocation"') ||
108        source.includes('from "@/hooks/useWifiNetworks"')
109      );
110    });
111
112    expect(offenders).toEqual([]);
113  });
114
115  it("keeps feature modules independent from app api routes", () => {
116    const files = FEATURE_MODULES
117      .flatMap((root) => listSourceFiles(join(REPO_ROOT, root)))
118      .filter((filePath) => !isTestFile(filePath));
119
120    const offenders = files.filter((filePath) => readImports(filePath).includes('from "@/app/api/'));
121
122    expect(offenders).toEqual([]);
123  });
124
125  it("keeps app api routes away from feature ui modules", () => {
126    const files = listSourceFiles(join(REPO_ROOT, "app", "api")).filter(
127      (filePath) => !isTestFile(filePath),
128    );
129
130    const offenders = files.filter((filePath) =>
131      readImports(filePath).includes('from "@/modules/'),
132    );
133
134    expect(offenders).toEqual([]);
135  });
136
137  it("keeps components/desktop limited to tests during the migration", () => {
138    const desktopRoot = join(REPO_ROOT, "components", "desktop");
139    const offenders = listSourceFiles(desktopRoot).filter(
140      (filePath) =>
141        !filePath.includes("/__tests__/") &&
142        !filePath.endsWith(".test.ts") &&
143        !filePath.endsWith(".test.tsx"),
144    );
145
146    expect(offenders).toEqual([]);
147  });
148
149  /**
150   * api/v1 routes that are intentionally exempt from requireApiSession.
151   * Currently limited to the Google Drive OAuth handshake: the browser is
152   * redirected through Google, and Google's redirect back to /callback may
153   * arrive without the homeio session cookie depending on SameSite behaviour.
154   * The allowlist must only ever shrink — never grow.
155   */
156  const V1_AUTH_ALLOWLIST = new Set<string>([
157    "app/api/v1/files/google-drive/auth/route.ts",
158    "app/api/v1/files/google-drive/callback/route.ts",
159  ]);
160
161  const HTTP_HANDLER_PATTERN =
162    /export\s+(?:async\s+)?function\s+(GET|POST|PUT|PATCH|DELETE)\s*\(/;
163
164  it("requires requireApiSession in every new app/api/v1/** route handler", () => {
165    const v1Root = join(REPO_ROOT, "app", "api", "v1");
166    const routeFiles = listSourceFiles(v1Root)
167      .filter((filePath) => !isTestFile(filePath))
168      .filter((filePath) => filePath.endsWith("/route.ts"));
169
170    const offenders: string[] = [];
171    const staleAllowlistEntries: string[] = [];
172
173    for (const filePath of routeFiles) {
174      const source = readImports(filePath);
175      if (!HTTP_HANDLER_PATTERN.test(source)) continue;
176
177      const relativePath = filePath.slice(REPO_ROOT.length + 1);
178      const hasAuth = source.includes("requireApiSession");
179      const allowlisted = V1_AUTH_ALLOWLIST.has(relativePath);
180
181      if (!hasAuth && !allowlisted) {
182        offenders.push(relativePath);
183      }
184      if (hasAuth && allowlisted) {
185        // A previously-unauthenticated route now calls requireApiSession;
186        // remove it from V1_AUTH_ALLOWLIST so the snapshot keeps shrinking.
187        staleAllowlistEntries.push(relativePath);
188      }
189    }
190
191    expect(offenders, "new v1 routes must call requireApiSession").toEqual([]);
192    expect(
193      staleAllowlistEntries,
194      "remove these from V1_AUTH_ALLOWLIST — they now authenticate",
195    ).toEqual([]);
196  });
197});
198