[ggj] feat: add LRO parsing

src/main/java/com/google/api/generator/gapic/model/BUILD.bazel

@@ -15,6 +15,7 @@ java_library(
         "//src/main/java/com/google/api/generator/engine/ast",
         "@com_google_auto_value_auto_value//jar",
         "@com_google_auto_value_auto_value_annotations//jar",
+        "@com_google_code_findbugs_jsr305//jar",
         "@com_google_guava_guava//jar",
     ],
 )

src/main/java/com/google/api/generator/gapic/model/LongrunningOperation.java

@@ -0,0 +1,44 @@
+// Copyright 2020 Google LLC
+//
+// Licensed 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 com.google.api.generator.gapic.model;
+
+import com.google.api.generator.engine.ast.TypeNode;
+import com.google.auto.value.AutoValue;
+
+@AutoValue
+public abstract class LongrunningOperation {
+  public abstract TypeNode responseType();
+
+  public abstract TypeNode metadataType();
+
+  public static LongrunningOperation withTypes(TypeNode responseType, TypeNode metadataType) {
+    return builder().setResponseType(responseType).setMetadataType(metadataType).build();
+  }
+
+  // Private.
+  static Builder builder() {
+    return new AutoValue_LongrunningOperation.Builder();
+  }
+
+  // Private.
+  @AutoValue.Builder
+  abstract static class Builder {
+    abstract Builder setResponseType(TypeNode responseType);
+
+    abstract Builder setMetadataType(TypeNode metadataType);
+
+    abstract LongrunningOperation build();
+  }
+}

src/main/java/com/google/api/generator/gapic/model/Method.java

@@ -16,6 +16,7 @@
 
 import com.google.api.generator.engine.ast.TypeNode;
 import com.google.auto.value.AutoValue;
