How to delete an enqueued job?

[drewbaker]

I'd like to be able to delete a enqueued job, based on args.

        await Sidequest.build(ReviewJob)
            .queue(`default`)
            .unique({
                withArgs: true,
                period: "minute",
            })
            .enqueue(jobParams);

And then delete it using the queue and args to find it:

        await Sidequest.deleteJob({
             queue: 'default',
             args: {
                  id: 123,
                  foo: 'bar'                  
             }
        })

Is this possible?

ChatGPT says it's possible but I need the jobId, which I will not have.

import boss from "@sidequest/engine"; // or however you initialized it
await boss.delete(jobId);

Is there a way to do this? Or perhaps a way to get the jobId based on the args?

[GiovaniGuizzo]

Hey @drewbaker. You cannot directly delete a job based on its args, but you can fetch the jobs:

Sidequest.job.list()

There you can pass args and class name as params, and you will get a list of jobs. You find yours, get the ID, and then delete the job by ID.

[drewbaker]

OK, so once I have the job ID, what is the command to delete it?

[GiovaniGuizzo]

After that, you can do:

Sidequest.job.cancel(jobId)

This won't actually delete the job, just cancel it and prevent its execution, or abort it if it's running.
Then it's considered a completed job, thus it will be cleaned based on your cleanup config.

In hindsight, we should have done a delete function, but that would require some lifecycle assertions to do it.

[drewbaker]

Is there a way to list jobs that contain some of the args, rather than exact match of all args?

For example,

Job args:

{
   templateId: 123,
   itemId: 456
}

So I'd want to search all jobs for args.templateId == '123'. Is that possible? Seems like .list() wants an exact match.

Sorry if there are docs anywhere for this, I couldn't find them.

[GiovaniGuizzo]

Yeah, list expects an exact match of args. There is no way of doing partial matches.