IGNITE-26728 Perform enum fields serialization/deserialization with mappers

Author: sergey-chugunov-1985

modules/codegen2/src/main/java/org/apache/ignite/internal/MessageSerializerGenerator.java

@@ -92,6 +92,9 @@ class MessageSerializerGenerator {
     /** Collection of message-specific imports. */
     private final Set<String> imports = new TreeSet<>();
 
+    /** Collection of Serializer class fields containing mappers for message enum fields. */
+    private final Set<String> mapperFields = new TreeSet<>();
+
     /** */
     private final ProcessingEnvironment env;
 
@@ -142,6 +145,8 @@ private String generateSerializerCode(String serClsName) throws IOException {
         try (Writer writer = new StringWriter()) {
             writeClassHeader(writer, PKG_NAME, serClsName);
 
+            writeClassFields(writer);
+
             // Write #writeTo method.
             for (String w: write)
                 writer.write(w + NL);
@@ -238,10 +243,6 @@ private void processField(VariableElement field, int opt) throws Exception {
         if (assignableFrom(field.asType(), type(Throwable.class.getName())))
             throw new UnsupportedOperationException("You should use ErrorMessage for serialization of throwables.");
 
-        if (enumType(erasedType(field.asType())))
-            throw new IllegalArgumentException("Unsupported enum type: " + field.asType() +
-                    ". The enum must be wrapped into a Message (see, for example, TransactionIsolationMessage).");
-
         writeField(field, opt);
         readField(field, opt);
     }
@@ -335,7 +336,7 @@ private void returnFalseIfWriteFailed(VariableElement field) throws Exception {
 
             imports.add("org.apache.ignite.plugin.extensions.communication.MessageCollectionItemType");
 
-            returnFalseIfWriteFailed(write, "writer.writeObjectArray", getExpr,
+            returnFalseIfEnumWriteFailed(write, "writer.writeObjectArray", getExpr,
                 "MessageCollectionItemType." + messageCollectionItemType(componentType));
 
             return;
@@ -388,10 +389,31 @@ else if (assignableFrom(erasedType(type), type(Collection.class.getName()))) {
 
                 imports.add("org.apache.ignite.plugin.extensions.communication.MessageCollectionItemType");
 
-                returnFalseIfWriteFailed(write, "writer.writeCollection", getExpr,
+                returnFalseIfEnumWriteFailed(write, "writer.writeCollection", getExpr,
                     "MessageCollectionItemType." + messageCollectionItemType(typeArgs.get(0)));
             }
 
+            else if (enumType(type)) {
+                //TODO check CustomMapper annotation
+                imports.add("org.apache.ignite.plugin.extensions.communication.mappers.EnumMapper");
+                imports.add("org.apache.ignite.plugin.extensions.communication.mappers.DefaultEnumMapper");
+
+                Element element = env.getTypeUtils().asElement(type);
+
+                imports.add(element.toString());
+
+                String enumName = element.getSimpleName().toString();
+
+                char[] chars = enumName.toCharArray();
+                chars[0] = Character.toLowerCase(chars[0]);
+
+                String enumMapperSerializerFieldName = new String(chars) + "Mapper";
+
+                mapperFields.add("private final EnumMapper<" + enumName + "> " + enumMapperSerializerFieldName + " = new DefaultEnumMapper<>(" + enumName + ".values());");
+
+                returnFalseIfEnumWriteFailed(write, "writer.writeByte", enumMapperSerializerFieldName + ".encode", getExpr);
+            }
+
             else
                 throw new IllegalArgumentException("Unsupported declared type: " + type);
 
@@ -420,6 +442,23 @@ private void returnFalseIfWriteFailed(Collection<String> code, String accessor,
         indent--;
     }
 
+    /**
+     * Generate code of writing single enum field mapped with EnumMapper:
+     * <pre>
+     * if (!writer.writeByte(myEnumMapper.encode(msg.myEnum()))
+     *     return false;
+     * </pre>
+     */
+    private void returnFalseIfEnumWriteFailed(Collection<String> code, String writerCall, String mapperCall, String fieldGetterCall) {
+        code.add(line("if (!%s(%s(msg.%s)))", writerCall, mapperCall, fieldGetterCall));
+
+        indent++;
+
+        code.add(line("return false;"));
+
+        indent--;
+    }
+
     /**
      * Discover access read methods, like {@code readInt}.
      *
@@ -530,6 +569,18 @@ else if (assignableFrom(erasedType(type), type(Collection.class.getName()))) {
                     "MessageCollectionItemType." + messageCollectionItemType(typeArgs.get(0)));
             }
 
+            else if (enumType(type)) {
+                //TODO check CustomMapper annotation
+                String enumName = env.getTypeUtils().asElement(type).getSimpleName().toString();
+
+                char[] chars = enumName.toCharArray();
+                chars[0] = Character.toLowerCase(chars[0]);
+
+                String enumMapperSerializerFieldName = new String(chars) + "Mapper";
+
+                returnFalseIfEnumReadFailed(name, enumMapperSerializerFieldName + ".decode");
+            }
+
             else
                 throw new IllegalArgumentException("Unsupported declared type: " + type);
 
@@ -643,6 +694,32 @@ private void returnFalseIfReadFailed(String var, String mtd, String... args) {
         indent--;
     }
 
+    /**
+     * Generate code of reading single field:
+     * <pre>
+     * msg.id(reader.readInt());
+     *
+     * if (!reader.isLastRead())
+     *     return false;
+     * </pre>
+     *
+     * @param msgSetterName Variable name.
+     * @param mapperDecodeCall Method name.
+     */
+    private void returnFalseIfEnumReadFailed(String msgSetterName, String mapperDecodeCall) {
+        read.add(line("msg.%s(%s(reader.readByte()));", msgSetterName, mapperDecodeCall));
+
+        read.add(EMPTY);
+
+        read.add(line("if (!reader.isLastRead())"));
+
+        indent++;
+
+        read.add(line("return false;"));
+
+        indent--;
+    }
+
     /** */
     private void finish(List<String> code) {
         String lastLine = code.get(code.size() - 1);
@@ -672,6 +749,21 @@ private String line(String format, Object... args) {
         return sb.toString();
     }
 
+    /** Write header of serializer class: license, imports, class declaration. */
+    private void writeClassFields(Writer writer) throws IOException {
+        indent = 1;
+
+        for (String field: mapperFields) {
+            writer.write(line(METHOD_JAVADOC));
+            writer.write(NL);
+            writer.write(line(field));
+            writer.write(NL);
+        }
+        writer.write(NL);
+
+        indent = 0;
+    }
+
     /** Write header of serializer class: license, imports, class declaration. */
     private void writeClassHeader(Writer writer, String pkgName, String serClsName) throws IOException {
         try (InputStream in = getClass().getClassLoader().getResourceAsStream("license.txt");
@@ -719,13 +811,9 @@ private boolean assignableFrom(TypeMirror type, TypeMirror superType) {
 
     /** */
     private boolean enumType(TypeMirror type) {
-        if (type.getKind() == TypeKind.DECLARED) {
-            Element element = env.getTypeUtils().asElement(type);
-
-            return element != null && element.getKind() == ElementKind.ENUM;
-        }
+        Element element = env.getTypeUtils().asElement(type);
 
-        return false;
+        return element != null && element.getKind() == ElementKind.ENUM;
     }
 
     /** */

…s/codegen/UnwrappedEnumFieldMessage.java …unication/mappers/DefaultEnumMapper.javamodules/core/src/test/resources/codegen/UnwrappedEnumFieldMessage.java renamed to modules/core/src/main/java/org/apache/ignite/plugin/extensions/communication/mappers/DefaultEnumMapper.java modules/core/src/test/resources/codegen/UnwrappedEnumFieldMessage.java renamed to modules/core/src/main/java/org/apache/ignite/plugin/extensions/communication/mappers/DefaultEnumMapper.java

@@ -15,24 +15,25 @@
  * limitations under the License.
  */
 
-package org.apache.ignite.internal;
+package org.apache.ignite.plugin.extensions.communication.mappers;
 
-import org.apache.ignite.plugin.extensions.communication.Message;
-import org.apache.ignite.transactions.TransactionIsolation;
+/** */
+public class DefaultEnumMapper<T extends Enum<T>> implements EnumMapper<T> {
+    /** */
+    private final T[] enumVals;
 
-public class UnwrappedEnumFieldMessage implements Message {
-    @Order(0)
-    private TransactionIsolation isolation;
-
-    public TransactionIsolation isolation() {
-        return isolation;
+    /** */
+    public DefaultEnumMapper(T[] vals) {
+        enumVals = vals;
     }
 
-    public void isolation(TransactionIsolation isolation) {
-        this.isolation = isolation;
+    /** {@inheritDoc} */
+    @Override public byte encode(T enumVal) {
+        return (byte)enumVal.ordinal();
     }
 
-    public short directType() {
-        return 0;
+    /** {@inheritDoc} */
+    @Override public T decode(byte enumCode) {
+        return enumVals[enumCode];
     }
 }

modules/core/src/main/java/org/apache/ignite/plugin/extensions/communication/mappers/EnumMapper.java

@@ -0,0 +1,24 @@
+/*
+ * 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.ignite.plugin.extensions.communication.mappers;
+
+public interface EnumMapper<T extends Enum<T>> {
+    public byte encode(T enumVal);
+
+    public T decode(byte enumCode);
+}

modules/core/src/test/java/org/apache/ignite/internal/codegen/MessageProcessorTest.java

@@ -30,7 +30,6 @@
 import org.apache.ignite.internal.util.typedef.F;
 import org.apache.ignite.lang.IgniteUuid;
 import org.apache.ignite.plugin.extensions.communication.Message;
-import org.apache.ignite.transactions.TransactionIsolation;
 import org.junit.Test;
 
 import static com.google.testing.compile.CompilationSubject.assertThat;
@@ -173,11 +172,14 @@ public void testExceptionFailed() {
 
     /** */
     @Test
-    public void testEnumFieldFailed() {
-        Compilation compilation = compile("UnwrappedEnumFieldMessage.java");
+    public void testEnumFields() {
+        Compilation compilation = compile("EnumFieldsMessage.java");
 
-        assertThat(compilation).failed();
-        assertThat(compilation).hadErrorContaining("Unsupported enum type: " + TransactionIsolation.class.getName());
+        assertThat(compilation).succeeded();
+
+        assertThat(compilation)
+            .generatedSourceFile("org.apache.ignite.internal.codegen.EnumFieldsMessageSerializer")
+            .hasSourceEquivalentTo(javaFile("EnumFieldsMessageSerializer.java"));
     }
 
     /** */

modules/core/src/test/resources/codegen/EnumFieldsMessage.java

@@ -0,0 +1,51 @@
+/*
+ * 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.ignite.internal;
+
+import org.apache.ignite.cache.CacheAtomicityMode;
+import org.apache.ignite.internal.processors.cache.GridCacheOperation;
+import org.apache.ignite.plugin.extensions.communication.Message;
+import org.apache.ignite.transactions.TransactionIsolation;
+
+public class EnumFieldsMessage implements Message {
+    @Order(0)
+    private TransactionIsolation publicEnum;
+
+    @Order(1)
+    private GridCacheOperation internalEnum;
+
+    public TransactionIsolation publicEnum() {
+        return publicEnum;
+    }
+
+    public void publicEnum(TransactionIsolation publicEnum) {
+        this.publicEnum = publicEnum;
+    }
+
+    public GridCacheOperation internalEnum() {
+        return internalEnum;
+    }
+
+    public void internalEnum(GridCacheOperation internalEnum) {
+        this.internalEnum = internalEnum;
+    }
+
+    public short directType() {
+        return 0;
+    }
+}