@futo-org/backups-orchestrator-api 0.23.1 → 0.25.0

package/dist/wellKnown.d.ts

@@ -0,0 +1,79 @@
+import { z } from 'zod';
+declare const metaConfigSchema: z.ZodObject<{
+    restic_pack_size_mib: z.ZodOptional<z.ZodNumber>;
+    connections_math: z.ZodOptional<z.ZodString>;
+}, z.core.$strict>;
+declare const metaClusterSchema: z.ZodObject<{
+    code: z.ZodString;
+    display_name: z.ZodString;
+    cluster_config: z.ZodObject<{
+        restic_pack_size_mib: z.ZodOptional<z.ZodNumber>;
+        connections_math: z.ZodOptional<z.ZodString>;
+    }, z.core.$strict>;
+}, z.core.$strict>;
+declare const metaSiteSchema: z.ZodObject<{
+    code: z.ZodString;
+    display_name: z.ZodString;
+    description: z.ZodString;
+    rest_url: z.ZodURL;
+    default_cluster: z.ZodString;
+    site_config: z.ZodObject<{
+        restic_pack_size_mib: z.ZodOptional<z.ZodNumber>;
+        connections_math: z.ZodOptional<z.ZodString>;
+    }, z.core.$strict>;
+    clusters: z.ZodArray<z.ZodObject<{
+        code: z.ZodString;
+        display_name: z.ZodString;
+        cluster_config: z.ZodObject<{
+            restic_pack_size_mib: z.ZodOptional<z.ZodNumber>;
+            connections_math: z.ZodOptional<z.ZodString>;
+        }, z.core.$strict>;
+    }, z.core.$strict>>;
+}, z.core.$strict>;
+declare const metaSchema: z.ZodObject<{
+    api_root: z.ZodURL;
+    config: z.ZodObject<{
+        restic_pack_size_mib: z.ZodOptional<z.ZodNumber>;
+        connections_math: z.ZodOptional<z.ZodString>;
+    }, z.core.$strict>;
+    default_site: z.ZodString;
+    sites: z.ZodArray<z.ZodObject<{
+        code: z.ZodString;
+        display_name: z.ZodString;
+        description: z.ZodString;
+        rest_url: z.ZodURL;
+        default_cluster: z.ZodString;
+        site_config: z.ZodObject<{
+            restic_pack_size_mib: z.ZodOptional<z.ZodNumber>;
+            connections_math: z.ZodOptional<z.ZodString>;
+        }, z.core.$strict>;
+        clusters: z.ZodArray<z.ZodObject<{
+            code: z.ZodString;
+            display_name: z.ZodString;
+            cluster_config: z.ZodObject<{
+                restic_pack_size_mib: z.ZodOptional<z.ZodNumber>;
+                connections_math: z.ZodOptional<z.ZodString>;
+            }, z.core.$strict>;
+        }, z.core.$strict>>;
+    }, z.core.$strict>>;
+}, z.core.$strict>;
+export type MetaConfig = z.infer<typeof metaConfigSchema>;
+export type MetaCluster = z.infer<typeof metaClusterSchema>;
+export type MetaSite = z.infer<typeof metaSiteSchema>;
+export type Meta = z.infer<typeof metaSchema>;
+export declare class YuccaWellKnown {
+    private url;
+    private data?;
+    private fetchedAt;
+    private lastError?;
+    private failedAt;
+    configure(url?: string): void;
+    get(): Promise<Meta>;
+    getBaseUrl(): Promise<string>;
+    getSites(): Promise<MetaSite[]>;
+    getConfig(siteCode?: string, clusterCode?: string): Promise<MetaConfig>;
+    getConnections(cores: number, siteCode?: string, clusterCode?: string): Promise<number | undefined>;
+    getPackSizeMib(siteCode?: string, clusterCode?: string): Promise<number | undefined>;
+}
+export declare const yuccaWellKnown: YuccaWellKnown;
+export {};

package/dist/wellKnown.js

