Introduce ServiceVersion framework to support backward compatible and reduce BlcokIdLayout message

Author: maobaolong

client/src/main/java/org/apache/uniffle/client/impl/ShuffleWriteClientImpl.java

@@ -590,7 +590,8 @@ public void registerShuffle(
             valueClassName,
             comparatorClassName,
             mergedBlockSize,
-            mergeClassLoader);
+            mergeClassLoader,
+            blockIdLayout);
     RssRegisterShuffleResponse response =
         getShuffleServerClient(shuffleServerInfo).registerShuffle(request);
 

common/src/main/java/org/apache/uniffle/common/ShuffleServerInfo.java

@@ -35,6 +35,8 @@ public class ShuffleServerInfo implements Serializable {
 
   private int nettyPort = -1;
 
+  private int serviceVersion = 0;
+
   @VisibleForTesting
   public ShuffleServerInfo(String host, int port) {
     this.id = host + "-" + port;
@@ -57,10 +59,16 @@ public ShuffleServerInfo(String id, String host, int port) {
   }
 
   public ShuffleServerInfo(String id, String host, int grpcPort, int nettyPort) {
+    this(id, host, grpcPort, nettyPort, 0);
+  }
+
+  public ShuffleServerInfo(
+      String id, String host, int grpcPort, int nettyPort, int serviceVersion) {
     this.id = id;
     this.host = host;
     this.grpcPort = grpcPort;
     this.nettyPort = nettyPort;
+    this.serviceVersion = serviceVersion;
   }
 
   public String getId() {
@@ -79,6 +87,10 @@ public int getNettyPort() {
     return nettyPort;
   }
 
+  public int getServiceVersion() {
+    return serviceVersion;
+  }
+
   @Override
   public int hashCode() {
     // By default id = host + "-" + grpc port, if netty port is greater than 0,
@@ -121,7 +133,8 @@ private static ShuffleServerInfo convertFromShuffleServerId(
             shuffleServerId.getId(),
             shuffleServerId.getIp(),
             shuffleServerId.getPort(),
-            shuffleServerId.getNettyPort());
+            shuffleServerId.getNettyPort(),
+            shuffleServerId.getServiceVersion());
     return shuffleServerInfo;
   }
 

common/src/main/java/org/apache/uniffle/common/netty/protocol/Decoders.java

@@ -36,7 +36,9 @@ public static ShuffleServerInfo decodeShuffleServerInfo(ByteBuf byteBuf) {
     String host = ByteBufUtils.readLengthAndString(byteBuf);
     int grpcPort = byteBuf.readInt();
     int nettyPort = byteBuf.readInt();
-    return new ShuffleServerInfo(id, host, grpcPort, nettyPort);
+    // this decodeShuffleServerInfo method is deprecated,
+    // clients do not need to encode service version
+    return new ShuffleServerInfo(id, host, grpcPort, nettyPort, 0);
   }
 
   public static ShuffleBlockInfo decodeShuffleBlockInfo(ByteBuf byteBuf) {

common/src/main/java/org/apache/uniffle/common/rpc/ServiceVersion.java

@@ -0,0 +1,70 @@
+/*
+ * 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.uniffle.common.rpc;
+
+import java.util.Arrays;
+import java.util.Map;
+import java.util.stream.Collectors;
+
+public class ServiceVersion {
+  public static final ServiceVersion NEWEST_VERSION =
+      new ServiceVersion(Feature.getNewest().getVersion());
+  static final Map<Integer, Feature> VALUE_MAP =
+      Arrays.stream(Feature.values()).collect(Collectors.toMap(Feature::getVersion, s -> s));
+  private final int version;
+
+  public ServiceVersion(int version) {
+    this.version = version;
+  }
+
+  public Feature getCurrentFeature() {
+    return VALUE_MAP.get(version);
+  }
+
+  public boolean supportFeature(Feature registerBlockIdLayout) {
+    return version >= registerBlockIdLayout.getVersion();
+  }
+
+  public int getVersion() {
+    return version;
+  }
+
+  public enum Feature {
+    // Treat the old version as init version
+    INIT_VERSION(0),
+    // Register block id layout to server to avoid sending block id layout for each getShuffleResult
+    // request
+    REGISTER_BLOCK_ID_LAYOUT(1),
+    ;
+
+    private final int version;
+
+    Feature(int version) {
+      this.version = version;
+    }
+
+    public int getVersion() {
+      return version;
+    }
+
+    public static Feature getNewest() {
+      Feature[] enumConstants = Feature.class.getEnumConstants();
+      return enumConstants[enumConstants.length - 1];
+    }
+  }
+}

common/src/main/java/org/apache/uniffle/common/util/BlockIdLayout.java

@@ -21,6 +21,7 @@
 
 import org.apache.uniffle.common.config.RssClientConf;
 import org.apache.uniffle.common.config.RssConf;
+import org.apache.uniffle.proto.RssProtos;
 
 /**
  * This represents the actual bit layout of {@link BlockId}s.
@@ -194,6 +195,14 @@ public BlockId asBlockId(int sequenceNo, int partitionId, long taskAttemptId) {
         (int) taskAttemptId);
   }
 
+  public RssProtos.BlockIdLayout toProto() {
+    return RssProtos.BlockIdLayout.newBuilder()
+        .setSequenceNoBits(sequenceNoBits)
+        .setPartitionIdBits(partitionIdBits)
+        .setTaskAttemptIdBits(taskAttemptIdBits)
+        .build();
+  }
+
   public static BlockIdLayout from(RssConf rssConf) {
     int sequenceBits = rssConf.get(RssClientConf.BLOCKID_SEQUENCE_NO_BITS);
     int partitionBits = rssConf.get(RssClientConf.BLOCKID_PARTITION_ID_BITS);

coordinator/src/main/java/org/apache/uniffle/coordinator/CoordinatorGrpcService.java

@@ -537,7 +537,8 @@ private ServerNode toServerNode(ShuffleServerHeartBeatRequest request) {
         request.getServerId().getJettyPort(),
         request.getStartTimeMs(),
         request.getVersion(),
-        request.getGitCommitId());
+        request.getGitCommitId(),
+        request.getServiceVersion());
   }
 
   /**

coordinator/src/main/java/org/apache/uniffle/coordinator/ServerNode.java

@@ -20,6 +20,7 @@
 import java.util.Map;
 import java.util.Set;
 
+import com.google.common.annotations.VisibleForTesting;
 import com.google.common.collect.Maps;
 import com.google.common.collect.Sets;
 
@@ -29,6 +30,7 @@
 
 public class ServerNode implements Comparable<ServerNode> {
 
+  private final int serviceVersion;
   private String id;
   private String ip;
   private int grpcPort;
@@ -51,7 +53,7 @@ public ServerNode(String id) {
     this(id, "", 0, 0, 0, 0, 0, Sets.newHashSet(), ServerStatus.EXCLUDED);
   }
 
-  // Only for test
+  @VisibleForTesting
   public ServerNode(
       String id,
       String ip,
@@ -124,6 +126,7 @@ public ServerNode(
         -1);
   }
 
+  @VisibleForTesting
   public ServerNode(
       String id,
       String ip,
@@ -181,7 +184,8 @@ public ServerNode(
         jettyPort,
         startTime,
         "",
-        "");
+        "",
+        0);
   }
 
   public ServerNode(
@@ -199,7 +203,8 @@ public ServerNode(
       int jettyPort,
       long startTime,
       String version,
-      String gitCommitId) {
+      String gitCommitId,
+      int serviceVersion) {
     this.id = id;
     this.ip = ip;
     this.grpcPort = grpcPort;
@@ -221,6 +226,7 @@ public ServerNode(
     this.startTime = startTime;
     this.version = version;
     this.gitCommitId = gitCommitId;
+    this.serviceVersion = serviceVersion;
   }
 
   public ShuffleServerId convertToGrpcProto() {
@@ -230,6 +236,7 @@ public ShuffleServerId convertToGrpcProto() {
         .setPort(grpcPort)
         .setNettyPort(nettyPort)
         .setJettyPort(jettyPort)
+        .setServiceVersion(serviceVersion)
         .build();
   }
 

internal-client/src/main/java/org/apache/uniffle/client/factory/ShuffleServerClientFactory.java

@@ -47,13 +47,17 @@ private ShuffleServerClient createShuffleServerClient(
       String clientType, ShuffleServerInfo shuffleServerInfo, RssConf rssConf) {
     if (clientType.equalsIgnoreCase(ClientType.GRPC.name())) {
       return new ShuffleServerGrpcClient(
-          rssConf, shuffleServerInfo.getHost(), shuffleServerInfo.getGrpcPort());
+          rssConf,
+          shuffleServerInfo.getHost(),
+          shuffleServerInfo.getGrpcPort(),
+          shuffleServerInfo.getServiceVersion());
     } else if (clientType.equalsIgnoreCase(ClientType.GRPC_NETTY.name())) {
       return new ShuffleServerGrpcNettyClient(
           rssConf,
           shuffleServerInfo.getHost(),
           shuffleServerInfo.getGrpcPort(),
-          shuffleServerInfo.getNettyPort());
+          shuffleServerInfo.getNettyPort(),
+          shuffleServerInfo.getServiceVersion());
     } else {
       throw new UnsupportedOperationException("Unsupported client type " + clientType);
     }

internal-client/src/main/java/org/apache/uniffle/client/impl/grpc/CoordinatorGrpcClient.java

@@ -52,6 +52,7 @@
 import org.apache.uniffle.common.ServerStatus;
 import org.apache.uniffle.common.ShuffleServerInfo;
 import org.apache.uniffle.common.exception.RssException;
+import org.apache.uniffle.common.rpc.ServiceVersion;
 import org.apache.uniffle.common.rpc.StatusCode;
 import org.apache.uniffle.common.storage.StorageInfo;
 import org.apache.uniffle.common.storage.StorageInfoUtils;
@@ -149,6 +150,7 @@ public ShuffleServerHeartBeatResponse doSendHeartBeat(
             .setStartTimeMs(startTimeMs)
             .setVersion(Constants.VERSION)
             .setGitCommitId(Constants.REVISION_SHORT)
+            .setServiceVersion(ServiceVersion.NEWEST_VERSION.getVersion())
             .build();
 
     RssProtos.StatusCode status;
@@ -421,7 +423,11 @@ public Map<Integer, List<ShuffleServerInfo>> getPartitionToServers(
               .map(
                   ss ->
                       new ShuffleServerInfo(
-                          ss.getId(), ss.getIp(), ss.getPort(), ss.getNettyPort()))
+                          ss.getId(),
+                          ss.getIp(),
+                          ss.getPort(),
+                          ss.getNettyPort(),
+                          ss.getServiceVersion()))
               .collect(Collectors.toList());
       for (int i = startPartition; i <= endPartition; i++) {
         partitionToServers.put(i, shuffleServerInfos);
@@ -446,7 +452,12 @@ public Map<ShuffleServerInfo, List<PartitionRange>> getServerToPartitionRanges(
             new PartitionRange(assign.getStartPartition(), assign.getEndPartition());
         for (ShuffleServerId ssi : shuffleServerIds) {
           ShuffleServerInfo shuffleServerInfo =
-              new ShuffleServerInfo(ssi.getId(), ssi.getIp(), ssi.getPort(), ssi.getNettyPort());
+              new ShuffleServerInfo(
+                  ssi.getId(),
+                  ssi.getIp(),
+                  ssi.getPort(),
+                  ssi.getNettyPort(),
+                  ssi.getServiceVersion());
           if (!serverToPartitionRanges.containsKey(shuffleServerInfo)) {
             serverToPartitionRanges.put(shuffleServerInfo, Lists.newArrayList());
           }

internal-client/src/main/java/org/apache/uniffle/client/impl/grpc/GrpcClient.java

@@ -25,31 +25,35 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+import org.apache.uniffle.common.rpc.ServiceVersion;
 import org.apache.uniffle.common.util.GrpcNettyUtils;
 
 public abstract class GrpcClient {
 
   private static final Logger logger = LoggerFactory.getLogger(GrpcClient.class);
   protected String host;
   protected int port;
+  protected ServiceVersion serviceVersion;
   protected boolean usePlaintext;
   protected int maxRetryAttempts;
   protected ManagedChannel channel;
 
   protected GrpcClient(String host, int port, int maxRetryAttempts, boolean usePlaintext) {
-    this(host, port, maxRetryAttempts, usePlaintext, 0, 0, 0);
+    this(host, port, 0, maxRetryAttempts, usePlaintext, 0, 0, 0);
   }
 
   protected GrpcClient(
       String host,
       int port,
+      int serviceVersion,
       int maxRetryAttempts,
       boolean usePlaintext,
       int pageSize,
       int maxOrder,
       int smallCacheSize) {
     this.host = host;
     this.port = port;
+    this.serviceVersion = new ServiceVersion(serviceVersion);
     this.maxRetryAttempts = maxRetryAttempts;
     this.usePlaintext = usePlaintext;
 
@@ -75,6 +79,10 @@ protected GrpcClient(ManagedChannel channel) {
     this.channel = channel;
   }
 
+  public ServiceVersion getServiceVersion() {
+    return serviceVersion;
+  }
+
   public void close() {
     try {
       channel.shutdown().awaitTermination(5, TimeUnit.SECONDS);