Temporal best practises to execute some cleanup activity before terminating workflow

antonio.perez · August 1, 2023, 2:13pm

Can you send a cancellation request instead of terminating the workflow?

You can learn about the difference here:

So just wanted to understand what is the best way to do cleanup activities?

With cancellation, Inside the activity, you can handle ActivityCompletionException and do any additional cleanup https://github.com/temporalio/samples-java/blob/f107c79e29453ecd43dce522dfd1c980439b3762/core/src/main/java/io/temporal/samples/hello/HelloCancellationScope.java#L207

The same in your workflow code , you can handle the exception and create a detached scope to run an activity

github.com

temporalio/samples-java/blob/f107c79e29453ecd43dce522dfd1c980439b3762/core/src/main/java/io/temporal/samples/hello/HelloDetachedCancellationScope.java#L136


      
                      .setCancellationType(ActivityCancellationType.WAIT_CANCELLATION_COMPLETED)
                      .setHeartbeatTimeout(Duration.ofSeconds(2))
                      .build());
          
          @Override
          public String getGreeting(String name) {
            try {
              this.greeting = activities.sayHello(name);
              return greeting;
            } catch (ActivityFailure af) {
              // Create a CancellationScope that is not linked to a parent scope
              // This can be used in the "cleanup" code after the Workflow Execution has been cancelled.
              CancellationScope detached =
                  Workflow.newDetachedCancellationScope(() -> greeting = activities.sayGoodBye(name));
              detached.run();
              throw af;
            }
          }
          
          @Override
          public String queryGreeting() {

Antonio

Topic		Replies	Views
Handle Request Cancellation/ Terminate from Temporal UI Community Support java-sdk , general-impl	1	119	March 7, 2024
Trouble with workflow cancellation Community Support java-sdk	10	2711	April 18, 2024
When cancelled the workflow does not complete. It continues to be in the running state Community Support java-sdk	6	471	October 17, 2022
When a Workflow is cancelled, how is the ongoing execution handled? Community Support general-impl , workflow-options	5	5960	December 13, 2022
Cancelled workflow waiting for signals Community Support go-sdk	2	896	April 5, 2021

Temporal best practises to execute some cleanup activity before terminating workflow

Related Topics