@constructive-io/knative-job-service 0.8.1 → 0.8.2

package/README.md

@@ -1 +1,59 @@
 # knative-job-service
+
+---
+
+## Education and Tutorials
+
+ 1. 🚀 [Quickstart: Getting Up and Running](https://constructive.io/learn/quickstart)
+Get started with modular databases in minutes. Install prerequisites and deploy your first module.
+
+ 2. 📦 [Modular PostgreSQL Development with Database Packages](https://constructive.io/learn/modular-postgres)
+Learn to organize PostgreSQL projects with pgpm workspaces and reusable database modules.
+
+ 3. ✏️ [Authoring Database Changes](https://constructive.io/learn/authoring-database-changes)
+Master the workflow for adding, organizing, and managing database changes with pgpm.
+
+ 4. 🧪 [End-to-End PostgreSQL Testing with TypeScript](https://constructive.io/learn/e2e-postgres-testing)
+Master end-to-end PostgreSQL testing with ephemeral databases, RLS testing, and CI/CD automation.
+
+ 5. ⚡ [Supabase Testing](https://constructive.io/learn/supabase)
+Use TypeScript-first tools to test Supabase projects with realistic RLS, policies, and auth contexts.
+
+ 6. 💧 [Drizzle ORM Testing](https://constructive.io/learn/drizzle-testing)
+Run full-stack tests with Drizzle ORM, including database setup, teardown, and RLS enforcement.
+
+ 7. 🔧 [Troubleshooting](https://constructive.io/learn/troubleshooting)
+Common issues and solutions for pgpm, PostgreSQL, and testing.
+
+## Related Constructive Tooling
+
+### 📦 Package Management
+
+* [pgpm](https://github.com/constructive-io/constructive/tree/main/pgpm/pgpm): **🖥️ PostgreSQL Package Manager** for modular Postgres development. Works with database workspaces, scaffolding, migrations, seeding, and installing database packages.
+
+### 🧪 Testing
+
+* [pgsql-test](https://github.com/constructive-io/constructive/tree/main/postgres/pgsql-test): **📊 Isolated testing environments** with per-test transaction rollbacks—ideal for integration tests, complex migrations, and RLS simulation.
+* [pgsql-seed](https://github.com/constructive-io/constructive/tree/main/postgres/pgsql-seed): **🌱 PostgreSQL seeding utilities** for CSV, JSON, SQL data loading, and pgpm deployment.
+* [supabase-test](https://github.com/constructive-io/constructive/tree/main/postgres/supabase-test): **🧪 Supabase-native test harness** preconfigured for the local Supabase stack—per-test rollbacks, JWT/role context helpers, and CI/GitHub Actions ready.
+* [graphile-test](https://github.com/constructive-io/constructive/tree/main/graphile/graphile-test): **🔐 Authentication mocking** for Graphile-focused test helpers and emulating row-level security contexts.
+* [pg-query-context](https://github.com/constructive-io/constructive/tree/main/postgres/pg-query-context): **🔒 Session context injection** to add session-local context (e.g., `SET LOCAL`) into queries—ideal for setting `role`, `jwt.claims`, and other session settings.
+
+### 🧠 Parsing & AST
+
+* [pgsql-parser](https://www.npmjs.com/package/pgsql-parser): **🔄 SQL conversion engine** that interprets and converts PostgreSQL syntax.
+* [libpg-query-node](https://www.npmjs.com/package/libpg-query): **🌉 Node.js bindings** for `libpg_query`, converting SQL into parse trees.
+* [pg-proto-parser](https://www.npmjs.com/package/pg-proto-parser): **📦 Protobuf parser** for parsing PostgreSQL Protocol Buffers definitions to generate TypeScript interfaces, utility functions, and JSON mappings for enums.
+* [@pgsql/enums](https://www.npmjs.com/package/@pgsql/enums): **🏷️ TypeScript enums** for PostgreSQL AST for safe and ergonomic parsing logic.
+* [@pgsql/types](https://www.npmjs.com/package/@pgsql/types): **📝 Type definitions** for PostgreSQL AST nodes in TypeScript.
+* [@pgsql/utils](https://www.npmjs.com/package/@pgsql/utils): **🛠️ AST utilities** for constructing and transforming PostgreSQL syntax trees.
+
+## Credits
+
+**🛠 Built by the [Constructive](https://constructive.io) team — creators of modular Postgres tooling for secure, composable backends. If you like our work, contribute on [GitHub](https://github.com/constructive-io).**
+
+## Disclaimer
+
+AS DESCRIBED IN THE LICENSES, THE SOFTWARE IS PROVIDED "AS IS", AT YOUR OWN RISK, AND WITHOUT WARRANTIES OF ANY KIND.
+
+No developer or entity involved in creating this software will be liable for any claims or damages whatsoever associated with your use, inability to use, or your interaction with other users of the code, including any direct, indirect, incidental, special, exemplary, punitive or consequential damages, or loss of profits, cryptocurrencies, tokens, or anything else of value.

package/esm/index.js

@@ -0,0 +1,345 @@
+import jobServerFactory from '@constructive-io/knative-job-server';
+import Worker from '@constructive-io/knative-job-worker';
+import Scheduler from '@constructive-io/job-scheduler';
+import poolManager from '@constructive-io/job-pg';
+import { getJobPgConfig, getJobSchema, getJobSupported, getJobsCallbackPort, getSchedulerHostname, getWorkerHostname } from '@constructive-io/job-utils';
+import { parseEnvBoolean } from '@pgpmjs/env';
+import { Logger } from '@pgpmjs/logger';
+import retry from 'async-retry';
+import { Client } from 'pg';
+import { createRequire } from 'module';
+const functionRegistry = {
+    'simple-email': {
+        moduleName: '@constructive-io/simple-email-fn',
+        defaultPort: 8081
+    },
+    'send-email-link': {
+        moduleName: '@constructive-io/send-email-link-fn',
+        defaultPort: 8082
+    }
+};
+const log = new Logger('knative-job-service');
+const requireFn = createRequire(__filename);
+const resolveFunctionEntry = (name) => {
+    const entry = functionRegistry[name];
+    if (!entry) {
+        throw new Error(`Unknown function "${name}".`);
+    }
+    return entry;
+};
+const loadFunctionApp = (moduleName) => {
+    const knativeModuleId = requireFn.resolve('@constructive-io/knative-job-fn');
+    delete requireFn.cache[knativeModuleId];
+    const moduleId = requireFn.resolve(moduleName);
+    delete requireFn.cache[moduleId];
+    const mod = requireFn(moduleName);
+    const app = mod.default ?? mod;
+    if (!app || typeof app.listen !== 'function') {
+        throw new Error(`Function module "${moduleName}" does not export a listenable app.`);
+    }
+    return app;
+};
+const shouldEnableFunctions = (options) => {
+    if (!options)
+        return false;
+    if (typeof options.enabled === 'boolean')
+        return options.enabled;
+    return Boolean(options.services?.length);
+};
+const normalizeFunctionServices = (options) => {
+    if (!shouldEnableFunctions(options))
+        return [];
+    if (!options?.services?.length) {
+        return Object.keys(functionRegistry).map((name) => ({
+            name: name
+        }));
+    }
+    return options.services;
+};
+const resolveFunctionPort = (service) => {
+    const entry = resolveFunctionEntry(service.name);
+    return service.port ?? entry.defaultPort;
+};
+const ensureUniquePorts = (services) => {
+    const usedPorts = new Set();
+    for (const service of services) {
+        const port = resolveFunctionPort(service);
+        if (usedPorts.has(port)) {
+            throw new Error(`Function port ${port} is assigned more than once.`);
+        }
+        usedPorts.add(port);
+    }
+};
+const startFunction = async (service, functionServers) => {
+    const entry = resolveFunctionEntry(service.name);
+    const port = resolveFunctionPort(service);
+    const app = loadFunctionApp(entry.moduleName);
+    await new Promise((resolve, reject) => {
+        const server = app.listen(port, () => {
+            log.info(`function:${service.name} listening on ${port}`);
+            resolve();
+        });
+        if (server?.on) {
+            server.on('error', (err) => {
+                log.error(`function:${service.name} failed to start`, err);
+                reject(err);
+            });
+        }
+        functionServers.set(service.name, server);
+    });
+    return { name: service.name, port };
+};
+const startFunctions = async (options, functionServers) => {
+    const services = normalizeFunctionServices(options);
+    if (!services.length)
+        return [];
+    ensureUniquePorts(services);
+    const started = [];
+    for (const service of services) {
+        started.push(await startFunction(service, functionServers));
+    }
+    return started;
+};
+const listenApp = async (app, port, host) => new Promise((resolveListen, rejectListen) => {
+    const server = host ? app.listen(port, host) : app.listen(port);
+    const cleanup = () => {
+        server.off('listening', handleListen);
+        server.off('error', handleError);
+    };
+    const handleListen = () => {
+        cleanup();
+        resolveListen(server);
+    };
+    const handleError = (err) => {
+        cleanup();
+        rejectListen(err);
+    };
+    server.once('listening', handleListen);
+    server.once('error', handleError);
+});
+const closeServer = async (server) => {
+    if (!server || !server.listening)
+        return;
+    await new Promise((resolveClose, rejectClose) => {
+        server.close((err) => {
+            if (err) {
+                rejectClose(err);
+                return;
+            }
+            resolveClose();
+        });
+    });
+};
+export class KnativeJobsSvc {
+    options;
+    started = false;
+    result = {
+        functions: [],
+        jobs: false
+    };
+    functionServers = new Map();
+    jobsHttpServer;
+    worker;
+    scheduler;
+    jobsPoolManager;
+    constructor(options = {}) {
+        this.options = options;
+    }
+    async start() {
+        if (this.started)
+            return this.result;
+        this.started = true;
+        this.result = {
+            functions: [],
+            jobs: false
+        };
+        if (shouldEnableFunctions(this.options.functions)) {
+            log.info('starting functions');
+            this.result.functions = await startFunctions(this.options.functions, this.functionServers);
+        }
+        if (this.options.jobs?.enabled) {
+            log.info('starting jobs service');
+            await this.startJobs();
+            this.result.jobs = true;
+        }
+        return this.result;
+    }
+    async stop() {
+        if (!this.started)
+            return;
+        this.started = false;
+        if (this.worker?.stop) {
+            await this.worker.stop();
+        }
+        if (this.scheduler?.stop) {
+            await this.scheduler.stop();
+        }
+        this.worker = undefined;
+        this.scheduler = undefined;
+        await closeServer(this.jobsHttpServer);
+        this.jobsHttpServer = undefined;
+        if (this.jobsPoolManager) {
+            await this.jobsPoolManager.close();
+            this.jobsPoolManager = undefined;
+        }
+        for (const server of this.functionServers.values()) {
+            await closeServer(server);
+        }
+        this.functionServers.clear();
+    }
+    async startJobs() {
+        const pgPool = poolManager.getPool();
+        const jobsApp = jobServerFactory(pgPool);
+        const callbackPort = getJobsCallbackPort();
+        this.jobsHttpServer = await listenApp(jobsApp, callbackPort);
+        const tasks = getJobSupported();
+        this.worker = new Worker({
+            pgPool,
+            tasks,
+            workerId: getWorkerHostname()
+        });
+        this.scheduler = new Scheduler({
+            pgPool,
+            tasks,
+            workerId: getSchedulerHostname()
+        });
+        this.jobsPoolManager = poolManager;
+        this.worker.listen();
+        this.scheduler.listen();
+    }
+}
+const parseList = (value) => {
+    if (!value)
+        return [];
+    return value
+        .split(',')
+        .map((item) => item.trim())
+        .filter(Boolean);
+};
+const parsePortMap = (value) => {
+    if (!value)
+        return {};
+    const trimmed = value.trim();
+    if (!trimmed)
+        return {};
+    if (trimmed.startsWith('{')) {
+        try {
+            const parsed = JSON.parse(trimmed);
+            return Object.entries(parsed).reduce((acc, [key, port]) => {
+                const portNumber = Number(port);
+                if (Number.isFinite(portNumber)) {
+                    acc[key] = portNumber;
+                }
+                return acc;
+            }, {});
+        }
+        catch {
+            return {};
+        }
+    }
+    return trimmed.split(',').reduce((acc, pair) => {
+        const [rawName, rawPort] = pair.split(/[:=]/).map((item) => item.trim());
+        const port = Number(rawPort);
+        if (rawName && Number.isFinite(port)) {
+            acc[rawName] = port;
+        }
+        return acc;
+    }, {});
+};
+const buildFunctionsOptionsFromEnv = () => {
+    const rawFunctions = (process.env.CONSTRUCTIVE_FUNCTIONS || '').trim();
+    if (!rawFunctions)
+        return undefined;
+    const portMap = parsePortMap(process.env.CONSTRUCTIVE_FUNCTION_PORTS);
+    const normalized = rawFunctions.toLowerCase();
+    if (normalized === 'all' || normalized === '*') {
+        return { enabled: true };
+    }
+    const names = parseList(rawFunctions);
+    if (!names.length)
+        return undefined;
+    const services = names.map((name) => ({
+        name,
+        port: portMap[name]
+    }));
+    return {
+        enabled: true,
+        services
+    };
+};
+export const buildKnativeJobsSvcOptionsFromEnv = () => ({
+    jobs: {
+        enabled: parseEnvBoolean(process.env.CONSTRUCTIVE_JOBS_ENABLED) ?? true
+    },
+    functions: buildFunctionsOptionsFromEnv()
+});
+export const startKnativeJobsSvcFromEnv = async () => {
+    const server = new KnativeJobsSvc(buildKnativeJobsSvcOptionsFromEnv());
+    return server.start();
+};
+export const startJobsServices = () => {
+    log.info('starting jobs services...');
+    const pgPool = poolManager.getPool();
+    const app = jobServerFactory(pgPool);
+    const callbackPort = getJobsCallbackPort();
+    const httpServer = app.listen(callbackPort, () => {
+        log.info(`listening ON ${callbackPort}`);
+        const tasks = getJobSupported();
+        const worker = new Worker({
+            pgPool,
+            workerId: getWorkerHostname(),
+            tasks
+        });
+        const scheduler = new Scheduler({
+            pgPool,
+            workerId: getSchedulerHostname(),
+            tasks
+        });
+        worker.listen();
+        scheduler.listen();
+    });
+    return { pgPool, httpServer };
+};
+export const waitForJobsPrereqs = async () => {
+    log.info('waiting for jobs prereqs');
+    let client = null;
+    try {
+        const cfg = getJobPgConfig();
+        client = new Client({
+            host: cfg.host,
+            port: cfg.port,
+            user: cfg.user,
+            password: cfg.password,
+            database: cfg.database
+        });
+        await client.connect();
+        const schema = getJobSchema();
+        await client.query(`SELECT * FROM "${schema}".jobs LIMIT 1;`);
+    }
+    catch (error) {
+        log.error(error);
+        throw new Error('jobs server boot failed...');
+    }
+    finally {
+        if (client) {
+            void client.end();
+        }
+    }
+};
+export const bootJobs = async () => {
+    log.info('attempting to boot jobs');
+    await retry(async () => {
+        await waitForJobsPrereqs();
+    }, {
+        retries: 10,
+        factor: 2
+    });
+    const options = buildKnativeJobsSvcOptionsFromEnv();
+    if (options.jobs?.enabled === false) {
+        log.info('jobs disabled; skipping startup');
+        return;
+    }
+    const server = new KnativeJobsSvc(options);
+    await server.start();
+};
+export * from './types';

package/{src/run.ts → esm/run.js}

@@ -1,9 +1,6 @@
 #!/usr/bin/env node
-
 export { bootJobs, startJobsServices, waitForJobsPrereqs } from './index';
-
 import { bootJobs } from './index';
-
 if (require.main === module) {
-  void bootJobs();
+    void bootJobs();
 }

package/esm/types.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,28 +1,33 @@
 {
   "name": "@constructive-io/knative-job-service",
-  "version": "0.8.1",
+  "version": "0.8.2",
   "description": "knative job service",
   "author": "Constructive <developers@constructive.io>",
   "homepage": "https://github.com/constructive-io/jobs/tree/master/packages/knative-job-service#readme",
   "license": "SEE LICENSE IN LICENSE",
-  "main": "dist/index.js",
+  "main": "index.js",
+  "module": "esm/index.js",
+  "types": "index.d.ts",
   "directories": {
     "lib": "src",
     "test": "__tests__"
   },
   "bin": {
-    "faas-job-service": "src/run.ts"
+    "faas-job-service": "run.js"
   },
   "publishConfig": {
-    "access": "public"
+    "access": "public",
+    "directory": "dist"
   },
   "repository": {
     "type": "git",
     "url": "https://github.com/constructive-io/jobs"
   },
   "scripts": {
-    "build": "tsc -p tsconfig.json",
-    "build:watch": "tsc -p tsconfig.json -w",
+    "clean": "makage clean",
+    "prepack": "npm run build",
+    "build": "makage build",
+    "build:dev": "makage build --dev",
     "start": "node dist/run.js",
     "dev": "ts-node --transpile-only src/run.ts",
     "test": "jest --passWithNoTests",
@@ -33,7 +38,7 @@
     "url": "https://github.com/constructive-io/jobs/issues"
   },
   "devDependencies": {
-    "@constructive-io/graphql-server": "^2.18.1",
+    "@constructive-io/graphql-server": "^2.18.2",
     "@constructive-io/graphql-types": "^2.13.0",
     "@pgpm/database-jobs": "^0.16.0",
     "@pgpm/inflection": "^0.16.0",
@@ -42,25 +47,26 @@
     "@pgpm/services": "^0.16.1",
     "@pgpm/types": "^0.16.0",
     "@pgpm/verify": "^0.16.0",
-    "@pgpmjs/core": "^4.16.0",
+    "@pgpmjs/core": "^4.16.1",
     "@types/supertest": "^6.0.3",
-    "pgsql-test": "^2.25.0",
+    "makage": "^0.1.10",
+    "pgsql-test": "^2.25.1",
     "supertest": "^7.2.2",
     "ts-node": "^10.9.2"
   },
   "dependencies": {
-    "@constructive-io/job-pg": "^0.4.0",
-    "@constructive-io/job-scheduler": "^0.4.0",
-    "@constructive-io/job-utils": "^0.6.0",
-    "@constructive-io/knative-job-fn": "^0.3.0",
-    "@constructive-io/knative-job-server": "^0.4.0",
-    "@constructive-io/knative-job-worker": "^0.8.0",
-    "@constructive-io/send-email-link-fn": "^0.3.0",
-    "@constructive-io/simple-email-fn": "^0.3.0",
+    "@constructive-io/job-pg": "^0.4.1",
+    "@constructive-io/job-scheduler": "^0.4.1",
+    "@constructive-io/job-utils": "^0.6.1",
+    "@constructive-io/knative-job-fn": "^0.3.1",
+    "@constructive-io/knative-job-server": "^0.4.1",
+    "@constructive-io/knative-job-worker": "^0.8.1",
+    "@constructive-io/send-email-link-fn": "^0.3.1",
+    "@constructive-io/simple-email-fn": "^0.3.1",
     "@pgpmjs/env": "^2.10.0",
     "@pgpmjs/logger": "^1.4.0",
     "async-retry": "1.3.1",
-    "pg": "8.16.3"
+    "pg": "8.17.1"
   },
-  "gitHead": "1da9596c2e7b9445466626b7b809339361aa0b65"
+  "gitHead": "3ffd5718e86ea5fa9ca6e0930aeb510cf392f343"
 }