Compare commits
2
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
 jschoubben
|
bd0c6b3dc9 | ||
|
jschoubben
|
287e5e6d3f |
@@ -13,7 +13,7 @@ ARG RUNTIME_BASE
|
||||
FROM ${BUILD_BASE} AS build
|
||||
WORKDIR /app/modules/bookshelf
|
||||
COPY . .
|
||||
RUN node /app/node_modules/typescript/bin/tsc client.ts index.ts tools/index.ts \
|
||||
RUN node /app/node_modules/typescript/bin/tsc client.ts index.ts tools/index.ts downloads/settings.ts downloads/index.ts \
|
||||
--module NodeNext --moduleResolution NodeNext --target ES2022 --outDir dist
|
||||
|
||||
FROM ${RUNTIME_BASE}
|
||||
@@ -22,3 +22,6 @@ COPY --from=build /app/modules/bookshelf/dist /app/modules/bookshelf/dist
|
||||
# provider's provisioner runs its reconcile loop in the same process, with the broker connected —
|
||||
# the convention novox/hq issues 060/061 settled.
|
||||
ENV MESH_TOOL_MODULES=/app/modules/bookshelf/dist/index.js,/app/modules/bookshelf/dist/tools/index.js
|
||||
# NOT dist/downloads/index.js: that is a step the host runs to completion, named by the `downloads`
|
||||
# container's args as `mesh-tools run …` (novox/hq ADR 0052). Listed here it would run inside the
|
||||
# serving sidecar too, and exit it.
|
||||
|
||||
@@ -0,0 +1,188 @@
|
||||
// The downloads step — run once by the host after the app's server starts, and again whenever a
|
||||
// binding, a pair credential or the step's settings change (the container's `restart-on`,
|
||||
// novox/hq ADR 0099). Byte-identical in sonarr, radarr, lidarr and bookshelf; see settings.ts.
|
||||
//
|
||||
// **A step, not a loop**: 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 anything could not be put right — a refused credential, an unreachable
|
||||
// provider, an entry the app would not save — so the node reports the step failed and the host
|
||||
// runs it again on the next apply. Declared last in the manifest, so its failing gates nothing
|
||||
// else of the module's (novox/hq ADR 0136).
|
||||
//
|
||||
// Reads, in MESH_DOWNLOADS_DIR, `<provision>.json` (the binding), `<provision>.secret` (the pair
|
||||
// credential) and the settings file; remembers in MESH_DOWNLOADS_MEMORY the jackett hosts it has
|
||||
// pointed feeds at, so a jackett that moves takes its feeds with it. Never prints a credential.
|
||||
|
||||
import { mkdir, rename, writeFile } from "node:fs/promises";
|
||||
import { dirname, join } from "node:path";
|
||||
|
||||
import {
|
||||
CLIENTS,
|
||||
JACKETT,
|
||||
acceptRemedy,
|
||||
appConfig,
|
||||
appReady,
|
||||
listEntries,
|
||||
providerTakes,
|
||||
readIfThere,
|
||||
readJson,
|
||||
reconcileClient,
|
||||
reconcileIndexers,
|
||||
scrub,
|
||||
stepSettings,
|
||||
wanted,
|
||||
type App,
|
||||
type Binding,
|
||||
type Http,
|
||||
type Entry,
|
||||
type Outcome,
|
||||
type Took,
|
||||
} from "./settings.js";
|
||||
|
||||
const module = process.env.MESH_DOWNLOADS_APP ?? "app";
|
||||
const dir = process.env.MESH_DOWNLOADS_DIR ?? "/run/downloads";
|
||||
const settingsFile = process.env.MESH_DOWNLOADS_SETTINGS ?? join(dir, "downloads.json");
|
||||
const memoryFile = process.env.MESH_DOWNLOADS_MEMORY ?? "/var/lib/downloads/memory.json";
|
||||
const waitSeconds = Number(process.env.MESH_DOWNLOADS_WAIT_SECONDS ?? "180");
|
||||
const tag = `[${module}-downloads]`;
|
||||
|
||||
const http: Http = { fetch: (u, init) => fetch(u, init) };
|
||||
const secrets: string[] = [];
|
||||
const say = (line: string) => console.log(scrub(`${tag} ${line}`, secrets));
|
||||
const fail = (line: string) => console.error(scrub(`${tag} ${line}`, secrets));
|
||||
|
||||
const config = appConfig((await readIfThere(process.env.MESH_DOWNLOADS_APP_CONFIG)) ?? "");
|
||||
if (!config.apiKey) {
|
||||
fail(`no API key in ${module}'s config.xml yet — ${module} writes it on its first start; the step runs again on the next apply`);
|
||||
process.exit(1);
|
||||
}
|
||||
secrets.push(config.apiKey);
|
||||
const app: App = {
|
||||
module,
|
||||
url: `${(process.env.MESH_DOWNLOADS_APP_URL ?? "http://127.0.0.1").replace(/\/$/, "")}${config.urlBase}`,
|
||||
apiKey: config.apiKey,
|
||||
api: process.env.MESH_DOWNLOADS_API ?? "v3",
|
||||
};
|
||||
const settings = stepSettings(await readJson(settingsFile));
|
||||
|
||||
if (!(await appReady(http, app, waitSeconds * 1000))) {
|
||||
fail(`${module} did not answer at ${app.url} within ${waitSeconds}s`);
|
||||
process.exit(1);
|
||||
}
|
||||
|
||||
const outcomes: Outcome[] = [];
|
||||
|
||||
// The download clients.
|
||||
let clients: Entry[];
|
||||
try {
|
||||
clients = await listEntries(http, app, "downloadclient");
|
||||
} catch (err) {
|
||||
fail(err instanceof Error ? err.message : String(err));
|
||||
process.exit(1);
|
||||
}
|
||||
for (const kind of CLIENTS) {
|
||||
const credential = await readIfThere(join(dir, `${kind.provision}.secret`));
|
||||
if (credential) secrets.push(credential.trim());
|
||||
const w = wanted(kind.provision, (await readJson(join(dir, `${kind.provision}.json`))) as Binding | undefined, credential, true);
|
||||
// `in`, not `!w.ok`: the Dockerfile compiles without strict, where a boolean discriminant does not
|
||||
// narrow.
|
||||
if ("problem" in w) {
|
||||
outcomes.push({ what: kind.provision, result: "refused", problem: w.problem });
|
||||
continue;
|
||||
}
|
||||
const ep = w.endpoint;
|
||||
try {
|
||||
if (!(await providerTakes(http, kind.provision, ep)).took) {
|
||||
outcomes.push({
|
||||
what: kind.provision,
|
||||
result: "refused",
|
||||
problem: acceptRemedy(app, settings.node, kind.provision, kind.provider, kind.secretName, ep.from),
|
||||
});
|
||||
continue;
|
||||
}
|
||||
} catch (err) {
|
||||
outcomes.push({
|
||||
what: kind.provision,
|
||||
result: "refused",
|
||||
problem: `${kind.provider} could not be asked whether it takes the credential at ${ep.host}:${ep.port}: ${err instanceof Error ? err.message : String(err)}`,
|
||||
});
|
||||
continue;
|
||||
}
|
||||
outcomes.push(...(await reconcileClient(http, app, kind, settings.names[kind.provision], ep, clients)));
|
||||
}
|
||||
|
||||
// The indexers, through jackett.
|
||||
{
|
||||
const credential = await readIfThere(join(dir, `${JACKETT}.secret`));
|
||||
if (credential) secrets.push(credential.trim());
|
||||
const w = wanted(JACKETT, (await readJson(join(dir, `${JACKETT}.json`))) as Binding | undefined, credential, false);
|
||||
if ("problem" in w) {
|
||||
outcomes.push({ what: JACKETT, result: "refused", problem: w.problem });
|
||||
} else {
|
||||
const ep = w.endpoint;
|
||||
let took: Took | undefined;
|
||||
try {
|
||||
took = await providerTakes(http, JACKETT, ep);
|
||||
} catch (err) {
|
||||
outcomes.push({
|
||||
what: JACKETT,
|
||||
result: "refused",
|
||||
problem: `jackett could not be asked whether it takes the key at ${ep.host}:${ep.port}: ${err instanceof Error ? err.message : String(err)}`,
|
||||
});
|
||||
}
|
||||
if (took && !took.took) {
|
||||
outcomes.push({ what: JACKETT, result: "refused", problem: acceptRemedy(app, settings.node, JACKETT, "jackett", "API key", ep.from) });
|
||||
} else if (took) {
|
||||
const memory = ((await readJson(memoryFile)) ?? {}) as Record<string, { hosts?: string[] } | undefined>;
|
||||
const remembered = Array.isArray(memory[JACKETT]?.hosts) ? (memory[JACKETT]?.hosts as string[]) : [];
|
||||
try {
|
||||
const indexers = await listEntries(http, app, "indexer");
|
||||
outcomes.push(
|
||||
...(await reconcileIndexers(http, app, ep, took.configured ?? new Map(), settings.indexers, remembered, indexers)),
|
||||
);
|
||||
} catch (err) {
|
||||
outcomes.push({ what: JACKETT, result: "refused", problem: err instanceof Error ? err.message : String(err) });
|
||||
}
|
||||
// Remember where the feeds now point, so they are still recognised as the mesh's if jackett
|
||||
// moves. Written whole and renamed, so a crash leaves the old memory, never half of one.
|
||||
const hosts = [...new Set([...remembered, ep.host.toLowerCase()])].sort();
|
||||
if (hosts.join() !== [...remembered].sort().join()) {
|
||||
try {
|
||||
await mkdir(dirname(memoryFile), { recursive: true });
|
||||
await writeFile(`${memoryFile}.tmp`, JSON.stringify({ ...memory, [JACKETT]: { hosts } }, null, 2) + "\n", { mode: 0o600 });
|
||||
await rename(`${memoryFile}.tmp`, memoryFile);
|
||||
} catch (err) {
|
||||
outcomes.push({
|
||||
what: JACKETT,
|
||||
result: "notice",
|
||||
note: `could not remember ${ep.host} as a jackett host (${err instanceof Error ? err.message : String(err)}); if jackett moves, list it in downloads.jackett-api.adopt-hosts`,
|
||||
});
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
let failed = 0;
|
||||
for (const o of outcomes) {
|
||||
switch (o.result) {
|
||||
case "unchanged":
|
||||
say(`${o.what}: already as the mesh says${o.untested ? "" : "; connection tested"}`);
|
||||
break;
|
||||
case "written":
|
||||
say(`${o.what}: wrote ${o.fields.join(", ")}${o.untested ? "" : "; connection tested"}`);
|
||||
break;
|
||||
case "created":
|
||||
say(`${o.what}: registered; connection tested`);
|
||||
break;
|
||||
case "notice":
|
||||
say(`${o.what}: ${o.note}`);
|
||||
break;
|
||||
case "refused":
|
||||
failed++;
|
||||
fail(`${o.what}: ${o.problem}`);
|
||||
break;
|
||||
}
|
||||
}
|
||||
process.exitCode = failed > 0 ? 1 : 0;
|
||||
@@ -0,0 +1,778 @@
|
||||
// Where a Servarr app reaches its download clients and its indexer proxy — decided by the mesh,
|
||||
// written into the app by the app's own API.
|
||||
//
|
||||
// **One file, four copies.** sonarr, radarr, lidarr and bookshelf (a Readarr fork) keep their
|
||||
// download clients and indexers behind the same API — `/api/v3/…` for the first two, `/api/v1/…`
|
||||
// for the others — so this step is the same code in each. Each module builds from its own
|
||||
// directory (novox/hq ADR 0069), so each carries a byte-identical copy under `downloads/`;
|
||||
// `test/downloads.test.ts` checks the copies agree wherever the siblings are checked out beside
|
||||
// it. Change all four together.
|
||||
//
|
||||
// **Why this exists.** The app keeps its connection to nzbget, qBittorrent and jackett in its own
|
||||
// database, not in a file, so the mesh has nowhere to write `${bound:nzbget-api:at}` for it. The
|
||||
// module requires `nzbget-api`, `qbittorrent-api` and `jackett-api`; the mesh delivers, for each,
|
||||
// a binding (where the provider is — `at` — and what it serves: `port`, `scheme`, `url-base`, and
|
||||
// for a download client the `username`) and a pair credential (nzbget's ControlPassword,
|
||||
// qBittorrent's WebUI password, jackett's API key — each the provider's one and only, accepted by
|
||||
// the operator per pair; the mesh cannot mint them). This step reads those files and makes the
|
||||
// app's entries say the same thing.
|
||||
//
|
||||
// **Which entries are the mesh's.** Never a guess from what an entry looks like:
|
||||
// - a download client is the mesh's when its name is the one the module's settings give for
|
||||
// that provision (`downloads.<provision>.name`) and its kind is that provider's. On a fresh
|
||||
// machine the step registers it under that name; on a migrated one the assignment names the
|
||||
// entry the migration adopts ("NZBGet" on ace).
|
||||
// - a Torznab indexer is the mesh's when it reads a jackett feed
|
||||
// (`…/api/v2.0/indexers/<id>/results/torznab`) on a host the mesh put there — the bound `at`,
|
||||
// one it bound before (remembered by the step), or one the settings adopt
|
||||
// (`downloads.jackett-api.adopt-hosts`, which is how a migration names the entries that pointed
|
||||
// at the old container). `downloads.jackett-api.indexers` lists the jackett indexers the app
|
||||
// should have; one missing is registered.
|
||||
// Everything else — every entry a person made, an nzbget elsewhere, a seedbox's jackett, a Newznab
|
||||
// indexer — is left exactly as it is. **Nothing is ever deleted.**
|
||||
//
|
||||
// **Only the connection, and only when it differs.** Host, port, TLS, base path, user name and
|
||||
// the credential. Categories, priorities, "enabled", seed criteria and every other choice made in
|
||||
// the app are left alone. The stored credential cannot be read back (the app masks it), so the
|
||||
// step asks the app to test the entry with the mesh's host and port and the credential it already
|
||||
// holds: passing, the credential is already the provider's one and only; failing, the delivered
|
||||
// credential is written.
|
||||
//
|
||||
// **A credential the provider refuses is never written.** Until the operator accepts the
|
||||
// provider's secret for this pair, the mesh delivers a value it minted itself, which no provider
|
||||
// will ever accept (novox/hq ADR 0092). Writing it would replace a working password with a dead
|
||||
// one. So it is tried against the provider first; refused, nothing of that provision 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/downloads.test.ts).
|
||||
// Never prints a credential, an API key, or a URL carrying one.
|
||||
|
||||
import { readFile } from "node:fs/promises";
|
||||
|
||||
/** A download-client provision and the shape of its entry in the app. */
|
||||
export interface ClientKind {
|
||||
provision: "nzbget-api" | "qbittorrent-api";
|
||||
/** The app's `implementation` for it. */
|
||||
implementation: "Nzbget" | "QBittorrent";
|
||||
/** The provider, as a person calls it. */
|
||||
provider: string;
|
||||
/** What the pair credential is, in the provider's words. */
|
||||
secretName: string;
|
||||
}
|
||||
|
||||
export const CLIENTS: readonly ClientKind[] = [
|
||||
{ provision: "nzbget-api", implementation: "Nzbget", provider: "nzbget", secretName: "ControlPassword" },
|
||||
{ provision: "qbittorrent-api", implementation: "QBittorrent", provider: "qBittorrent", secretName: "WebUI password" },
|
||||
];
|
||||
|
||||
export const JACKETT = "jackett-api";
|
||||
|
||||
/** What the mesh wrote at `binds.<provision>`: the binding document. */
|
||||
export interface Binding {
|
||||
provision?: string;
|
||||
from?: string;
|
||||
at?: string;
|
||||
as?: string;
|
||||
serves?: Record<string, unknown>;
|
||||
}
|
||||
|
||||
/** Where a provider is, as the mesh bound it, and the credential for it. */
|
||||
export interface Endpoint {
|
||||
scheme: "http" | "https";
|
||||
host: string;
|
||||
port: number;
|
||||
/** "" at the root, otherwise "/base" — one leading slash, none trailing. */
|
||||
urlBase: string;
|
||||
/** The user a download client logs in as; "" for jackett, which takes a key. */
|
||||
username: string;
|
||||
credential: string;
|
||||
/** The provider's node, for the `secret accept` remedy. */
|
||||
from: string;
|
||||
}
|
||||
|
||||
export type Wanted = { ok: true; endpoint: Endpoint } | { ok: false; problem: string };
|
||||
|
||||
/**
|
||||
* The endpoint the mesh says to use, from a binding and its pair credential.
|
||||
*
|
||||
* Refused rather than guessed when the binding cannot be dialled from the app's own container: a
|
||||
* loopback `at` — what the mesh hands a machine that is not on the private network — is the app's
|
||||
* container itself.
|
||||
*/
|
||||
export function wanted(
|
||||
provision: string,
|
||||
binding: Binding | undefined,
|
||||
credential: string | undefined,
|
||||
needsUser: boolean,
|
||||
): Wanted {
|
||||
if (!binding) {
|
||||
return { ok: false, problem: `no binding for ${provision} was delivered — the mesh writes it before this step runs` };
|
||||
}
|
||||
const host = typeof binding.at === "string" ? binding.at.trim() : "";
|
||||
const serves = binding.serves ?? {};
|
||||
const port = Number(serves.port);
|
||||
if (!host) return { ok: false, problem: `the ${provision} binding names no host (at)` };
|
||||
if (isLoopback(host)) {
|
||||
return {
|
||||
ok: false,
|
||||
problem:
|
||||
`the ${provision} binding says the provider is at ${host}, which from the app's own container is the ` +
|
||||
`app itself. The mesh hands loopback to a machine that is not on the private network; put it on the ` +
|
||||
`private network so the provider has an address the app can dial`,
|
||||
};
|
||||
}
|
||||
if (!Number.isInteger(port) || port <= 0 || port > 65535) {
|
||||
return { ok: false, problem: `the ${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 ${provision} binding serves scheme ${scheme}, which the app cannot dial` };
|
||||
}
|
||||
const username = typeof serves.username === "string" ? serves.username.trim() : "";
|
||||
if (needsUser && !username) {
|
||||
return { ok: false, problem: `the ${provision} binding serves no username for the app to log in as` };
|
||||
}
|
||||
const key = (credential ?? "").trim();
|
||||
if (!key) return { ok: false, problem: `the ${provision} credential is empty or was not delivered` };
|
||||
return {
|
||||
ok: true,
|
||||
endpoint: {
|
||||
scheme,
|
||||
host,
|
||||
port,
|
||||
urlBase: normBase(serves["url-base"]),
|
||||
username,
|
||||
credential: key,
|
||||
from: typeof binding.from === "string" ? binding.from : "",
|
||||
},
|
||||
};
|
||||
}
|
||||
|
||||
/** A URL base as "" or "/x/y": slashes trimmed, one put back in front. */
|
||||
export function normBase(v: unknown): string {
|
||||
const s = typeof v === "string" ? v.trim().replace(/^\/+|\/+$/g, "") : "";
|
||||
return s === "" ? "" : `/${s}`;
|
||||
}
|
||||
|
||||
function isLoopback(host: string): boolean {
|
||||
const h = host.toLowerCase();
|
||||
return h === "localhost" || h === "::1" || h === "[::1]" || /^127\./.test(h);
|
||||
}
|
||||
|
||||
function hostForUrl(host: string): string {
|
||||
return host.includes(":") && !host.startsWith("[") ? `[${host}]` : host;
|
||||
}
|
||||
|
||||
/** The provider's base URL, as the step dials it and as the app is given it. */
|
||||
export function baseUrl(ep: Endpoint): string {
|
||||
return `${ep.scheme}://${hostForUrl(ep.host)}:${ep.port}${ep.urlBase}`;
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------------------------
|
||||
// HTTP
|
||||
|
||||
/** The HTTP the step needs, so a test can stand fakes in for the app and the providers. */
|
||||
export interface Http {
|
||||
fetch(
|
||||
url: string,
|
||||
init?: { method?: string; headers?: Record<string, string>; body?: string },
|
||||
): Promise<{ status: number; text(): Promise<string> }>;
|
||||
}
|
||||
|
||||
/** The app, as the step reaches it from the host. */
|
||||
export interface App {
|
||||
/** The module, for messages and the remedy: sonarr, radarr, lidarr, bookshelf. */
|
||||
module: string;
|
||||
/** Its own URL, base path included. */
|
||||
url: string;
|
||||
apiKey: string;
|
||||
/** v3 (sonarr, radarr) or v1 (lidarr, bookshelf). */
|
||||
api: string;
|
||||
}
|
||||
|
||||
interface Answer {
|
||||
status: number;
|
||||
body: unknown;
|
||||
}
|
||||
|
||||
async function appCall(http: Http, app: App, method: string, path: string, body?: unknown): Promise<Answer> {
|
||||
const res = await http.fetch(`${app.url.replace(/\/$/, "")}/api/${app.api}${path}`, {
|
||||
method,
|
||||
headers: {
|
||||
"X-Api-Key": app.apiKey,
|
||||
Accept: "application/json",
|
||||
...(body !== undefined ? { "Content-Type": "application/json" } : {}),
|
||||
},
|
||||
body: body !== undefined ? JSON.stringify(body) : undefined,
|
||||
});
|
||||
const text = await res.text();
|
||||
let parsed: unknown = undefined;
|
||||
if (text) {
|
||||
try {
|
||||
parsed = JSON.parse(text) as unknown;
|
||||
} catch {
|
||||
parsed = text;
|
||||
}
|
||||
}
|
||||
return { status: res.status, body: parsed };
|
||||
}
|
||||
|
||||
async function appGet(http: Http, app: App, path: string): Promise<unknown> {
|
||||
const a = await appCall(http, app, "GET", path);
|
||||
if (a.status < 200 || a.status >= 300) throw new Error(`${app.module} GET ${path} answered ${a.status}`);
|
||||
return a.body;
|
||||
}
|
||||
|
||||
/** One of the app's validation failures: the only parts of an answer the step ever prints. */
|
||||
interface Failure {
|
||||
property: string;
|
||||
message: string;
|
||||
warning: boolean;
|
||||
}
|
||||
|
||||
function failuresOf(body: unknown): Failure[] {
|
||||
const list = Array.isArray(body) ? body : [];
|
||||
return list.map((f) => {
|
||||
const o = (f ?? {}) as Record<string, unknown>;
|
||||
return {
|
||||
property: String(o.propertyName ?? ""),
|
||||
message: String(o.errorMessage ?? ""),
|
||||
warning: o.isWarning === true,
|
||||
};
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* One shape rather than a union on `ok`: the Dockerfile compiles without strict, where a boolean
|
||||
* discriminant does not narrow.
|
||||
*/
|
||||
interface Verdict {
|
||||
ok: boolean;
|
||||
/** Warnings the app raised on a pass; errors (and any warnings) on a failure. */
|
||||
failures: Failure[];
|
||||
status: number;
|
||||
saved?: Entry;
|
||||
}
|
||||
|
||||
function verdict(a: Answer): Verdict {
|
||||
if (a.status >= 200 && a.status < 300) return { ok: true, failures: [], status: a.status };
|
||||
const failures = failuresOf(a.body);
|
||||
if (a.status === 400 && failures.length > 0 && failures.every((f) => f.warning)) return { ok: true, failures, status: a.status };
|
||||
return { ok: false, failures, status: a.status };
|
||||
}
|
||||
|
||||
/** The app's own test of an entry, from the app's own container. */
|
||||
async function appTest(http: Http, app: App, resource: string, entry: Entry): Promise<Verdict> {
|
||||
return verdict(await appCall(http, app, "POST", `/${resource}/test`, entry));
|
||||
}
|
||||
|
||||
/**
|
||||
* Save an entry. The app tests an enabled entry before saving it; a test that passes with only
|
||||
* warnings ("a category is recommended") is saved with `forceSave`, the same as pressing "save
|
||||
* anyway" in its screen. An error is never forced.
|
||||
*/
|
||||
async function appSave(http: Http, app: App, resource: string, entry: Entry, create: boolean): Promise<Verdict> {
|
||||
const path = create ? `/${resource}` : `/${resource}/${entry.id}`;
|
||||
const method = create ? "POST" : "PUT";
|
||||
let a = await appCall(http, app, method, path, entry);
|
||||
let v = verdict(a);
|
||||
if (v.ok && (a.status < 200 || a.status >= 300)) {
|
||||
a = await appCall(http, app, method, `${path}?forceSave=true`, entry);
|
||||
v = verdict(a);
|
||||
if (v.ok && (a.status < 200 || a.status >= 300)) {
|
||||
return { ok: false, failures: failuresOf(a.body), status: a.status };
|
||||
}
|
||||
}
|
||||
if (!v.ok) return v;
|
||||
return { ...v, saved: (a.body ?? undefined) as Entry | undefined };
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------------------------
|
||||
// Entries
|
||||
|
||||
/** An entry as the app's API gives it: a download client or an indexer. */
|
||||
export interface Entry {
|
||||
id?: number;
|
||||
name?: string;
|
||||
implementation?: string;
|
||||
enable?: boolean;
|
||||
enableRss?: boolean;
|
||||
enableAutomaticSearch?: boolean;
|
||||
enableInteractiveSearch?: boolean;
|
||||
supportsRss?: boolean;
|
||||
supportsSearch?: boolean;
|
||||
fields?: { name: string; value?: unknown; [k: string]: unknown }[];
|
||||
[k: string]: unknown;
|
||||
}
|
||||
|
||||
export function field(e: Entry, name: string): unknown {
|
||||
return e.fields?.find((f) => f.name === name)?.value;
|
||||
}
|
||||
|
||||
/** The entry with these fields' values replaced — added when the app's shape lacks one. */
|
||||
export function withFields(e: Entry, values: Record<string, unknown>): Entry {
|
||||
const fields = (e.fields ?? []).map((f) => (f.name in values ? { ...f, value: values[f.name] } : { ...f }));
|
||||
for (const [name, value] of Object.entries(values)) {
|
||||
if (!fields.some((f) => f.name === name)) fields.push({ name, value });
|
||||
}
|
||||
return { ...e, fields };
|
||||
}
|
||||
|
||||
function enabled(e: Entry): boolean {
|
||||
return e.enable === true || e.enableRss === true || e.enableAutomaticSearch === true || e.enableInteractiveSearch === true;
|
||||
}
|
||||
|
||||
/** What one provision, or one entry of it, came to. */
|
||||
export type Outcome =
|
||||
| { what: string; result: "unchanged"; untested?: boolean }
|
||||
| { what: string; result: "written"; fields: string[]; untested?: boolean }
|
||||
| { what: string; result: "created"; fields: string[] }
|
||||
| { what: string; result: "notice"; note: string }
|
||||
| { what: string; result: "refused"; problem: string };
|
||||
|
||||
function said(fs: Failure[]): string {
|
||||
return fs.length === 0 ? "no reason given" : fs.map((f) => (f.property ? `${f.property}: ${f.message}` : f.message)).join("; ");
|
||||
}
|
||||
|
||||
/**
|
||||
* Bring one of the mesh's entries in line: `connection` is the non-secret fields as the mesh says
|
||||
* them, `differs` which of them the entry does not already say, `secretField` where the credential
|
||||
* goes. Never throws: every failure is an outcome with a reason.
|
||||
*/
|
||||
export async function reconcileEntry(
|
||||
http: Http,
|
||||
app: App,
|
||||
resource: "downloadclient" | "indexer",
|
||||
what: string,
|
||||
current: Entry,
|
||||
connection: Record<string, unknown>,
|
||||
differs: string[],
|
||||
secretField: string,
|
||||
credential: string,
|
||||
testable = true,
|
||||
): Promise<Outcome> {
|
||||
try {
|
||||
const base = withFields(current, connection); // the credential as the app holds it — masked
|
||||
if (!testable) {
|
||||
// Nothing to test against (jackett no longer has the indexer it names): the connection is
|
||||
// still the mesh's to state, and the key goes with it when the address changes.
|
||||
if (differs.length === 0) return { what, result: "unchanged", untested: true };
|
||||
const s = await appSave(http, app, resource, withFields(base, { [secretField]: credential }), false);
|
||||
if (!s.ok) return { what, result: "refused", problem: `${app.module} would not save it: ${said(s.failures)}` };
|
||||
return { what, result: "written", fields: [...differs, secretField], untested: true };
|
||||
}
|
||||
const first = await appTest(http, app, resource, base);
|
||||
if (first.ok) {
|
||||
// The credential the app holds already works against the provider at the mesh's address —
|
||||
// and the provider has exactly one, so it is the delivered one.
|
||||
if (differs.length === 0) return { what, result: "unchanged" };
|
||||
const s = await appSave(http, app, resource, base, false);
|
||||
if (!s.ok) return { what, result: "refused", problem: `${app.module} would not save it: ${said(s.failures)}` };
|
||||
return { what, result: "written", fields: differs };
|
||||
}
|
||||
// The app's test failed with what it holds. The delivered credential was already checked
|
||||
// against the provider, so writing it is safe; the app tests an enabled entry again on save.
|
||||
const s = await appSave(http, app, resource, withFields(base, { [secretField]: credential }), false);
|
||||
if (!s.ok) {
|
||||
return {
|
||||
what,
|
||||
result: "refused",
|
||||
problem: `${app.module} tested it at the mesh's address and would not save it (nothing was written): ${said(s.failures)}`,
|
||||
};
|
||||
}
|
||||
const stored = (await appGet(http, app, `/${resource}/${current.id}`)) as Entry;
|
||||
const second = await appTest(http, app, resource, stored);
|
||||
const fields = [...differs, secretField];
|
||||
if (second.ok) return { what, result: "written", fields };
|
||||
const why = `written (${fields.join(", ")}), and ${app.module}'s own test still fails: ${said(second.failures)}`;
|
||||
return enabled(stored) ? { what, result: "refused", problem: why } : { what, result: "notice", note: `${why} — it is disabled, so nothing uses it` };
|
||||
} catch (err) {
|
||||
return { what, result: "refused", problem: message(err) };
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Register a new entry from the app's own template for that kind: its defaults, the name, the
|
||||
* connection and the credential. A category the provider does not have (nzbget refuses one it was
|
||||
* not told about) is left empty rather than failing the registration, and said.
|
||||
*/
|
||||
export async function createEntry(
|
||||
http: Http,
|
||||
app: App,
|
||||
resource: "downloadclient" | "indexer",
|
||||
what: string,
|
||||
implementation: string,
|
||||
name: string,
|
||||
values: Record<string, unknown>,
|
||||
): Promise<Outcome> {
|
||||
try {
|
||||
const schema = (await appGet(http, app, `/${resource}/schema`)) as Entry[];
|
||||
const template = (schema ?? []).find((s) => s.implementation === implementation);
|
||||
if (!template) return { what, result: "refused", problem: `${app.module} has no ${implementation} to register` };
|
||||
let entry: Entry = withFields({ ...template, id: undefined, name }, values);
|
||||
if (resource === "downloadclient") entry.enable = true;
|
||||
else {
|
||||
entry.enableRss = template.supportsRss !== false;
|
||||
entry.enableAutomaticSearch = template.supportsSearch !== false;
|
||||
entry.enableInteractiveSearch = template.supportsSearch !== false;
|
||||
}
|
||||
let s = await appSave(http, app, resource, entry, true);
|
||||
let note = "";
|
||||
if (!s.ok && s.failures.length > 0 && s.failures.every((f) => /category/i.test(f.property))) {
|
||||
const emptied: Record<string, unknown> = {};
|
||||
for (const f of entry.fields ?? []) if (/category$/i.test(f.name) && !/imported/i.test(f.name)) emptied[f.name] = "";
|
||||
entry = withFields(entry, emptied);
|
||||
s = await appSave(http, app, resource, entry, true);
|
||||
note = " with its category left empty — the provider has none by the app's default name; set one in both";
|
||||
}
|
||||
if (!s.ok) return { what, result: "refused", problem: `${app.module} would not register it: ${said(s.failures)}` };
|
||||
const created = s.saved;
|
||||
if (created?.id !== undefined) {
|
||||
const t = await appTest(http, app, resource, (await appGet(http, app, `/${resource}/${created.id}`)) as Entry);
|
||||
if (!t.ok) {
|
||||
return { what, result: "refused", problem: `registered as "${name}"${note}, and ${app.module}'s own test fails: ${said(t.failures)}` };
|
||||
}
|
||||
}
|
||||
return note
|
||||
? { what, result: "notice", note: `registered as "${name}"${note}` }
|
||||
: { what, result: "created", fields: Object.keys(values) };
|
||||
} catch (err) {
|
||||
return { what, result: "refused", problem: message(err) };
|
||||
}
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------------------------
|
||||
// Providers: does it take the credential?
|
||||
|
||||
/**
|
||||
* Does the provider take this credential? `took` it does (for jackett, with the ids of the indexers
|
||||
* it has configured); `refused` it said no; a thrown error when it could not be asked.
|
||||
*/
|
||||
export interface Took {
|
||||
took: boolean;
|
||||
configured?: Map<string, string>;
|
||||
}
|
||||
|
||||
export async function providerTakes(http: Http, provision: string, ep: Endpoint): Promise<Took> {
|
||||
const base = baseUrl(ep);
|
||||
if (provision === "nzbget-api") {
|
||||
const auth = Buffer.from(`${ep.username}:${ep.credential}`).toString("base64");
|
||||
const res = await http.fetch(`${base}/jsonrpc/version`, { method: "GET", headers: { Authorization: `Basic ${auth}` } });
|
||||
await res.text();
|
||||
if (res.status === 401 || res.status === 403) return { took: false };
|
||||
if (res.status >= 200 && res.status < 300) return { took: true };
|
||||
throw new Error(`nzbget answered ${res.status}`);
|
||||
}
|
||||
if (provision === "qbittorrent-api") {
|
||||
const form = `username=${encodeURIComponent(ep.username)}&password=${encodeURIComponent(ep.credential)}`;
|
||||
const res = await http.fetch(`${base}/api/v2/auth/login`, {
|
||||
method: "POST",
|
||||
headers: { "Content-Type": "application/x-www-form-urlencoded" },
|
||||
body: form,
|
||||
});
|
||||
const text = (await res.text()).trim();
|
||||
if (res.status === 401 || /^fails\.?$/i.test(text)) return { took: false };
|
||||
if (res.status === 403) {
|
||||
throw new Error(
|
||||
"qBittorrent answered 403: it has banned this address after failed logins (WebUI\\BanDuration); it lifts by itself",
|
||||
);
|
||||
}
|
||||
if (res.status >= 200 && res.status < 300) return { took: true };
|
||||
throw new Error(`qBittorrent answered ${res.status}`);
|
||||
}
|
||||
if (provision === JACKETT) {
|
||||
const url = `${base}/api/v2.0/indexers/all/results/torznab/api?t=indexers&configured=true&apikey=${encodeURIComponent(ep.credential)}`;
|
||||
const res = await http.fetch(url, { method: "GET" });
|
||||
const text = await res.text();
|
||||
if (res.status === 401 || res.status === 403) return { took: false };
|
||||
if (res.status < 200 || res.status >= 300) throw new Error(`jackett answered ${res.status}`);
|
||||
// jackett answers a wrong key 200 with an error document: code 100, "Invalid API Key".
|
||||
if (/<error\b[^>]*\bcode="100"/i.test(text)) return { took: false };
|
||||
if (/<error\b/i.test(text)) throw new Error("jackett answered with an error document");
|
||||
return { took: true, configured: configuredIndexers(text) };
|
||||
}
|
||||
throw new Error(`no check for ${provision}`);
|
||||
}
|
||||
|
||||
/** jackett's configured indexers, id → title, from its `t=indexers` feed. */
|
||||
export function configuredIndexers(xml: string): Map<string, string> {
|
||||
const out = new Map<string, string>();
|
||||
const re = /<indexer\b[^>]*\bid="([^"]+)"[^>]*>([\s\S]*?)<\/indexer>/g;
|
||||
for (let m = re.exec(xml); m; m = re.exec(xml)) {
|
||||
const title = /<title>([\s\S]*?)<\/title>/.exec(m[2])?.[1]?.trim() ?? m[1];
|
||||
out.set(m[1], decodeXml(title));
|
||||
}
|
||||
return out;
|
||||
}
|
||||
|
||||
function decodeXml(s: string): string {
|
||||
return s.replace(/</g, "<").replace(/>/g, ">").replace(/"/g, '"').replace(/'/g, "'").replace(/&/g, "&");
|
||||
}
|
||||
|
||||
/** The remedy for a refused credential, in the controller's own words (ADR 0092). */
|
||||
export function acceptRemedy(app: App, node: string, provision: string, provider: string, secretName: string, from: string): string {
|
||||
return (
|
||||
`${provider} refuses the ${provision} credential the mesh delivered, so nothing of ${provision} was written ` +
|
||||
`into ${app.module}. ${provider} has one ${secretName} and the mesh cannot make it: accept it for this pair — ` +
|
||||
`\`secret accept ${node || "<this node>"} ${app.module} ${provision} --provider ${from || "<its node>"} ` +
|
||||
`--from <file holding ${provider}'s ${secretName}>\``
|
||||
);
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------------------------
|
||||
// Download clients
|
||||
|
||||
/** The non-secret fields of a download client as the mesh says them. */
|
||||
export function clientConnection(ep: Endpoint): Record<string, unknown> {
|
||||
return { host: ep.host, port: ep.port, useSsl: ep.scheme === "https", urlBase: ep.urlBase === "" ? null : ep.urlBase, username: ep.username };
|
||||
}
|
||||
|
||||
/** Which of them the entry does not already say. Names only. */
|
||||
export function clientDiffers(e: Entry, ep: Endpoint): string[] {
|
||||
const out: string[] = [];
|
||||
if (String(field(e, "host") ?? "").toLowerCase() !== ep.host.toLowerCase()) out.push("host");
|
||||
if (Number(field(e, "port") ?? 0) !== ep.port) out.push("port");
|
||||
if (Boolean(field(e, "useSsl")) !== (ep.scheme === "https")) out.push("useSsl");
|
||||
if (normBase(field(e, "urlBase")) !== ep.urlBase) out.push("urlBase");
|
||||
if (String(field(e, "username") ?? "") !== ep.username) out.push("username");
|
||||
return out;
|
||||
}
|
||||
|
||||
/**
|
||||
* Bring the app's download client for one provision in line: the entry by that name and kind is
|
||||
* the mesh's and is updated; none, it is registered. An entry by that name of another kind, or by
|
||||
* that name in another case, is somebody else's and is refused rather than touched.
|
||||
*/
|
||||
export async function reconcileClient(
|
||||
http: Http,
|
||||
app: App,
|
||||
kind: ClientKind,
|
||||
name: string,
|
||||
ep: Endpoint,
|
||||
entries: Entry[],
|
||||
): Promise<Outcome[]> {
|
||||
const what = `${kind.provision} ("${name}")`;
|
||||
const exact = entries.filter((e) => e.name === name);
|
||||
const alike = entries.filter((e) => e.name !== name && String(e.name ?? "").toLowerCase() === name.toLowerCase());
|
||||
if (exact.length > 0 && exact[0].implementation !== kind.implementation) {
|
||||
return [{
|
||||
what,
|
||||
result: "refused",
|
||||
problem: `the download client named "${name}" is a ${exact[0].implementation}, not ${kind.implementation}; it is not the mesh's and was left alone. Name the mesh's entry otherwise in downloads.${kind.provision}.name`,
|
||||
}];
|
||||
}
|
||||
if (exact.length === 0 && alike.length > 0) {
|
||||
return [{
|
||||
what,
|
||||
result: "refused",
|
||||
problem: `${app.module} already has "${alike[0].name}", which is not the mesh's name ("${name}") and was left alone. To have the mesh manage it, set downloads.${kind.provision}.name to "${alike[0].name}"`,
|
||||
}];
|
||||
}
|
||||
const outcomes: Outcome[] = [];
|
||||
const others = entries.filter((e) => e.implementation === kind.implementation && e.name !== name);
|
||||
if (others.length > 0) {
|
||||
outcomes.push({
|
||||
what,
|
||||
result: "notice",
|
||||
note: `also present and not the mesh's, left alone: ${others.map((o) => `"${o.name}"`).join(", ")}`,
|
||||
});
|
||||
}
|
||||
if (exact.length === 0) {
|
||||
outcomes.push(
|
||||
await createEntry(http, app, "downloadclient", what, kind.implementation, name, {
|
||||
...clientConnection(ep),
|
||||
password: ep.credential,
|
||||
}),
|
||||
);
|
||||
return outcomes;
|
||||
}
|
||||
outcomes.push(
|
||||
await reconcileEntry(http, app, "downloadclient", what, exact[0], clientConnection(ep), clientDiffers(exact[0], ep), "password", ep.credential),
|
||||
);
|
||||
return outcomes;
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------------------------
|
||||
// Indexers
|
||||
|
||||
const FEED = /\/api\/v2\.0\/indexers\/([^/]+)\/results\/torznab\/?$/;
|
||||
|
||||
/** A Torznab entry reading a jackett feed: the host it points at and the jackett indexer's id. */
|
||||
export function jackettFeed(e: Entry): { host: string; id: string } | undefined {
|
||||
if (e.implementation !== "Torznab") return undefined;
|
||||
const raw = String(field(e, "baseUrl") ?? "").trim();
|
||||
if (!raw) return undefined;
|
||||
let u: URL;
|
||||
try {
|
||||
u = new URL(raw);
|
||||
} catch {
|
||||
return undefined;
|
||||
}
|
||||
const path = `${u.pathname.replace(/\/+$/, "")}/${String(field(e, "apiPath") ?? "").replace(/^\/+/, "")}`;
|
||||
const m = FEED.exec(path);
|
||||
if (!m) return undefined;
|
||||
return { host: u.hostname.replace(/^\[|\]$/g, "").toLowerCase(), id: decodeURIComponent(m[1]) };
|
||||
}
|
||||
|
||||
/** The feed's two fields as the mesh says them. */
|
||||
export function feedConnection(ep: Endpoint, id: string): Record<string, unknown> {
|
||||
return { baseUrl: baseUrl(ep), apiPath: `/api/v2.0/indexers/${id}/results/torznab/` };
|
||||
}
|
||||
|
||||
function sameUrl(a: string, b: string): boolean {
|
||||
try {
|
||||
const x = new URL(a);
|
||||
const y = new URL(b);
|
||||
const port = (u: URL) => u.port || (u.protocol === "https:" ? "443" : "80");
|
||||
return (
|
||||
x.protocol === y.protocol &&
|
||||
x.hostname.toLowerCase() === y.hostname.toLowerCase() &&
|
||||
port(x) === port(y) &&
|
||||
x.pathname.replace(/\/+$/, "") === y.pathname.replace(/\/+$/, "")
|
||||
);
|
||||
} catch {
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
export function feedDiffers(e: Entry, ep: Endpoint, id: string): string[] {
|
||||
const want = feedConnection(ep, id);
|
||||
const out: string[] = [];
|
||||
if (!sameUrl(String(field(e, "baseUrl") ?? ""), String(want.baseUrl))) out.push("baseUrl");
|
||||
const path = (v: unknown) => `/${String(v ?? "").replace(/^\/+|\/+$/g, "")}`;
|
||||
if (path(field(e, "apiPath")) !== path(want.apiPath)) out.push("apiPath");
|
||||
return out;
|
||||
}
|
||||
|
||||
export interface IndexerSettings {
|
||||
/** Hosts whose jackett feeds the mesh takes over — a migration's old names. */
|
||||
adoptHosts: string[];
|
||||
/** jackett indexer ids the app should have. */
|
||||
indexers: string[];
|
||||
}
|
||||
|
||||
/**
|
||||
* Bring the app's jackett feeds in line: every one the mesh manages is pointed at the bound jackett
|
||||
* with its key, and every listed jackett indexer the app lacks is registered.
|
||||
*/
|
||||
export async function reconcileIndexers(
|
||||
http: Http,
|
||||
app: App,
|
||||
ep: Endpoint,
|
||||
configured: Map<string, string>,
|
||||
settings: IndexerSettings,
|
||||
remembered: string[],
|
||||
entries: Entry[],
|
||||
): Promise<Outcome[]> {
|
||||
const ours = new Set([ep.host, ...settings.adoptHosts, ...remembered].map((h) => h.trim().toLowerCase()).filter(Boolean));
|
||||
const outcomes: Outcome[] = [];
|
||||
const managed = new Set<string>();
|
||||
for (const e of entries) {
|
||||
const feed = jackettFeed(e);
|
||||
if (!feed || !ours.has(feed.host)) continue;
|
||||
managed.add(feed.id);
|
||||
const what = `jackett-api ("${e.name}", jackett indexer ${feed.id})`;
|
||||
const known = feed.id === "all" || configured.has(feed.id);
|
||||
const outcome = await reconcileEntry(
|
||||
http, app, "indexer", what, e, feedConnection(ep, feed.id), feedDiffers(e, ep, feed.id), "apiKey", ep.credential, known,
|
||||
);
|
||||
outcomes.push(outcome);
|
||||
if (!known && outcome.result !== "refused") {
|
||||
outcomes.push({ what, result: "notice", note: `jackett has no indexer "${feed.id}" configured, so it was not tested; configure it in jackett or remove the entry in ${app.module}` });
|
||||
}
|
||||
}
|
||||
for (const id of settings.indexers) {
|
||||
if (managed.has(id)) continue;
|
||||
const what = `jackett-api (jackett indexer ${id})`;
|
||||
if (id !== "all" && !configured.has(id)) {
|
||||
outcomes.push({ what, result: "refused", problem: `downloads.jackett-api.indexers lists "${id}", and jackett has no indexer by that id configured` });
|
||||
continue;
|
||||
}
|
||||
const name = `Jackett - ${id === "all" ? "all" : configured.get(id)}`;
|
||||
outcomes.push(await createEntry(http, app, "indexer", what, "Torznab", name, { ...feedConnection(ep, id), apiKey: ep.credential }));
|
||||
}
|
||||
if (outcomes.length === 0) {
|
||||
outcomes.push({ what: "jackett-api", result: "notice", note: `${app.module} has no jackett feed the mesh manages, and downloads.jackett-api.indexers lists none to register` });
|
||||
}
|
||||
return outcomes;
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------------------------
|
||||
// Files
|
||||
|
||||
/** The module's settings for this step, from its merged `downloads.json`. */
|
||||
export interface StepSettings {
|
||||
node: string;
|
||||
names: Record<string, string>;
|
||||
indexers: IndexerSettings;
|
||||
}
|
||||
|
||||
export function stepSettings(raw: unknown): StepSettings {
|
||||
const doc = (raw ?? {}) as Record<string, unknown>;
|
||||
const d = (doc.downloads ?? {}) as Record<string, Record<string, unknown> | undefined>;
|
||||
const names: Record<string, string> = {};
|
||||
for (const k of CLIENTS) {
|
||||
const n = d[k.provision]?.name;
|
||||
names[k.provision] = typeof n === "string" && n.trim() ? n.trim() : k.provision.replace(/-api$/, "");
|
||||
}
|
||||
const j = d[JACKETT] ?? {};
|
||||
const strings = (v: unknown) => (Array.isArray(v) ? v.filter((x): x is string => typeof x === "string" && x.trim() !== "").map((x) => x.trim()) : []);
|
||||
return {
|
||||
node: typeof doc.node === "string" ? doc.node : "",
|
||||
names,
|
||||
indexers: { adoptHosts: strings(j["adopt-hosts"]), indexers: strings(j.indexers) },
|
||||
};
|
||||
}
|
||||
|
||||
/** The app's own key and base path, from its config.xml. */
|
||||
export function appConfig(xml: string): { apiKey: string; urlBase: string } {
|
||||
const tag = (t: string) => new RegExp(`<${t}>([^<]*)</${t}>`).exec(xml)?.[1]?.trim() ?? "";
|
||||
return { apiKey: tag("ApiKey"), urlBase: normBase(tag("UrlBase")) };
|
||||
}
|
||||
|
||||
/** 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 JSON file parsed, or undefined when absent or not JSON. */
|
||||
export async function readJson(path: string | undefined): Promise<unknown> {
|
||||
const raw = await readIfThere(path);
|
||||
if (raw === undefined) return undefined;
|
||||
try {
|
||||
return JSON.parse(raw) as unknown;
|
||||
} catch {
|
||||
return undefined;
|
||||
}
|
||||
}
|
||||
|
||||
/** Wait for the app to answer, because the step runs right after its container starts. */
|
||||
export async function appReady(http: Http, app: App, waitMs: number, pauseMs = 2000): Promise<boolean> {
|
||||
const until = Date.now() + waitMs;
|
||||
for (;;) {
|
||||
try {
|
||||
const a = await appCall(http, app, "GET", "/system/status");
|
||||
if (a.status === 200) return true;
|
||||
} catch {
|
||||
// not listening yet
|
||||
}
|
||||
if (Date.now() >= until) return false;
|
||||
await new Promise((r) => setTimeout(r, pauseMs));
|
||||
}
|
||||
}
|
||||
|
||||
export async function listEntries(http: Http, app: App, resource: "downloadclient" | "indexer"): Promise<Entry[]> {
|
||||
return ((await appGet(http, app, `/${resource}`)) as Entry[]) ?? [];
|
||||
}
|
||||
|
||||
/** Anything printed goes through this: the credentials the step holds never reach a log. */
|
||||
export function scrub(text: string, secrets: string[]): string {
|
||||
let out = text;
|
||||
for (const s of secrets) if (s && s.length >= 4) out = out.split(s).join("<redacted>");
|
||||
return out;
|
||||
}
|
||||
|
||||
function message(err: unknown): string {
|
||||
return err instanceof Error ? err.message : String(err);
|
||||
}
|
||||
@@ -39,10 +39,15 @@
|
||||
"path": "/var/lib/mesh/bookshelf",
|
||||
"mode": "0700"
|
||||
},
|
||||
{
|
||||
"id": "state",
|
||||
"type": "directory",
|
||||
"mode": "0700",
|
||||
"place": "."
|
||||
},
|
||||
{
|
||||
"id": "config",
|
||||
"type": "directory",
|
||||
"path": "/services/bookshelf/config",
|
||||
"mode": "0700",
|
||||
"owner": "1000:1000"
|
||||
},
|
||||
@@ -50,7 +55,7 @@
|
||||
"id": "server",
|
||||
"type": "container",
|
||||
"name": "bookshelf",
|
||||
"image": "ghcr.io/pennydreadful/bookshelf@sha256:388eecc94362580eae31ee0a454be6af516f8a311f8432a521c202fb475f4359",
|
||||
"image": "ghcr.io/pennydreadful/bookshelf@sha256:67498dd5ece516867d72ee642abd6c1a66b36a135c8f7da0127109564372beb1",
|
||||
"env": {
|
||||
"PUID": "1000",
|
||||
"PGID": "1000",
|
||||
@@ -60,7 +65,7 @@
|
||||
"8787"
|
||||
],
|
||||
"volumes": [
|
||||
"/services/bookshelf/config:/config",
|
||||
"${dir:config}:/config",
|
||||
"/services/media/books:/books",
|
||||
"/services/media/downloads:/downloads"
|
||||
]
|
||||
@@ -72,17 +77,74 @@
|
||||
"network": "host",
|
||||
"volumes": [
|
||||
"/var/lib/mesh/bookshelf/broker:/run/secrets/broker:ro",
|
||||
"/services/bookshelf/config:/var/lib/bookshelf/config:ro"
|
||||
"${dir:config}:/var/lib/bookshelf/config:ro"
|
||||
],
|
||||
"env": {
|
||||
"MESH_BROKER_FILE": "/run/secrets/broker",
|
||||
"MESH_BOOKSHELF_URL": "http://127.0.0.1:8787",
|
||||
"MESH_BOOKSHELF_URL": "http://127.0.0.1:${port:8787}",
|
||||
"MESH_BOOKSHELF_CONFIG_DIR": "/var/lib/bookshelf/config"
|
||||
},
|
||||
"artifact": "runtime"
|
||||
},
|
||||
{
|
||||
"id": "downloads-config",
|
||||
"type": "file",
|
||||
"path": "${dir:state}/downloads.json",
|
||||
"mode": "0600",
|
||||
"content": "{\n \"node\": \"${machine:name}\",\n \"downloads\": {\n \"nzbget-api\": {\n \"name\": \"nzbget\"\n },\n \"qbittorrent-api\": {\n \"name\": \"qbittorrent\"\n },\n \"jackett-api\": {\n \"adopt-hosts\": [],\n \"indexers\": []\n }\n }\n}\n",
|
||||
"merge": "json"
|
||||
},
|
||||
{
|
||||
"id": "downloads-memory",
|
||||
"type": "directory",
|
||||
"mode": "0700"
|
||||
},
|
||||
{
|
||||
"id": "downloads",
|
||||
"type": "container",
|
||||
"name": "mesh-bookshelf-downloads",
|
||||
"network": "host",
|
||||
"run-once": true,
|
||||
"volumes": [
|
||||
"${dir:state}/downloads.json:/run/downloads/downloads.json:ro",
|
||||
"${dir:state}/nzbget-api.json:/run/downloads/nzbget-api.json:ro",
|
||||
"${dir:state}/nzbget-api.secret:/run/downloads/nzbget-api.secret:ro",
|
||||
"${dir:state}/qbittorrent-api.json:/run/downloads/qbittorrent-api.json:ro",
|
||||
"${dir:state}/qbittorrent-api.secret:/run/downloads/qbittorrent-api.secret:ro",
|
||||
"${dir:state}/jackett-api.json:/run/downloads/jackett-api.json:ro",
|
||||
"${dir:state}/jackett-api.secret:/run/downloads/jackett-api.secret:ro",
|
||||
"${dir:config}:/var/lib/bookshelf/config:ro",
|
||||
"${dir:downloads-memory}:/var/lib/downloads"
|
||||
],
|
||||
"env": {
|
||||
"MESH_DOWNLOADS_APP": "bookshelf",
|
||||
"MESH_DOWNLOADS_API": "v1",
|
||||
"MESH_DOWNLOADS_APP_URL": "http://127.0.0.1:${port:8787}",
|
||||
"MESH_DOWNLOADS_APP_CONFIG": "/var/lib/bookshelf/config/config.xml",
|
||||
"MESH_DOWNLOADS_DIR": "/run/downloads",
|
||||
"MESH_DOWNLOADS_SETTINGS": "/run/downloads/downloads.json",
|
||||
"MESH_DOWNLOADS_MEMORY": "/var/lib/downloads/memory.json"
|
||||
},
|
||||
"args": [
|
||||
"run",
|
||||
"/app/modules/bookshelf/dist/downloads/index.js"
|
||||
],
|
||||
"restart-on": [
|
||||
"downloads-config",
|
||||
"bound-nzbget-api",
|
||||
"secret-nzbget-api",
|
||||
"bound-qbittorrent-api",
|
||||
"secret-qbittorrent-api",
|
||||
"bound-jackett-api",
|
||||
"secret-jackett-api"
|
||||
],
|
||||
"artifact": "runtime"
|
||||
}
|
||||
],
|
||||
"requires": [
|
||||
"jackett-api",
|
||||
"nzbget-api",
|
||||
"qbittorrent-api",
|
||||
"route"
|
||||
],
|
||||
"contributes": {
|
||||
@@ -92,7 +154,15 @@
|
||||
}
|
||||
},
|
||||
"binds": {
|
||||
"route": "/var/lib/mesh/bookshelf/route.json"
|
||||
"route": "${dir:state}/route.json",
|
||||
"nzbget-api": "${dir:state}/nzbget-api.json",
|
||||
"qbittorrent-api": "${dir:state}/qbittorrent-api.json",
|
||||
"jackett-api": "${dir:state}/jackett-api.json"
|
||||
},
|
||||
"secrets": {
|
||||
"nzbget-api": "${dir:state}/nzbget-api.secret",
|
||||
"qbittorrent-api": "${dir:state}/qbittorrent-api.secret",
|
||||
"jackett-api": "${dir:state}/jackett-api.secret"
|
||||
},
|
||||
"build": {
|
||||
"on": [
|
||||
|
||||
@@ -4,6 +4,11 @@
|
||||
"description": "bookshelf — ebook/audiobook management (Readarr fork). Its API client, tools and events live here (novox/hq ADR 0039).",
|
||||
"type": "module",
|
||||
"private": true,
|
||||
"scripts": {
|
||||
"build": "tsc client.ts index.ts tools/index.ts downloads/settings.ts downloads/index.ts --module NodeNext --moduleResolution NodeNext --target ES2022 --outDir dist",
|
||||
"typecheck": "tsc -p tsconfig.json",
|
||||
"test": "node --test --experimental-strip-types 'test/*.test.ts'"
|
||||
},
|
||||
"dependencies": {
|
||||
"@novox/mesh-sdk": "^0.1.0"
|
||||
},
|
||||
|
||||
@@ -0,0 +1,365 @@
|
||||
// What holds the downloads step (downloads/settings.ts): the app's download clients and jackett
|
||||
// feeds are made to say what the mesh bound — host, port, TLS, base path, user, credential — and
|
||||
// nothing else they keep is touched; only the mesh's entries are touched, and nothing is ever
|
||||
// deleted; nothing is written when nothing differs; a missing one is registered; and a credential
|
||||
// the provider refuses (the mesh's own minted value, before the operator accepts the provider's)
|
||||
// is never written, with the `secret accept` that fixes it named.
|
||||
//
|
||||
// The app and the providers are fakes: the routes the step touches, answering as the real ones do
|
||||
// (checked against the catalogue's pinned sonarr, radarr, lidarr, bookshelf, nzbget, qBittorrent
|
||||
// and jackett): the app masks a stored password as "********", tests an enabled entry before
|
||||
// saving it, refuses a warning unless forceSave, and jackett answers a wrong key 200 with an error.
|
||||
|
||||
import { test } from "node:test";
|
||||
import assert from "node:assert/strict";
|
||||
import { existsSync, readFileSync } from "node:fs";
|
||||
import { dirname, join } from "node:path";
|
||||
import { fileURLToPath } from "node:url";
|
||||
|
||||
import {
|
||||
CLIENTS,
|
||||
acceptRemedy,
|
||||
jackettFeed,
|
||||
providerTakes,
|
||||
reconcileClient,
|
||||
reconcileIndexers,
|
||||
stepSettings,
|
||||
wanted,
|
||||
type App,
|
||||
type Binding,
|
||||
type Endpoint,
|
||||
type Entry,
|
||||
type Http,
|
||||
} from "../downloads/settings.ts";
|
||||
|
||||
const NZBGET = CLIENTS.find((c) => c.provision === "nzbget-api")!;
|
||||
const QBIT = CLIENTS.find((c) => c.provision === "qbittorrent-api")!;
|
||||
const APP: App = { module: "sonarr", url: "http://127.0.0.1:8989", apiKey: "app-key", api: "v3" };
|
||||
const MASK = "********";
|
||||
|
||||
interface Provider {
|
||||
host: string;
|
||||
port: number;
|
||||
user?: string;
|
||||
secret: string;
|
||||
configured?: Record<string, string>;
|
||||
}
|
||||
|
||||
const nzbget: Provider = { host: "ace.internal", port: 20201, user: "luffy", secret: "nzb-real" };
|
||||
const qbit: Provider = { host: "ace.internal", port: 8112, user: "luffy", secret: "qbt-real" };
|
||||
const jackett: Provider = { host: "ace.internal", port: 20204, secret: "jackett-real", configured: { rutracker: "RuTracker", torrent9: "Torrent9" } };
|
||||
|
||||
function binding(p: Provider, provision: string, extra: Record<string, unknown> = {}): Binding {
|
||||
return {
|
||||
provision,
|
||||
from: "ace",
|
||||
at: p.host,
|
||||
as: "mesh_ace_sonarr",
|
||||
serves: { scheme: "http", port: p.port, "url-base": "", ...(p.user ? { username: p.user } : {}), ...extra },
|
||||
};
|
||||
}
|
||||
|
||||
function endpoint(p: Provider, provision: string, credential = p.secret): Endpoint {
|
||||
const w = wanted(provision, binding(p, provision), credential, provision !== "jackett-api");
|
||||
if (!w.ok) throw new Error(w.problem);
|
||||
return w.endpoint;
|
||||
}
|
||||
|
||||
const f = (name: string, value: unknown) => ({ name, value });
|
||||
|
||||
function client(id: number, name: string, implementation: string, host: string, port: number, password: string, extra: Record<string, unknown> = {}): Entry {
|
||||
return {
|
||||
id, name, implementation, enable: true, priority: 1, tags: [],
|
||||
fields: [f("host", host), f("port", port), f("useSsl", false), f("urlBase", null), f("username", "luffy"), f("password", password), f("tvCategory", "Series"), ...Object.entries(extra).map(([k, v]) => f(k, v))],
|
||||
};
|
||||
}
|
||||
|
||||
function feed(id: number, name: string, baseUrl: string, jid: string, key: string, on = true): Entry {
|
||||
return {
|
||||
id, name, implementation: "Torznab", enableRss: on, enableAutomaticSearch: on, enableInteractiveSearch: on, priority: 25,
|
||||
fields: [f("baseUrl", baseUrl), f("apiPath", `/api/v2.0/indexers/${jid}/results/torznab/`), f("apiKey", key), f("categories", [5000])],
|
||||
};
|
||||
}
|
||||
|
||||
interface Call {
|
||||
method: string;
|
||||
url: string;
|
||||
body?: unknown;
|
||||
}
|
||||
|
||||
/** A Servarr app and the three providers behind one fetch. */
|
||||
function fakes(start: { clients?: Entry[]; indexers?: Entry[] }) {
|
||||
const calls: Call[] = [];
|
||||
const store: Record<string, Entry[]> = {
|
||||
downloadclient: structuredClone(start.clients ?? []),
|
||||
indexer: structuredClone(start.indexers ?? []),
|
||||
};
|
||||
let next = 100;
|
||||
const secretOf: Record<string, string> = { downloadclient: "password", indexer: "apiKey" };
|
||||
const masked = (e: Entry): Entry => ({ ...e, fields: e.fields!.map((x) => (x.name === "password" || x.name === "apiKey") && x.value ? { ...x, value: MASK } : { ...x }) });
|
||||
const val = (e: Entry, n: string) => e.fields?.find((x) => x.name === n)?.value;
|
||||
|
||||
/** What the app's own test says: dialled from its container, with its stored secret for a mask. */
|
||||
const appTest = (kind: string, e: Entry): { propertyName: string; errorMessage: string; isWarning: boolean }[] => {
|
||||
let secret = val(e, secretOf[kind]);
|
||||
if (secret === MASK) secret = val(store[kind].find((s) => s.id === e.id) ?? {}, secretOf[kind]);
|
||||
if (kind === "downloadclient") {
|
||||
const p = e.implementation === "Nzbget" ? nzbget : qbit;
|
||||
if (val(e, "host") !== p.host || val(e, "port") !== p.port) return [{ propertyName: "Host", errorMessage: "Unable to connect", isWarning: false }];
|
||||
if (secret !== p.secret || val(e, "username") !== p.user) return [{ propertyName: "Username", errorMessage: "Authentication Failure", isWarning: false }];
|
||||
if (val(e, "tvCategory") === "") return [{ propertyName: "TvCategory", errorMessage: "A category is recommended", isWarning: true }];
|
||||
if (e.implementation === "Nzbget" && val(e, "tvCategory") === "tv") return [{ propertyName: "TvCategory", errorMessage: "Category does not exist", isWarning: false }];
|
||||
return [];
|
||||
}
|
||||
const u = new URL(String(val(e, "baseUrl")));
|
||||
if (u.hostname !== jackett.host || Number(u.port) !== jackett.port) return [{ propertyName: "BaseUrl", errorMessage: "Unable to connect", isWarning: false }];
|
||||
if (secret !== jackett.secret) return [{ propertyName: "ApiKey", errorMessage: "Invalid API Key", isWarning: false }];
|
||||
const id = /indexers\/([^/]+)\//.exec(String(val(e, "apiPath")))?.[1] ?? "";
|
||||
if (!(id in jackett.configured!)) return [{ propertyName: "", errorMessage: "Unknown indexer", isWarning: false }];
|
||||
return [];
|
||||
};
|
||||
|
||||
const http: Http = {
|
||||
async fetch(url, init) {
|
||||
const method = init?.method ?? "GET";
|
||||
const body = init?.body && init.headers?.["Content-Type"] === "application/json" ? (JSON.parse(init.body) as Entry) : init?.body;
|
||||
calls.push({ method, url, body });
|
||||
const reply = (status: number, value?: unknown) => ({ status, text: async () => (value === undefined ? "" : typeof value === "string" ? value : JSON.stringify(value)) });
|
||||
const u = new URL(url);
|
||||
// Providers.
|
||||
if (u.pathname === "/jsonrpc/version") {
|
||||
const want = "Basic " + Buffer.from(`${nzbget.user}:${nzbget.secret}`).toString("base64");
|
||||
return init?.headers?.Authorization === want ? reply(200, { result: "26.0" }) : reply(401);
|
||||
}
|
||||
if (u.pathname === "/api/v2/auth/login") {
|
||||
const form = new URLSearchParams(String(init?.body ?? ""));
|
||||
return form.get("username") === qbit.user && form.get("password") === qbit.secret ? reply(204) : reply(401, "Unauthorized");
|
||||
}
|
||||
if (u.pathname.endsWith("/torznab/api")) {
|
||||
if (u.searchParams.get("apikey") !== jackett.secret) return reply(200, '<?xml version="1.0"?><error code="100" description="Invalid API Key" />');
|
||||
const items = Object.entries(jackett.configured!).map(([id, t]) => `<indexer id="${id}" configured="true"><title>${t}</title></indexer>`).join("");
|
||||
return reply(200, `<?xml version="1.0"?><indexers>${items}</indexers>`);
|
||||
}
|
||||
// The app.
|
||||
if (init?.headers?.["X-Api-Key"] !== APP.apiKey) return reply(401);
|
||||
const m = /^\/api\/v3\/(downloadclient|indexer)(?:\/(schema|test|\d+))?$/.exec(u.pathname);
|
||||
if (!m) return reply(404);
|
||||
const [, kind, sub] = m;
|
||||
const force = u.searchParams.get("forceSave") === "true";
|
||||
if (method === "GET" && !sub) return reply(200, store[kind].map(masked));
|
||||
if (method === "GET" && sub === "schema") {
|
||||
return reply(200, kind === "downloadclient"
|
||||
? [client(0, "", "Nzbget", "localhost", 6789, MASK, {}), client(0, "", "QBittorrent", "localhost", 8080, "", {})].map((e) => ({ ...e, fields: e.fields!.map((x) => x.name === "tvCategory" ? { ...x, value: e.implementation === "Nzbget" ? "tv" : "tv-sonarr" } : x.name === "username" ? { ...x, value: null } : x) }))
|
||||
: [{ ...feed(0, "", "", "x", "", false), supportsRss: true, supportsSearch: true, fields: [f("baseUrl", null), f("apiPath", "/api"), f("apiKey", null), f("categories", [5030, 5040])] }]);
|
||||
}
|
||||
if (method === "GET") {
|
||||
const e = store[kind].find((s) => s.id === Number(sub));
|
||||
return e ? reply(200, masked(e)) : reply(404);
|
||||
}
|
||||
if (method === "POST" && sub === "test") {
|
||||
const fails = appTest(kind, body as Entry);
|
||||
return fails.length ? reply(400, fails) : reply(200);
|
||||
}
|
||||
// Save: tested when enabled; a mask keeps what is stored.
|
||||
const e = body as Entry;
|
||||
const on = e.enable === true || e.enableRss === true || e.enableAutomaticSearch === true;
|
||||
if (on) {
|
||||
const fails = appTest(kind, e);
|
||||
if (fails.some((x) => !x.isWarning) || (fails.length && !force)) return reply(400, fails);
|
||||
}
|
||||
if (method === "POST" && !sub) {
|
||||
if (store[kind].some((s) => String(s.name).toLowerCase() === String(e.name).toLowerCase())) {
|
||||
return reply(400, [{ propertyName: "Name", errorMessage: "Should be unique", isWarning: false }]);
|
||||
}
|
||||
const created = { ...e, id: next++ };
|
||||
store[kind].push(created);
|
||||
return reply(201, masked(created));
|
||||
}
|
||||
if (method === "PUT") {
|
||||
const i = store[kind].findIndex((s) => s.id === Number(sub));
|
||||
if (i < 0) return reply(404);
|
||||
const was = store[kind][i];
|
||||
store[kind][i] = { ...e, fields: e.fields!.map((x) => x.value === MASK ? { ...x, value: val(was, x.name) } : x) };
|
||||
return reply(202, masked(store[kind][i]));
|
||||
}
|
||||
return reply(405);
|
||||
},
|
||||
};
|
||||
const saves = () => calls.filter((c) => (c.method === "PUT" || (c.method === "POST" && !c.url.endsWith("/test"))) && c.url.includes("/api/v3/"));
|
||||
return { http, calls, store, saves };
|
||||
}
|
||||
|
||||
const aceClients = () => [
|
||||
client(1, "NZBGet", "Nzbget", "nzbget", 6789, "nzb-real"),
|
||||
client(2, "qBitTorrent", "QBittorrent", "qbittorrent", 8112, "qbt-real"),
|
||||
];
|
||||
|
||||
test("the migration's download client is repointed, its category and everything else kept", async () => {
|
||||
const f = fakes({ clients: aceClients() });
|
||||
const out = await reconcileClient(f.http, APP, NZBGET, "NZBGet", endpoint(nzbget, "nzbget-api"), f.store.downloadclient.map((e) => ({ ...e })));
|
||||
assert.deepEqual(out, [{ what: 'nzbget-api ("NZBGet")', result: "written", fields: ["host", "port"] }]);
|
||||
const saved = f.store.downloadclient.find((e) => e.id === 1)!;
|
||||
const v = (n: string) => saved.fields!.find((x) => x.name === n)?.value;
|
||||
assert.equal(v("host"), "ace.internal");
|
||||
assert.equal(v("port"), 20201);
|
||||
assert.equal(v("tvCategory"), "Series");
|
||||
assert.equal(v("password"), "nzb-real", "the password it held works, so it was kept, not rewritten");
|
||||
assert.equal(saved.priority, 1);
|
||||
});
|
||||
|
||||
test("rerun: already as the mesh says, nothing saved", async () => {
|
||||
const f = fakes({ clients: [client(1, "NZBGet", "Nzbget", "ace.internal", 20201, "nzb-real")] });
|
||||
const out = await reconcileClient(f.http, APP, NZBGET, "NZBGet", endpoint(nzbget, "nzbget-api"), f.store.downloadclient);
|
||||
assert.deepEqual(out, [{ what: 'nzbget-api ("NZBGet")', result: "unchanged" }]);
|
||||
assert.equal(f.saves().length, 0);
|
||||
});
|
||||
|
||||
test("a stale password is replaced by the delivered one, which the provider took first", async () => {
|
||||
const f = fakes({ clients: [client(2, "qBitTorrent", "QBittorrent", "ace.internal", 8112, "old-pass")] });
|
||||
const out = await reconcileClient(f.http, APP, QBIT, "qBitTorrent", endpoint(qbit, "qbittorrent-api"), f.store.downloadclient);
|
||||
assert.deepEqual(out, [{ what: 'qbittorrent-api ("qBitTorrent")', result: "written", fields: ["password"] }]);
|
||||
assert.equal(f.store.downloadclient[0].fields!.find((x) => x.name === "password")?.value, "qbt-real");
|
||||
});
|
||||
|
||||
test("a minted credential is refused by the provider: nothing written, the accept named", async () => {
|
||||
const f = fakes({ clients: aceClients() });
|
||||
const ep = endpoint(nzbget, "nzbget-api", "a-value-the-mesh-minted");
|
||||
assert.deepEqual(await providerTakes(f.http, "nzbget-api", ep), { took: false });
|
||||
const remedy = acceptRemedy(APP, "ace", "nzbget-api", "nzbget", "ControlPassword", ep.from);
|
||||
assert.match(remedy, /`secret accept ace sonarr nzbget-api --provider ace --from <file holding nzbget's ControlPassword>`/);
|
||||
assert.doesNotMatch(remedy, /minted/);
|
||||
assert.equal(f.calls.some((c) => c.url.includes("/api/v3/")), false, "the app was not even asked");
|
||||
const q = endpoint(qbit, "qbittorrent-api", "minted");
|
||||
assert.deepEqual(await providerTakes(f.http, "qbittorrent-api", q), { took: false });
|
||||
const j = endpoint(jackett, "jackett-api", "minted");
|
||||
assert.deepEqual(await providerTakes(f.http, "jackett-api", j), { took: false });
|
||||
assert.equal(f.calls.find((c) => c.url.includes("apikey="))?.url.includes("jackett-real"), false);
|
||||
});
|
||||
|
||||
test("a fresh app gets the mesh's client registered, under the mesh's name", async () => {
|
||||
const f = fakes({});
|
||||
const out = await reconcileClient(f.http, APP, QBIT, "qbittorrent", endpoint(qbit, "qbittorrent-api"), []);
|
||||
assert.equal(out[0].result, "created");
|
||||
const e = f.store.downloadclient[0];
|
||||
assert.equal(e.name, "qbittorrent");
|
||||
assert.equal(e.enable, true);
|
||||
assert.equal(e.fields!.find((x) => x.name === "tvCategory")?.value, "tv-sonarr", "the app's own default category");
|
||||
});
|
||||
|
||||
test("nzbget without the app's default category: registered with none, and said", async () => {
|
||||
const f = fakes({});
|
||||
const out = await reconcileClient(f.http, APP, NZBGET, "nzbget", endpoint(nzbget, "nzbget-api"), []);
|
||||
assert.equal(out[0].result, "notice");
|
||||
assert.match((out[0] as { note: string }).note, /category left empty/);
|
||||
assert.equal(f.store.downloadclient[0].fields!.find((x) => x.name === "tvCategory")?.value, "");
|
||||
});
|
||||
|
||||
test("somebody else's entries are never touched: another name of the same kind, and a clash of names", async () => {
|
||||
const mine = client(7, "My seedbox", "QBittorrent", "seedbox.example", 443, "theirs");
|
||||
const f = fakes({ clients: [mine] });
|
||||
const out = await reconcileClient(f.http, APP, QBIT, "qbittorrent", endpoint(qbit, "qbittorrent-api"), f.store.downloadclient);
|
||||
assert.equal(out[0].result, "notice");
|
||||
assert.deepEqual(f.store.downloadclient.find((e) => e.id === 7), mine);
|
||||
// Same name in another case: refused, and the setting that adopts it named.
|
||||
const g = fakes({ clients: aceClients() });
|
||||
const clash = await reconcileClient(g.http, APP, NZBGET, "nzbget", endpoint(nzbget, "nzbget-api"), g.store.downloadclient);
|
||||
assert.equal(clash[0].result, "refused");
|
||||
assert.match((clash[0] as { problem: string }).problem, /downloads\.nzbget-api\.name to "NZBGet"/);
|
||||
assert.equal(g.saves().length, 0);
|
||||
});
|
||||
|
||||
test("jackett feeds: the migration's are repointed, a person's is left, a listed one is registered", async () => {
|
||||
const personal = feed(9, "Seedbox jackett", "https://jackett.seedbox.example", "rutracker", "their-key");
|
||||
const f = fakes({
|
||||
indexers: [
|
||||
feed(5, "Torznab - RuTracker", "https://indexers.zurag.be", "rutracker-ru", "jackett-real", false),
|
||||
feed(6, "Torznab - Torrent9", "https://indexers.zurag.be", "torrent9", "jackett-real", false),
|
||||
feed(4, "Jackett - RARBG", "http://jackett:9117", "therarbg", "old", false),
|
||||
personal,
|
||||
],
|
||||
});
|
||||
const configured = new Map(Object.entries(jackett.configured!));
|
||||
const out = await reconcileIndexers(
|
||||
f.http, APP, endpoint(jackett, "jackett-api"), configured,
|
||||
{ adoptHosts: ["indexers.zurag.be", "jackett"], indexers: ["rutracker"] }, [], f.store.indexer,
|
||||
);
|
||||
const byWhat = Object.fromEntries(out.map((o) => [o.what + ":" + o.result, o]));
|
||||
// torrent9: jackett has it; repointed, key already right, tested.
|
||||
assert.ok(byWhat['jackett-api ("Torznab - Torrent9", jackett indexer torrent9):written']);
|
||||
// rutracker-ru and therarbg: jackett has neither — repointed with the key, untested, and said.
|
||||
assert.ok(byWhat['jackett-api ("Jackett - RARBG", jackett indexer therarbg):written']);
|
||||
assert.ok(byWhat['jackett-api ("Jackett - RARBG", jackett indexer therarbg):notice']);
|
||||
// rutracker is listed and nothing of the mesh's reads it: registered.
|
||||
assert.ok(byWhat["jackett-api (jackett indexer rutracker):created"]);
|
||||
assert.deepEqual(f.store.indexer.find((e) => e.id === 9), personal, "a person's jackett is not the mesh's");
|
||||
const t9 = f.store.indexer.find((e) => e.id === 6)!;
|
||||
assert.equal(t9.fields!.find((x) => x.name === "baseUrl")?.value, "http://ace.internal:20204");
|
||||
assert.equal(t9.enableRss, false, "disabled stays disabled");
|
||||
const created = f.store.indexer.find((e) => e.name === "Jackett - RuTracker")!;
|
||||
assert.equal(created.enableRss, true);
|
||||
assert.equal(f.calls.some((c) => c.method === "DELETE"), false, "nothing is ever deleted");
|
||||
});
|
||||
|
||||
test("jackett feeds rerun: nothing saved, and a remembered host keeps a moved jackett's feeds", async () => {
|
||||
const f = fakes({ indexers: [feed(6, "Torznab - Torrent9", "http://ace.internal:20204", "torrent9", "jackett-real")] });
|
||||
const configured = new Map(Object.entries(jackett.configured!));
|
||||
const out = await reconcileIndexers(f.http, APP, endpoint(jackett, "jackett-api"), configured, { adoptHosts: [], indexers: ["torrent9"] }, [], f.store.indexer);
|
||||
assert.deepEqual(out.map((o) => o.result), ["unchanged"]);
|
||||
assert.equal(f.saves().length, 0);
|
||||
// jackett moved to novox: the feed on ace.internal is still the mesh's because it was remembered.
|
||||
const moved = { ...jackett, host: "novox.internal" };
|
||||
const g = fakes({ indexers: [feed(6, "Torznab - Torrent9", "http://ace.internal:20204", "torrent9", "jackett-real")] });
|
||||
const saved = jackett.host;
|
||||
jackett.host = moved.host;
|
||||
try {
|
||||
const again = await reconcileIndexers(g.http, APP, endpoint(moved, "jackett-api"), configured, { adoptHosts: [], indexers: [] }, ["ace.internal"], g.store.indexer);
|
||||
assert.equal(again[0].result, "written");
|
||||
assert.equal(g.store.indexer[0].fields!.find((x) => x.name === "baseUrl")?.value, "http://novox.internal:20204");
|
||||
} finally {
|
||||
jackett.host = saved;
|
||||
}
|
||||
});
|
||||
|
||||
test("an enabled entry the app cannot test at the mesh's address is not saved", async () => {
|
||||
const f = fakes({ clients: [client(1, "NZBGet", "Nzbget", "nzbget", 6789, "nzb-real")] });
|
||||
const elsewhere = { ...nzbget, port: 1 };
|
||||
const out = await reconcileClient(f.http, APP, NZBGET, "NZBGet", endpoint(elsewhere, "nzbget-api"), f.store.downloadclient);
|
||||
assert.equal(out[0].result, "refused");
|
||||
assert.equal(f.store.downloadclient[0].fields!.find((x) => x.name === "host")?.value, "nzbget", "left as it was");
|
||||
});
|
||||
|
||||
test("bindings: loopback, no user, no credential are refused; the base path is normalised", () => {
|
||||
assert.equal(wanted("nzbget-api", { ...binding(nzbget, "nzbget-api"), at: "127.0.0.1" }, "x", true).ok, false);
|
||||
assert.equal(wanted("nzbget-api", binding({ ...nzbget, user: undefined }, "nzbget-api"), "x", true).ok, false);
|
||||
assert.equal(wanted("nzbget-api", binding(nzbget, "nzbget-api"), " \n", true).ok, false);
|
||||
const w = wanted("jackett-api", binding(jackett, "jackett-api", { "url-base": "jackett/" }), "k", false);
|
||||
assert.equal(w.ok && w.endpoint.urlBase, "/jackett");
|
||||
});
|
||||
|
||||
test("a feed is read whole: base path in the base URL or in the API path", () => {
|
||||
const e = feed(1, "x", "http://ace.internal:9117/jackett", "rutracker", "k");
|
||||
assert.deepEqual(jackettFeed(e), { host: "ace.internal", id: "rutracker" });
|
||||
assert.equal(jackettFeed({ ...e, implementation: "Newznab" }), undefined);
|
||||
assert.equal(jackettFeed({ ...e, fields: [f("baseUrl", "https://api.nzbgeek.info"), f("apiPath", "/api")] }), undefined);
|
||||
});
|
||||
|
||||
test("settings: names default to the provider's, adoption and registration read from the merged file", () => {
|
||||
assert.deepEqual(stepSettings({ node: "ace" }), { node: "ace", names: { "nzbget-api": "nzbget", "qbittorrent-api": "qbittorrent" }, indexers: { adoptHosts: [], indexers: [] } });
|
||||
const s = stepSettings({ node: "ace", downloads: { "nzbget-api": { name: "NZBGet" }, "jackett-api": { "adopt-hosts": ["jackett"], indexers: ["torrent9", 3] } } });
|
||||
assert.equal(s.names["nzbget-api"], "NZBGet");
|
||||
assert.deepEqual(s.indexers, { adoptHosts: ["jackett"], indexers: ["torrent9"] });
|
||||
});
|
||||
|
||||
// The four copies are one step. Where the siblings are checked out beside this module, they must
|
||||
// be byte-identical — a fix made in one and not the others is a bug in three apps.
|
||||
test("the step is the same in sonarr, radarr, lidarr and bookshelf", () => {
|
||||
const here = dirname(dirname(fileURLToPath(import.meta.url)));
|
||||
const modules = dirname(here);
|
||||
for (const file of ["downloads/settings.ts", "downloads/index.ts", "test/downloads.test.ts"]) {
|
||||
const mine = readFileSync(join(here, file), "utf8");
|
||||
for (const sibling of ["sonarr", "radarr", "lidarr", "bookshelf"]) {
|
||||
const theirs = join(modules, sibling, file);
|
||||
if (existsSync(theirs)) assert.equal(readFileSync(theirs, "utf8"), mine, `${sibling}/${file} differs`);
|
||||
}
|
||||
}
|
||||
});
|
||||
@@ -8,5 +8,5 @@
|
||||
"skipLibCheck": true,
|
||||
"noEmit": true
|
||||
},
|
||||
"include": ["client.ts", "index.ts", "tools/index.ts"]
|
||||
"include": ["client.ts", "index.ts", "tools/index.ts", "downloads/settings.ts", "downloads/index.ts"]
|
||||
}
|
||||
|
||||
+21
-41
@@ -10,35 +10,35 @@
|
||||
"port": 8443,
|
||||
"protocol": "tcp",
|
||||
"from": "mesh",
|
||||
"why": "the controller web UI and API, over its own self-signed tls; named through the proxy as an https route"
|
||||
"why": "the controller web UI, over its own self-signed tls; reaching it from outside is a route grant later"
|
||||
},
|
||||
{
|
||||
"name": "inform",
|
||||
"port": 8080,
|
||||
"protocol": "tcp",
|
||||
"from": "mesh",
|
||||
"why": "device inform, how APs and switches check in and are adopted; the controller tells devices this number, so the machine must publish it on the same one"
|
||||
"why": "device inform \u2014 how APs and switches check in and are adopted"
|
||||
},
|
||||
{
|
||||
"name": "stun",
|
||||
"port": 3478,
|
||||
"protocol": "udp",
|
||||
"from": "mesh",
|
||||
"why": "STUN for managed devices; the controller tells devices this number, so the machine must publish it on the same one"
|
||||
"why": "STUN, so managed devices can find the controller through NAT"
|
||||
},
|
||||
{
|
||||
"name": "discovery",
|
||||
"port": 10001,
|
||||
"protocol": "udp",
|
||||
"from": "mesh",
|
||||
"why": "device discovery broadcasts from unadopted devices and the UniFi apps"
|
||||
"why": "device discovery \u2014 the controller finds unadopted devices on the network"
|
||||
},
|
||||
{
|
||||
"name": "discovery-l2",
|
||||
"port": 1900,
|
||||
"port": 1902,
|
||||
"protocol": "udp",
|
||||
"from": "mesh",
|
||||
"why": "make-controller-discoverable-on-L2 (SSDP); the software listens on 1900, which machines commonly have taken by another SSDP speaker"
|
||||
"why": "layer-2 (UBNT) discovery broadcasts; published on 1902, the container listens on 1900"
|
||||
},
|
||||
{
|
||||
"name": "portal-tls",
|
||||
@@ -76,15 +76,10 @@
|
||||
"path": "/var/lib/mesh/unifi",
|
||||
"mode": "0700"
|
||||
},
|
||||
{
|
||||
"id": "state",
|
||||
"type": "directory",
|
||||
"mode": "0700",
|
||||
"place": "."
|
||||
},
|
||||
{
|
||||
"id": "data",
|
||||
"type": "directory",
|
||||
"path": "/services/unifi/data",
|
||||
"mode": "0700",
|
||||
"owner": "1000:1000"
|
||||
},
|
||||
@@ -92,17 +87,17 @@
|
||||
"id": "server",
|
||||
"type": "container",
|
||||
"name": "unifi-controller",
|
||||
"image": "lscr.io/linuxserver/unifi-controller@sha256:0ae315a3a45635e443899e30e86bd507c2c48922cb27f4bc7241777885f4650e",
|
||||
"image": "lscr.io/linuxserver/unifi-controller@sha256:fcd5d8b13a77a588c79c1b49e5fc9ad08115aa3bb1a3576c589c64908a68845f",
|
||||
"ports": [
|
||||
"8443",
|
||||
"8080",
|
||||
"3478/udp",
|
||||
"10001/udp",
|
||||
"1900/udp",
|
||||
"8843",
|
||||
"8880",
|
||||
"6789",
|
||||
"5514/udp"
|
||||
"8443:8443",
|
||||
"8080:8080",
|
||||
"3478:3478/udp",
|
||||
"10001:10001/udp",
|
||||
"1902:1900/udp",
|
||||
"8843:8843",
|
||||
"8880:8880",
|
||||
"6789:6789",
|
||||
"5514:5514/udp"
|
||||
],
|
||||
"env": {
|
||||
"PUID": "1000",
|
||||
@@ -112,7 +107,7 @@
|
||||
"MEM_STARTUP": "1024"
|
||||
},
|
||||
"volumes": [
|
||||
"${dir:data}:/config"
|
||||
"/services/unifi/data:/config"
|
||||
]
|
||||
},
|
||||
{
|
||||
@@ -120,7 +115,7 @@
|
||||
"type": "file",
|
||||
"path": "/var/lib/mesh/unifi/config.json",
|
||||
"mode": "0600",
|
||||
"content": "{\n \"site\": \"default\",\n \"password\": \"${secret:controller}\"\n}\n",
|
||||
"content": "{}\n",
|
||||
"merge": "json"
|
||||
},
|
||||
{
|
||||
@@ -134,7 +129,7 @@
|
||||
],
|
||||
"env": {
|
||||
"MESH_BROKER_FILE": "/run/secrets/broker",
|
||||
"MESH_UNIFI_URL": "https://127.0.0.1:${port:8443}",
|
||||
"MESH_UNIFI_URL": "https://127.0.0.1:8443",
|
||||
"MESH_UNIFI_CONFIG_FILE": "/run/config/config.json"
|
||||
},
|
||||
"restart-on": [
|
||||
@@ -143,23 +138,8 @@
|
||||
"artifact": "runtime"
|
||||
}
|
||||
],
|
||||
"requires": [
|
||||
"route"
|
||||
],
|
||||
"contributes": {
|
||||
"route": {
|
||||
"label": "unifi",
|
||||
"endpoint": "web",
|
||||
"scheme": "https",
|
||||
"insecure": true
|
||||
}
|
||||
},
|
||||
"binds": {
|
||||
"route": "${dir:state}/route.json"
|
||||
},
|
||||
"own-secrets": {
|
||||
"broker": "/var/lib/mesh/unifi/broker",
|
||||
"controller": "/var/lib/mesh/unifi/controller"
|
||||
"broker": "/var/lib/mesh/unifi/broker"
|
||||
},
|
||||
"build": {
|
||||
"on": [
|
||||
|
||||
Reference in New Issue
Block a user