{"id":19632994,"url":"https://github.com/kabbouchi/adonisjs-jobs","last_synced_at":"2025-04-28T07:30:43.061Z","repository":{"id":229180697,"uuid":"775973479","full_name":"KABBOUCHI/adonisjs-jobs","owner":"KABBOUCHI","description":"Job processing for AdonisJS","archived":false,"fork":false,"pushed_at":"2025-03-25T15:13:30.000Z","size":61,"stargazers_count":24,"open_issues_count":0,"forks_count":4,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-05T07:33:01.135Z","etag":null,"topics":["adonisjs","background-jobs","bullmq","jobs","queue","redis"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/KABBOUCHI.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-03-22T12:25:48.000Z","updated_at":"2025-03-31T14:16:57.000Z","dependencies_parsed_at":null,"dependency_job_id":"7f647a4f-d568-4347-8ab7-2083f0d31285","html_url":"https://github.com/KABBOUCHI/adonisjs-jobs","commit_stats":null,"previous_names":["kabbouchi/adonisjs-jobs"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KABBOUCHI%2Fadonisjs-jobs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KABBOUCHI%2Fadonisjs-jobs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KABBOUCHI%2Fadonisjs-jobs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KABBOUCHI%2Fadonisjs-jobs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/KABBOUCHI","download_url":"https://codeload.github.com/KABBOUCHI/adonisjs-jobs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251271082,"owners_count":21562487,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["adonisjs","background-jobs","bullmq","jobs","queue","redis"],"created_at":"2024-11-11T12:15:57.428Z","updated_at":"2025-04-28T07:30:43.046Z","avatar_url":"https://github.com/KABBOUCHI.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n  \u003ch1\u003e\u003cb\u003eAdonisJS Jobs\u003c/b\u003e\u003c/h1\u003e\n\n  \u003cp\u003eJob processing for AdonisJS v6 using \u003ca href=\"https://bullmq.io/\" target=\"_blank\"\u003eBullMQ\u003c/a\u003e\u003c/p\u003e\n\u003c/div\u003e\n\n## Getting Started\n\nThis package is available in the npm registry.\n\n```bash\npnpm install adonisjs-jobs\n```\n\nNext, configure the package by running the following command.\n\n```bash\nnode ace configure adonisjs-jobs\n```\n\n## Creating Jobs\n\nYou can create a new job by running the following command.\n\n```sh\nnode ace jobs:make SendEmail\n```\n\n## Listening for Jobs\n\nFirst, you need to start the jobs listener, you can spawn multiple listeners to process jobs concurrently.\n\n```sh\nnode ace jobs:listen  # default queue from env `REDIS_QUEUE`\n\nnode ace jobs:listen --queue=high\nnode ace jobs:listen --queue=high --queue=medium\nnode ace jobs:listen --queue=high,medium,low\n\nnode ace jobs:listen --queue=high --concurrency=3\n```\n\n## Dispatching Jobs\n\nDispatching jobs is as simple as importing the job class and calling\n\n```ts\nimport SendEmail from 'path/to/jobs/send_email.js'\n\nawait SendEmail.dispatch({ ... })\n\nawait SendEmail.dispatch({ ... }, { // for more job options check https://docs.bullmq.io/\n  attempts: 3,\n  delay: 1000,\n})\n```\n\n## Import Aliases (optional)\n\nupdate your `package.json` and `tsconfig.json` to use import aliases\n\n`package.json`\n\n```json\n{\n  \"imports\": {\n    \"#jobs/*\": \"./app/jobs/*.js\"\n  }\n}\n```\n\n`tsconfig.json`\n\n```json\n{\n  \"compilerOptions\": {\n    \"paths\": {\n      \"#jobs/*\": [\"./app/jobs/*.js\"]\n    }\n  }\n}\n```\n\n```ts\nimport SendEmail from '#jobs/send_email.js'\n\nawait SendEmail.dispatch({ ... })\n```\n\n## Jobs Dashboard\n\nYou can view the jobs dashboard by adding the following route to your `start/routes.ts` file.\n\n```ts\nimport router from '@adonisjs/core/services/router'\n\nrouter.jobs() // default is /jobs\n\n// or\n\nrouter.jobs('/my-jobs-dashboard')\n```\n\n`router.jobs()` returns a route group, you can add middleware to the group\n\n```ts\nrouter.jobs().use(\n  middleware.auth({\n    guards: ['basicAuth'],\n  })\n)\n```\n\n## Tips\n\n### Job Completion on Kubernetes\n\nIn Kubernetes, prevent job termination by adjusting `terminationGracePeriodSeconds` (default is 30s) to allow jobs to finish gracefully.\n\n```yaml\nspec:\n  containers:\n    - name: listen-jobs\n      image: \u003cIMAGE\u003e\n      command: ['node']\n      args: ['ace', 'jobs:listen']\nterminationGracePeriodSeconds: 1800\n```\n\n## Experimental Features\n\n### Dispatch Closure\n\n```ts\nimport { dispatch } from 'adonisjs-jobs/services/main'\n\nawait dispatch(async () =\u003e {\n  const { default: User } = await import('#models/user')\n\n  console.log(await User.query().count('*'))\n})\n\nawait dispatch(async () =\u003e {\n  const { default: mail } = await import('@adonisjs/mail/services/main')\n\n  await mail.send((message) =\u003e {\n    message\n      .to('doe@example.org')\n      .from('info@example.org')\n      .subject('Verify your email address')\n      .htmlView('emails/verify_email')\n  })\n})\n```\n\n## Alternative Ways to Run the Job Worker\n\nBesides using `node ace jobs:listen`, you can also manually initialize and control the job worker in your code:\n\n```ts\nimport { Worker } from 'adonisjs-jobs'\nimport app from '@adonisjs/core/services/app'\n\nconst worker = new Worker(app, {\n  queues: ['default', 'mail'],\n  concurrency: 1,\n})\n\napp.terminating(async () =\u003e {\n  await worker.stop()\n})\n\nawait worker.start()\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkabbouchi%2Fadonisjs-jobs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkabbouchi%2Fadonisjs-jobs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkabbouchi%2Fadonisjs-jobs/lists"}