@redmix/jobs 0.0.1

package/dist/loaders.js

@@ -0,0 +1,71 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var loaders_exports = {};
+__export(loaders_exports, {
+  loadJob: () => loadJob,
+  loadJobsManager: () => loadJobsManager
+});
+module.exports = __toCommonJS(loaders_exports);
+var import_node_fs = __toESM(require("node:fs"));
+var import_node_path = __toESM(require("node:path"));
+var import_project_config = require("@redmix/project-config");
+var import_errors = require("./errors.js");
+var import_util = require("./util.js");
+const loadJobsManager = async () => {
+  const jobsConfigPath = (0, import_project_config.getPaths)().api.distJobsConfig;
+  if (!jobsConfigPath) {
+    throw new import_errors.JobsLibNotFoundError();
+  }
+  const importPath = (0, import_util.makeFilePath)(jobsConfigPath);
+  const { jobs } = await import(importPath);
+  if (!jobs) {
+    throw new import_errors.JobsLibNotFoundError();
+  }
+  return jobs;
+};
+const loadJob = async ({
+  name: jobName,
+  path: jobPath
+}) => {
+  const completeJobPath = import_node_path.default.join((0, import_project_config.getPaths)().api.distJobs, jobPath) + ".js";
+  if (!import_node_fs.default.existsSync(completeJobPath)) {
+    throw new import_errors.JobNotFoundError(jobName);
+  }
+  const importPath = (0, import_util.makeFilePath)(completeJobPath);
+  const jobModule = await import(importPath);
+  if (!jobModule[jobName]) {
+    throw new import_errors.JobNotFoundError(jobName);
+  }
+  return jobModule[jobName];
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  loadJob,
+  loadJobsManager
+});

package/dist/setupEnv.d.ts

@@ -0,0 +1,2 @@
+export declare const setupEnv: () => void;
+//# sourceMappingURL=setupEnv.d.ts.map

package/dist/setupEnv.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"setupEnv.d.ts","sourceRoot":"","sources":["../src/setupEnv.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,QAAQ,YAQpB,CAAA"}

package/dist/setupEnv.js

@@ -0,0 +1,34 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var setupEnv_exports = {};
+__export(setupEnv_exports, {
+  setupEnv: () => setupEnv
+});
+module.exports = __toCommonJS(setupEnv_exports);
+var import_loadEnvFiles = require("@redmix/cli-helpers/loadEnvFiles");
+const setupEnv = () => {
+  (0, import_loadEnvFiles.loadEnvFiles)();
+  if (process.env.NODE_ENV === void 0) {
+    process.env.NODE_ENV = "development";
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  setupEnv
+});

package/dist/types.d.ts

