[SalesForce] How to capture Queueable class status when job is completed

I have created Queueable class to process data and making the callouts this Queueable class executes upon after update and after insert of Opportunity object.

Now in order to track the status of Queueable class I am inserting the status of job into another object i.e. LogInfo object. The purpose of this object is to keep track of jobs, status and error if any.

When the queueable gets executed i do insert the status of it using following code

Execute method of Queueable class

 public void execute(QueueableContext context) {


     SomeHandler.insertStatus(context.getJobId());

 }

 class SomeHandler {

    public Id insertStatus(Id jobId){


     AsyncApexJob apexJob = [SELECT Id ,Status,CompletedDate,ExtendedStatus, 
     NumberOfErrors,JobItemsProcessed,TotalJobItems,CreatedBy.Email 
                                FROM AsyncApexJob 
                                WHERE Id = :jobId];

     LogInfo__c logInfoObj = new LogInfo__c();
     // add job id 
     logInfoObj.JobId__c = jobId;
     // update status
     logInfoObj.JobStatus__c = apexJob.Status;



    }

 }

SomeHandler.insertStatus is being used by multiple Queueable classes , now the issue is so far I am able to record only Processing status as all calls to insertStatus are being made within the exectue method and what I really want to record is the Completed status. However, Queueable class does not have the finish method we do not have any space or hook where in we can record the Queueable class Completed status. In the end we waned to display the real-time dashboard of how many jobs are in the queue and how many are being processed , failed, and completed.

Solutions did not work so far

Can not create a trigger on AsyncApexJob object
Can not use Transaction Finalizers as it is a pilot and available for specially-configured scratch orgs

Best Answer

It looks like you are trying to create a apex jobs view which is available out of the box with with new apex jobs interface.

If you want to do this manually there are two options:

Put you queue able code in try/catch and update the job status to complete at the end of the queuable as last line in try block or as a failure in the catch block . It may not work if the errors are non catch-able like limit exceptions.
Write a batch which runs every 15 minutes, queries the job status for records in log info and updates them.

Related Solutions

[SalesForce] Queueable Job limit hit when trigger is batched

When run in Batch, you can only enqueue 1 job per execution of the batch so if your batch is causing the Trigger to enqueue more than 1, it will fail as described. I'll try to find a link to the docs describing this.

If your trigger is firing, from a batch apex process, and you have 2 Triggers firing that both enqueue a job, you will get the error because both the triggers fire in the same execution context (even though they are separate triggers).

For example:

Batch Apex
    Insert record(s)
        Trigger 1 (enqueue job 1 - ok)
        Trigger 2 (enqueue job 2 - fail)

The only way to get around that would be to ensure that only one enqueue job gets called across all triggers that fire.

[SalesForce] Chaining Queueables: Clarification & Practical Usage

There's two modes of operation in Salesforce: synchronous and asynchronous. The rule is that if you're synchronous, you get 50 jobs for that transaction. Once you go asynchronous, you get only one child allowed. This is done to prevent "rabbits." A rabbit is code that reproduces until it consumes all available resources. In a Queueable, this would be a rabbit:

public class Rabbit implements Queueable {
    public void execute(QueueableContext context) {
        System.enqueueJob(this);
        System.enqueueJob(this);
    }
}

As you can see, one job would spawn 2, those would spawn 4, and those would spawn 8... you end up with exponential growth. Without governor limits, doing such a thing could bring the servers down, which is why we have limits in place, so that this can't happen.

While this is an explicit example, it would be more challenging to necessarily find this condition when you have multiple triggers that each may enqueue a job, perhaps indefinitely.

So, generally speaking, you'll need to make a design choice in order to fix the problem. On potential solution would be to write a utility class, perhaps something like the following:

public class QueueableUtil implements Queueable {
    Queueable[] payload;
    static QueueableUtil self;
    QueueableUtil(Queueable item) {
        payload = new Queueable[] { item };
    }
    public static Id enqueueJob(Queueable item) {
        if(!System.isQueueable()) {
            return System.enqueueJob(new QueueableUtil(item));
        } else {
            self.payload.add(item);
            return null;
        }
    }
    public void execute(QueueableContext context) {
        self = this;
        payload.remove(0).execute(context);
        if(!payload.isEmpty()) {
            System.enqueueJob(this);
        }
    }
}

Now, you can call your items using the new method:

QueueableUtil.enqueueJob(new ContactTriggerHandlerQueueable(Trigger.new));

If you're in a Queueable context, your job will be added to a queue to be executed, and if you're not, you'll be queued normally.

I haven't tested this, but it looks like it should work. Please keep in mind that you may hit heap limits if your queue gets too big, so try to design your Queueable jobs to have as small of a footprint as possible.

Keep in mind that this requires discipline; you'll need to use this utility all the time in order for it to be useful, because it will only queue itself from a non-queueable context so as to not violate the chaining rules.

You may also need to consider adding additional logic if you need to worry about scheduled, future, and batchable contexts, which have similar restrictions (only one call per transaction). I wouldn't consider this a full solution, but it's better than nothing.

Keep in mind that if you use a method like this, it is entirely possible to chain even more than 50 jobs in a single transaction. You may want to add some safeguards to prevent runaway processes.

Best Answer

Related Solutions

[SalesForce] Queueable Job limit hit when trigger is batched

[SalesForce] Chaining Queueables: Clarification & Practical Usage

Related Topic