What is the recommended way to retrieve results from completed job?

[sfdcale]

I am using BullMQ with express server to process jobs asynchronously but confused as how to retrieve the results from completed jobs.

What I am doing currently is to listen for job completed status event and store those results in an object with job Id as key and retrieving the results from that object whenever I need it. Is there a recommended way of doing this?

I looked at documentation but couldn't find anything about how to retrieve results.

Here is the sample code:

// Kick off a new job by adding it to the work queue
app.post("/api/submitjob", async (req, res) => {
  let job = await workQueue.add();
  res.json({ id: job.id });
});

app.get("/api/jobstatus/:id", async (req, res) => {
  let id = req.params.id;
  let job = await workQueue.getJob(id);

  if (job === null) {
    res.status(404).end();
  } else {
    let state = await job.getState();
    let reason = job.failedReason;
    res.json({ id, state, progress, reason, result: jobIdResultMap[id] });
  }
});

// You can listen to global events to get notified when jobs are processed
workQueue.on('global:completed', (jobId, result) => {
  logger.log('info', `${jobId} succesfully completed`);
  jobIdResultMap[jobId] = JSON.parse(result);
});

app.listen(PORT, () => console.log(`✅  API Server started: http://${HOST}:${PORT}/api/v1/endpoint`));

[manast]

Please let me know if the information here is enough or we need to improve the documentation https://docs.bullmq.io/guide/returning-job-data

[sfdcale]

@manast Thank you for pointing to me that article. It gave me some pointers on how to get result from processed job.

I have one more question as how to get job status efficiently when server receives request from client about job status.

Here in the below pseudo code, I am using job.getState() method but the documentation says, don't use this method as it is not efficient.

app.get("/api/jobstatus/:id", async (req, res) => {
  let id = req.params.id;
  let job = await workQueue.getJob(id);

  if (job === null) {
    res.status(404).end();
  } else {
    let state = await job.getState();
    let reason = job.failedReason;
    res.json({ id, state, progress, reason, result: job.returnvalue });
  }
});

What is the recommended approach to get job status in this situation?

Also, if you can point me to some example code on how to use results queue approach, that would be awesome.

[TemaSM]

@manast how about to add more detailed info (like code examples) to this section?
https://docs.bullmq.io/guide/returning-job-data#using-a-results-queue
Thanks in advance 😉

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.