@quave/agenda-mongodb 1.0.0

package/dist/cjs/MongoJobLogger.js

@@ -0,0 +1,149 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MongoJobLogger = void 0;
+const debug_1 = __importDefault(require("debug"));
+const log = (0, debug_1.default)('agenda:mongo:logger');
+/**
+ * MongoDB implementation of JobLogger.
+ * Stores job lifecycle events in a dedicated MongoDB collection.
+ *
+ * @example
+ * ```typescript
+ * // Via backend (automatic connection sharing):
+ * import { MongoBackend } from '@quave/agenda-mongodb';
+ *
+ * const backend = new MongoBackend({
+ *   mongo: db,
+ *   logging: true // enables MongoJobLogger with 'agenda_logs' collection
+ * });
+ *
+ * // Standalone (e.g., log to Mongo while using Postgres for storage):
+ * import { MongoJobLogger } from '@quave/agenda-mongodb';
+ *
+ * const logger = new MongoJobLogger({ db: existingDb });
+ * const agenda = new Agenda({
+ *   backend: new PostgresBackend({ connectionString: '...' }),
+ *   logging: logger
+ * });
+ * ```
+ */
+class MongoJobLogger {
+    constructor(options) {
+        this.initialized = false;
+        if (typeof options === 'string') {
+            // Legacy: constructor(collectionName)
+            this.collectionName = options;
+        }
+        else {
+            this.collectionName = options?.collectionName ?? 'agenda_logs';
+            if (options?.db) {
+                this.collection = options.db.collection(this.collectionName);
+            }
+        }
+    }
+    /**
+     * Set the database instance and initialize the collection.
+     * Called by MongoBackend after the repository connects,
+     * or automatically when a db is provided in the constructor.
+     */
+    async setDb(db) {
+        this.collection = db.collection(this.collectionName);
+        await this.ensureIndexes();
+    }
+    async ensureIndexes() {
+        if (this.initialized || !this.collection)
+            return;
+        this.initialized = true;
+        log('creating indexes for %s collection', this.collectionName);
+        await this.collection.createIndex({ timestamp: -1 }, { name: 'agenda_logs_timestamp_idx' });
+        await this.collection.createIndex({ jobId: 1, timestamp: -1 }, { name: 'agenda_logs_job_id_idx' });
+        await this.collection.createIndex({ jobName: 1, timestamp: -1 }, { name: 'agenda_logs_job_name_idx' });
+        log('indexes created for %s collection', this.collectionName);
+    }
+    async log(entry) {
+        if (!this.collection) {
+            log('collection not initialized, skipping log entry');
+            return;
+        }
+        await this.ensureIndexes();
+        await this.collection.insertOne({ ...entry });
+    }
+    async getLogs(query) {
+        if (!this.collection) {
+            return { entries: [], total: 0 };
+        }
+        const filter = this.buildFilter(query);
+        const sort = { timestamp: query?.sort === 'asc' ? 1 : -1 };
+        const limit = query?.limit ?? 50;
+        const offset = query?.offset ?? 0;
+        const [entries, total] = await Promise.all([
+            this.collection
+                .find(filter)
+                .sort(sort)
+                .skip(offset)
+                .limit(limit)
+                .toArray()
+                .then(docs => docs.map(doc => ({
+                _id: doc._id.toHexString(),
+                timestamp: doc.timestamp,
+                level: doc.level,
+                event: doc.event,
+                jobId: doc.jobId,
+                jobName: doc.jobName,
+                message: doc.message,
+                duration: doc.duration,
+                error: doc.error,
+                failCount: doc.failCount,
+                retryDelay: doc.retryDelay,
+                retryAttempt: doc.retryAttempt,
+                agendaName: doc.agendaName,
+                meta: doc.meta
+            }))),
+            this.collection.countDocuments(filter)
+        ]);
+        return { entries, total };
+    }
+    async clearLogs(query) {
+        if (!this.collection) {
+            return 0;
+        }
+        const filter = this.buildFilter(query);
+        const result = await this.collection.deleteMany(filter);
+        return result.deletedCount;
+    }
+    buildFilter(query) {
+        if (!query)
+            return {};
+        const filter = {};
+        if (query.jobId) {
+            filter.jobId = query.jobId;
+        }
+        if (query.jobName) {
+            filter.jobName = query.jobName;
+        }
+        if (query.level) {
+            filter.level = Array.isArray(query.level)
+                ? { $in: query.level }
+                : query.level;
+        }
+        if (query.event) {
+            filter.event = Array.isArray(query.event)
+                ? { $in: query.event }
+                : query.event;
+        }
+        if (query.from || query.to) {
+            const timestampFilter = {};
+            if (query.from)
+                timestampFilter.$gte = query.from;
+            if (query.to)
+                timestampFilter.$lte = query.to;
+            filter.timestamp = timestampFilter;
+        }
+        return filter;
+    }
+}
+exports.MongoJobLogger = MongoJobLogger;
+//# sourceMappingURL=MongoJobLogger.js.map

