@constructive-io/job-scheduler 0.3.22 → 0.4.1

package/README.md

@@ -1 +1,59 @@
-# job-scheduler
+# job-scheduler
+
+---
+
+## 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,224 @@
+import * as jobs from '@constructive-io/job-utils';
+import schedule from 'node-schedule';
+import poolManager from '@constructive-io/job-pg';
+import { Logger } from '@pgpmjs/logger';
+const log = new Logger('jobs:scheduler');
+export default class Scheduler {
+    idleDelay;
+    supportedTaskNames;
+    workerId;
+    doNextTimer;
+    pgPool;
+    jobs;
+    _initialized;
+    listenClient;
+    listenRelease;
+    stopped;
+    constructor({ tasks, idleDelay = 15000, pgPool = poolManager.getPool(), workerId = 'scheduler-0' }) {
+        /*
+         * idleDelay: This is how long to wait between polling for jobs.
+         *
+         * Note: this does NOT need to be short, because we use LISTEN/NOTIFY to be
+         * notified when new jobs are added - this is just used in the case where
+         * LISTEN/NOTIFY fails for whatever reason.
+         */
+        this.idleDelay = idleDelay;
+        this.supportedTaskNames = tasks;
+        this.workerId = workerId;
+        this.doNextTimer = undefined;
+        this.pgPool = pgPool;
+        this.jobs = {};
+        poolManager.onClose(async () => {
+            await jobs.releaseScheduledJobs(pgPool, {
+                workerId: this.workerId,
+                // When ids is omitted the DB function releases all scheduled jobs
+                ids: undefined
+            });
+        });
+    }
+    async initialize(client) {
+        if (this._initialized === true)
+            return;
+        await jobs.releaseScheduledJobs(client, {
+            workerId: this.workerId,
+            // When ids is omitted the DB function releases all scheduled jobs
+            ids: undefined
+        });
+        this._initialized = true;
+        await this.doNext(client);
+    }
+    async handleFatalError(client, { err, fatalError, jobId }) {
+        const when = err ? `after failure '${err.message}'` : 'after success';
+        log.error(`Failed to release job '${jobId}' ${when}; committing seppuku`);
+        log.error(String(fatalError));
+        await poolManager.close();
+        process.exit(1);
+    }
+    async handleError(client, { err, job, duration }) {
+        log.error(`Failed to initialize scheduler for ${job.id} (${job.task_identifier}) with error ${err.message} (${duration}ms)`);
+        const j = this.jobs[job.id];
+        if (j)
+            j.cancel();
+        await jobs.releaseScheduledJobs(client, {
+            workerId: this.workerId,
+            ids: [job.id]
+        });
+    }
+    async handleSuccess(client, { job, duration }) {
+        log.info(`initialized ${job.id} (${job.task_identifier}) with success (${duration}ms)`);
+    }
+    async scheduleJob(client, job) {
+        const { id, task_identifier, schedule_info } = job;
+        const j = schedule.scheduleJob(schedule_info, async () => {
+            const newjob = (await jobs.runScheduledJob(client, {
+                jobId: id
+            }));
+            if (newjob) {
+                if (newjob.id) {
+                    log.info(`spinning up job[${newjob.task_identifier}]`);
+                }
+                else {
+                    // this means the scheduled_job has been deleted from db, so cancel it
+                    log.info(`attempted job[${job.task_identifier}] but it's probably non existent, unscheduling...`);
+                    const scheduledJob = this.jobs[job.id];
+                    if (scheduledJob)
+                        scheduledJob.cancel();
+                }
+            }
+            else {
+                log.info(`job already scheduled but not yet run or complete: [${job.task_identifier}]`);
+            }
+        });
+        this.jobs[id] = j;
+    }
+    async doNext(client) {
+        if (this.stopped)
+            return;
+        if (!this._initialized) {
+            return await this.initialize(client);
+        }
+        if (this.doNextTimer) {
+            clearTimeout(this.doNextTimer);
+            this.doNextTimer = undefined;
+        }
+        try {
+            const job = await jobs.getScheduledJob(client, {
+                workerId: this.workerId,
+                supportedTaskNames: jobs.getJobSupportAny()
+                    ? null
+                    : this.supportedTaskNames
+            });
+            if (!job || !job.id) {
+                if (!this.stopped) {
+                    this.doNextTimer = setTimeout(() => this.doNext(client), this.idleDelay);
+                }
+                return;
+            }
+            const start = process.hrtime();
+            let err = null;
+            try {
+                await this.scheduleJob(client, job);
+            }
+            catch (error) {
+                err = error;
+            }
+            const durationRaw = process.hrtime(start);
+            const duration = ((durationRaw[0] * 1e9 + durationRaw[1]) / 1e6).toFixed(2);
+            const jobId = job.id;
+            try {
+                if (err) {
+                    await this.handleError(client, { err, job, duration });
+                }
+                else {
+                    await this.handleSuccess(client, { job, duration });
+                }
+            }
+            catch (fatalError) {
+                await this.handleFatalError(client, { err, fatalError, jobId });
+            }
+            if (!this.stopped) {
+                return this.doNext(client);
+            }
+            return;
+        }
+        catch (err) {
+            if (!this.stopped) {
+                this.doNextTimer = setTimeout(() => this.doNext(client), this.idleDelay);
+            }
+        }
+    }
+    listen() {
+        if (this.stopped)
+            return;
+        const listenForChanges = (err, client, release) => {
+            if (err) {
+                log.error('Error connecting with notify listener', err);
+                if (err instanceof Error && err.stack) {
+                    log.debug(err.stack);
+                }
+                // Try again in 5 seconds
+                // should this really be done in the node process?
+                if (!this.stopped) {
+                    setTimeout(this.listen, 5000);
+                }
+                return;
+            }
+            if (this.stopped) {
+                release();
+                return;
+            }
+            this.listenClient = client;
+            this.listenRelease = release;
+            client.on('notification', () => {
+                log.info('a NEW scheduled JOB!');
+                if (this.doNextTimer) {
+                    // Must be idle, do something!
+                    this.doNext(client);
+                }
+            });
+            client.query('LISTEN "scheduled_jobs:insert"');
+            client.on('error', (e) => {
+                if (this.stopped) {
+                    release();
+                    return;
+                }
+                log.error('Error with database notify listener', e);
+                if (e instanceof Error && e.stack) {
+                    log.debug(e.stack);
+                }
+                release();
+                if (!this.stopped) {
+                    this.listen();
+                }
+            });
+            log.info(`${this.workerId} connected and looking for scheduled jobs...`);
+            this.doNext(client);
+        };
+        this.pgPool.connect(listenForChanges);
+    }
+    async stop() {
+        this.stopped = true;
+        if (this.doNextTimer) {
+            clearTimeout(this.doNextTimer);
+            this.doNextTimer = undefined;
+        }
+        Object.values(this.jobs).forEach((job) => job.cancel());
+        this.jobs = {};
+        const client = this.listenClient;
+        const release = this.listenRelease;
+        this.listenClient = undefined;
+        this.listenRelease = undefined;
+        if (client && release) {
+            client.removeAllListeners('notification');
+            client.removeAllListeners('error');
+            try {
+                await client.query('UNLISTEN "scheduled_jobs:insert"');
+            }
+            catch {
+                // Ignore listener cleanup errors during shutdown.
+            }
+            release();
+        }
+    }
+}
+export { Scheduler };

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

