chore!: update to boringnode/queue 0.4.0

Author: RomainLanz

configure.ts

@@ -83,19 +83,12 @@ export async function configure(command: Configure) {
    * Create migration for database driver
    */
   if (driver === 'database') {
-    const shouldPublishMigration = await command.prompt.confirm(
-      'Do you want to publish the migration for the queue tables?',
-      { hint: 'Tables are auto-created by default, but you can manage them manually' }
-    )
-
-    if (shouldPublishMigration) {
-      await codemods.makeUsingStub(stubsRoot, 'migration.stub', {
-        entity: command.app.generators.createEntity('queue'),
-        migration: {
-          folder: 'database/migrations',
-          fileName: `${new Date().getTime()}_create_queue_tables.ts`,
-        },
-      })
-    }
+    await codemods.makeUsingStub(stubsRoot, 'migration.stub', {
+      entity: command.app.generators.createEntity('queue'),
+      migration: {
+        folder: 'database/migrations',
+        fileName: `${new Date().getTime()}_create_queue_tables.ts`,
+      },
+    })
   }
 }

package.json

@@ -35,7 +35,7 @@
     "version": "npm run build"
   },
   "dependencies": {
-    "@boringnode/queue": "^0.3.1",
+    "@boringnode/queue": "^0.4.0",
     "@poppinss/utils": "^6.10.1"
   },
   "devDependencies": {

stubs/migration.stub

@@ -4,53 +4,20 @@
   })
 }}}
 import { BaseSchema } from '@adonisjs/lucid/schema'
+import { QueueSchemaService } from '@boringnode/queue'
 
 export default class extends BaseSchema {
   async up() {
-    /**
-     * Jobs table - stores pending, active, and delayed jobs
-     */
-    this.schema.createTable('queue_jobs', (table) => {
-      table.string('id', 255).notNullable()
-      table.string('queue', 255).notNullable()
-      table.enu('status', ['pending', 'active', 'delayed', 'completed', 'failed']).notNullable()
-      table.text('data').notNullable()
-      table.bigint('score').unsigned().nullable()
-      table.string('worker_id', 255).nullable()
-      table.bigint('acquired_at').unsigned().nullable()
-      table.bigint('execute_at').unsigned().nullable()
-      table.bigint('finished_at').unsigned().nullable()
-      table.text('error').nullable()
-      table.primary(['id', 'queue'])
-      table.index(['queue', 'status', 'score'])
-      table.index(['queue', 'status', 'execute_at'])
-      table.index(['queue', 'status', 'finished_at'])
-    })
+    const schemaService = new QueueSchemaService(this.db.connection().getWriteClient())
 
-    /**
-     * Schedules table - stores recurring job schedules
-     */
-    this.schema.createTable('queue_schedules', (table) => {
-      table.string('id', 255).primary()
-      table.string('status', 50).notNullable().defaultTo('active')
-      table.string('name', 255).notNullable()
-      table.text('payload').notNullable()
-      table.string('cron_expression', 255).nullable()
-      table.bigint('every_ms').unsigned().nullable()
-      table.string('timezone', 100).notNullable().defaultTo('UTC')
-      table.timestamp('from_date').nullable()
-      table.timestamp('to_date').nullable()
-      table.integer('run_limit').unsigned().nullable()
-      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().defaultTo(this.now())
-      table.index(['status', 'next_run_at'])
-    })
+    await schemaService.createJobsTable()
+    await schemaService.createSchedulesTable()
   }
 
   async down() {
-    this.schema.dropTable('queue_jobs')
-    this.schema.dropTable('queue_schedules')
+    const schemaService = new QueueSchemaService(this.db.connection().getWriteClient())
+
+    await schemaService.dropSchedulesTable()
+    await schemaService.dropJobsTable()
   }
 }

tests/configure.spec.ts

@@ -9,10 +9,13 @@
 
 import { test } from '@japa/runner'
 import { fileURLToPath } from 'node:url'
+import { readdir } from 'node:fs/promises'
+import { join } from 'node:path'
 import { IgnitorFactory } from '@adonisjs/core/factories'
 import Configure from '@adonisjs/core/commands/configure'
 
 const BASE_URL = new URL('./tmp/', import.meta.url)
+const BASE_PATH = fileURLToPath(BASE_URL)
 
 test.group('Configure', (group) => {
   group.tap((t) => t.timeout(10_000))
@@ -25,6 +28,7 @@ test.group('Configure', (group) => {
     await context.fs.createJson('tsconfig.json', {})
     await context.fs.create('start/env.ts', `export default Env.create(new URL('./'), {})`)
     await context.fs.create('adonisrc.ts', `export default defineConfig({})`)
+    await context.fs.create('database/migrations/.gitkeep', '')
   })
 
   test('should register provider and command', async ({ assert }) => {
@@ -159,13 +163,18 @@ test.group('Configure', (group) => {
 
     const ace = await app.container.make('ace')
     ace.prompt.trap('Select the queue driver you plan to use').chooseOption(1) // database
-    ace.prompt.trap('Do you want to publish the migration for the queue tables?').reject()
     ace.ui.switchMode('raw')
 
     const command = await ace.create(Configure, ['../../index.js'])
     await command.exec()
 
     await assert.fileContains('config/queue.ts', 'drivers.database')
     await assert.fileContains('.env', 'QUEUE_DRIVER=database')
+
+    const migrationDir = join(BASE_PATH, 'database/migrations')
+    const migrationFiles = await readdir(migrationDir)
+    const hasQueueMigration = migrationFiles.some((file) => file.endsWith('_create_queue_tables.ts'))
+
+    assert.isTrue(hasQueueMigration)
   })
 })