You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@servicecomb.apache.org by ni...@apache.org on 2018/09/02 14:12:51 UTC

[incubator-servicecomb-saga] branch master updated: SCB-876 Add ParameterContext to store the parameters of TCC method

This is an automated email from the ASF dual-hosted git repository.

ningjiang pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-servicecomb-saga.git


The following commit(s) were added to refs/heads/master by this push:
     new 9424a33  SCB-876 Add ParameterContext to store the parameters of TCC method
9424a33 is described below

commit 9424a33881e8609639867f0212088f0f9c5c77db
Author: Willem Jiang <ji...@huawei.com>
AuthorDate: Sun Sep 2 21:57:54 2018 +0800

    SCB-876 Add ParameterContext to store the parameters of TCC method
---
 .../saga/omega/context/OmegaContext.java           | 15 --------
 .../saga/omega/spring/OmegaSpringConfig.java       |  7 ++++
 .../spring/TransactionAspectConfig.java            | 10 +++---
 .../omega/transaction/spring/MessageConfig.java    |  7 ++++
 .../transaction/spring/TccInterceptorTest.java     | 10 ------
 .../transaction/tcc/CoordinateMessageHandler.java  | 12 +++++--
 .../transaction/tcc/DefaultParametersContext.java  | 40 ++++++++++++++++++++++
 .../transaction/tcc/TccParticipatorAspect.java     |  9 ++++-
 .../tcc/CoordinateMessageHandlerTest.java          |  3 +-
 .../transaction/tcc/TccParticipatorAspectTest.java |  3 +-
 10 files changed, 82 insertions(+), 34 deletions(-)

