fix: Allow custom HttpRules for REST LROs

.github/workflows/ci-maven.yaml

@@ -106,7 +106,6 @@ jobs:
         with:
           java-version: 8
           distribution: temurin
-          cache: maven
       - run: java -version
       - name: Run tests in Java 8 with the source compiled in Java 11 for gapic-generator-java
         shell: bash

DEVELOPMENT.md

@@ -38,4 +38,4 @@ for gapic-generator-java's Bazel build.
 
     ```sh
     mvn fmt:format
-    ```
+    ```

gapic-generator-java/src/main/java/com/google/api/generator/gapic/composer/common/AbstractTransportServiceStubClassComposer.java

@@ -649,6 +649,7 @@ protected List<MethodDefinition> createConstructorMethods(
     if (generateOperationsStubLogic(service)) {
       secondCtorExprs.addAll(
           createOperationsStubInitExpr(
+              context,
               service,
               thisExpr,
               operationsStubClassVarExpr,
@@ -758,6 +759,7 @@ protected List<MethodDefinition> createConstructorMethods(
   }
 
   protected List<Expr> createOperationsStubInitExpr(
+      GapicContext context,
       Service service,
       Expr thisExpr,
       VariableExpr operationsStubClassVarExpr,

gapic-generator-java/src/main/java/com/google/api/generator/gapic/composer/rest/HttpJsonServiceStubClassComposer.java

@@ -14,6 +14,7 @@
 
 package com.google.api.generator.gapic.composer.rest;
 
+import com.google.api.HttpRule;
 import com.google.api.core.InternalApi;
 import com.google.api.gax.httpjson.ApiMethodDescriptor;
 import com.google.api.gax.httpjson.ApiMethodDescriptor.MethodType;
@@ -63,6 +64,7 @@
 import com.google.common.annotations.VisibleForTesting;
 import com.google.common.collect.BiMap;
 import com.google.common.collect.ImmutableList;
+import com.google.common.collect.ImmutableMap;
 import com.google.protobuf.TypeRegistry;
 import java.util.ArrayList;
 import java.util.Arrays;
@@ -73,10 +75,10 @@
 import java.util.Set;
 import java.util.function.BiFunction;
 import java.util.function.Function;
+import java.util.function.Predicate;
 import java.util.stream.Collectors;
 
 public class HttpJsonServiceStubClassComposer extends AbstractTransportServiceStubClassComposer {
-
   private static final HttpJsonServiceStubClassComposer INSTANCE =
       new HttpJsonServiceStubClassComposer();
 
@@ -89,6 +91,7 @@ public class HttpJsonServiceStubClassComposer extends AbstractTransportServiceSt
                   .setType(FIXED_REST_TYPESTORE.get(TypeRegistry.class.getSimpleName()))
                   .build())
           .build();
+  private static final String LRO_NAME_PREFIX = "google.longrunning.Operations";
 
   protected HttpJsonServiceStubClassComposer() {
     super(RestContext.instance());
@@ -109,7 +112,9 @@ private static TypeStore createStaticTypes() {
             HttpJsonCallSettings.class,
             HttpJsonOperationSnapshot.class,
             HttpJsonStubCallableFactory.class,
+            HttpRule.class,
             Map.class,
+            ImmutableMap.class,
             ProtoMessageRequestFormatter.class,
             ProtoMessageResponseParser.class,
             ProtoRestSerializer.class,
@@ -1075,6 +1080,7 @@ private List<Expr> getMethodTypeExpr(Method protoMethod) {
 
   @Override
   protected List<Expr> createOperationsStubInitExpr(
+      GapicContext context,
       Service service,
       Expr thisExpr,
       VariableExpr operationsStubClassVarExpr,
@@ -1089,6 +1095,47 @@ protected List<Expr> createOperationsStubInitExpr(
       arguments.add(TYPE_REGISTRY_VAR_EXPR);
     }
 
+    // If the Service contains custom HttpRules for Operations, we pass a map of the custom rules to
+    // the Operations Client
+    Map<String, HttpRule> operationCustomHttpRules = parseOperationsCustomHttpRules(context);
+    if (operationCustomHttpRules.size() > 0) {
+      Expr operationCustomHttpBindingsBuilderExpr =
+          MethodInvocationExpr.builder()
+              .setStaticReferenceType(FIXED_REST_TYPESTORE.get(ImmutableMap.class.getSimpleName()))
+              .setMethodName("builder")
+              .setGenerics(
+                  Arrays.asList(
+                      TypeNode.STRING.reference(),
+                      FIXED_REST_TYPESTORE.get(HttpRule.class.getSimpleName()).reference()))
+              .build();
+
+      // Sorting is done to ensure consistent ordering of the entries in the Custom HttpRule Map
+      for (String selector :
+          operationCustomHttpRules.keySet().stream().sorted().collect(Collectors.toList())) {
+        HttpRule httpRule = operationCustomHttpRules.get(selector);
+        Expr httpRuleBuilderExpr = createHttpRuleExpr(httpRule, true);
+
+        operationCustomHttpBindingsBuilderExpr =
+            MethodInvocationExpr.builder()
+                .setExprReferenceExpr(operationCustomHttpBindingsBuilderExpr)
+                .setMethodName("put")
+                .setArguments(
+                    Arrays.asList(
+                        ValueExpr.withValue(StringObjectValue.withValue(selector)),
+                        httpRuleBuilderExpr))
+                .build();
+      }
+
+      operationCustomHttpBindingsBuilderExpr =
+          MethodInvocationExpr.builder()
+              .setExprReferenceExpr(operationCustomHttpBindingsBuilderExpr)
+              .setMethodName("build")
+              .setReturnType(FIXED_REST_TYPESTORE.get(ImmutableMap.class.getSimpleName()))
+              .build();
+
+      arguments.add(operationCustomHttpBindingsBuilderExpr);
+    }
+
     return Collections.singletonList(
         AssignmentExpr.builder()
             .setVariableExpr(
@@ -1103,6 +1150,73 @@ protected List<Expr> createOperationsStubInitExpr(
             .build());
   }
 
+  /* Build an Expr that creates an HttpRule. Creates a builder and adds the http verb, custom path, and any additional bindings. `additional_bindings` can only be nested one layer deep, so we only check once */
+  private Expr createHttpRuleExpr(HttpRule httpRule, boolean checkAdditionalBindings) {
+    Expr httpRuleBuilderExpr =
+        MethodInvocationExpr.builder()
+            .setStaticReferenceType(FIXED_REST_TYPESTORE.get(HttpRule.class.getSimpleName()))
+            .setMethodName("newBuilder")
+            .build();
+
+    httpRuleBuilderExpr =
+        MethodInvocationExpr.builder()
+            .setExprReferenceExpr(httpRuleBuilderExpr)
+            // toLowerCase as the PatternCase result is all uppercase
+            .setMethodName(setMethodFormat(httpRule.getPatternCase().toString().toLowerCase()))
+            .setArguments(
+                ValueExpr.withValue(
+                    StringObjectValue.withValue(getOperationsURIValueFromHttpRule(httpRule))))
+            .setReturnType(FIXED_REST_TYPESTORE.get(HttpRule.class.getSimpleName()))
+            .build();
+
+    if (checkAdditionalBindings) {
+      for (HttpRule additionalBindings : httpRule.getAdditionalBindingsList()) {
+        httpRuleBuilderExpr =
+            MethodInvocationExpr.builder()
+                .setExprReferenceExpr(httpRuleBuilderExpr)
+                .setMethodName("addAdditionalBindings")
+                .setArguments(Arrays.asList(createHttpRuleExpr(additionalBindings, false)))
+                .build();
+      }
+    }
+
+    httpRuleBuilderExpr =
+        MethodInvocationExpr.builder()
+            .setExprReferenceExpr(httpRuleBuilderExpr)
+            .setMethodName("build")
+            .setReturnType(FIXED_REST_TYPESTORE.get(HttpRule.class.getSimpleName()))
+            .build();
+    return httpRuleBuilderExpr;
+  }
+
+  /* Parses the Service Yaml file's for custom HttpRules. Filter the HttpRules for ones that match Operations */
+  private Map<String, HttpRule> parseOperationsCustomHttpRules(GapicContext context) {
+    Predicate<HttpRule> predicate = x -> x.getSelector().contains(LRO_NAME_PREFIX);
+    com.google.api.Service service = context.serviceYamlProto();
+    if (service == null || service.getHttp() == null) {
+      return ImmutableMap.of();
+    }
+    return service.getHttp().getRulesList().stream()
+        .filter(predicate)
+        .collect(Collectors.toMap(HttpRule::getSelector, x -> x));
+  }
+
+  /* This is meant to be used for the OperationsClient Mixin OperationsClient's RPCs are mapped to GET/POST/DELETE and this function only expects those HttpVerbs to be used */
+  private String getOperationsURIValueFromHttpRule(HttpRule httpRule) {
+    switch (httpRule.getPatternCase().getNumber()) {
+      case 2:
+        return httpRule.getGet();
+      case 4:
+        return httpRule.getPost();
+      case 5:
+        return httpRule.getDelete();
+      default:
+        throw new IllegalArgumentException(
+            "Operations HttpRule should only contain GET/POST/DELETE. Invalid: "
+                + httpRule.getSelector());
+    }
+  }
+
   @Override
   protected List<Statement> createLongRunningClient(Service service, TypeStore typeStore) {
     Method pollingMethod = service.operationPollingMethod();

gapic-generator-java/src/test/java/com/google/api/generator/gapic/composer/rest/HttpJsonServiceStubClassComposerTest.java

@@ -39,10 +39,10 @@ public void setUp() throws Exception {
   }
 
   @Test
-  public void generateServiceClasses() {
+  public void generateComplianceServiceClasses() {
     GapicContext context = RestTestProtoLoader.instance().parseCompliance();
-    Service echoProtoService = context.services().get(0);
-    GapicClass clazz = composer.generate(context, echoProtoService);
+    Service complianceProtoServices = context.services().get(0);
+    GapicClass clazz = composer.generate(context, complianceProtoServices);
 
     JavaWriterVisitor visitor = new JavaWriterVisitor();
     clazz.classDefinition().accept(visitor);
@@ -52,6 +52,19 @@ public void generateServiceClasses() {
     Assert.assertCodeEquals(goldenFilePath, visitor.write());
   }
 
+  @Test
+  public void generateEchoServiceClasses() {
+    GapicContext context = RestTestProtoLoader.instance().parseEcho();
+    Service echoProtoService = context.services().get(0);
+    GapicClass clazz = composer.generate(context, echoProtoService);
+
+    JavaWriterVisitor visitor = new JavaWriterVisitor();
+    clazz.classDefinition().accept(visitor);
+    Utils.saveCodegenToFile(this.getClass(), "HttpJsonEchoStub.golden", visitor.write());
+    Path goldenFilePath = Paths.get(Utils.getGoldenDir(this.getClass()), "HttpJsonEchoStub.golden");
+    Assert.assertCodeEquals(goldenFilePath, visitor.write());
+  }
+
   @Test
   public void
       getBindingFieldMethodName_shouldReturnGetFieldListIfTheFieldIsInLastPositionAndIsRepeated() {

gapic-generator-java/src/test/java/com/google/api/generator/gapic/composer/rest/RestTestProtoLoader.java

@@ -14,8 +14,7 @@
 
 package com.google.api.generator.gapic.composer.rest;
 
-import static org.junit.Assert.assertEquals;
-import static org.junit.Assert.assertTrue;
+import static com.google.common.truth.Truth.assertThat;
 
 import com.google.api.generator.gapic.composer.common.TestProtoLoader;
 import com.google.api.generator.gapic.model.GapicContext;
@@ -26,9 +25,13 @@
 import com.google.api.generator.gapic.model.Transport;
 import com.google.api.generator.gapic.protoparser.Parser;
 import com.google.api.generator.gapic.protoparser.ServiceConfigParser;
+import com.google.api.generator.gapic.protoparser.ServiceYamlParser;
+import com.google.longrunning.OperationsProto;
 import com.google.protobuf.Descriptors.FileDescriptor;
 import com.google.protobuf.Descriptors.ServiceDescriptor;
+import com.google.protobuf.StructProto;
 import com.google.showcase.v1beta1.ComplianceOuterClass;
+import com.google.showcase.v1beta1.EchoOuterClass;
 import java.nio.file.Path;
 import java.nio.file.Paths;
 import java.util.HashSet;
@@ -49,28 +52,71 @@ public static RestTestProtoLoader instance() {
   }
 
   public GapicContext parseCompliance() {
-    FileDescriptor echoFileDescriptor = ComplianceOuterClass.getDescriptor();
+    FileDescriptor complianceFileDescriptor = ComplianceOuterClass.getDescriptor();
+    ServiceDescriptor complianceServiceDescriptor = complianceFileDescriptor.getServices().get(0);
+    assertThat(complianceServiceDescriptor.getName()).isEqualTo("Compliance");
+
+    Map<String, Message> messageTypes = Parser.parseMessages(complianceFileDescriptor);
+    Map<String, ResourceName> resourceNames = Parser.parseResourceNames(complianceFileDescriptor);
+    Set<ResourceName> outputResourceNames = new HashSet<>();
+    List<Service> services =
+        Parser.parseService(
+            complianceFileDescriptor,
+            messageTypes,
+            resourceNames,
+            Optional.empty(),
+            outputResourceNames);
+
+    String jsonFilename = "showcase_grpc_service_config.json";
+    Path jsonPath = Paths.get(getTestFilesDirectory(), jsonFilename);
+    Optional<GapicServiceConfig> configOpt = ServiceConfigParser.parse(jsonPath.toString());
+    assertThat(configOpt.isPresent()).isTrue();
+    GapicServiceConfig config = configOpt.get();
+
+    return GapicContext.builder()
+        .setMessages(messageTypes)
+        .setResourceNames(resourceNames)
+        .setServices(services)
+        .setServiceConfig(config)
+        .setHelperResourceNames(outputResourceNames)
+        .setTransport(getTransport())
+        .setRestNumericEnumsEnabled(true)
+        .build();
+  }
+
+  public GapicContext parseEcho() {
+    FileDescriptor echoFileDescriptor = EchoOuterClass.getDescriptor();
     ServiceDescriptor echoServiceDescriptor = echoFileDescriptor.getServices().get(0);
-    assertEquals(echoServiceDescriptor.getName(), "Compliance");
+    assertThat(echoServiceDescriptor.getName()).isEqualTo("Echo");
+
+    String serviceYamlFileName = "showcase_v1beta1.yaml";
+    Path serviceYamlPath = Paths.get(getTestFilesDirectory(), serviceYamlFileName);
+    Optional<com.google.api.Service> serviceYamlOpt =
+        ServiceYamlParser.parse(serviceYamlPath.toString());
+    assertThat(serviceYamlOpt.isPresent()).isTrue();
+    com.google.api.Service service = serviceYamlOpt.get();
 
     Map<String, Message> messageTypes = Parser.parseMessages(echoFileDescriptor);
+    messageTypes.putAll(Parser.parseMessages(OperationsProto.getDescriptor()));
+    messageTypes.putAll(Parser.parseMessages(StructProto.getDescriptor()));
     Map<String, ResourceName> resourceNames = Parser.parseResourceNames(echoFileDescriptor);
     Set<ResourceName> outputResourceNames = new HashSet<>();
     List<Service> services =
         Parser.parseService(
-            echoFileDescriptor, messageTypes, resourceNames, Optional.empty(), outputResourceNames);
+            echoFileDescriptor, messageTypes, resourceNames, serviceYamlOpt, outputResourceNames);
 
     String jsonFilename = "showcase_grpc_service_config.json";
     Path jsonPath = Paths.get(getTestFilesDirectory(), jsonFilename);
     Optional<GapicServiceConfig> configOpt = ServiceConfigParser.parse(jsonPath.toString());
-    assertTrue(configOpt.isPresent());
+    assertThat(configOpt.isPresent()).isTrue();
     GapicServiceConfig config = configOpt.get();
 
     return GapicContext.builder()
         .setMessages(messageTypes)
         .setResourceNames(resourceNames)
         .setServices(services)
         .setServiceConfig(config)
+        .setServiceYamlProto(service)
         .setHelperResourceNames(outputResourceNames)
         .setTransport(getTransport())
         .setRestNumericEnumsEnabled(true)