@@ -0,0 +1,163 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.yuccaWellKnown = exports.YuccaWellKnown = void 0;
+const zod_1 = require("zod");
+const const_1 = require("./const");
+const connectionsMath_1 = require("./utils/connectionsMath");
+const metaConfigSchema = zod_1.z
+    .object({
+    restic_pack_size_mib: zod_1.z.number().int().min(1).max(128).optional(),
+    connections_math: zod_1.z.string().optional(),
+})
+    .strict();
+const metaClusterSchema = zod_1.z
+    .object({
+    code: zod_1.z.string().min(1),
+    display_name: zod_1.z.string().min(1),
+    cluster_config: metaConfigSchema,
+})
+    .strict();
+const metaSiteSchema = zod_1.z
+    .object({
+    code: zod_1.z.string().min(1),
+    display_name: zod_1.z.string().min(1),
+    description: zod_1.z.string(),
+    rest_url: zod_1.z.url(),
+    default_cluster: zod_1.z.string().min(1),
+    site_config: metaConfigSchema,
+    clusters: zod_1.z.array(metaClusterSchema).min(1),
+})
+    .strict();
+const metaSchema = zod_1.z
+    .object({
+    api_root: zod_1.z.url(),
+    config: metaConfigSchema,
+    default_site: zod_1.z.string().min(1),
+    sites: zod_1.z.array(metaSiteSchema).min(1),
+})
+    .strict()
+    .superRefine((meta, ctx) => {
+    if (!meta.sites.some((site) => site.code === meta.default_site)) {
+        ctx.addIssue({ code: 'custom', message: `default_site '${meta.default_site}' is not declared` });
+    }
+    for (const site of meta.sites) {
+        if (!site.clusters.some((cluster) => cluster.code === site.default_cluster)) {
+            ctx.addIssue({
+                code: 'custom',
+                message: `Site '${site.code}' default_cluster '${site.default_cluster}' is not declared`,
+            });
+        }
+    }
+});
+const pointerSchema = zod_1.z.object({ meta_url: zod_1.z.url() }).strict();
+const META_CACHE_TTL = 5 * 60 * 1000;
+const FAILURE_CACHE_TTL = 60 * 1000;
+const FETCH_TIMEOUT = 8000;
+class UnknownTopologyCodeError extends Error {
+}
+const fetchValidated = async (url, schema) => {
+    const response = await fetch(url, { signal: AbortSignal.timeout(FETCH_TIMEOUT) });
+    if (!response.ok) {
+        throw new Error(`GET ${url} failed with HTTP ${response.status}`);
+    }
+    return schema.parse(await response.json());
+};
+class YuccaWellKnown {
+    url = const_1.YUCCA_WELL_KNOWN;
+    data;
+    fetchedAt = 0;
+    lastError;
+    failedAt = 0;
+    configure(url) {
+        this.url = url ?? const_1.YUCCA_WELL_KNOWN;
+        this.data = undefined;
+        this.fetchedAt = 0;
+        this.lastError = undefined;
+        this.failedAt = 0;
+    }
+    async get() {
+        const fresh = Date.now() - this.fetchedAt < META_CACHE_TTL;
+        const failedRecently = this.lastError !== undefined && Date.now() - this.failedAt < FAILURE_CACHE_TTL;
+        if (this.data && (fresh || failedRecently)) {
+            return this.data;
+        }
+        if (!this.data && failedRecently) {
+            throw this.lastError;
+        }
+        try {
+            const pointer = await fetchValidated(this.url, pointerSchema);
+            const next = await fetchValidated(pointer.meta_url, metaSchema);
+            this.data = next;
+            this.fetchedAt = Date.now();
+            this.lastError = undefined;
+            return next;
+        }
+        catch (error) {
+            this.lastError = error;
+            this.failedAt = Date.now();
+            if (this.data) {
+                return this.data;
+            }
+            throw error;
+        }
+    }
+    async getBaseUrl() {
+        const meta = await this.get();
+        return meta.api_root.replace(/\/api\/?$/, '');
+    }
+    async getSites() {
+        const meta = await this.get();
+        return meta.sites;
+    }
+    async getConfig(siteCode, clusterCode) {
+        const meta = await this.get();
+        if (!siteCode) {
+            if (clusterCode) {
+                throw new UnknownTopologyCodeError(`Cluster '${clusterCode}' was provided without a site`);
+            }
+            return { ...meta.config };
+        }
+        const site = meta.sites.find((candidate) => candidate.code === siteCode);
+        if (!site) {
+            throw new UnknownTopologyCodeError(`Unknown site '${siteCode}'`);
+        }
+        if (!clusterCode) {
+            return { ...meta.config, ...site.site_config };
+        }
+        const cluster = site.clusters.find((candidate) => candidate.code === clusterCode);
+        if (!cluster) {
+            throw new UnknownTopologyCodeError(`Unknown cluster '${clusterCode}' for site '${siteCode}'`);
+        }
+        return { ...meta.config, ...site.site_config, ...cluster.cluster_config };
+    }
+    async getConnections(cores, siteCode, clusterCode) {
+        try {
+            const { connections_math } = await this.getConfig(siteCode, clusterCode);
+            if (!connections_math) {
+                return undefined;
+            }
+            return Math.max(1, Math.floor((0, connectionsMath_1.evaluateConnectionsMath)(connections_math, cores)));
+        }
+        catch (error) {
+            if (error instanceof UnknownTopologyCodeError) {
+                throw error;
+            }
+            return undefined;
+        }
+    }
+    async getPackSizeMib(siteCode, clusterCode) {
+        try {
+            const config = await this.getConfig(siteCode, clusterCode);
+            return config.restic_pack_size_mib;
+        }
+        catch (error) {
+            if (error instanceof UnknownTopologyCodeError) {
+                throw error;
+            }
+            return undefined;
+        }
+    }
+}
+exports.YuccaWellKnown = YuccaWellKnown;
+exports.yuccaWellKnown = new YuccaWellKnown();
+//# sourceMappingURL=wellKnown.js.map