package/dist/cjs/MongoJobLogger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MongoJobLogger.js","sourceRoot":"","sources":["../../src/MongoJobLogger.ts"],"names":[],"mappings":";;;;;;AAAA,kDAA0B;AAI1B,MAAM,GAAG,GAAG,IAAA,eAAK,EAAC,qBAAqB,CAAC,CAAC;AAEzC;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAa,cAAc;IAK1B,YAAY,OAAuD;QAF3D,gBAAW,GAAG,KAAK,CAAC;QAG3B,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE,CAAC;YACjC,sCAAsC;YACtC,IAAI,CAAC,cAAc,GAAG,OAAO,CAAC;QAC/B,CAAC;aAAM,CAAC;YACP,IAAI,CAAC,cAAc,GAAG,OAAO,EAAE,cAAc,IAAI,aAAa,CAAC;YAC/D,IAAI,OAAO,EAAE,EAAE,EAAE,CAAC;gBACjB,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;YAC9D,CAAC;QACF,CAAC;IACF,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,KAAK,CAAC,EAAM;QACjB,IAAI,CAAC,UAAU,GAAG,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QACrD,MAAM,IAAI,CAAC,aAAa,EAAE,CAAC;IAC5B,CAAC;IAEO,KAAK,CAAC,aAAa;QAC1B,IAAI,IAAI,CAAC,WAAW,IAAI,CAAC,IAAI,CAAC,UAAU;YAAE,OAAO;QACjD,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC;QAExB,GAAG,CAAC,oCAAoC,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;QAC/D,MAAM,IAAI,CAAC,UAAU,CAAC,WAAW,CAChC,EAAE,SAAS,EAAE,CAAC,CAAC,EAAE,EACjB,EAAE,IAAI,EAAE,2BAA2B,EAAE,CACrC,CAAC;QACF,MAAM,IAAI,CAAC,UAAU,CAAC,WAAW,CAChC,EAAE,KAAK,EAAE,CAAC,EAAE,SAAS,EAAE,CAAC,CAAC,EAAE,EAC3B,EAAE,IAAI,EAAE,wBAAwB,EAAE,CAClC,CAAC;QACF,MAAM,IAAI,CAAC,UAAU,CAAC,WAAW,CAChC,EAAE,OAAO,EAAE,CAAC,EAAE,SAAS,EAAE,CAAC,CAAC,EAAE,EAC7B,EAAE,IAAI,EAAE,0BAA0B,EAAE,CACpC,CAAC;QACF,GAAG,CAAC,mCAAmC,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;IAC/D,CAAC;IAED,KAAK,CAAC,GAAG,CAAC,KAA+B;QACxC,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC;YACtB,GAAG,CAAC,gDAAgD,CAAC,CAAC;YACtD,OAAO;QACR,CAAC;QAED,MAAM,IAAI,CAAC,aAAa,EAAE,CAAC;QAC3B,MAAM,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,GAAG,KAAK,EAAE,CAAC,CAAC;IAC/C,CAAC;IAED,KAAK,CAAC,OAAO,CAAC,KAAmB;QAChC,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC;YACtB,OAAO,EAAE,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC;QAClC,CAAC;QAED,MAAM,MAAM,GAAG,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;QACvC,MAAM,IAAI,GAAS,EAAE,SAAS,EAAE,KAAK,EAAE,IAAI,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QACjE,MAAM,KAAK,GAAG,KAAK,EAAE,KAAK,IAAI,EAAE,CAAC;QACjC,MAAM,MAAM,GAAG,KAAK,EAAE,MAAM,IAAI,CAAC,CAAC;QAElC,MAAM,CAAC,OAAO,EAAE,KAAK,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;YAC1C,IAAI,CAAC,UAAU;iBACb,IAAI,CAAC,MAAM,CAAC;iBACZ,IAAI,CAAC,IAAI,CAAC;iBACV,IAAI,CAAC,MAAM,CAAC;iBACZ,KAAK,CAAC,KAAK,CAAC;iBACZ,OAAO,EAAE;iBACT,IAAI,CAAC,IAAI,CAAC,EAAE,CACZ,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;gBAChB,GAAG,EAAE,GAAG,CAAC,GAAG,CAAC,WAAW,EAAE;gBAC1B,SAAS,EAAE,GAAG,CAAC,SAAiB;gBAChC,KAAK,EAAE,GAAG,CAAC,KAAiB;gBAC5B,KAAK,EAAE,GAAG,CAAC,KAAoB;gBAC/B,KAAK,EAAE,GAAG,CAAC,KAA2B;gBACtC,OAAO,EAAE,GAAG,CAAC,OAAiB;gBAC9B,OAAO,EAAE,GAAG,CAAC,OAAiB;gBAC9B,QAAQ,EAAE,GAAG,CAAC,QAA8B;gBAC5C,KAAK,EAAE,GAAG,CAAC,KAA2B;gBACtC,SAAS,EAAE,GAAG,CAAC,SAA+B;gBAC9C,UAAU,EAAE,GAAG,CAAC,UAAgC;gBAChD,YAAY,EAAE,GAAG,CAAC,YAAkC;gBACpD,UAAU,EAAE,GAAG,CAAC,UAAgC;gBAChD,IAAI,EAAE,GAAG,CAAC,IAA2C;aACrD,CAAC,CAAC,CACH;YACF,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC,MAAM,CAAC;SACtC,CAAC,CAAC;QAEH,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;IAC3B,CAAC;IAED,KAAK,CAAC,SAAS,CAAC,KAAmB;QAClC,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC;YACtB,OAAO,CAAC,CAAC;QACV,CAAC;QAED,MAAM,MAAM,GAAG,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;QACvC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;QACxD,OAAO,MAAM,CAAC,YAAY,CAAC;IAC5B,CAAC;IAEO,WAAW,CAAC,KAAmB;QACtC,IAAI,CAAC,KAAK;YAAE,OAAO,EAAE,CAAC;QAEtB,MAAM,MAAM,GAAoC,EAAE,CAAC;QAEnD,IAAI,KAAK,CAAC,KAAK,EAAE,CAAC;YACjB,MAAM,CAAC,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC;QAC5B,CAAC;QACD,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC;YACnB,MAAM,CAAC,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC;QAChC,CAAC;QACD,IAAI,KAAK,CAAC,KAAK,EAAE,CAAC;YACjB,MAAM,CAAC,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC;gBACxC,CAAC,CAAC,EAAE,GAAG,EAAE,KAAK,CAAC,KAAK,EAAE;gBACtB,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC;QAChB,CAAC;QACD,IAAI,KAAK,CAAC,KAAK,EAAE,CAAC;YACjB,MAAM,CAAC,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC;gBACxC,CAAC,CAAC,EAAE,GAAG,EAAE,KAAK,CAAC,KAAK,EAAE;gBACtB,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC;QAChB,CAAC;QACD,IAAI,KAAK,CAAC,IAAI,IAAI,KAAK,CAAC,EAAE,EAAE,CAAC;YAC5B,MAAM,eAAe,GAAyB,EAAE,CAAC;YACjD,IAAI,KAAK,CAAC,IAAI;gBAAE,eAAe,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;YAClD,IAAI,KAAK,CAAC,EAAE;gBAAE,eAAe,CAAC,IAAI,GAAG,KAAK,CAAC,EAAE,CAAC;YAC9C,MAAM,CAAC,SAAS,GAAG,eAAe,CAAC;QACpC,CAAC;QAED,OAAO,MAAM,CAAC;IACf,CAAC;CACD;AA1ID,wCA0IC"}

