IGNITE-29143 Commit message wire format files and check them on CI

.github/workflows/commit-check.yml

@@ -124,6 +124,22 @@ jobs:
           fi
           exit "$rc"
 
+      - name: Check message wire format descriptions
+        run: |
+          missing=$(find modules -path '*/target/classes/META-INF/ignite-wire/*' -type f | sed 's#.*/META-INF/ignite-wire/##' | sort -u \
+            | while read -r f; do [ -f "modules/wire-compatibility-check/wire/$f" ] || echo "$f"; done | paste -sd ' ' -)
+          if [ -n "$missing" ]; then
+            echo "::error title=Uncollected wire format descriptions::Add the modules that generate these descriptions to modules/wire-compatibility-check/pom.xml: $missing"
+            exit 1
+          fi
+          git add -A modules/wire-compatibility-check/wire
+          if ! git diff --cached --quiet -- modules/wire-compatibility-check/wire; then
+            echo "::error title=Outdated wire format descriptions::modules/wire-compatibility-check/wire differs from the compiled messages. Run './mvnw clean process-classes -pl modules/wire-compatibility-check -am' and commit the changes."
+            git diff --cached --color=always -- modules/wire-compatibility-check/wire
+            { echo '```diff'; git diff --cached -- modules/wire-compatibility-check/wire; echo '```'; } >> "$GITHUB_STEP_SUMMARY"
+            exit 1
+          fi
+
       - name: Run abandoned tests checks.
         # Reuse classes from the previous step; the differing profiles otherwise trigger a full reactor recompile.
         run : |

assembly/dependencies-apache-ignite-lgpl.xml

@@ -140,6 +140,7 @@
                 <exclude>${project.groupId}:ignite-extdata-platform</exclude>
                 <exclude>${project.groupId}:ignite-compatibility</exclude>
                 <exclude>${project.groupId}:ignite-calcite-testing</exclude>
+                <exclude>${project.groupId}:ignite-wire-compatibility-check</exclude>
                 <exclude>${project.groupId}:ignite-sqlline</exclude>
                 <exclude>${project.groupId}:ignite-control-utility</exclude>
                 <exclude>${project.groupId}:ignite-checkstyle</exclude>

assembly/dependencies-apache-ignite-slim.xml

@@ -141,6 +141,7 @@
                 <exclude>${project.groupId}:ignite-extdata-platform</exclude>
                 <exclude>${project.groupId}:ignite-compatibility</exclude>
                 <exclude>${project.groupId}:ignite-calcite-testing</exclude>
+                <exclude>${project.groupId}:ignite-wire-compatibility-check</exclude>
                 <exclude>${project.groupId}:ignite-sqlline</exclude>
                 <!-- Removed from slim packaging are: -->
                 <exclude>${project.groupId}:ignite-direct-io</exclude>

assembly/dependencies-apache-ignite.xml

@@ -142,6 +142,7 @@
                 <exclude>${project.groupId}:ignite-extdata-platform</exclude>
                 <exclude>${project.groupId}:ignite-compatibility</exclude>
                 <exclude>${project.groupId}:ignite-calcite-testing</exclude>
+                <exclude>${project.groupId}:ignite-wire-compatibility-check</exclude>
                 <exclude>${project.groupId}:ignite-sqlline</exclude>
                 <exclude>${project.groupId}:ignite-control-utility</exclude>
                 <exclude>${project.groupId}:ignite-checkstyle</exclude>

modules/wire-compatibility-check/pom.xml

