* This version effectively defines the protocol version between actors participating on a particular shard. A shard * participant instance should oppose RAFT candidates which produce persistence of an unsupported version. If a follower * encounters an unsupported version it must not become fully-operational, as it does not have an accurate view * of shard state. - * - * @author Robert Varga */ @Beta public enum PayloadVersion implements WritableObject { - // NOTE: enumeration values need to be sorted in asceding order of their version to keep Comparable working + // NOTE: enumeration values need to be sorted in ascending order of their version to keep Comparable working /** * Version which is older than any other version. This version exists purely for testing purposes. */ @VisibleForTesting - TEST_PAST_VERSION(0), + TEST_PAST_VERSION(0) { + @Override + public NormalizedNodeStreamVersion getStreamVersion() { + throw new UnsupportedOperationException(); + } + }, /** - * Initial ABI version, as shipped with Boron Simultaneous release. + * ABI version shipped enabled {@code 2022.09 Chlorine SR2}. This version revises the serialization format of + * payloads proxies to reduce their size. Otherwise this format is equivalent to {@code #MAGNESIUM}. + * + * @deprecated Use {@link #POTASSIUM} instead. */ - // We seed the initial version to be the same as DataStoreVersions.BORON-VERSION for compatibility reasons. - BORON(5), + @Deprecated(since = "8.0.0", forRemoval = true) + CHLORINE_SR2(9) { + @Override + public NormalizedNodeStreamVersion getStreamVersion() { + return NormalizedNodeStreamVersion.MAGNESIUM; + } + }, + + /** + * ABI version shipped enabled {@code 2023.09 Potassium}. This version removes Augmentation identifier and nodes. + * Otherwise this format is equivalent to {@link #CHLORINE_SR2}. + */ + POTASSIUM(10) { + @Override + public NormalizedNodeStreamVersion getStreamVersion() { + return NormalizedNodeStreamVersion.POTASSIUM; + } + }, /** * Version which is newer than any other version. This version exists purely for testing purposes. */ @VisibleForTesting - TEST_FUTURE_VERSION(65535); + TEST_FUTURE_VERSION(65535) { + @Override + public NormalizedNodeStreamVersion getStreamVersion() { + throw new UnsupportedOperationException(); + } + }; private final short value; PayloadVersion(final int intVersion) { - Preconditions.checkArgument(intVersion >= 0 && intVersion <= 65535); + checkArgument(intVersion >= 0 && intVersion <= 65535); value = (short) intVersion; } @@ -67,15 +99,21 @@ public enum PayloadVersion implements WritableObject { return value; } + /** + * Return the NormalizedNode stream version corresponding to this particular ABI. + * + * @return Stream Version to use for this ABI version + */ + public abstract @NonNull NormalizedNodeStreamVersion getStreamVersion(); + /** * Return the codebase-native persistence version. This version is the default version allocated to messages * at runtime. Conversion to previous versions may incur additional overhead (such as object allocation). * * @return Current {@link PayloadVersion} */ - @Nonnull - public static PayloadVersion current() { - return BORON; + public static @NonNull PayloadVersion current() { + return POTASSIUM; } /** @@ -87,20 +125,14 @@ public enum PayloadVersion implements WritableObject { * @throws FutureVersionException if the specified integer identifies a future version * @throws PastVersionException if the specified integer identifies a past version which is no longer supported */ - @Nonnull - public static PayloadVersion valueOf(final short version) throws FutureVersionException, PastVersionException { - switch (Short.toUnsignedInt(version)) { - case 0: - case 1: - case 2: - case 3: - case 4: - throw new PastVersionException(version, BORON); - case 5: - return BORON; - default: - throw new FutureVersionException(version, BORON); - } + public static @NonNull PayloadVersion valueOf(final short version) + throws FutureVersionException, PastVersionException { + return switch (Short.toUnsignedInt(version)) { + case 0, 1, 2, 3, 4, 5, 6, 7, 8 -> throw new PastVersionException(version, CHLORINE_SR2); + case 9 -> CHLORINE_SR2; + case 10 -> POTASSIUM; + default -> throw new FutureVersionException(version, CHLORINE_SR2); + }; } @Override @@ -116,14 +148,12 @@ public enum PayloadVersion implements WritableObject { * @return An {@link PayloadVersion} * @throws IOException If read fails or an unsupported version is encountered */ - @Nonnull - public static PayloadVersion readFrom(@Nonnull final DataInput in) throws IOException { + public static @NonNull PayloadVersion readFrom(final @NonNull DataInput in) throws IOException { final short s = in.readShort(); try { return valueOf(s); } catch (FutureVersionException | PastVersionException e) { - throw new IOException("Unsupported version", e); + throw new IOException(e); } } - }