@adonisjs/queue 0.1.1 → 0.2.1

package/build/commands/commands.json

@@ -1 +1 @@
-{"commands":[{"commandName":"make:job","description":"Create a new job class","help":"","namespace":"make","aliases":[],"flags":[],"args":[{"name":"name","argumentName":"name","required":true,"description":"Name of the job","type":"string"}],"options":{"allowUnknownFlags":true},"filePath":"make_job.js"},{"commandName":"queue:scheduler:clear","description":"Remove all scheduled jobs","help":"","namespace":"queue","aliases":[],"flags":[],"args":[],"options":{"startApp":true},"filePath":"queue_scheduler_clear.js"},{"commandName":"queue:scheduler:list","description":"List all scheduled jobs","help":"","namespace":"queue","aliases":[],"flags":[{"name":"status","flagName":"status","required":false,"type":"string","description":"Filter by status (active, paused)","alias":"s"}],"args":[],"options":{"startApp":true},"filePath":"queue_scheduler_list.js"},{"commandName":"queue:scheduler:remove","description":"Remove a scheduled job by ID","help":"","namespace":"queue","aliases":[],"flags":[],"args":[{"name":"id","argumentName":"id","required":true,"description":"ID of the schedule to remove","type":"string"}],"options":{"startApp":true},"filePath":"queue_scheduler_remove.js"},{"commandName":"queue:work","description":"Start processing jobs from the queue","help":"","namespace":"queue","aliases":[],"flags":[{"name":"queue","flagName":"queue","required":false,"type":"string","description":"Comma-separated list of queues to process","alias":"q"}],"args":[],"options":{"startApp":true,"staysAlive":true},"filePath":"queue_work.js"}],"version":1}
+{"commands":[{"commandName":"make:job","description":"Create a new job class","help":"","namespace":"make","aliases":[],"flags":[],"args":[{"name":"name","argumentName":"name","required":true,"description":"Name of the job","type":"string"}],"options":{"allowUnknownFlags":true},"filePath":"make_job.js"},{"commandName":"queue:scheduler:clear","description":"Remove all scheduled jobs","help":"","namespace":"queue","aliases":[],"flags":[],"args":[],"options":{"startApp":true},"filePath":"queue_scheduler_clear.js"},{"commandName":"queue:scheduler:list","description":"List all scheduled jobs","help":"","namespace":"queue","aliases":[],"flags":[{"name":"status","flagName":"status","required":false,"type":"string","description":"Filter by status (active, paused)","alias":"s"}],"args":[],"options":{"startApp":true},"filePath":"queue_scheduler_list.js"},{"commandName":"queue:scheduler:remove","description":"Remove a scheduled job by ID","help":"","namespace":"queue","aliases":[],"flags":[],"args":[{"name":"id","argumentName":"id","required":true,"description":"ID of the schedule to remove","type":"string"}],"options":{"startApp":true},"filePath":"queue_scheduler_remove.js"},{"commandName":"queue:work","description":"Start processing jobs from the queue","help":"","namespace":"queue","aliases":[],"flags":[{"name":"queue","flagName":"queue","required":false,"type":"string","description":"Comma-separated list of queues to process","alias":"q"},{"name":"concurrency","flagName":"concurrency","required":false,"type":"number","description":"Number of jobs to process concurrently","alias":"c"}],"args":[],"options":{"startApp":true,"staysAlive":true},"filePath":"queue_work.js"}],"version":1}

package/build/commands/queue_scheduler_list.js