package/dist/cjs/MongoJobRepository.d.ts

@@ -0,0 +1,84 @@
+import { Collection, Db, ObjectId } from 'mongodb';
+import type { JobParameters, JobId, JobsQueryOptions, JobsResult, JobsOverview, JobRepository, JobRepositoryOptions, RemoveJobsOptions } from '@quave/agenda';
+import type { MongoJobRepositoryConfig } from './types.js';
+/**
+ * Internal MongoDB document type with ObjectId for _id
+ * This is what's actually stored in MongoDB, separate from the public JobParameters interface
+ */
+type MongoJobDocument = Omit<JobParameters, '_id'> & {
+    _id?: ObjectId;
+};
+/**
+ * @class
+ * MongoDB implementation of JobRepository
+ */
+export declare class MongoJobRepository implements JobRepository {
+    private connectOptions;
+    collection: Collection<MongoJobDocument>;
+    private mongoClient?;
+    private _db?;
+    private ownsConnection;
+    constructor(connectOptions: MongoJobRepositoryConfig);
+    private createConnection;
+    getJobById(id: string): Promise<JobParameters | null>;
+    /**
+     * Convert a SortDirection value to MongoDB's numeric sort direction
+     */
+    private toMongoSortDirection;
+    /**
+     * findOneAndUpdate that tolerates both driver result shapes: driver 6+
+     * returns the document (or null) directly, while drivers 4/5 — e.g. the
+     * mongodb driver bundled with Meteor 2.x — return a ModifyResult wrapper
+     * with the document under `value`.
+     */
+    private findOneAndUpdateDoc;
+    /**
+     * Convert generic sort options to MongoDB sort
+     */
+    private toMongoSort;
+    /**
+     * Query jobs with database-agnostic options.
+     * Handles state computation and filtering internally.
+     */
+    queryJobs(options?: JobsQueryOptions): Promise<JobsResult>;
+    /**
+     * Get overview statistics for jobs grouped by name.
+     * Returns counts of jobs in each state for each job name.
+     */
+    getJobsOverview(): Promise<JobsOverview[]>;
+    /**
+     * Get all distinct job names
+     */
+    getDistinctJobNames(): Promise<string[]>;
+    getQueueSize(): Promise<number>;
+    removeJobs(options: RemoveJobsOptions): Promise<number>;
+    /**
+     * Build a MongoDB filter from RemoveJobsOptions
+     */
+    private buildFilterFromOptions;
+    disableJobs(options: RemoveJobsOptions): Promise<number>;
+    enableJobs(options: RemoveJobsOptions): Promise<number>;
+    purgeAllJobs(): Promise<number>;
+    unlockJob(job: JobParameters): Promise<void>;
+    /**
+     * Internal method to unlock jobs so that they can be re-run
+     */
+    unlockJobs(jobIds: (JobId | string)[]): Promise<void>;
+    lockJob(job: JobParameters, options: JobRepositoryOptions | undefined): Promise<JobParameters | undefined>;
+    getNextJobToRun(jobName: string, nextScanAt: Date, lockDeadline: Date, now: Date | undefined, options: JobRepositoryOptions | undefined): Promise<JobParameters | undefined>;
+    /**
+     * Get the underlying MongoDB Db instance (for use by job logger).
+     */
+    getDb(): Db;
+    connect(): Promise<void>;
+    private database;
+    disconnect(): Promise<void>;
+    saveJobState(job: JobParameters, options: JobRepositoryOptions | undefined): Promise<void>;
+    /**
+     * Save a job to the database (insert or update)
+     * @param job Job parameters to save
+     * @returns The saved job parameters with ID
+     */
+    saveJob<DATA = unknown>(job: JobParameters<DATA>, options: JobRepositoryOptions | undefined): Promise<JobParameters<DATA>>;
+}
+export {};