Skip to content

[8.18] Update TransportVersion to support a new model (#131488) (#131889) #132047

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 28, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
281 changes: 263 additions & 18 deletions server/src/main/java/org/elasticsearch/TransportVersion.java

Large diffs are not rendered by default.

35 changes: 11 additions & 24 deletions server/src/main/java/org/elasticsearch/TransportVersions.java
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,13 @@
import org.elasticsearch.core.UpdateForV9;

import java.lang.reflect.Field;
import java.util.Collection;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.NavigableMap;
import java.util.Set;
import java.util.TreeMap;
import java.util.TreeSet;
import java.util.function.IntFunction;

/**
* <p>Transport version is used to coordinate compatible wire protocol communication between nodes, at a fine-grained level. This replaces
Expand Down Expand Up @@ -262,21 +260,14 @@ static TransportVersion def(int id) {
*/
public static final TransportVersion MINIMUM_CCS_VERSION = QUERY_RULES_LIST_INCLUDES_TYPES_BACKPORT_8_16;

static final NavigableMap<Integer, TransportVersion> VERSION_IDS = getAllVersionIds(TransportVersions.class);

// the highest transport version constant defined in this file, used as a fallback for TransportVersion.current()
static final TransportVersion LATEST_DEFINED;
static {
LATEST_DEFINED = VERSION_IDS.lastEntry().getValue();

// see comment on IDS field
// now we're registered all the transport versions, we can clear the map
IDS = null;
}
/**
* Sorted list of all versions defined in this class
*/
static final List<TransportVersion> DEFINED_VERSIONS = collectAllVersionIdsDefinedInClass(TransportVersions.class);

public static NavigableMap<Integer, TransportVersion> getAllVersionIds(Class<?> cls) {
public static List<TransportVersion> collectAllVersionIdsDefinedInClass(Class<?> cls) {
Map<Integer, String> versionIdFields = new HashMap<>();
NavigableMap<Integer, TransportVersion> builder = new TreeMap<>();
List<TransportVersion> definedTransportVersions = new ArrayList<>();

Set<String> ignore = Set.of("ZERO", "CURRENT", "MINIMUM_COMPATIBLE", "MINIMUM_CCS_VERSION");

Expand All @@ -293,7 +284,7 @@ public static NavigableMap<Integer, TransportVersion> getAllVersionIds(Class<?>
} catch (IllegalAccessException e) {
throw new AssertionError(e);
}
builder.put(version.id(), version);
definedTransportVersions.add(version);

if (Assertions.ENABLED) {
// check the version number is unique
Expand All @@ -310,15 +301,11 @@ public static NavigableMap<Integer, TransportVersion> getAllVersionIds(Class<?>
}
}

return Collections.unmodifiableNavigableMap(builder);
}
Collections.sort(definedTransportVersions);

static Collection<TransportVersion> getAllVersions() {
return VERSION_IDS.values();
return List.copyOf(definedTransportVersions);
}

static final IntFunction<String> VERSION_LOOKUP = ReleaseVersions.generateVersionsLookup(TransportVersions.class, LATEST_DEFINED.id());

// no instance
private TransportVersions() {}
}
1 change: 1 addition & 0 deletions server/src/main/resources/transport/latest/8.18.csv
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
placeholder,8840007
1 change: 1 addition & 0 deletions server/src/main/resources/transport/latest/8.19.csv
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
placeholder,8841064
1 change: 1 addition & 0 deletions server/src/main/resources/transport/latest/9.0.csv
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
placeholder,9000014
1 change: 1 addition & 0 deletions server/src/main/resources/transport/latest/9.1.csv
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
placeholder,9112003
1 change: 1 addition & 0 deletions server/src/main/resources/transport/latest/9.2.csv
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
placeholder,9130000
142 changes: 123 additions & 19 deletions server/src/test/java/org/elasticsearch/TransportVersionTests.java
Original file line number Diff line number Diff line change
Expand Up @@ -15,15 +15,14 @@
import java.lang.reflect.Modifier;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.TreeSet;
import java.util.regex.Matcher;
import java.util.regex.Pattern;

import static org.hamcrest.Matchers.contains;
import static org.hamcrest.Matchers.containsString;
import static org.hamcrest.Matchers.endsWith;
import static org.hamcrest.Matchers.equalTo;
import static org.hamcrest.Matchers.greaterThan;
import static org.hamcrest.Matchers.is;
import static org.hamcrest.Matchers.lessThan;
Expand All @@ -35,7 +34,7 @@ public class TransportVersionTests extends ESTestCase {
* This test is specific for 8.18, to ensure that transport versions are backported correctly. Do not forward or backport it.
*/
public void testMaximumAllowedTransportVersion() {
assertThat(TransportVersions.LATEST_DEFINED.isPatchFrom(TransportVersions.ML_INFERENCE_IBM_WATSONX_RERANK_ADDED), is(true));
assertThat(TransportVersion.current().isPatchFrom(TransportVersions.ML_INFERENCE_IBM_WATSONX_RERANK_ADDED), is(true));
}

public void testVersionComparison() {
Expand Down Expand Up @@ -77,21 +76,18 @@ public static class DuplicatedIdFakeVersion {

public void testStaticTransportVersionChecks() {
assertThat(
TransportVersions.getAllVersionIds(CorrectFakeVersion.class),
equalTo(
Map.of(
199,
CorrectFakeVersion.V_0_00_01,
2,
CorrectFakeVersion.V_0_000_002,
3,
CorrectFakeVersion.V_0_000_003,
4,
CorrectFakeVersion.V_0_000_004
)
TransportVersions.collectAllVersionIdsDefinedInClass(CorrectFakeVersion.class),
contains(
CorrectFakeVersion.V_0_000_002,
CorrectFakeVersion.V_0_000_003,
CorrectFakeVersion.V_0_000_004,
CorrectFakeVersion.V_0_00_01
)
);
AssertionError e = expectThrows(AssertionError.class, () -> TransportVersions.getAllVersionIds(DuplicatedIdFakeVersion.class));
AssertionError e = expectThrows(
AssertionError.class,
() -> TransportVersions.collectAllVersionIdsDefinedInClass(DuplicatedIdFakeVersion.class)
);
assertThat(e.getMessage(), containsString("have the same version number"));
}

Expand Down Expand Up @@ -194,7 +190,7 @@ public void testVersionConstantPresent() {
}

public void testCURRENTIsLatest() {
assertThat(Collections.max(TransportVersions.getAllVersions()), is(TransportVersion.current()));
assertThat(Collections.max(TransportVersion.getAllVersions()), is(TransportVersion.current()));
}

public void testPatchVersionsStillAvailable() {
Expand Down Expand Up @@ -231,7 +227,7 @@ public void testToString() {
public void testDenseTransportVersions() {
Set<Integer> missingVersions = new TreeSet<>();
TransportVersion previous = null;
for (var tv : TransportVersions.getAllVersions()) {
for (var tv : TransportVersion.getAllVersions()) {
if (tv.before(TransportVersions.V_8_16_0)) {
continue;
}
Expand Down Expand Up @@ -259,7 +255,7 @@ public void testDenseTransportVersions() {
}

public void testDuplicateConstants() {
List<TransportVersion> tvs = TransportVersions.getAllVersions().stream().sorted().toList();
List<TransportVersion> tvs = TransportVersion.getAllVersions().stream().sorted().toList();
TransportVersion previous = tvs.get(0);
for (int i = 1; i < tvs.size(); i++) {
TransportVersion next = tvs.get(i);
Expand All @@ -269,4 +265,112 @@ public void testDuplicateConstants() {
previous = next;
}
}

public void testFromName() {
assertThat(TransportVersion.fromName("test_0"), is(new TransportVersion("test_0", 3001000, null)));
assertThat(TransportVersion.fromName("test_1"), is(new TransportVersion("test_1", 3002000, null)));
assertThat(
TransportVersion.fromName("test_2"),
is(
new TransportVersion(
"test_2",
3003000,
new TransportVersion("test_2", 2001001, new TransportVersion("test_2", 1001001, null))
)
)
);
assertThat(
TransportVersion.fromName("test_3"),
is(new TransportVersion("test_3", 3003001, new TransportVersion("test_3", 2001002, null)))
);
assertThat(
TransportVersion.fromName("test_4"),
is(
new TransportVersion(
"test_4",
3003002,
new TransportVersion("test_4", 2001003, new TransportVersion("test_4", 1001002, null))
)
)
);
}

public void testSupports() {
TransportVersion test0 = TransportVersion.fromName("test_0");
assertThat(new TransportVersion(null, 2003000, null).supports(test0), is(false));
assertThat(new TransportVersion(null, 3001000, null).supports(test0), is(true));
assertThat(new TransportVersion(null, 100001001, null).supports(test0), is(true));

TransportVersion test1 = TransportVersion.fromName("test_1");
assertThat(new TransportVersion(null, 2003000, null).supports(test1), is(false));
assertThat(new TransportVersion(null, 3001000, null).supports(test1), is(false));
assertThat(new TransportVersion(null, 3001001, null).supports(test1), is(false));
assertThat(new TransportVersion(null, 3002000, null).supports(test1), is(true));
assertThat(new TransportVersion(null, 100001000, null).supports(test1), is(true));
assertThat(new TransportVersion(null, 100001001, null).supports(test1), is(true));

TransportVersion test2 = TransportVersion.fromName("test_2");
assertThat(new TransportVersion(null, 1001000, null).supports(test2), is(false));
assertThat(new TransportVersion(null, 1001001, null).supports(test2), is(true));
assertThat(new TransportVersion(null, 1001002, null).supports(test2), is(true));
assertThat(new TransportVersion(null, 1002000, null).supports(test2), is(false));
assertThat(new TransportVersion(null, 1002001, null).supports(test2), is(false));
assertThat(new TransportVersion(null, 2001000, null).supports(test2), is(false));
assertThat(new TransportVersion(null, 2001001, null).supports(test2), is(true));
assertThat(new TransportVersion(null, 2001002, null).supports(test2), is(true));
assertThat(new TransportVersion(null, 2003000, null).supports(test2), is(false));
assertThat(new TransportVersion(null, 2003001, null).supports(test2), is(false));
assertThat(new TransportVersion(null, 3001000, null).supports(test2), is(false));
assertThat(new TransportVersion(null, 3001001, null).supports(test2), is(false));
assertThat(new TransportVersion(null, 3003000, null).supports(test2), is(true));
assertThat(new TransportVersion(null, 3003001, null).supports(test2), is(true));
assertThat(new TransportVersion(null, 3003002, null).supports(test2), is(true));
assertThat(new TransportVersion(null, 3003003, null).supports(test2), is(true));
assertThat(new TransportVersion(null, 100001000, null).supports(test2), is(true));
assertThat(new TransportVersion(null, 100001001, null).supports(test2), is(true));

TransportVersion test3 = TransportVersion.fromName("test_3");
assertThat(new TransportVersion(null, 1001001, null).supports(test3), is(false));
assertThat(new TransportVersion(null, 1001002, null).supports(test3), is(false));
assertThat(new TransportVersion(null, 1001003, null).supports(test3), is(false));
assertThat(new TransportVersion(null, 1002001, null).supports(test3), is(false));
assertThat(new TransportVersion(null, 1002002, null).supports(test3), is(false));
assertThat(new TransportVersion(null, 2001001, null).supports(test3), is(false));
assertThat(new TransportVersion(null, 2001002, null).supports(test3), is(true));
assertThat(new TransportVersion(null, 2001003, null).supports(test3), is(true));
assertThat(new TransportVersion(null, 2003000, null).supports(test3), is(false));
assertThat(new TransportVersion(null, 2003001, null).supports(test3), is(false));
assertThat(new TransportVersion(null, 3001000, null).supports(test3), is(false));
assertThat(new TransportVersion(null, 3001001, null).supports(test3), is(false));
assertThat(new TransportVersion(null, 3003000, null).supports(test3), is(false));
assertThat(new TransportVersion(null, 3003001, null).supports(test3), is(true));
assertThat(new TransportVersion(null, 3003002, null).supports(test3), is(true));
assertThat(new TransportVersion(null, 3003003, null).supports(test3), is(true));
assertThat(new TransportVersion(null, 3004000, null).supports(test3), is(true));
assertThat(new TransportVersion(null, 100001000, null).supports(test3), is(true));
assertThat(new TransportVersion(null, 100001001, null).supports(test3), is(true));

TransportVersion test4 = TransportVersion.fromName("test_4");
assertThat(new TransportVersion(null, 1001001, null).supports(test4), is(false));
assertThat(new TransportVersion(null, 1001002, null).supports(test4), is(true));
assertThat(new TransportVersion(null, 1001003, null).supports(test4), is(true));
assertThat(new TransportVersion(null, 1002001, null).supports(test4), is(false));
assertThat(new TransportVersion(null, 1002002, null).supports(test4), is(false));
assertThat(new TransportVersion(null, 1002003, null).supports(test3), is(false));
assertThat(new TransportVersion(null, 2001002, null).supports(test4), is(false));
assertThat(new TransportVersion(null, 2001003, null).supports(test4), is(true));
assertThat(new TransportVersion(null, 2001004, null).supports(test4), is(true));
assertThat(new TransportVersion(null, 2003000, null).supports(test4), is(false));
assertThat(new TransportVersion(null, 2003001, null).supports(test4), is(false));
assertThat(new TransportVersion(null, 3001000, null).supports(test4), is(false));
assertThat(new TransportVersion(null, 3001001, null).supports(test4), is(false));
assertThat(new TransportVersion(null, 3003000, null).supports(test4), is(false));
assertThat(new TransportVersion(null, 3003001, null).supports(test4), is(false));
assertThat(new TransportVersion(null, 3003002, null).supports(test4), is(true));
assertThat(new TransportVersion(null, 3003003, null).supports(test4), is(true));
assertThat(new TransportVersion(null, 3003004, null).supports(test4), is(true));
assertThat(new TransportVersion(null, 3004000, null).supports(test4), is(true));
assertThat(new TransportVersion(null, 100001000, null).supports(test4), is(true));
assertThat(new TransportVersion(null, 100001001, null).supports(test4), is(true));
}
}
5 changes: 5 additions & 0 deletions server/src/test/resources/transport/constant/manifest.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
test_0.csv
test_1.csv
test_2.csv
test_3.csv
test_4.csv
1 change: 1 addition & 0 deletions server/src/test/resources/transport/constant/test_0.csv
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
100001000,3001000
2 changes: 2 additions & 0 deletions server/src/test/resources/transport/constant/test_1.csv
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
3002000

1 change: 1 addition & 0 deletions server/src/test/resources/transport/constant/test_2.csv
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
3003000,2001001,1001001
1 change: 1 addition & 0 deletions server/src/test/resources/transport/constant/test_3.csv
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
100002000,3003001,2001002
1 change: 1 addition & 0 deletions server/src/test/resources/transport/constant/test_4.csv
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
100002000,3003002,2001003,1001002
Original file line number Diff line number Diff line change
Expand Up @@ -18,5 +18,5 @@ public class KnownTransportVersions {
/**
* A sorted list of all known transport versions
*/
public static final List<TransportVersion> ALL_VERSIONS = List.copyOf(TransportVersions.getAllVersions());
public static final List<TransportVersion> ALL_VERSIONS = List.copyOf(TransportVersion.getAllVersions());
}