@@ -0,0 +1,175 @@
+import type { IntRange } from 'type-fest';
+import type { BaseAdapter } from './adapters/BaseAdapter/BaseAdapter.js';
+/** Redwood's logger and the standard console logger conform to this shape. */
+export interface BasicLogger {
+    debug: (message?: any, ...optionalParams: any[]) => void;
+    info: (message?: any, ...optionalParams: any[]) => void;
+    warn: (message?: any, ...optionalParams: any[]) => void;
+    error: (message?: any, ...optionalParams: any[]) => void;
+}
+/**
+ *This is the minimum interface that a "job" must conform to in order to be
+ * scheduled and executed by Redwood's job engine.
+ */
+export interface BaseJob {
+    id: string | number;
+    name: string;
+    path: string;
+    args: unknown[];
+    attempts: number;
+}
+export type PossibleBaseJob = BaseJob | undefined;
+export type Adapters = Record<string, BaseAdapter>;
+export type QueueNames = readonly [string, ...string[]];
+export interface WorkerConfig<TAdapters extends Adapters, TQueues extends QueueNames> extends WorkerSharedOptions {
+    /**
+     * The name of the adapter to use for this worker. This must be one of the keys
+     * in the `adapters` object when you created the `JobManager`.
+     */
+    adapter: keyof TAdapters;
+    /**
+     * The queue or queues that this worker should work on. You can pass a single
+     * queue name, an array of queue names, or the string `'*'` to work on all
+     * queues.
+     */
+    queue: '*' | TQueues[number] | TQueues[number][];
+    /**
+     * The number of workers to spawn for this worker configuration.
+     *
+     * @default 1
+     */
+    count?: number;
+    /**
+     * The logger to use for this worker. If not provided, the logger from the
+     * `JobManager` will be used.
+     */
+    logger?: BasicLogger;
+}
+export interface WorkerSharedOptions {
+    /**
+     * The maximum number of retries to attempt for a job before giving up.
+     *
+     * @default 24
+     */
+    maxAttempts?: number;
+    /**
+     * The maximum amount of time in seconds that a job can run before another
+     * worker will attempt to retry it.
+     *
+     * @default 14,400 (4 hours)
+     */
+    maxRuntime?: number;
+    /**
+     * Whether a job that exceeds its `maxAttempts` should be deleted from the
+     * queue. If `false`, the job will remain in the queue but will not be
+     * processed further.
+     *
+     * @default false
+     */
+    deleteFailedJobs?: boolean;
+    /**
+     * Whether to keep succeeded jobs in the database after they have completed
+     * successfully.
+     *
+     * @default true
+     *
+     */
+    deleteSuccessfulJobs?: boolean;
+    /**
+     * The amount of time in seconds to wait between polling the queue for new
+     * jobs. Some adapters may not need this if they do not poll the queue and
+     * instead rely on a subscription model.
+     *
+     * @default 5
+     */
+    sleepDelay?: number;
+}
+export interface JobManagerConfig<TAdapters extends Adapters, TQueues extends QueueNames, TLogger extends BasicLogger> {
+    /**
+     * An object containing all of the adapters that this job manager will use.
+     * The keys should be the names of the adapters and the values should be the
+     * adapter instances.
+     */
+    adapters: TAdapters;
+    /**
+     * The logger to use for this job manager. If not provided, the logger will
+     * default to the console.
+     */
+    logger: TLogger;
+    /**
+     * An array of all of queue names that jobs can be scheduled on to. Workers can
+     * be configured to work on a selection of these queues.
+     *
+     * This should be an array of string literals.
+     * If you're using TypeScript, you can use `as const`, like in
+     * `['default', 'critical', 'low'] as const` to construct an array of string
+     * literals
+     */
+    queues: TQueues;
+    /**
+     * An array of worker configurations that define how jobs should be processed.
+     */
+    workers: WorkerConfig<TAdapters, TQueues>[];
+}
+export interface CreateSchedulerConfig<TAdapters extends Adapters> {
+    /**
+     * The name of the adapter to use for this scheduler. This must be one of the keys
+     * in the `adapters` object when you created the `JobManager`.
+     */
+    adapter: keyof TAdapters;
+    /**
+     * The logger to use for this scheduler. If not provided, the logger from the
+     * `JobManager` will be used.
+     */
+    logger?: BasicLogger;
+}
+export interface JobDefinition<TQueues extends QueueNames, TArgs extends unknown[] = []> {
+    /**
+     * The name of the queue that this job should always be scheduled on. This
+     * must be one of the values in the `queues` array when you created the
+     * `JobManager`.
+     */
+    queue: TQueues[number];
+    /**
+     * The priority of the job in the range of 0-100. The lower the number, the
+     * higher the priority. The default is 50.
+     * @default 50
+     */
+    priority?: PriorityValue;
+    /**
+     * The function to run when this job is executed.
+     *
+     * @param args The arguments that were passed when the job was scheduled.
+     */
+    perform: (...args: TArgs) => Promise<void> | void;
+}
+export type JobComputedProperties = {
+    /**
+     * The name of the job that was defined in the job file.
+     */
+    name: string;
+    /**
+     * The path to the job file that this job was defined in.
+     */
+    path: string;
+};
+export type Job<TQueues extends QueueNames, TArgs extends unknown[] = []> = JobDefinition<TQueues, TArgs> & JobComputedProperties;
+export type ScheduleJobOptions = {
+    /**
+     * The number of seconds to wait before scheduling this job. This is mutually
+     * exclusive with `waitUntil`.
+     */
+    wait: number;
+    waitUntil?: never;
+} | {
+    wait?: never;
+    /**
+     * The date and time to schedule this job for. This is mutually exclusive with
+     * `wait`.
+     */
+    waitUntil: Date;
+};
+type PriorityValue = IntRange<1, 101>;
+export type CreateSchedulerArgs<TJob extends Job<QueueNames>> = Parameters<TJob['perform']> extends [] ? [ScheduleJobOptions?] | [[], ScheduleJobOptions?] : [Parameters<TJob['perform']>, ScheduleJobOptions?];
+export {};
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAA;AAEzC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uCAAuC,CAAA;AAExE,8EAA8E;AAC9E,MAAM,WAAW,WAAW;IAC1B,KAAK,EAAE,CAAC,OAAO,CAAC,EAAE,GAAG,EAAE,GAAG,cAAc,EAAE,GAAG,EAAE,KAAK,IAAI,CAAA;IACxD,IAAI,EAAE,CAAC,OAAO,CAAC,EAAE,GAAG,EAAE,GAAG,cAAc,EAAE,GAAG,EAAE,KAAK,IAAI,CAAA;IACvD,IAAI,EAAE,CAAC,OAAO,CAAC,EAAE,GAAG,EAAE,GAAG,cAAc,EAAE,GAAG,EAAE,KAAK,IAAI,CAAA;IACvD,KAAK,EAAE,CAAC,OAAO,CAAC,EAAE,GAAG,EAAE,GAAG,cAAc,EAAE,GAAG,EAAE,KAAK,IAAI,CAAA;CACzD;AAED;;;GAGG;AACH,MAAM,WAAW,OAAO;IACtB,EAAE,EAAE,MAAM,GAAG,MAAM,CAAA;IACnB,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,OAAO,EAAE,CAAA;IACf,QAAQ,EAAE,MAAM,CAAA;CACjB;AACD,MAAM,MAAM,eAAe,GAAG,OAAO,GAAG,SAAS,CAAA;AAEjD,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,CAAA;AAElD,MAAM,MAAM,UAAU,GAAG,SAAS,CAAC,MAAM,EAAE,GAAG,MAAM,EAAE,CAAC,CAAA;AAEvD,MAAM,WAAW,YAAY,CAC3B,SAAS,SAAS,QAAQ,EAC1B,OAAO,SAAS,UAAU,CAC1B,SAAQ,mBAAmB;IAC3B;;;OAGG;IACH,OAAO,EAAE,MAAM,SAAS,CAAA;IAExB;;;;OAIG;IACH,KAAK,EAAE,GAAG,GAAG,OAAO,CAAC,MAAM,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC,EAAE,CAAA;IAEhD;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IAEd;;;OAGG;IACH,MAAM,CAAC,EAAE,WAAW,CAAA;CACrB;AAED,MAAM,WAAW,mBAAmB;IAClC;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IAEpB;;;;;OAKG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IAEnB;;;;;;OAMG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAA;IAE1B;;;;;;OAMG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAA;IAE9B;;;;;;OAMG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB;AAED,MAAM,WAAW,gBAAgB,CAC/B,SAAS,SAAS,QAAQ,EAC1B,OAAO,SAAS,UAAU,EAC1B,OAAO,SAAS,WAAW;IAE3B;;;;OAIG;IACH,QAAQ,EAAE,SAAS,CAAA;IAEnB;;;OAGG;IACH,MAAM,EAAE,OAAO,CAAA;IAEf;;;;;;;;OAQG;IACH,MAAM,EAAE,OAAO,CAAA;IAEf;;OAEG;IACH,OAAO,EAAE,YAAY,CAAC,SAAS,EAAE,OAAO,CAAC,EAAE,CAAA;CAC5C;AAED,MAAM,WAAW,qBAAqB,CAAC,SAAS,SAAS,QAAQ;IAC/D;;;OAGG;IACH,OAAO,EAAE,MAAM,SAAS,CAAA;IAExB;;;OAGG;IACH,MAAM,CAAC,EAAE,WAAW,CAAA;CACrB;AAED,MAAM,WAAW,aAAa,CAC5B,OAAO,SAAS,UAAU,EAC1B,KAAK,SAAS,OAAO,EAAE,GAAG,EAAE;IAE5B;;;;OAIG;IACH,KAAK,EAAE,OAAO,CAAC,MAAM,CAAC,CAAA;IAEtB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,aAAa,CAAA;IAExB;;;;OAIG;IACH,OAAO,EAAE,CAAC,GAAG,IAAI,EAAE,KAAK,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAA;CAClD;AAED,MAAM,MAAM,qBAAqB,GAAG;IAClC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;CACb,CAAA;AAED,MAAM,MAAM,GAAG,CACb,OAAO,SAAS,UAAU,EAC1B,KAAK,SAAS,OAAO,EAAE,GAAG,EAAE,IAC1B,aAAa,CAAC,OAAO,EAAE,KAAK,CAAC,GAAG,qBAAqB,CAAA;AAEzD,MAAM,MAAM,kBAAkB,GAC1B;IACE;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAA;IACZ,SAAS,CAAC,EAAE,KAAK,CAAA;CAClB,GACD;IACE,IAAI,CAAC,EAAE,KAAK,CAAA;IACZ;;;OAGG;IACH,SAAS,EAAE,IAAI,CAAA;CAChB,CAAA;AAEL,KAAK,aAAa,GAAG,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAA;AAOrC,MAAM,MAAM,mBAAmB,CAAC,IAAI,SAAS,GAAG,CAAC,UAAU,CAAC,IAC1D,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,SAAS,EAAE,GAClC,CAAC,kBAAkB,CAAC,CAAC,GAAG,CAAC,EAAE,EAAE,kBAAkB,CAAC,CAAC,GACjD,CAAC,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,kBAAkB,CAAC,CAAC,CAAA"}

