Feature 7840 saga annotation robustness

common/src/main/java/org/apache/seata/common/ConfigurationKeys.java

@@ -224,6 +224,12 @@ public interface ConfigurationKeys {
      */
     String CLIENT_SAGA_COMPENSATE_PERSIST_MODE_UPDATE = CLIENT_RM_PREFIX + "sagaCompensatePersistModeUpdate";
 
+    /**
+     * The constant CLIENT_SAGA_ACTION_STATUS_REPORT_ENABLE.
+     * Enable action status report for SAGA/TCC annotation mode to handle empty compensation and suspension issues.
+     */
+    String CLIENT_SAGA_ACTION_STATUS_REPORT_ENABLE = CLIENT_RM_PREFIX + "sagaActionStatusReportEnable";
+
     /**
      * The constant CLIENT_REPORT_RETRY_COUNT.
      */

common/src/main/java/org/apache/seata/common/Constants.java

@@ -250,4 +250,19 @@ public interface Constants {
      * CW stands for Cluster Watch
      */
     String WATCH_EVENT_PREFIX = "CW:";
+
+    /**
+     * Action status key for action context
+     */
+    String ACTION_STATUS = "actionStatus";
+
+    /**
+     * Action status: prepare method executed successfully
+     */
+    String ACTION_STATUS_SUCCESS = "success";
+
+    /**
+     * Action status: prepare method execution failed
+     */
+    String ACTION_STATUS_FAILED = "failed";
 }

integration-tx-api/src/main/java/org/apache/seata/integration/tx/api/interceptor/ActionInterceptorHandler.java

@@ -16,13 +16,15 @@
  */
 package org.apache.seata.integration.tx.api.interceptor;
 
+import org.apache.seata.common.ConfigurationKeys;
 import org.apache.seata.common.Constants;
 import org.apache.seata.common.exception.FrameworkException;
 import org.apache.seata.common.exception.SkipCallbackWrapperException;
 import org.apache.seata.common.executor.Callback;
 import org.apache.seata.common.json.JsonUtil;
 import org.apache.seata.common.util.CollectionUtils;
 import org.apache.seata.common.util.NetUtil;
+import org.apache.seata.config.ConfigurationFactory;
 import org.apache.seata.core.context.RootContext;
 import org.apache.seata.integration.tx.api.fence.DefaultCommonFenceHandler;
 import org.apache.seata.integration.tx.api.fence.hook.TccHook;
@@ -53,6 +55,9 @@ public class ActionInterceptorHandler {
 
     private static final Logger LOGGER = LoggerFactory.getLogger(ActionInterceptorHandler.class);
 
+    private static final boolean ENABLE_ACTION_STATUS_REPORT = ConfigurationFactory.getInstance()
+            .getBoolean(ConfigurationKeys.CLIENT_SAGA_ACTION_STATUS_REPORT_ENABLE, false);
+
     /**
      * Handler the Tx Aspect
      *
@@ -111,7 +116,20 @@ public Object proceed(
                 }
             } else {
                 // Execute business, and return the business result
-                return targetCallback.execute();
+                try {
+                    Object result = targetCallback.execute();
+                    // Report action status: success (only for non-CommonFence mode)
+                    if (ENABLE_ACTION_STATUS_REPORT) {
+                        reportActionStatus(actionContext, Constants.ACTION_STATUS_SUCCESS);
+                    }
+                    return result;
+                } catch (Throwable t) {
+                    // Report action status: failed (only for non-CommonFence mode)
+                    if (ENABLE_ACTION_STATUS_REPORT) {
+                        reportActionStatus(actionContext, Constants.ACTION_STATUS_FAILED);
+                    }
+                    throw t;
+                }
             }
         } finally {
             try {
@@ -325,4 +343,32 @@ protected Map<String, Object> fetchActionRequestContext(Method method, Object[]
         }
         return context;
     }
+
+    /**
+     * Report action status to TC
+     *
+     * @param actionContext the action context
+     * @param status        the action status (success/failed)
+     */
+    protected void reportActionStatus(BusinessActionContext actionContext, String status) {
+        try {
+            actionContext.setActionStatus(status);
+            actionContext.setUpdated(true);
+            BusinessActionContextUtil.reportContext(actionContext);
+            if (LOGGER.isDebugEnabled()) {
+                LOGGER.debug(
+                        "Report action status: xid={}, branchId={}, status={}",
+                        actionContext.getXid(),
+                        actionContext.getBranchId(),
+                        status);
+            }
+        } catch (Exception e) {
+            LOGGER.warn(
+                    "Report action status failed: xid={}, branchId={}, status={}, error={}",
+                    actionContext.getXid(),
+                    actionContext.getBranchId(),
+                    status,
+                    e.getMessage());
+        }
+    }
 }

integration-tx-api/src/main/java/org/apache/seata/rm/tcc/api/BusinessActionContext.java

@@ -16,6 +16,7 @@
  */
 package org.apache.seata.rm.tcc.api;
 
+import org.apache.seata.common.Constants;
 import org.apache.seata.core.model.BranchType;
 import org.apache.seata.integration.tx.api.interceptor.ActionContextUtil;
 
@@ -233,6 +234,30 @@ public void setBranchType(BranchType branchType) {
         this.branchType = branchType;
     }
 
+    /**
+     * Gets action status.
+     *
+     * @return the action status
+     */
+    public String getActionStatus() {
+        if (actionContext == null) {
+            return null;
+        }
+        Object status = actionContext.get(Constants.ACTION_STATUS);
+        return status != null ? status.toString() : null;
+    }
+
+    /**
+     * Sets action status.
+     *
+     * @param status the action status
+     */
+    public void setActionStatus(String status) {
+        if (actionContext != null && status != null) {
+            actionContext.put(Constants.ACTION_STATUS, status);
+        }
+    }
+
     @Override
     public String toString() {
         StringBuilder sb = new StringBuilder();

integration-tx-api/src/test/java/org/apache/seata/rm/tcc/api/BusinessActionContextTest.java

@@ -0,0 +1,111 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.seata.rm.tcc.api;
+
+import org.apache.seata.common.Constants;
+import org.junit.jupiter.api.Test;
+
+import java.util.HashMap;
+import java.util.Map;
+
+import static org.junit.jupiter.api.Assertions.*;
+
+/**
+ * Test cases for BusinessActionContext action status methods.
+ */
+public class BusinessActionContextTest {
+
+    @Test
+    public void testGetActionStatusWhenContextIsNull() {
+        BusinessActionContext context = new BusinessActionContext();
+        assertNull(context.getActionStatus(), "Action status should be null when actionContext is null");
+    }
+
+    @Test
+    public void testGetActionStatusWhenNotSet() {
+        BusinessActionContext context = new BusinessActionContext();
+        Map<String, Object> actionContext = new HashMap<>();
+        context.setActionContext(actionContext);
+
+        assertNull(context.getActionStatus(), "Action status should be null when not set");
+    }
+
+    @Test
+    public void testSetAndGetActionStatusSuccess() {
+        BusinessActionContext context = new BusinessActionContext();
+        Map<String, Object> actionContext = new HashMap<>();
+        context.setActionContext(actionContext);
+
+        context.setActionStatus(Constants.ACTION_STATUS_SUCCESS);
+
+        assertEquals(Constants.ACTION_STATUS_SUCCESS, context.getActionStatus(), "Action status should be 'success'");
+    }
+
+    @Test
+    public void testSetAndGetActionStatusFailed() {
+        BusinessActionContext context = new BusinessActionContext();
+        Map<String, Object> actionContext = new HashMap<>();
+        context.setActionContext(actionContext);
+
+        context.setActionStatus(Constants.ACTION_STATUS_FAILED);
+
+        assertEquals(Constants.ACTION_STATUS_FAILED, context.getActionStatus(), "Action status should be 'failed'");
+    }
+
+    @Test
+    public void testSetActionStatusWithNullStatus() {
+        BusinessActionContext context = new BusinessActionContext();
+        Map<String, Object> actionContext = new HashMap<>();
+        context.setActionContext(actionContext);
+
+        context.setActionStatus(Constants.ACTION_STATUS_SUCCESS);
+        context.setActionStatus(null);
+
+        assertEquals(
+                Constants.ACTION_STATUS_SUCCESS,
+                context.getActionStatus(),
+                "Action status should not change when setting null");
+    }
+
+    @Test
+    public void testSetActionStatusWithNullActionContext() {
+        BusinessActionContext context = new BusinessActionContext();
+
+        // Should not throw exception
+        assertDoesNotThrow(
+                () -> context.setActionStatus(Constants.ACTION_STATUS_SUCCESS),
+                "Setting action status with null actionContext should not throw exception");
+
+        assertNull(context.getActionStatus(), "Action status should still be null");
+    }
+
+    @Test
+    public void testActionStatusOverwrite() {
+        BusinessActionContext context = new BusinessActionContext();
+        Map<String, Object> actionContext = new HashMap<>();
+        context.setActionContext(actionContext);
+
+        context.setActionStatus(Constants.ACTION_STATUS_SUCCESS);
+        assertEquals(Constants.ACTION_STATUS_SUCCESS, context.getActionStatus());
+
+        context.setActionStatus(Constants.ACTION_STATUS_FAILED);
+        assertEquals(
+                Constants.ACTION_STATUS_FAILED,
+                context.getActionStatus(),
+                "Action status should be overwritten to 'failed'");
+    }
+}

saga/seata-saga-annotation/src/main/java/org/apache/seata/saga/rm/SagaAnnotationResourceManager.java

@@ -23,12 +23,15 @@
 import org.apache.seata.core.model.BranchStatus;
 import org.apache.seata.core.model.BranchType;
 import org.apache.seata.core.model.Resource;
+import org.apache.seata.integration.tx.api.fence.hook.TccHook;
+import org.apache.seata.integration.tx.api.fence.hook.TccHookManager;
 import org.apache.seata.integration.tx.api.remoting.TwoPhaseResult;
 import org.apache.seata.rm.AbstractResourceManager;
 import org.apache.seata.rm.tcc.api.BusinessActionContext;
 import org.apache.seata.rm.tcc.api.BusinessActionContextUtil;
 
 import java.lang.reflect.Method;
+import java.util.List;
 import java.util.Map;
 import java.util.concurrent.ConcurrentHashMap;
 
@@ -100,12 +103,15 @@ public BranchStatus branchRollback(
                     String.format("SagaAnnotation resource is not available, resourceId: %s", resourceId));
         }
 
+        BusinessActionContext businessActionContext = null;
         try {
-            BusinessActionContext businessActionContext =
+            businessActionContext =
                     BusinessActionContextUtil.getBusinessActionContext(xid, branchId, resourceId, applicationData);
             Object[] args = this.getTwoPhaseRollbackArgs(resource, businessActionContext);
             BusinessActionContextUtil.setContext(businessActionContext);
 
+            doBeforeSagaAnnotationRollback(xid, branchId, resource.getActionName(), businessActionContext);
+
             boolean result;
             Object ret = compensationMethod.invoke(targetBean, args);
             if (ret != null) {
@@ -131,6 +137,7 @@ public BranchStatus branchRollback(
             LOGGER.error(msg, ExceptionUtil.unwrap(t));
             return BranchStatus.PhaseTwo_RollbackFailed_Retryable;
         } finally {
+            doAfterSagaAnnotationRollback(xid, branchId, resource.getActionName(), businessActionContext);
             BusinessActionContextUtil.clear();
         }
     }
@@ -164,4 +171,48 @@ protected Object[] getTwoPhaseMethodParams(
         }
         return args;
     }
+
+    /**
+     * to do some business operations before saga annotation rollback
+     * @param xid          the xid
+     * @param branchId     the branchId
+     * @param actionName   the actionName
+     * @param context      the business action context
+     */
+    private void doBeforeSagaAnnotationRollback(
+            String xid, long branchId, String actionName, BusinessActionContext context) {
+        List<TccHook> hooks = TccHookManager.getHooks();
+        if (hooks.isEmpty()) {
+            return;
+        }
+        for (TccHook hook : hooks) {
+            try {
+                hook.beforeTccRollback(xid, branchId, actionName, context);
+            } catch (Exception e) {
+                LOGGER.error("Failed execute beforeTccRollback in hook {}", e.getMessage(), e);
+            }
+        }
+    }
+
+    /**
+     * to do some business operations after saga annotation rollback
+     * @param xid          the xid
+     * @param branchId     the branchId
+     * @param actionName   the actionName
+     * @param context      the business action context
+     */
+    private void doAfterSagaAnnotationRollback(
+            String xid, long branchId, String actionName, BusinessActionContext context) {
+        List<TccHook> hooks = TccHookManager.getHooks();
+        if (hooks.isEmpty()) {
+            return;
+        }
+        for (TccHook hook : hooks) {
+            try {
+                hook.afterTccRollback(xid, branchId, actionName, context);
+            } catch (Exception e) {
+                LOGGER.error("Failed execute afterTccRollback in hook {}", e.getMessage(), e);
+            }
+        }
+    }
 }