@constructive-io/knative-job-server 0.3.7

package/CHANGELOG.md

@@ -0,0 +1,12 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+## 0.3.7 (2025-12-18)
+
+**Note:** Version bump only for package @constructive-io/knative-job-server
+
+## [0.3.6](https://github.com/constructive-io/jobs/compare/@launchql/knative-job-server@0.3.5...@launchql/knative-job-server@0.3.6) (2025-12-17)
+
+**Note:** Version bump only for package @launchql/knative-job-server

package/LICENSE

@@ -0,0 +1,23 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Dan Lynch <pyramation@gmail.com>
+Copyright (c) 2025 Constructive <developers@constructive.io>
+Copyright (c) 2020-present, Interweb, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1 @@
+# knative-job-server

package/dist/env.d.ts

@@ -0,0 +1,6 @@
+declare const _default: Readonly<{
+    INTERNAL_JOBS_CALLBACK_PORT: number;
+}> & import("envalid").CleanEnv & {
+    readonly [varName: string]: string;
+};
+export default _default;

package/dist/env.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const envalid_1 = require("envalid");
+exports.default = (0, envalid_1.cleanEnv)(process.env, {
+    INTERNAL_JOBS_CALLBACK_PORT: (0, envalid_1.port)({ default: 12345 })
+}, { dotEnvPath: null });

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+import type { Pool } from 'pg';
+declare const _default: (pgPool?: Pool) => any;
+export default _default;

package/dist/index.js

@@ -0,0 +1,112 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const express_1 = __importDefault(require("express"));
+const body_parser_1 = __importDefault(require("body-parser"));
+const jobs = __importStar(require("@constructive-io/job-utils"));
+const job_pg_1 = __importDefault(require("@constructive-io/job-pg"));
+exports.default = (pgPool = job_pg_1.default.getPool()) => {
+    const app = (0, express_1.default)();
+    app.use(body_parser_1.default.json());
+    const withClient = (cb) => async (req, res, next) => {
+        const client = (await pgPool.connect());
+        try {
+            await cb(client, req, res, next);
+        }
+        catch (e) {
+            next(e);
+        }
+        finally {
+            client.release();
+        }
+    };
+    const complete = withClient(async (client, req, res) => {
+        const workerId = req.get('X-Worker-Id');
+        const jobIdHeader = req.get('X-Job-Id');
+        if (!workerId || !jobIdHeader) {
+            console.log('server: missing worker/job headers on completion callback', { workerId, jobIdHeader });
+            res.status(400).json({ error: 'Missing X-Worker-Id or X-Job-Id header' });
+            return;
+        }
+        console.log(`server: Completed task ${jobIdHeader} with success`);
+        await jobs.completeJob(client, { workerId, jobId: jobIdHeader });
+        res
+            .set({
+            'Content-Type': 'application/json'
+        })
+            .status(200)
+            .send({ workerId, jobId: jobIdHeader });
+    });
+    const fail = withClient(async (client, req, res) => {
+        const workerId = req.get('X-Worker-Id');
+        const jobIdHeader = req.get('X-Job-Id');
+        if (!workerId || !jobIdHeader) {
+            console.log('server: missing worker/job headers on failure callback', { workerId, jobIdHeader });
+            res.status(400).json({ error: 'Missing X-Worker-Id or X-Job-Id header' });
+            return;
+        }
+        const errorMessage = req.body.error || req.body.message || 'UNKNOWN_ERROR';
+        console.log(`server: Failed task ${jobIdHeader} with error: \n${errorMessage}\n\n`);
+        await jobs.failJob(client, {
+            workerId,
+            jobId: jobIdHeader,
+            message: errorMessage
+        });
+        res.status(200).json({ workerId, jobId: jobIdHeader });
+    });
+    app.post('*', async (req, res, next) => {
+        const jobId = req.get('X-Job-Id');
+        if (typeof jobId === 'undefined') {
+            console.log('server: undefined JOB, what is this? healthcheck?');
+            console.log(req.url);
+            console.log(req.originalUrl);
+            return res.status(200).json('OK');
+        }
+        if (req.get('X-Job-Error') === 'true') {
+            await fail(req, res, next);
+        }
+        else {
+            await complete(req, res, next);
+        }
+    });
+    app.use((error, req, res, next) => {
+        // TODO check headers for jobId and call fail?
+        res.status(500).json({ error });
+    });
+    return app;
+};