@@ -38,7 +38,7 @@ export default class QueueSchedulerList extends BaseCommand {
             const lastRun = schedule.lastRunAt?.toISOString() ?? 'Never';
             table.row([
                 schedule.id,
-                schedule.jobName,
+                schedule.name,
                 scheduleExpr,
                 schedule.status,
                 String(schedule.runCount),

package/build/commands/queue_work.d.ts

@@ -5,5 +5,6 @@ export default class QueueWork extends BaseCommand {
     static description: string;
     static options: CommandOptions;
     queue?: string;
+    concurrency?: number;
     run(): Promise<void>;
 }

package/build/commands/queue_work.js

@@ -13,6 +13,7 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
     return c > 3 && r && Object.defineProperty(target, key, r), r;
 };
 import { flags, BaseCommand } from '@adonisjs/core/ace';
+import { resolveAdapters } from '../src/utils.js';
 export default class QueueWork extends BaseCommand {
     static commandName = 'queue:work';
     static description = 'Start processing jobs from the queue';
@@ -30,12 +31,20 @@ export default class QueueWork extends BaseCommand {
          */
         const router = await this.app.container.make('router');
         router.commit();
+        const resolvedAdapters = await resolveAdapters(config, this.app);
         const queues = this.queue ? this.queue.split(',').map((q) => q.trim()) : ['default'];
         this.logger.info(`Starting worker for queues: ${queues.join(', ')}`);
-        const worker = new Worker(config);
+        const worker = new Worker({
+            ...config,
+            adapters: resolvedAdapters,
+            ...(this.concurrency && { concurrency: this.concurrency }),
+        });
         await worker.start(queues);
     }
 }
 __decorate([
     flags.string({ description: 'Comma-separated list of queues to process', alias: 'q' })
 ], QueueWork.prototype, "queue", void 0);
+__decorate([
+    flags.number({ description: 'Number of jobs to process concurrently', alias: 'c' })
+], QueueWork.prototype, "concurrency", void 0);

package/build/providers/queue_provider.js

@@ -7,6 +7,7 @@
  * file that was distributed with this source code.
  */
 import '../src/types/extended.js';
+import { resolveAdapters } from '../src/utils.js';
 export default class QueueProvider {
     app;
     constructor(app) {
@@ -16,25 +17,14 @@ export default class QueueProvider {
         this.app.container.singleton('queue.manager', async () => {
             const { QueueManager } = await import('@boringnode/queue');
             const config = this.app.config.get('queue');
-            /**
-             * Resolve adapter factories from config providers
-             */
-            const resolvedAdapters = {};
-            for (const [name, adapterConfig] of Object.entries(config.adapters)) {
-                if (typeof adapterConfig === 'function') {
-                    resolvedAdapters[name] = adapterConfig;
-                }
-                else {
-                    resolvedAdapters[name] = await adapterConfig.resolver(this.app);
-                }
-            }
+            const resolvedAdapters = await resolveAdapters(config, this.app);
             /**
              * Inject jobFactory if not already defined.
              * This enables automatic dependency injection for job classes.
              */
             const jobFactory = config.jobFactory ??
-                (async (JobClass, payload, context) => {
-                    return this.app.container.make(JobClass, [payload, context]);
+                (async (JobClass) => {
+                    return this.app.container.make(JobClass);
                 });
             const logger = await this.app.container.make('logger');
             await QueueManager.init({

package/build/src/define_config.d.ts

@@ -1,5 +1,5 @@
-import type { QueueManagerConfig } from '@boringnode/queue/types';
+import type { QueueConfig } from './types/main.js';
 /**
  * Define queue configuration with type-safety.
  */
-export declare function defineConfig(config: QueueManagerConfig): QueueManagerConfig;
+export declare function defineConfig(config: QueueConfig): QueueConfig;

package/build/src/types/main.d.ts

@@ -1 +1,11 @@
+import type { ConfigProvider } from '@adonisjs/core/types';
+import type { Adapter, QueueManagerConfig } from '@boringnode/queue/types';
 export * from '@boringnode/queue/types';
+type AdapterFactory = () => Adapter;
+/**
+ * AdonisJS-specific queue configuration that supports both
+ * direct adapter factories and config providers.
+ */
+export interface QueueConfig extends Omit<QueueManagerConfig, 'adapters'> {
+    adapters: Record<string, AdapterFactory | ConfigProvider<AdapterFactory>>;
+}

package/build/src/utils.d.ts

@@ -0,0 +1,14 @@
+import type { ApplicationService } from '@adonisjs/core/types';
+import type { QueueConfig } from './types/main.js';
+type AdapterFactory = () => any;
+/**
+ * Resolve adapter factories from config providers.
+ *
+ * Adapters in the config can be either:
+ * - Direct factory functions
+ * - ConfigProvider objects that need to be resolved
+ *
+ * This function normalizes them all to factory functions.
+ */
+export declare function resolveAdapters(config: QueueConfig, app: ApplicationService): Promise<Record<string, AdapterFactory>>;
+export {};

package/build/src/utils.js

@@ -0,0 +1,29 @@
+/*
+ * @adonisjs/queue
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+/**
+ * Resolve adapter factories from config providers.
+ *
+ * Adapters in the config can be either:
+ * - Direct factory functions
+ * - ConfigProvider objects that need to be resolved
+ *
+ * This function normalizes them all to factory functions.
+ */
+export async function resolveAdapters(config, app) {
+    const resolvedAdapters = {};
+    for (const [name, adapterConfig] of Object.entries(config.adapters)) {
+        if (typeof adapterConfig === 'function') {
+            resolvedAdapters[name] = adapterConfig;
+        }
+        else {
+            resolvedAdapters[name] = await adapterConfig.resolver(app);
+        }
+    }
+    return resolvedAdapters;
+}

package/build/stubs/make/job/main.stub

@@ -6,14 +6,14 @@
   })
 }}}
 import { Job } from '@adonisjs/queue'
-import type { JobOption } from '@adonisjs/queue/types'
+import type { JobOptions } from '@adonisjs/queue/types'
 
 interface {{ jobName }}Payload {
   // Define your payload type here
 }
 
 export default class {{ jobName }} extends Job<{{ jobName }}Payload> {
-  static options: JobOption = {
+  static options: JobOptions = {
     queue: 'default',
     maxRetries: 3,
   }

package/build/stubs/migration.stub

@@ -13,7 +13,7 @@ export default class extends BaseSchema {
     this.schema.createTable('queue_jobs', (table) => {
       table.string('id', 255).notNullable()
       table.string('queue', 255).notNullable()
-      table.enum('status', ['pending', 'active', 'delayed']).notNullable()
+      table.enu('status', ['pending', 'active', 'delayed']).notNullable()
       table.text('data').notNullable()
       table.bigint('score').unsigned().nullable()
       table.string('worker_id', 255).nullable()
@@ -30,7 +30,7 @@ export default class extends BaseSchema {
     this.schema.createTable('queue_schedules', (table) => {
       table.string('id', 255).primary()
       table.string('status', 50).notNullable().defaultTo('active')
-      table.string('job_name', 255).notNullable()
+      table.string('name', 255).notNullable()
       table.text('payload').notNullable()
       table.string('cron_expression', 255).nullable()
       table.bigint('every_ms').unsigned().nullable()
@@ -41,7 +41,7 @@ export default class extends BaseSchema {
       table.integer('run_count').unsigned().notNullable().defaultTo(0)
       table.timestamp('next_run_at').nullable()
       table.timestamp('last_run_at').nullable()
-      table.timestamp('created_at').notNullable()
+      table.timestamp('created_at').notNullable().defaultTo(this.#connection.fn.now())
       table.index(['status', 'next_run_at'])
     })
   }

package/build/tests/helpers.d.ts

@@ -0,0 +1,5 @@
+import type { AppEnvironments } from '@adonisjs/core/types/app';
+import { defineConfig } from '../index.js';
+export declare function setupApp(env?: AppEnvironments, config?: {
+    queue?: ReturnType<typeof defineConfig>;
+}): Promise<import("@adonisjs/core/types").ApplicationService>;

package/build/tests/helpers.js

@@ -0,0 +1,51 @@
+/*
+ * @adonisjs/queue
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+var __rewriteRelativeImportExtension = (this && this.__rewriteRelativeImportExtension) || function (path, preserveJsx) {
+    if (typeof path === "string" && /^\.\.?\//.test(path)) {
+        return path.replace(/\.(tsx)$|((?:\.d)?)((?:\.[^./]+?)?)\.([cm]?)ts$/i, function (m, tsx, d, ext, cm) {
+            return tsx ? preserveJsx ? ".jsx" : ".js" : d && (!ext || !cm) ? m : (d + ext + "." + cm.toLowerCase() + "js");
+        });
+    }
+    return path;
+};
+import { getActiveTest } from '@japa/runner';
+import { IgnitorFactory } from '@adonisjs/core/factories';
+import { defineConfig, drivers } from '../index.js';
+const BASE_URL = new URL('./tmp/', import.meta.url);
+export async function setupApp(env, config = {}) {
+    const ignitor = new IgnitorFactory()
+        .withCoreProviders()
+        .withCoreConfig()
+        .merge({
+        config: {
+            queue: config.queue ||
+                defineConfig({
+                    default: 'sync',
+                    adapters: {
+                        sync: drivers.sync(),
+                    },
+                }),
+        },
+        rcFileContents: {
+            providers: [() => import('../providers/queue_provider.js')],
+        },
+    })
+        .create(BASE_URL, {
+        importer: (filePath) => {
+            if (filePath.startsWith('./') || filePath.startsWith('../')) {
+                return import(__rewriteRelativeImportExtension(new URL(filePath, BASE_URL).href));
+            }
+            return import(__rewriteRelativeImportExtension(filePath));
+        },
+    });
+    const app = ignitor.createApp(env || 'web');
+    await app.init().then(() => app.boot());
+    getActiveTest()?.cleanup(() => app.terminate());
+    return app;
+}

package/build/tests/provider.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/build/tests/provider.spec.js

@@ -0,0 +1,30 @@
+/*
+ * @adonisjs/queue
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+import { test } from '@japa/runner';
+import { setupApp } from './helpers.js';
+test.group('Provider', () => {
+    test('should resolve queue manager from container', async ({ assert }) => {
+        const app = await setupApp();
+        const queueManager = await app.container.make('queue.manager');
+        assert.isDefined(queueManager);
+        assert.isFunction(queueManager.use);
+        assert.isFunction(queueManager.destroy);
+    });
+    test('should resolve adapters from config providers', async ({ assert }) => {
+        const app = await setupApp();
+        const queueManager = await app.container.make('queue.manager');
+        assert.isDefined(queueManager);
+    });
+    test('should shutdown queue manager when app terminates', async ({ assert }) => {
+        const app = await setupApp();
+        const queueManager = await app.container.make('queue.manager');
+        assert.isDefined(queueManager);
+        await app.terminate();
+    });
+});

package/build/tests/utils.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/build/tests/utils.spec.js

@@ -0,0 +1,148 @@
+/*
+ * @adonisjs/queue
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+var __rewriteRelativeImportExtension = (this && this.__rewriteRelativeImportExtension) || function (path, preserveJsx) {
+    if (typeof path === "string" && /^\.\.?\//.test(path)) {
+        return path.replace(/\.(tsx)$|((?:\.d)?)((?:\.[^./]+?)?)\.([cm]?)ts$/i, function (m, tsx, d, ext, cm) {
+            return tsx ? preserveJsx ? ".jsx" : ".js" : d && (!ext || !cm) ? m : (d + ext + "." + cm.toLowerCase() + "js");
+        });
+    }
+    return path;
+};
+import { test } from '@japa/runner';
+import { IgnitorFactory } from '@adonisjs/core/factories';
+import { defineConfig, drivers } from '../index.js';
+import { resolveAdapters } from '../src/utils.js';
+const BASE_URL = new URL('./tmp/', import.meta.url);
+test.group('resolveAdapters', () => {
+    test('should resolve config providers to adapter factories', async ({ assert }) => {
+        const ignitor = new IgnitorFactory()
+            .withCoreProviders()
+            .withCoreConfig()
+            .merge({
+            config: {
+                queue: defineConfig({
+                    default: 'sync',
+                    adapters: {
+                        sync: drivers.sync(),
+                    },
+                }),
+            },
+            rcFileContents: {
+                providers: [() => import('../providers/queue_provider.js')],
+            },
+        })
+            .create(BASE_URL, {
+            importer: (filePath) => {
+                if (filePath.startsWith('./') || filePath.startsWith('../')) {
+                    return import(__rewriteRelativeImportExtension(new URL(filePath, BASE_URL).href));
+                }
+                return import(__rewriteRelativeImportExtension(filePath));
+            },
+        });
+        const app = ignitor.createApp('console');
+        await app.init().then(() => app.boot());
+        const config = app.config.get('queue');
+        /**
+         * Before resolution, the adapter is a ConfigProvider (object with resolver method)
+         */
+        assert.isObject(config.adapters.sync);
+        assert.isFunction(config.adapters.sync.resolver);
+        /**
+         * After resolution, the adapter should be a factory function
+         */
+        const resolvedAdapters = await resolveAdapters(config, app);
+        assert.isFunction(resolvedAdapters.sync);
+        await app.terminate();
+    });
+    test('should pass through direct factory functions unchanged', async ({ assert }) => {
+        const directFactory = () => ({
+            pushOn: async () => { },
+            pushLaterOn: async () => { },
+            pop: async () => null,
+            acknowledge: async () => { },
+            fail: async () => { },
+            getFailedJobs: async () => [],
+            removeFailedJob: async () => { },
+            clearFailedJobs: async () => { },
+            destroy: async () => { },
+        });
+        const ignitor = new IgnitorFactory()
+            .withCoreProviders()
+            .withCoreConfig()
+            .merge({
+            config: {
+                queue: defineConfig({
+                    default: 'custom',
+                    adapters: {
+                        custom: directFactory,
+                    },
+                }),
+            },
+            rcFileContents: {
+                providers: [() => import('../providers/queue_provider.js')],
+            },
+        })
+            .create(BASE_URL, {
+            importer: (filePath) => {
+                if (filePath.startsWith('./') || filePath.startsWith('../')) {
+                    return import(__rewriteRelativeImportExtension(new URL(filePath, BASE_URL).href));
+                }
+                return import(__rewriteRelativeImportExtension(filePath));
+            },
+        });
+        const app = ignitor.createApp('console');
+        await app.init().then(() => app.boot());
+        const config = app.config.get('queue');
+        const resolvedAdapters = await resolveAdapters(config, app);
+        assert.strictEqual(resolvedAdapters.custom, directFactory);
+        await app.terminate();
+    });
+    test('worker should accept resolved adapters without throwing', async ({ assert }) => {
+        const ignitor = new IgnitorFactory()
+            .withCoreProviders()
+            .withCoreConfig()
+            .merge({
+            config: {
+                queue: defineConfig({
+                    default: 'sync',
+                    adapters: {
+                        sync: drivers.sync(),
+                    },
+                }),
+            },
+            rcFileContents: {
+                providers: [() => import('../providers/queue_provider.js')],
+            },
+        })
+            .create(BASE_URL, {
+            importer: (filePath) => {
+                if (filePath.startsWith('./') || filePath.startsWith('../')) {
+                    return import(__rewriteRelativeImportExtension(new URL(filePath, BASE_URL).href));
+                }
+                return import(__rewriteRelativeImportExtension(filePath));
+            },
+        });
+        const app = ignitor.createApp('console');
+        await app.init().then(() => app.boot());
+        const config = app.config.get('queue');
+        const resolvedAdapters = await resolveAdapters(config, app);
+        /**
+         * Creating a Worker with resolved adapters should not throw
+         * "Adapter must be a factory function" error
+         */
+        const { Worker } = await import('@boringnode/queue');
+        assert.doesNotThrow(() => {
+            new Worker({
+                ...config,
+                adapters: resolvedAdapters,
+            });
+        });
+        await app.terminate();
+    });
+});

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@adonisjs/queue",
   "description": "Queue system for AdonisJS powered by @boringnode/queue",
-  "version": "0.1.1",
+  "version": "0.2.1",
   "engines": {
     "node": ">=20.11.1"
   },
@@ -35,7 +35,7 @@
     "version": "npm run build"
   },
   "dependencies": {
-    "@boringnode/queue": "^0.1.0",
+    "@boringnode/queue": "^0.2.0",
     "@poppinss/utils": "^6.10.1"
   },
   "devDependencies": {
@@ -61,10 +61,10 @@
     "typescript": "^5.8.2"
   },
   "peerDependencies": {
-    "@adonisjs/assembler": "^7.0.0 || ^8.0.0",
-    "@adonisjs/core": "^6.2.0 || ^7.0.0",
-    "@adonisjs/lucid": "^20.0.0 || ^21.0.0 || ^22.0.0",
-    "@adonisjs/redis": "^8.0.0 || ^9.0.0 || ^10.0.0"
+    "@adonisjs/assembler": "^7.0.0 || ^8.0.0 || ^8.0.0-next",
+    "@adonisjs/core": "^6.2.0 || ^7.0.0 || ^7.0.0-next",
+    "@adonisjs/lucid": "^20.0.0 || ^21.0.0 || ^22.0.0 || ^22.0.0-next",
+    "@adonisjs/redis": "^8.0.0 || ^9.0.0 || ^10.0.0 || ^10.0.0-next"
   },
   "peerDependenciesMeta": {
     "@adonisjs/lucid": {