package/dist/wellKnown.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"wellKnown.js","sourceRoot":"","sources":["../src/wellKnown.ts"],"names":[],"mappings":";;;AAAA,6BAAwB;AACxB,mCAA2C;AAC3C,6DAAkE;AAElE,MAAM,gBAAgB,GAAG,OAAC;KACvB,MAAM,CAAC;IACN,oBAAoB,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE;IACjE,gBAAgB,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CACxC,CAAC;KACD,MAAM,EAAE,CAAC;AAEZ,MAAM,iBAAiB,GAAG,OAAC;KACxB,MAAM,CAAC;IACN,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IACvB,YAAY,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IAC/B,cAAc,EAAE,gBAAgB;CACjC,CAAC;KACD,MAAM,EAAE,CAAC;AAEZ,MAAM,cAAc,GAAG,OAAC;KACrB,MAAM,CAAC;IACN,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IACvB,YAAY,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IAC/B,WAAW,EAAE,OAAC,CAAC,MAAM,EAAE;IACvB,QAAQ,EAAE,OAAC,CAAC,GAAG,EAAE;IACjB,eAAe,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IAClC,WAAW,EAAE,gBAAgB;IAC7B,QAAQ,EAAE,OAAC,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;CAC5C,CAAC;KACD,MAAM,EAAE,CAAC;AAEZ,MAAM,UAAU,GAAG,OAAC;KACjB,MAAM,CAAC;IACN,QAAQ,EAAE,OAAC,CAAC,GAAG,EAAE;IACjB,MAAM,EAAE,gBAAgB;IACxB,YAAY,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IAC/B,KAAK,EAAE,OAAC,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;CACtC,CAAC;KACD,MAAM,EAAE;KACR,WAAW,CAAC,CAAC,IAAI,EAAE,GAAG,EAAE,EAAE;IACzB,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC;QAChE,GAAG,CAAC,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,iBAAiB,IAAI,CAAC,YAAY,mBAAmB,EAAE,CAAC,CAAC;IACnG,CAAC;IACD,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;QAC9B,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,KAAK,IAAI,CAAC,eAAe,CAAC,EAAE,CAAC;YAC5E,GAAG,CAAC,QAAQ,CAAC;gBACX,IAAI,EAAE,QAAQ;gBACd,OAAO,EAAE,SAAS,IAAI,CAAC,IAAI,sBAAsB,IAAI,CAAC,eAAe,mBAAmB;aACzF,CAAC,CAAC;QACL,CAAC;IACH,CAAC;AACH,CAAC,CAAC,CAAC;AAEL,MAAM,aAAa,GAAG,OAAC,CAAC,MAAM,CAAC,EAAE,QAAQ,EAAE,OAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC;AAO/D,MAAM,cAAc,GAAG,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC;AACrC,MAAM,iBAAiB,GAAG,EAAE,GAAG,IAAI,CAAC;AACpC,MAAM,aAAa,GAAG,IAAI,CAAC;AAE3B,MAAM,wBAAyB,SAAQ,KAAK;CAAG;AAE/C,MAAM,cAAc,GAAG,KAAK,EAAK,GAAW,EAAE,MAAoB,EAAc,EAAE;IAChF,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE,EAAE,MAAM,EAAE,WAAW,CAAC,OAAO,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC;IAClF,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;QACjB,MAAM,IAAI,KAAK,CAAC,OAAO,GAAG,qBAAqB,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;IACpE,CAAC;IACD,OAAO,MAAM,CAAC,KAAK,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC;AAC7C,CAAC,CAAC;AAEF,MAAa,cAAc;IACjB,GAAG,GAAG,wBAAgB,CAAC;IACvB,IAAI,CAAQ;IACZ,SAAS,GAAG,CAAC,CAAC;IACd,SAAS,CAAW;IACpB,QAAQ,GAAG,CAAC,CAAC;IAErB,SAAS,CAAC,GAAY;QACpB,IAAI,CAAC,GAAG,GAAG,GAAG,IAAI,wBAAgB,CAAC;QACnC,IAAI,CAAC,IAAI,GAAG,SAAS,CAAC;QACtB,IAAI,CAAC,SAAS,GAAG,CAAC,CAAC;QACnB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,QAAQ,GAAG,CAAC,CAAC;IACpB,CAAC;IAED,KAAK,CAAC,GAAG;QACP,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,SAAS,GAAG,cAAc,CAAC;QAC3D,MAAM,cAAc,GAAG,IAAI,CAAC,SAAS,KAAK,SAAS,IAAI,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,QAAQ,GAAG,iBAAiB,CAAC;QACtG,IAAI,IAAI,CAAC,IAAI,IAAI,CAAC,KAAK,IAAI,cAAc,CAAC,EAAE,CAAC;YAC3C,OAAO,IAAI,CAAC,IAAI,CAAC;QACnB,CAAC;QACD,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,cAAc,EAAE,CAAC;YACjC,MAAM,IAAI,CAAC,SAAS,CAAC;QACvB,CAAC;QAED,IAAI,CAAC;YACH,MAAM,OAAO,GAAG,MAAM,cAAc,CAAC,IAAI,CAAC,GAAG,EAAE,aAAa,CAAC,CAAC;YAC9D,MAAM,IAAI,GAAG,MAAM,cAAc,CAAC,OAAO,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;YAChE,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;YACjB,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;YAC5B,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;YAC3B,OAAO,IAAI,CAAC;QACd,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC;YACvB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;YAC3B,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;gBACd,OAAO,IAAI,CAAC,IAAI,CAAC;YACnB,CAAC;YACD,MAAM,KAAK,CAAC;QACd,CAAC;IACH,CAAC;IAID,KAAK,CAAC,UAAU;QACd,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,GAAG,EAAE,CAAC;QAC9B,OAAO,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;IAChD,CAAC;IAED,KAAK,CAAC,QAAQ;QACZ,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,GAAG,EAAE,CAAC;QAC9B,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED,KAAK,CAAC,SAAS,CAAC,QAAiB,EAAE,WAAoB;QACrD,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,GAAG,EAAE,CAAC;QAC9B,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,IAAI,WAAW,EAAE,CAAC;gBAChB,MAAM,IAAI,wBAAwB,CAAC,YAAY,WAAW,+BAA+B,CAAC,CAAC;YAC7F,CAAC;YACD,OAAO,EAAE,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC;QAC5B,CAAC;QAED,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC;QACzE,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,MAAM,IAAI,wBAAwB,CAAC,iBAAiB,QAAQ,GAAG,CAAC,CAAC;QACnE,CAAC;QACD,IAAI,CAAC,WAAW,EAAE,CAAC;YACjB,OAAO,EAAE,GAAG,IAAI,CAAC,MAAM,EAAE,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;QACjD,CAAC;QAED,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,KAAK,WAAW,CAAC,CAAC;QAClF,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,MAAM,IAAI,wBAAwB,CAAC,oBAAoB,WAAW,eAAe,QAAQ,GAAG,CAAC,CAAC;QAChG,CAAC;QACD,OAAO,EAAE,GAAG,IAAI,CAAC,MAAM,EAAE,GAAG,IAAI,CAAC,WAAW,EAAE,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC;IAC5E,CAAC;IAED,KAAK,CAAC,cAAc,CAAC,KAAa,EAAE,QAAiB,EAAE,WAAoB;QACzE,IAAI,CAAC;YACH,MAAM,EAAE,gBAAgB,EAAE,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;YACzE,IAAI,CAAC,gBAAgB,EAAE,CAAC;gBACtB,OAAO,SAAS,CAAC;YACnB,CAAC;YACD,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,IAAA,yCAAuB,EAAC,gBAAgB,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;QACnF,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,KAAK,YAAY,wBAAwB,EAAE,CAAC;gBAC9C,MAAM,KAAK,CAAC;YACd,CAAC;YACD,OAAO,SAAS,CAAC;QACnB,CAAC;IACH,CAAC;IAED,KAAK,CAAC,cAAc,CAAC,QAAiB,EAAE,WAAoB;QAC1D,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;YAC3D,OAAO,MAAM,CAAC,oBAAoB,CAAC;QACrC,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,KAAK,YAAY,wBAAwB,EAAE,CAAC;gBAC9C,MAAM,KAAK,CAAC;YACd,CAAC;YACD,OAAO,SAAS,CAAC;QACnB,CAAC;IACH,CAAC;CACF;AAxGD,wCAwGC;AAEY,QAAA,cAAc,GAAG,IAAI,cAAc,EAAE,CAAC"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@futo-org/backups-orchestrator-api",
   "repository": "https://github.com/immich-app/yucca",
-  "version": "0.23.1",
+  "version": "0.25.0",
   "description": "Backups orchestrator (API)",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -31,7 +31,8 @@
     "rxjs": "^7.8.2",
     "socket.io": "^4.8.3",
     "tail": "^2.2.6",
-    "@futo-org/backups-api-client": "^0.23.1"
+    "zod": "^4.3.5",
+    "@futo-org/backups-api-client": "^0.25.0"
   },
   "devDependencies": {
     "@nestjs/cli": "^11.0.14",