From 48492023ea713028204eeaeae69818007591340d Mon Sep 17 00:00:00 2001 From: Pierre Date: Sat, 10 Jan 2026 16:17:31 +0100 Subject: [PATCH] initial commit --- .github/workflows/docker.yml | 56 ++++++++++++ .gitignore | 5 ++ Dockerfile | 29 ++++++ README.md | 65 ++++++++++++++ package.json | 26 ++++++ src/index.ts | 81 +++++++++++++++++ src/meta-core-client.ts | 73 +++++++++++++++ src/plugin.ts | 167 +++++++++++++++++++++++++++++++++++ src/types.ts | 72 +++++++++++++++ tsconfig.json | 18 ++++ 10 files changed, 592 insertions(+) create mode 100644 .github/workflows/docker.yml create mode 100644 .gitignore create mode 100644 Dockerfile create mode 100644 README.md create mode 100644 package.json create mode 100644 src/index.ts create mode 100644 src/meta-core-client.ts create mode 100644 src/plugin.ts create mode 100644 src/types.ts create mode 100644 tsconfig.json diff --git a/.github/workflows/docker.yml b/.github/workflows/docker.yml new file mode 100644 index 0000000..8cdc3e7 --- /dev/null +++ b/.github/workflows/docker.yml @@ -0,0 +1,56 @@ +name: Build and Push Docker Image + +on: + push: + branches: [main, master] + tags: ['v*'] + pull_request: + branches: [main, master] + +env: + REGISTRY: ghcr.io + IMAGE_NAME: ${{ github.repository }} + +jobs: + build: + runs-on: ubuntu-latest + permissions: + contents: read + packages: write + + steps: + - name: Checkout repository + uses: actions/checkout@v4 + + - name: Set up Docker Buildx + uses: docker/setup-buildx-action@v3 + + - name: Log in to Container Registry + if: github.event_name != 'pull_request' + uses: docker/login-action@v3 + with: + registry: ${{ env.REGISTRY }} + username: ${{ github.actor }} + password: ${{ secrets.GITHUB_TOKEN }} + + - 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 }} + cache-from: type=gha + cache-to: type=gha,mode=max diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..397b0d9 --- /dev/null +++ b/.gitignore @@ -0,0 +1,5 @@ +node_modules/ +dist/ +*.log +.env +.DS_Store diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..7c4d4cc --- /dev/null +++ b/Dockerfile @@ -0,0 +1,29 @@ +# MetaMesh Plugin: file-info +# Extracts basic file information (type, MIME, size) + +FROM node:20-slim AS builder + +WORKDIR /app + +COPY package.json tsconfig.json ./ +RUN npm install + +COPY src/ ./src/ +RUN npm run build + +# Production +FROM node:20-slim + +WORKDIR /app + +COPY package.json ./ +RUN npm install --omit=dev + +COPY --from=builder /app/dist ./dist + +EXPOSE 8080 + +HEALTHCHECK --interval=30s --timeout=5s --start-period=5s --retries=3 \ + CMD node -e "require('http').get('http://localhost:8080/health', (r) => process.exit(r.statusCode === 200 ? 0 : 1))" + +CMD ["node", "dist/index.js"] diff --git a/README.md b/README.md new file mode 100644 index 0000000..12d0e18 --- /dev/null +++ b/README.md @@ -0,0 +1,65 @@ +# MetaMesh Plugin: File Info + +A MetaMesh plugin that extracts basic file information including type, MIME type, and size. + +## Description + +This is the first plugin in the processing chain. It extracts fundamental file metadata: + +- **File type detection**: Uses magic bytes (`file-type`) with extension fallback +- **MIME type**: Detected from content or extension +- **File stats**: Size, name, extension + +## Metadata Fields + +| Field | Description | +|-------|-------------| +| `fileType` | Category: `video`, `audio`, `document`, `subtitle`, `torrent`, `archive`, `other` | +| `mimeType` | MIME type (e.g., `video/mp4`) | +| `sizeByte` | File size in bytes | +| `fileName` | Base filename | +| `extension` | File extension (lowercase) | +| `filePath` | Original file path | + +## Dependencies + +- No plugin dependencies (this runs first) + +## Configuration + +No configuration required. + +## API Endpoints + +| Endpoint | Method | Description | +|----------|--------|-------------| +| `/health` | GET | Health check | +| `/manifest` | GET | Plugin manifest | +| `/configure` | POST | Update configuration | +| `/process` | POST | Process a file | + +## Running Locally + +```bash +npm install +npm run build +npm start +``` + +## Docker + +```bash +docker build -t metamesh-plugin-file-info . +docker run -p 8080:8080 metamesh-plugin-file-info +``` + +## Environment Variables + +| Variable | Default | Description | +|----------|---------|-------------| +| `PORT` | `8080` | HTTP server port | +| `HOST` | `0.0.0.0` | HTTP server host | + +## License + +MIT diff --git a/package.json b/package.json new file mode 100644 index 0000000..57367b6 --- /dev/null +++ b/package.json @@ -0,0 +1,26 @@ +{ + "name": "@metazla/plugin-file-info", + "version": "1.0.0", + "description": "MetaMesh plugin: Extracts basic file information (type, MIME, size)", + "type": "module", + "main": "dist/index.js", + "scripts": { + "build": "tsc", + "start": "node dist/index.js", + "dev": "tsx watch src/index.ts" + }, + "dependencies": { + "fastify": "^5.0.0", + "file-type": "^19.0.0", + "mime-types": "^2.1.35" + }, + "devDependencies": { + "@types/mime-types": "^2.1.4", + "@types/node": "^20.0.0", + "tsx": "^4.0.0", + "typescript": "^5.3.0" + }, + "engines": { + "node": ">=20.0.0" + } +} diff --git a/src/index.ts b/src/index.ts new file mode 100644 index 0000000..f55ad3f --- /dev/null +++ b/src/index.ts @@ -0,0 +1,81 @@ +/** + * MetaMesh Plugin: file-info + * Entry point + */ + +import Fastify from 'fastify'; +import type { + HealthResponse, + ProcessRequest, + ProcessResponse, + CallbackPayload, + ConfigureRequest, + ConfigureResponse, +} from './types.js'; +import { manifest, process as processFile } from './plugin.js'; + +const app = Fastify({ logger: true }); +let ready = false; +let pluginConfig: Record = {}; + +// Health check +app.get('/health', async (): Promise => ({ + status: 'healthy', + ready, + version: manifest.version, +})); + +// Manifest +app.get('/manifest', async () => manifest); + +// Configure +app.post<{ Body: ConfigureRequest }>('/configure', async (request): Promise => { + try { + pluginConfig = request.body.config || {}; + console.log('[file-info] Configuration updated'); + return { status: 'ok' }; + } catch (error) { + return { status: 'error', error: error instanceof Error ? error.message : String(error) }; + } +}); + +// Process +app.post<{ Body: ProcessRequest }>('/process', async (request, reply) => { + const { taskId, cid, filePath, callbackUrl, metaCoreUrl } = request.body; + + if (!taskId || !cid || !filePath || !callbackUrl || !metaCoreUrl) { + return reply.send({ status: 'rejected', error: 'Missing required fields' } as ProcessResponse); + } + + // Process in background (don't await) + processFile(request.body, async (payload: CallbackPayload) => { + try { + await fetch(callbackUrl, { + method: 'POST', + headers: { 'Content-Type': 'application/json' }, + body: JSON.stringify(payload), + }); + } catch (error) { + console.error('[file-info] Callback error:', error); + } + }).catch(console.error); + + // Accept immediately + return reply.send({ status: 'accepted' } as ProcessResponse); +}); + +// Start server +const port = parseInt(process.env.PORT || '8080', 10); +const host = process.env.HOST || '0.0.0.0'; + +app.listen({ port, host }).then(() => { + ready = true; + console.log(`[file-info] Plugin listening on http://${host}:${port}`); +}); + +// Graceful shutdown +process.on('SIGTERM', async () => { + ready = false; + await app.close(); + process.exit(0); +}); diff --git a/src/meta-core-client.ts b/src/meta-core-client.ts new file mode 100644 index 0000000..edbe17c --- /dev/null +++ b/src/meta-core-client.ts @@ -0,0 +1,73 @@ +/** + * meta-core API Client for writing metadata + * Fails gracefully if meta-core is unavailable (logs warning, returns without throwing) + */ + +export class MetaCoreClient { + constructor(private baseUrl: string) {} + + private async safeFetch(url: string, options: RequestInit): Promise { + try { + return await fetch(url, { ...options, signal: AbortSignal.timeout(5000) }); + } catch (error) { + console.warn(`[MetaCoreClient] Warning: meta-core unavailable at ${this.baseUrl}`); + return null; + } + } + + async setProperty(hashId: string, key: string, value: string): Promise { + const response = await this.safeFetch(`${this.baseUrl}/meta/${hashId}/${key}`, { + method: 'PUT', + headers: { 'Content-Type': 'application/json' }, + body: JSON.stringify({ value }), + }); + if (response && !response.ok) { + console.warn(`[MetaCoreClient] Failed to set property: ${response.status}`); + } + } + + async getProperty(hashId: string, key: string): Promise { + 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; + } + + async mergeMetadata(hashId: string, metadata: Record): Promise { + const response = await this.safeFetch(`${this.baseUrl}/meta/${hashId}`, { + method: 'PATCH', + headers: { 'Content-Type': 'application/json' }, + body: JSON.stringify(metadata), + }); + if (response && !response.ok) { + console.warn(`[MetaCoreClient] Failed to merge metadata: ${response.status}`); + } + } + + async deleteProperty(hashId: string, key: string): Promise { + const response = await this.safeFetch(`${this.baseUrl}/meta/${hashId}/${key}`, { method: 'DELETE' }); + if (response && !response.ok && response.status !== 404) { + console.warn(`[MetaCoreClient] Failed to delete property: ${response.status}`); + } + } + + async addToSet(hashId: string, key: string, value: string): Promise { + const response = await this.safeFetch(`${this.baseUrl}/meta/${hashId}/_add/${key}`, { + method: 'POST', + headers: { 'Content-Type': 'application/json' }, + body: JSON.stringify({ value }), + }); + if (response && !response.ok) { + console.warn(`[MetaCoreClient] Failed to add to set: ${response.status}`); + } + } + + async getMetadata(hashId: string): Promise> { + 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 }; + return data.metadata ?? {}; + } +} diff --git a/src/plugin.ts b/src/plugin.ts new file mode 100644 index 0000000..ffa6560 --- /dev/null +++ b/src/plugin.ts @@ -0,0 +1,167 @@ +/** + * File Info Plugin + * + * Extracts basic file information: type, MIME type, and size. + * This is the first plugin in the processing chain. + */ + +import { stat } from 'fs/promises'; +import { basename, extname } from 'path'; +import { fileTypeFromFile } from 'file-type'; +import { lookup as mimeTypeLookup } from 'mime-types'; +import type { PluginManifest, ProcessRequest, CallbackPayload } from './types.js'; +import { MetaCoreClient } from './meta-core-client.js'; + +export const manifest: PluginManifest = { + id: 'file-info', + name: 'File Information', + version: '1.0.0', + description: 'Extracts basic file information (type, MIME, size)', + author: 'MetaMesh', + dependencies: [], + priority: 10, + color: '#607D8B', + defaultQueue: 'fast', + timeout: 30000, + schema: { + privateFilePath: { + label: 'Original File Path', + type: 'string', + readonly: true, + hint: 'Physical path on disk (used by Stremio addon and FUSE)', + }, + fileType: { + label: 'File Type', + type: 'string', + readonly: true, + }, + mimeType: { + label: 'MIME Type', + type: 'string', + readonly: true, + }, + sizeByte: { + label: 'Size (bytes)', + type: 'number', + readonly: true, + }, + fileName: { + label: 'File Name', + type: 'string', + readonly: true, + }, + extension: { + label: 'Extension', + type: 'string', + readonly: true, + }, + }, + config: {}, +}; + +// File type detection based on extension (matching @metazla/filename-tools) +// Note: Images are classified as 'document' not 'image' per original design +const EXTENSION_MAPPINGS: Record = { + // Video + 'mp4': 'video', 'mkv': 'video', 'webm': 'video', 'avi': 'video', + 'mov': 'video', 'wmv': 'video', 'flv': 'video', 'm4v': 'video', + 'mpg': 'video', 'mpeg': 'video', '3gp': 'video', '3g2': 'video', + 'f4v': 'video', 'm2ts': 'video', 'mts': 'video', 'ts': 'video', + 'vob': 'video', 'ogm': 'video', 'divx': 'video', 'xvid': 'video', + // Audio + 'mp3': 'audio', 'wav': 'audio', 'flac': 'audio', 'aac': 'audio', + 'ogg': 'audio', 'm4a': 'audio', + // Document (includes images per original design) + 'pdf': 'document', 'doc': 'document', 'docx': 'document', + 'ppt': 'document', 'pptx': 'document', 'xls': 'document', + 'xlsx': 'document', 'txt': 'document', 'rtf': 'document', + // Images are classified as 'document' per original library + 'jpg': 'document', 'jpeg': 'document', 'png': 'document', + 'gif': 'document', 'bmp': 'document', 'tif': 'document', + 'tiff': 'document', 'svg': 'document', 'webp': 'document', + // Archive + 'zip': 'archive', 'rar': 'archive', '7z': 'archive', + 'tar': 'archive', 'gz': 'archive', 'bz2': 'archive', 'xz': 'archive', + // Subtitles + 'srt': 'subtitle', 'sub': 'subtitle', 'sbv': 'subtitle', 'vtt': 'subtitle', + // Torrent + 'torrent': 'torrent', +}; + +function getFileTypeFromExtension(ext: string): string { + if (!ext) return 'undefined'; + const lowerExt = ext.toLowerCase(); + return EXTENSION_MAPPINGS[lowerExt] || 'other'; +} + +export async function process( + request: ProcessRequest, + sendCallback: (payload: CallbackPayload) => Promise +): Promise { + const startTime = Date.now(); + const metaCore = new MetaCoreClient(request.metaCoreUrl); + + try { + const { cid, filePath } = request; + + // Get file stats + const stats = await stat(filePath); + + // Get file name and extension + const fileName = basename(filePath); + const extension = extname(filePath).slice(1).toLowerCase(); + + // Determine file type + let fileType = getFileTypeFromExtension(extension); + + // Try to get MIME type from file magic bytes + let mimeType: string | undefined; + try { + const detected = await fileTypeFromFile(filePath); + if (detected) { + mimeType = detected.mime; + } + } catch { + // Fallback to extension-based lookup + } + + // Fallback MIME type lookup by extension + if (!mimeType) { + mimeType = mimeTypeLookup(extension) || 'application/octet-stream'; + } + + // Prepare metadata + const metadata = { + fileType, + mimeType, + sizeByte: String(stats.size), + fileName, + extension, + filePath, // Store the file path for other plugins/services + }; + + // Write metadata to meta-core + await metaCore.mergeMetadata(cid, metadata); + + const duration = Date.now() - startTime; + console.log(`[file-info] Processed ${fileName} in ${duration}ms`); + + await sendCallback({ + taskId: request.taskId, + status: 'completed', + duration, + metadata, // Include metadata in callback as fallback + }); + } catch (error) { + const duration = Date.now() - startTime; + const errorMessage = error instanceof Error ? error.message : String(error); + console.error(`[file-info] Error:`, errorMessage); + + await sendCallback({ + taskId: request.taskId, + status: 'failed', + duration, + error: errorMessage, + }); + } +} diff --git a/src/types.ts b/src/types.ts new file mode 100644 index 0000000..cb4a365 --- /dev/null +++ b/src/types.ts @@ -0,0 +1,72 @@ +/** + * MetaMesh Plugin Types + */ + +export interface PluginManifest { + id: string; + name: string; + version: string; + description?: string; + author?: string; + dependencies?: string[]; + schema?: Record; + config?: Record; + priority?: number; + color?: string; + defaultQueue?: 'fast' | 'background'; + timeout?: number; +} + +export interface SchemaField { + label: string; + type?: 'string' | 'number' | 'boolean' | 'select' | 'text' | 'array' | 'json' | 'cid'; + readonly?: boolean; + hint?: string; +} + +export interface ConfigField { + type: 'string' | 'number' | 'boolean' | 'select'; + label?: string; + required?: boolean; + default?: unknown; + secret?: boolean; +} + +export interface HealthResponse { + status: 'healthy' | 'unhealthy'; + ready: boolean; + version: string; +} + +export interface ProcessRequest { + taskId: string; + cid: string; + filePath: string; + callbackUrl: string; + metaCoreUrl: string; + existingMeta?: Record; +} + +export interface ProcessResponse { + status: 'accepted' | 'rejected'; + error?: string; +} + +export interface CallbackPayload { + taskId: string; + status: 'completed' | 'failed' | 'skipped'; + duration: number; + error?: string; + reason?: string; + /** Metadata to write (fallback if meta-core unavailable) */ + metadata?: Record; +} + +export interface ConfigureRequest { + config: Record; +} + +export interface ConfigureResponse { + status: 'ok' | 'error'; + error?: string; +} diff --git a/tsconfig.json b/tsconfig.json new file mode 100644 index 0000000..95ac5c2 --- /dev/null +++ b/tsconfig.json @@ -0,0 +1,18 @@ +{ + "compilerOptions": { + "target": "ES2022", + "module": "NodeNext", + "moduleResolution": "NodeNext", + "lib": ["ES2022"], + "outDir": "./dist", + "rootDir": "./src", + "strict": true, + "esModuleInterop": true, + "skipLibCheck": true, + "forceConsistentCasingInFileNames": true, + "declaration": true, + "sourceMap": true + }, + "include": ["src/**/*"], + "exclude": ["node_modules", "dist"] +}