@@ -0,0 +1,82 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!--
+  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.
+-->
+
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+
+    <parent>
+        <groupId>org.apache.ignite</groupId>
+        <artifactId>ignite-parent-internal</artifactId>
+        <version>${revision}</version>
+        <relativePath>../../parent-internal/pom.xml</relativePath>
+    </parent>
+
+    <artifactId>ignite-wire-compatibility-check</artifactId>
+    <packaging>pom</packaging>
+
+    <dependencies>
+        <dependency>
+            <groupId>${project.groupId}</groupId>
+            <artifactId>ignite-core</artifactId>
+        </dependency>
+
+        <dependency>
+            <groupId>${project.groupId}</groupId>
+            <artifactId>ignite-indexing</artifactId>
+        </dependency>
+
+        <dependency>
+            <groupId>${project.groupId}</groupId>
+            <artifactId>ignite-calcite</artifactId>
+        </dependency>
+
+        <dependency>
+            <groupId>${project.groupId}</groupId>
+            <artifactId>ignite-zookeeper</artifactId>
+        </dependency>
+    </dependencies>
+
+    <build>
+        <plugins>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-antrun-plugin</artifactId>
+                <executions>
+                    <execution>
+                        <id>collect-wire</id>
+                        <phase>process-classes</phase>
+                        <goals>
+                            <goal>run</goal>
+                        </goals>
+                        <configuration>
+                            <target>
+                                <sync todir="${basedir}/wire" overwrite="true">
+                                    <fileset dir="${basedir}/../core/target/classes/META-INF/ignite-wire"/>
+                                    <fileset dir="${basedir}/../indexing/target/classes/META-INF/ignite-wire"/>
+                                    <fileset dir="${basedir}/../calcite/target/classes/META-INF/ignite-wire"/>
+                                    <fileset dir="${basedir}/../zookeeper/target/classes/META-INF/ignite-wire"/>
+                                </sync>
+                            </target>
+                        </configuration>
+                    </execution>
+                </executions>
+            </plugin>
+        </plugins>
+    </build>
+</project>

modules/wire-compatibility-check/wire/enums/javax.cache.event.EventType.json

@@ -0,0 +1,9 @@
+{
+  "class": "javax.cache.event.EventType",
+  "fields": [
+    {"order": 0, "type": "javax.cache.event.EventType", "name": "CREATED"},
+    {"order": 1, "type": "javax.cache.event.EventType", "name": "UPDATED"},
+    {"order": 2, "type": "javax.cache.event.EventType", "name": "REMOVED"},
+    {"order": 3, "type": "javax.cache.event.EventType", "name": "EXPIRED"}
+  ]
+}

modules/wire-compatibility-check/wire/enums/org.apache.ignite.cache.CacheWriteSynchronizationMode.json

@@ -0,0 +1,8 @@
+{
+  "class": "org.apache.ignite.cache.CacheWriteSynchronizationMode",
+  "fields": [
+    {"order": 0, "type": "org.apache.ignite.cache.CacheWriteSynchronizationMode", "name": "FULL_SYNC"},
+    {"order": 1, "type": "org.apache.ignite.cache.CacheWriteSynchronizationMode", "name": "FULL_ASYNC"},
+    {"order": 2, "type": "org.apache.ignite.cache.CacheWriteSynchronizationMode", "name": "PRIMARY_SYNC"}
+  ]
+}

modules/wire-compatibility-check/wire/enums/org.apache.ignite.cache.QueryIndexType.json

@@ -0,0 +1,8 @@
+{
+  "class": "org.apache.ignite.cache.QueryIndexType",
+  "fields": [
+    {"order": 0, "type": "org.apache.ignite.cache.QueryIndexType", "name": "SORTED"},
+    {"order": 1, "type": "org.apache.ignite.cache.QueryIndexType", "name": "FULLTEXT"},
+    {"order": 2, "type": "org.apache.ignite.cache.QueryIndexType", "name": "GEOSPATIAL"}
+  ]
+}

modules/wire-compatibility-check/wire/enums/org.apache.ignite.cluster.ClusterState.json

@@ -0,0 +1,8 @@
+{
+  "class": "org.apache.ignite.cluster.ClusterState",
+  "fields": [
+    {"order": 0, "type": "org.apache.ignite.cluster.ClusterState", "name": "INACTIVE"},
+    {"order": 1, "type": "org.apache.ignite.cluster.ClusterState", "name": "ACTIVE"},
+    {"order": 2, "type": "org.apache.ignite.cluster.ClusterState", "name": "ACTIVE_READ_ONLY"}
+  ]
+}

modules/wire-compatibility-check/wire/enums/org.apache.ignite.configuration.DeploymentMode.json

@@ -0,0 +1,9 @@
+{
+  "class": "org.apache.ignite.configuration.DeploymentMode",
+  "fields": [
+    {"order": 0, "type": "org.apache.ignite.configuration.DeploymentMode", "name": "PRIVATE"},
+    {"order": 1, "type": "org.apache.ignite.configuration.DeploymentMode", "name": "ISOLATED"},
+    {"order": 2, "type": "org.apache.ignite.configuration.DeploymentMode", "name": "SHARED"},
+    {"order": 3, "type": "org.apache.ignite.configuration.DeploymentMode", "name": "CONTINUOUS"}
+  ]
+}

modules/wire-compatibility-check/wire/enums/org.apache.ignite.internal.cache.query.index.sorted.IndexKeyType.json

