@arkstack/jobs 0.18.3 → 0.18.4

package/dist/{bridge-BtIHRRM7.js → bridge-2bzbP44n.js}

@@ -1,17 +1,24 @@
 import { Queue } from "@arkstack/queue";
 import { randomUUID } from "node:crypto";
 //#region src/JobRegistry.ts
+const REGISTRY = Symbol.for("arkstack.jobs.registry");
+const registry = () => {
+	const store = globalThis;
+	return store[REGISTRY] ??= /* @__PURE__ */ new Map();
+};
 /**
 * A registry mapping job names to their classes so a worker can reconstruct job
 * instances from a stored payload.
 *
 * Job classes register themselves when instantiated, which covers same-process
-* dispatch + work. For dedicated worker processes, ensure the job modules are
-* imported (or call {@link JobRegistry.register} explicitly) so the names are
-* known before jobs are processed.
+* dispatch + work. A dedicated worker process constructs none of them, so
+* `queue:work` calls {@link loadJobs} to import the application's job modules
+* before it starts working.
 */
 var JobRegistry = class {
-	static classes = /* @__PURE__ */ new Map();
+	static get classes() {
+		return registry();
+	}
 	/**
 	* Register a job class under an explicit name (defaults to the class name).
 	*/

package/dist/commands/MakeJobCommand.js

@@ -1,7 +1,7 @@
-import { mkdir, writeFile } from "node:fs/promises";
+import { dirname, resolve } from "node:path";
 import { Arkstack } from "@arkstack/contract";
+import { mkdir, writeFile } from "node:fs/promises";
 import { Command } from "@h3ravel/musket";
-import { dirname, resolve } from "node:path";
 //#region src/commands/MakeJobCommand.ts
 /**
 * Generate a new dispatchable job class.

package/dist/index.d.ts

@@ -106,12 +106,12 @@ interface DispatchOptions {
  * instances from a stored payload.
  *
  * Job classes register themselves when instantiated, which covers same-process
- * dispatch + work. For dedicated worker processes, ensure the job modules are
- * imported (or call {@link JobRegistry.register} explicitly) so the names are
- * known before jobs are processed.
+ * dispatch + work. A dedicated worker process constructs none of them, so
+ * `queue:work` calls {@link loadJobs} to import the application's job modules
+ * before it starts working.
  */
 declare class JobRegistry {
-  private static classes;
+  private static get classes();
   /**
    * Register a job class under an explicit name (defaults to the class name).
    */
@@ -153,6 +153,23 @@ declare class JobRegistry {
  */
 declare const dispatch: <T extends Job>(job: T, options?: DispatchOptions) => PendingDispatch<T>;
 //#endregion
+//#region src/loader.d.ts
+/**
+ * Import the application's job classes so a worker can reconstruct them.
+ *
+ * A dedicated `queue:work` process never constructs the app's jobs itself, and
+ * a job class only reaches the {@link JobRegistry} when its module is loaded —
+ * without this a worker cannot resolve a single payload it pops, and every job
+ * is released back onto the queue until it exhausts its attempts.
+ *
+ * Every concrete `Job` subclass a module exports is registered under its class
+ * name, which is the name payloads are serialized with.
+ *
+ * @param subPath  Directory (under `src/`, or the build output) to load from.
+ * @returns        The names registered, in discovery order.
+ */
+declare const loadJobs: (subPath?: string) => Promise<string[]>;
+//#endregion
 //#region src/bridge.d.ts
 /**
  * Wire `@arkstack/jobs` into `@arkstack/queue` by registering how jobs are
@@ -163,4 +180,4 @@ declare const dispatch: <T extends Job>(job: T, options?: DispatchOptions) => Pe
  */
 declare const registerJobsWithQueue: () => void;
 //#endregion
-export { DispatchOptions, Job, JobConstructor, JobRegistry, PendingDispatch, dispatch, registerJobsWithQueue };
+export { DispatchOptions, Job, JobConstructor, JobRegistry, PendingDispatch, dispatch, loadJobs, registerJobsWithQueue };

package/dist/index.js

@@ -1,4 +1,8 @@
-import { i as JobRegistry, n as Job, r as PendingDispatch, t as registerJobsWithQueue } from "./bridge-BtIHRRM7.js";
+import { i as JobRegistry, n as Job, r as PendingDispatch, t as registerJobsWithQueue } from "./bridge-2bzbP44n.js";
+import { importFile, nodeEnv, outputDir } from "@arkstack/common";
+import path, { join } from "node:path";
+import { Arkstack } from "@arkstack/contract";
+import { readdirSync } from "node:fs";
 //#region src/dispatch.ts
 /**
 * Dispatch a job instance onto a queue.
@@ -20,7 +24,60 @@ const dispatch = (job, options = {}) => {
 	return pending;
 };
 //#endregion
+//#region src/loader.ts
+/**
+* Whether a module export is a runnable job class.
+*
+* The test is `handle` on the prototype rather than `instanceof Job`: a job
+* module loaded through jiti carries its own copy of the base class, so an
+* identity check would reject every job it finds. An abstract base declares no
+* `handle` of its own and is skipped.
+*/
+const isJobClass = (value) => typeof value === "function" && typeof value.prototype?.handle === "function";
+/** The job modules in the first candidate directory that has any. */
+const jobFiles = (directories) => {
+	for (const directory of directories) try {
+		const files = readdirSync(directory, { withFileTypes: true }).filter((file) => file.isFile() && [
+			".ts",
+			".js",
+			".mjs"
+		].includes(path.extname(file.name)));
+		if (files.length) return [directory, files];
+	} catch {}
+	return ["", []];
+};
+/**
+* Import the application's job classes so a worker can reconstruct them.
+*
+* A dedicated `queue:work` process never constructs the app's jobs itself, and
+* a job class only reaches the {@link JobRegistry} when its module is loaded —
+* without this a worker cannot resolve a single payload it pops, and every job
+* is released back onto the queue until it exhausts its attempts.
+*
+* Every concrete `Job` subclass a module exports is registered under its class
+* name, which is the name payloads are serialized with.
+*
+* @param subPath  Directory (under `src/`, or the build output) to load from.
+* @returns        The names registered, in discovery order.
+*/
+const loadJobs = async (subPath = join("app", "jobs")) => {
+	const root = Arkstack.rootDir();
+	const [directory, files] = jobFiles(nodeEnv() === "prod" ? [join(outputDir(), subPath), join(root, "src", subPath)] : [join(root, "src", subPath), join(outputDir(), subPath)]);
+	const registered = [];
+	for (const file of files) try {
+		const module = await importFile(join(directory, file.name));
+		for (const value of Object.values(module)) {
+			if (!isJobClass(value)) continue;
+			JobRegistry.register(value);
+			registered.push(value.name);
+		}
+	} catch {
+		continue;
+	}
+	return registered;
+};
+//#endregion
 //#region src/index.ts
 registerJobsWithQueue();
 //#endregion
-export { Job, JobRegistry, PendingDispatch, dispatch, registerJobsWithQueue };
+export { Job, JobRegistry, PendingDispatch, dispatch, loadJobs, registerJobsWithQueue };

package/dist/setup.js

@@ -1,4 +1,4 @@
-import { t as registerJobsWithQueue } from "./bridge-BtIHRRM7.js";
+import { t as registerJobsWithQueue } from "./bridge-2bzbP44n.js";
 //#region src/setup.ts
 /**
 * Boot the jobs/queue integration. Import this from your application bootstrap:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arkstack/jobs",
-  "version": "0.18.3",
+  "version": "0.18.4",
   "type": "module",
   "description": "Jobs module for Arkstack, providing dispatchable job classes and a dispatcher on top of @arkstack/queue.",
   "homepage": "https://arkstack.toneflix.net/guide/jobs",
@@ -32,12 +32,12 @@
     "./package.json": "./package.json"
   },
   "dependencies": {
-    "@arkstack/queue": "^0.18.3",
-    "@arkstack/common": "^0.18.3"
+    "@arkstack/common": "^0.18.4",
+    "@arkstack/queue": "^0.18.4"
   },
   "peerDependencies": {
     "@h3ravel/musket": "^2.2.13",
-    "@arkstack/contract": "^0.18.3"
+    "@arkstack/contract": "^0.18.4"
   },
   "scripts": {
     "build": "tsdown",