package/dist/types.js

@@ -0,0 +1,16 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var types_exports = {};
+module.exports = __toCommonJS(types_exports);

package/dist/util.d.ts

@@ -0,0 +1,2 @@
+export declare function makeFilePath(path: string): string;
+//# sourceMappingURL=util.d.ts.map

package/dist/util.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"util.d.ts","sourceRoot":"","sources":["../src/util.ts"],"names":[],"mappings":"AAGA,wBAAgB,YAAY,CAAC,IAAI,EAAE,MAAM,UAExC"}

package/dist/util.js

@@ -0,0 +1,31 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var util_exports = {};
+__export(util_exports, {
+  makeFilePath: () => makeFilePath
+});
+module.exports = __toCommonJS(util_exports);
+var import_node_url = require("node:url");
+function makeFilePath(path) {
+  return (0, import_node_url.pathToFileURL)(path).href;
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  makeFilePath
+});

package/package.json

@@ -0,0 +1,58 @@
+{
+  "name": "@redmix/jobs",
+  "version": "0.0.1",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/redmix-run/redmix.git",
+    "directory": "packages/jobs"
+  },
+  "license": "MIT",
+  "type": "commonjs",
+  "exports": {
+    ".": {
+      "default": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      }
+    },
+    "./package.json": "./package.json"
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "bin": {
+    "rw-jobs": "./dist/bins/rw-jobs.js",
+    "rw-jobs-worker": "./dist/bins/rw-jobs-worker.js"
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsx ./build.mts && yarn build:types",
+    "build:pack": "yarn pack -o redmix-jobs.tgz",
+    "build:types": "tsc --build --verbose ./tsconfig.build.json",
+    "build:watch": "nodemon --watch src --ext \"js,jsx,ts,tsx\" --ignore dist --exec \"yarn build\"",
+    "check:attw": "yarn rw-fwtools-attw",
+    "check:package": "concurrently npm:check:attw yarn:publint",
+    "prepublishOnly": "NODE_ENV=production yarn build",
+    "test": "vitest run",
+    "test:watch": "vitest"
+  },
+  "dependencies": {
+    "@redmix/cli-helpers": "0.0.1",
+    "@redmix/project-config": "0.0.1",
+    "type-fest": "4.26.1"
+  },
+  "devDependencies": {
+    "@prisma/client": "5.20.0",
+    "@redmix/framework-tools": "0.0.1",
+    "concurrently": "8.2.2",
+    "publint": "0.3.11",
+    "tsx": "4.19.3",
+    "typescript": "5.6.2",
+    "vitest": "2.1.9"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "gitHead": "688027c97502c500ebbede9cdc7cc51545a8dcf3"
+}