+import javax.annotation.Nullable;
 
 @AutoValue
 public abstract class Method {
@@ -34,6 +35,13 @@ public enum Stream {
 
   public abstract TypeNode outputType();
 
+  @Nullable
+  public abstract LongrunningOperation lro();
+
+  public boolean hasLro() {
+    return lro() != null;
+  }
+
   // TODO(miraleung): Parse annotations, comments.
 
   public static Builder builder() {
@@ -63,6 +71,8 @@ public abstract static class Builder {
 
     public abstract Builder setStream(Stream stream);
 
+    public abstract Builder setLro(LongrunningOperation lro);
+
     public abstract Method build();
   }
 }

src/main/java/com/google/api/generator/gapic/protoparser/BUILD.bazel

@@ -5,12 +5,21 @@ filegroup(
     srcs = glob(["*.java"]),
 )
 
+java_proto_library(
+    name = "longrunning_java_proto",
+    visibility = ["//visibility:private"],
+    deps = [
+        "@com_google_googleapis//google/longrunning:operations_proto",
+    ],
+)
+
 java_library(
     name = "protoparser",
     srcs = [
         ":protoparser_files",
     ],
     deps = [
+        ":longrunning_java_proto",
         "//src/main/java/com/google/api/generator/engine/ast",
         "//src/main/java/com/google/api/generator/gapic/model",
         "@com_google_code_findbugs_jsr305//jar",

src/main/java/com/google/api/generator/gapic/protoparser/Parser.java

@@ -17,16 +17,21 @@
 import com.google.api.generator.engine.ast.TypeNode;
 import com.google.api.generator.engine.ast.VaporReference;
 import com.google.api.generator.gapic.model.Field;
+import com.google.api.generator.gapic.model.LongrunningOperation;
 import com.google.api.generator.gapic.model.Message;
 import com.google.api.generator.gapic.model.Method;
 import com.google.api.generator.gapic.model.Service;
 import com.google.common.annotations.VisibleForTesting;
 import com.google.common.base.Preconditions;
 import com.google.common.collect.Maps;
+import com.google.longrunning.OperationInfo;
+import com.google.longrunning.OperationsProto;
 import com.google.protobuf.DescriptorProtos.FileDescriptorProto;
+import com.google.protobuf.DescriptorProtos.MethodOptions;
 import com.google.protobuf.Descriptors.Descriptor;
 import com.google.protobuf.Descriptors.DescriptorValidationException;
 import com.google.protobuf.Descriptors.FileDescriptor;
+import com.google.protobuf.Descriptors.MethodDescriptor;
 import com.google.protobuf.Descriptors.ServiceDescriptor;
 import com.google.protobuf.compiler.PluginProtos.CodeGeneratorRequest;
 import java.util.ArrayList;
@@ -115,10 +120,33 @@ static List<Method> parseMethods(
                     .setInputType(TypeParser.parseType(md.getInputType()))
                     .setOutputType(TypeParser.parseType(md.getOutputType()))
                     .setStream(Method.toStream(md.isClientStreaming(), md.isServerStreaming()))
+                    .setLro(parseLro(md, messageTypes))
                     .build())
         .collect(Collectors.toList());
   }
 
+  @VisibleForTesting
+  static LongrunningOperation parseLro(
+      MethodDescriptor methodDescriptor, Map<String, Message> messageTypes) {
+    MethodOptions methodOptions = methodDescriptor.getOptions();
+    if (!methodOptions.hasExtension(OperationsProto.operationInfo)) {
+      return null;
+    }
+
+    OperationInfo lroInfo =
+        methodDescriptor.getOptions().getExtension(OperationsProto.operationInfo);
+    String responseTypeName = lroInfo.getResponseType();
+    String metadataTypeName = lroInfo.getMetadataType();
+    Message responseMessage = messageTypes.get(responseTypeName);
+    Message metadataMessage = messageTypes.get(metadataTypeName);
+    Preconditions.checkNotNull(
+        responseMessage, String.format("LRO response message %s not found", responseTypeName));
+    Preconditions.checkNotNull(
+        metadataMessage, String.format("LRO metadata message %s not found", metadataTypeName));
+
+    return LongrunningOperation.withTypes(responseMessage.type(), metadataMessage.type());
+  }
+
   private static List<Field> parseFields(Descriptor messageDescriptor) {
     return messageDescriptor.getFields().stream()
         .map(f -> Field.builder().setName(f.getName()).setType(TypeParser.parseType(f)).build())

src/test/java/com/google/api/generator/gapic/protoparser/ParserTest.java

@@ -16,13 +16,16 @@
 
 import static com.google.common.truth.Truth.assertThat;
 import static junit.framework.Assert.assertEquals;
+import static junit.framework.Assert.assertTrue;
+import static org.junit.Assert.assertThrows;
 
 import com.google.api.generator.engine.ast.TypeNode;
 import com.google.api.generator.engine.ast.VaporReference;
 import com.google.api.generator.gapic.model.Field;
 import com.google.api.generator.gapic.model.Message;
 import com.google.api.generator.gapic.model.Method;
 import com.google.protobuf.Descriptors.FileDescriptor;
+import com.google.protobuf.Descriptors.MethodDescriptor;
 import com.google.protobuf.Descriptors.ServiceDescriptor;
 import com.google.showcase.v1beta1.EchoOuterClass;
 import java.util.Arrays;
@@ -102,4 +105,38 @@ public void parseMethods_basic() {
     assertEquals(chatMethod.name(), "Chat");
     assertEquals(chatMethod.stream(), Method.Stream.BIDI);
   }
+
+  @Test
+  public void parseMethods_basicLro() {
+    Map<String, Message> messageTypes = Parser.parseMessages(echoFileDescriptor);
+    List<Method> methods = Parser.parseMethods(echoService, messageTypes);
+    assertThat(methods.size()).isEqualTo(7);
+
+    // Methods should appear in the same order as in the protobuf file.
+    Method waitMethod = methods.get(5);
+    assertEquals(waitMethod.name(), "Wait");
+    assertTrue(waitMethod.hasLro());
+    TypeNode waitResponseType = messageTypes.get("WaitResponse").type();
+    TypeNode waitMetadataType = messageTypes.get("WaitMetadata").type();
+    assertThat(waitMethod.lro().responseType()).isEqualTo(waitResponseType);
+    assertThat(waitMethod.lro().metadataType()).isEqualTo(waitMetadataType);
+  }
+
+  @Test
+  public void parseMethods_lroMissingResponseType() {
+    Map<String, Message> messageTypes = Parser.parseMessages(echoFileDescriptor);
+    MethodDescriptor waitMethodDescriptor = echoService.getMethods().get(5);
+    messageTypes.remove("WaitResponse");
+    assertThrows(
+        NullPointerException.class, () -> Parser.parseLro(waitMethodDescriptor, messageTypes));
+  }
+
+  @Test
+  public void parseMethods_lroMissingMetadataType() {
+    Map<String, Message> messageTypes = Parser.parseMessages(echoFileDescriptor);
+    MethodDescriptor waitMethodDescriptor = echoService.getMethods().get(5);
+    messageTypes.remove("WaitMetadata");
+    assertThrows(
+        NullPointerException.class, () -> Parser.parseLro(waitMethodDescriptor, messageTypes));
+  }
 }