if_not_found option as a replacement for "nullable"

SuduIDE · Sep 22, 2023 · bc784ec · bc784ec
1 parent fdac51d
commit bc784ec
Show file tree

Hide file tree

Showing 5 changed files with 20 additions and 13 deletions.
diff --git a/generator/src/main/java/org/sudu/protogen/descriptors/Method.java b/generator/src/main/java/org/sudu/protogen/descriptors/Method.java
@@ -37,8 +37,9 @@ public boolean isOutputStreaming() {
         return methodDescriptor.isServerStreaming();
     }
 
-    public final boolean isNullable() {
-        return getNullableOption().orElse(false);
+    public final protogen.Options.IfNotFound ifNotFoundBehavior() {
+        return Options.wrapExtension(methodDescriptor.getOptions(), protogen.Options.ifNotFound)
+                .orElse(protogen.Options.IfNotFound.IGNORE);
     }
 
     public final String generatedName() {
@@ -83,10 +84,6 @@ protected Optional<Boolean> getUnfoldRequestOption() {
         return Options.wrapExtension(methodDescriptor.getOptions(), protogen.Options.unfoldRequest);
     }
 
-    protected Optional<Boolean> getNullableOption() {
-        return Options.wrapExtension(methodDescriptor.getOptions(), protogen.Options.nullable);
-    }
-
     public RepeatedContainer getStreamToContainer() {
         return Options.wrapExtension(methodDescriptor.getOptions(), protogen.Options.streamToContainer)
                 .map(RepeatedContainer::fromGrpc)

diff --git a/generator/src/main/java/org/sudu/protogen/generator/client/ApiMethodGeneratorBase.java b/generator/src/main/java/org/sudu/protogen/generator/client/ApiMethodGeneratorBase.java
@@ -9,6 +9,7 @@
 import org.sudu.protogen.generator.message.ToGrpcMethodGenerator;
 import org.sudu.protogen.generator.type.TypeModel;
 import org.sudu.protogen.utils.Poem;
+import protogen.Options;
 
 import java.util.List;
 
@@ -37,7 +38,7 @@ public MethodSpec generate() {
                 .addParameters(params)
                 .addCode(body(params))
                 .addAnnotation(
-                        method.isNullable()
+                        method.ifNotFoundBehavior() == Options.IfNotFound.NULLIFY
                                 ? context.configuration().nullableAnnotationClass()
                                 : context.configuration().nonnullAnnotationClass()
                 )

diff --git a/generator/src/main/java/org/sudu/protogen/generator/client/StubCallMethodGenerator.java b/generator/src/main/java/org/sudu/protogen/generator/client/StubCallMethodGenerator.java
@@ -7,6 +7,7 @@
 import org.sudu.protogen.generator.GenerationContext;
 import org.sudu.protogen.generator.type.RepeatedType;
 import org.sudu.protogen.generator.type.TypeModel;
+import protogen.Options;
 
 import javax.lang.model.element.Modifier;
 import java.util.List;
@@ -35,7 +36,7 @@ public MethodSpec generate() {
                 .addCode(body())
                 .returns(returnType.getTypeName())
                 .addAnnotation(
-                        method.isNullable()
+                        method.ifNotFoundBehavior() == Options.IfNotFound.NULLIFY
                                 ? context.configuration().nullableAnnotationClass()
                                 : context.configuration().nonnullAnnotationClass()
                 )
@@ -62,8 +63,10 @@ private CodeBlock body() {
             returnExpr = returnType.fromGrpcTransformer(returnExpr);
         }
 
-        if (method.isNullable()) {
-            returnExpr = CodeBlock.of("$T.nullifyIfNotFound(() -> $L)", BaseClientUtils.class, returnExpr);
+        switch (method.ifNotFoundBehavior()) {
+            case NULLIFY ->
+                    returnExpr = CodeBlock.of("$T.nullifyIfNotFound(() -> $L)", BaseClientUtils.class, returnExpr);
+            case EMPTY -> returnExpr = CodeBlock.of("$T.emptyIfNotFound(() -> $L)", BaseClientUtils.class, returnExpr);
         }
 
         if (returnType.getTypeName() != TypeName.VOID) {

diff --git a/options/src/main/proto/protogen/options.proto b/options/src/main/proto/protogen/options.proto
@@ -24,6 +24,12 @@ enum AccessModifier {
   PRIVATE = 2;
 }
 
+enum IfNotFound {
+  IGNORE = 0;
+  NULLIFY = 1;
+  EMPTY = 2;
+}
+
 extend google.protobuf.FileOptions {
   // Asks protogen to generate the whole content of the file excluding *Request/*Response messages
   bool enable = 5000;
@@ -149,7 +155,7 @@ extend google.protobuf.MethodOptions {
   // If enabled, applies field unfolding for request parameters even if input is a domain object
   bool unfold_request = 5502;
   // Annotates method with @Nullable and wraps response into nullifyIfNotFound method of BaseGrpcClient
-  bool nullable = 5503;
+  IfNotFound if_not_found = 5503;
   // If method is output-streaming, collects its output into a specified container using spliterator
   RepeatedContainer stream_to_container = 5504;
   /*
@@ -161,7 +167,7 @@ extend google.protobuf.MethodOptions {
    * }
    */
   string method_name = 5505;
-  // Allows to make your method public/proteceted/private
+  // Allows to make your method public/protected/private
   AccessModifier access_modifier = 5506;
 
 }
diff --git a/tests/src/test/proto/client.proto b/tests/src/test/proto/client.proto
@@ -65,7 +65,7 @@ service SomeService {
   rpc commonRetList(google.protobuf.Empty) returns (GrpcListResponse);
   rpc commonMulti(GrpcMultiFieldRequest) returns (GrpcDomain);
   rpc commonMultiNullable(GrpcMultiFieldRequest) returns (GrpcDomain) {
-    option (.protogen.nullable) = true;
+    option (.protogen.if_not_found) = NULLIFY;
   }
   rpc commonUnfolded(GrpcMultiFieldRequest) returns (GrpcDomainId);
   rpc commonOneField(GrpcMultiFieldRequest) returns (GrpcOneFieldResponse);