package/dist/run.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/dist/run.js

@@ -0,0 +1,15 @@
+#!/usr/bin/env node
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const index_1 = __importDefault(require("./index"));
+const job_pg_1 = __importDefault(require("@constructive-io/job-pg"));
+const job_utils_1 = require("@constructive-io/job-utils");
+const pgPool = job_pg_1.default.getPool();
+const port = (0, job_utils_1.getJobsCallbackPort)();
+(0, index_1.default)(pgPool).listen(port, () => {
+    // eslint-disable-next-line no-console
+    console.log(`listening ON ${port}`);
+});

package/jest.config.js

@@ -0,0 +1,18 @@
+/** @type {import('ts-jest').JestConfigWithTsJest} */
+module.exports = {
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+  transform: {
+    '^.+\\.tsx?$': [
+      'ts-jest',
+      {
+        babelConfig: false,
+        tsconfig: 'tsconfig.json',
+      },
+    ],
+  },
+  transformIgnorePatterns: [`/node_modules/*`],
+  testRegex: '(/__tests__/.*|(\\.|/)(test|spec))\\.(jsx?|tsx?)$',
+  moduleFileExtensions: ['ts', 'tsx', 'js', 'jsx', 'json', 'node'],
+  modulePathIgnorePatterns: ['dist/*'],
+};

package/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "@constructive-io/knative-job-server",
+  "version": "0.3.7",
+  "description": "knative job server",
+  "author": "Constructive <developers@constructive.io>",
+  "homepage": "https://github.com/constructive-io/jobs/tree/master/packages/knative-job-server#readme",
+  "license": "SEE LICENSE IN LICENSE",
+  "main": "dist/index.js",
+  "directories": {
+    "lib": "src",
+    "test": "__tests__"
+  },
+  "bin": {
+    "faas-job-server": "src/run.ts"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/constructive-io/jobs"
+  },
+  "scripts": {
+    "test": "jest",
+    "test:watch": "jest --watch",
+    "test:debug": "node --inspect node_modules/.bin/jest --runInBand",
+    "build": "tsc -p tsconfig.json",
+    "build:watch": "tsc -p tsconfig.json -w"
+  },
+  "bugs": {
+    "url": "https://github.com/constructive-io/jobs/issues"
+  },
+  "dependencies": {
+    "@constructive-io/job-pg": "^0.3.5",
+    "@constructive-io/job-utils": "^0.5.0",
+    "body-parser": "1.19.0",
+    "express": "4.17.1",
+    "pg": "8.16.3"
+  },
+  "gitHead": "86d74dc4fce9051df0d2b5bcc163607aba42f009"
+}

package/src/index.ts

