feat: add jobs.ts inside start path to preload jobs

README.md

@@ -40,11 +40,11 @@ Example:
 ```typescript
 import app from '@adonisjs/core/services/app'
 import bull from '@acidiney/bull-queue/services/main'
-import { RegisterStripeCustomer, RegisterStripeCustomerPayload } from '#app/jobs/register_stripe_customer.js'
+import { RegisterStripeCustomerPayload } from '#app/jobs/register_stripe_customer.js'
 
 await app.booted(async () => {
   bull.dispatch(
-    RegisterStripeCustomer.instance(),
+    'RegisterStripeCustomer',
     { userId: '123456' } as RegisterStripeCustomerPayload,
   )
 })
@@ -77,14 +77,18 @@ export class RegisterStripeCustomer implements JobHandlerContract<RegisterStripe
     const { userId } = job.data;
     // Send notification or log failure
   }
+}
 
-  public static instance (): 'RegisterStripeCustomer' {
-    app.container.singleton('RegisterStripeCustomer', () => new RegisterStripeCustomer())
+// You need to declare the new job inside `start/jobs.ts` to be preload.
+import { RegisterStripeCustomer } from '#app/jobs/register_stripe_customer.js'
 
-    return 'RegisterStripeCustomer'
-  }
+const jobs: Record<string, Function> = {
+  [RegisterStripeCustomer.name]: () => new RegisterStripeCustomer(),
 }
 
+export { jobs }
+
+
 // Define payload types for jobs in the `config/queue.ts` file to ensure type safety and consistency.
 declare module '@adonisjs/core/types' {
   interface ContainerBindings {
@@ -93,6 +97,9 @@ declare module '@adonisjs/core/types' {
 }
 ```
 
+
+
+
 ### Job Lifecycle <a id="job-lifecycle"></a>
 
 Define the `handle` method to execute job logic and the `failed` method to handle failed attempts.
@@ -114,7 +121,7 @@ Example:
 node ace queue:listen:ui
 ```
 
-By default, the UI will be accessible at `localhost:9999/ui`. You can specify a different port using the `--port` option:
+By default, the UI will be accessible at `localhost:9999/admin`. You can specify a different port using the `--port` option:
 
 ```bash
 node ace queue:listen:ui --port=3939
@@ -136,4 +143,4 @@ This command starts the queue worker and launches the UI for convenient manageme
 - **h3**: A library for generating unique hash codes.
 
 # Author
-Acidiney Dias
+Acidiney Dias

configure.ts

@@ -22,6 +22,7 @@ export async function configure(command: ConfigureCommand) {
    * Publish config file
    */
   await codemods.makeUsingStub(stubsRoot, 'config/queue.stub', {})
+  await codemods.makeUsingStub(stubsRoot, 'start/jobs.stub', {})
 
   /**
    * Register provider

providers/queue_provider.ts

@@ -37,6 +37,17 @@ export default class QueueProvider {
     })
   }
 
+  async boot() {
+    const { jobs } = await import(this.app.startPath('jobs.ts'))
+    const logger = await this.app.container.make('logger')
+    const jobNames = Object.keys(jobs)
+
+    for (const job of jobNames) {
+      this.app.container.singleton<any>(job, jobs[job])
+      logger.info(`[@acidiney/bull-queue] ${job} loaded!`)
+    }
+  }
+
   async shutdown() {
     const bullQueue = await this.app.container.make('bull_queue')
 

stubs/config/queue.stub

@@ -47,8 +47,3 @@ connection: {
   queueNames: ['default'],
   queuePrefix: '@bull-'
 })
-
-declare module '@adonisjs/core/types' {
-  interface ContainerBindings {
-  }
-}

stubs/start/jobs.stub

@@ -0,0 +1,6 @@
+{{{ exports({ to: app.makePath('start', 'jobs.ts') }) }}}
+
+const jobs: Record<string, Function> = {
+}
+
+export { jobs }