8 Commits
Author SHA1 Message Date
Worph ed0f964c0b sign every write as an MMUR2 claim (POST /api/claims)
Build and Push Docker Image / build (push) Successful in 1m31s
2026-10-25 17:36:58 +00:00
Manielle 06310f66fa CI accepts four-part tags (v1.2.3.1) for fixes
Build and Push Docker Image / build (push) Successful in 27s
2026-10-25 14:21:55 +01:00
Worph 4d9f5c7ecc release (first build on gitea-watch / IPCR)
Build and Push Docker Image / build (push) Successful in 34s
2026-10-13 11:04:01 +00:00
Worph 6fcc474c94 gitea workflow: push to IPCR's direct host (Cloudflare 100 MB cap) [skip ci] 2026-10-13 10:03:17 +00:00
Worph 2ee2907ba9 gitea workflow: publish to IPCR (metadec.eth) instead of ghcr
Build and Push Docker Image / build (push) Successful in 40s
2026-10-12 18:31:35 +00:00
Worph e788537907 advertise over beacon v2 as metamesh.enrich/<id> so meta-sort's Plugins page can find it (Scan -> Add)
Build and Push Docker Image / build (push) Failing after 16s
2026-10-04 17:19:20 +00:00
Worph 2fd0099eee improve search and fix languages
Build and Push Docker Image / build (push) Failing after 17s
2026-09-14 22:29:58 +02:00
Worph 343e4a9815 align with metadata standard
Build and Push Docker Image / build (push) Failing after 24s
2026-09-13 15:56:14 +02:00
7 changed files with 741 additions and 70 deletions
+85
View File
@@ -0,0 +1,85 @@
# Gitea twin of .github/workflows/docker.yml. Gitea runs only .gitea/workflows/ once this
# folder exists, and GitHub never reads it.
#
# Publishes to IPCR on watch.nsl.sh instead of ghcr.io:
# push ipcr-push-85-17-246-67.nip.io/metadec.eth/<repo>:<tag> docker login as metadec.eth with the
# IPCR_PUSH_TOKEN secret (the metadec.eth namespace token from the IPCR dashboard)
# pull ipcr-watch.nsl.sh/ipns/metadec.eth/metadec.eth/<repo>:<tag> anonymous
# The push goes to ipcr-push-85-17-246-67.nip.io, the box's own address, not ipcr-push-watch.nsl.sh: Cloudflare fronts
# *.watch.nsl.sh and refuses any request over 100 MB (413), which a large image layer is.
# That host's certificate is signed by the box's private Mesh Router CA, given to buildkit from
# the IPCR_CA_PEM repo variable. docker login would make the job's Docker daemon check the
# certificate without that CA, so the login is written straight into ~/.docker/config.json.
# The runner's job image (node:22-bookworm) has no docker CLI, so the static one is
# installed first; buildx installs itself. No `type=gha` cache: the runner has none.
name: Build and Push Docker Image
on:
push:
branches: [main, master]
tags: ['v*']
pull_request:
branches: [main, master]
env:
REGISTRY: ipcr-push-85-17-246-67.nip.io
IMAGE_NAME: metadec.eth/${{ github.event.repository.name }}
jobs:
build:
runs-on: ubuntu-latest
permissions:
contents: read
packages: write
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Install Docker CLI
run: curl -fsSL https://download.docker.com/linux/static/stable/x86_64/docker-28.5.1.tgz | tar -xz -C /usr/local/bin --strip-components=1 docker/docker
- name: Trust the Mesh Router CA
run: printf '%s\n' "$IPCR_CA_PEM" > /tmp/ipcr-ca.pem
env:
IPCR_CA_PEM: ${{ vars.IPCR_CA_PEM }}
- name: Set up Docker Buildx
uses: docker/setup-buildx-action@v3
with:
version: latest
buildkitd-config-inline: |
[registry."${{ env.REGISTRY }}"]
ca = ["/tmp/ipcr-ca.pem"]
- name: Log in to IPCR
if: github.event_name != 'pull_request'
env:
IPCR_PUSH_TOKEN: ${{ secrets.IPCR_PUSH_TOKEN }}
run: |
mkdir -p ~/.docker
printf '{"auths":{"%s":{"auth":"%s"}}}\n' "$REGISTRY" "$(printf 'metadec.eth:%s' "$IPCR_PUSH_TOKEN" | base64 -w0)" > ~/.docker/config.json
- name: Extract metadata
id: meta
uses: docker/metadata-action@v5
with:
images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
tags: |
type=ref,event=branch
type=ref,event=pr
type=semver,pattern={{version}}
# A fix to release 1.2.3 is tagged v1.2.3.1: four numbers are not semver, so
# the pattern above makes no tag for it; this one does (image tag 1.2.3.1).
type=match,pattern=v(\d+\.\d+\.\d+\.\d+),group=1
type=semver,pattern={{major}}.{{minor}}
type=sha
- name: Build and push
uses: docker/build-push-action@v5
with:
context: .
push: ${{ github.event_name != 'pull_request' }}
tags: ${{ steps.meta.outputs.tags }}
labels: ${{ steps.meta.outputs.labels }}
+3
View File
@@ -42,6 +42,9 @@ jobs:
type=ref,event=branch
type=ref,event=pr
type=semver,pattern={{version}}
# A fix to release 1.2.3 is tagged v1.2.3.1: four numbers are not semver, so
# the pattern above makes no tag for it; this one does (image tag 1.2.3.1).
type=match,pattern=v(\d+\.\d+\.\d+\.\d+),group=1
type=semver,pattern={{major}}.{{minor}}
type=sha
+188
View File
@@ -0,0 +1,188 @@
/**
* Beacon v2 advertiser — makes this plugin findable by meta-sort's Plugins
* page (Scan → Add) without anyone typing its URL.
*
* Advertises one resource, cap `metamesh.enrich/<manifest id>`, on the beacon
* group (239.255.99.1:9099): unsolicited every 10 s, and unicast in reply to
* any probe whose `want` matches. Says `bye` on shutdown. It keeps no view of
* other nodes — a plugin only needs to be found. Spec:
* meta-root docs/project-architecture/beacon-v2.md.
*
* Env:
* ENABLE_UDP_DISCOVERY false/0/no/off disables
* BEACON_ADVERTISE_URL endpoints.http (default http://$HOSTNAME:$PORT)
* BEACON_BINDS the one meta-sort instance allowed to list it
* (meta-sort sets this on containers it spawns)
* BEACON_GROUP / BEACON_PORT / BEACON_INTERVAL_MS
*
* ⚠ MIRRORED FILE. Byte-identical copies live in every TypeScript
* metamesh-plugin-*; see meta-root `scripts/check-mirrors.sh`. Never fatal: a
* host that blocks multicast logs a warning and the plugin serves on.
*/
import dgram from 'dgram';
import { hostname, networkInterfaces } from 'os';
const PROTO = 'beacon';
const VERSION = 2;
interface Resource {
id: string;
caps: string[];
endpoints: Record<string, string>;
binds?: string;
}
interface NodeInfo {
name: string;
instance: string;
version?: string;
}
function envNum(key: string): number | undefined {
const n = Number(process.env[key]);
return Number.isFinite(n) && n > 0 ? n : undefined;
}
function enabled(): boolean {
const v = (process.env.ENABLE_UDP_DISCOVERY ?? '').trim().toLowerCase();
return !['false', '0', 'no', 'off'].includes(v);
}
/** IPv4 addresses of every up, non-internal interface. */
function interfaceAddresses(): string[] {
const out: string[] = [];
for (const list of Object.values(networkInterfaces())) {
for (const ni of list ?? []) {
const v4 = (ni as { family: string | number }).family === 'IPv4' || (ni as { family: string | number }).family === 4;
if (v4 && !ni.internal && ni.address) out.push(ni.address);
}
}
return out;
}
/** Same matching rules as the spec: `*`, `x/*`, optional `@contract`. */
function capMatches(pattern: string, cap: string): boolean {
if (pattern === '*') return true;
const split = (s: string): [string, string | null] => {
const i = s.lastIndexOf('@');
return i >= 0 ? [s.slice(0, i), s.slice(i + 1)] : [s, null];
};
const [pb, pc] = split(pattern);
const [cb, cc] = split(cap);
if (pc !== null && cc !== pc) return false;
if (pb.endsWith('/*')) {
const prefix = pb.slice(0, -2);
const rest = cb.startsWith(prefix) ? cb.slice(prefix.length) : '';
return rest.startsWith('/') && rest.length > 1;
}
return pb === cb;
}
let socket: dgram.Socket | null = null;
let timer: NodeJS.Timeout | null = null;
let node: NodeInfo | null = null;
let resource: Resource | null = null;
let ifaces: string[] = [];
let group = '239.255.99.1';
let udpPort = 9099;
function send(msg: object, dest?: { address: string; port: number }): void {
const s = socket;
if (!s) return;
const body = Buffer.from(JSON.stringify(msg));
if (dest) {
s.send(body, dest.port, dest.address, () => {});
return;
}
// Once per interface: the default route alone reaches one network.
for (const addr of ifaces) {
try {
s.setMulticastInterface(addr);
s.send(body, udpPort, group, () => {});
} catch (e) {
console.warn(`[beacon] send on ${addr} failed:`, e);
}
}
}
function advertise(dest?: { address: string; port: number }): void {
if (!node || !resource) return;
send({ proto: PROTO, v: VERSION, type: 'advertise', node, resources: [resource] }, dest);
}
/**
* Start advertising this plugin. Call once the HTTP server is listening, so a
* consumer that hears it can reach it. Idempotent.
*/
export function startBeacon(pluginId: string, version: string, httpPort: number): void {
if (socket || !enabled()) return;
group = process.env.BEACON_GROUP || group;
udpPort = envNum('BEACON_PORT') ?? udpPort;
const intervalMs = envNum('BEACON_INTERVAL_MS') ?? 10_000;
const instance = process.env.HOSTNAME || hostname();
const url = (process.env.BEACON_ADVERTISE_URL || `http://${instance}:${httpPort}`).replace(/\/+$/, '');
const binds = (process.env.BEACON_BINDS || '').trim();
node = { name: `metamesh-plugin-${pluginId}`, instance, ...(version ? { version } : {}) };
resource = {
id: pluginId,
caps: [`metamesh.enrich/${pluginId}`],
endpoints: { http: url, manifest: '/manifest' },
...(binds ? { binds } : {}),
};
const s = dgram.createSocket({ type: 'udp4', reuseAddr: true });
socket = s;
s.on('error', (err) => console.warn('[beacon] socket error:', err.message));
s.on('message', (buf, rinfo) => {
let m: { proto?: string; v?: number; type?: string; from?: string; want?: string[] };
try {
m = JSON.parse(buf.toString('utf8'));
} catch {
return; // foreign traffic on the shared group
}
if (m?.proto !== PROTO || m.v !== VERSION || m.type !== 'probe' || m.from === instance) return;
const want = Array.isArray(m.want) ? m.want : [];
if (want.length === 0 || resource!.caps.some((c) => want.some((p) => capMatches(p, c)))) {
advertise({ address: rinfo.address, port: rinfo.port });
}
});
s.bind(udpPort, '0.0.0.0', () => {
try {
s.setMulticastTTL(1);
} catch {
/* best effort */
}
ifaces = interfaceAddresses();
for (const addr of ifaces) {
try {
s.addMembership(group, addr);
} catch (e) {
console.warn(`[beacon] join ${group} on ${addr} failed:`, e);
}
}
console.log(`[beacon] advertising metamesh.enrich/${pluginId} at ${url} on ${group}:${udpPort}`);
advertise();
timer = setInterval(() => advertise(), intervalMs);
timer.unref?.();
});
}
/** Say `bye` so consumers drop this plugin at once. */
export async function stopBeacon(): Promise<void> {
if (!socket || !node) return;
if (timer) clearInterval(timer);
send({ proto: PROTO, v: VERSION, type: 'bye', node });
// Let the bye datagrams leave before the socket closes under them.
await new Promise((r) => setTimeout(r, 50));
const s = socket;
socket = null;
await new Promise<void>((resolve) => {
try {
s.close(() => resolve());
} catch {
resolve();
}
});
}
+3 -2
View File
@@ -24,6 +24,7 @@
import Fastify from 'fastify';
import type { HealthResponse, ProcessRequest, ProcessResponse, CallbackPayload, ConfigureRequest, ConfigureResponse } from './types.js';
import { manifest, process as processFile } from './plugin.js';
import { startBeacon, stopBeacon } from './beacon-advertise.js';
const app = Fastify({ logger: true });
let ready = false;
@@ -47,5 +48,5 @@ app.post<{ Body: ProcessRequest }>('/process', async (request, reply) => {
});
const port = parseInt(process.env.PORT || '8080', 10);
app.listen({ port, host: '0.0.0.0' }).then(() => { ready = true; console.log(`[${manifest.id}] Listening on port ${port}`); });
process.on('SIGTERM', async () => { ready = false; await app.close(); process.exit(0); });
app.listen({ port, host: '0.0.0.0' }).then(() => { startBeacon(manifest.id, manifest.version, port); ready = true; console.log(`[${manifest.id}] Listening on port ${port}`); });
process.on('SIGTERM', async () => { await stopBeacon(); ready = false; await app.close(); process.exit(0); });
+356 -42
View File
@@ -1,66 +1,380 @@
/**
* meta-core API Client for writing metadata
* Fails gracefully if meta-core is unavailable (returns without throwing)
* meta-core client: signed claim writes (MMUR2) + plain reads.
*
* MIRRORED byte-for-byte across every `metamesh-plugin-*` TypeScript plugin and
* meta-sort-core (`src/kv/meta-core-client.ts`) — guarded by
* `scripts/check-mirrors.sh`. Edit one copy, then copy it everywhere.
*
* Every write is a vote signed by THIS container's key
* (docs/implementation/metacore-claims-model.md §3, §9):
*
* bytes_to_sign = "MMUR2\n" || canonical CBOR [cid, uid, key, value, ts]
* sig = ECDSA-secp256k1(SHA-256(bytes)), compact r||s, low-S
*
* and is posted to `POST {baseUrl}/api/claims` — meta-core directly, or
* meta-sort's pass-through relay when the plugin runs under meta-sort. The
* encoding is pinned by meta-core's `internal/claim/testdata/claim-vectors.json`
* (vendored as `test/claim-vectors.json`).
*
* Key: `METAMESH_SIGNING_KEY` (64 hex chars) or `METAMESH_SIGNING_KEY_FILE`
* (read; generated and written 0600 if missing). With neither, writes are
* refused (logged, return false) — no silent throwaway identities.
*
* Fails gracefully if meta-core is unavailable: logs and returns, never throws.
*/
import * as crypto from 'crypto';
import * as fs from 'fs';
import * as path from 'path';
// ---------------------------------------------------------------- encoding --
const DOMAIN = Buffer.from('MMUR2\n', 'utf8');
const B58 = '123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz';
const N = BigInt('0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFEBAAEDCE6AF48A03BBFD25E8CD0364141');
const HALF_N = N >> 1n;
/** A claim value: text (public), bytes (private envelope) or null (retraction). */
export type ClaimValue = string | Uint8Array | null;
export interface SignedClaim {
cid: string;
uid: string;
key: string;
value: ClaimValue;
ts: number;
sig: Uint8Array;
}
function head(major: number, n: number | bigint): Buffer {
const m = major << 5;
const v = BigInt(n);
if (v < 24n) return Buffer.from([m | Number(v)]);
if (v <= 0xffn) return Buffer.from([m | 24, Number(v)]);
if (v <= 0xffffn) {
const b = Buffer.alloc(3);
b[0] = m | 25;
b.writeUInt16BE(Number(v), 1);
return b;
}
if (v <= 0xffffffffn) {
const b = Buffer.alloc(5);
b[0] = m | 26;
b.writeUInt32BE(Number(v), 1);
return b;
}
const b = Buffer.alloc(9);
b[0] = m | 27;
b.writeBigUInt64BE(v, 1);
return b;
}
function text(s: string): Buffer {
const raw = Buffer.from(s, 'utf8');
return Buffer.concat([head(3, raw.length), raw]);
}
/** The exact bytes an MMUR2 signature covers. */
export function signedBytes(cid: string, uid: string, key: string, value: ClaimValue, ts: number): Buffer {
let v: Buffer;
if (value === null) v = Buffer.from([0xf6]);
else if (typeof value === 'string') v = text(value);
else v = Buffer.concat([head(2, value.length), Buffer.from(value)]);
return Buffer.concat([DOMAIN, head(4, 5), text(cid), text(uid), text(key), v, head(0, ts)]);
}
function base58Encode(bytes: Uint8Array): string {
let n = BigInt('0x' + (Buffer.from(bytes).toString('hex') || '0'));
let out = '';
while (n > 0n) {
out = B58[Number(n % 58n)] + out;
n /= 58n;
}
for (const b of bytes) {
if (b !== 0) break;
out = '1' + out;
}
return out;
}
function base58Decode(s: string): Buffer {
let n = 0n;
for (const ch of s) {
const i = B58.indexOf(ch);
if (i < 0) throw new Error(`invalid base58 character ${ch}`);
n = n * 58n + BigInt(i);
}
let hex = n === 0n ? '' : n.toString(16);
if (hex.length % 2) hex = '0' + hex;
let zeros = 0;
while (zeros < s.length && s[zeros] === '1') zeros++;
return Buffer.concat([Buffer.alloc(zeros), Buffer.from(hex, 'hex')]);
}
function b64url(b: Buffer): string {
return b.toString('base64url');
}
function publicKeyFromCompressed(compressed: Buffer): crypto.KeyObject {
const full = crypto.ECDH.convertKey(compressed, 'secp256k1', undefined, undefined, 'uncompressed') as Buffer;
return crypto.createPublicKey({
key: { kty: 'EC', crv: 'secp256k1', x: b64url(full.subarray(1, 33)), y: b64url(full.subarray(33, 65)) },
format: 'jwk',
});
}
/** Rewrite a compact signature to its low-S form (MMUR2 refuses high-S). */
function lowS(sig: Buffer): Buffer {
const s = BigInt('0x' + sig.subarray(32).toString('hex'));
if (s <= HALF_N) return sig;
const fixed = Buffer.from((N - s).toString(16).padStart(64, '0'), 'hex');
return Buffer.concat([sig.subarray(0, 32), fixed]);
}
/** True when the claim's signature is a valid low-S signature by its uid. */
export function verifyClaim(c: SignedClaim): boolean {
try {
const sig = Buffer.from(c.sig);
if (sig.length !== 64) return false;
if (BigInt('0x' + sig.subarray(32).toString('hex')) > HALF_N) return false;
if (!c.uid.startsWith('z')) return false;
const pub = base58Decode(c.uid.slice(1));
if (pub.length !== 33) return false;
return crypto.verify(
'sha256',
signedBytes(c.cid, c.uid, c.key, c.value, c.ts),
{ key: publicKeyFromCompressed(pub), dsaEncoding: 'ieee-p1363' },
sig,
);
} catch {
return false;
}
}
// ----------------------------------------------------------------- signer --
export class ClaimSigner {
readonly uid: string;
private readonly key: crypto.KeyObject;
private lastTs = 0;
constructor(privateKeyHex: string) {
const hex = privateKeyHex.trim().replace(/^0x/i, '');
if (!/^[0-9a-fA-F]{64}$/.test(hex)) throw new Error('signing key must be 64 hex characters');
const d = Buffer.from(hex, 'hex');
const ecdh = crypto.createECDH('secp256k1');
ecdh.setPrivateKey(d);
const full = ecdh.getPublicKey(null, 'uncompressed');
this.uid = 'z' + base58Encode(ecdh.getPublicKey(null, 'compressed'));
this.key = crypto.createPrivateKey({
key: {
kty: 'EC', crv: 'secp256k1', d: b64url(d),
x: b64url(full.subarray(1, 33)), y: b64url(full.subarray(33, 65)),
},
format: 'jwk',
});
}
/** Milliseconds, strictly increasing within this process (ts is the version). */
nextTs(): number {
this.lastTs = Math.max(Date.now(), this.lastTs + 1);
return this.lastTs;
}
sign(cid: string, key: string, value: ClaimValue, ts: number = this.nextTs()): SignedClaim {
const raw = crypto.sign('sha256', signedBytes(cid, this.uid, key, value, ts), {
key: this.key,
dsaEncoding: 'ieee-p1363',
});
return { cid, uid: this.uid, key, value, ts, sig: lowS(raw) };
}
}
let cachedSigner: ClaimSigner | null | undefined;
/**
* The process signer from the environment, or null when no key is configured.
* Read lazily on first write; `resetSignerForTests()` forgets it.
*/
export function loadSigner(): ClaimSigner | null {
if (cachedSigner !== undefined) return cachedSigner;
const inline = process.env.METAMESH_SIGNING_KEY;
const file = process.env.METAMESH_SIGNING_KEY_FILE;
try {
if (inline) {
cachedSigner = new ClaimSigner(inline);
} else if (file) {
if (!fs.existsSync(file)) {
fs.mkdirSync(path.dirname(file), { recursive: true });
fs.writeFileSync(file, crypto.randomBytes(32).toString('hex') + '\n', { mode: 0o600 });
}
cachedSigner = new ClaimSigner(fs.readFileSync(file, 'utf8'));
} else {
cachedSigner = null;
}
} catch (error) {
console.warn(`[MetaCoreClient] Signing key unusable: ${error instanceof Error ? error.message : String(error)}`);
cachedSigner = null;
}
if (cachedSigner) console.log(`[MetaCoreClient] Signing claims as ${cachedSigner.uid}`);
else console.warn('[MetaCoreClient] No METAMESH_SIGNING_KEY / METAMESH_SIGNING_KEY_FILE — metadata writes are refused');
return cachedSigner;
}
export function resetSignerForTests(): void {
cachedSigner = undefined;
}
/** The §3.4 JSON form. */
export function claimToJSON(c: SignedClaim): Record<string, unknown> {
let value: unknown = null;
if (typeof c.value === 'string') value = c.value;
else if (c.value) value = { b64: Buffer.from(c.value).toString('base64') };
return { cid: c.cid, uid: c.uid, key: c.key, value, ts: c.ts, sig: Buffer.from(c.sig).toString('base64') };
}
// ----------------------------------------------------------------- client --
export class MetaCoreClient {
constructor(private baseUrl: string) {}
private async safeFetch(url: string, options: RequestInit): Promise<Response | null> {
try {
return await fetch(url, { ...options, signal: AbortSignal.timeout(5000) });
} catch {
// meta-core unavailable - fail silently (expected in standalone/test mode)
return await fetch(url, { ...options, signal: AbortSignal.timeout(10000) });
} catch (error) {
console.warn(`[MetaCoreClient] Warning: meta-core unavailable at ${this.baseUrl}: ${error instanceof Error ? error.message : String(error)}`);
return null;
}
}
async setProperty(hashId: string, key: string, value: string): Promise<void> {
const response = await this.safeFetch(`${this.baseUrl}/meta/${hashId}/${key}`, {
method: 'PUT',
/**
* Sign and post claims about `cid`. True when every claim was accepted (or
* was already stored: `unchanged` / `stale` are not failures).
*/
async writeClaims(cid: string, values: Array<[string, ClaimValue]>): Promise<boolean> {
if (values.length === 0) return true;
const signer = loadSigner();
if (!signer) return false;
const claims = values.map(([key, value]) => claimToJSON(signer.sign(cid, key, value)));
const response = await this.safeFetch(`${this.baseUrl}/api/claims`, {
method: 'POST',
headers: { 'Content-Type': 'application/json' },
body: JSON.stringify({ value }),
body: JSON.stringify(claims),
});
// Silently ignore errors (expected in standalone/test mode)
if (!response) return false;
if (!response.ok) {
console.warn(`[MetaCoreClient] Claims for ${cid} rejected: ${response.status}`);
return false;
}
const statuses = await response.json().catch(() => null) as Array<{ status?: string; reason?: string }> | null;
const bad = (statuses ?? []).filter((s) => s.status === 'bad_signature' || s.status === 'bad_request');
if (bad.length > 0) {
console.warn(`[MetaCoreClient] ${bad.length} claim(s) for ${cid} refused: ${bad[0].status} ${bad[0].reason ?? ''}`);
return false;
}
return true;
}
/** One text claim. */
async setProperty(hashId: string, key: string, value: string): Promise<boolean> {
return this.writeClaims(hashId, [[key, String(value)]]);
}
/** One text claim per entry, in a single batch. */
async mergeMetadata(hashId: string, metadata: Record<string, string>): Promise<boolean> {
return this.writeClaims(hashId, Object.entries(metadata).map(([k, v]) => [k, String(v)]));
}
/**
* Retract this signer's own vote for `key`. Other signers' votes for the
* same key are untouched (there are no negative votes).
*/
async deleteProperty(hashId: string, key: string): Promise<boolean> {
return this.writeClaims(hashId, [[key, null]]);
}
/**
* Append a member to a legacy csv-set field (`genres`, `studio`, `tags`,
* `announceList`, …) — the comma-joined shape readers still parse (the
* METADATA_KEYS §14.12 key-set migration is out of scope for phase 1).
*
* Under claims a signer owns only its OWN vote, so this reads this
* signer's current claim for (cid, key) from
* `GET /api/meta/{cid}/claims?key=<key>` (other signers' claims are
* ignored), adds the member if absent and signs the new full value as one
* text claim. Members are kept raw (no escaping), same as the old
* meta-sort `_add` proxy. A member already present writes nothing.
*/
async addToSet(hashId: string, key: string, value: string): Promise<boolean> {
const member = String(value);
if (!member) return true;
const signer = loadSigner();
if (!signer) return false;
const current = await this.ownClaimValue(hashId, key, signer.uid);
if (current === undefined) return false; // could not read: never clobber our own set
const members = current ? current.split(',').map((v) => v.trim()).filter(Boolean) : [];
if (members.includes(member)) return true;
return this.writeClaims(hashId, [[key, [...members, member].join(',')]]);
}
/**
* This signer's newest text claim for (cid, key): the value, `null` when it
* has none, `undefined` when the claims could not be read.
*/
private async ownClaimValue(cid: string, key: string, uid: string): Promise<string | null | undefined> {
const url = `${this.baseUrl}/api/meta/${encodeURIComponent(cid)}/claims?key=${encodeURIComponent(key)}`;
const response = await this.safeFetch(url, { method: 'GET' });
if (!response) return undefined;
if (response.status === 404) return null;
if (!response.ok) {
console.warn(`[MetaCoreClient] Failed to read claims for ${cid}/${key}: ${response.status}`);
return undefined;
}
const body = await response.json().catch(() => null) as unknown;
const list = (Array.isArray(body) ? body : (body as { claims?: unknown })?.claims) as
Array<{ uid?: string; key?: string; value?: unknown; ts?: number }> | undefined;
let best: { value: string; ts: number } | null = null;
for (const c of Array.isArray(list) ? list : []) {
if (c.uid !== uid || c.key !== key || typeof c.value !== 'string') continue;
const ts = Number(c.ts) || 0;
if (!best || ts > best.ts) best = { value: c.value, ts };
}
return best ? best.value : null;
}
async getProperty(hashId: string, key: string): Promise<string | null> {
const response = await this.safeFetch(`${this.baseUrl}/meta/${hashId}/${key}`, { method: 'GET' });
if (!response || response.status === 404) return null;
if (!response.ok) return null;
const data = await response.json() as { value?: string };
return data.value ?? null;
if (!response || !response.ok) return null;
const data = await response.json() as { value?: unknown };
return data.value === undefined || data.value === null ? null : String(data.value);
}
/** PATCH (merge). Resolves `true` only when the write was accepted. */
async mergeMetadata(hashId: string, metadata: Record<string, string>): Promise<boolean> {
const response = await this.safeFetch(`${this.baseUrl}/meta/${hashId}`, {
method: 'PATCH',
headers: { 'Content-Type': 'application/json' },
body: JSON.stringify(metadata),
});
return !!response && response.ok;
}
async deleteProperty(hashId: string, key: string): Promise<void> {
const response = await this.safeFetch(`${this.baseUrl}/meta/${hashId}/${key}`, { method: 'DELETE' });
// Silently ignore errors (expected in standalone/test mode)
}
async addToSet(hashId: string, key: string, value: string): Promise<void> {
const response = await this.safeFetch(`${this.baseUrl}/meta/${hashId}/_add/${key}`, {
method: 'POST',
headers: { 'Content-Type': 'application/json' },
body: JSON.stringify({ value }),
});
// Silently ignore errors (expected in standalone/test mode)
}
async getMetadata(hashId: string): Promise<Record<string, string>> {
/**
* Whole merged record, in whatever form the endpoint serves (meta-sort's
* /meta is nested, meta-core's is flat) — callers flatten. `null` when the
* call itself failed, `{}` when the record does not exist.
*/
async getMetadata(hashId: string): Promise<Record<string, unknown> | null> {
const response = await this.safeFetch(`${this.baseUrl}/meta/${hashId}`, { method: 'GET' });
if (!response || response.status === 404) return {};
if (!response.ok) return {};
const data = await response.json() as { metadata?: Record<string, string> };
if (!response) return null;
if (response.status === 404) return {};
if (!response.ok) return null;
const data = await response.json() as { metadata?: Record<string, unknown> };
return data.metadata ?? {};
}
/**
* Compute the CID of a file under FILES_PATH via meta-core's `POST /file/cid`.
* @param filePath - path relative to FILES_PATH (e.g. "poster/Movie (2024)_poster.jpg")
*/
async computeFileCID(filePath: string): Promise<string | null> {
const response = await this.safeFetch(`${this.baseUrl}/file/cid`, {
method: 'POST',
headers: { 'Content-Type': 'application/json' },
body: JSON.stringify({ path: filePath }),
});
if (!response || !response.ok) return null;
const data = await response.json().catch(() => null) as { cid?: string } | null;
return data?.cid ?? null;
}
}
+40 -15
View File
@@ -21,11 +21,17 @@
* Matroska stream tags already carry. A `fra` member would be dropped by a
* `languages:fre` filter.
*
* ⚠ Audio only. Consumers read `languages/*` as the AUDIO-language set
* (meta-watch `cards::audio_languages`); subtitle-track languages belong to
* `subtitleLanguages/*` (subtitle-extractor). Title keys are not a source
* either: `titles/<lang>` names the language of a TITLE (tmdb files
* `originalTitle` under `original_language`), not of the file's audio.
* ⚠ Audio only as a SOURCE — but it writes two keys, not one. This plugin reads
* audio tracks, so the codes it finds are audio languages and land in
* `audioLanguages/<lang3>`; every one of them is ALSO written to
* `languages/<lang3>`, the union that queries filter on (METADATA_KEYS §9,
* rule #7 — "a union field is written, never computed"). Nothing reconciles the
* two after the fact, so a record with the split set and the union unset is
* invisible to every language filter on every peer. Subtitle-track languages
* belong to `subtitleLanguages/*` (subtitle-extractor), which owes the union
* member for the same reason. Title keys are not a source either:
* `titles/<lang>` names the language of a TITLE (tmdb files `originalTitle`
* under `original_language`), not of the file's audio.
*
* ⚠ No `titles/*` write. The old `titles/{firstAudioLang || 'eng'}` =
* `originalTitle` guess overwrote better identity (tmdb, jellyfin-nfo,
@@ -41,8 +47,8 @@ import { MetaCoreClient } from './meta-core-client.js';
export const manifest: PluginManifest = {
id: 'language',
name: 'Language Aggregator',
version: '1.1.0',
description: 'Adds audio-track languages to the languages/<lang3> key-set',
version: '1.2.0',
description: 'Adds audio-track languages to the audioLanguages/<lang3> and languages/<lang3> key-sets',
author: 'MetaMesh',
dependencies: ['ffmpeg'],
priority: 40,
@@ -50,6 +56,7 @@ export const manifest: PluginManifest = {
defaultQueue: 'fast',
timeout: 30000,
schema: {
audioLanguages: { label: 'Audio languages', type: 'array', readonly: true },
languages: { label: 'Languages', type: 'array', readonly: true },
},
config: {},
@@ -170,23 +177,41 @@ export function audioLanguagesFromMeta(existingMeta: Record<string, unknown> | u
}
/**
* Whether the record already carries `languages/<code>`, in either shape: the
* flat key, or the nested `languages: { <code>: ... }` object meta-sort's
* reconstructed document holds.
* Whether the record already carries `<field>/<code>`, in either shape: the flat
* key, or the nested `<field>: { <code>: ... }` object meta-sort's reconstructed
* document holds.
*/
function hasMember(existingMeta: Record<string, unknown> | undefined, code: string): boolean {
function hasMember(
existingMeta: Record<string, unknown> | undefined,
field: string,
code: string,
): boolean {
if (!existingMeta) return false;
if (existingMeta[`languages/${code}`] !== undefined) return true;
const nested = existingMeta['languages'];
if (existingMeta[`${field}/${code}`] !== undefined) return true;
const nested = existingMeta[field];
return !!nested && typeof nested === 'object' && !Array.isArray(nested)
&& (nested as Record<string, unknown>)[code] !== undefined;
}
/** The `languages/<code>` members to add — never one the record already has. */
/**
* The members to add — never one the record already has.
*
* Each audio code is written TWICE: once to `audioLanguages/<code>` (what this
* plugin actually observed — a spoken track) and once to `languages/<code>`
* (the union every query filters on). METADATA_KEYS §9 rule #7 makes the second
* write mandatory, not a convenience: the union is stored, never computed, and
* a query cannot ask for `audioLanguages OR subtitleLanguages` — the gateway
* wire ANDs across keys, so an OR of the splits would return strictly less.
*/
export function languageWrites(existingMeta: Record<string, unknown> | undefined): Record<string, string> {
const writes: Record<string, string> = {};
for (const code of audioLanguagesFromMeta(existingMeta)) {
if (!hasMember(existingMeta, code)) writes[`languages/${code}`] = 'true';
if (!hasMember(existingMeta, 'audioLanguages', code)) {
writes[`audioLanguages/${code}`] = 'true';
}
if (!hasMember(existingMeta, 'languages', code)) {
writes[`languages/${code}`] = 'true';
}
}
return writes;
}
+66 -11
View File
@@ -164,18 +164,47 @@ describe('audioLanguagesFromMeta', () => {
});
describe('languageWrites', () => {
it('skips members already present in the flat or nested form', () => {
expect(languageWrites(nestedDoc({ 'languages/jpn': 'true' }))).toEqual({ 'languages/eng': 'true' });
expect(languageWrites(nestedDoc({ languages: { eng: 'true', jpn: true } }))).toEqual({});
it('writes each audio code to BOTH the split and the union (METADATA_KEYS §9 rule #7)', () => {
expect(languageWrites(nestedDoc())).toEqual({
'audioLanguages/jpn': 'true',
'languages/jpn': 'true',
'audioLanguages/eng': 'true',
'languages/eng': 'true',
});
});
it('skips members already present in the flat or nested form, per field', () => {
// The union is already there; the split is not — the record still owes
// the split, and vice versa. The two are tracked independently.
expect(languageWrites(nestedDoc({ 'languages/jpn': 'true' }))).toEqual({
'audioLanguages/jpn': 'true',
'audioLanguages/eng': 'true',
'languages/eng': 'true',
});
expect(languageWrites(nestedDoc({ languages: { eng: 'true', jpn: true } }))).toEqual({
'audioLanguages/jpn': 'true',
'audioLanguages/eng': 'true',
});
expect(
languageWrites(nestedDoc({ audioLanguages: { eng: 'true', jpn: 'true' }, languages: { eng: 'true', jpn: 'true' } })),
).toEqual({});
});
});
describe('process', () => {
it('writes the audio languages/* key-set from the nested payload in one merge', async () => {
it('writes the audio split AND the union from the nested payload in one merge', async () => {
const { callback, writer } = await run(nestedDoc());
expect(callback?.status).toBe('completed');
expect(writer.calls).toEqual([
{ hashId: 'cid-1', metadata: { 'languages/jpn': 'true', 'languages/eng': 'true' } },
{
hashId: 'cid-1',
metadata: {
'audioLanguages/jpn': 'true',
'languages/jpn': 'true',
'audioLanguages/eng': 'true',
'languages/eng': 'true',
},
},
]);
});
@@ -183,19 +212,32 @@ describe('process', () => {
const flat = Object.fromEntries(REAL_STREAMS.map((s, i) => [`stream/${i}`, s]));
const { callback, writer } = await run(flat);
expect(callback?.status).toBe('completed');
expect(writer.calls[0].metadata).toEqual({ 'languages/jpn': 'true', 'languages/eng': 'true' });
expect(writer.calls[0].metadata).toEqual({
'audioLanguages/jpn': 'true',
'languages/jpn': 'true',
'audioLanguages/eng': 'true',
'languages/eng': 'true',
});
});
it('never writes titles/* or any non-languages key, even with originalTitle and title keys', async () => {
const { writer } = await run(nestedDoc({ 'titles/eng': 'Better Title', titles: { jpn: '番組' } }));
it('every split member has a matching union member — the record is never left half-written', async () => {
const { writer } = await run(nestedDoc());
const keys = writer.calls.flatMap((c) => Object.keys(c.metadata));
for (const k of keys.filter((k) => k.startsWith('audioLanguages/'))) {
expect(keys).toContain(`languages/${k.slice('audioLanguages/'.length)}`);
}
});
it('never writes titles/* or any non-language key, even with originalTitle and title keys', async () => {
const { writer } = await run(nestedDoc({ 'titles/eng/Better Title': 'true', titles: { jpn: { '番組': 'true' } } }));
const keys = writer.calls.flatMap((c) => Object.keys(c.metadata));
expect(keys.length).toBeGreaterThan(0);
expect(keys.every((k) => k.startsWith('languages/'))).toBe(true);
expect(keys.every((k) => k.startsWith('languages/') || k.startsWith('audioLanguages/'))).toBe(true);
expect(keys.some((k) => k.startsWith('titles'))).toBe(false);
});
it('does not derive languages from title keys', async () => {
const { callback, writer } = await run({ originalTitle: 'x', 'titles/jpn': 'y', 'titles/jpl': 'z' });
const { callback, writer } = await run({ originalTitle: 'x', 'titles/jpn/y': 'true', 'titles/jpl/z': 'true' });
expect(callback?.status).toBe('completed');
expect(writer.calls).toEqual([]);
});
@@ -209,10 +251,23 @@ describe('process', () => {
});
it('is idempotent: a re-run over a record that already has the members writes nothing', async () => {
const { writer } = await run(nestedDoc({ 'languages/jpn': 'true', 'languages/eng': 'true' }));
const { writer } = await run(nestedDoc({
'audioLanguages/jpn': 'true', 'audioLanguages/eng': 'true',
'languages/jpn': 'true', 'languages/eng': 'true',
}));
expect(writer.calls).toEqual([]);
});
it('backfills the union on a record written before the split existed', async () => {
// Pre-1.2.0 records carry only `languages/*`. A re-run must add the
// split without disturbing the union that is already correct.
const { writer } = await run(nestedDoc({ 'languages/jpn': 'true', 'languages/eng': 'true' }));
expect(writer.calls[0].metadata).toEqual({
'audioLanguages/jpn': 'true',
'audioLanguages/eng': 'true',
});
});
it('fails the task when the write is rejected', async () => {
const { callback } = await run(nestedDoc(), new RecordingWriter(false));
expect(callback?.status).toBe('failed');