@@ -1,18 +1,11 @@
 #!/usr/bin/env node
-
 import Scheduler from './index';
 import poolManager from '@constructive-io/job-pg';
-import {
-  getSchedulerHostname,
-  getJobSupported
-} from '@constructive-io/job-utils';
-
+import { getSchedulerHostname, getJobSupported } from '@constructive-io/job-utils';
 const pgPool = poolManager.getPool();
-
 const scheduler = new Scheduler({
-  pgPool,
-  workerId: getSchedulerHostname(),
-  tasks: getJobSupported()
+    pgPool,
+    workerId: getSchedulerHostname(),
+    tasks: getJobSupported()
 });
-
 scheduler.listen();

package/{dist/index.d.ts → index.d.ts}

@@ -1,5 +1,5 @@
 import type { PgClientLike } from '@constructive-io/job-utils';
-import type { Pool } from 'pg';
+import type { Pool, PoolClient } from 'pg';
 export interface ScheduledJobRow {
     id: number | string;
     task_identifier: string;
@@ -16,6 +16,9 @@ export default class Scheduler {
     pgPool: Pool;
     jobs: Record<ScheduledJobRow['id'], SchedulerJobHandle>;
     _initialized?: boolean;
+    listenClient?: PoolClient;
+    listenRelease?: () => void;
+    stopped?: boolean;
     constructor({ tasks, idleDelay, pgPool, workerId }: {
         tasks: string[];
         idleDelay?: number;
@@ -40,5 +43,6 @@ export default class Scheduler {
     scheduleJob(client: PgClientLike, job: ScheduledJobRow): Promise<void>;
     doNext(client: PgClientLike): Promise<void>;
     listen(): void;
+    stop(): Promise<void>;
 }
 export { Scheduler };

package/{dist/index.js → index.js}

@@ -50,6 +50,9 @@ class Scheduler {
     pgPool;
     jobs;
     _initialized;
+    listenClient;
+    listenRelease;
+    stopped;
     constructor({ tasks, idleDelay = 15000, pgPool = job_pg_1.default.getPool(), workerId = 'scheduler-0' }) {
         /*
          * idleDelay: This is how long to wait between polling for jobs.
@@ -128,6 +131,8 @@ class Scheduler {
         this.jobs[id] = j;
     }
     async doNext(client) {
+        if (this.stopped)
+            return;
         if (!this._initialized) {
             return await this.initialize(client);
         }
@@ -143,7 +148,9 @@ class Scheduler {
                     : this.supportedTaskNames
             });
             if (!job || !job.id) {
-                this.doNextTimer = setTimeout(() => this.doNext(client), this.idleDelay);
+                if (!this.stopped) {
+                    this.doNextTimer = setTimeout(() => this.doNext(client), this.idleDelay);
+                }
                 return;
             }
             const start = process.hrtime();
@@ -168,13 +175,20 @@ class Scheduler {
             catch (fatalError) {
                 await this.handleFatalError(client, { err, fatalError, jobId });
             }
-            return this.doNext(client);
+            if (!this.stopped) {
+                return this.doNext(client);
+            }
+            return;
         }
         catch (err) {
-            this.doNextTimer = setTimeout(() => this.doNext(client), this.idleDelay);
+            if (!this.stopped) {
+                this.doNextTimer = setTimeout(() => this.doNext(client), this.idleDelay);
+            }
         }
     }
     listen() {
+        if (this.stopped)
+            return;
         const listenForChanges = (err, client, release) => {
             if (err) {
                 log.error('Error connecting with notify listener', err);
@@ -183,9 +197,17 @@ class Scheduler {
                 }
                 // Try again in 5 seconds
                 // should this really be done in the node process?
-                setTimeout(this.listen, 5000);
+                if (!this.stopped) {
+                    setTimeout(this.listen, 5000);
+                }
+                return;
+            }
+            if (this.stopped) {
+                release();
                 return;
             }
+            this.listenClient = client;
+            this.listenRelease = release;
             client.on('notification', () => {
                 log.info('a NEW scheduled JOB!');
                 if (this.doNextTimer) {
@@ -195,18 +217,48 @@ class Scheduler {
             });
             client.query('LISTEN "scheduled_jobs:insert"');
             client.on('error', (e) => {
+                if (this.stopped) {
+                    release();
+                    return;
+                }
                 log.error('Error with database notify listener', e);
                 if (e instanceof Error && e.stack) {
                     log.debug(e.stack);
                 }
                 release();
-                this.listen();
+                if (!this.stopped) {
+                    this.listen();
+                }
             });
             log.info(`${this.workerId} connected and looking for scheduled jobs...`);
             this.doNext(client);
         };
         this.pgPool.connect(listenForChanges);
     }
+    async stop() {
+        this.stopped = true;
+        if (this.doNextTimer) {
+            clearTimeout(this.doNextTimer);
+            this.doNextTimer = undefined;
+        }
+        Object.values(this.jobs).forEach((job) => job.cancel());
+        this.jobs = {};
+        const client = this.listenClient;
+        const release = this.listenRelease;
+        this.listenClient = undefined;
+        this.listenRelease = undefined;
+        if (client && release) {
+            client.removeAllListeners('notification');
+            client.removeAllListeners('error');
+            try {
+                await client.query('UNLISTEN "scheduled_jobs:insert"');
+            }
+            catch {
+                // Ignore listener cleanup errors during shutdown.
+            }
+            release();
+        }
+    }
 }
 exports.default = Scheduler;
 exports.Scheduler = Scheduler;

package/package.json

@@ -1,17 +1,20 @@
 {
   "name": "@constructive-io/job-scheduler",
-  "version": "0.3.22",
+  "version": "0.4.1",
   "description": "job scheduler",
   "author": "Constructive <developers@constructive.io>",
   "homepage": "https://github.com/constructive-io/jobs/tree/master/packages/job-scheduler#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__"
   },
   "publishConfig": {
-    "access": "public"
+    "access": "public",
+    "directory": "dist"
   },
   "repository": {
     "type": "git",
@@ -21,17 +24,22 @@
     "test": "jest --passWithNoTests",
     "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"
+    "clean": "makage clean",
+    "prepack": "npm run build",
+    "build": "makage build",
+    "build:dev": "makage build --dev"
   },
   "bugs": {
     "url": "https://github.com/constructive-io/jobs/issues"
   },
+  "devDependencies": {
+    "makage": "^0.1.10"
+  },
   "dependencies": {
-    "@constructive-io/job-pg": "^0.3.20",
-    "@constructive-io/job-utils": "^0.5.15",
-    "@pgpmjs/logger": "^1.3.7",
+    "@constructive-io/job-pg": "^0.4.1",
+    "@constructive-io/job-utils": "^0.6.1",
+    "@pgpmjs/logger": "^1.4.0",
     "node-schedule": "1.3.2"
   },
-  "gitHead": "cb4af2cf6c23dad24cd951c232d3e2006b81aa3d"
+  "gitHead": "3ffd5718e86ea5fa9ca6e0930aeb510cf392f343"
 }

package/CHANGELOG.md

@@ -1,72 +0,0 @@
-# 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.22](https://github.com/constructive-io/jobs/compare/@constructive-io/job-scheduler@0.3.21...@constructive-io/job-scheduler@0.3.22) (2026-01-09)
-
-**Note:** Version bump only for package @constructive-io/job-scheduler
-
-## [0.3.21](https://github.com/constructive-io/jobs/compare/@constructive-io/job-scheduler@0.3.20...@constructive-io/job-scheduler@0.3.21) (2026-01-07)
-
-**Note:** Version bump only for package @constructive-io/job-scheduler
-
-## [0.3.20](https://github.com/constructive-io/jobs/compare/@constructive-io/job-scheduler@0.3.19...@constructive-io/job-scheduler@0.3.20) (2026-01-02)
-
-**Note:** Version bump only for package @constructive-io/job-scheduler
-
-## [0.3.19](https://github.com/constructive-io/jobs/compare/@constructive-io/job-scheduler@0.3.18...@constructive-io/job-scheduler@0.3.19) (2026-01-02)
-
-**Note:** Version bump only for package @constructive-io/job-scheduler
-
-## [0.3.18](https://github.com/constructive-io/jobs/compare/@constructive-io/job-scheduler@0.3.17...@constructive-io/job-scheduler@0.3.18) (2025-12-31)
-
-**Note:** Version bump only for package @constructive-io/job-scheduler
-
-## [0.3.17](https://github.com/constructive-io/jobs/compare/@constructive-io/job-scheduler@0.3.16...@constructive-io/job-scheduler@0.3.17) (2025-12-31)
-
-**Note:** Version bump only for package @constructive-io/job-scheduler
-
-## [0.3.16](https://github.com/constructive-io/jobs/compare/@constructive-io/job-scheduler@0.3.15...@constructive-io/job-scheduler@0.3.16) (2025-12-27)
-
-**Note:** Version bump only for package @constructive-io/job-scheduler
-
-## [0.3.15](https://github.com/constructive-io/jobs/compare/@constructive-io/job-scheduler@0.3.14...@constructive-io/job-scheduler@0.3.15) (2025-12-26)
-
-**Note:** Version bump only for package @constructive-io/job-scheduler
-
-## [0.3.14](https://github.com/constructive-io/jobs/compare/@constructive-io/job-scheduler@0.3.13...@constructive-io/job-scheduler@0.3.14) (2025-12-26)
-
-**Note:** Version bump only for package @constructive-io/job-scheduler
-
-## [0.3.13](https://github.com/constructive-io/jobs/compare/@constructive-io/job-scheduler@0.3.12...@constructive-io/job-scheduler@0.3.13) (2025-12-24)
-
-**Note:** Version bump only for package @constructive-io/job-scheduler
-
-## [0.3.12](https://github.com/constructive-io/jobs/compare/@constructive-io/job-scheduler@0.3.11...@constructive-io/job-scheduler@0.3.12) (2025-12-23)
-
-**Note:** Version bump only for package @constructive-io/job-scheduler
-
-## [0.3.11](https://github.com/constructive-io/jobs/compare/@constructive-io/job-scheduler@0.3.10...@constructive-io/job-scheduler@0.3.11) (2025-12-22)
-
-**Note:** Version bump only for package @constructive-io/job-scheduler
-
-## [0.3.10](https://github.com/constructive-io/jobs/compare/@constructive-io/job-scheduler@0.3.9...@constructive-io/job-scheduler@0.3.10) (2025-12-22)
-
-**Note:** Version bump only for package @constructive-io/job-scheduler
-
-## [0.3.9](https://github.com/constructive-io/jobs/compare/@constructive-io/job-scheduler@0.3.8...@constructive-io/job-scheduler@0.3.9) (2025-12-21)
-
-**Note:** Version bump only for package @constructive-io/job-scheduler
-
-## [0.3.8](https://github.com/constructive-io/jobs/compare/@constructive-io/job-scheduler@0.3.7...@constructive-io/job-scheduler@0.3.8) (2025-12-19)
-
-**Note:** Version bump only for package @constructive-io/job-scheduler
-
-## 0.3.7 (2025-12-18)
-
-**Note:** Version bump only for package @constructive-io/job-scheduler
-
-## [0.3.6](https://github.com/constructive-io/jobs/compare/@constructive-io/job-scheduler@0.3.5...@constructive-io/job-scheduler@0.3.6) (2025-12-17)
-
-**Note:** Version bump only for package @constructive-io/job-scheduler

package/jest.config.js

@@ -1,18 +0,0 @@
-/** @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/src/index.ts

@@ -1,229 +0,0 @@
-import * as jobs from '@constructive-io/job-utils';
-import type { PgClientLike } from '@constructive-io/job-utils';
-import schedule from 'node-schedule';
-import poolManager from '@constructive-io/job-pg';
-import type { Pool, PoolClient } from 'pg';
-import { Logger } from '@pgpmjs/logger';
-
-export interface ScheduledJobRow {
-  id: number | string;
-  task_identifier: string;
-  schedule_info: unknown;
-}
-
-interface SchedulerJobHandle {
-  cancel(): void;
-}
-
-const log = new Logger('jobs:scheduler');
-
-export default class Scheduler {
-  idleDelay: number;
-  supportedTaskNames: string[];
-  workerId: string;
-  doNextTimer?: NodeJS.Timeout;
-  pgPool: Pool;
-  jobs: Record<ScheduledJobRow['id'], SchedulerJobHandle>;
-  _initialized?: boolean;
-
-  constructor({
-    tasks,
-    idleDelay = 15000,
-    pgPool = poolManager.getPool(),
-    workerId = 'scheduler-0'
-  }: {
-    tasks: string[];
-    idleDelay?: number;
-    pgPool?: Pool;
-    workerId?: string;
-  }) {
-    /*
-     * idleDelay: This is how long to wait between polling for jobs.
-     *
-     * Note: this does NOT need to be short, because we use LISTEN/NOTIFY to be
-     * notified when new jobs are added - this is just used in the case where
-     * LISTEN/NOTIFY fails for whatever reason.
-     */
-    this.idleDelay = idleDelay;
-    this.supportedTaskNames = tasks;
-    this.workerId = workerId;
-    this.doNextTimer = undefined;
-    this.pgPool = pgPool;
-    this.jobs = {};
-    poolManager.onClose(async () => {
-      await jobs.releaseScheduledJobs(pgPool, {
-        workerId: this.workerId,
-        // When ids is omitted the DB function releases all scheduled jobs
-        ids: undefined as unknown as Array<number | string>
-      });
-    });
-  }
-  async initialize(client: PgClientLike) {
-    if (this._initialized === true) return;
-    await jobs.releaseScheduledJobs(client, {
-      workerId: this.workerId,
-      // When ids is omitted the DB function releases all scheduled jobs
-      ids: undefined as unknown as Array<number | string>
-    });
-    this._initialized = true;
-    await this.doNext(client);
-  }
-  async handleFatalError(
-    client: PgClientLike,
-    {
-      err,
-      fatalError,
-      jobId
-    }: { err?: Error; fatalError: unknown; jobId: ScheduledJobRow['id'] }
-  ) {
-    const when = err ? `after failure '${err.message}'` : 'after success';
-    log.error(`Failed to release job '${jobId}' ${when}; committing seppuku`);
-    log.error(String(fatalError));
-    await poolManager.close();
-    process.exit(1);
-  }
-  async handleError(
-    client: PgClientLike,
-    {
-      err,
-      job,
-      duration
-    }: { err: Error; job: ScheduledJobRow; duration: string }
-  ) {
-    log.error(
-      `Failed to initialize scheduler for ${job.id} (${job.task_identifier}) with error ${err.message} (${duration}ms)`
-    );
-    const j = this.jobs[job.id];
-    if (j) j.cancel();
-    await jobs.releaseScheduledJobs(client, {
-      workerId: this.workerId,
-      ids: [job.id]
-    });
-  }
-  async handleSuccess(
-    client: PgClientLike,
-    { job, duration }: { job: ScheduledJobRow; duration: string }
-  ) {
-    log.info(
-      `initialized ${job.id} (${job.task_identifier}) with success (${duration}ms)`
-    );
-  }
-  async scheduleJob(client: PgClientLike, job: ScheduledJobRow) {
-    const { id, task_identifier, schedule_info } = job;
-    const j = schedule.scheduleJob(schedule_info as never, async () => {
-      const newjob = (await jobs.runScheduledJob(client, {
-        jobId: id
-      })) as ScheduledJobRow | null;
-
-      if (newjob) {
-        if (newjob.id) {
-          log.info(`spinning up job[${newjob.task_identifier}]`);
-        } else {
-          // this means the scheduled_job has been deleted from db, so cancel it
-          log.info(
-            `attempted job[${job.task_identifier}] but it's probably non existent, unscheduling...`
-          );
-          const scheduledJob = this.jobs[job.id];
-          if (scheduledJob) scheduledJob.cancel();
-        }
-      } else {
-        log.info(
-          `job already scheduled but not yet run or complete: [${job.task_identifier}]`
-        );
-      }
-    });
-    this.jobs[id] = j as SchedulerJobHandle;
-  }
-  async doNext(client: PgClientLike): Promise<void> {
-    if (!this._initialized) {
-      return await this.initialize(client);
-    }
-
-    if (this.doNextTimer) {
-      clearTimeout(this.doNextTimer);
-      this.doNextTimer = undefined;
-    }
-    try {
-      const job = await jobs.getScheduledJob<ScheduledJobRow>(client, {
-        workerId: this.workerId,
-        supportedTaskNames: jobs.getJobSupportAny()
-          ? null
-          : this.supportedTaskNames
-      });
-      if (!job || !job.id) {
-        this.doNextTimer = setTimeout(
-          () => this.doNext(client),
-          this.idleDelay
-        );
-        return;
-      }
-      const start = process.hrtime();
-
-      let err: Error | null = null;
-      try {
-        await this.scheduleJob(client, job);
-      } catch (error) {
-        err = error as Error;
-      }
-
-      const durationRaw = process.hrtime(start);
-      const duration = ((durationRaw[0] * 1e9 + durationRaw[1]) / 1e6).toFixed(
-        2
-      );
-      const jobId = job.id;
-      try {
-        if (err) {
-          await this.handleError(client, { err, job, duration });
-        } else {
-          await this.handleSuccess(client, { job, duration });
-        }
-      } catch (fatalError: unknown) {
-        await this.handleFatalError(client, { err, fatalError, jobId });
-      }
-      return this.doNext(client);
-    } catch (err: unknown) {
-      this.doNextTimer = setTimeout(() => this.doNext(client), this.idleDelay);
-    }
-  }
-  listen() {
-    const listenForChanges = (
-      err: Error | null,
-      client: PoolClient,
-      release: () => void
-    ) => {
-      if (err) {
-        log.error('Error connecting with notify listener', err);
-        if (err instanceof Error && err.stack) {
-          log.debug(err.stack);
-        }
-        // Try again in 5 seconds
-        // should this really be done in the node process?
-        setTimeout(this.listen, 5000);
-        return;
-      }
-      client.on('notification', () => {
-        log.info('a NEW scheduled JOB!');
-        if (this.doNextTimer) {
-          // Must be idle, do something!
-          this.doNext(client);
-        }
-      });
-      client.query('LISTEN "scheduled_jobs:insert"');
-      client.on('error', (e: unknown) => {
-        log.error('Error with database notify listener', e);
-        if (e instanceof Error && e.stack) {
-          log.debug(e.stack);
-        }
-        release();
-        this.listen();
-      });
-      log.info(
-        `${this.workerId} connected and looking for scheduled jobs...`
-      );
-      this.doNext(client);
-    };
-    this.pgPool.connect(listenForChanges);
-  }
-}
-
-export { Scheduler };

package/tsconfig.esm.json

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

package/tsconfig.json

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