Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
0e37bb4b42 | ||
|
|
4da5c3778d | ||
|
|
ae1ee8c0b4 | ||
|
|
316db6ad03 | ||
|
|
c82a931a8c |
@@ -0,0 +1,82 @@
|
||||
# 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}}
|
||||
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 }}
|
||||
@@ -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();
|
||||
}
|
||||
});
|
||||
}
|
||||
@@ -18,6 +18,7 @@
|
||||
import Fastify from 'fastify';
|
||||
import type { HealthResponse, ProcessRequest, ProcessResponse, CallbackPayload, ConfigureRequest, ConfigureResponse } from './types.js';
|
||||
import { manifest, process as processFile, configure } from './plugin.js';
|
||||
import { startBeacon, stopBeacon } from './beacon-advertise.js';
|
||||
|
||||
const app = Fastify({ logger: true });
|
||||
let ready = false;
|
||||
@@ -69,11 +70,13 @@ 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(() => {
|
||||
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);
|
||||
|
||||
+22
-3
@@ -477,9 +477,21 @@ export function videoSubtitleKeys(produced: ProducedSubtitle[]): Record<string,
|
||||
return keys;
|
||||
}
|
||||
|
||||
/** Keys on the subtitle file's own record. */
|
||||
/**
|
||||
* Keys on the subtitle file's own record.
|
||||
*
|
||||
* `source/extract` (METADATA_KEYS.md §5) says the bytes came out of a video
|
||||
* container. The video record already implies it through `extractedSubtitles/`,
|
||||
* but that is the wrong side of the relation to store it on: a subtitle fetched
|
||||
* over the swarm by CID arrives WITHOUT its video record, so a reader holding
|
||||
* only the file would have no way to tell an extracted track from a sidecar
|
||||
* someone dropped next to the video.
|
||||
*/
|
||||
export function subtitleRecordKeys(videoCid: string, lang3: string): Record<string, string> {
|
||||
const keys: Record<string, string> = { [`videos/${videoCid}`]: 'true' };
|
||||
const keys: Record<string, string> = {
|
||||
[`videos/${videoCid}`]: 'true',
|
||||
'source/extract': 'true',
|
||||
};
|
||||
if (lang3 !== 'und') keys.subtitleLanguage = lang3;
|
||||
return keys;
|
||||
}
|
||||
@@ -499,7 +511,14 @@ export function legacySubtitleMigration(existingMeta: Record<string, unknown> |
|
||||
const langs = legacyCsvMembers(existingMeta, 'subtitleLanguages');
|
||||
if (langs) {
|
||||
deletes.push('subtitleLanguages');
|
||||
for (const l of langs.map(toLang3)) if (l !== 'und') sets[`subtitleLanguages/${l}`] = 'true';
|
||||
for (const l of langs.map(toLang3)) {
|
||||
if (l === 'und') continue;
|
||||
sets[`subtitleLanguages/${l}`] = 'true';
|
||||
// …and the union (§9 rule #7). The live write path below already
|
||||
// does this; the migration path did not, so records that only ever
|
||||
// went through it were left half-written.
|
||||
sets[`languages/${l}`] = 'true';
|
||||
}
|
||||
}
|
||||
|
||||
const subs = legacyCsvMembers(existingMeta, 'subtitles');
|
||||
|
||||
+28
-6
@@ -284,9 +284,16 @@ describe('record keys (METADATA_KEYS.md §8)', () => {
|
||||
expect(keys.every((k) => k.split('/').length === 3)).toBe(true);
|
||||
});
|
||||
|
||||
it('subtitle record carries the back-pointer and a determined language only', () => {
|
||||
expect(subtitleRecordKeys('bagvideo', 'fre')).toEqual({ 'videos/bagvideo': 'true', subtitleLanguage: 'fre' });
|
||||
expect(subtitleRecordKeys('bagvideo', 'und')).toEqual({ 'videos/bagvideo': 'true' });
|
||||
it('subtitle record carries the back-pointer, its origin, and a determined language only', () => {
|
||||
expect(subtitleRecordKeys('bagvideo', 'fre')).toEqual({
|
||||
'videos/bagvideo': 'true',
|
||||
'source/extract': 'true',
|
||||
subtitleLanguage: 'fre',
|
||||
});
|
||||
expect(subtitleRecordKeys('bagvideo', 'und')).toEqual({
|
||||
'videos/bagvideo': 'true',
|
||||
'source/extract': 'true',
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
@@ -310,7 +317,13 @@ describe('legacySubtitleMigration', () => {
|
||||
subtitles: 'cidS',
|
||||
})).toEqual({
|
||||
deletes: ['extractedSubtitles', 'subtitleLanguages', 'subtitles'],
|
||||
sets: { 'subtitleLanguages/eng': 'true', 'subtitleLanguages/fre': 'true', 'subtitles/und/cidS': 'true' },
|
||||
sets: {
|
||||
'subtitleLanguages/eng': 'true',
|
||||
'languages/eng': 'true',
|
||||
'subtitleLanguages/fre': 'true',
|
||||
'languages/fre': 'true',
|
||||
'subtitles/und/cidS': 'true',
|
||||
},
|
||||
});
|
||||
});
|
||||
|
||||
@@ -495,8 +508,17 @@ describe.skipIf(!ffmpegReady)('process — end to end against a fake core', () =
|
||||
expect(video.subtitleLanguages).toBeUndefined();
|
||||
expect(video['subtitleLanguages/und']).toBeUndefined();
|
||||
|
||||
expect(core.records.get(fre)).toEqual({ [`videos/${VIDEO_CID}`]: 'true', subtitleLanguage: 'fre' });
|
||||
expect(core.records.get(und)).toEqual({ [`videos/${VIDEO_CID}`]: 'true' });
|
||||
// `source/extract` rides on the subtitle's OWN record, so a peer that
|
||||
// fetched only the file can still tell it came out of a container.
|
||||
expect(core.records.get(fre)).toEqual({
|
||||
[`videos/${VIDEO_CID}`]: 'true',
|
||||
'source/extract': 'true',
|
||||
subtitleLanguage: 'fre',
|
||||
});
|
||||
expect(core.records.get(und)).toEqual({
|
||||
[`videos/${VIDEO_CID}`]: 'true',
|
||||
'source/extract': 'true',
|
||||
});
|
||||
|
||||
// The video PATCH carried only new keys — nothing the record already had.
|
||||
const patch = writesTo(core, VIDEO_CID).find((c) => c.method === 'PATCH')!;
|
||||
|
||||
Reference in New Issue
Block a user