Transaction Finalizers

1global void execute(System.FinalizerContext ctx) {}

1public class LoggingFinalizer implements Finalizer, Queueable {
2
3  // Queueable implementation
4  // A queueable job that uses LoggingFinalizer to buffer the log
5  // and commit upon exit, even if the queueable execution fails
6
7    public void execute(QueueableContext ctx) {
8        String jobId = '' + ctx.getJobId();
9        System.debug('Begin: executing queueable job: ' + jobId);
10        try {
11            // Create an instance of LoggingFinalizer and attach it
12            // Alternatively, System.attachFinalizer(this) can be used instead of instantiating LoggingFinalizer
13            LoggingFinalizer f = new LoggingFinalizer();
14            System.attachFinalizer(f);
15
16            // While executing the job, log using LoggingFinalizer.addLog()
17            // Note that addlog() modifies the Finalizer's state after it is attached 
18            DateTime start = DateTime.now();
19            f.addLog('About to do some work...', jobId);
20
21            while (true) {
22              // Results in limit error
23            }
24        } catch (Exception e) {
25            System.debug('Error executing the job [' + jobId + ']: ' + e.getMessage());
26        } finally {
27            System.debug('Completed: execution of queueable job: ' + jobId);
28        }
29    }
30
31  // Finalizer implementation
32  // Logging finalizer provides a public method addLog(message,source) that allows buffering log lines from the Queueable job.
33  // When the Queueable job completes, regardless of success or failure, the LoggingFinalizer instance commits this buffered log.
34  // Custom object LogMessage__c has four custom fields-see addLog() method.
35
36    // internal log buffer
37    private List<LogMessage__c> logRecords = new List<LogMessage__c>();
38
39    public void execute(FinalizerContext ctx) {
40        String parentJobId = ctx.getAsyncApexJobId();
41        System.debug('Begin: executing finalizer attached to queueable job: ' + parentJobId);
42
43        // Update the log records with the parent queueable job id
44        System.Debug('Updating job id on ' + logRecords.size() + ' log records');
45        for (LogMessage__c log : logRecords) {
46            log.Request__c = parentJobId; // or could be ctx.getRequestId()
47        }
48        // Commit the buffer
49        System.Debug('committing log records to database');
50        Database.insert(logRecords, false);
51
52        if (ctx.getResult() == ParentJobResult.SUCCESS) {
53            System.debug('Parent queueable job [' + parentJobId + '] completed successfully.');
54        } else {
55            System.debug('Parent queueable job [' + parentJobId + '] failed due to unhandled exception: ' + ctx.getException().getMessage());
56            System.debug('Enqueueing another instance of the queueable...');
57        }
58        System.debug('Completed: execution of finalizer attached to queueable job: ' + parentJobId);
59    }
60
61    public void addLog(String message, String source) {
62        // append the log message to the buffer
63        logRecords.add(new LogMessage__c(
64            DateTime__c = DateTime.now(),
65            Message__c = message,
66            Request__c = 'setbeforecommit',
67            Source__c = source
68        ));
69    }
70}

1public class RetryLimitDemo implements Finalizer, Queueable {
2
3  // Queueable implementation
4  public void execute(QueueableContext ctx) {
5    String jobId = '' + ctx.getJobId();
6    System.debug('Begin: executing queueable job: ' + jobId);
7    try {
8        Finalizer finalizer = new RetryLimitDemo();
9        System.attachFinalizer(finalizer);
10        System.debug('Attached finalizer');
11        Integer accountNumber = 1;
12        while (true) { // results in limit error
13          Account a = new Account();
14          a.Name = 'Account-Number-' + accountNumber;
15          insert a;
16          accountNumber++;
17        }
18    } catch (Exception e) {
19        System.debug('Error executing the job [' + jobId + ']: ' + e.getMessage());
20    } finally {
21        System.debug('Completed: execution of queueable job: ' + jobId);
22    }
23  }
24
25  // Finalizer implementation
26  public void execute(FinalizerContext ctx) {
27    String parentJobId = '' + ctx.getAsyncApexJobId();
28    System.debug('Begin: executing finalizer attached to queueable job: ' + parentJobId);
29    if (ctx.getResult() == ParentJobResult.SUCCESS) {
30        System.debug('Parent queueable job [' + parentJobId + '] completed successfully.');
31    } else {
32        System.debug('Parent queueable job [' + parentJobId + '] failed due to unhandled exception: ' + ctx.getException().getMessage());
33        System.debug('Enqueueing another instance of the queueable...');
34        String newJobId = '' + System.enqueueJob(new RetryLimitDemo()); // This call fails after 5 times when it hits the chaining limit
35        System.debug('Enqueued new job: ' + newJobId);
36    }
37    System.debug('Completed: execution of finalizer attached to queueable job: ' + parentJobId);
38  }
39}