@@ -0,0 +1,31 @@
+{
+  "class": "org.apache.ignite.internal.cache.query.index.sorted.IndexKeyType",
+  "fields": [
+    {"order": 0, "type": "org.apache.ignite.internal.cache.query.index.sorted.IndexKeyType", "name": "UNKNOWN"},
+    {"order": 1, "type": "org.apache.ignite.internal.cache.query.index.sorted.IndexKeyType", "name": "NULL"},
+    {"order": 2, "type": "org.apache.ignite.internal.cache.query.index.sorted.IndexKeyType", "name": "BOOLEAN"},
+    {"order": 3, "type": "org.apache.ignite.internal.cache.query.index.sorted.IndexKeyType", "name": "BYTE"},
+    {"order": 4, "type": "org.apache.ignite.internal.cache.query.index.sorted.IndexKeyType", "name": "SHORT"},
+    {"order": 5, "type": "org.apache.ignite.internal.cache.query.index.sorted.IndexKeyType", "name": "INT"},
+    {"order": 6, "type": "org.apache.ignite.internal.cache.query.index.sorted.IndexKeyType", "name": "LONG"},
+    {"order": 7, "type": "org.apache.ignite.internal.cache.query.index.sorted.IndexKeyType", "name": "DECIMAL"},
+    {"order": 8, "type": "org.apache.ignite.internal.cache.query.index.sorted.IndexKeyType", "name": "DOUBLE"},
+    {"order": 9, "type": "org.apache.ignite.internal.cache.query.index.sorted.IndexKeyType", "name": "FLOAT"},
+    {"order": 10, "type": "org.apache.ignite.internal.cache.query.index.sorted.IndexKeyType", "name": "TIME"},
+    {"order": 11, "type": "org.apache.ignite.internal.cache.query.index.sorted.IndexKeyType", "name": "DATE"},
+    {"order": 12, "type": "org.apache.ignite.internal.cache.query.index.sorted.IndexKeyType", "name": "TIMESTAMP"},
+    {"order": 13, "type": "org.apache.ignite.internal.cache.query.index.sorted.IndexKeyType", "name": "BYTES"},
+    {"order": 14, "type": "org.apache.ignite.internal.cache.query.index.sorted.IndexKeyType", "name": "STRING"},
+    {"order": 15, "type": "org.apache.ignite.internal.cache.query.index.sorted.IndexKeyType", "name": "STRING_IGNORECASE"},
+    {"order": 16, "type": "org.apache.ignite.internal.cache.query.index.sorted.IndexKeyType", "name": "BLOB"},
+    {"order": 17, "type": "org.apache.ignite.internal.cache.query.index.sorted.IndexKeyType", "name": "CLOB"},
+    {"order": 18, "type": "org.apache.ignite.internal.cache.query.index.sorted.IndexKeyType", "name": "ARRAY"},
+    {"order": 19, "type": "org.apache.ignite.internal.cache.query.index.sorted.IndexKeyType", "name": "RESULT_SET"},
+    {"order": 20, "type": "org.apache.ignite.internal.cache.query.index.sorted.IndexKeyType", "name": "JAVA_OBJECT"},
+    {"order": 21, "type": "org.apache.ignite.internal.cache.query.index.sorted.IndexKeyType", "name": "UUID"},
+    {"order": 22, "type": "org.apache.ignite.internal.cache.query.index.sorted.IndexKeyType", "name": "STRING_FIXED"},
+    {"order": 23, "type": "org.apache.ignite.internal.cache.query.index.sorted.IndexKeyType", "name": "GEOMETRY"},
+    {"order": 24, "type": "org.apache.ignite.internal.cache.query.index.sorted.IndexKeyType", "name": "TIMESTAMP_TZ"},
+    {"order": 25, "type": "org.apache.ignite.internal.cache.query.index.sorted.IndexKeyType", "name": "ENUM"}
+  ]
+}

modules/wire-compatibility-check/wire/enums/org.apache.ignite.internal.processors.authentication.UserManagementOperation$OperationType.json

@@ -0,0 +1,8 @@
+{
+  "class": "org.apache.ignite.internal.processors.authentication.UserManagementOperation$OperationType",
+  "fields": [
+    {"order": 0, "type": "org.apache.ignite.internal.processors.authentication.UserManagementOperation$OperationType", "name": "ADD"},
+    {"order": 1, "type": "org.apache.ignite.internal.processors.authentication.UserManagementOperation$OperationType", "name": "UPDATE"},
+    {"order": 2, "type": "org.apache.ignite.internal.processors.authentication.UserManagementOperation$OperationType", "name": "REMOVE"}
+  ]
+}

