@constructive-io/knative-job-fn 0.2.7 → 0.3.0

package/CHANGELOG.md

@@ -3,6 +3,14 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [0.3.0](https://github.com/constructive-io/jobs/compare/@constructive-io/knative-job-fn@0.2.8...@constructive-io/knative-job-fn@0.3.0) (2026-01-18)
+
+**Note:** Version bump only for package @constructive-io/knative-job-fn
+
+## [0.2.8](https://github.com/constructive-io/jobs/compare/@constructive-io/knative-job-fn@0.2.7...@constructive-io/knative-job-fn@0.2.8) (2026-01-18)
+
+**Note:** Version bump only for package @constructive-io/knative-job-fn
+
 ## [0.2.7](https://github.com/constructive-io/jobs/compare/@constructive-io/knative-job-fn@0.2.6...@constructive-io/knative-job-fn@0.2.7) (2025-12-25)
 
 **Note:** Version bump only for package @constructive-io/knative-job-fn

package/dist/index.d.ts

@@ -1,5 +1,11 @@
-declare const _default: {
+import type { Server as HttpServer } from 'http';
+declare const createJobApp: () => {
     post: (...args: any[]) => any;
-    listen: (port: any, cb?: () => void) => void;
+    listen: (port: any, hostOrCb?: string | (() => void), cb?: () => void) => HttpServer;
 };
-export default _default;
+declare const defaultApp: {
+    post: (...args: any[]) => any;
+    listen: (port: any, hostOrCb?: string | (() => void), cb?: () => void) => HttpServer;
+};
+export { createJobApp };
+export default defaultApp;

package/dist/index.js

@@ -3,11 +3,13 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.createJobApp = void 0;
 const express_1 = __importDefault(require("express"));
 const body_parser_1 = __importDefault(require("body-parser"));
 const node_http_1 = __importDefault(require("node:http"));
 const node_https_1 = __importDefault(require("node:https"));
 const node_url_1 = require("node:url");
+const logger_1 = require("@pgpmjs/logger");
 function getHeaders(req) {
     return {
         'x-worker-id': req.get('X-Worker-Id'),
@@ -16,48 +18,6 @@ function getHeaders(req) {
         'x-callback-url': req.get('X-Callback-Url')
     };
 }
-const app = (0, express_1.default)();
-app.use(body_parser_1.default.json());
-// Basic request logging for all incoming job invocations.
-app.use((req, res, next) => {
-    try {
-        // Log only the headers we care about plus a shallow body snapshot
-        const headers = getHeaders(req);
-        let body;
-        if (req.body && typeof req.body === 'object') {
-            // Only log top-level keys to avoid exposing sensitive body contents.
-            body = { keys: Object.keys(req.body) };
-        }
-        else if (typeof req.body === 'string') {
-            // For string bodies, log only the length.
-            body = { length: req.body.length };
-        }
-        else {
-            body = undefined;
-        }
-        // eslint-disable-next-line no-console
-        console.log('[knative-job-fn] Incoming job request', {
-            method: req.method,
-            path: req.originalUrl || req.url,
-            headers,
-            body
-        });
-    }
-    catch {
-        // best-effort logging; never block the request
-    }
-    next();
-});
-// Echo job headers back on responses for debugging/traceability.
-app.use((req, res, next) => {
-    res.set({
-        'Content-Type': 'application/json',
-        'X-Worker-Id': req.get('X-Worker-Id'),
-        'X-Database-Id': req.get('X-Database-Id'),
-        'X-Job-Id': req.get('X-Job-Id')
-    });
-    next();
-});
 // Normalize callback URL so it always points at the /callback endpoint.
 const normalizeCallbackUrl = (rawUrl) => {
     try {
@@ -123,8 +83,7 @@ const sendJobCallback = async (ctx, status, errorMessage) => {
         body.error = errorMessage || 'ERROR';
     }
     try {
-        // eslint-disable-next-line no-console
-        console.log('[knative-job-fn] Sending job callback', {
+        logger.info('Sending job callback', {
             status,
             target: normalizeCallbackUrl(callbackUrl),
             workerId,
@@ -134,99 +93,150 @@ const sendJobCallback = async (ctx, status, errorMessage) => {
         await postJson(target, headers, body);
     }
     catch (err) {
-        // eslint-disable-next-line no-console
-        console.error('[knative-job-fn] Failed to POST job callback', {
+        logger.error('Failed to POST job callback', {
             target,
             status,
             err
         });
     }
 };
-// Attach per-request context and a finish hook to send success callbacks.
-app.use((req, res, next) => {
-    const ctx = {
-        callbackUrl: req.get('X-Callback-Url'),
-        workerId: req.get('X-Worker-Id'),
-        jobId: req.get('X-Job-Id'),
-        databaseId: req.get('X-Database-Id')
-    };
-    // Store on res.locals so the error middleware can also mark callbacks as sent.
-    res.locals = res.locals || {};
-    res.locals.jobContext = ctx;
-    res.locals.jobCallbackSent = false;
-    if (ctx.callbackUrl && ctx.workerId && ctx.jobId) {
-        res.on('finish', () => {
-            // If an error handler already sent a callback, skip.
-            if (res.locals.jobCallbackSent)
-                return;
-            res.locals.jobCallbackSent = true;
-            // eslint-disable-next-line no-console
-            console.log('[knative-job-fn] Function completed', {
-                workerId: ctx.workerId,
-                jobId: ctx.jobId,
-                databaseId: ctx.databaseId,
-                statusCode: res.statusCode
+const logger = (0, logger_1.createLogger)('knative-job-fn');
+const createJobApp = () => {
+    const app = (0, express_1.default)();
+    app.use(body_parser_1.default.json());
+    // Basic request logging for all incoming job invocations.
+    app.use((req, res, next) => {
+        try {
+            // Log only the headers we care about plus a shallow body snapshot
+            const headers = getHeaders(req);
+            let body;
+            if (req.body && typeof req.body === 'object') {
+                // Only log top-level keys to avoid exposing sensitive body contents.
+                body = { keys: Object.keys(req.body) };
+            }
+            else if (typeof req.body === 'string') {
+                // For string bodies, log only the length.
+                body = { length: req.body.length };
+            }
+            else {
+                body = undefined;
+            }
+            logger.info('Incoming job request', {
+                method: req.method,
+                path: req.originalUrl || req.url,
+                headers,
+                body
             });
-            void sendJobCallback(ctx, 'success');
+        }
+        catch {
+            // best-effort logging; never block the request
+        }
+        next();
+    });
+    // Echo job headers back on responses for debugging/traceability.
+    app.use((req, res, next) => {
+        res.set({
+            'Content-Type': 'application/json',
+            'X-Worker-Id': req.get('X-Worker-Id'),
+            'X-Database-Id': req.get('X-Database-Id'),
+            'X-Job-Id': req.get('X-Job-Id')
         });
-    }
-    next();
-});
-exports.default = {
-    post: function (...args) {
-        return app.post.apply(app, args);
-    },
-    listen: (port, cb = () => { }) => {
-        // NOTE Remember that Express middleware executes in order.
-        // You should define error handlers last, after all other middleware.
-        // Otherwise, your error handler won't get called
-        // eslint-disable-next-line no-unused-vars
-        app.use(async (error, req, res, next) => {
-            res.set({
-                'Content-Type': 'application/json',
-                'X-Job-Error': true
+        next();
+    });
+    // Attach per-request context and a finish hook to send success callbacks.
+    app.use((req, res, next) => {
+        const ctx = {
+            callbackUrl: req.get('X-Callback-Url'),
+            workerId: req.get('X-Worker-Id'),
+            jobId: req.get('X-Job-Id'),
+            databaseId: req.get('X-Database-Id')
+        };
+        // Store on res.locals so the error middleware can also mark callbacks as sent.
+        res.locals = res.locals || {};
+        res.locals.jobContext = ctx;
+        res.locals.jobCallbackSent = false;
+        if (ctx.callbackUrl && ctx.workerId && ctx.jobId) {
+            res.on('finish', () => {
+                // If an error handler already sent a callback, skip.
+                if (res.locals.jobCallbackSent)
+                    return;
+                res.locals.jobCallbackSent = true;
+                logger.info('Function completed', {
+                    workerId: ctx.workerId,
+                    jobId: ctx.jobId,
+                    databaseId: ctx.databaseId,
+                    statusCode: res.statusCode
+                });
+                void sendJobCallback(ctx, 'success');
             });
-            // Mark job as having errored via callback, if available.
-            try {
-                const ctx = res.locals?.jobContext;
-                if (ctx && !res.locals.jobCallbackSent) {
-                    res.locals.jobCallbackSent = true;
-                    await sendJobCallback(ctx, 'error', error?.message);
+        }
+        next();
+    });
+    return {
+        post: function (...args) {
+            return app.post.apply(app, args);
+        },
+        listen: (port, hostOrCb, cb = () => { }) => {
+            // NOTE Remember that Express middleware executes in order.
+            // You should define error handlers last, after all other middleware.
+            // Otherwise, your error handler won't get called
+            // eslint-disable-next-line no-unused-vars
+            app.use(async (error, req, res, next) => {
+                res.set({
+                    'Content-Type': 'application/json',
+                    'X-Job-Error': true
+                });
+                // Mark job as having errored via callback, if available.
+                try {
+                    const ctx = res.locals?.jobContext;
+                    if (ctx && !res.locals.jobCallbackSent) {
+                        res.locals.jobCallbackSent = true;
+                        await sendJobCallback(ctx, 'error', error?.message);
+                    }
                 }
-            }
-            catch (err) {
-                // eslint-disable-next-line no-console
-                console.error('[knative-job-fn] Failed to send error callback', err);
-            }
-            // Log the full error context for debugging.
-            try {
-                const headers = getHeaders(req);
-                // Some error types (e.g. GraphQL ClientError) expose response info.
-                const errorDetails = {
-                    message: error?.message,
-                    name: error?.name,
-                    stack: error?.stack
-                };
-                if (error?.response) {
-                    errorDetails.response = {
-                        status: error.response.status,
-                        statusText: error.response.statusText,
-                        errors: error.response.errors,
-                        data: error.response.data
+                catch (err) {
+                    logger.error('Failed to send error callback', err);
+                }
+                // Log the full error context for debugging.
+                try {
+                    const headers = getHeaders(req);
+                    // Some error types (e.g. GraphQL ClientError) expose response info.
+                    const errorDetails = {
+                        message: error?.message,
+                        name: error?.name,
+                        stack: error?.stack
                     };
+                    if (error?.response) {
+                        errorDetails.response = {
+                            status: error.response.status,
+                            statusText: error.response.statusText,
+                            errors: error.response.errors,
+                            data: error.response.data
+                        };
+                    }
+                    logger.error('Function error', {
+                        headers,
+                        path: req.originalUrl || req.url,
+                        error: errorDetails
+                    });
                 }
-                // eslint-disable-next-line no-console
-                console.error('[knative-job-fn] Function error', {
-                    headers,
-                    path: req.originalUrl || req.url,
-                    error: errorDetails
-                });
-            }
-            catch {
-                // never throw from the error logger
-            }
-            res.status(200).json({ message: error.message });
-        });
-        app.listen(port, cb);
-    }
+                catch {
+                    // never throw from the error logger
+                }
+                res.status(200).json({ message: error.message });
+            });
+            const host = typeof hostOrCb === 'string' ? hostOrCb : undefined;
+            const callback = typeof hostOrCb === 'function' ? hostOrCb : cb;
+            const onListen = () => {
+                callback();
+            };
+            const server = host
+                ? app.listen(port, host, onListen)
+                : app.listen(port, onListen);
+            return server;
+        }
+    };
 };
+exports.createJobApp = createJobApp;
+const defaultApp = createJobApp();
+exports.default = defaultApp;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@constructive-io/knative-job-fn",
-  "version": "0.2.7",
+  "version": "0.3.0",
   "description": "knative job fn",
   "author": "Constructive <developers@constructive.io>",
   "homepage": "https://github.com/constructive-io/jobs/tree/master/packages/knative-job-fn#readme",
@@ -28,8 +28,9 @@
     "url": "https://github.com/constructive-io/jobs/issues"
   },
   "dependencies": {
+    "@pgpmjs/logger": "^1.4.0",
     "body-parser": "1.19.0",
     "express": "5.2.1"
   },
-  "gitHead": "976cc9e0e09201c7df40518a1797f4178fc21c2c"
+  "gitHead": "481b3a50b4eec2da6b376c4cd1868065e1e28edb"
 }

package/src/index.ts

@@ -3,6 +3,8 @@ import bodyParser from 'body-parser';
 import http from 'node:http';
 import https from 'node:https';
 import { URL } from 'node:url';
+import type { Server as HttpServer } from 'http';
+import { createLogger } from '@pgpmjs/logger';
 
 type JobCallbackStatus = 'success' | 'error';
 
@@ -22,51 +24,6 @@ function getHeaders(req: any) {
   };
 }
 
-const app: any = express();
-
-app.use(bodyParser.json());
-
-// Basic request logging for all incoming job invocations.
-app.use((req: any, res: any, next: any) => {
-  try {
-    // Log only the headers we care about plus a shallow body snapshot
-    const headers = getHeaders(req);
-
-    let body: any;
-    if (req.body && typeof req.body === 'object') {
-      // Only log top-level keys to avoid exposing sensitive body contents.
-      body = { keys: Object.keys(req.body) };
-    } else if (typeof req.body === 'string') {
-      // For string bodies, log only the length.
-      body = { length: req.body.length };
-    } else {
-      body = undefined;
-    }
-
-    // eslint-disable-next-line no-console
-    console.log('[knative-job-fn] Incoming job request', {
-      method: req.method,
-      path: req.originalUrl || req.url,
-      headers,
-      body
-    });
-  } catch {
-    // best-effort logging; never block the request
-  }
-  next();
-});
-
-// Echo job headers back on responses for debugging/traceability.
-app.use((req: any, res: any, next: any) => {
-  res.set({
-    'Content-Type': 'application/json',
-    'X-Worker-Id': req.get('X-Worker-Id'),
-    'X-Database-Id': req.get('X-Database-Id'),
-    'X-Job-Id': req.get('X-Job-Id')
-  });
-  next();
-});
-
 // Normalize callback URL so it always points at the /callback endpoint.
 const normalizeCallbackUrl = (rawUrl: string): string => {
   try {
@@ -152,8 +109,7 @@ const sendJobCallback = async (
   }
 
   try {
-    // eslint-disable-next-line no-console
-    console.log('[knative-job-fn] Sending job callback', {
+    logger.info('Sending job callback', {
       status,
       target: normalizeCallbackUrl(callbackUrl),
       workerId,
@@ -162,8 +118,7 @@ const sendJobCallback = async (
     });
     await postJson(target, headers, body);
   } catch (err) {
-    // eslint-disable-next-line no-console
-    console.error('[knative-job-fn] Failed to POST job callback', {
+    logger.error('Failed to POST job callback', {
       target,
       status,
       err
@@ -171,98 +126,162 @@ const sendJobCallback = async (
   }
 };
 
-// Attach per-request context and a finish hook to send success callbacks.
-app.use((req: any, res: any, next: any) => {
-  const ctx: JobContext = {
-    callbackUrl: req.get('X-Callback-Url'),
-    workerId: req.get('X-Worker-Id'),
-    jobId: req.get('X-Job-Id'),
-    databaseId: req.get('X-Database-Id')
-  };
+const logger = createLogger('knative-job-fn');
 
-  // Store on res.locals so the error middleware can also mark callbacks as sent.
-  res.locals = res.locals || {};
-  res.locals.jobContext = ctx;
-  res.locals.jobCallbackSent = false;
-
-  if (ctx.callbackUrl && ctx.workerId && ctx.jobId) {
-    res.on('finish', () => {
-      // If an error handler already sent a callback, skip.
-      if (res.locals.jobCallbackSent) return;
-      res.locals.jobCallbackSent = true;
-      // eslint-disable-next-line no-console
-      console.log('[knative-job-fn] Function completed', {
-        workerId: ctx.workerId,
-        jobId: ctx.jobId,
-        databaseId: ctx.databaseId,
-        statusCode: res.statusCode
+const createJobApp = () => {
+  const app: any = express();
+
+  app.use(bodyParser.json());
+
+  // Basic request logging for all incoming job invocations.
+  app.use((req: any, res: any, next: any) => {
+    try {
+      // Log only the headers we care about plus a shallow body snapshot
+      const headers = getHeaders(req);
+
+      let body: any;
+      if (req.body && typeof req.body === 'object') {
+        // Only log top-level keys to avoid exposing sensitive body contents.
+        body = { keys: Object.keys(req.body) };
+      } else if (typeof req.body === 'string') {
+        // For string bodies, log only the length.
+        body = { length: req.body.length };
+      } else {
+        body = undefined;
+      }
+
+      logger.info('Incoming job request', {
+        method: req.method,
+        path: req.originalUrl || req.url,
+        headers,
+        body
       });
-      void sendJobCallback(ctx, 'success');
+    } catch {
+      // best-effort logging; never block the request
+    }
+    next();
+  });
+
+  // Echo job headers back on responses for debugging/traceability.
+  app.use((req: any, res: any, next: any) => {
+    res.set({
+      'Content-Type': 'application/json',
+      'X-Worker-Id': req.get('X-Worker-Id'),
+      'X-Database-Id': req.get('X-Database-Id'),
+      'X-Job-Id': req.get('X-Job-Id')
     });
-  }
+    next();
+  });
 
-  next();
-});
-
-export default {
-  post: function (...args: any[]) {
-    return app.post.apply(app, args as any);
-  },
-  listen: (port: any, cb: () => void = () => {}) => {
-    // NOTE Remember that Express middleware executes in order.
-    // You should define error handlers last, after all other middleware.
-    // Otherwise, your error handler won't get called
-    // eslint-disable-next-line no-unused-vars
-    app.use(async (error: any, req: any, res: any, next: any) => {
-      res.set({
-        'Content-Type': 'application/json',
-        'X-Job-Error': true
+  // Attach per-request context and a finish hook to send success callbacks.
+  app.use((req: any, res: any, next: any) => {
+    const ctx: JobContext = {
+      callbackUrl: req.get('X-Callback-Url'),
+      workerId: req.get('X-Worker-Id'),
+      jobId: req.get('X-Job-Id'),
+      databaseId: req.get('X-Database-Id')
+    };
+
+    // Store on res.locals so the error middleware can also mark callbacks as sent.
+    res.locals = res.locals || {};
+    res.locals.jobContext = ctx;
+    res.locals.jobCallbackSent = false;
+
+    if (ctx.callbackUrl && ctx.workerId && ctx.jobId) {
+      res.on('finish', () => {
+        // If an error handler already sent a callback, skip.
+        if (res.locals.jobCallbackSent) return;
+        res.locals.jobCallbackSent = true;
+        logger.info('Function completed', {
+          workerId: ctx.workerId,
+          jobId: ctx.jobId,
+          databaseId: ctx.databaseId,
+          statusCode: res.statusCode
+        });
+        void sendJobCallback(ctx, 'success');
       });
+    }
+
+    next();
+  });
 
-      // Mark job as having errored via callback, if available.
-      try {
-        const ctx: JobContext | undefined = res.locals?.jobContext;
-        if (ctx && !res.locals.jobCallbackSent) {
-          res.locals.jobCallbackSent = true;
-          await sendJobCallback(ctx, 'error', error?.message);
+  return {
+    post: function (...args: any[]) {
+      return app.post.apply(app, args as any);
+    },
+    listen: (
+      port: any,
+      hostOrCb?: string | (() => void),
+      cb: () => void = () => {}
+    ): HttpServer => {
+      // NOTE Remember that Express middleware executes in order.
+      // You should define error handlers last, after all other middleware.
+      // Otherwise, your error handler won't get called
+      // eslint-disable-next-line no-unused-vars
+      app.use(async (error: any, req: any, res: any, next: any) => {
+        res.set({
+          'Content-Type': 'application/json',
+          'X-Job-Error': true
+        });
+
+        // Mark job as having errored via callback, if available.
+        try {
+          const ctx: JobContext | undefined = res.locals?.jobContext;
+          if (ctx && !res.locals.jobCallbackSent) {
+            res.locals.jobCallbackSent = true;
+            await sendJobCallback(ctx, 'error', error?.message);
+          }
+        } catch (err) {
+          logger.error('Failed to send error callback', err);
         }
-      } catch (err) {
-        // eslint-disable-next-line no-console
-        console.error('[knative-job-fn] Failed to send error callback', err);
-      }
 
-      // Log the full error context for debugging.
-      try {
-        const headers = getHeaders(req);
-
-        // Some error types (e.g. GraphQL ClientError) expose response info.
-        const errorDetails: any = {
-          message: error?.message,
-          name: error?.name,
-          stack: error?.stack
-        };
-
-        if (error?.response) {
-          errorDetails.response = {
-            status: error.response.status,
-            statusText: error.response.statusText,
-            errors: error.response.errors,
-            data: error.response.data
+        // Log the full error context for debugging.
+        try {
+          const headers = getHeaders(req);
+
+          // Some error types (e.g. GraphQL ClientError) expose response info.
+          const errorDetails: any = {
+            message: error?.message,
+            name: error?.name,
+            stack: error?.stack
           };
+
+          if (error?.response) {
+            errorDetails.response = {
+              status: error.response.status,
+              statusText: error.response.statusText,
+              errors: error.response.errors,
+              data: error.response.data
+            };
+          }
+
+          logger.error('Function error', {
+            headers,
+            path: req.originalUrl || req.url,
+            error: errorDetails
+          });
+        } catch {
+          // never throw from the error logger
         }
 
-        // eslint-disable-next-line no-console
-        console.error('[knative-job-fn] Function error', {
-          headers,
-          path: req.originalUrl || req.url,
-          error: errorDetails
-        });
-      } catch {
-        // never throw from the error logger
-      }
+        res.status(200).json({ message: error.message });
+      });
 
-      res.status(200).json({ message: error.message });
-    });
-    app.listen(port, cb);
-  }
+      const host = typeof hostOrCb === 'string' ? hostOrCb : undefined;
+      const callback = typeof hostOrCb === 'function' ? hostOrCb : cb;
+      const onListen = () => {
+        callback();
+      };
+      const server = host
+        ? app.listen(port, host, onListen)
+        : app.listen(port, onListen);
+
+      return server;
+    }
+  };
 };
+
+const defaultApp = createJobApp();
+
+export { createJobApp };
+export default defaultApp;