Compare commits
2
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
323ef9ec7e | ||
|
|
fe0ed3b74e |
@@ -94,7 +94,7 @@
|
|||||||
],
|
],
|
||||||
"env": {
|
"env": {
|
||||||
"MESH_BROKER_FILE": "/run/secrets/broker",
|
"MESH_BROKER_FILE": "/run/secrets/broker",
|
||||||
"MESH_BAZARR_URL": "http://127.0.0.1:${port:6767}",
|
"MESH_BAZARR_URL": "http://127.0.0.1:6767",
|
||||||
"MESH_BAZARR_API_KEY_FILE": "/run/secrets/api-key",
|
"MESH_BAZARR_API_KEY_FILE": "/run/secrets/api-key",
|
||||||
"MESH_BAZARR_CONFIG_FILE": "/run/config/config.json",
|
"MESH_BAZARR_CONFIG_FILE": "/run/config/config.json",
|
||||||
"MESH_BAZARR_CONFIG_DIR": "/var/lib/bazarr/config"
|
"MESH_BAZARR_CONFIG_DIR": "/var/lib/bazarr/config"
|
||||||
|
|||||||
@@ -76,7 +76,7 @@
|
|||||||
],
|
],
|
||||||
"env": {
|
"env": {
|
||||||
"MESH_BROKER_FILE": "/run/secrets/broker",
|
"MESH_BROKER_FILE": "/run/secrets/broker",
|
||||||
"MESH_BOOKSHELF_URL": "http://127.0.0.1:${port:8787}",
|
"MESH_BOOKSHELF_URL": "http://127.0.0.1:8787",
|
||||||
"MESH_BOOKSHELF_CONFIG_DIR": "/var/lib/bookshelf/config"
|
"MESH_BOOKSHELF_CONFIG_DIR": "/var/lib/bookshelf/config"
|
||||||
},
|
},
|
||||||
"artifact": "runtime"
|
"artifact": "runtime"
|
||||||
|
|||||||
@@ -13,7 +13,7 @@ ARG RUNTIME_BASE
|
|||||||
FROM ${BUILD_BASE} AS build
|
FROM ${BUILD_BASE} AS build
|
||||||
WORKDIR /app/modules/influxdb
|
WORKDIR /app/modules/influxdb
|
||||||
COPY . .
|
COPY . .
|
||||||
RUN node /app/node_modules/typescript/bin/tsc client.ts tools/index.ts \
|
RUN node /app/node_modules/typescript/bin/tsc client.ts grants.ts provisioner/index.ts tools/index.ts \
|
||||||
--module NodeNext --moduleResolution NodeNext --target ES2022 --outDir dist
|
--module NodeNext --moduleResolution NodeNext --target ES2022 --outDir dist
|
||||||
|
|
||||||
FROM ${RUNTIME_BASE}
|
FROM ${RUNTIME_BASE}
|
||||||
@@ -21,4 +21,4 @@ COPY --from=build /app/modules/influxdb/dist /app/modules/influxdb/dist
|
|||||||
# Every serve-time entrypoint, loaded by the runtime in serve mode: tools and events serve, and a
|
# Every serve-time entrypoint, loaded by the runtime in serve mode: tools and events serve, and a
|
||||||
# provider's provisioner runs its reconcile loop in the same process, with the broker connected —
|
# provider's provisioner runs its reconcile loop in the same process, with the broker connected —
|
||||||
# the convention novox/hq issues 060/061 settled.
|
# the convention novox/hq issues 060/061 settled.
|
||||||
ENV MESH_TOOL_MODULES=/app/modules/influxdb/dist/tools/index.js
|
ENV MESH_TOOL_MODULES=/app/modules/influxdb/dist/tools/index.js,/app/modules/influxdb/dist/provisioner/index.js
|
||||||
|
|||||||
+118
-3
@@ -17,6 +17,25 @@ export interface InfluxBucket {
|
|||||||
retentionSeconds?: number;
|
retentionSeconds?: number;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/** One permission of an authorization, as InfluxDB represents it: an action on a resource type,
|
||||||
|
* in one org, optionally narrowed to one resource by id (no id = every resource of that type). */
|
||||||
|
export interface InfluxPermission {
|
||||||
|
action: "read" | "write";
|
||||||
|
resource: { type: string; orgID?: string; id?: string; name?: string; org?: string };
|
||||||
|
}
|
||||||
|
|
||||||
|
/** A v1-compatibility ("legacy") authorization: a username (InfluxDB calls it `token`) and a
|
||||||
|
* password the caller chooses, scoped by permissions. The one credential InfluxDB 2.x lets a
|
||||||
|
* caller set to a value it did not generate — which is what a mesh-minted password needs. */
|
||||||
|
export interface LegacyAuthorization {
|
||||||
|
id: string;
|
||||||
|
token: string;
|
||||||
|
orgID: string;
|
||||||
|
status?: "active" | "inactive";
|
||||||
|
description?: string;
|
||||||
|
permissions: InfluxPermission[];
|
||||||
|
}
|
||||||
|
|
||||||
/** The settings-merged config the mesh delivers (novox/hq ADR 0046): { url, apiKey, token, password, user, ... }. */
|
/** The settings-merged config the mesh delivers (novox/hq ADR 0046): { url, apiKey, token, password, user, ... }. */
|
||||||
function meshConfig(file?: string): Record<string, string> {
|
function meshConfig(file?: string): Record<string, string> {
|
||||||
if (!file) return {};
|
if (!file) return {};
|
||||||
@@ -24,13 +43,20 @@ function meshConfig(file?: string): Record<string, string> {
|
|||||||
catch { return {}; }
|
catch { return {}; }
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/** A secret delivered as a file, trimmed; undefined when there is none, so the caller can fall back. */
|
||||||
|
function tokenFromFile(file?: string): string | undefined {
|
||||||
|
if (!file) return undefined;
|
||||||
|
try { return readFileSync(file, "utf8").trim() || undefined; }
|
||||||
|
catch { return undefined; }
|
||||||
|
}
|
||||||
|
|
||||||
export class InfluxDBClient {
|
export class InfluxDBClient {
|
||||||
readonly baseUrl: string;
|
readonly baseUrl: string;
|
||||||
|
|
||||||
constructor(
|
constructor(
|
||||||
url: string,
|
url: string,
|
||||||
private readonly token: string,
|
private readonly token: string,
|
||||||
private readonly org: string,
|
readonly org: string,
|
||||||
) {
|
) {
|
||||||
this.baseUrl = url.replace(/\/$/, "");
|
this.baseUrl = url.replace(/\/$/, "");
|
||||||
}
|
}
|
||||||
@@ -43,8 +69,10 @@ export class InfluxDBClient {
|
|||||||
static fromEnv(env: NodeJS.ProcessEnv = process.env): InfluxDBClient {
|
static fromEnv(env: NodeJS.ProcessEnv = process.env): InfluxDBClient {
|
||||||
const cfg = meshConfig(env.MESH_INFLUXDB_CONFIG_FILE);
|
const cfg = meshConfig(env.MESH_INFLUXDB_CONFIG_FILE);
|
||||||
const url = cfg.url ?? env.MESH_INFLUXDB_URL ?? `http://127.0.0.1:${env.INFLUXDB_PORT ?? "8086"}`;
|
const url = cfg.url ?? env.MESH_INFLUXDB_URL ?? `http://127.0.0.1:${env.INFLUXDB_PORT ?? "8086"}`;
|
||||||
const token = cfg.token ?? env.MESH_INFLUXDB_TOKEN;
|
// The token reaches the process as a file (novox/hq ADR 0086); the environment variable stays
|
||||||
if (!token) throw new Error("no InfluxDB token — set MESH_INFLUXDB_TOKEN");
|
// only for a workstation running the tools by hand.
|
||||||
|
const token = cfg.token ?? tokenFromFile(env.MESH_INFLUXDB_TOKEN_FILE) ?? env.MESH_INFLUXDB_TOKEN;
|
||||||
|
if (!token) throw new Error("no InfluxDB token — set MESH_INFLUXDB_TOKEN_FILE");
|
||||||
const org = cfg.org ?? env.MESH_INFLUXDB_ORG ?? "mesh";
|
const org = cfg.org ?? env.MESH_INFLUXDB_ORG ?? "mesh";
|
||||||
return new InfluxDBClient(url, token, org);
|
return new InfluxDBClient(url, token, org);
|
||||||
}
|
}
|
||||||
@@ -61,6 +89,93 @@ export class InfluxDBClient {
|
|||||||
return res;
|
return res;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/** Like request, but the answer is returned whatever its status, for the caller to read. */
|
||||||
|
private async raw(path: string, init?: RequestInit): Promise<Response> {
|
||||||
|
return fetch(`${this.baseUrl}${path}`, {
|
||||||
|
...init,
|
||||||
|
headers: { Authorization: `Token ${this.token}`, ...(init?.headers ?? {}) },
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
private async send(path: string, method: string, body?: unknown): Promise<Response> {
|
||||||
|
return this.request(path, {
|
||||||
|
method,
|
||||||
|
headers: { "Content-Type": "application/json" },
|
||||||
|
body: body === undefined ? undefined : JSON.stringify(body),
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
/** The id of the org of this name, or undefined when there is none. */
|
||||||
|
async orgID(name: string): Promise<string | undefined> {
|
||||||
|
const res = await this.raw(`/api/v2/orgs?org=${encodeURIComponent(name)}`);
|
||||||
|
if (res.status === 404) return undefined;
|
||||||
|
if (!res.ok) throw new Error(`InfluxDB API /api/v2/orgs: ${res.status} ${await res.text()}`);
|
||||||
|
const body = (await res.json()) as { orgs?: { id: string; name: string }[] };
|
||||||
|
return body.orgs?.find((o) => o.name === name)?.id;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** The bucket of exactly this name in the org, or undefined. */
|
||||||
|
async findBucket(orgID: string, name: string): Promise<InfluxBucket | undefined> {
|
||||||
|
const res = await this.raw(`/api/v2/buckets?orgID=${encodeURIComponent(orgID)}&name=${encodeURIComponent(name)}`);
|
||||||
|
if (res.status === 404) return undefined;
|
||||||
|
if (!res.ok) throw new Error(`InfluxDB API /api/v2/buckets: ${res.status} ${await res.text()}`);
|
||||||
|
const body = (await res.json()) as { buckets?: { id: string; name: string; orgID?: string }[] };
|
||||||
|
const b = body.buckets?.find((x) => x.name === name);
|
||||||
|
return b ? { id: b.id, name: b.name, orgID: b.orgID } : undefined;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Create a bucket that keeps its data for ever — retention is the operator's choice, never the mesh's. */
|
||||||
|
async createBucket(orgID: string, name: string, description: string): Promise<InfluxBucket> {
|
||||||
|
const b = (await (await this.send("/api/v2/buckets", "POST", {
|
||||||
|
orgID, name, description, retentionRules: [],
|
||||||
|
})).json()) as { id: string; name: string; orgID?: string };
|
||||||
|
return { id: b.id, name: b.name, orgID: b.orgID };
|
||||||
|
}
|
||||||
|
|
||||||
|
/** The v1 authorization whose username is exactly this, or undefined. */
|
||||||
|
async findLegacy(username: string): Promise<LegacyAuthorization | undefined> {
|
||||||
|
const path = `/private/legacy/authorizations?token=${encodeURIComponent(username)}`;
|
||||||
|
const res = await this.raw(path);
|
||||||
|
// InfluxDB answers a filter matching nothing with 404, not an empty list.
|
||||||
|
if (res.status === 404) return undefined;
|
||||||
|
if (!res.ok) throw new Error(`InfluxDB API ${path}: ${res.status} ${await res.text()}`);
|
||||||
|
const body = (await res.json()) as { authorizations?: LegacyAuthorization[] };
|
||||||
|
return body.authorizations?.find((a) => a.token === username);
|
||||||
|
}
|
||||||
|
|
||||||
|
async createLegacy(a: Omit<LegacyAuthorization, "id">): Promise<LegacyAuthorization> {
|
||||||
|
return (await (await this.send("/private/legacy/authorizations", "POST", a)).json()) as LegacyAuthorization;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Set a v1 authorization's password. InfluxDB keeps only a hash of it, so it can be set, never read. */
|
||||||
|
async setLegacyPassword(id: string, password: string): Promise<void> {
|
||||||
|
await this.send(`/private/legacy/authorizations/${encodeURIComponent(id)}/password`, "POST", { password });
|
||||||
|
}
|
||||||
|
|
||||||
|
async updateLegacy(id: string, patch: { status?: "active" | "inactive"; description?: string }): Promise<void> {
|
||||||
|
await this.send(`/private/legacy/authorizations/${encodeURIComponent(id)}`, "PATCH", patch);
|
||||||
|
}
|
||||||
|
|
||||||
|
async deleteLegacy(id: string): Promise<void> {
|
||||||
|
await this.send(`/private/legacy/authorizations/${encodeURIComponent(id)}`, "DELETE");
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Whether this username and password sign in on the v1 API — the consumer's own view. Asked with
|
||||||
|
* a statement that reads nothing (`SHOW DATABASES` lists only what the credential may read), sent
|
||||||
|
* with Basic auth so the password is never in a URL. 401 is a wrong password or no such user;
|
||||||
|
* anything else that is not a server error means InfluxDB knew who was asking.
|
||||||
|
*/
|
||||||
|
async legacySignsIn(username: string, password: string): Promise<boolean> {
|
||||||
|
const res = await fetch(`${this.baseUrl}/query?q=${encodeURIComponent("SHOW DATABASES")}`, {
|
||||||
|
headers: { Authorization: `Basic ${Buffer.from(`${username}:${password}`).toString("base64")}` },
|
||||||
|
});
|
||||||
|
await res.arrayBuffer();
|
||||||
|
if (res.status === 401) return false;
|
||||||
|
if (res.status >= 500) throw new Error(`InfluxDB v1 /query: ${res.status}`);
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
/** Server health — the one endpoint that needs no token, but we send it anyway. */
|
/** Server health — the one endpoint that needs no token, but we send it anyway. */
|
||||||
async health(): Promise<InfluxHealth> {
|
async health(): Promise<InfluxHealth> {
|
||||||
return (await (await this.request("/health")).json()) as InfluxHealth;
|
return (await (await this.request("/health")).json()) as InfluxHealth;
|
||||||
|
|||||||
@@ -0,0 +1,186 @@
|
|||||||
|
// What the `influxdb-api` provision means in InfluxDB: one v1-compatibility authorization per
|
||||||
|
// consumer, in the org this module serves, under the username and password the mesh gave both ends,
|
||||||
|
// allowed exactly the access the consumer contributed. The provisioner (provisioner/index.ts) is the
|
||||||
|
// sdk harness calling these; they are here, apart from it, so they can be exercised against a fake
|
||||||
|
// InfluxDB without a broker or a contributions file.
|
||||||
|
//
|
||||||
|
// **Why a v1 authorization and not a v2 API token.** The mesh mints the consumer's password and
|
||||||
|
// hands it to both ends (novox/hq ADR 0048); the provider sets it, and never hands one back. An
|
||||||
|
// InfluxDB 2.x API token is generated by the server — `POST /api/v2/authorizations` ignores a token
|
||||||
|
// the caller sends — so a token could only ever be the operator's to accept, one per pair, by hand.
|
||||||
|
// A v1 authorization is a username and a password the caller chooses (8–72 characters; the mesh
|
||||||
|
// mints 40), stored hashed, and it reads and writes through InfluxQL (`/query`) and line protocol
|
||||||
|
// (`/write`), which every bucket answers under its own name as a database (InfluxDB maps each
|
||||||
|
// bucket to a database of the same name by itself). That is what grafana's InfluxDB data source
|
||||||
|
// speaks, and what Node-RED's influxdb nodes speak in their 1.x mode — so the mesh can make every
|
||||||
|
// consumer's credential, rotate it and withdraw it, with no person in the loop.
|
||||||
|
//
|
||||||
|
// **What a consumer contributes.** `access`: "read" (the default), "write" or "read-write".
|
||||||
|
// `buckets`: the buckets it may use, by name. A reader that names none may read every bucket of the
|
||||||
|
// org — a dashboard is pointed at data, it does not own it. A writer must name its buckets: writing
|
||||||
|
// everywhere, the org's system buckets included, is never what a consumer means. A named bucket
|
||||||
|
// that does not exist is created, keeping its data for ever; the mesh never deletes a bucket.
|
||||||
|
//
|
||||||
|
// **Only what the mesh made is touched.** An authorization this module creates is named with the
|
||||||
|
// mesh's identity prefix and its description starts with MARK. One with the same username that
|
||||||
|
// lacks the mark is somebody else's: it is refused, never adopted, never updated, never deleted.
|
||||||
|
// Every other authorization, token, user and bucket in the instance is left exactly as it was.
|
||||||
|
|
||||||
|
import type { InfluxDBClient, InfluxPermission, LegacyAuthorization } from "./client.js";
|
||||||
|
|
||||||
|
/** How a description marks an authorization as the mesh's own work. */
|
||||||
|
export const MARK = "[mesh]";
|
||||||
|
|
||||||
|
/** The prefix the mesh gives every consumer identity (novox/hq ADR 0049). */
|
||||||
|
const IDENTITY_PREFIX = "mesh_";
|
||||||
|
|
||||||
|
/** One consumer, as the harness hands it over. */
|
||||||
|
export interface ApiGrant {
|
||||||
|
readonly as: string;
|
||||||
|
readonly password: string;
|
||||||
|
readonly values: Readonly<Record<string, unknown>>;
|
||||||
|
readonly consumer?: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export type Access = "read" | "write" | "read-write";
|
||||||
|
|
||||||
|
/** What a contribution asks for, checked. Refused when it cannot be served as asked. */
|
||||||
|
export function askedFor(values: Readonly<Record<string, unknown>>): { access: Access; buckets: string[] } {
|
||||||
|
const access = values.access ?? "read";
|
||||||
|
if (access !== "read" && access !== "write" && access !== "read-write") {
|
||||||
|
throw new Error(`contributes an access of ${JSON.stringify(access)} — it is "read", "write" or "read-write"`);
|
||||||
|
}
|
||||||
|
const raw = values.buckets ?? [];
|
||||||
|
if (!Array.isArray(raw) || raw.some((b) => typeof b !== "string" || b.trim() === "")) {
|
||||||
|
throw new Error(`contributes buckets of ${JSON.stringify(raw)} — a list of bucket names`);
|
||||||
|
}
|
||||||
|
const buckets = [...new Set((raw as string[]).map((b) => b.trim()))].sort();
|
||||||
|
if (access !== "read" && buckets.length === 0) {
|
||||||
|
throw new Error(`asks to write and names no bucket (\`buckets\`) — a writer names what it writes to`);
|
||||||
|
}
|
||||||
|
if (buckets.some((b) => b.startsWith("_"))) {
|
||||||
|
throw new Error(`names a system bucket (${buckets.filter((b) => b.startsWith("_")).join(", ")}) — those are InfluxDB's own`);
|
||||||
|
}
|
||||||
|
return { access: access as Access, buckets };
|
||||||
|
}
|
||||||
|
|
||||||
|
/** The permissions a grant resolves to, given each named bucket's id. */
|
||||||
|
export function permissionsFor(orgID: string, access: Access, bucketIDs: string[]): InfluxPermission[] {
|
||||||
|
const actions: ("read" | "write")[] = access === "read-write" ? ["read", "write"] : [access];
|
||||||
|
const out: InfluxPermission[] = [];
|
||||||
|
for (const action of actions) {
|
||||||
|
if (bucketIDs.length === 0) {
|
||||||
|
out.push({ action, resource: { type: "buckets", orgID } });
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
for (const id of bucketIDs) out.push({ action, resource: { type: "buckets", orgID, id } });
|
||||||
|
}
|
||||||
|
return out;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** A permission as a comparable string: what InfluxDB answers carries names and links besides. */
|
||||||
|
function key(p: InfluxPermission): string {
|
||||||
|
return `${p.action}:${p.resource.type}:${p.resource.orgID ?? ""}:${p.resource.id ?? "*"}`;
|
||||||
|
}
|
||||||
|
|
||||||
|
function samePermissions(a: readonly InfluxPermission[], b: readonly InfluxPermission[]): boolean {
|
||||||
|
const x = a.map(key).sort();
|
||||||
|
const y = b.map(key).sort();
|
||||||
|
return x.length === y.length && x.every((v, i) => v === y[i]);
|
||||||
|
}
|
||||||
|
|
||||||
|
export function marked(a: Pick<LegacyAuthorization, "token" | "description">): boolean {
|
||||||
|
return a.token.startsWith(IDENTITY_PREFIX) && (a.description ?? "").startsWith(MARK);
|
||||||
|
}
|
||||||
|
|
||||||
|
function describe(g: ApiGrant): string {
|
||||||
|
return `${MARK} made by the mesh for ${g.consumer ? `a module on ${g.consumer}` : "a consumer"} — do not edit; it is reset`;
|
||||||
|
}
|
||||||
|
|
||||||
|
export class ApiGrants {
|
||||||
|
constructor(private readonly influx: InfluxDBClient, readonly org: string) {}
|
||||||
|
|
||||||
|
private async orgID(): Promise<string> {
|
||||||
|
const id = await this.influx.orgID(this.org);
|
||||||
|
if (!id) throw new Error(`InfluxDB has no org ${JSON.stringify(this.org)} — the org this module serves must exist`);
|
||||||
|
return id;
|
||||||
|
}
|
||||||
|
|
||||||
|
/** The ids of the named buckets, creating any that are missing when `create` says so. Undefined
|
||||||
|
* when one is missing and may not be created (a read-only question). */
|
||||||
|
private async bucketIDs(orgID: string, names: string[], create: ApiGrant | undefined): Promise<string[] | undefined> {
|
||||||
|
const ids: string[] = [];
|
||||||
|
for (const name of names) {
|
||||||
|
let b = await this.influx.findBucket(orgID, name);
|
||||||
|
if (!b) {
|
||||||
|
if (!create) return undefined;
|
||||||
|
b = await this.influx.createBucket(orgID, name, `${MARK} made by the mesh for ${create.as}; the mesh never deletes it`);
|
||||||
|
}
|
||||||
|
ids.push(b.id);
|
||||||
|
}
|
||||||
|
return ids.sort();
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Create the consumer's authorization, or bring the mesh's existing one back to what the grant
|
||||||
|
* says. Idempotent: a second apply of the same grant changes nothing beyond re-asserting the
|
||||||
|
* password, which InfluxDB can be told but never asked. */
|
||||||
|
async ensure(g: ApiGrant): Promise<"created" | "updated" | "unchanged"> {
|
||||||
|
if (!g.as.startsWith(IDENTITY_PREFIX)) {
|
||||||
|
throw new Error(`${g.as} is not a mesh identity — the mesh names every consumer ${IDENTITY_PREFIX}<node>_<module>`);
|
||||||
|
}
|
||||||
|
const { access, buckets } = askedFor(g.values);
|
||||||
|
const orgID = await this.orgID();
|
||||||
|
const found = await this.influx.findLegacy(g.as);
|
||||||
|
if (found && !marked(found)) {
|
||||||
|
throw new Error(
|
||||||
|
`InfluxDB already has a v1 authorization ${g.as} the mesh did not make — left alone; ` +
|
||||||
|
`delete it if the mesh should own that name`);
|
||||||
|
}
|
||||||
|
const want = permissionsFor(orgID, access, (await this.bucketIDs(orgID, buckets, g))!);
|
||||||
|
|
||||||
|
if (found && found.orgID === orgID && samePermissions(found.permissions, want)) {
|
||||||
|
// Only what differs is written. The password cannot be read back, so it is tried instead.
|
||||||
|
let changed = false;
|
||||||
|
if (found.status === "inactive") {
|
||||||
|
await this.influx.updateLegacy(found.id, { status: "active" });
|
||||||
|
changed = true;
|
||||||
|
}
|
||||||
|
if (!(await this.influx.legacySignsIn(g.as, g.password))) {
|
||||||
|
await this.influx.setLegacyPassword(found.id, g.password);
|
||||||
|
changed = true;
|
||||||
|
}
|
||||||
|
return changed ? "updated" : "unchanged";
|
||||||
|
}
|
||||||
|
// InfluxDB cannot change an authorization's permissions in place, so the mesh's own is made
|
||||||
|
// again. Only ever one the mesh made: a foreign one was refused above.
|
||||||
|
if (found) await this.influx.deleteLegacy(found.id);
|
||||||
|
const made = await this.influx.createLegacy({
|
||||||
|
token: g.as, orgID, status: "active", description: describe(g), permissions: want,
|
||||||
|
});
|
||||||
|
await this.influx.setLegacyPassword(made.id, g.password);
|
||||||
|
return found ? "updated" : "created";
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Whether InfluxDB still holds this consumer's authorization exactly as the grant says: present,
|
||||||
|
* the mesh's, active, allowed what was asked and nothing more, and signing in with the mesh's
|
||||||
|
* password. Reads only — a missing bucket is "not held", never created here. */
|
||||||
|
async holds(g: ApiGrant): Promise<boolean> {
|
||||||
|
const { access, buckets } = askedFor(g.values);
|
||||||
|
const orgID = await this.influx.orgID(this.org);
|
||||||
|
if (!orgID) return false;
|
||||||
|
const found = await this.influx.findLegacy(g.as);
|
||||||
|
if (!found || !marked(found) || found.status === "inactive" || found.orgID !== orgID) return false;
|
||||||
|
const ids = await this.bucketIDs(orgID, buckets, undefined);
|
||||||
|
if (!ids || !samePermissions(found.permissions, permissionsFor(orgID, access, ids))) return false;
|
||||||
|
return this.influx.legacySignsIn(g.as, g.password);
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Withdraw a consumer's authorization — only one the mesh made. Its buckets and their data stay. */
|
||||||
|
async remove(as: string): Promise<"removed" | "absent" | "not ours"> {
|
||||||
|
const found = await this.influx.findLegacy(as);
|
||||||
|
if (!found) return "absent";
|
||||||
|
if (!marked(found)) return "not ours";
|
||||||
|
await this.influx.deleteLegacy(found.id);
|
||||||
|
return "removed";
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,6 +1,12 @@
|
|||||||
{
|
{
|
||||||
"module": "influxdb",
|
"module": "influxdb",
|
||||||
"version": "1",
|
"version": "1",
|
||||||
|
"provides": [
|
||||||
|
{
|
||||||
|
"name": "influxdb-api",
|
||||||
|
"scope": "mesh"
|
||||||
|
}
|
||||||
|
],
|
||||||
"capabilities": [
|
"capabilities": [
|
||||||
"container-runtime"
|
"container-runtime"
|
||||||
],
|
],
|
||||||
@@ -13,9 +19,23 @@
|
|||||||
"port": 8086,
|
"port": 8086,
|
||||||
"protocol": "tcp",
|
"protocol": "tcp",
|
||||||
"from": "mesh",
|
"from": "mesh",
|
||||||
"why": "queries and writes, over http"
|
"why": "queries, writes and the web UI, over http; consumers granted influxdb-api sign in with the mesh's credential, and a name is a route grant"
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
|
"serves": {
|
||||||
|
"influxdb-api": {
|
||||||
|
"scheme": "http",
|
||||||
|
"port": 8086,
|
||||||
|
"org": "mesh",
|
||||||
|
"bucket": "default"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"receives": {
|
||||||
|
"influxdb-api": "${dir:grants}/mesh.json"
|
||||||
|
},
|
||||||
|
"grants": {
|
||||||
|
"influxdb-api": "${dir:grants}"
|
||||||
|
},
|
||||||
"resources": [
|
"resources": [
|
||||||
{
|
{
|
||||||
"id": "mesh-state",
|
"id": "mesh-state",
|
||||||
@@ -26,46 +46,50 @@
|
|||||||
{
|
{
|
||||||
"id": "state",
|
"id": "state",
|
||||||
"type": "directory",
|
"type": "directory",
|
||||||
"path": "/var/lib/influxdb-module",
|
"mode": "0700",
|
||||||
"mode": "0700"
|
"place": "."
|
||||||
},
|
|
||||||
{
|
|
||||||
"id": "server-env",
|
|
||||||
"type": "file",
|
|
||||||
"path": "/var/lib/influxdb-module/server.env",
|
|
||||||
"mode": "0600",
|
|
||||||
"content": "DOCKER_INFLUXDB_INIT_MODE=setup\nDOCKER_INFLUXDB_INIT_USERNAME=admin\nDOCKER_INFLUXDB_INIT_PASSWORD=${secret:admin}\nDOCKER_INFLUXDB_INIT_ADMIN_TOKEN=${secret:admin-token}\nDOCKER_INFLUXDB_INIT_ORG=mesh\nDOCKER_INFLUXDB_INIT_BUCKET=default\n"
|
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": "data",
|
"id": "data",
|
||||||
"type": "directory",
|
"type": "directory",
|
||||||
"path": "/services/influxdb/data",
|
|
||||||
"mode": "0700",
|
"mode": "0700",
|
||||||
"owner": "1000:1000"
|
"owner": "1000:1000"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": "config",
|
"id": "config",
|
||||||
"type": "directory",
|
"type": "directory",
|
||||||
"path": "/services/influxdb/config",
|
|
||||||
"mode": "0700",
|
"mode": "0700",
|
||||||
"owner": "1000:1000"
|
"owner": "1000:1000"
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
"id": "grants",
|
||||||
|
"type": "directory",
|
||||||
|
"mode": "0700"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"id": "server-env",
|
||||||
|
"type": "file",
|
||||||
|
"path": "${dir:state}/server.env",
|
||||||
|
"mode": "0600",
|
||||||
|
"content": "DOCKER_INFLUXDB_INIT_MODE=setup\nDOCKER_INFLUXDB_INIT_USERNAME=admin\nDOCKER_INFLUXDB_INIT_PASSWORD_FILE=/run/secrets/admin\nDOCKER_INFLUXDB_INIT_ADMIN_TOKEN_FILE=/run/secrets/admin-token\nDOCKER_INFLUXDB_INIT_ORG=mesh\nDOCKER_INFLUXDB_INIT_BUCKET=default\n"
|
||||||
|
},
|
||||||
{
|
{
|
||||||
"id": "server",
|
"id": "server",
|
||||||
"type": "container",
|
"type": "container",
|
||||||
"name": "influxdb",
|
"name": "influxdb",
|
||||||
"image": "influxdb@sha256:f75e48af0598e8aec7986e991a848d19a119101a7d563a2e5db1dfaac9c45daa",
|
"image": "influxdb@sha256:f75e48af0598e8aec7986e991a848d19a119101a7d563a2e5db1dfaac9c45daa",
|
||||||
"env-file": [
|
"env-file": [
|
||||||
"/var/lib/influxdb-module/server.env"
|
"${dir:state}/server.env"
|
||||||
],
|
],
|
||||||
"ports": [
|
"ports": [
|
||||||
"8086"
|
"8086"
|
||||||
],
|
],
|
||||||
"volumes": [
|
"volumes": [
|
||||||
"/services/influxdb/data:/var/lib/influxdb2",
|
"${dir:data}:/var/lib/influxdb2",
|
||||||
"/services/influxdb/config:/etc/influxdb2"
|
"${dir:config}:/etc/influxdb2",
|
||||||
],
|
"${dir:state}/admin.secret:/run/secrets/admin:ro",
|
||||||
"secrets-in-environment": "the image honours DOCKER_INFLUXDB_INIT_PASSWORD_FILE and _ADMIN_TOKEN_FILE; convertible, awaiting a bed that proves it"
|
"${dir:state}/admin-token.secret:/run/secrets/admin-token:ro"
|
||||||
|
]
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": "runtime-config",
|
"id": "runtime-config",
|
||||||
@@ -83,13 +107,15 @@
|
|||||||
"volumes": [
|
"volumes": [
|
||||||
"/var/lib/mesh/influxdb/broker:/run/secrets/broker:ro",
|
"/var/lib/mesh/influxdb/broker:/run/secrets/broker:ro",
|
||||||
"/var/lib/mesh/influxdb/config.json:/run/config/config.json:ro",
|
"/var/lib/mesh/influxdb/config.json:/run/config/config.json:ro",
|
||||||
"/services/influxdb/config:/var/lib/influxdb/config:ro"
|
"${dir:state}/admin-token.secret:/run/secrets/admin-token:ro",
|
||||||
|
"${dir:grants}:${dir:grants}:ro"
|
||||||
],
|
],
|
||||||
"env": {
|
"env": {
|
||||||
"MESH_BROKER_FILE": "/run/secrets/broker",
|
"MESH_BROKER_FILE": "/run/secrets/broker",
|
||||||
"MESH_INFLUXDB_URL": "http://127.0.0.1:8086",
|
"MESH_INFLUXDB_URL": "http://127.0.0.1:${port:8086}",
|
||||||
"MESH_INFLUXDB_CONFIG_FILE": "/run/config/config.json",
|
"MESH_INFLUXDB_CONFIG_FILE": "/run/config/config.json",
|
||||||
"MESH_INFLUXDB_CONFIG_DIR": "/var/lib/influxdb/config"
|
"MESH_INFLUXDB_TOKEN_FILE": "/run/secrets/admin-token",
|
||||||
|
"MESH_RECEIVES": "${dir:grants}/mesh.json"
|
||||||
},
|
},
|
||||||
"restart-on": [
|
"restart-on": [
|
||||||
"runtime-config"
|
"runtime-config"
|
||||||
@@ -97,6 +123,22 @@
|
|||||||
"artifact": "runtime"
|
"artifact": "runtime"
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
|
"requires": [
|
||||||
|
"route",
|
||||||
|
"secret"
|
||||||
|
],
|
||||||
|
"contributes": {
|
||||||
|
"route": {
|
||||||
|
"label": "influxdb",
|
||||||
|
"endpoint": "api"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"secrets": {
|
||||||
|
"secret": {
|
||||||
|
"admin": "${dir:state}/admin.secret",
|
||||||
|
"admin-token": "${dir:state}/admin-token.secret"
|
||||||
|
}
|
||||||
|
},
|
||||||
"build": {
|
"build": {
|
||||||
"on": [
|
"on": [
|
||||||
{
|
{
|
||||||
@@ -117,14 +159,5 @@
|
|||||||
"from": "Dockerfile"
|
"from": "Dockerfile"
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
},
|
|
||||||
"requires": [
|
|
||||||
"secret"
|
|
||||||
],
|
|
||||||
"secrets": {
|
|
||||||
"secret": {
|
|
||||||
"admin": "/var/lib/influxdb-module/admin.secret",
|
|
||||||
"admin-token": "/var/lib/influxdb-module/admin-token.secret"
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,9 +1,14 @@
|
|||||||
{
|
{
|
||||||
"name": "@novox/module-influxdb",
|
"name": "@novox/module-influxdb",
|
||||||
"version": "0.1.0",
|
"version": "0.1.0",
|
||||||
"description": "influxdb — time-series database. Its API client and tools live here (novox/hq ADR 0039).",
|
"description": "influxdb — time-series database; provides the mesh influxdb-api interface. Its API client, provisioner and tools live here (novox/hq ADR 0039).",
|
||||||
"type": "module",
|
"type": "module",
|
||||||
"private": true,
|
"private": true,
|
||||||
|
"scripts": {
|
||||||
|
"build": "tsc client.ts grants.ts provisioner/index.ts tools/index.ts --module NodeNext --moduleResolution NodeNext --target ES2022 --outDir dist",
|
||||||
|
"typecheck": "tsc -p tsconfig.json",
|
||||||
|
"test": "npm run build && node --test --experimental-strip-types 'test/*.test.ts'"
|
||||||
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@novox/mesh-sdk": "^0.1.0"
|
"@novox/mesh-sdk": "^0.1.0"
|
||||||
},
|
},
|
||||||
|
|||||||
@@ -0,0 +1,54 @@
|
|||||||
|
// influxdb's provisioner — the adapter that makes influxdb a provider of the mesh `influxdb-api`
|
||||||
|
// interface. The reconcile loop, the contributions file and reading the mesh's minted secret are the
|
||||||
|
// sdk harness's; this writes only the per-service half: how InfluxDB creates, checks and removes a
|
||||||
|
// consumer's credential (novox/hq ADR 0039/0040/0048). What that credential is, and why it is a v1
|
||||||
|
// authorization, is in ../grants.ts.
|
||||||
|
//
|
||||||
|
// The `influxdb-api` interface: a consumer reaches `${bound:influxdb-api:scheme}://…:at:…:port`,
|
||||||
|
// signs in as `${bound:influxdb-api:as}` with the password the mesh minted for the pair, and reads
|
||||||
|
// or writes the org's buckets as databases of the same name — `${bound:influxdb-api:bucket}` being
|
||||||
|
// the one this instance serves by default. The org and the default bucket are the assignment's
|
||||||
|
// settings, which reach both what is served and this module's config.json, so the org a consumer is
|
||||||
|
// told and the org its credential is made in cannot disagree.
|
||||||
|
|
||||||
|
import { runProvisioner, type Provision } from "@novox/mesh-sdk/provisioner";
|
||||||
|
import { InfluxDBClient } from "../client.js";
|
||||||
|
import { ApiGrants } from "../grants.js";
|
||||||
|
|
||||||
|
let grants: ApiGrants | undefined;
|
||||||
|
try {
|
||||||
|
const influx = InfluxDBClient.fromEnv();
|
||||||
|
grants = new ApiGrants(influx, influx.org);
|
||||||
|
} catch (err) {
|
||||||
|
// No admin token: nothing can be provisioned, and the tools loaded beside this must still serve.
|
||||||
|
console.error(`[provisioner:influxdb-api] not started: ${err instanceof Error ? err.message : err}`);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (grants) serve(grants);
|
||||||
|
|
||||||
|
function serve(grants: ApiGrants): void {
|
||||||
|
runProvisioner("influxdb-api", {
|
||||||
|
async create(p: Provision): Promise<void> {
|
||||||
|
const done = await grants.ensure(p);
|
||||||
|
if (done !== "unchanged") {
|
||||||
|
console.log(`[provisioner:influxdb-api] ${done} v1 authorization ${p.as} in org ${grants.org}`);
|
||||||
|
}
|
||||||
|
},
|
||||||
|
|
||||||
|
async remove(p: { as: string }): Promise<void> {
|
||||||
|
const done = await grants.remove(p.as);
|
||||||
|
if (done === "not ours") {
|
||||||
|
console.error(`[provisioner:influxdb-api] ${p.as}: an authorization of that name exists that the mesh did not make — left alone`);
|
||||||
|
} else if (done === "removed") {
|
||||||
|
console.log(`[provisioner:influxdb-api] removed v1 authorization ${p.as}; its buckets and their data stay`);
|
||||||
|
}
|
||||||
|
},
|
||||||
|
|
||||||
|
// Asked every minute by the harness: whether InfluxDB still holds this consumer's authorization
|
||||||
|
// exactly as the mesh gave it, so one deleted, disabled or re-passworded behind the mesh's back is
|
||||||
|
// made whole again (hq issue 120).
|
||||||
|
async holds(p: Provision): Promise<boolean> {
|
||||||
|
return grants.holds(p);
|
||||||
|
},
|
||||||
|
});
|
||||||
|
}
|
||||||
@@ -0,0 +1,246 @@
|
|||||||
|
// What holds influxdb to the `influxdb-api` provision (grants.ts): one v1 authorization per consumer,
|
||||||
|
// under the username and password the mesh gave, allowed only what the consumer contributed; made
|
||||||
|
// once and brought back on every apply; buckets created when missing and never deleted; and an
|
||||||
|
// authorization the mesh did not make — same name or not — never adopted, changed or deleted.
|
||||||
|
//
|
||||||
|
// InfluxDB is a fake: the routes the module touches, answering with the status codes and shapes
|
||||||
|
// InfluxDB 2.9 gives (a filter matching nothing is a 404, a password outside 8–72 characters a 400,
|
||||||
|
// an inactive authorization or a wrong password a 401 on /query). Run against the compiled module
|
||||||
|
// (npm test builds first), the way the runtime loads it.
|
||||||
|
|
||||||
|
import { test, after, beforeEach } from "node:test";
|
||||||
|
import assert from "node:assert/strict";
|
||||||
|
import { createServer, type IncomingMessage, type ServerResponse } from "node:http";
|
||||||
|
|
||||||
|
import { InfluxDBClient } from "../dist/client.js";
|
||||||
|
import { ApiGrants, MARK, askedFor, marked } from "../dist/grants.js";
|
||||||
|
|
||||||
|
type Rec = Record<string, any>;
|
||||||
|
|
||||||
|
const ADMIN = "operator-token";
|
||||||
|
const orgs = new Map<string, string>([["zurag", "org1"]]);
|
||||||
|
let buckets: Rec[] = [];
|
||||||
|
let auths: Rec[] = [];
|
||||||
|
let calls: string[] = [];
|
||||||
|
let seq = 0;
|
||||||
|
|
||||||
|
function body(req: IncomingMessage): Promise<any> {
|
||||||
|
return new Promise((resolve) => {
|
||||||
|
let raw = "";
|
||||||
|
req.on("data", (c) => (raw += c));
|
||||||
|
req.on("end", () => resolve(raw ? JSON.parse(raw) : undefined));
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
function send(res: ServerResponse, status: number, value?: unknown): void {
|
||||||
|
res.writeHead(status, { "Content-Type": "application/json" });
|
||||||
|
res.end(value === undefined ? "" : JSON.stringify(value));
|
||||||
|
}
|
||||||
|
|
||||||
|
const server = createServer(async (req, res) => {
|
||||||
|
const url = new URL(req.url!, "http://fake");
|
||||||
|
const p = url.pathname;
|
||||||
|
calls.push(`${req.method} ${p}`);
|
||||||
|
if (p === "/query") {
|
||||||
|
const basic = (req.headers.authorization ?? "").replace(/^Basic /, "");
|
||||||
|
const [u, pw] = Buffer.from(basic, "base64").toString().split(":");
|
||||||
|
const a = auths.find((x) => x.token === u);
|
||||||
|
if (!a || a.status !== "active" || a.password === undefined || a.password !== pw) {
|
||||||
|
return send(res, 401, { code: "unauthorized", message: "Unauthorized" });
|
||||||
|
}
|
||||||
|
return send(res, 200, { results: [{ statement_id: 0 }] });
|
||||||
|
}
|
||||||
|
if (req.headers.authorization !== `Token ${ADMIN}`) return send(res, 401, { code: "unauthorized" });
|
||||||
|
if (p === "/api/v2/orgs") {
|
||||||
|
const id = orgs.get(url.searchParams.get("org") ?? "");
|
||||||
|
if (!id) return send(res, 404, { code: "not found", message: "organization name not found" });
|
||||||
|
return send(res, 200, { orgs: [{ id, name: url.searchParams.get("org") }] });
|
||||||
|
}
|
||||||
|
if (p === "/api/v2/buckets" && req.method === "GET") {
|
||||||
|
const found = buckets.filter((b) => b.orgID === url.searchParams.get("orgID") && b.name === url.searchParams.get("name"));
|
||||||
|
if (found.length === 0) return send(res, 404, { code: "not found", message: "bucket not found" });
|
||||||
|
return send(res, 200, { buckets: found });
|
||||||
|
}
|
||||||
|
if (p === "/api/v2/buckets" && req.method === "POST") {
|
||||||
|
const b = { ...(await body(req)), id: `b${++seq}` };
|
||||||
|
buckets.push(b);
|
||||||
|
return send(res, 201, b);
|
||||||
|
}
|
||||||
|
if (p === "/private/legacy/authorizations" && req.method === "GET") {
|
||||||
|
const found = auths.filter((a) => a.token === url.searchParams.get("token"));
|
||||||
|
if (found.length === 0) return send(res, 404, { code: "not found", message: "authorization not found" });
|
||||||
|
// Never answers with the password: InfluxDB keeps only its hash.
|
||||||
|
return send(res, 200, { authorizations: found.map(({ password, ...a }) => ({ ...a, links: {} })) });
|
||||||
|
}
|
||||||
|
if (p === "/private/legacy/authorizations" && req.method === "POST") {
|
||||||
|
const a = await body(req);
|
||||||
|
if (auths.some((x) => x.token === a.token)) return send(res, 409, { code: "conflict", message: "token already exists" });
|
||||||
|
const made = { ...a, id: `a${++seq}`, status: a.status ?? "active" };
|
||||||
|
auths.push(made);
|
||||||
|
return send(res, 201, made);
|
||||||
|
}
|
||||||
|
const m = /^\/private\/legacy\/authorizations\/([^/]+)(\/password)?$/.exec(p);
|
||||||
|
const a = m && auths.find((x) => x.id === m[1]);
|
||||||
|
if (!a) return send(res, 404, { code: "not found" });
|
||||||
|
if (m![2] && req.method === "POST") {
|
||||||
|
const { password } = await body(req);
|
||||||
|
if (typeof password !== "string" || password.length < 8 || password.length > 72) {
|
||||||
|
return send(res, 400, { code: "invalid", message: "passwords must be between 8 and 72 characters long" });
|
||||||
|
}
|
||||||
|
a.password = password;
|
||||||
|
return send(res, 204);
|
||||||
|
}
|
||||||
|
if (req.method === "PATCH") {
|
||||||
|
Object.assign(a, await body(req));
|
||||||
|
return send(res, 200, a);
|
||||||
|
}
|
||||||
|
if (req.method === "DELETE") {
|
||||||
|
auths = auths.filter((x) => x !== a);
|
||||||
|
return send(res, 204);
|
||||||
|
}
|
||||||
|
send(res, 405);
|
||||||
|
});
|
||||||
|
await new Promise<void>((r) => server.listen(0, "127.0.0.1", r));
|
||||||
|
after(() => server.close());
|
||||||
|
const port = (server.address() as { port: number }).port;
|
||||||
|
|
||||||
|
const grants = new ApiGrants(new InfluxDBClient(`http://127.0.0.1:${port}`, ADMIN, "zurag"), "zurag");
|
||||||
|
|
||||||
|
const PW = "mesh-minted-password-of-forty-characters";
|
||||||
|
|
||||||
|
/** Grafana on ace, as the mesh hands it to the provisioner. */
|
||||||
|
function grafana(password = PW, values: Record<string, unknown> = { access: "read" }) {
|
||||||
|
return { as: "mesh_ace_grafana", password, consumer: "ace", values };
|
||||||
|
}
|
||||||
|
/** Node-RED on ace: writes one bucket. */
|
||||||
|
function nodered(password = PW, values: Record<string, unknown> = { access: "write", buckets: ["zurag"] }) {
|
||||||
|
return { as: "mesh_ace_nodered", password, consumer: "ace", values };
|
||||||
|
}
|
||||||
|
|
||||||
|
function only(token: string): Rec {
|
||||||
|
const found = auths.filter((a) => a.token === token);
|
||||||
|
assert.equal(found.length, 1, `exactly one authorization ${token}, found ${found.length}`);
|
||||||
|
return found[0];
|
||||||
|
}
|
||||||
|
|
||||||
|
function perms(a: Rec): string[] {
|
||||||
|
return a.permissions.map((p: Rec) => `${p.action}:${p.resource.type}:${p.resource.id ?? "*"}`).sort();
|
||||||
|
}
|
||||||
|
|
||||||
|
beforeEach(() => {
|
||||||
|
buckets = [{ id: "zb", orgID: "org1", name: "zurag" }];
|
||||||
|
auths = [];
|
||||||
|
calls = [];
|
||||||
|
});
|
||||||
|
|
||||||
|
test("what a contribution may ask for, and what is refused", () => {
|
||||||
|
assert.deepEqual(askedFor({}), { access: "read", buckets: [] });
|
||||||
|
assert.deepEqual(askedFor({ access: "read-write", buckets: ["b", "a", "a"] }), { access: "read-write", buckets: ["a", "b"] });
|
||||||
|
assert.throws(() => askedFor({ access: "admin" }), /access/);
|
||||||
|
assert.throws(() => askedFor({ access: "write" }), /names no bucket/);
|
||||||
|
assert.throws(() => askedFor({ buckets: "zurag" }), /list of bucket names/);
|
||||||
|
assert.throws(() => askedFor({ access: "write", buckets: ["_monitoring"] }), /system bucket/);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a reader is given one authorization, reading every bucket of the org, under the mesh's password", async () => {
|
||||||
|
assert.equal(await grants.ensure(grafana()), "created");
|
||||||
|
const a = only("mesh_ace_grafana");
|
||||||
|
assert.equal(a.orgID, "org1");
|
||||||
|
assert.equal(a.status, "active");
|
||||||
|
assert.ok(a.description.startsWith(MARK));
|
||||||
|
assert.deepEqual(perms(a), ["read:buckets:*"]);
|
||||||
|
assert.equal(a.password, PW);
|
||||||
|
assert.equal(await grants.holds(grafana()), true);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a writer is allowed its own buckets only, and a missing one is made — never deleted", async () => {
|
||||||
|
assert.equal(await grants.ensure(nodered(PW, { access: "write", buckets: ["zurag", "printer"] })), "created");
|
||||||
|
const made = buckets.find((b) => b.name === "printer");
|
||||||
|
assert.ok(made, "the missing bucket was created");
|
||||||
|
assert.deepEqual(made!.retentionRules, [], "kept for ever: retention is the operator's choice");
|
||||||
|
assert.deepEqual(perms(only("mesh_ace_nodered")), [`write:buckets:${made!.id}`, "write:buckets:zb"]);
|
||||||
|
assert.equal(await grants.remove("mesh_ace_nodered"), "removed");
|
||||||
|
assert.equal(buckets.length, 2, "withdrawing the consumer leaves every bucket and its data");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("applying the same grant again writes nothing", async () => {
|
||||||
|
await grants.ensure(grafana());
|
||||||
|
calls = [];
|
||||||
|
assert.equal(await grants.ensure(grafana()), "unchanged");
|
||||||
|
assert.ok(calls.every((c) => c.startsWith("GET")), `only reads: ${calls.join(", ")}`);
|
||||||
|
only("mesh_ace_grafana");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a rotated password is set in place; a changed access remakes only the mesh's own", async () => {
|
||||||
|
await grants.ensure(nodered());
|
||||||
|
const id = only("mesh_ace_nodered").id;
|
||||||
|
assert.equal(await grants.holds(nodered("rotated-password-0123456789")), false);
|
||||||
|
assert.equal(await grants.ensure(nodered("rotated-password-0123456789")), "updated");
|
||||||
|
assert.equal(only("mesh_ace_nodered").id, id, "updated, not replaced");
|
||||||
|
assert.equal(await grants.holds(nodered("rotated-password-0123456789")), true);
|
||||||
|
|
||||||
|
await grants.ensure(nodered(PW, { access: "read-write", buckets: ["zurag"] }));
|
||||||
|
assert.deepEqual(perms(only("mesh_ace_nodered")), ["read:buckets:zb", "write:buckets:zb"]);
|
||||||
|
assert.equal(await grants.holds(nodered(PW, { access: "read-write", buckets: ["zurag"] })), true);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("an authorization disabled, re-passworded or deleted behind the mesh's back is not held, and is made whole", async () => {
|
||||||
|
await grants.ensure(grafana());
|
||||||
|
only("mesh_ace_grafana").status = "inactive";
|
||||||
|
assert.equal(await grants.holds(grafana()), false);
|
||||||
|
assert.equal(await grants.ensure(grafana()), "updated");
|
||||||
|
assert.equal(await grants.holds(grafana()), true);
|
||||||
|
|
||||||
|
only("mesh_ace_grafana").password = "somebody-else-set-this";
|
||||||
|
assert.equal(await grants.holds(grafana()), false);
|
||||||
|
await grants.ensure(grafana());
|
||||||
|
assert.equal(await grants.holds(grafana()), true);
|
||||||
|
|
||||||
|
auths = [];
|
||||||
|
assert.equal(await grants.holds(grafana()), false);
|
||||||
|
assert.equal(await grants.ensure(grafana()), "created");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("holds only reads, and a bucket gone missing is not held rather than made", async () => {
|
||||||
|
await grants.ensure(nodered());
|
||||||
|
buckets = [];
|
||||||
|
calls = [];
|
||||||
|
assert.equal(await grants.holds(nodered()), false);
|
||||||
|
assert.ok(calls.every((c) => c.startsWith("GET")), `only reads: ${calls.join(", ")}`);
|
||||||
|
assert.equal(buckets.length, 0);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("an authorization of the same name the mesh did not make is refused, and left exactly as it was", async () => {
|
||||||
|
auths = [{ id: "theirs", token: "mesh_ace_grafana", orgID: "org1", status: "active", description: "hand-made",
|
||||||
|
permissions: [{ action: "write", resource: { type: "buckets", orgID: "org1" } }], password: "their-password" }];
|
||||||
|
const before = JSON.stringify(auths);
|
||||||
|
await assert.rejects(grants.ensure(grafana()), /did not make/);
|
||||||
|
assert.equal(JSON.stringify(auths), before);
|
||||||
|
assert.ok(calls.every((c) => c.startsWith("GET")), `only reads: ${calls.join(", ")}`);
|
||||||
|
assert.equal(await grants.holds(grafana()), false);
|
||||||
|
assert.equal(await grants.remove("mesh_ace_grafana"), "not ours");
|
||||||
|
assert.equal(auths.length, 1, "never deleted");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("the predecessor's own v1 users and tokens are never touched", async () => {
|
||||||
|
auths = [{ id: "hal", token: "grafana", orgID: "org1", status: "active", description: "",
|
||||||
|
permissions: [{ action: "read", resource: { type: "buckets", orgID: "org1" } }], password: "old-password" }];
|
||||||
|
await grants.ensure(grafana());
|
||||||
|
assert.equal(auths.find((a) => a.id === "hal")!.password, "old-password");
|
||||||
|
assert.equal(await grants.remove("grafana"), "not ours");
|
||||||
|
assert.equal(marked({ token: "grafana", description: `${MARK} x` }), false, "the mark needs the mesh's name too");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("an org the instance does not have, or a non-mesh name, makes nothing", async () => {
|
||||||
|
const elsewhere = new ApiGrants(new InfluxDBClient(`http://127.0.0.1:${port}`, ADMIN, "nope"), "nope");
|
||||||
|
await assert.rejects(elsewhere.ensure(grafana()), /no org "nope"/);
|
||||||
|
await assert.rejects(grants.ensure({ ...grafana(), as: "grafana" }), /not a mesh identity/);
|
||||||
|
assert.equal(auths.length, 0);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a withdrawn consumer's authorization is removed, and an absent one is not an error", async () => {
|
||||||
|
await grants.ensure(grafana());
|
||||||
|
assert.equal(await grants.remove("mesh_ace_grafana"), "removed");
|
||||||
|
assert.equal(auths.length, 0);
|
||||||
|
assert.equal(await grants.remove("mesh_ace_grafana"), "absent");
|
||||||
|
});
|
||||||
@@ -8,5 +8,10 @@
|
|||||||
"skipLibCheck": true,
|
"skipLibCheck": true,
|
||||||
"noEmit": true
|
"noEmit": true
|
||||||
},
|
},
|
||||||
"include": ["client.ts", "tools/index.ts"]
|
"include": [
|
||||||
|
"client.ts",
|
||||||
|
"grants.ts",
|
||||||
|
"provisioner/index.ts",
|
||||||
|
"tools/index.ts"
|
||||||
|
]
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,19 +1,6 @@
|
|||||||
{
|
{
|
||||||
"module": "lidarr",
|
"module": "lidarr",
|
||||||
"version": "1",
|
"version": "1",
|
||||||
"provides": [
|
|
||||||
{
|
|
||||||
"name": "lidarr-api",
|
|
||||||
"scope": "mesh"
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"serves": {
|
|
||||||
"lidarr-api": {
|
|
||||||
"scheme": "http",
|
|
||||||
"port": 8686,
|
|
||||||
"url-base": ""
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"capabilities": [
|
"capabilities": [
|
||||||
"container-runtime"
|
"container-runtime"
|
||||||
],
|
],
|
||||||
@@ -88,7 +75,7 @@
|
|||||||
],
|
],
|
||||||
"env": {
|
"env": {
|
||||||
"MESH_BROKER_FILE": "/run/secrets/broker",
|
"MESH_BROKER_FILE": "/run/secrets/broker",
|
||||||
"MESH_LIDARR_URL": "http://127.0.0.1:${port:8686}",
|
"MESH_LIDARR_URL": "http://127.0.0.1:8686",
|
||||||
"MESH_LIDARR_CONFIG_DIR": "/var/lib/lidarr/config"
|
"MESH_LIDARR_CONFIG_DIR": "/var/lib/lidarr/config"
|
||||||
},
|
},
|
||||||
"artifact": "runtime"
|
"artifact": "runtime"
|
||||||
|
|||||||
@@ -81,7 +81,7 @@
|
|||||||
],
|
],
|
||||||
"env": {
|
"env": {
|
||||||
"MESH_BROKER_FILE": "/run/secrets/broker",
|
"MESH_BROKER_FILE": "/run/secrets/broker",
|
||||||
"MESH_NZBGET_URL": "http://127.0.0.1:${port:6789}",
|
"MESH_NZBGET_URL": "http://127.0.0.1:6789",
|
||||||
"MESH_NZBGET_PASSWORD_FILE": "/run/secrets/password",
|
"MESH_NZBGET_PASSWORD_FILE": "/run/secrets/password",
|
||||||
"MESH_NZBGET_CONFIG_FILE": "/run/config/config.json",
|
"MESH_NZBGET_CONFIG_FILE": "/run/config/config.json",
|
||||||
"MESH_NZBGET_CONFIG_DIR": "/var/lib/nzbget/config"
|
"MESH_NZBGET_CONFIG_DIR": "/var/lib/nzbget/config"
|
||||||
|
|||||||
@@ -13,7 +13,7 @@ ARG RUNTIME_BASE
|
|||||||
FROM ${BUILD_BASE} AS build
|
FROM ${BUILD_BASE} AS build
|
||||||
WORKDIR /app/modules/ombi
|
WORKDIR /app/modules/ombi
|
||||||
COPY . .
|
COPY . .
|
||||||
RUN node /app/node_modules/typescript/bin/tsc client.ts index.ts tools/index.ts servarr/settings.ts plex/settings.ts connections/index.ts \
|
RUN node /app/node_modules/typescript/bin/tsc client.ts index.ts tools/index.ts \
|
||||||
--module NodeNext --moduleResolution NodeNext --target ES2022 --outDir dist
|
--module NodeNext --moduleResolution NodeNext --target ES2022 --outDir dist
|
||||||
|
|
||||||
FROM ${RUNTIME_BASE}
|
FROM ${RUNTIME_BASE}
|
||||||
@@ -22,6 +22,3 @@ COPY --from=build /app/modules/ombi/dist /app/modules/ombi/dist
|
|||||||
# provider's provisioner runs its reconcile loop in the same process, with the broker connected —
|
# provider's provisioner runs its reconcile loop in the same process, with the broker connected —
|
||||||
# the convention novox/hq issues 060/061 settled.
|
# the convention novox/hq issues 060/061 settled.
|
||||||
ENV MESH_TOOL_MODULES=/app/modules/ombi/dist/index.js,/app/modules/ombi/dist/tools/index.js
|
ENV MESH_TOOL_MODULES=/app/modules/ombi/dist/index.js,/app/modules/ombi/dist/tools/index.js
|
||||||
# NOT dist/connections/index.js: that is a step the host runs to completion, named by the `connections`
|
|
||||||
# container's args as `mesh-tools run …` (novox/hq ADR 0052). Listed here it would run inside the
|
|
||||||
# serving sidecar too, and exit it.
|
|
||||||
|
|||||||
@@ -1,66 +0,0 @@
|
|||||||
// ombi's connections step — run once by the host after ombi's server starts, and run again whenever
|
|
||||||
// a binding or pair credential it reads changes (the container's `restart-on`, novox/hq ADR 0099).
|
|
||||||
// It brings ombi's connections to Sonarr, Radarr, Lidarr (servarr/settings.ts) and Plex
|
|
||||||
// (plex/settings.ts) in line with what the mesh bound.
|
|
||||||
//
|
|
||||||
// **A step, not a loop**, for the reason route-adapter gives: everything it does is a function of
|
|
||||||
// files the mesh writes, and the host already knows when they change. It connects to no broker.
|
|
||||||
//
|
|
||||||
// Exits non-zero when any app could not be put right — a refused credential, an unreachable app, an
|
|
||||||
// ombi that cannot reach it — so the node reports the step failed and the host runs it again on the
|
|
||||||
// next apply. It is declared last in the manifest, so its failing gates nothing else of ombi's
|
|
||||||
// (novox/hq ADR 0136). One app failing does not stop the others being put right.
|
|
||||||
//
|
|
||||||
// Reads, per provision, `<dir>/<provision>.json` (the binding) and `<dir>/<provision>.secret` (the
|
|
||||||
// pair credential), where <dir> is MESH_CONNECTIONS_DIR. Never prints a key or a token.
|
|
||||||
|
|
||||||
import { join } from "node:path";
|
|
||||||
|
|
||||||
import { PLEX_PROVISION, reconcilePlex } from "../plex/settings.js";
|
|
||||||
import { APPS, ombiReady, readBinding, readIfThere, reconcileApp, type Http, type Outcome } from "../servarr/settings.js";
|
|
||||||
|
|
||||||
const dir = process.env.MESH_CONNECTIONS_DIR ?? "/run/connections";
|
|
||||||
const url = process.env.MESH_OMBI_URL ?? "http://127.0.0.1:3579";
|
|
||||||
const apiKey = (await readIfThere(process.env.MESH_OMBI_API_KEY_FILE))?.trim() ?? process.env.MESH_OMBI_API_KEY ?? "";
|
|
||||||
const waitSeconds = Number(process.env.MESH_OMBI_WAIT_SECONDS ?? "180");
|
|
||||||
|
|
||||||
// Every call bounded: an entry ombi keeps may name a host that no longer answers, and a step that
|
|
||||||
// hangs on it holds the apply.
|
|
||||||
const http: Http = { fetch: (u, init) => fetch(u, { ...init, signal: AbortSignal.timeout(20_000) }) };
|
|
||||||
|
|
||||||
if (!apiKey) {
|
|
||||||
console.error("[ombi-connections] no ombi API key — ombi's own `api-key` secret has not been accepted");
|
|
||||||
process.exit(1);
|
|
||||||
}
|
|
||||||
const ombi = { url, apiKey };
|
|
||||||
|
|
||||||
if (!(await ombiReady(http, ombi, waitSeconds * 1000))) {
|
|
||||||
console.error(`[ombi-connections] ombi did not answer at ${url} within ${waitSeconds}s`);
|
|
||||||
process.exit(1);
|
|
||||||
}
|
|
||||||
|
|
||||||
const inputs = async (provision: string) =>
|
|
||||||
[await readBinding(join(dir, `${provision}.json`)), await readIfThere(join(dir, `${provision}.secret`))] as const;
|
|
||||||
|
|
||||||
const outcomes: Outcome[] = [];
|
|
||||||
for (const spec of APPS) {
|
|
||||||
outcomes.push(await reconcileApp(http, ombi, spec, ...(await inputs(spec.provision))));
|
|
||||||
}
|
|
||||||
outcomes.push(await reconcilePlex(http, ombi, ...(await inputs(PLEX_PROVISION))));
|
|
||||||
|
|
||||||
let failed = 0;
|
|
||||||
for (const outcome of outcomes) {
|
|
||||||
switch (outcome.result) {
|
|
||||||
case "unchanged":
|
|
||||||
console.log(`[ombi-connections] ${outcome.app}: already as the mesh says; connection tested`);
|
|
||||||
break;
|
|
||||||
case "written":
|
|
||||||
console.log(`[ombi-connections] ${outcome.app}: wrote ${outcome.fields.join(", ")}; connection tested`);
|
|
||||||
break;
|
|
||||||
case "refused":
|
|
||||||
failed++;
|
|
||||||
console.error(`[ombi-connections] ${outcome.app}: ${outcome.problem}`);
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
process.exitCode = failed > 0 ? 1 : 0;
|
|
||||||
+10
-65
@@ -28,15 +28,10 @@
|
|||||||
"path": "/var/lib/mesh/ombi",
|
"path": "/var/lib/mesh/ombi",
|
||||||
"mode": "0700"
|
"mode": "0700"
|
||||||
},
|
},
|
||||||
{
|
|
||||||
"id": "state",
|
|
||||||
"type": "directory",
|
|
||||||
"mode": "0700",
|
|
||||||
"place": "."
|
|
||||||
},
|
|
||||||
{
|
{
|
||||||
"id": "config",
|
"id": "config",
|
||||||
"type": "directory",
|
"type": "directory",
|
||||||
|
"path": "/services/ombi/config",
|
||||||
"mode": "0700",
|
"mode": "0700",
|
||||||
"owner": "1000:1000"
|
"owner": "1000:1000"
|
||||||
},
|
},
|
||||||
@@ -44,7 +39,7 @@
|
|||||||
"id": "server",
|
"id": "server",
|
||||||
"type": "container",
|
"type": "container",
|
||||||
"name": "ombi",
|
"name": "ombi",
|
||||||
"image": "lscr.io/linuxserver/ombi@sha256:22d6ebadbaaa728571353e74dc2173719e0fb02d4eaec551a7e9d2ee99ef68ac",
|
"image": "lscr.io/linuxserver/ombi@sha256:a6f76ac521ba01eee2e9f0c23a3fed22e56630d97a04d5eeaeaa36c1e681640d",
|
||||||
"env": {
|
"env": {
|
||||||
"PUID": "1000",
|
"PUID": "1000",
|
||||||
"PGID": "1000",
|
"PGID": "1000",
|
||||||
@@ -54,7 +49,7 @@
|
|||||||
"3579"
|
"3579"
|
||||||
],
|
],
|
||||||
"volumes": [
|
"volumes": [
|
||||||
"${dir:config}:/config"
|
"/services/ombi/config:/config"
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
@@ -73,64 +68,24 @@
|
|||||||
"volumes": [
|
"volumes": [
|
||||||
"/var/lib/mesh/ombi/broker:/run/secrets/broker:ro",
|
"/var/lib/mesh/ombi/broker:/run/secrets/broker:ro",
|
||||||
"/var/lib/mesh/ombi/api-key:/run/secrets/api-key:ro",
|
"/var/lib/mesh/ombi/api-key:/run/secrets/api-key:ro",
|
||||||
"/var/lib/mesh/ombi/config.json:/run/config/config.json:ro"
|
"/var/lib/mesh/ombi/config.json:/run/config/config.json:ro",
|
||||||
|
"/services/ombi/config:/var/lib/ombi/config:ro"
|
||||||
],
|
],
|
||||||
"env": {
|
"env": {
|
||||||
"MESH_BROKER_FILE": "/run/secrets/broker",
|
"MESH_BROKER_FILE": "/run/secrets/broker",
|
||||||
"MESH_OMBI_URL": "http://127.0.0.1:${port:3579}",
|
"MESH_OMBI_URL": "http://127.0.0.1:3579",
|
||||||
"MESH_OMBI_API_KEY_FILE": "/run/secrets/api-key",
|
"MESH_OMBI_API_KEY_FILE": "/run/secrets/api-key",
|
||||||
"MESH_OMBI_CONFIG_FILE": "/run/config/config.json"
|
"MESH_OMBI_CONFIG_FILE": "/run/config/config.json",
|
||||||
|
"MESH_OMBI_CONFIG_DIR": "/var/lib/ombi/config"
|
||||||
},
|
},
|
||||||
"restart-on": [
|
"restart-on": [
|
||||||
"runtime-config"
|
"runtime-config"
|
||||||
],
|
],
|
||||||
"artifact": "runtime"
|
"artifact": "runtime"
|
||||||
},
|
|
||||||
{
|
|
||||||
"id": "connections",
|
|
||||||
"type": "container",
|
|
||||||
"name": "mesh-ombi-connections",
|
|
||||||
"network": "host",
|
|
||||||
"run-once": true,
|
|
||||||
"volumes": [
|
|
||||||
"/var/lib/mesh/ombi/api-key:/run/secrets/api-key:ro",
|
|
||||||
"${dir:state}/sonarr-api.json:/run/connections/sonarr-api.json:ro",
|
|
||||||
"${dir:state}/sonarr-api.secret:/run/connections/sonarr-api.secret:ro",
|
|
||||||
"${dir:state}/radarr-api.json:/run/connections/radarr-api.json:ro",
|
|
||||||
"${dir:state}/radarr-api.secret:/run/connections/radarr-api.secret:ro",
|
|
||||||
"${dir:state}/lidarr-api.json:/run/connections/lidarr-api.json:ro",
|
|
||||||
"${dir:state}/lidarr-api.secret:/run/connections/lidarr-api.secret:ro",
|
|
||||||
"${dir:state}/plex-api.json:/run/connections/plex-api.json:ro",
|
|
||||||
"${dir:state}/plex-api.secret:/run/connections/plex-api.secret:ro"
|
|
||||||
],
|
|
||||||
"env": {
|
|
||||||
"MESH_OMBI_URL": "http://127.0.0.1:${port:3579}",
|
|
||||||
"MESH_OMBI_API_KEY_FILE": "/run/secrets/api-key",
|
|
||||||
"MESH_CONNECTIONS_DIR": "/run/connections"
|
|
||||||
},
|
|
||||||
"args": [
|
|
||||||
"run",
|
|
||||||
"/app/modules/ombi/dist/connections/index.js"
|
|
||||||
],
|
|
||||||
"restart-on": [
|
|
||||||
"bound-sonarr-api",
|
|
||||||
"secret-sonarr-api",
|
|
||||||
"bound-radarr-api",
|
|
||||||
"secret-radarr-api",
|
|
||||||
"bound-lidarr-api",
|
|
||||||
"secret-lidarr-api",
|
|
||||||
"bound-plex-api",
|
|
||||||
"secret-plex-api"
|
|
||||||
],
|
|
||||||
"artifact": "runtime"
|
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"requires": [
|
"requires": [
|
||||||
"lidarr-api",
|
"route"
|
||||||
"plex-api",
|
|
||||||
"radarr-api",
|
|
||||||
"route",
|
|
||||||
"sonarr-api"
|
|
||||||
],
|
],
|
||||||
"contributes": {
|
"contributes": {
|
||||||
"route": {
|
"route": {
|
||||||
@@ -139,17 +94,7 @@
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
"binds": {
|
"binds": {
|
||||||
"route": "${dir:state}/route.json",
|
"route": "/var/lib/mesh/ombi/route.json"
|
||||||
"sonarr-api": "${dir:state}/sonarr-api.json",
|
|
||||||
"radarr-api": "${dir:state}/radarr-api.json",
|
|
||||||
"lidarr-api": "${dir:state}/lidarr-api.json",
|
|
||||||
"plex-api": "${dir:state}/plex-api.json"
|
|
||||||
},
|
|
||||||
"secrets": {
|
|
||||||
"sonarr-api": "${dir:state}/sonarr-api.secret",
|
|
||||||
"radarr-api": "${dir:state}/radarr-api.secret",
|
|
||||||
"lidarr-api": "${dir:state}/lidarr-api.secret",
|
|
||||||
"plex-api": "${dir:state}/plex-api.secret"
|
|
||||||
},
|
},
|
||||||
"build": {
|
"build": {
|
||||||
"on": [
|
"on": [
|
||||||
|
|||||||
@@ -4,11 +4,6 @@
|
|||||||
"description": "ombi — media requests. Its API client, tools and events live here (novox/hq ADR 0039).",
|
"description": "ombi — media requests. Its API client, tools and events live here (novox/hq ADR 0039).",
|
||||||
"type": "module",
|
"type": "module",
|
||||||
"private": true,
|
"private": true,
|
||||||
"scripts": {
|
|
||||||
"build": "tsc client.ts index.ts tools/index.ts servarr/settings.ts plex/settings.ts connections/index.ts --module NodeNext --moduleResolution NodeNext --target ES2022 --outDir dist",
|
|
||||||
"typecheck": "tsc -p tsconfig.json",
|
|
||||||
"test": "npm run build && node --test --experimental-strip-types 'test/*.test.ts'"
|
|
||||||
},
|
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@novox/mesh-sdk": "^0.1.0"
|
"@novox/mesh-sdk": "^0.1.0"
|
||||||
},
|
},
|
||||||
|
|||||||
@@ -1,271 +0,0 @@
|
|||||||
// Where ombi reaches Plex — decided by the mesh, written into ombi by ombi's own API.
|
|
||||||
//
|
|
||||||
// **Why this exists.** ombi keeps its Plex servers in its own database (OmbiSettings.db), so the
|
|
||||||
// mesh has no file to write `${bound:plex-api:at}` into. ombi requires `plex-api`; the mesh delivers
|
|
||||||
// a binding (where plex is: `at`, and what it serves: `port`, `scheme`) and a pair credential (the
|
|
||||||
// server owner's X-Plex-Token, accepted by the operator — plex.tv issues it and the mesh cannot
|
|
||||||
// mint it). This step makes ombi's Plex settings say the same thing, beside its Servarr ones.
|
|
||||||
//
|
|
||||||
// **Which entry is plex's.** ombi may list several Plex servers. The one this provision names is
|
|
||||||
// found by the server's own machineIdentifier, which plex answers at /identity — the same value
|
|
||||||
// ombi stored when an operator loaded the server in its settings screen. That entry's connection is
|
|
||||||
// brought in line; an entry for any other server is never touched.
|
|
||||||
//
|
|
||||||
// When no entry carries that identifier, an entry may still be this server reached another way:
|
|
||||||
// ace's ombi holds one loaded from an older server and later retyped to plex's public name, so its
|
|
||||||
// stored identifier is stale while its address answers as this plex. Each entry's OWN address is
|
|
||||||
// asked for /identity, and an entry plex itself answers for is this server's — adopted: its
|
|
||||||
// connection laid over and its identifier corrected (ombi builds its "view in Plex" links from it).
|
|
||||||
// Nothing is guessed: an entry whose address is unreachable, or answers as another server, is left
|
|
||||||
// as it was. Only when no entry is this server's either way is one added, named as plex names
|
|
||||||
// itself — it is the mesh's, so later runs keep it true.
|
|
||||||
//
|
|
||||||
// **Only the connection, and only when it differs.** Host, port, TLS, base path and token — and the
|
|
||||||
// identifier of an adopted entry. Whether Plex is enabled in ombi, watchlist import, the selected
|
|
||||||
// libraries, the batch size and everything else an operator chose are left exactly as they are.
|
|
||||||
//
|
|
||||||
// **A token plex refuses is never written.** Until the operator accepts the server's token for this
|
|
||||||
// pair, the mesh delivers a value it minted itself, which plex answers with 401 (or 400 on its own
|
|
||||||
// network). Writing it would replace a working token in ombi with a dead one, so the token is tried
|
|
||||||
// against plex first; refused, nothing is written and the step fails naming the `secret accept`.
|
|
||||||
|
|
||||||
import { isLoopback, ombiCall, type Binding, type Http, type Ombi, type Outcome } from "../servarr/settings.js";
|
|
||||||
|
|
||||||
/** The provision ombi requires for Plex — the manifest's `requires`, `binds` and `secrets` key. */
|
|
||||||
export const PLEX_PROVISION = "plex-api";
|
|
||||||
|
|
||||||
/** The connection fields ombi keeps for a Plex server — the only ones this step ever writes. */
|
|
||||||
export interface PlexConnection {
|
|
||||||
ip: string;
|
|
||||||
port: number;
|
|
||||||
ssl: boolean;
|
|
||||||
subDir: string | null;
|
|
||||||
plexAuthToken: string;
|
|
||||||
}
|
|
||||||
|
|
||||||
export type PlexWanted = { ok: true; connection: PlexConnection; from: string } | { ok: false; problem: string };
|
|
||||||
|
|
||||||
/** The connection the mesh says ombi should use, from the binding and the pair credential. */
|
|
||||||
export function wantedPlex(binding: Binding | undefined, credential: string | undefined): PlexWanted {
|
|
||||||
if (!binding) {
|
|
||||||
return { ok: false, problem: `no binding for ${PLEX_PROVISION} was delivered — the mesh writes it before this step runs` };
|
|
||||||
}
|
|
||||||
const at = typeof binding.at === "string" ? binding.at.trim() : "";
|
|
||||||
const serves = binding.serves ?? {};
|
|
||||||
const port = Number(serves.port);
|
|
||||||
if (!at) return { ok: false, problem: `the ${PLEX_PROVISION} binding names no host (at)` };
|
|
||||||
if (isLoopback(at)) {
|
|
||||||
return {
|
|
||||||
ok: false,
|
|
||||||
problem:
|
|
||||||
`the ${PLEX_PROVISION} binding says plex is at ${at}, which from ombi's own container is ombi itself. ` +
|
|
||||||
`The mesh hands loopback to a machine that is not on the private network; put it on the private ` +
|
|
||||||
`network so plex has an address ombi can dial`,
|
|
||||||
};
|
|
||||||
}
|
|
||||||
if (!Number.isInteger(port) || port <= 0 || port > 65535) {
|
|
||||||
return { ok: false, problem: `the ${PLEX_PROVISION} binding serves no usable port (${String(serves.port)})` };
|
|
||||||
}
|
|
||||||
const scheme = typeof serves.scheme === "string" && serves.scheme ? serves.scheme : "http";
|
|
||||||
if (scheme !== "http" && scheme !== "https") {
|
|
||||||
return { ok: false, problem: `the ${PLEX_PROVISION} binding serves scheme ${scheme}, which ombi cannot dial` };
|
|
||||||
}
|
|
||||||
const token = (credential ?? "").trim();
|
|
||||||
if (!token) return { ok: false, problem: `the ${PLEX_PROVISION} credential is empty or was not delivered` };
|
|
||||||
return {
|
|
||||||
ok: true,
|
|
||||||
from: typeof binding.from === "string" ? binding.from : "",
|
|
||||||
connection: { ip: at, port, ssl: scheme === "https", subDir: null, plexAuthToken: token },
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
/** plex's base URL as the step dials it — the same host and port ombi will be given. */
|
|
||||||
export function plexUrl(want: PlexConnection): string {
|
|
||||||
const host = want.ip.includes(":") && !want.ip.startsWith("[") ? `[${want.ip}]` : want.ip;
|
|
||||||
return `${want.ssl ? "https" : "http"}://${host}:${want.port}`;
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Which connection fields differ between an entry ombi holds and what the mesh says. Names only. */
|
|
||||||
export function differingPlex(current: Record<string, unknown> | undefined, want: PlexConnection): (keyof PlexConnection)[] {
|
|
||||||
const now = current ?? {};
|
|
||||||
const out: (keyof PlexConnection)[] = [];
|
|
||||||
if (String(now.ip ?? "") !== want.ip) out.push("ip");
|
|
||||||
if (Number(now.port ?? 0) !== want.port) out.push("port");
|
|
||||||
if (Boolean(now.ssl) !== want.ssl) out.push("ssl");
|
|
||||||
const sub = typeof now.subDir === "string" && now.subDir.trim() !== "" ? now.subDir : null;
|
|
||||||
if (sub !== want.subDir) out.push("subDir");
|
|
||||||
if (String(now.plexAuthToken ?? "") !== want.plexAuthToken) out.push("plexAuthToken");
|
|
||||||
return out;
|
|
||||||
}
|
|
||||||
|
|
||||||
async function plexGet(http: Http, want: PlexConnection, path: string, withToken: boolean) {
|
|
||||||
const headers: Record<string, string> = { Accept: "application/json" };
|
|
||||||
if (withToken) headers["X-Plex-Token"] = want.plexAuthToken;
|
|
||||||
return http.fetch(`${plexUrl(want)}${path}`, { method: "GET", headers });
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Does plex take this token? `true` it does; `false` it refused it — 401 or 403, or 400, which is
|
|
||||||
* what plex answers a token it never issued on a network it trusts. A thrown error when plex could
|
|
||||||
* not be asked.
|
|
||||||
*/
|
|
||||||
export async function plexTakes(http: Http, want: PlexConnection): Promise<{ takes: boolean; friendlyName?: string }> {
|
|
||||||
const res = await plexGet(http, want, "/", true);
|
|
||||||
if (res.status === 400 || res.status === 401 || res.status === 403) return { takes: false };
|
|
||||||
if (res.status < 200 || res.status >= 300) throw new Error(`plex answered ${res.status} at /`);
|
|
||||||
let friendlyName: string | undefined;
|
|
||||||
try {
|
|
||||||
const body = JSON.parse(await res.text()) as { MediaContainer?: { friendlyName?: unknown } };
|
|
||||||
if (typeof body.MediaContainer?.friendlyName === "string") friendlyName = body.MediaContainer.friendlyName;
|
|
||||||
} catch {
|
|
||||||
// a name is a nicety for a new entry, not a condition
|
|
||||||
}
|
|
||||||
return { takes: true, friendlyName };
|
|
||||||
}
|
|
||||||
|
|
||||||
/** The server's own machineIdentifier, which plex answers without a token. */
|
|
||||||
export async function plexIdentity(http: Http, want: Pick<PlexConnection, "ip" | "port" | "ssl" | "subDir">): Promise<string> {
|
|
||||||
const host = want.ip.includes(":") && !want.ip.startsWith("[") ? `[${want.ip}]` : want.ip;
|
|
||||||
const base = `${want.ssl ? "https" : "http"}://${host}:${want.port}${want.subDir ? `/${want.subDir.replace(/^\/+|\/+$/g, "")}` : ""}`;
|
|
||||||
const res = await http.fetch(`${base}/identity`, { method: "GET", headers: { Accept: "application/json" } });
|
|
||||||
if (res.status !== 200) throw new Error(`plex answered ${res.status} at /identity`);
|
|
||||||
const body = JSON.parse(await res.text()) as { MediaContainer?: { machineIdentifier?: unknown } };
|
|
||||||
const id = body.MediaContainer?.machineIdentifier;
|
|
||||||
if (typeof id !== "string" || id === "") throw new Error("plex's /identity names no machineIdentifier");
|
|
||||||
return id;
|
|
||||||
}
|
|
||||||
|
|
||||||
/** The remedy for a refused token, in the controller's own words (ADR 0092). */
|
|
||||||
export function plexAcceptRemedy(from: string): string {
|
|
||||||
return (
|
|
||||||
`plex refuses the ${PLEX_PROVISION} credential the mesh delivered, so it was not written into ombi. ` +
|
|
||||||
`plex's token is issued by plex.tv and the mesh cannot make it: accept the server's own token for ` +
|
|
||||||
`this pair — \`secret accept <this node> ombi ${PLEX_PROVISION} --provider ${from || "<its node>"} ` +
|
|
||||||
`--from <file holding the server's X-Plex-Token>\``
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
/** The batch size ombi's settings screen fills in for a server it adds ("150 by default"). */
|
|
||||||
const EPISODE_BATCH_SIZE = 150;
|
|
||||||
|
|
||||||
/** ombi's server entries, as its settings document holds them (null on a fresh ombi). */
|
|
||||||
export function serversOf(document: Record<string, unknown> | undefined): Record<string, unknown>[] {
|
|
||||||
const servers = document?.servers;
|
|
||||||
return Array.isArray(servers) ? (servers as Record<string, unknown>[]) : [];
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Which entries, holding another identifier, plex answers for at their own address — this server,
|
|
||||||
* reached another way. Asked only when no entry carries the identifier. An entry that cannot be
|
|
||||||
* asked is not this server's: nothing is guessed.
|
|
||||||
*/
|
|
||||||
export async function answeringAs(http: Http, servers: Record<string, unknown>[], machineIdentifier: string): Promise<Set<number>> {
|
|
||||||
const out = new Set<number>();
|
|
||||||
if (servers.some((s) => s?.machineIdentifier === machineIdentifier)) return out;
|
|
||||||
for (const [i, s] of servers.entries()) {
|
|
||||||
const ip = typeof s?.ip === "string" ? s.ip.trim() : "";
|
|
||||||
const port = Number(s?.port);
|
|
||||||
if (!ip || !Number.isInteger(port) || port <= 0 || port > 65535) continue;
|
|
||||||
const subDir = typeof s.subDir === "string" && s.subDir.trim() !== "" ? s.subDir : null;
|
|
||||||
try {
|
|
||||||
if ((await plexIdentity(http, { ip, port, ssl: Boolean(s.ssl), subDir })) === machineIdentifier) out.add(i);
|
|
||||||
} catch {
|
|
||||||
// unreachable, or not a plex: not this server's
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return out;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* ombi's Plex settings with this server's connection laid over them: every entry naming the
|
|
||||||
* server's machineIdentifier — or adopted, its address answering as this server — gets the
|
|
||||||
* connection (an adopted one also the identifier), every other entry is left as it was, and when
|
|
||||||
* none is this server's one is added. Returns the document to save and the fields that changed.
|
|
||||||
*/
|
|
||||||
export function withPlexServer(
|
|
||||||
document: Record<string, unknown> | undefined,
|
|
||||||
machineIdentifier: string,
|
|
||||||
want: PlexConnection,
|
|
||||||
name: string,
|
|
||||||
adopted: ReadonlySet<number> = new Set(),
|
|
||||||
): { next: Record<string, unknown>; fields: string[]; added: boolean; entry: Record<string, unknown> } {
|
|
||||||
const doc = document ?? {};
|
|
||||||
const servers = serversOf(doc);
|
|
||||||
const fields = new Set<string>();
|
|
||||||
let entry: Record<string, unknown> | undefined;
|
|
||||||
const next = servers.map((s, i) => {
|
|
||||||
const adopt = adopted.has(i) && s?.machineIdentifier !== machineIdentifier;
|
|
||||||
if (s?.machineIdentifier !== machineIdentifier && !adopt) return s;
|
|
||||||
for (const f of differingPlex(s, want)) fields.add(f);
|
|
||||||
if (adopt) fields.add("machineIdentifier");
|
|
||||||
const laid = { ...s, machineIdentifier, ip: want.ip, port: want.port, ssl: want.ssl, subDir: want.subDir, plexAuthToken: want.plexAuthToken };
|
|
||||||
entry ??= laid;
|
|
||||||
return laid;
|
|
||||||
});
|
|
||||||
if (entry) return { next: { ...doc, servers: next }, fields: [...fields], added: false, entry };
|
|
||||||
const added: Record<string, unknown> = {
|
|
||||||
name,
|
|
||||||
machineIdentifier,
|
|
||||||
ip: want.ip,
|
|
||||||
port: want.port,
|
|
||||||
ssl: want.ssl,
|
|
||||||
subDir: want.subDir,
|
|
||||||
plexAuthToken: want.plexAuthToken,
|
|
||||||
episodeBatchSize: EPISODE_BATCH_SIZE,
|
|
||||||
plexSelectedLibraries: [],
|
|
||||||
};
|
|
||||||
return { next: { ...doc, servers: [...next, added] }, fields: ["server"], added: true, entry: added };
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Bring ombi's connection to plex in line with the mesh: check the token against plex, find the
|
|
||||||
* server's entry by its machineIdentifier, write only the connection fields when they differ (or add
|
|
||||||
* the entry), then have ombi test the connection from its own container. Never throws.
|
|
||||||
*/
|
|
||||||
export async function reconcilePlex(http: Http, ombi: Ombi, binding: Binding | undefined, credential: string | undefined): Promise<Outcome> {
|
|
||||||
const app = "plex";
|
|
||||||
const w = wantedPlex(binding, credential);
|
|
||||||
// `in`, not `!w.ok`: the Dockerfile compiles without strict, where a boolean discriminant does not
|
|
||||||
// narrow.
|
|
||||||
if ("problem" in w) return { app, result: "refused", problem: w.problem };
|
|
||||||
const want = w.connection;
|
|
||||||
|
|
||||||
let name: string;
|
|
||||||
let machineIdentifier: string;
|
|
||||||
try {
|
|
||||||
const taken = await plexTakes(http, want);
|
|
||||||
if (!taken.takes) return { app, result: "refused", problem: plexAcceptRemedy(w.from) };
|
|
||||||
machineIdentifier = await plexIdentity(http, want);
|
|
||||||
name = taken.friendlyName || "Plex";
|
|
||||||
} catch (err) {
|
|
||||||
return { app, result: "refused", problem: `plex could not be asked whether it takes the token at ${want.ip}:${want.port}: ${message(err)}` };
|
|
||||||
}
|
|
||||||
|
|
||||||
try {
|
|
||||||
const document = (await ombiCall(http, ombi, "GET", "/Settings/Plex")) as Record<string, unknown> | undefined;
|
|
||||||
const adopted = await answeringAs(http, serversOf(document), machineIdentifier);
|
|
||||||
const laid = withPlexServer(document, machineIdentifier, want, name, adopted);
|
|
||||||
if (laid.fields.length > 0) {
|
|
||||||
const saved = await ombiCall(http, ombi, "POST", "/Settings/Plex", laid.next);
|
|
||||||
if (saved === false) return { app, result: "refused", problem: "ombi declined to save its Plex settings" };
|
|
||||||
}
|
|
||||||
// ombi's own test, from ombi's own container — the path the step's check above did not take.
|
|
||||||
const tested = await ombiCall(http, ombi, "POST", "/Tester/plex", laid.entry);
|
|
||||||
if (tested !== true) {
|
|
||||||
return {
|
|
||||||
app,
|
|
||||||
result: "refused",
|
|
||||||
problem:
|
|
||||||
`ombi cannot reach plex at ${want.ip}:${want.port} from its own container` +
|
|
||||||
(laid.fields.length > 0 ? `; its settings were written (${laid.fields.join(", ")})` : ""),
|
|
||||||
};
|
|
||||||
}
|
|
||||||
return laid.fields.length > 0 ? { app, result: "written", fields: laid.fields } : { app, result: "unchanged" };
|
|
||||||
} catch (err) {
|
|
||||||
return { app, result: "refused", problem: message(err) };
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
function message(err: unknown): string {
|
|
||||||
return err instanceof Error ? err.message : String(err);
|
|
||||||
}
|
|
||||||
@@ -1,304 +0,0 @@
|
|||||||
// Where ombi reaches Sonarr, Radarr and Lidarr — decided by the mesh, written into ombi by ombi's
|
|
||||||
// own API.
|
|
||||||
//
|
|
||||||
// **Why this exists.** ombi keeps its connection to each Servarr app in its own database
|
|
||||||
// (OmbiSettings.db), not in a file, so the mesh has nowhere to write `${bound:sonarr-api:at}` for it.
|
|
||||||
// ombi requires `sonarr-api`, `radarr-api` and `lidarr-api`; the mesh delivers, for each, a binding
|
|
||||||
// (where the app is: `at`, and what it serves: `port`, `scheme`, `url-base`) and a pair credential
|
|
||||||
// (the app's API key, accepted by the operator — a Servarr app has exactly one key and the mesh
|
|
||||||
// cannot mint it). This step reads those files and makes ombi's settings say the same thing.
|
|
||||||
//
|
|
||||||
// **Only the connection, and only when it differs.** Host, port, TLS, base path and API key. The
|
|
||||||
// quality profile, root folder, language profile, tags, "enabled" and every other choice an operator
|
|
||||||
// made in ombi's settings screen are left exactly as they are: the mesh knows where the app is, not
|
|
||||||
// what ombi should do with it. Radarr's 4K instance is a different Radarr and is not touched.
|
|
||||||
//
|
|
||||||
// **A credential the app refuses is never written.** Until the operator accepts the app's API key
|
|
||||||
// for this pair, the mesh delivers a value it minted itself, which no Servarr app will ever accept
|
|
||||||
// (novox/hq ADR 0092). Writing it would replace a working key in ombi with a dead one. So the key is
|
|
||||||
// tried against the app first; refused, nothing for that app is written and the step fails naming
|
|
||||||
// the `secret accept` that fixes it.
|
|
||||||
//
|
|
||||||
// Pure logic and a small HTTP seam, so it is tested against fake servers (test/servarr.test.ts).
|
|
||||||
|
|
||||||
import { readFile } from "node:fs/promises";
|
|
||||||
|
|
||||||
/** One Servarr app ombi connects to, and the shape of that connection in ombi's API. */
|
|
||||||
export interface ServarrApp {
|
|
||||||
/** The app, as ombi's API names it: /Settings/<app>, /Tester/<app>. */
|
|
||||||
app: "sonarr" | "radarr" | "lidarr";
|
|
||||||
/** The provision it is required as — the manifest's `requires`, `binds` and `secrets` key. */
|
|
||||||
provision: string;
|
|
||||||
/** The app's own status endpoint, which answers 401 to a wrong key. */
|
|
||||||
statusPath: string;
|
|
||||||
/**
|
|
||||||
* Where the one connection sits in ombi's settings document. Radarr's is `{radarr, radarr4K}`
|
|
||||||
* (two Radarr instances); only `radarr` is this provision's.
|
|
||||||
*/
|
|
||||||
within?: string;
|
|
||||||
}
|
|
||||||
|
|
||||||
export const APPS: readonly ServarrApp[] = [
|
|
||||||
{ app: "sonarr", provision: "sonarr-api", statusPath: "/api/v3/system/status" },
|
|
||||||
{ app: "radarr", provision: "radarr-api", statusPath: "/api/v3/system/status", within: "radarr" },
|
|
||||||
{ app: "lidarr", provision: "lidarr-api", statusPath: "/api/v1/system/status" },
|
|
||||||
];
|
|
||||||
|
|
||||||
/** The connection fields ombi keeps for an app — the only ones this step ever writes. */
|
|
||||||
export interface Connection {
|
|
||||||
ip: string;
|
|
||||||
port: number;
|
|
||||||
ssl: boolean;
|
|
||||||
/** ombi's name for the app's URL base; null when the app is served at the root. */
|
|
||||||
subDir: string | null;
|
|
||||||
apiKey: string;
|
|
||||||
}
|
|
||||||
|
|
||||||
/** What the mesh wrote at `binds.<provision>`: the binding document (controller's boundFile). */
|
|
||||||
export interface Binding {
|
|
||||||
provision?: string;
|
|
||||||
from?: string;
|
|
||||||
at?: string;
|
|
||||||
as?: string;
|
|
||||||
serves?: Record<string, unknown>;
|
|
||||||
}
|
|
||||||
|
|
||||||
export type Wanted = { ok: true; connection: Connection; from: string } | { ok: false; problem: string };
|
|
||||||
|
|
||||||
/**
|
|
||||||
* The connection the mesh says ombi should use, from the binding and the pair credential.
|
|
||||||
*
|
|
||||||
* Refused rather than guessed when the binding cannot be dialled from ombi's own container: a
|
|
||||||
* loopback `at` — what the mesh hands a machine that is not on the private network — is ombi's
|
|
||||||
* container itself, not the app.
|
|
||||||
*/
|
|
||||||
export function wanted(spec: ServarrApp, binding: Binding | undefined, credential: string | undefined): Wanted {
|
|
||||||
if (!binding) {
|
|
||||||
return { ok: false, problem: `no binding for ${spec.provision} was delivered — the mesh writes it before this step runs` };
|
|
||||||
}
|
|
||||||
const at = typeof binding.at === "string" ? binding.at.trim() : "";
|
|
||||||
const serves = binding.serves ?? {};
|
|
||||||
const port = Number(serves.port);
|
|
||||||
if (!at) {
|
|
||||||
return { ok: false, problem: `the ${spec.provision} binding names no host (at)` };
|
|
||||||
}
|
|
||||||
if (isLoopback(at)) {
|
|
||||||
return {
|
|
||||||
ok: false,
|
|
||||||
problem:
|
|
||||||
`the ${spec.provision} binding says ${spec.app} is at ${at}, which from ombi's own container is ` +
|
|
||||||
`ombi itself. The mesh hands loopback to a machine that is not on the private network; put it ` +
|
|
||||||
`on the private network so ${spec.app} has an address ombi can dial`,
|
|
||||||
};
|
|
||||||
}
|
|
||||||
if (!Number.isInteger(port) || port <= 0 || port > 65535) {
|
|
||||||
return { ok: false, problem: `the ${spec.provision} binding serves no usable port (${String(serves.port)})` };
|
|
||||||
}
|
|
||||||
const scheme = typeof serves.scheme === "string" && serves.scheme ? serves.scheme : "http";
|
|
||||||
if (scheme !== "http" && scheme !== "https") {
|
|
||||||
return { ok: false, problem: `the ${spec.provision} binding serves scheme ${scheme}, which ombi cannot dial` };
|
|
||||||
}
|
|
||||||
const key = (credential ?? "").trim();
|
|
||||||
if (!key) {
|
|
||||||
return { ok: false, problem: `the ${spec.provision} credential is empty or was not delivered` };
|
|
||||||
}
|
|
||||||
return {
|
|
||||||
ok: true,
|
|
||||||
from: typeof binding.from === "string" ? binding.from : "",
|
|
||||||
connection: { ip: at, port, ssl: scheme === "https", subDir: subDirOf(serves["url-base"]), apiKey: key },
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
/** ombi's `subDir`: the URL base with its slashes trimmed, null when there is none. */
|
|
||||||
export function subDirOf(urlBase: unknown): string | null {
|
|
||||||
const trimmed = typeof urlBase === "string" ? urlBase.trim().replace(/^\/+|\/+$/g, "") : "";
|
|
||||||
return trimmed === "" ? null : trimmed;
|
|
||||||
}
|
|
||||||
|
|
||||||
export function isLoopback(host: string): boolean {
|
|
||||||
const h = host.toLowerCase();
|
|
||||||
return h === "localhost" || h === "::1" || h === "[::1]" || /^127\./.test(h);
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Which connection fields differ between what ombi holds and what the mesh says. Names only. */
|
|
||||||
export function differing(current: Record<string, unknown> | undefined, want: Connection): (keyof Connection)[] {
|
|
||||||
const now = current ?? {};
|
|
||||||
const out: (keyof Connection)[] = [];
|
|
||||||
if (String(now.ip ?? "") !== want.ip) out.push("ip");
|
|
||||||
if (Number(now.port ?? 0) !== want.port) out.push("port");
|
|
||||||
if (Boolean(now.ssl) !== want.ssl) out.push("ssl");
|
|
||||||
if (subDirOf(now.subDir) !== want.subDir) out.push("subDir");
|
|
||||||
if (String(now.apiKey ?? "") !== want.apiKey) out.push("apiKey");
|
|
||||||
return out;
|
|
||||||
}
|
|
||||||
|
|
||||||
/** ombi's settings for the app with the connection laid over them and nothing else changed. */
|
|
||||||
export function withConnection(current: Record<string, unknown> | undefined, want: Connection): Record<string, unknown> {
|
|
||||||
return { ...(current ?? {}), ip: want.ip, port: want.port, ssl: want.ssl, subDir: want.subDir, apiKey: want.apiKey };
|
|
||||||
}
|
|
||||||
|
|
||||||
/** The app's base URL as the step dials it — the same host and port ombi will be given. */
|
|
||||||
export function appUrl(want: Connection): string {
|
|
||||||
const scheme = want.ssl ? "https" : "http";
|
|
||||||
const host = want.ip.includes(":") && !want.ip.startsWith("[") ? `[${want.ip}]` : want.ip;
|
|
||||||
return `${scheme}://${host}:${want.port}${want.subDir ? `/${want.subDir}` : ""}`;
|
|
||||||
}
|
|
||||||
|
|
||||||
/** How one app came out. */
|
|
||||||
export type Outcome =
|
|
||||||
| { app: string; result: "unchanged" }
|
|
||||||
| { app: string; result: "written"; fields: string[] }
|
|
||||||
| { app: string; result: "refused"; problem: string };
|
|
||||||
|
|
||||||
/** The HTTP the step needs, so a test can stand fakes in for ombi and the apps. */
|
|
||||||
export interface Http {
|
|
||||||
fetch(url: string, init?: { method?: string; headers?: Record<string, string>; body?: string }): Promise<{
|
|
||||||
status: number;
|
|
||||||
text(): Promise<string>;
|
|
||||||
}>;
|
|
||||||
}
|
|
||||||
|
|
||||||
export interface Ombi {
|
|
||||||
url: string;
|
|
||||||
apiKey: string;
|
|
||||||
}
|
|
||||||
|
|
||||||
export async function ombiCall(http: Http, ombi: Ombi, method: string, path: string, body?: unknown): Promise<unknown> {
|
|
||||||
const res = await http.fetch(`${ombi.url.replace(/\/$/, "")}/api/v1${path}`, {
|
|
||||||
method,
|
|
||||||
headers: {
|
|
||||||
ApiKey: ombi.apiKey,
|
|
||||||
Accept: "application/json",
|
|
||||||
...(body !== undefined ? { "Content-Type": "application/json" } : {}),
|
|
||||||
},
|
|
||||||
body: body !== undefined ? JSON.stringify(body) : undefined,
|
|
||||||
});
|
|
||||||
const text = await res.text();
|
|
||||||
if (res.status < 200 || res.status >= 300) {
|
|
||||||
// The body is ombi's error, never a request echo, so it carries no key.
|
|
||||||
throw new Error(`ombi ${method} ${path} answered ${res.status}${text ? `: ${text.slice(0, 200)}` : ""}`);
|
|
||||||
}
|
|
||||||
return text ? (JSON.parse(text) as unknown) : undefined;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Does the app take this key? `true` it does, `false` it refused it (401/403), and a thrown error
|
|
||||||
* when it could not be asked — unreachable, or answering something that is neither.
|
|
||||||
*/
|
|
||||||
export async function appTakes(http: Http, spec: ServarrApp, want: Connection): Promise<boolean> {
|
|
||||||
const res = await http.fetch(`${appUrl(want)}${spec.statusPath}`, {
|
|
||||||
method: "GET",
|
|
||||||
headers: { "X-Api-Key": want.apiKey, Accept: "application/json" },
|
|
||||||
});
|
|
||||||
if (res.status === 401 || res.status === 403) return false;
|
|
||||||
if (res.status >= 200 && res.status < 300) return true;
|
|
||||||
throw new Error(`${spec.app} answered ${res.status} at ${spec.statusPath}`);
|
|
||||||
}
|
|
||||||
|
|
||||||
/** The remedy for a refused key, in the controller's own words (ADR 0092). */
|
|
||||||
export function acceptRemedy(spec: ServarrApp, from: string): string {
|
|
||||||
return (
|
|
||||||
`${spec.app} refuses the ${spec.provision} credential the mesh delivered, so it was not written ` +
|
|
||||||
`into ombi. A Servarr app has one API key and the mesh cannot make it: accept ${spec.app}'s own ` +
|
|
||||||
`key for this pair — \`secret accept <this node> ombi ${spec.provision} --provider ${from || "<its node>"} ` +
|
|
||||||
`--from <file holding ${spec.app}'s ApiKey>\``
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Bring ombi's connection to one app in line with the mesh: check the key against the app, compare,
|
|
||||||
* write only the connection fields when they differ, then have ombi test the connection from its own
|
|
||||||
* container. Never throws: every failure is an outcome with a reason.
|
|
||||||
*/
|
|
||||||
export async function reconcileApp(
|
|
||||||
http: Http,
|
|
||||||
ombi: Ombi,
|
|
||||||
spec: ServarrApp,
|
|
||||||
binding: Binding | undefined,
|
|
||||||
credential: string | undefined,
|
|
||||||
): Promise<Outcome> {
|
|
||||||
const w = wanted(spec, binding, credential);
|
|
||||||
// `in`, not `!w.ok`: the Dockerfile compiles without strict, where a boolean discriminant does not
|
|
||||||
// narrow.
|
|
||||||
if ("problem" in w) return { app: spec.app, result: "refused", problem: w.problem };
|
|
||||||
const want = w.connection;
|
|
||||||
|
|
||||||
try {
|
|
||||||
if (!(await appTakes(http, spec, want))) {
|
|
||||||
return { app: spec.app, result: "refused", problem: acceptRemedy(spec, w.from) };
|
|
||||||
}
|
|
||||||
} catch (err) {
|
|
||||||
return {
|
|
||||||
app: spec.app,
|
|
||||||
result: "refused",
|
|
||||||
problem: `${spec.app} could not be asked whether it takes the key at ${want.ip}:${want.port}: ${message(err)}`,
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
try {
|
|
||||||
const document = (await ombiCall(http, ombi, "GET", `/Settings/${spec.app}`)) as Record<string, unknown> | undefined;
|
|
||||||
const current = spec.within ? (document?.[spec.within] as Record<string, unknown> | undefined) : document;
|
|
||||||
const fields = differing(current, want);
|
|
||||||
if (fields.length > 0) {
|
|
||||||
const next = withConnection(current, want);
|
|
||||||
const body = spec.within ? { ...(document ?? {}), [spec.within]: next } : next;
|
|
||||||
const saved = await ombiCall(http, ombi, "POST", `/Settings/${spec.app}`, body);
|
|
||||||
if (saved === false) {
|
|
||||||
return { app: spec.app, result: "refused", problem: `ombi declined to save its ${spec.app} settings` };
|
|
||||||
}
|
|
||||||
}
|
|
||||||
// ombi's own test, from ombi's own container — the path the step's check above did not take.
|
|
||||||
const tested = (await ombiCall(http, ombi, "POST", `/Tester/${spec.app}`, withConnection(current, want))) as
|
|
||||||
| { isValid?: boolean; expectedSubDir?: string | null }
|
|
||||||
| undefined;
|
|
||||||
if (!tested?.isValid) {
|
|
||||||
const hint = tested?.expectedSubDir ? ` (ombi expected the base path ${tested.expectedSubDir})` : "";
|
|
||||||
return {
|
|
||||||
app: spec.app,
|
|
||||||
result: "refused",
|
|
||||||
problem:
|
|
||||||
`ombi cannot reach ${spec.app} at ${want.ip}:${want.port} from its own container${hint}` +
|
|
||||||
(fields.length > 0 ? `; its settings were written (${fields.join(", ")})` : ""),
|
|
||||||
};
|
|
||||||
}
|
|
||||||
return fields.length > 0 ? { app: spec.app, result: "written", fields } : { app: spec.app, result: "unchanged" };
|
|
||||||
} catch (err) {
|
|
||||||
return { app: spec.app, result: "refused", problem: message(err) };
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/** Wait for ombi to answer, because the step runs right after its container starts. */
|
|
||||||
export async function ombiReady(http: Http, ombi: Ombi, waitMs: number, pauseMs = 2000): Promise<boolean> {
|
|
||||||
const until = Date.now() + waitMs;
|
|
||||||
for (;;) {
|
|
||||||
try {
|
|
||||||
const res = await http.fetch(`${ombi.url.replace(/\/$/, "")}/api/v1/Status`, { method: "GET" });
|
|
||||||
if (res.status === 200) return true;
|
|
||||||
} catch {
|
|
||||||
// not listening yet
|
|
||||||
}
|
|
||||||
if (Date.now() >= until) return false;
|
|
||||||
await new Promise((r) => setTimeout(r, pauseMs));
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/** A file the mesh wrote, or undefined when it is not there. */
|
|
||||||
export async function readIfThere(path: string | undefined): Promise<string | undefined> {
|
|
||||||
if (!path) return undefined;
|
|
||||||
return readFile(path, "utf8").catch(() => undefined);
|
|
||||||
}
|
|
||||||
|
|
||||||
/** A binding file parsed, or undefined when absent or not JSON. */
|
|
||||||
export async function readBinding(path: string | undefined): Promise<Binding | undefined> {
|
|
||||||
const raw = await readIfThere(path);
|
|
||||||
if (raw === undefined) return undefined;
|
|
||||||
try {
|
|
||||||
return JSON.parse(raw) as Binding;
|
|
||||||
} catch {
|
|
||||||
return undefined;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
function message(err: unknown): string {
|
|
||||||
return err instanceof Error ? err.message : String(err);
|
|
||||||
}
|
|
||||||
@@ -1,223 +0,0 @@
|
|||||||
// What holds ombi's Plex step (plex/settings.ts): the entry for the server plex says it is — found
|
|
||||||
// by machineIdentifier — is made to say what the mesh bound (host, port, TLS, token) and nothing
|
|
||||||
// else it keeps is touched; an entry for another server is left alone; an ombi with no entry for it
|
|
||||||
// gets one; nothing is written when nothing differs; and a token plex refuses (the mesh's own minted
|
|
||||||
// value, before the operator accepts the server's token) is never written, with the `secret accept`
|
|
||||||
// that fixes it named.
|
|
||||||
//
|
|
||||||
// ombi and plex are fakes answering the routes the step touches as the real ones do (checked against
|
|
||||||
// lscr.io/linuxserver/ombi 4.53.10 and plexinc/pms-docker 1.43.4: plex answers 401 to an unknown
|
|
||||||
// token from another network and 400 on one it trusts; ombi's /Tester/plex answers a bare boolean).
|
|
||||||
//
|
|
||||||
// Imports the compiled step, as keycloak's tests do: plex/settings.ts imports its sibling with the
|
|
||||||
// `.js` specifier the build needs, which Node's type stripping does not resolve to a `.ts` file.
|
|
||||||
|
|
||||||
import { test } from "node:test";
|
|
||||||
import assert from "node:assert/strict";
|
|
||||||
|
|
||||||
import { differingPlex, reconcilePlex, wantedPlex, withPlexServer } from "../dist/plex/settings.js";
|
|
||||||
import type { Binding, Http } from "../servarr/settings.ts";
|
|
||||||
|
|
||||||
const TOKEN = "the-servers-own-token";
|
|
||||||
const MACHINE = "5c47d9a165d10b622995d55b3ae1f168242f33bd";
|
|
||||||
const OMBI = { url: "http://127.0.0.1:3579", apiKey: "ombi-key" };
|
|
||||||
|
|
||||||
function binding(port = 32400, at = "ace.internal", scheme = "http"): Binding {
|
|
||||||
return { binding: 1, provision: "plex-api", from: "ace", at, as: "mesh_ace_ombi", serves: { scheme, port } } as Binding;
|
|
||||||
}
|
|
||||||
|
|
||||||
interface Call {
|
|
||||||
method: string;
|
|
||||||
url: string;
|
|
||||||
body?: unknown;
|
|
||||||
}
|
|
||||||
|
|
||||||
function fakes(plexSettings: Record<string, unknown>, opts: { reachable?: boolean; trusted?: boolean } = {}) {
|
|
||||||
const calls: Call[] = [];
|
|
||||||
const store = { plex: plexSettings };
|
|
||||||
const http: Http = {
|
|
||||||
async fetch(url, init) {
|
|
||||||
const method = init?.method ?? "GET";
|
|
||||||
const body = init?.body ? (JSON.parse(init.body) as unknown) : undefined;
|
|
||||||
calls.push({ method, url, body });
|
|
||||||
const reply = (status: number, value?: unknown) => ({
|
|
||||||
status,
|
|
||||||
text: async () => (value === undefined ? "" : JSON.stringify(value)),
|
|
||||||
});
|
|
||||||
const u = new URL(url);
|
|
||||||
// Other servers an entry may name: a friend's, and plex's own public name (the same server).
|
|
||||||
if (u.hostname === "10.0.0.9") return reply(200, { MediaContainer: { machineIdentifier: "another-server" } });
|
|
||||||
if (u.hostname === "gone.example") throw new Error("getaddrinfo ENOTFOUND");
|
|
||||||
if (u.hostname === "plex.zurag.be") {
|
|
||||||
if (u.pathname === "/identity") return reply(200, { MediaContainer: { machineIdentifier: MACHINE } });
|
|
||||||
return reply(401);
|
|
||||||
}
|
|
||||||
if (u.port === "32400" || u.hostname === "ace.internal") {
|
|
||||||
if (opts.reachable === false) throw new Error("connect ECONNREFUSED");
|
|
||||||
if (u.pathname === "/identity") return reply(200, { MediaContainer: { machineIdentifier: MACHINE } });
|
|
||||||
const token = init?.headers?.["X-Plex-Token"];
|
|
||||||
if (token !== TOKEN) return reply(opts.trusted ? 400 : 401);
|
|
||||||
return reply(200, { MediaContainer: { friendlyName: "ace", machineIdentifier: MACHINE } });
|
|
||||||
}
|
|
||||||
if (init?.headers?.ApiKey !== "ombi-key") return reply(401);
|
|
||||||
if (u.pathname === "/api/v1/Settings/Plex" && method === "GET") return reply(200, store.plex);
|
|
||||||
if (u.pathname === "/api/v1/Settings/Plex" && method === "POST") {
|
|
||||||
store.plex = body as Record<string, unknown>;
|
|
||||||
return reply(200, true);
|
|
||||||
}
|
|
||||||
if (u.pathname === "/api/v1/Tester/plex") {
|
|
||||||
const tried = body as { plexAuthToken?: string; ip?: string };
|
|
||||||
return reply(200, tried.plexAuthToken === TOKEN && tried.ip === "ace.internal");
|
|
||||||
}
|
|
||||||
return reply(404);
|
|
||||||
},
|
|
||||||
};
|
|
||||||
return { http, calls, store };
|
|
||||||
}
|
|
||||||
|
|
||||||
// What an operator's ombi holds: plex loaded through its public name, plus a friend's server.
|
|
||||||
const operatorPlex = () => ({
|
|
||||||
enable: true,
|
|
||||||
enableWatchlistImport: true,
|
|
||||||
monitorAll: false,
|
|
||||||
installId: "b358a2a2-2ab0-4025-a3f3-450313c3c418",
|
|
||||||
servers: [
|
|
||||||
{
|
|
||||||
name: "ace", plexAuthToken: TOKEN, machineIdentifier: MACHINE, episodeBatchSize: 150,
|
|
||||||
serverHostname: "https://app.plex.tv", plexSelectedLibraries: [{ key: "1", title: "Films", enabled: true }],
|
|
||||||
ssl: true, subDir: null, ip: "plex.zurag.be", port: 443, id: 1,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "a friend", plexAuthToken: "their-token", machineIdentifier: "another-server", episodeBatchSize: 150,
|
|
||||||
plexSelectedLibraries: [], ssl: false, subDir: null, ip: "10.0.0.9", port: 32400, id: 2,
|
|
||||||
},
|
|
||||||
],
|
|
||||||
id: 4,
|
|
||||||
});
|
|
||||||
|
|
||||||
test("the server's own entry gets the bound connection; its libraries and every other setting stay", async () => {
|
|
||||||
const f = fakes(operatorPlex());
|
|
||||||
const out = await reconcilePlex(f.http, OMBI, binding(), `${TOKEN}\n`);
|
|
||||||
assert.deepEqual(out, { app: "plex", result: "written", fields: ["ip", "port", "ssl"] });
|
|
||||||
const want = operatorPlex();
|
|
||||||
Object.assign(want.servers[0], { ip: "ace.internal", port: 32400, ssl: false });
|
|
||||||
assert.deepEqual(f.store.plex, want);
|
|
||||||
});
|
|
||||||
|
|
||||||
test("another server's entry is never touched", async () => {
|
|
||||||
const f = fakes(operatorPlex());
|
|
||||||
await reconcilePlex(f.http, OMBI, binding(), TOKEN);
|
|
||||||
const servers = f.store.plex.servers as Record<string, unknown>[];
|
|
||||||
assert.deepEqual(servers[1], operatorPlex().servers[1]);
|
|
||||||
});
|
|
||||||
|
|
||||||
test("nothing is written when ombi already says what the mesh says", async () => {
|
|
||||||
const doc = operatorPlex();
|
|
||||||
Object.assign(doc.servers[0], { ip: "ace.internal", port: 32400, ssl: false });
|
|
||||||
const f = fakes(doc);
|
|
||||||
const out = await reconcilePlex(f.http, OMBI, binding(), TOKEN);
|
|
||||||
assert.deepEqual(out, { app: "plex", result: "unchanged" });
|
|
||||||
assert.equal(f.calls.filter((c) => c.method === "POST" && c.url.includes("/Settings/")).length, 0);
|
|
||||||
});
|
|
||||||
|
|
||||||
test("an ombi with no entry for this server gets one, named as plex names itself", async () => {
|
|
||||||
const fresh = { enable: false, enableWatchlistImport: false, monitorAll: false, installId: "x", servers: null, id: 0 };
|
|
||||||
const f = fakes(fresh);
|
|
||||||
const out = await reconcilePlex(f.http, OMBI, binding(), TOKEN);
|
|
||||||
assert.deepEqual(out, { app: "plex", result: "written", fields: ["server"] });
|
|
||||||
assert.deepEqual(f.store.plex, {
|
|
||||||
...fresh,
|
|
||||||
servers: [{
|
|
||||||
name: "ace", machineIdentifier: MACHINE, ip: "ace.internal", port: 32400, ssl: false, subDir: null,
|
|
||||||
plexAuthToken: TOKEN, episodeBatchSize: 150, plexSelectedLibraries: [],
|
|
||||||
}],
|
|
||||||
});
|
|
||||||
assert.equal(f.store.plex.enable, false, "whether plex is enabled in ombi is the operator's choice");
|
|
||||||
});
|
|
||||||
|
|
||||||
test("a token plex refuses is never written, and the accept that fixes it is named", async () => {
|
|
||||||
for (const trusted of [false, true]) {
|
|
||||||
const f = fakes(operatorPlex(), { trusted });
|
|
||||||
const out = await reconcilePlex(f.http, OMBI, binding(), "a-value-the-mesh-minted");
|
|
||||||
assert.equal(out.result, "refused");
|
|
||||||
const problem = (out as { problem: string }).problem;
|
|
||||||
assert.match(problem, /secret accept <this node> ombi plex-api --provider ace/);
|
|
||||||
assert.doesNotMatch(problem, /a-value-the-mesh-minted/);
|
|
||||||
assert.deepEqual(f.store.plex, operatorPlex(), "ombi's working settings were left alone");
|
|
||||||
assert.equal(f.calls.some((c) => c.url.includes("/api/v1/")), false, "ombi was not even asked");
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
test("a plex it cannot reach is reported, and ombi is left alone", async () => {
|
|
||||||
const f = fakes(operatorPlex(), { reachable: false });
|
|
||||||
const out = await reconcilePlex(f.http, OMBI, binding(), TOKEN);
|
|
||||||
assert.equal(out.result, "refused");
|
|
||||||
assert.match((out as { problem: string }).problem, /could not be asked.*ECONNREFUSED/);
|
|
||||||
assert.deepEqual(f.store.plex, operatorPlex());
|
|
||||||
});
|
|
||||||
|
|
||||||
test("a loopback binding is refused: from ombi's container it is ombi itself", () => {
|
|
||||||
const w = wantedPlex(binding(32400, "127.0.0.1"), TOKEN);
|
|
||||||
assert.equal(w.ok, false);
|
|
||||||
assert.match((w as { problem: string }).problem, /private network/);
|
|
||||||
});
|
|
||||||
|
|
||||||
test("an https binding sets ombi's ssl flag; an empty subDir is none", () => {
|
|
||||||
const w = wantedPlex(binding(32400, "ace.internal", "https"), TOKEN);
|
|
||||||
assert.equal(w.ok && w.connection.ssl, true);
|
|
||||||
assert.deepEqual(
|
|
||||||
differingPlex({ ip: "h", port: 1, ssl: false, subDir: "", plexAuthToken: "k" }, { ip: "h", port: 1, ssl: false, subDir: null, plexAuthToken: "k" }),
|
|
||||||
[],
|
|
||||||
);
|
|
||||||
});
|
|
||||||
|
|
||||||
test("every entry naming the server is laid over, not only the first", () => {
|
|
||||||
const doc = { servers: [{ machineIdentifier: MACHINE, ip: "a" }, { machineIdentifier: MACHINE, ip: "b" }] };
|
|
||||||
const want = { ip: "ace.internal", port: 32400, ssl: false, subDir: null, plexAuthToken: TOKEN };
|
|
||||||
const laid = withPlexServer(doc, MACHINE, want, "ace");
|
|
||||||
assert.equal(laid.added, false);
|
|
||||||
assert.deepEqual((laid.next.servers as { ip: string }[]).map((s) => s.ip), ["ace.internal", "ace.internal"]);
|
|
||||||
});
|
|
||||||
|
|
||||||
// ace's own ombi: its one entry was loaded from an older server (a stale identifier) and retyped to
|
|
||||||
// plex's public name, so it IS this server, reached another way (read from ace, 2026-09-30).
|
|
||||||
const acesOmbi = () => ({
|
|
||||||
enable: true,
|
|
||||||
enableWatchlistImport: true,
|
|
||||||
servers: [{
|
|
||||||
name: "Nami", plexAuthToken: TOKEN, machineIdentifier: "76562198623e708eef85b46aedb72c8f2fe671aa", episodeBatchSize: 0,
|
|
||||||
plexSelectedLibraries: [1, 2, 3, 4, 5, 6].map((k) => ({ key: String(k), enabled: true })), ssl: true, subDir: null,
|
|
||||||
ip: "plex.zurag.be", port: 443, id: 1,
|
|
||||||
}],
|
|
||||||
id: 4,
|
|
||||||
});
|
|
||||||
|
|
||||||
test("an entry whose own address answers as this server is adopted: connection and identifier, nothing else", async () => {
|
|
||||||
const f = fakes(acesOmbi());
|
|
||||||
const out = await reconcilePlex(f.http, OMBI, binding(), TOKEN);
|
|
||||||
assert.deepEqual(out, { app: "plex", result: "written", fields: ["ip", "port", "ssl", "machineIdentifier"] });
|
|
||||||
const want = acesOmbi();
|
|
||||||
Object.assign(want.servers[0], { ip: "ace.internal", port: 32400, ssl: false, machineIdentifier: MACHINE });
|
|
||||||
assert.deepEqual(f.store.plex, want, "one entry, still named Nami, its six libraries kept; none added");
|
|
||||||
});
|
|
||||||
|
|
||||||
test("an entry answering as another server, or not at all, is not adopted; this server gets its own", async () => {
|
|
||||||
const doc = {
|
|
||||||
servers: [
|
|
||||||
{ name: "a friend", machineIdentifier: "stale-1", ip: "10.0.0.9", port: 32400, ssl: false, plexAuthToken: "theirs" },
|
|
||||||
{ name: "gone", machineIdentifier: "stale-2", ip: "gone.example", port: 32400, ssl: false, plexAuthToken: "old" },
|
|
||||||
],
|
|
||||||
};
|
|
||||||
const f = fakes(structuredClone(doc));
|
|
||||||
const out = await reconcilePlex(f.http, OMBI, binding(), TOKEN);
|
|
||||||
assert.deepEqual(out, { app: "plex", result: "written", fields: ["server"] });
|
|
||||||
const servers = f.store.plex.servers as Record<string, unknown>[];
|
|
||||||
assert.deepEqual(servers.slice(0, 2), doc.servers, "both left exactly as they were");
|
|
||||||
assert.equal(servers[2].machineIdentifier, MACHINE);
|
|
||||||
});
|
|
||||||
|
|
||||||
test("no entry is probed once one carries the server's identifier", async () => {
|
|
||||||
const f = fakes(operatorPlex());
|
|
||||||
await reconcilePlex(f.http, OMBI, binding(), TOKEN);
|
|
||||||
assert.equal(f.calls.some((c) => c.url.startsWith("http://10.0.0.9")), false, "the friend's server was not asked");
|
|
||||||
});
|
|
||||||
@@ -1,147 +0,0 @@
|
|||||||
// What holds ombi's Servarr step (servarr/settings.ts): the connection ombi keeps for each app is
|
|
||||||
// made to say what the mesh bound — host, port, TLS, base path, key — and nothing else it keeps is
|
|
||||||
// touched; nothing is written when nothing differs; Radarr's 4K instance is left alone; and a key the
|
|
||||||
// app refuses (the mesh's own minted value, before the operator accepts the app's key) is never
|
|
||||||
// written, with the `secret accept` that fixes it named.
|
|
||||||
//
|
|
||||||
// ombi and the apps are fakes: the routes the step touches, answering as the real ones do (checked
|
|
||||||
// against lscr.io/linuxserver/ombi 4.53.10 and the catalogue's pinned sonarr/radarr/lidarr).
|
|
||||||
|
|
||||||
import { test } from "node:test";
|
|
||||||
import assert from "node:assert/strict";
|
|
||||||
|
|
||||||
import { APPS, differing, reconcileApp, subDirOf, wanted, type Binding, type Http, type ServarrApp } from "../servarr/settings.ts";
|
|
||||||
|
|
||||||
const SONARR = APPS.find((a) => a.app === "sonarr") as ServarrApp;
|
|
||||||
const RADARR = APPS.find((a) => a.app === "radarr") as ServarrApp;
|
|
||||||
const LIDARR = APPS.find((a) => a.app === "lidarr") as ServarrApp;
|
|
||||||
const THE_KEY = "the-apps-own-key";
|
|
||||||
|
|
||||||
function binding(provision: string, port: number, at = "ace.internal"): Binding {
|
|
||||||
return { binding: 1, provision, from: "ace", at, as: "mesh_ace_ombi", serves: { scheme: "http", port, "url-base": "" } } as Binding;
|
|
||||||
}
|
|
||||||
|
|
||||||
interface Call {
|
|
||||||
method: string;
|
|
||||||
url: string;
|
|
||||||
body?: unknown;
|
|
||||||
}
|
|
||||||
|
|
||||||
/** ombi's settings store and the apps' key check, behind one fetch. */
|
|
||||||
function fakes(settings: Record<string, unknown>, opts: { appKey?: string; reachable?: boolean } = {}) {
|
|
||||||
const calls: Call[] = [];
|
|
||||||
const appKey = opts.appKey ?? THE_KEY;
|
|
||||||
const http: Http = {
|
|
||||||
async fetch(url, init) {
|
|
||||||
const method = init?.method ?? "GET";
|
|
||||||
const body = init?.body ? (JSON.parse(init.body) as unknown) : undefined;
|
|
||||||
calls.push({ method, url, body });
|
|
||||||
const reply = (status: number, value?: unknown) => ({
|
|
||||||
status,
|
|
||||||
text: async () => (value === undefined ? "" : JSON.stringify(value)),
|
|
||||||
});
|
|
||||||
const u = new URL(url);
|
|
||||||
if (u.pathname.endsWith("/system/status")) {
|
|
||||||
if (opts.reachable === false) throw new Error("connect ECONNREFUSED");
|
|
||||||
return init?.headers?.["X-Api-Key"] === appKey ? reply(200, { version: "4" }) : reply(401);
|
|
||||||
}
|
|
||||||
if (init?.headers?.ApiKey !== "ombi-key") return reply(401);
|
|
||||||
const m = u.pathname.match(/^\/api\/v1\/(Settings|Tester)\/(\w+)$/);
|
|
||||||
if (!m) return reply(404);
|
|
||||||
const [, kind, app] = m;
|
|
||||||
if (kind === "Settings" && method === "GET") return reply(200, settings[app]);
|
|
||||||
if (kind === "Settings" && method === "POST") {
|
|
||||||
settings[app] = body;
|
|
||||||
return reply(200, true);
|
|
||||||
}
|
|
||||||
const tried = body as { apiKey?: string };
|
|
||||||
return reply(200, { isValid: tried.apiKey === appKey, expectedSubDir: null });
|
|
||||||
},
|
|
||||||
};
|
|
||||||
return { http, calls, settings };
|
|
||||||
}
|
|
||||||
|
|
||||||
const OMBI = { url: "http://127.0.0.1:3579", apiKey: "ombi-key" };
|
|
||||||
|
|
||||||
const operatorSonarr = () => ({
|
|
||||||
enabled: true, apiKey: "old-key", qualityProfile: "3", seasonFolders: true, rootPath: "10",
|
|
||||||
qualityProfileAnime: "7", rootPathAnime: "9", languageProfile: 1, ssl: false, subDir: null,
|
|
||||||
ip: "sonarr", port: 8989, id: 5,
|
|
||||||
});
|
|
||||||
|
|
||||||
test("it writes the connection the mesh bound, and keeps every other setting ombi had", async () => {
|
|
||||||
const f = fakes({ sonarr: operatorSonarr() });
|
|
||||||
const out = await reconcileApp(f.http, OMBI, SONARR, binding("sonarr-api", 20101), `${THE_KEY}\n`);
|
|
||||||
assert.deepEqual(out, { app: "sonarr", result: "written", fields: ["ip", "port", "apiKey"] });
|
|
||||||
assert.deepEqual(f.settings.sonarr, {
|
|
||||||
...operatorSonarr(), ip: "ace.internal", port: 20101, apiKey: THE_KEY, ssl: false, subDir: null,
|
|
||||||
});
|
|
||||||
// Checked against the app itself, at the bound address, before anything was written.
|
|
||||||
assert.equal(f.calls[0].url, "http://ace.internal:20101/api/v3/system/status");
|
|
||||||
});
|
|
||||||
|
|
||||||
test("nothing is written when ombi already says what the mesh says", async () => {
|
|
||||||
const f = fakes({ sonarr: { ...operatorSonarr(), ip: "ace.internal", port: 20101, apiKey: THE_KEY } });
|
|
||||||
const out = await reconcileApp(f.http, OMBI, SONARR, binding("sonarr-api", 20101), THE_KEY);
|
|
||||||
assert.deepEqual(out, { app: "sonarr", result: "unchanged" });
|
|
||||||
assert.equal(f.calls.filter((c) => c.method === "POST" && c.url.includes("/Settings/")).length, 0);
|
|
||||||
});
|
|
||||||
|
|
||||||
test("a key the app refuses is never written, and the accept that fixes it is named", async () => {
|
|
||||||
const f = fakes({ sonarr: operatorSonarr() });
|
|
||||||
const out = await reconcileApp(f.http, OMBI, SONARR, binding("sonarr-api", 20101), "a-value-the-mesh-minted");
|
|
||||||
assert.equal(out.result, "refused");
|
|
||||||
assert.match((out as { problem: string }).problem, /secret accept <this node> ombi sonarr-api --provider ace/);
|
|
||||||
assert.doesNotMatch((out as { problem: string }).problem, /a-value-the-mesh-minted/);
|
|
||||||
assert.deepEqual(f.settings.sonarr, operatorSonarr(), "ombi's working settings were left alone");
|
|
||||||
assert.equal(f.calls.some((c) => c.url.includes("/api/v1/")), false, "ombi was not even asked");
|
|
||||||
});
|
|
||||||
|
|
||||||
test("an app it cannot reach is reported, and ombi is left alone", async () => {
|
|
||||||
const f = fakes({ sonarr: operatorSonarr() }, { reachable: false });
|
|
||||||
const out = await reconcileApp(f.http, OMBI, SONARR, binding("sonarr-api", 20101), THE_KEY);
|
|
||||||
assert.equal(out.result, "refused");
|
|
||||||
assert.match((out as { problem: string }).problem, /could not be asked.*ECONNREFUSED/);
|
|
||||||
assert.deepEqual(f.settings.sonarr, operatorSonarr());
|
|
||||||
});
|
|
||||||
|
|
||||||
test("radarr's connection is written inside its combined document, and the 4K instance is untouched", async () => {
|
|
||||||
const fourK = { enabled: true, apiKey: "4k-key", ip: "radarr4k", port: 7879, defaultQualityProfile: "9", id: 7 };
|
|
||||||
const f = fakes({ radarr: { radarr: { enabled: true, apiKey: "old", ip: "radarr", port: 7878, defaultRootPath: "/movies", id: 6 }, radarr4K: fourK } });
|
|
||||||
const out = await reconcileApp(f.http, OMBI, RADARR, binding("radarr-api", 20102), THE_KEY);
|
|
||||||
assert.equal(out.result, "written");
|
|
||||||
const doc = f.settings.radarr as { radarr: Record<string, unknown>; radarr4K: unknown };
|
|
||||||
assert.deepEqual(doc.radarr4K, fourK);
|
|
||||||
assert.equal(doc.radarr.ip, "ace.internal");
|
|
||||||
assert.equal(doc.radarr.port, 20102);
|
|
||||||
assert.equal(doc.radarr.defaultRootPath, "/movies");
|
|
||||||
});
|
|
||||||
|
|
||||||
test("lidarr is checked on its own API version", async () => {
|
|
||||||
const f = fakes({ lidarr: { enabled: true, apiKey: null, ip: null, port: 0, id: 0 } });
|
|
||||||
const out = await reconcileApp(f.http, OMBI, LIDARR, binding("lidarr-api", 20103), THE_KEY);
|
|
||||||
assert.equal(out.result, "written");
|
|
||||||
assert.equal(f.calls[0].url, "http://ace.internal:20103/api/v1/system/status");
|
|
||||||
});
|
|
||||||
|
|
||||||
test("a loopback binding is refused: from ombi's container it is ombi itself", () => {
|
|
||||||
const w = wanted(SONARR, binding("sonarr-api", 20101, "127.0.0.1"), THE_KEY);
|
|
||||||
assert.equal(w.ok, false);
|
|
||||||
assert.match((w as { problem: string }).problem, /private network/);
|
|
||||||
});
|
|
||||||
|
|
||||||
test("the base path is ombi's subDir, slashes trimmed; empty is none", () => {
|
|
||||||
assert.equal(subDirOf(""), null);
|
|
||||||
assert.equal(subDirOf("/sonarr/"), "sonarr");
|
|
||||||
assert.deepEqual(
|
|
||||||
differing({ ip: "h", port: 1, ssl: false, subDir: "", apiKey: "k" }, { ip: "h", port: 1, ssl: false, subDir: null, apiKey: "k" }),
|
|
||||||
[],
|
|
||||||
);
|
|
||||||
});
|
|
||||||
|
|
||||||
test("an https binding sets ombi's ssl flag", () => {
|
|
||||||
const b = binding("sonarr-api", 443);
|
|
||||||
(b.serves as Record<string, unknown>).scheme = "https";
|
|
||||||
const w = wanted(SONARR, b, THE_KEY);
|
|
||||||
assert.equal(w.ok && w.connection.ssl, true);
|
|
||||||
});
|
|
||||||
@@ -8,5 +8,5 @@
|
|||||||
"skipLibCheck": true,
|
"skipLibCheck": true,
|
||||||
"noEmit": true
|
"noEmit": true
|
||||||
},
|
},
|
||||||
"include": ["client.ts", "index.ts", "tools/index.ts", "servarr/settings.ts", "plex/settings.ts", "connections/index.ts"]
|
"include": ["client.ts", "index.ts", "tools/index.ts"]
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -82,7 +82,7 @@
|
|||||||
],
|
],
|
||||||
"env": {
|
"env": {
|
||||||
"MESH_BROKER_FILE": "/run/secrets/broker",
|
"MESH_BROKER_FILE": "/run/secrets/broker",
|
||||||
"MESH_QBITTORRENT_URL": "http://127.0.0.1:${port:8080}",
|
"MESH_QBITTORRENT_URL": "http://127.0.0.1:8080",
|
||||||
"MESH_QBITTORRENT_PASSWORD_FILE": "/run/secrets/password",
|
"MESH_QBITTORRENT_PASSWORD_FILE": "/run/secrets/password",
|
||||||
"MESH_QBITTORRENT_CONFIG_FILE": "/run/config/config.json",
|
"MESH_QBITTORRENT_CONFIG_FILE": "/run/config/config.json",
|
||||||
"MESH_QBITTORRENT_CONFIG_DIR": "/var/lib/qbittorrent/config"
|
"MESH_QBITTORRENT_CONFIG_DIR": "/var/lib/qbittorrent/config"
|
||||||
|
|||||||
@@ -1,19 +1,6 @@
|
|||||||
{
|
{
|
||||||
"module": "radarr",
|
"module": "radarr",
|
||||||
"version": "1",
|
"version": "1",
|
||||||
"provides": [
|
|
||||||
{
|
|
||||||
"name": "radarr-api",
|
|
||||||
"scope": "mesh"
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"serves": {
|
|
||||||
"radarr-api": {
|
|
||||||
"scheme": "http",
|
|
||||||
"port": 7878,
|
|
||||||
"url-base": ""
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"capabilities": [
|
"capabilities": [
|
||||||
"container-runtime"
|
"container-runtime"
|
||||||
],
|
],
|
||||||
@@ -88,7 +75,7 @@
|
|||||||
],
|
],
|
||||||
"env": {
|
"env": {
|
||||||
"MESH_BROKER_FILE": "/run/secrets/broker",
|
"MESH_BROKER_FILE": "/run/secrets/broker",
|
||||||
"MESH_RADARR_URL": "http://127.0.0.1:${port:7878}",
|
"MESH_RADARR_URL": "http://127.0.0.1:7878",
|
||||||
"MESH_RADARR_CONFIG_DIR": "/var/lib/radarr/config"
|
"MESH_RADARR_CONFIG_DIR": "/var/lib/radarr/config"
|
||||||
},
|
},
|
||||||
"artifact": "runtime"
|
"artifact": "runtime"
|
||||||
|
|||||||
@@ -100,7 +100,7 @@
|
|||||||
],
|
],
|
||||||
"env": {
|
"env": {
|
||||||
"MESH_BROKER_FILE": "/run/secrets/broker",
|
"MESH_BROKER_FILE": "/run/secrets/broker",
|
||||||
"MESH_SEARXNG_URL": "http://127.0.0.1:${port:8080}",
|
"MESH_SEARXNG_URL": "http://127.0.0.1:8080",
|
||||||
"MESH_SEARXNG_CONFIG_FILE": "/run/config/config.json"
|
"MESH_SEARXNG_CONFIG_FILE": "/run/config/config.json"
|
||||||
},
|
},
|
||||||
"restart-on": [
|
"restart-on": [
|
||||||
|
|||||||
@@ -1,19 +1,6 @@
|
|||||||
{
|
{
|
||||||
"module": "sonarr",
|
"module": "sonarr",
|
||||||
"version": "1",
|
"version": "1",
|
||||||
"provides": [
|
|
||||||
{
|
|
||||||
"name": "sonarr-api",
|
|
||||||
"scope": "mesh"
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"serves": {
|
|
||||||
"sonarr-api": {
|
|
||||||
"scheme": "http",
|
|
||||||
"port": 8989,
|
|
||||||
"url-base": ""
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"capabilities": [
|
"capabilities": [
|
||||||
"container-runtime"
|
"container-runtime"
|
||||||
],
|
],
|
||||||
@@ -93,7 +80,7 @@
|
|||||||
],
|
],
|
||||||
"env": {
|
"env": {
|
||||||
"MESH_BROKER_FILE": "/run/secrets/broker",
|
"MESH_BROKER_FILE": "/run/secrets/broker",
|
||||||
"MESH_SONARR_URL": "http://127.0.0.1:${port:8989}",
|
"MESH_SONARR_URL": "http://127.0.0.1:8989",
|
||||||
"MESH_SONARR_CONFIG_DIR": "/var/lib/sonarr/config"
|
"MESH_SONARR_CONFIG_DIR": "/var/lib/sonarr/config"
|
||||||
},
|
},
|
||||||
"artifact": "runtime"
|
"artifact": "runtime"
|
||||||
|
|||||||
Reference in New Issue
Block a user