modules/wire-compatibility-check/wire/enums/org.apache.ignite.internal.processors.cache.CacheEntryPredicateType.json

@@ -0,0 +1,10 @@
+{
+  "class": "org.apache.ignite.internal.processors.cache.CacheEntryPredicateType",
+  "fields": [
+    {"order": 0, "type": "org.apache.ignite.internal.processors.cache.CacheEntryPredicateType", "name": "VALUE"},
+    {"order": 1, "type": "org.apache.ignite.internal.processors.cache.CacheEntryPredicateType", "name": "HAS_VALUE"},
+    {"order": 2, "type": "org.apache.ignite.internal.processors.cache.CacheEntryPredicateType", "name": "HAS_NO_VALUE"},
+    {"order": 3, "type": "org.apache.ignite.internal.processors.cache.CacheEntryPredicateType", "name": "ALWAYS_FALSE"},
+    {"order": 4, "type": "org.apache.ignite.internal.processors.cache.CacheEntryPredicateType", "name": "OTHER"}
+  ]
+}

modules/wire-compatibility-check/wire/enums/org.apache.ignite.internal.processors.cache.CacheType.json

@@ -0,0 +1,9 @@
+{
+  "class": "org.apache.ignite.internal.processors.cache.CacheType",
+  "fields": [
+    {"order": 0, "type": "org.apache.ignite.internal.processors.cache.CacheType", "name": "USER"},
+    {"order": 1, "type": "org.apache.ignite.internal.processors.cache.CacheType", "name": "INTERNAL"},
+    {"order": 2, "type": "org.apache.ignite.internal.processors.cache.CacheType", "name": "DATA_STRUCTURES"},
+    {"order": 3, "type": "org.apache.ignite.internal.processors.cache.CacheType", "name": "UTILITY"}
+  ]
+}

modules/wire-compatibility-check/wire/enums/org.apache.ignite.internal.processors.cache.GridCacheOperation.json

@@ -0,0 +1,12 @@
+{
+  "class": "org.apache.ignite.internal.processors.cache.GridCacheOperation",
+  "fields": [
+    {"order": 0, "type": "org.apache.ignite.internal.processors.cache.GridCacheOperation", "name": "READ"},
+    {"order": 1, "type": "org.apache.ignite.internal.processors.cache.GridCacheOperation", "name": "CREATE"},
+    {"order": 2, "type": "org.apache.ignite.internal.processors.cache.GridCacheOperation", "name": "UPDATE"},
+    {"order": 3, "type": "org.apache.ignite.internal.processors.cache.GridCacheOperation", "name": "DELETE"},
+    {"order": 4, "type": "org.apache.ignite.internal.processors.cache.GridCacheOperation", "name": "TRANSFORM"},
+    {"order": 5, "type": "org.apache.ignite.internal.processors.cache.GridCacheOperation", "name": "RELOAD"},
+    {"order": 6, "type": "org.apache.ignite.internal.processors.cache.GridCacheOperation", "name": "NOOP"}
+  ]
+}

modules/wire-compatibility-check/wire/enums/org.apache.ignite.internal.processors.cache.query.GridCacheQueryType.json

@@ -0,0 +1,12 @@
+{
+  "class": "org.apache.ignite.internal.processors.cache.query.GridCacheQueryType",
+  "fields": [
+    {"order": 0, "type": "org.apache.ignite.internal.processors.cache.query.GridCacheQueryType", "name": "SPI"},
+    {"order": 1, "type": "org.apache.ignite.internal.processors.cache.query.GridCacheQueryType", "name": "SCAN"},
+    {"order": 2, "type": "org.apache.ignite.internal.processors.cache.query.GridCacheQueryType", "name": "SQL"},
+    {"order": 3, "type": "org.apache.ignite.internal.processors.cache.query.GridCacheQueryType", "name": "SQL_FIELDS"},
+    {"order": 4, "type": "org.apache.ignite.internal.processors.cache.query.GridCacheQueryType", "name": "TEXT"},
+    {"order": 5, "type": "org.apache.ignite.internal.processors.cache.query.GridCacheQueryType", "name": "SET"},
+    {"order": 6, "type": "org.apache.ignite.internal.processors.cache.query.GridCacheQueryType", "name": "INDEX"}
+  ]
+}

modules/wire-compatibility-check/wire/enums/org.apache.ignite.internal.processors.cache.verify.PartitionHashRecord$PartitionState.json

