example.ts

import * as Bull from 'bull'
import Queue3 from 'bull'
import { Queue as QueueMQ, QueueScheduler, Worker } from 'bullmq'
import express from 'express'
import { createBullBoard } from './src'
import { BullAdapter } from './src/queueAdapters/bull'
import { BullMQAdapter } from './src/queueAdapters/bullMQ'

const redisOptions = {
  port: 6379,
  host: 'localhost',
  password: '',
}

const sleep = (t: number) =>
  new Promise((resolve) => setTimeout(resolve, t * 1000))

const createQueue3 = (name: string) => new Queue3(name, { redis: redisOptions })
const createQueueMQ = (name: string) =>
  new QueueMQ(name, { connection: redisOptions })

function setupBullProcessor(bullQueue: Bull.Queue) {
  bullQueue.process(async (job) => {
    for (let i = 0; i <= 100; i++) {
      await sleep(Math.random())
      await job.progress(i)
      await job.log(`Processing job at interval ${i}`)
      if (Math.random() * 200 < 1) throw new Error(`Random error ${i}`)
    }

    return { jobId: `This is the return value of job (${job.id})` }
  })
}

async function setupBullMQProcessor(queueName: string) {
  const queueScheduler = new QueueScheduler(queueName, {
    connection: redisOptions,
  })
  await queueScheduler.waitUntilReady()

  new Worker(queueName, async (job) => {
    for (let i = 0; i <= 100; i++) {
      await sleep(Math.random())
      await job.updateProgress(i)
      await job.log(`Processing job at interval ${i}`)

      if (Math.random() * 200 < 1) throw new Error(`Random error ${i}`)
    }

    return { jobId: `This is the return value of job (${job.id})` }
  })
}

const run = async () => {
  const app = express()

  const exampleBull = createQueue3('ExampleBull')
  const exampleBullMq = createQueueMQ('ExampleBullMQ')

  await setupBullProcessor(exampleBull) // needed only for example proposes
  await setupBullMQProcessor(exampleBullMq.name) // needed only for example proposes

  app.use('/add', (req, res) => {
    const opts = req.query.opts || ({} as any)

    if (opts.delay) {
      opts.delay = +opts.delay * 1000 // delay must be a number
    }

    exampleBull.add({ title: req.query.title }, opts)
    exampleBullMq.add('Add', { title: req.query.title }, opts)

    res.json({
      ok: true,
    })
  })

  const { router: bullBoardRouter } = createBullBoard([
    new BullMQAdapter(exampleBullMq),
    new BullAdapter(exampleBull),
  ])

  app.use('/ui', bullBoardRouter)

  app.listen(3000, () => {
    console.log('Running on 3000...')
    console.log('For the UI, open http://localhost:3000/ui')
    console.log('Make sure Redis is running on port 6379 by default')
    console.log('To populate the queue, run:')
    console.log('  curl http://localhost:3000/add?title=Example')
    console.log('To populate the queue with custom options (opts), run:')
    console.log('  curl http://localhost:3000/add?title=Test&opts[delay]=10')
  })
}

run().catch((e) => console.error(e))