diff --git a/omega/omega-context/src/main/java/org/apache/servicecomb/saga/omega/context/OmegaContext.java b/omega/omega-context/src/main/java/org/apache/servicecomb/saga/omega/context/OmegaContext.java
index 4055a69..c84337a 100644
--- a/omega/omega-context/src/main/java/org/apache/servicecomb/saga/omega/context/OmegaContext.java
+++ b/omega/omega-context/src/main/java/org/apache/servicecomb/saga/omega/context/OmegaContext.java
@@ -30,12 +30,6 @@ public class OmegaContext {
   private final ThreadLocal<String> globalTxId = new InheritableThreadLocal<>();
   private final ThreadLocal<String> localTxId = new InheritableThreadLocal<>();
   private final IdGenerator<String> idGenerator;
-  private final ThreadLocal<Map<String, Object[]>> parameters = new InheritableThreadLocal<Map<String, Object[]>>() {
-    @Override
-    protected Map<String, Object[]> initialValue() {
-      return new HashMap<>();
-    }
-  };
 
   public OmegaContext(IdGenerator<String> idGenerator) {
     this.idGenerator = idGenerator;
@@ -69,18 +63,9 @@ public class OmegaContext {
     return localTxId.get();
   }
 
-  public void setParameters(String localTxId, Object ... parameters) {
-    this.parameters.get().put(localTxId, parameters);
-  }
-
-  public Object[] parameters(String localTxId) {
-    return parameters.get().get(localTxId);
-  }
-
   public void clear() {
     globalTxId.remove();
     localTxId.remove();
-    parameters.remove();
   }
 
   @Override
diff --git a/omega/omega-spring-starter/src/main/java/org/apache/servicecomb/saga/omega/spring/OmegaSpringConfig.java b/omega/omega-spring-starter/src/main/java/org/apache/servicecomb/saga/omega/spring/OmegaSpringConfig.java
index 2db09dd..cc6b264 100644
--- a/omega/omega-spring-starter/src/main/java/org/apache/servicecomb/saga/omega/spring/OmegaSpringConfig.java
+++ b/omega/omega-spring-starter/src/main/java/org/apache/servicecomb/saga/omega/spring/OmegaSpringConfig.java
@@ -32,6 +32,8 @@ import org.apache.servicecomb.saga.omega.format.KryoMessageFormat;
 import org.apache.servicecomb.saga.omega.format.MessageFormat;
 import org.apache.servicecomb.saga.omega.transaction.MessageHandler;
 import org.apache.servicecomb.saga.omega.transaction.MessageSender;
+import org.apache.servicecomb.saga.omega.transaction.tcc.DefaultParametersContext;
+import org.apache.servicecomb.saga.omega.transaction.tcc.ParametersContext;
 import org.apache.servicecomb.saga.omega.transaction.tcc.TccEventService;
 import org.springframework.beans.factory.annotation.Qualifier;
 import org.springframework.beans.factory.annotation.Value;
@@ -68,6 +70,11 @@ class OmegaSpringConfig {
   }
 
   @Bean
+  ParametersContext parametersContext() {
+    return new DefaultParametersContext();
+  }
+
+  @Bean
   MessageSender grpcMessageSender(
       @Value("${alpha.cluster.address:localhost:8080}") String[] addresses,
       @Value("${alpha.cluster.ssl.enable:false}") boolean enableSSL,
diff --git a/omega/omega-spring-tx/src/main/java/org/apache/servicecomb/saga/omega/transaction/spring/TransactionAspectConfig.java b/omega/omega-spring-tx/src/main/java/org/apache/servicecomb/saga/omega/transaction/spring/TransactionAspectConfig.java
index 1516394..92d8bf4 100644
--- a/omega/omega-spring-tx/src/main/java/org/apache/servicecomb/saga/omega/transaction/spring/TransactionAspectConfig.java
+++ b/omega/omega-spring-tx/src/main/java/org/apache/servicecomb/saga/omega/transaction/spring/TransactionAspectConfig.java
@@ -25,6 +25,7 @@ import org.apache.servicecomb.saga.omega.transaction.MessageSender;
 import org.apache.servicecomb.saga.omega.transaction.SagaStartAspect;
 import org.apache.servicecomb.saga.omega.transaction.TransactionAspect;
 import org.apache.servicecomb.saga.omega.transaction.tcc.CoordinateMessageHandler;
+import org.apache.servicecomb.saga.omega.transaction.tcc.ParametersContext;
 import org.apache.servicecomb.saga.omega.transaction.tcc.TccEventService;
 import org.apache.servicecomb.saga.omega.transaction.tcc.TccParticipatorAspect;
 import org.apache.servicecomb.saga.omega.transaction.tcc.TccStartAspect;
@@ -66,8 +67,9 @@ public class TransactionAspectConfig {
   org.apache.servicecomb.saga.omega.transaction.tcc.MessageHandler coordinateMessageHandler(
       TccEventService tccEventService,
       @Qualifier("coordinateContext") CallbackContext coordinateContext,
-      OmegaContext omegaContext) {
-    return new CoordinateMessageHandler(tccEventService, coordinateContext, omegaContext);
+      OmegaContext omegaContext,
+      ParametersContext parametersContext) {
+    return new CoordinateMessageHandler(tccEventService, coordinateContext, omegaContext, parametersContext);
   }
 
   @Order(0)
@@ -78,8 +80,8 @@ public class TransactionAspectConfig {
 
   @Order(1)
   @Bean
-  TccParticipatorAspect tccParticipatorAspect(TccEventService tccEventService, OmegaContext context) {
-    return new TccParticipatorAspect(tccEventService, context);
+  TccParticipatorAspect tccParticipatorAspect(TccEventService tccEventService, OmegaContext context, ParametersContext parametersContext) {
+    return new TccParticipatorAspect(tccEventService, context, parametersContext);
   }
 
   @Bean
diff --git a/omega/omega-spring-tx/src/test/java/org/apache/servicecomb/saga/omega/transaction/spring/MessageConfig.java b/omega/omega-spring-tx/src/test/java/org/apache/servicecomb/saga/omega/transaction/spring/MessageConfig.java
index 6651248..1015f9b 100644
--- a/omega/omega-spring-tx/src/test/java/org/apache/servicecomb/saga/omega/transaction/spring/MessageConfig.java
+++ b/omega/omega-spring-tx/src/test/java/org/apache/servicecomb/saga/omega/transaction/spring/MessageConfig.java
@@ -25,6 +25,8 @@ import org.apache.servicecomb.saga.omega.context.OmegaContext;
 import org.apache.servicecomb.saga.omega.transaction.AlphaResponse;
 import org.apache.servicecomb.saga.omega.transaction.MessageSender;
 import org.apache.servicecomb.saga.omega.transaction.TxEvent;
+import org.apache.servicecomb.saga.omega.transaction.tcc.DefaultParametersContext;
+import org.apache.servicecomb.saga.omega.transaction.tcc.ParametersContext;
 import org.apache.servicecomb.saga.omega.transaction.tcc.TccEventService;
 import org.apache.servicecomb.saga.omega.transaction.tcc.events.CoordinatedEvent;
 import org.apache.servicecomb.saga.omega.transaction.tcc.events.ParticipatedEvent;
@@ -54,6 +56,11 @@ public class MessageConfig {
   }
 
   @Bean
+  ParametersContext parametersContext() {
+    return new DefaultParametersContext();
+  }
+
+  @Bean
   OmegaContext omegaContext(IdGenerator<String> idGenerator) {
     return new OmegaContext(idGenerator);
   }
diff --git a/omega/omega-spring-tx/src/test/java/org/apache/servicecomb/saga/omega/transaction/spring/TccInterceptorTest.java b/omega/omega-spring-tx/src/test/java/org/apache/servicecomb/saga/omega/transaction/spring/TccInterceptorTest.java
index ce56636..53cf36d 100644
--- a/omega/omega-spring-tx/src/test/java/org/apache/servicecomb/saga/omega/transaction/spring/TccInterceptorTest.java
+++ b/omega/omega-spring-tx/src/test/java/org/apache/servicecomb/saga/omega/transaction/spring/TccInterceptorTest.java
@@ -86,8 +86,6 @@ public class TccInterceptorTest {
   @Before
   public void setUp() throws Exception {
     when(idGenerator.nextId()).thenReturn(globalTxId, newLocalTxId, anotherLocalTxId);
-//    omegaContext.setGlobalTxId(globalTxId);
-//    omegaContext.setLocalTxId(globalTxId);
     confirmMethod = TccUserService.class.getDeclaredMethod("confirm", User.class).toString();
     cancelMethod = TccUserService.class.getDeclaredMethod("cancel", User.class).toString();
   }
@@ -107,10 +105,6 @@ public class TccInterceptorTest {
   public void tccWorkflowSucceed() {
     tccUserServiceMain.add(user, jack);
 
-    // TODO could't get parameters, for OmegaContext has been cleared after sending TccEndedEvent synchronous.
-    // TODO CoordinateCommand will be send from alpha asynchronous.
-    omegaContext.setParameters(newLocalTxId, user);
-    omegaContext.setParameters(anotherLocalTxId, jack);
     coordinateMessageHandler.onReceive(globalTxId, newLocalTxId, globalTxId, confirmMethod);
     coordinateMessageHandler.onReceive(globalTxId, anotherLocalTxId, globalTxId, confirmMethod);
 
@@ -144,10 +138,6 @@ public class TccInterceptorTest {
 
     }
 
-    // TODO could't get parameters, for OmegaContext has been cleared after sending TccEndedEvent synchronous.
-    // TODO CoordinateCommand will be send from alpha asynchronous.
-    omegaContext.setParameters(newLocalTxId, user);
-    omegaContext.setParameters(anotherLocalTxId, illegalUser);
     coordinateMessageHandler.onReceive(globalTxId, newLocalTxId, globalTxId, cancelMethod);
     assertArrayEquals(
         new String[] {
diff --git a/omega/omega-transaction/src/main/java/org/apache/servicecomb/saga/omega/transaction/tcc/CoordinateMessageHandler.java b/omega/omega-transaction/src/main/java/org/apache/servicecomb/saga/omega/transaction/tcc/CoordinateMessageHandler.java
index 65f3cd5..8d5e273 100644
--- a/omega/omega-transaction/src/main/java/org/apache/servicecomb/saga/omega/transaction/tcc/CoordinateMessageHandler.java
+++ b/omega/omega-transaction/src/main/java/org/apache/servicecomb/saga/omega/transaction/tcc/CoordinateMessageHandler.java
@@ -30,16 +30,24 @@ public class CoordinateMessageHandler implements MessageHandler {
 
   private final OmegaContext omegaContext;
 
+  private final ParametersContext parametersContext;
+
   public CoordinateMessageHandler(TccEventService tccEventService,
-      CallbackContext callbackContext, OmegaContext omegaContext) {
+      CallbackContext callbackContext, OmegaContext omegaContext,
+      ParametersContext parametersContext) {
     this.tccEventService = tccEventService;
     this.callbackContext = callbackContext;
     this.omegaContext = omegaContext;
+    this.parametersContext = parametersContext;
   }
 
   @Override
   public void onReceive(String globalTxId, String localTxId, String parentTxId, String methodName) {
-    callbackContext.apply(globalTxId, localTxId, methodName, omegaContext.parameters(localTxId));
+    // TODO need to catch the exception and send the failed message
+    // The parameter need to be updated here
+    callbackContext.apply(globalTxId, localTxId, methodName, parametersContext.getParameters(localTxId));
     tccEventService.coordinate(new CoordinatedEvent(globalTxId, localTxId, parentTxId, methodName, TransactionStatus.Succeed));
+    // Need to remove the parameter
+    parametersContext.removeParameter(localTxId);
   }
 }
diff --git a/omega/omega-transaction/src/main/java/org/apache/servicecomb/saga/omega/transaction/tcc/DefaultParametersContext.java b/omega/omega-transaction/src/main/java/org/apache/servicecomb/saga/omega/transaction/tcc/DefaultParametersContext.java
new file mode 100644
index 0000000..2fb9f2f
--- /dev/null
+++ b/omega/omega-transaction/src/main/java/org/apache/servicecomb/saga/omega/transaction/tcc/DefaultParametersContext.java
@@ -0,0 +1,40 @@
+/*
+ * 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.servicecomb.saga.omega.transaction.tcc;
+
+import java.util.HashMap;
+import java.util.Map;
+
+public class DefaultParametersContext implements ParametersContext {
+  private Map<String, Object[]> parameters = new HashMap<>();
+
+  @Override
+  public Object[] getParameters(String localTransactionId) {
+    return parameters.get(localTransactionId);
+  }
+
+  @Override
+  public void putParamters(String localTransactionId, Object ... paramters) {
+    parameters.put(localTransactionId, paramters);
+  }
+
+  @Override
+  public void removeParameter(String localTransactionId) {
+    parameters.remove(localTransactionId);
+  }
+}
diff --git a/omega/omega-transaction/src/main/java/org/apache/servicecomb/saga/omega/transaction/tcc/TccParticipatorAspect.java b/omega/omega-transaction/src/main/java/org/apache/servicecomb/saga/omega/transaction/tcc/TccParticipatorAspect.java
index 6ad9253..e3a8fcc 100644
--- a/omega/omega-transaction/src/main/java/org/apache/servicecomb/saga/omega/transaction/tcc/TccParticipatorAspect.java
+++ b/omega/omega-transaction/src/main/java/org/apache/servicecomb/saga/omega/transaction/tcc/TccParticipatorAspect.java
@@ -36,10 +36,15 @@ public class TccParticipatorAspect {
 
   private final OmegaContext context;
   private final TccEventService tccEventService;
+  private final ParametersContext parametersContext;
 
-  public TccParticipatorAspect(TccEventService tccEventService, OmegaContext context) {
+  //We need to inject the CoordinateMessageHandler for the parameter map
+
+  public TccParticipatorAspect(TccEventService tccEventService, OmegaContext context,
+      ParametersContext parametersContext) {
     this.context = context;
     this.tccEventService = tccEventService;
+    this.parametersContext = parametersContext;
   }
 
   @Around("execution(@org.apache.servicecomb.saga.omega.transaction.annotations.Participate * *(..)) && @annotation(participate)")
@@ -57,6 +62,8 @@ public class TccParticipatorAspect {
       // Send the participate message back
       tccEventService.participate(new ParticipatedEvent(context.globalTxId(), context.localTxId(), localTxId, confirmMethod,
           cancelMethod, TransactionStatus.Succeed));
+      // Just store the parameters into the context
+      parametersContext.putParamters(context.localTxId(), joinPoint.getArgs());
       LOG.debug("Participate Transaction with context {} has finished.", context);
       return result;
     } catch (Throwable throwable) {
diff --git a/omega/omega-transaction/src/test/java/org/apache/servicecomb/saga/omega/transaction/tcc/CoordinateMessageHandlerTest.java b/omega/omega-transaction/src/test/java/org/apache/servicecomb/saga/omega/transaction/tcc/CoordinateMessageHandlerTest.java
index fb71505..e2e0769 100644
--- a/omega/omega-transaction/src/test/java/org/apache/servicecomb/saga/omega/transaction/tcc/CoordinateMessageHandlerTest.java
+++ b/omega/omega-transaction/src/test/java/org/apache/servicecomb/saga/omega/transaction/tcc/CoordinateMessageHandlerTest.java
@@ -91,7 +91,8 @@ public class CoordinateMessageHandlerTest {
 
   private final CallbackContext callbackContext = Mockito.mock(CallbackContext.class);
   private final OmegaContext omegaContext = Mockito.mock(OmegaContext.class);
-  private final CoordinateMessageHandler handler = new CoordinateMessageHandler(eventService, callbackContext, omegaContext);
+  private final ParametersContext parametersContext = Mockito.mock(ParametersContext.class);
+  private final CoordinateMessageHandler handler = new CoordinateMessageHandler(eventService, callbackContext, omegaContext, parametersContext);
 
   @Before
   public void setUp() {
diff --git a/omega/omega-transaction/src/test/java/org/apache/servicecomb/saga/omega/transaction/tcc/TccParticipatorAspectTest.java b/omega/omega-transaction/src/test/java/org/apache/servicecomb/saga/omega/transaction/tcc/TccParticipatorAspectTest.java
index c56bf7a..d308876 100644
--- a/omega/omega-transaction/src/test/java/org/apache/servicecomb/saga/omega/transaction/tcc/TccParticipatorAspectTest.java
+++ b/omega/omega-transaction/src/test/java/org/apache/servicecomb/saga/omega/transaction/tcc/TccParticipatorAspectTest.java
@@ -101,8 +101,9 @@ public class TccParticipatorAspectTest {
 
   private final OmegaContext omegaContext = new OmegaContext(idGenerator);
   private final Participate participate = mock(Participate.class);
+  private final ParametersContext parametersContext = new DefaultParametersContext();
 
-  private final TccParticipatorAspect aspect = new TccParticipatorAspect(eventService, omegaContext);
+  private final TccParticipatorAspect aspect = new TccParticipatorAspect(eventService, omegaContext, parametersContext);
 
 
   @Before