Merge pull request #10 from strategyobject/feature/rpc-contracts

Rpc contracts

Author: kalaninja

build.gradle

@@ -28,8 +28,10 @@ subprojects {
 
         testImplementation 'org.junit.jupiter:junit-jupiter-api:5.7.2'
         testImplementation 'org.junit.jupiter:junit-jupiter-params:5.7.2'
+        testImplementation 'org.assertj:assertj-core:3.22.0'
         testImplementation 'org.mockito:mockito-core:3.12.4'
         testImplementation 'org.mockito:mockito-inline:3.12.4'
+        testImplementation 'org.slf4j:slf4j-simple:1.7.32'
 
         testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine:5.7.2'
     }

common/build.gradle

@@ -1,4 +1,4 @@
 dependencies {
-    implementation 'org.reflections:reflections:0.10.1'
+    implementation 'org.reflections:reflections:0.10.2'
     implementation 'com.squareup:javapoet:1.13.0'
 }

rpc/rpc-codegen/build.gradle

@@ -5,12 +5,12 @@ dependencies {
     implementation project(':scale:scale-codegen')
     implementation project(':transport')
 
-    compileOnly 'com.google.auto.service:auto-service-annotations:1.0'
-    annotationProcessor 'com.google.auto.service:auto-service:1.0'
+    compileOnly 'com.google.auto.service:auto-service-annotations:1.0.1'
+    annotationProcessor 'com.google.auto.service:auto-service:1.0.1'
 
     implementation 'com.squareup:javapoet:1.13.0'
     testImplementation 'com.google.testing.compile:compile-testing:0.19'
-    testImplementation 'com.google.code.gson:gson:2.8.8'
+    testImplementation 'com.google.code.gson:gson:2.8.9'
 
     testCompileOnly project(':rpc:rpc-codegen')
     testAnnotationProcessor project(':rpc:rpc-codegen')

rpc/rpc-codegen/src/main/java/com/strategyobject/substrateclient/rpc/codegen/decoder/RpcDecoderAnnotatedClass.java

@@ -16,6 +16,7 @@
 import com.strategyobject.substrateclient.scale.codegen.ScaleAnnotationParser;
 import com.strategyobject.substrateclient.scale.codegen.reader.ReaderCompositor;
 import com.strategyobject.substrateclient.scale.registries.ScaleReaderRegistry;
+import com.strategyobject.substrateclient.transport.RpcObject;
 import lombok.NonNull;
 import lombok.val;
 import lombok.var;
@@ -83,14 +84,15 @@ private MethodSpec generateDecodeMethod(ProcessorContext context, TypeName class
                 .addAnnotation(suppressWarnings("unchecked"))
                 .addModifiers(Modifier.PUBLIC)
                 .returns(classWildcardTyped)
-                .addParameter(Object.class, VALUE_ARG)
+                .addParameter(RpcObject.class, VALUE_ARG)
                 .addParameter(ArrayTypeName.of(
                                 ParameterizedTypeName.get(
                                         ClassName.get(DecoderPair.class),
                                         WildcardTypeName.subtypeOf(Object.class))),
                         DECODERS_ARG)
                 .varargs(true);
 
+        shortcutIfNull(methodSpec);
         addValidationRules(methodSpec);
         addMethodBody(methodSpec, context);
 
@@ -100,10 +102,9 @@ private MethodSpec generateDecodeMethod(ProcessorContext context, TypeName class
     private void addMethodBody(MethodSpec.Builder methodSpec, ProcessorContext context) throws ProcessingException {
         val resultType = JavaPoet.setEachGenericParameterAs(classElement, TypeName.OBJECT);
         methodSpec
-                .addStatement("if ($L == null) { return null; }", VALUE_ARG)
                 .addStatement("$1T $2L = $1T.getInstance()", RpcDecoderRegistry.class, DECODER_REGISTRY)
                 .addStatement("$1T $2L = $1T.getInstance()", ScaleReaderRegistry.class, SCALE_READER_REGISTRY)
-                .addStatement("$1T<$2T, ?> $3L = ($1T<$2T, ?>)$4L", Map.class, String.class, MAP_VAR, VALUE_ARG)
+                .addStatement("$T<$T, $T> $L = $L.asMap()", Map.class, String.class, RpcObject.class, MAP_VAR, VALUE_ARG)
                 .addStatement("$1T $2L = new $1T()", resultType, RESULT_VAR)
                 .beginControlFlow("try");
 
@@ -166,13 +167,8 @@ private void setScaleField(MethodSpec.Builder methodSpec,
                     readerCompositor.traverse(fieldType);
             methodSpec
                     .addStatement(code
-                            .add("$T.$L(",
-                                    ScaleUtils.class,
-                                    FROM_HEX_STRING)
-                            .add("($T)$L.get($S), ",
-                                    String.class,
-                                    MAP_VAR,
-                                    field)
+                            .add("$T.$L(", ScaleUtils.class, FROM_HEX_STRING)
+                            .add("$L.get($S).asString(), ", MAP_VAR, field)
                             .add("($T)", ScaleReader.class)
                             .add(readerCode)
                             .add("))")
@@ -225,4 +221,8 @@ private void addValidationRules(MethodSpec.Builder methodSpec) {
             }
         }
     }
+
+    private void shortcutIfNull(MethodSpec.Builder methodSpec) {
+        methodSpec.addStatement("if ($L.isNull()) { return null; }", VALUE_ARG);
+    }
 }

rpc/rpc-codegen/src/main/java/com/strategyobject/substrateclient/rpc/codegen/encoder/RpcEncoderAnnotatedClass.java

@@ -92,6 +92,7 @@ private MethodSpec generateEncodeMethod(ProcessorContext context, TypeName class
                         ENCODERS_ARG)
                 .varargs(true);
 
+        shortcutIfNull(methodSpec);
         addValidationRules(methodSpec, context);
         addMethodBody(methodSpec, context);
 
@@ -100,7 +101,6 @@ private MethodSpec generateEncodeMethod(ProcessorContext context, TypeName class
 
     private void addMethodBody(MethodSpec.Builder methodSpec, ProcessorContext context) throws ProcessingException {
         methodSpec
-                .addStatement("if ($L == null) { return null; }", SOURCE_ARG)
                 .addStatement("$1T $2L = $1T.getInstance()", RpcEncoderRegistry.class, ENCODER_REGISTRY)
                 .addStatement("$1T $2L = $1T.getInstance()", ScaleWriterRegistry.class, SCALE_WRITER_REGISTRY)
                 .addStatement("$1T<$2T, $3T> $4L = new $1T<>()", HashMap.class, String.class, Object.class, RESULT_VAR)
@@ -223,4 +223,8 @@ private void addValidationRules(MethodSpec.Builder methodSpec, ProcessorContext
             }
         }
     }
+
+    private void shortcutIfNull(MethodSpec.Builder methodSpec) {
+        methodSpec.addStatement("if ($L == null) { return null; }", SOURCE_ARG);
+    }
 }

rpc/rpc-codegen/src/main/java/com/strategyobject/substrateclient/rpc/codegen/sections/RpcMethodProcessor.java

@@ -158,7 +158,7 @@ private CodeBlock getScaleReadCodeBlock(AnnotatedConstruct annotated,
         return CodeBlock.builder()
                 .add("($T) (", resultType)
                 .add("$T.$L(", ScaleUtils.class, FROM_HEX_STRING)
-                .add("($T) $L, ($T) ", String.class, arg, ScaleReader.class)
+                .add("$L.asString(), ($T) ", arg, ScaleReader.class)
                 .add(readerCode)
                 .add("))")
                 .build();

rpc/rpc-codegen/src/main/java/com/strategyobject/substrateclient/rpc/codegen/sections/RpcSubscriptionProcessor.java

@@ -6,6 +6,7 @@
 import com.strategyobject.substrateclient.common.codegen.ProcessingException;
 import com.strategyobject.substrateclient.common.codegen.ProcessorContext;
 import com.strategyobject.substrateclient.rpc.core.annotations.RpcSubscription;
+import com.strategyobject.substrateclient.transport.RpcObject;
 import lombok.NonNull;
 import lombok.val;
 
@@ -58,7 +59,7 @@ protected void callProviderInterface(MethodSpec.Builder methodSpecBuilder,
                 .add("$1T<$2T, $3T> $4L = ($5L, $6L) -> { $7N.$8L($5L, ",
                         BiConsumer.class,
                         Exception.class,
-                        Object.class,
+                        RpcObject.class,
                         CALL_BACK_PROXY,
                         CALL_BACK_EX_ARG,
                         CALL_BACK_ARG,

rpc/rpc-codegen/src/test/java/com/strategyobject/substrateclient/rpc/codegen/decoder/RpcDecoderProcessorTests.java

@@ -5,14 +5,12 @@
 import com.strategyobject.substrateclient.rpc.codegen.substitutes.TestDecodable;
 import com.strategyobject.substrateclient.rpc.core.DecoderPair;
 import com.strategyobject.substrateclient.rpc.core.registries.RpcDecoderRegistry;
+import com.strategyobject.substrateclient.transport.RpcObject;
 import lombok.val;
 import org.junit.jupiter.api.Test;
 
-import java.util.AbstractMap;
 import java.util.Arrays;
-import java.util.Map;
-import java.util.stream.Collectors;
-import java.util.stream.Stream;
+import java.util.HashMap;
 
 import static com.google.testing.compile.CompilationSubject.assertThat;
 import static com.google.testing.compile.Compiler.javac;
@@ -62,23 +60,50 @@ void compilesAndDecodes() { // TODO move this test out of the project
         val decoder = registry.resolve(TestDecodable.class)
                 .inject(DecoderPair.of(registry.resolve(String.class), null));
 
-        Object source = gson.fromJson("{\"a\":4,\"b\":\"123\",\"c\":\"some\"," +
-                        "\"d\":[\"1\",\"2\"],\"e\":{\"a\":1,\"b\":2},\"f\":\"0x04000000\"," +
-                        "\"g\":\"0x0c0500000002000000fdffffff\"}",
-                Object.class);
+        /*
+            {
+                "a": 4,
+                "b": "123",
+                "c": "some",
+                "d": [
+                    "1",
+                    "2"
+                ],
+                "e": {
+                    "a": null,
+                    "b": 2
+                },
+                "f": "0x04000000",
+                "g": "0x0c0500000002000000fdffffff",
+                "h": 1.5,
+            }
+         */
+        val source = RpcObject.of(new HashMap<String, RpcObject>() {{
+            put("a", RpcObject.of(4));
+            put("b", RpcObject.of("123"));
+            put("c", RpcObject.of("some"));
+            put("d", RpcObject.of(Arrays.asList(RpcObject.of("1"), RpcObject.of("2"))));
+            put("e", RpcObject.of(new HashMap<String, RpcObject>() {{
+                put("a", RpcObject.ofNull());
+                put("b", RpcObject.of(2));
+            }}));
+            put("f", RpcObject.of("0x04000000"));
+            put("g", RpcObject.of("0x0c0500000002000000fdffffff"));
+            put("h", RpcObject.of(1.5));
+        }});
+        val actual = decoder.decode(source);
+
         val expected = new TestDecodable<>(4,
                 "123",
                 "some",
                 Arrays.asList("1", "2"),
-                Stream.of(
-                                new AbstractMap.SimpleEntry<>("a", 1),
-                                new AbstractMap.SimpleEntry<>("b", 2))
-                        .collect(Collectors.toMap(Map.Entry::getKey, Map.Entry::getValue)),
+                new HashMap<String, Float>() {{
+                    put("a", null);
+                    put("b", 2f);
+                }},
                 4,
-                Arrays.asList(5, 2, -3));
-
-        val actual = decoder.decode(source);
-
+                Arrays.asList(5, 2, -3),
+                1.5f);
         assertEquals(gson.toJson(expected), gson.toJson(actual));
     }
 }

rpc/rpc-codegen/src/test/java/com/strategyobject/substrateclient/rpc/codegen/sections/RpcSectionFactoryTest.java

@@ -2,6 +2,8 @@
 
 import com.strategyobject.substrateclient.rpc.codegen.substitutes.TestSection;
 import com.strategyobject.substrateclient.transport.ProviderInterface;
+import com.strategyobject.substrateclient.transport.RpcBoolean;
+import com.strategyobject.substrateclient.transport.RpcObject;
 import lombok.val;
 import org.junit.jupiter.api.Test;
 
@@ -19,7 +21,7 @@ public class RpcSectionFactoryTest {
     @Test
     void createsRpcSectionAndCallsMethod() throws ExecutionException, InterruptedException, RpcInterfaceInitializationException {
         val expected = true;
-        val sendFuture = CompletableFuture.completedFuture((Object) Boolean.valueOf(expected));
+        val sendFuture = CompletableFuture.completedFuture((RpcObject) new RpcBoolean(expected));
         val provider = mock(ProviderInterface.class);
         when(provider.send(anyString(), anyList()))
                 .thenReturn(sendFuture);

rpc/rpc-codegen/src/test/java/com/strategyobject/substrateclient/rpc/codegen/substitutes/TestDecodable.java

@@ -20,9 +20,10 @@ public class TestDecodable<T> {
     private String b;
     private T c;
     private List<String> d;
-    private Map<String, Integer> e;
+    private Map<String, Float> e;
     @Scale
     private int f;
     @Scale
     private List<Integer> g;
+    private float h;
 }