optimize : support multi-version codec & fix not returning client registration failure msg

changes/en-us/2.x.md

@@ -58,6 +58,8 @@ Add changes here for all PR submitted to the 2.x branch.
 - [[#7428](https://github.com/apache/incubator-seata/pull/7428)] pmd-check log as ERROR level
 - [[#7430](https://github.com/apache/incubator-seata/pull/7430)] Add support for parsing @RequestParam annotation in netty-http-server
 - [[#7432](https://github.com/apache/incubator-seata/pull/7432)] conditionally include test modules using Maven profiles
+- [[#7000](https://github.com/apache/incubator-seata/pull/7000)] support multi-version codec & fix not returning client registration failure msg
+
 
 
 ### security:

changes/zh-cn/2.x.md

@@ -57,6 +57,7 @@
 - [[#7419](https://github.com/apache/incubator-seata/pull/7419)] 添加 Maven 配置文件以支持源码打包
 - [[#7428](https://github.com/apache/incubator-seata/pull/7428)] 修改 pmd-check 输出日志为 ERROR 级别
 - [[#7430](https://github.com/apache/incubator-seata/pull/7430)] 在netty-http-server中增加了对解析@RequestParam注释的支持
+- [[#7000](https://github.com/apache/incubator-seata/pull/7000)] 支持多版本codec，修复不返回客户端注册失败消息的问题
 
 
 ### security:

core/src/main/java/org/apache/seata/core/protocol/ProtocolConstants.java

@@ -38,14 +38,19 @@ public interface ProtocolConstants {
     byte VERSION_0 = 0;
 
     /**
-     * Protocol version
+     * Protocol version 1
      */
     byte VERSION_1 = 1;
 
+    /**
+     * Protocol version 2
+     */
+    byte VERSION_2 = 2;
+
     /**
      * Protocol version
      */
-    byte VERSION = VERSION_1;
+    byte VERSION = VERSION_2;
 
     /**
      * Max frame length

core/src/main/java/org/apache/seata/core/protocol/RegisterRMResponse.java

@@ -39,6 +39,7 @@ public RegisterRMResponse() {
     public RegisterRMResponse(boolean result) {
         super();
         setIdentified(result);
+        setResultCode(result ? ResultCode.Success : ResultCode.Failed);
     }
 
     @Override

core/src/main/java/org/apache/seata/core/protocol/RegisterTMResponse.java

@@ -39,6 +39,7 @@ public RegisterTMResponse() {
     public RegisterTMResponse(boolean result) {
         super();
         setIdentified(result);
+        setResultCode(result ? ResultCode.Success : ResultCode.Failed);
     }
 
     @Override

core/src/main/java/org/apache/seata/core/protocol/Version.java

@@ -40,6 +40,9 @@
     private static final String VERSION_0_7_1 = "0.7.1";
     private static final String VERSION_1_5_0 = "1.5.0";
     private static final String VERSION_2_3_0 = "2.3.0";
+
+    public static final String VERSION_0_7_0 = "0.7.0";
+
     private static final int MAX_VERSION_DOT = 3;
 
     /**
@@ -98,6 +101,10 @@
         return !isAboveOrEqualVersion(version, VERSION_0_7_1);
     }
 
+    public static boolean isAboveOrEqualVersion071(String version) {
+        return isAboveOrEqualVersion(version, VERSION_0_7_1);
+    }
+
     public static boolean isAboveOrEqualVersion(String clientVersion, String divideVersion) {
         boolean isAboveOrEqualVersion = false;
         try {

core/src/main/java/org/apache/seata/core/rpc/netty/MultiProtocolDecoder.java

@@ -27,6 +27,8 @@
 import org.apache.seata.core.rpc.netty.v0.ProtocolEncoderV0;
 import org.apache.seata.core.rpc.netty.v1.ProtocolDecoderV1;
 import org.apache.seata.core.rpc.netty.v1.ProtocolEncoderV1;
+import org.apache.seata.core.rpc.netty.v2.ProtocolDecoderV2;
+import org.apache.seata.core.rpc.netty.v2.ProtocolEncoderV2;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -83,12 +85,16 @@
         int initialBytesToStrip we will check magic code and version self, so do not strip any bytes. so values is 0
         */
         super(maxFrameLength, 3, 4, -7, 0);
-        this.protocolDecoderMap =
-                ImmutableMap.<Byte, ProtocolDecoder>builder().put(ProtocolConstants.VERSION_0, new ProtocolDecoderV0())
-                        .put(ProtocolConstants.VERSION_1, new ProtocolDecoderV1()).build();
-        this.protocolEncoderMap =
-                ImmutableMap.<Byte, ProtocolEncoder>builder().put(ProtocolConstants.VERSION_0, new ProtocolEncoderV0())
-                        .put(ProtocolConstants.VERSION_1, new ProtocolEncoderV1()).build();
+        this.protocolDecoderMap = ImmutableMap.<Byte, ProtocolDecoder>builder()
+                .put(ProtocolConstants.VERSION_0, new ProtocolDecoderV0())
+                .put(ProtocolConstants.VERSION_1, new ProtocolDecoderV1())
+                .put(ProtocolConstants.VERSION_2, new ProtocolDecoderV2())
+                .build();
+        this.protocolEncoderMap = ImmutableMap.<Byte, ProtocolEncoder>builder()
+                .put(ProtocolConstants.VERSION_0, new ProtocolEncoderV0())
+                .put(ProtocolConstants.VERSION_1, new ProtocolEncoderV1())
+                .put(ProtocolConstants.VERSION_2, new ProtocolEncoderV2())
+                .build();
         this.channelHandlers = channelHandlers;
     }
 

core/src/main/java/org/apache/seata/core/rpc/netty/NettyClientBootstrap.java

@@ -43,8 +43,8 @@
 import org.apache.seata.core.rpc.RemotingBootstrap;
 import org.apache.seata.core.rpc.netty.grpc.GrpcDecoder;
 import org.apache.seata.core.rpc.netty.grpc.GrpcEncoder;
-import org.apache.seata.core.rpc.netty.v1.ProtocolDecoderV1;
-import org.apache.seata.core.rpc.netty.v1.ProtocolEncoderV1;
+import org.apache.seata.core.rpc.netty.v2.ProtocolDecoderV2;
+import org.apache.seata.core.rpc.netty.v2.ProtocolEncoderV2;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -147,8 +147,8 @@ public void initChannel(SocketChannel ch) {
                         pipeline.addLast(new IdleStateHandler(nettyClientConfig.getChannelMaxReadIdleSeconds(),
                                 nettyClientConfig.getChannelMaxWriteIdleSeconds(),
                                 nettyClientConfig.getChannelMaxAllIdleSeconds()));
-                        pipeline.addLast(new ProtocolDecoderV1())
-                                .addLast(new ProtocolEncoderV1());
+                        pipeline.addLast(new ProtocolDecoderV2())
+                                .addLast(new ProtocolEncoderV2());
                         if (channelHandlers != null) {
                             addChannelPipelineLast(ch, channelHandlers);
                         }

core/src/main/java/org/apache/seata/core/rpc/netty/ProtocolDecoder.java

@@ -27,4 +27,5 @@ public interface ProtocolDecoder {
 
     RpcMessage decodeFrame(ByteBuf in);
 
+    byte protocolVersion();
 }

core/src/main/java/org/apache/seata/core/rpc/netty/ProtocolEncoder.java

@@ -25,4 +25,6 @@
  **/
 public interface ProtocolEncoder {
     void encode(RpcMessage rpcMessage, ByteBuf out);
+
+    byte protocolVersion();
 }

core/src/main/java/org/apache/seata/core/rpc/netty/v0/ProtocolDecoderV0.java

@@ -130,7 +130,7 @@
             bs2[1] = (byte) (0x00FF & typeCode);
             System.arraycopy(bs, 0, bs2, 2, length);
             byte codecType = isSeataCodec ? SerializerType.SEATA.getCode() : SerializerType.HESSIAN.getCode();
-            Serializer serializer = SerializerServiceLoader.load(SerializerType.getByCode(codecType), ProtocolConstants.VERSION_0);
+            Serializer serializer = SerializerServiceLoader.load(SerializerType.getByCode(codecType), protocolVersion());
             rpcMessage.setBody(serializer.deserialize(bs2));
         } catch (Exception e) {
             LOGGER.error("decode error", e);
@@ -151,4 +151,9 @@
             throw new DecodeException(exx);
         }
     }
+
+    @Override
+    public byte protocolVersion() {
+        return ProtocolConstants.VERSION_0;
+    }
 }

core/src/main/java/org/apache/seata/core/rpc/netty/v0/ProtocolEncoderV0.java

@@ -82,7 +82,7 @@
             }
 
             byte[] bodyBytes = null;
-            Serializer serializer = SerializerServiceLoader.load(SerializerType.getByCode(codec), ProtocolConstants.VERSION_0);
+            Serializer serializer = SerializerServiceLoader.load(SerializerType.getByCode(codec), protocolVersion());
             bodyBytes = serializer.serialize(msg.getBody());
 
             if (msg.isSeataCodec()) {
@@ -118,4 +118,9 @@
             LOGGER.error("Encode request error!", e);
         }
     }
+
+    @Override
+    public byte protocolVersion() {
+        return ProtocolConstants.VERSION_0;
+    }
 }

core/src/main/java/org/apache/seata/core/rpc/netty/v1/ProtocolDecoderV1.java

@@ -129,7 +129,7 @@
                 bs = compressor.decompress(bs);
                 SerializerType protocolType = SerializerType.getByCode(rpcMessage.getCodec());
                 if (this.supportDeSerializerTypes.contains(protocolType)) {
-                    Serializer serializer = SerializerServiceLoader.load(protocolType, ProtocolConstants.VERSION_1);
+                    Serializer serializer = SerializerServiceLoader.load(protocolType, protocolVersion());
                     rpcMessage.setBody(serializer.deserialize(bs));
                 } else {
                     throw new IllegalArgumentException("SerializerType not match");
@@ -160,4 +160,8 @@
         return decoded;
     }
 
+    @Override
+    public byte protocolVersion() {
+        return ProtocolConstants.VERSION_1;
+    }
 }

core/src/main/java/org/apache/seata/core/rpc/netty/v1/ProtocolEncoderV1.java

@@ -74,7 +74,7 @@
 
             byte messageType = rpcMessage.getMessageType();
             out.writeBytes(ProtocolConstants.MAGIC_CODE_BYTES);
-            out.writeByte(ProtocolConstants.VERSION_1);
+            out.writeByte(protocolVersion());
             // full Length(4B) and head length(2B) will fix in the end.
             out.writerIndex(out.writerIndex() + 6);
             out.writeByte(messageType);
@@ -94,7 +94,7 @@
             if (messageType != ProtocolConstants.MSGTYPE_HEARTBEAT_REQUEST
                 && messageType != ProtocolConstants.MSGTYPE_HEARTBEAT_RESPONSE) {
                 // heartbeat has no body
-                Serializer serializer = SerializerServiceLoader.load(SerializerType.getByCode(rpcMessage.getCodec()), ProtocolConstants.VERSION_1);
+                Serializer serializer = SerializerServiceLoader.load(SerializerType.getByCode(rpcMessage.getCodec()), protocolVersion());
                 bodyBytes = serializer.serialize(rpcMessage.getBody());
                 Compressor compressor = CompressorFactory.getCompressor(rpcMessage.getCompressor());
                 bodyBytes = compressor.compress(bodyBytes);
@@ -134,4 +134,8 @@
         }
     }
 
+    @Override
+    public byte protocolVersion() {
+        return ProtocolConstants.VERSION_1;
+    }
 }

core/src/main/java/org/apache/seata/core/rpc/netty/v2/ProtocolDecoderV2.java

@@ -0,0 +1,31 @@
+/*
+ * 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.core.rpc.netty.v2;
+
+import org.apache.seata.core.protocol.ProtocolConstants;
+import org.apache.seata.core.rpc.netty.v1.ProtocolDecoderV1;
+
+/**
+ * Decoder of protocol-v2
+ **/
+public class ProtocolDecoderV2 extends ProtocolDecoderV1 {
+
+    @Override
+    public byte protocolVersion() {
+        return ProtocolConstants.VERSION_2;
+    }
+}

core/src/main/java/org/apache/seata/core/rpc/netty/v2/ProtocolEncoderV2.java

@@ -0,0 +1,30 @@
+/*
+ * 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.core.rpc.netty.v2;
+
+import org.apache.seata.core.protocol.ProtocolConstants;
+import org.apache.seata.core.rpc.netty.v1.ProtocolEncoderV1;
+
+/**
+ * Encoder of protocol-v2
+ **/
+public class ProtocolEncoderV2 extends ProtocolEncoderV1 {
+    @Override
+    public byte protocolVersion() {
+        return ProtocolConstants.VERSION_2;
+    }
+}

core/src/main/java/org/apache/seata/core/rpc/processor/server/RegRmProcessor.java

@@ -74,6 +74,7 @@
                 if (LOGGER.isWarnEnabled()) {
                     LOGGER.warn("RM checkAuth for client:{},vgroup:{},applicationId:{} is FAIL", ipAndPort, message.getTransactionServiceGroup(), message.getApplicationId());
                 }
+                errorInfo = "RM checkAuth fail";
             }
         } catch (Exception exx) {
             isSuccess = false;

core/src/main/java/org/apache/seata/core/rpc/processor/server/RegTmProcessor.java

@@ -77,6 +77,7 @@
                     LOGGER.warn("TM checkAuth for client:{},vgroup:{},applicationId:{} is FAIL",
                             ipAndPort, message.getTransactionServiceGroup(), message.getApplicationId());
                 }
+                errorInfo = "TM checkAuth fail";
             }
         } catch (Exception exx) {
             isSuccess = false;

mock-server/src/main/java/org/apache/seata/mockserver/processor/MockRegisterProcessor.java

@@ -17,6 +17,8 @@
 package org.apache.seata.mockserver.processor;
 
 import io.netty.channel.ChannelHandlerContext;
+import org.apache.commons.lang.StringUtils;
+import org.apache.seata.core.protocol.AbstractResultMessage;
 import org.apache.seata.core.protocol.RegisterRMRequest;
 import org.apache.seata.core.protocol.RegisterRMResponse;
 import org.apache.seata.core.protocol.RegisterTMRequest;
@@ -49,27 +51,31 @@
 
     @Override
     public void process(ChannelHandlerContext ctx, RpcMessage rpcMessage) throws Exception {
-        if (role == Role.TM) {
-            RegisterTMRequest message = (RegisterTMRequest) rpcMessage.getBody();
-            LOGGER.info("message = " + message);
-
-            ChannelManager.registerTMChannel(message, ctx.channel());
-            Version.putChannelVersion(ctx.channel(), message.getVersion());
-
-            RegisterTMResponse resp = new RegisterTMResponse();
-            remotingServer.sendAsyncResponse(rpcMessage, ctx.channel(), resp);
-            LOGGER.info("sendAsyncResponse: {}", resp);
-        } else if (role == Role.RM) {
-            RegisterRMRequest message = (RegisterRMRequest) rpcMessage.getBody();
-            LOGGER.info("message = " + message);
-
-            ChannelManager.registerRMChannel(message, ctx.channel());
-            Version.putChannelVersion(ctx.channel(), message.getVersion());
-
-            RegisterRMResponse resp = new RegisterRMResponse();
-            remotingServer.sendAsyncResponse(rpcMessage, ctx.channel(), resp);
-            LOGGER.info("sendAsyncResponse: {}", resp);
+        String errorInfo = StringUtils.EMPTY;
+        AbstractResultMessage response = null;
+        try {
+            if (role == Role.TM) {
+                RegisterTMRequest message = (RegisterTMRequest) rpcMessage.getBody();
+                LOGGER.info("reg message = " + message);
+                ChannelManager.registerTMChannel(message, ctx.channel());
+                Version.putChannelVersion(ctx.channel(), message.getVersion());
+                response = new RegisterTMResponse();
+            } else if (role == Role.RM) {
+                RegisterRMRequest message = (RegisterRMRequest) rpcMessage.getBody();
+                LOGGER.info("reg message = " + message);
+                ChannelManager.registerRMChannel(message, ctx.channel());
+                Version.putChannelVersion(ctx.channel(), message.getVersion());
+                response = new RegisterRMResponse();
+            }
+        } catch (Exception e) {
+            errorInfo = e.getMessage();
+            LOGGER.error(role + " register fail, error message:{}", errorInfo);
+        }
+        if (StringUtils.isNotEmpty(errorInfo)) {
+            response.setMsg(errorInfo);
         }
+        remotingServer.sendAsyncResponse(rpcMessage, ctx.channel(), response);
+        LOGGER.info("sendAsyncResponse: {}", response);
     }