@@ -0,0 +1,129 @@
+import express from 'express';
+import bodyParser from 'body-parser';
+import type { Pool, PoolClient } from 'pg';
+import * as jobs from '@constructive-io/job-utils';
+import poolManager from '@constructive-io/job-pg';
+
+type JobRequestBody = {
+  message?: string;
+  error?: string;
+  // allow additional fields without typing everything
+  [key: string]: unknown;
+};
+
+type JobRequest = {
+  get(name: string): string | undefined;
+  body: JobRequestBody;
+  url: string;
+  originalUrl: string;
+};
+
+type JobResponse = {
+  set(headers: Record<string, string>): JobResponse;
+  status(code: number): JobResponse;
+  json(body: unknown): JobResponse;
+  send(body: unknown): JobResponse;
+};
+
+type NextFn = (err?: unknown) => void;
+
+type WithClientHandler = (
+  client: PoolClient,
+  req: JobRequest,
+  res: JobResponse,
+  next: NextFn
+) => Promise<void>;
+
+export default (pgPool: Pool = poolManager.getPool()) => {
+  const app = express();
+  app.use(bodyParser.json());
+
+  const withClient =
+    (cb: WithClientHandler) =>
+    async (req: JobRequest, res: JobResponse, next: NextFn) => {
+      const client = (await pgPool.connect()) as PoolClient;
+      try {
+        await cb(client as PoolClient, req, res, next);
+      } catch (e) {
+        next(e);
+      } finally {
+        client.release();
+      }
+    };
+
+  const complete = withClient(async (client, req, res) => {
+    const workerId = req.get('X-Worker-Id');
+    const jobIdHeader = req.get('X-Job-Id');
+
+    if (!workerId || !jobIdHeader) {
+      console.log(
+        'server: missing worker/job headers on completion callback',
+        { workerId, jobIdHeader }
+      );
+      res.status(400).json({ error: 'Missing X-Worker-Id or X-Job-Id header' });
+      return;
+    }
+
+    console.log(`server: Completed task ${jobIdHeader} with success`);
+    await jobs.completeJob(client, { workerId, jobId: jobIdHeader });
+
+    res
+      .set({
+        'Content-Type': 'application/json'
+      })
+      .status(200)
+      .send({ workerId, jobId: jobIdHeader });
+  });
+
+  const fail = withClient(async (client, req, res) => {
+    const workerId = req.get('X-Worker-Id');
+    const jobIdHeader = req.get('X-Job-Id');
+
+    if (!workerId || !jobIdHeader) {
+      console.log(
+        'server: missing worker/job headers on failure callback',
+        { workerId, jobIdHeader }
+      );
+      res.status(400).json({ error: 'Missing X-Worker-Id or X-Job-Id header' });
+      return;
+    }
+
+    const errorMessage = req.body.error || req.body.message || 'UNKNOWN_ERROR';
+
+    console.log(
+      `server: Failed task ${jobIdHeader} with error: \n${errorMessage}\n\n`
+    );
+
+    await jobs.failJob(client, {
+      workerId,
+      jobId: jobIdHeader,
+      message: errorMessage
+    });
+
+    res.status(200).json({ workerId, jobId: jobIdHeader });
+  });
+
+  app.post('*', async (req: JobRequest, res: JobResponse, next: NextFn) => {
+    const jobId = req.get('X-Job-Id');
+
+    if (typeof jobId === 'undefined') {
+      console.log('server: undefined JOB, what is this? healthcheck?');
+      console.log(req.url);
+      console.log(req.originalUrl);
+      return res.status(200).json('OK');
+    }
+
+    if (req.get('X-Job-Error') === 'true') {
+      await fail(req, res, next);
+    } else {
+      await complete(req, res, next);
+    }
+  });
+
+  app.use((error: unknown, req: JobRequest, res: JobResponse, next: NextFn) => {
+    // TODO check headers for jobId and call fail?
+    res.status(500).json({ error });
+  });
+
+  return app;
+};

package/src/run.ts

@@ -0,0 +1,13 @@
+#!/usr/bin/env node
+
+import server from './index';
+import poolManager from '@constructive-io/job-pg';
+import { getJobsCallbackPort } from '@constructive-io/job-utils';
+
+const pgPool = poolManager.getPool();
+const port = getJobsCallbackPort();
+
+server(pgPool).listen(port, () => {
+  // eslint-disable-next-line no-console
+  console.log(`listening ON ${port}`);
+});

package/tsconfig.esm.json

@@ -0,0 +1,9 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "dist/esm",
+    "module": "es2022",
+    "rootDir": "src/",
+    "declaration": false
+  }
+}

package/tsconfig.json

@@ -0,0 +1,9 @@
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "outDir": "dist",
+    "rootDir": "src/"
+  },
+  "include": ["src/**/*.ts", "../../types/**/*.d.ts"],
+  "exclude": ["dist", "node_modules", "**/*.spec.*", "**/*.test.*"]
+}