ac-bootstrap-bull 3.0.12 → 3.0.13

package/.github/workflows/node.js.yml

@@ -0,0 +1,34 @@
+# This workflow will do a clean installation of node dependencies, cache/restore them, build the source code and run tests across different versions of node
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
+
+name: Node.js CI
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+
+  build:
+
+    permissions:
+      contents: read      
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [22.x, 24.x]
+        # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
+
+    steps:
+    - uses: actions/checkout@v5
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v5
+      with:
+        node-version: ${{ matrix.node-version }}
+
+    - run: yarn install
+    - run: yarn run test

package/CHANGELOG.md

@@ -1,3 +1,27 @@
+## [3.0.13](https://github.com/admiralcloud/ac-bootstrap-bull/compare/v3.0.12..v3.0.13) (2026-04-04 10:49:38)
+
+
+### Bug Fix
+
+
+* **App:** Package updates | MP | [f3c59d460e36ec89cddf9ecd0723f31d57892e4e](https://github.com/admiralcloud/ac-bootstrap-bull/commit/f3c59d460e36ec89cddf9ecd0723f31d57892e4e)    
+Package udpates  
+Related issues:
+* **App:** Package updates | MP | [44274e75c86c4dc5dae9b831dd63a492d83a0117](https://github.com/admiralcloud/ac-bootstrap-bull/commit/44274e75c86c4dc5dae9b831dd63a492d83a0117)    
+Package updates  
+Related issues:
+### Tests
+
+
+* **App:** Added tests | MP | [4046d6909ae3525ec71f0bd60ba9b834b935dc08](https://github.com/admiralcloud/ac-bootstrap-bull/commit/4046d6909ae3525ec71f0bd60ba9b834b935dc08)    
+Added tests  
+Related issues:
+### Documentation
+
+
+* **App:** Added badge | MP | [83793ee1d6d33029a05d4ca86aa6cf049ec1c29f](https://github.com/admiralcloud/ac-bootstrap-bull/commit/83793ee1d6d33029a05d4ca86aa6cf049ec1c29f)    
+Added badge for CI  
+Related issues:
 
 ## [3.0.12](https://github.com/admiralcloud/ac-bootstrap-bull/compare/v3.0.11..v3.0.12) (2026-03-21 11:23:53)
 

package/Makefile

@@ -2,10 +2,10 @@ MOCHA_OPTS= --slow 0 -A
 REPORTER = spec
 
 lint-fix:
-	./node_modules/.bin/eslint --fix index.js
+	./node_modules/.bin/eslint --fix
 
 lint-check:
-	./node_modules/.bin/eslint index.js
+	./node_modules/.bin/eslint
 
 commit:
 	@node ./node_modules/ac-semantic-release/lib/commit.js

package/README.md

@@ -1,6 +1,8 @@
 # AdmiralCloud Bull Queue List
 This helper initialitzes Bull lists and helper functions and makes them available on a globally scoped variable.
 
+[![Node.js CI](https://github.com/AdmiralCloud/ac-bootstrap-bull/actions/workflows/node.js.yml/badge.svg)](https://github.com/AdmiralCloud/ac-bootstrap-bull/actions/workflows/node.js.yml) [![CodeQL](https://github.com/AdmiralCloud/ac-bootstrap-bull/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/AdmiralCloud/ac-bootstrap-bull/actions/workflows/github-code-scanning/codeql)
+
 # Usage
 ```
 const bullOptions = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ac-bootstrap-bull",
-  "version": "3.0.12",
+  "version": "3.0.13",
   "description": "Bull helper",
   "repository": {
     "type": "git",
@@ -9,15 +9,24 @@
   "author": "Mark Poepping <mark.poepping@admiralcloud.com>",
   "license": "MIT",
   "dependencies": {
-    "ac-redislock": "^6.0.5",
+    "ac-redislock": "^6.0.6",
     "bull": "^4.16.5",
     "ioredis": "^5.10.1",
-    "lodash": "^4.17.23"
+    "lodash": "^4.18.1"
+  },
+  "scripts": {
+    "test": "mocha test/**/*.test.js"
   },
   "devDependencies": {
-    "ac-semantic-release": "^0.4.10",
-    "eslint": "^10.1.0",
-    "globals": "^17.4.0"
+    "ac-semantic-release": "^1.0.1",
+    "chai": "^5.2.0",
+    "eslint": "^10.2.0",
+    "globals": "^17.4.0",
+    "mocha": "^11.1.0"
+  },
+  "resolutions": {
+    "mocha/serialize-javascript": "^7.0.5",
+    "mocha/diff": "^8.0.3"
   },
   "packageManager": "yarn@1.22.22+sha512.a6b2f7906b721bba3d67d4aff083df04dad64c399707841b7acf00f6b133b7ac24255f2652fa22ae3534329dc6180534e98d17432037ff6fd140556e2bb3137e"
 }

package/test/index.test.js

@@ -0,0 +1,267 @@
+'use strict'
+
+const { expect } = require('chai')
+const bullModule = require('../index')
+
+// ACError is a global in the consuming application
+global.ACError = class ACError extends Error {
+  constructor(code, status, meta) {
+    super(code)
+    this.code = code
+    this.status = status
+    this.meta = meta
+  }
+}
+
+const createAcapi = (overrides = {}) => ({
+  config: {
+    environment: 'test',
+    bull: {
+      log: { functionNameLength: 20, functionIdentifierLength: 20 },
+      jobLists: [
+        { jobList: 'myQueue' },
+        { jobList: 'otherQueue', retentionTime: 5000 }
+      ],
+      ...(overrides.bull || {})
+    },
+    redis: {
+      servers: [{ server: 'jobProcessing', host: 'localhost', port: 6379 }],
+      databases: [{ name: 'jobProcessing', db: 3 }]
+    },
+    ...(overrides.config || {})
+  },
+  log: {
+    error: () => {},
+    warn: () => {},
+    info: () => {},
+    debug: () => {},
+    silly: () => {}
+  },
+  aclog: { serverInfo: () => [] },
+  bull: {},
+  redis: {},
+  ...overrides
+})
+
+// ------------------------------------------------------------------
+// helpers
+// ------------------------------------------------------------------
+
+const makeMockQueue = (addResult = { id: 'job-123' }) => ({
+  add: async (...args) => addResult,
+  close: async () => {}
+})
+
+// ------------------------------------------------------------------
+// tests
+// ------------------------------------------------------------------
+
+describe('ac-bootstrap-bull', () => {
+
+  describe('prepareQueue', () => {
+    let acapi, bull
+
+    beforeEach(() => {
+      acapi = createAcapi()
+      bull = bullModule(acapi)
+    })
+
+    it('returns false when jobList is not in config', () => {
+      expect(bull.prepareQueue({ jobList: 'nonexistent' })).to.be.false
+    })
+
+    it('builds queueName as <environment>.<jobList>', () => {
+      const { queueName } = bull.prepareQueue({ jobList: 'myQueue' })
+      expect(queueName).to.equal('test.myQueue')
+    })
+
+    it('appends localDevelopment suffix to queueName', () => {
+      acapi.config.localDevelopment = '-dev'
+      const { queueName } = bull.prepareQueue({ jobList: 'myQueue' })
+      expect(queueName).to.equal('test-dev.myQueue')
+    })
+
+    it('skips localDevelopment suffix when ignore.localDevelopment is true', () => {
+      acapi.config.localDevelopment = '-dev'
+      const { queueName } = bull.prepareQueue({ jobList: 'myQueue', ignore: { localDevelopment: true } })
+      expect(queueName).to.equal('test.myQueue')
+    })
+
+    it('uses customJobList.environment instead of acapi.config.environment', () => {
+      const { queueName } = bull.prepareQueue({ jobList: 'myQueue', customJobList: { environment: 'staging' } })
+      expect(queueName).to.equal('staging.myQueue')
+    })
+
+    it('returns the matching jobListConfig', () => {
+      const { jobListConfig } = bull.prepareQueue({ jobList: 'myQueue' })
+      expect(jobListConfig).to.deep.equal({ jobList: 'myQueue' })
+    })
+
+    it('uses a custom configPath to look up jobLists', () => {
+      acapi.config.custom = { jobLists: [{ jobList: 'myQueue' }] }
+      const { queueName } = bull.prepareQueue({ jobList: 'myQueue', configPath: 'custom' })
+      expect(queueName).to.equal('test.myQueue')
+    })
+  })
+
+  // ------------------------------------------------------------------
+
+  describe('scope', () => {
+    let acapi, bull
+
+    beforeEach(() => {
+      acapi = createAcapi()
+      bull = bullModule(acapi)
+    })
+
+    it('sets bull.redis.database.name from params.redis.config', () => {
+      bull.scope({ redis: { config: 'myDatabase' } })
+      expect(acapi.config.bull.redis.database.name).to.equal('myDatabase')
+    })
+
+    it('defaults to "jobProcessing" when redis.config is not provided', () => {
+      bull.scope({})
+      expect(acapi.config.bull.redis.database.name).to.equal('jobProcessing')
+    })
+  })
+
+  // ------------------------------------------------------------------
+
+  describe('handleFailedJobs', () => {
+    it('logs an error', () => {
+      let errorLogged = false
+      const acapi = createAcapi()
+      acapi.log.error = () => { errorLogged = true }
+      const bull = bullModule(acapi)
+
+      bull.handleFailedJobs('test.myQueue', 'job-1', new Error('timeout'))
+      expect(errorLogged).to.be.true
+    })
+  })
+
+  // ------------------------------------------------------------------
+
+  describe('addJob', () => {
+    const QUEUE_NAME = 'test.myQueue'
+    let acapi, bull
+
+    beforeEach(() => {
+      acapi = createAcapi()
+      bull = bullModule(acapi)
+      acapi.bull[QUEUE_NAME] = makeMockQueue()
+    })
+
+    it('throws ACError when jobList is not configured', async () => {
+      try {
+        await bull.addJob('unknownQueue', {})
+        expect.fail('expected ACError')
+      } catch (e) {
+        expect(e).to.be.instanceOf(ACError)
+        expect(e.code).to.equal('jobListNotDefined')
+      }
+    })
+
+    it('throws ACError when bull queue is not initialized', async () => {
+      delete acapi.bull[QUEUE_NAME]
+      try {
+        await bull.addJob('myQueue', { jobPayload: {} })
+        expect.fail('expected ACError')
+      } catch (e) {
+        expect(e).to.be.instanceOf(ACError)
+        expect(e.code).to.equal('bullNotAvailableForQueueName')
+      }
+    })
+
+    it('prefixes jobId with customerId when customerId is present', async () => {
+      let capturedOptions
+      acapi.bull[QUEUE_NAME].add = async (payload, options) => {
+        capturedOptions = options
+        return { id: options.jobId }
+      }
+
+      await bull.addJob('myQueue', { jobPayload: { customerId: 'cust-1' } })
+      expect(capturedOptions.jobId).to.match(/^cust-1:::/)
+    })
+
+    it('does not double-prefix when jobId already starts with customerId', async () => {
+      let capturedOptions
+      acapi.bull[QUEUE_NAME].add = async (payload, options) => {
+        capturedOptions = options
+        return { id: options.jobId }
+      }
+
+      await bull.addJob('myQueue', {
+        jobPayload: { customerId: 'cust-1' },
+        jobOptions: { jobId: 'cust-1:::existing-id' }
+      })
+      expect(capturedOptions.jobId).to.equal('cust-1:::existing-id')
+    })
+
+    it('returns { jobId } after adding a named job', async () => {
+      acapi.bull[QUEUE_NAME].add = async (name, payload, options) => ({ id: 'named-job-id' })
+      const result = await bull.addJob('myQueue', { name: 'myJobName', jobPayload: {} })
+      expect(result).to.deep.equal({ jobId: 'named-job-id' })
+    })
+  })
+
+  // ------------------------------------------------------------------
+
+  describe('removeJob', () => {
+    let acapi, bull
+
+    beforeEach(() => {
+      acapi = createAcapi()
+      bull = bullModule(acapi)
+    })
+
+    it('logs an error and returns early when job is null', async () => {
+      let errorLogged = false
+      acapi.log.error = () => { errorLogged = true }
+      bull = bullModule(acapi)
+
+      await bull.removeJob(null, 'test.myQueue')
+      expect(errorLogged).to.be.true
+    })
+
+    it('calls job.remove() on a valid job', async () => {
+      let removed = false
+      const mockJob = {
+        id: 'job-abc',
+        data: {},
+        remove: async () => { removed = true }
+      }
+
+      await bull.removeJob(mockJob, 'test.myQueue')
+      expect(removed).to.be.true
+    })
+
+    it('logs success after removing a valid job', async () => {
+      let infoLogged = false
+      acapi.log.info = () => { infoLogged = true }
+      bull = bullModule(acapi)
+
+      const mockJob = { id: 'job-abc', data: {}, remove: async () => {} }
+      await bull.removeJob(mockJob, 'test.myQueue')
+      expect(infoLogged).to.be.true
+    })
+  })
+
+  // ------------------------------------------------------------------
+
+  describe('shutdown', () => {
+    it('closes all registered queues', async () => {
+      const acapi = createAcapi()
+      const bull = bullModule(acapi)
+      const closedQueues = []
+
+      // manually populate jobLists as init would
+      bull.jobLists.push('test.myQueue', 'test.otherQueue')
+      acapi.bull['test.myQueue']   = { close: async () => closedQueues.push('test.myQueue') }
+      acapi.bull['test.otherQueue'] = { close: async () => closedQueues.push('test.otherQueue') }
+
+      await bull.shutdown()
+      expect(closedQueues).to.include.members(['test.myQueue', 'test.otherQueue'])
+    })
+  })
+
+})