@@ -0,0 +1,8 @@
+{
+  "class": "org.apache.ignite.internal.processors.cache.verify.PartitionHashRecord$PartitionState",
+  "fields": [
+    {"order": 0, "type": "org.apache.ignite.internal.processors.cache.verify.PartitionHashRecord$PartitionState", "name": "OWNING"},
+    {"order": 1, "type": "org.apache.ignite.internal.processors.cache.verify.PartitionHashRecord$PartitionState", "name": "MOVING"},
+    {"order": 2, "type": "org.apache.ignite.internal.processors.cache.verify.PartitionHashRecord$PartitionState", "name": "LOST"}
+  ]
+}

modules/wire-compatibility-check/wire/enums/org.apache.ignite.internal.processors.continuous.GridContinuousMessageType.json

@@ -0,0 +1,7 @@
+{
+  "class": "org.apache.ignite.internal.processors.continuous.GridContinuousMessageType",
+  "fields": [
+    {"order": 0, "type": "org.apache.ignite.internal.processors.continuous.GridContinuousMessageType", "name": "MSG_EVT_NOTIFICATION"},
+    {"order": 1, "type": "org.apache.ignite.internal.processors.continuous.GridContinuousMessageType", "name": "MSG_EVT_ACK"}
+  ]
+}

modules/wire-compatibility-check/wire/enums/org.apache.ignite.internal.processors.continuous.StartRoutineDiscoveryMessage$Mode.json

@@ -0,0 +1,7 @@
+{
+  "class": "org.apache.ignite.internal.processors.continuous.StartRoutineDiscoveryMessage$Mode",
+  "fields": [
+    {"order": 0, "type": "org.apache.ignite.internal.processors.continuous.StartRoutineDiscoveryMessage$Mode", "name": "MUTABLE"},
+    {"order": 1, "type": "org.apache.ignite.internal.processors.continuous.StartRoutineDiscoveryMessage$Mode", "name": "IMMUTABLE"}
+  ]
+}

modules/wire-compatibility-check/wire/enums/org.apache.ignite.internal.processors.datastreamer.DataStreamerBuiltInUpdater.json

@@ -0,0 +1,9 @@
+{
+  "class": "org.apache.ignite.internal.processors.datastreamer.DataStreamerBuiltInUpdater",
+  "fields": [
+    {"order": 0, "type": "org.apache.ignite.internal.processors.datastreamer.DataStreamerBuiltInUpdater", "name": "ISOLATED"},
+    {"order": 1, "type": "org.apache.ignite.internal.processors.datastreamer.DataStreamerBuiltInUpdater", "name": "INDIVIDUAL"},
+    {"order": 2, "type": "org.apache.ignite.internal.processors.datastreamer.DataStreamerBuiltInUpdater", "name": "BATCHED"},
+    {"order": 3, "type": "org.apache.ignite.internal.processors.datastreamer.DataStreamerBuiltInUpdater", "name": "BATCHED_SORTED"}
+  ]
+}

modules/wire-compatibility-check/wire/enums/org.apache.ignite.internal.processors.marshaller.MappingProposedMessage$ProposalStatus.json

@@ -0,0 +1,8 @@
+{
+  "class": "org.apache.ignite.internal.processors.marshaller.MappingProposedMessage$ProposalStatus",
+  "fields": [
+    {"order": 0, "type": "org.apache.ignite.internal.processors.marshaller.MappingProposedMessage$ProposalStatus", "name": "SUCCESSFUL"},
+    {"order": 1, "type": "org.apache.ignite.internal.processors.marshaller.MappingProposedMessage$ProposalStatus", "name": "IN_CONFLICT"},
+    {"order": 2, "type": "org.apache.ignite.internal.processors.marshaller.MappingProposedMessage$ProposalStatus", "name": "DUPLICATED"}
+  ]
+}

modules/wire-compatibility-check/wire/enums/org.apache.ignite.internal.processors.query.stat.StatisticsType.json

@@ -0,0 +1,8 @@
+{
+  "class": "org.apache.ignite.internal.processors.query.stat.StatisticsType",
+  "fields": [
+    {"order": 0, "type": "org.apache.ignite.internal.processors.query.stat.StatisticsType", "name": "PARTITION"},
+    {"order": 1, "type": "org.apache.ignite.internal.processors.query.stat.StatisticsType", "name": "LOCAL"},
+    {"order": 2, "type": "org.apache.ignite.internal.processors.query.stat.StatisticsType", "name": "GLOBAL"}
+  ]
+}