homeio

1import { mkdtemp, mkdir, writeFile } from "node:fs/promises";
2import type * as FsPromises from "node:fs/promises";
3import os from "node:os";
4import path from "node:path";
5import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
6
7vi.mock("@/lib/server/modules/store/catalog-config", () => ({
8  OFFICIAL_STORE_SOURCE_ID: "official-casaos",
9  readStoreCatalogConfig: vi.fn(),
10  readStoreCatalogSources: vi.fn(),
11  resolveStoreCatalogsRoot: vi.fn(() => "/tmp"),
12  writeStoreCatalogConfig: vi.fn(),
13  writeStoreCatalogSources: vi.fn(),
14}));
15
16vi.mock("@/lib/server/storage/data-root", () => ({
17  ensureDataRootDirectories: vi.fn(),
18}));
19
20vi.mock("node:fs/promises", async () => {
21  const actual = await vi.importActual<typeof FsPromises>("node:fs/promises");
22  return { ...actual, stat: vi.fn(actual.stat) };
23});
24
25import {
26  readStoreCatalogConfig,
27  readStoreCatalogSources,
28  writeStoreCatalogConfig,
29} from "@/lib/server/modules/store/catalog-config";
30import { ensureDataRootDirectories } from "@/lib/server/storage/data-root";
31
32describe("store catalog", () => {
33  let repoRoot = "";
34
35  beforeEach(async () => {
36    vi.resetModules();
37    repoRoot = await mkdtemp(path.join(os.tmpdir(), "casaos-catalog-"));
38    await mkdir(path.join(repoRoot, "Apps", "AdGuardHome"), { recursive: true });
39    await writeFile(
40      path.join(repoRoot, "Apps", "AdGuardHome", "docker-compose.yml"),
41      `name: adguardhome
42services:
43  adguardhome:
44    image: adguard/adguardhome:v1
45    ports:
46      - "3001:3000"
47x-casaos:
48  main: adguardhome
49  category: Network
50  title:
51    en_us: AdGuard Home
52  description:
53    en_us: Network DNS blocker
54  icon: https://example.com/logo.png
55  screenshot_link:
56    - https://example.com/screenshot.png
57  tips:
58    before_install:
59      en_us: Read this first
60  scheme: http
61  index: /
62  port_map: "3001"
63`,
64      "utf8",
65    );
66    await writeFile(
67      path.join(repoRoot, "category-list.json"),
68      JSON.stringify([{ name: "Network", description: "Network apps" }]),
69      "utf8",
70    );
71    await writeFile(
72      path.join(repoRoot, "featured-apps.json"),
73      JSON.stringify([{ appid: "adguardhome" }]),
74      "utf8",
75    );
76    await writeFile(
77      path.join(repoRoot, "recommend-list.json"),
78      JSON.stringify([{ appid: "adguardhome" }]),
79      "utf8",
80    );
81    vi.mocked(readStoreCatalogConfig).mockResolvedValue({
82      defaultCatalogPath: repoRoot,
83      repoUrl: "https://github.com/IceWhaleTech/CasaOS-AppStore",
84      updatedAt: new Date().toISOString(),
85    });
86    vi.mocked(readStoreCatalogSources).mockResolvedValue([
87      {
88        id: "official-casaos",
89        name: "Official CasaOS",
90        url: "https://github.com/IceWhaleTech/CasaOS-AppStore",
91        kind: "official",
92        enabled: true,
93        status: "ready",
94        sourcePath: repoRoot,
95        suppressedAppIds: [],
96        addedAt: new Date().toISOString(),
97        updatedAt: new Date().toISOString(),
98        lastSyncedAt: new Date().toISOString(),
99        lastError: null,
100      },
101    ]);
102  });
103
104  afterEach(() => {
105    vi.clearAllMocks();
106  });
107
108  it("indexes CasaOS compose apps from the local catalog checkout", async () => {
109    const { getStoreCatalogSnapshot } = await import("@/lib/server/modules/store/catalog");
110    const snapshot = await getStoreCatalogSnapshot({ bypassCache: true });
111
112    expect(ensureDataRootDirectories).toHaveBeenCalled();
113    expect(snapshot.apps).toHaveLength(1);
114    expect(snapshot.apps[0]).toMatchObject({
115      appId: "adguardhome",
116      name: "AdGuard Home",
117      description: "Network DNS blocker",
118      categories: ["Network"],
119      repositoryUrl: "https://github.com/IceWhaleTech/CasaOS-AppStore",
120      stackFile: "Apps/AdGuardHome/docker-compose.yml",
121      port: 3001,
122      screenshots: ["https://example.com/screenshot.png"],
123    });
124    expect(snapshot.categories).toEqual([
125      {
126        id: "network",
127        name: "Network",
128        description: "Network apps",
129        appCount: 1,
130      },
131    ]);
132    expect(snapshot.featuredAppIds).toEqual(["adguardhome"]);
133    expect(snapshot.recommendedAppIds).toEqual(["adguardhome"]);
134    expect(snapshot.sources).toHaveLength(1);
135    expect(snapshot.apps[0]).toMatchObject({
136      sourceId: "official-casaos",
137      sourceKind: "official",
138      sourceName: "Official CasaOS",
139    });
140  });
141
142  it("does not re-stat the catalog on every request", async () => {
143    // buildSignature stats one file per app. Doing that per request pegged the
144    // CPU on real catalogs (~1000 apps) — every App Store search keystroke
145    // walked the whole store before the cache was even consulted.
146    const { getStoreCatalogSnapshot } = await import("@/lib/server/modules/store/catalog");
147    const { stat } = await import("node:fs/promises");
148
149    await getStoreCatalogSnapshot();
150    const statCallsAfterFirst = vi.mocked(stat).mock.calls.length;
151    expect(statCallsAfterFirst).toBeGreaterThan(0);
152
153    await getStoreCatalogSnapshot();
154    expect(vi.mocked(stat).mock.calls.length).toBe(statCallsAfterFirst);
155  });
156
157  it("does not rewrite the catalog registry on every store request", async () => {
158    // Each write takes the registry lock: store requests used to queue behind each other.
159    const { getStoreCatalogSnapshot } = await import("@/lib/server/modules/store/catalog");
160
161    await getStoreCatalogSnapshot();
162    await getStoreCatalogSnapshot();
163
164    expect(writeStoreCatalogConfig).not.toHaveBeenCalled();
165  });
166
167  it("records the catalog when its location changed", async () => {
168    vi.mocked(readStoreCatalogConfig).mockResolvedValue({
169      defaultCatalogPath: "/somewhere/else",
170      repoUrl: "https://github.com/IceWhaleTech/CasaOS-AppStore",
171      updatedAt: new Date().toISOString(),
172    });
173    const { getStoreCatalogSnapshot } = await import("@/lib/server/modules/store/catalog");
174
175    await getStoreCatalogSnapshot();
176
177    expect(writeStoreCatalogConfig).toHaveBeenCalledWith({
178      defaultCatalogPath: repoRoot,
179      repoUrl: "https://github.com/IceWhaleTech/CasaOS-AppStore",
180    });
181  });
182
183  it("shares one revalidation between requests arriving together", async () => {
184    vi.useFakeTimers();
185
186    try {
187      const { getStoreCatalogSnapshot } = await import("@/lib/server/modules/store/catalog");
188      const { stat } = await import("node:fs/promises");
189
190      await getStoreCatalogSnapshot();
191      const statsPerRevalidation = vi.mocked(stat).mock.calls.length;
192      vi.advanceTimersByTime(31_000);
193
194      const before = vi.mocked(stat).mock.calls.length;
195      await Promise.all(Array.from({ length: 5 }, () => getStoreCatalogSnapshot()));
196
197      expect(vi.mocked(stat).mock.calls.length - before).toBeLessThanOrEqual(statsPerRevalidation);
198    } finally {
199      vi.useRealTimers();
200    }
201  });
202
203  it("still picks up on-disk changes once the revalidation window elapses", async () => {
204    vi.useFakeTimers();
205
206    try {
207      const { getStoreCatalogSnapshot } = await import("@/lib/server/modules/store/catalog");
208
209      const first = await getStoreCatalogSnapshot();
210      expect(first.apps).toHaveLength(1);
211
212      await mkdir(path.join(repoRoot, "Apps", "Jellyfin"), { recursive: true });
213      await writeFile(
214        path.join(repoRoot, "Apps", "Jellyfin", "docker-compose.yml"),
215        `name: jellyfin
216services:
217  jellyfin:
218    image: jellyfin/jellyfin:v1
219x-casaos:
220  main: jellyfin
221  category: Media
222  title:
223    en_us: Jellyfin
224  description:
225    en_us: Media server
226  icon: https://example.com/jellyfin.png
227  scheme: http
228  index: /
229  port_map: "8096"
230`,
231        "utf8",
232      );
233
234      // Still cached — the new app must not appear yet.
235      expect((await getStoreCatalogSnapshot()).apps).toHaveLength(1);
236
237      vi.advanceTimersByTime(31_000);
238      expect((await getStoreCatalogSnapshot()).apps).toHaveLength(2);
239    } finally {
240      vi.useRealTimers();
241    }
242  });
243});
244