Handle google.rpc.ErrorInfo in HttpJson*Stub class

[JoeWang1127]

Followup on #2229.

The generated HttpJsonEchoStub can't handle message type: google.rpc.ErrorInfo introduced by echo.proto (version 0.29.0).
A easy integration test:

@Test
public void testEchoErrorDetails() {
  EchoErrorDetailsResponse response = httpjsonClient.echoErrorDetails(
      EchoErrorDetailsRequest
          .newBuilder()
          .setSingleDetailText("singleDetailText1774380934")
          .addAllMultiDetailText(new ArrayList<>())
          .build());
  assertThat(response.hasSingleDetail()).isEqualTo(true);
}

failed with the following error message:

Caused by: com.google.protobuf.InvalidProtocolBufferException: Cannot resolve type: type.googleapis.com/google.rpc.ErrorInfo
    at com.google.protobuf.util.JsonFormat$ParserImpl.mergeAny(JsonFormat.java:1511)

Possible solution:
Add the message type in

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

Lines 1279 to 1286 in 003b993

	for (Method method : service.methods()) {
	if (method.hasLro()) {
	TypeNode anyType = method.lro().responseType();
	anyTypes.put(anyType.reference().fullName(), anyType);
	anyType = method.lro().metadataType();
	anyTypes.put(anyType.reference().fullName(), anyType);
	}
	}

[JoeWang1127]

In the possible solution part, the types are added recursively in TypeRegistry.Builder.add() method.

However, only two types serves as the "root" of this method, WaitRequest and WaitResponse, we need to understand the reason behind this before adding ErrorInfo into the registry.

[lqiu96]

Took a look at some of the code in Gax and I believe it may be due to the ProtoOperationTransformers:

sdk-platform-java/gax-java/gax-grpc/src/main/java/com/google/api/gax/grpc/ProtoOperationTransformers.java

Lines 130 to 140 in 9d30ed9

	public PackedT apply(Any input) {
	try {
	return input == null || packedClass == null ? null : input.unpack(packedClass);
	} catch (InvalidProtocolBufferException | ClassCastException e) {
	throw new IllegalStateException(
	"Failed to unpack object from 'any' field. Expected "
	+ packedClass.getName()
	+ ", found "
	+ input.getTypeUrl());
	}
	}

ServiceStubSettings transforms it from Any to the classes:

sdk-platform-java/showcase/gapic-showcase/src/main/java/com/google/showcase/v1beta1/stub/EchoStubSettings.java

Lines 792 to 795 in 9d30ed9

	.setResponseTransformer(
	ProtoOperationTransformers.ResponseTransformer.create(WaitResponse.class))
	.setMetadataTransformer(
	ProtoOperationTransformers.MetadataTransformer.create(WaitMetadata.class))

I believe conversion from Any -> Class would require a TypeRegistry.

[blakeli0]

I'm afraid this issue is more complicated than we expected. The new Showcase feature tests that we can deserialize an Any field to a concrete field in ErrorInfo, which is only used by the Error Details feature, and it was deferred last year. See b/260671246 for details. In short, we can not support this test for HttpJson stubs until Error Details feature is implemented for REGAPIC.

In the mean time, I think it's still worth it to add a showcase test for gRPC.

[diegomarquezp]

we can not support this test for HttpJson stubs until Error Details feature is implemented for REGAPIC

I'll be demoting this to p3

[blakeli0]

Verified that adding ErrorInfo to the type registry should fix this issue, see #3093. However, we need to figure out where exact to add the additional types, either in Gax or generated layers.

Theoretically this issue can be tackled individually, but it will likely be resolved if the actionable ErrorDetails project is implemented for httpjson. Hence keeping this as a P3.

[baeminbo]

I reported a related issue at googleapis/java-spanner#3640. That issue is about a failure in parsing error status during server streaming calls. It has two underlying problems:

1. HttpJsonClientCallImpl.consumeMessageFromStream() uses the TypeRegistry from HttpJsonCallOptions, ignoring the default registry in ProtoMessageResponseParser. If the TypeRegistry is null in HttpJsonCallOptions, a NullPointerException is thrown.
2. DebugInfo is not added in TypeRegistry for HttpJson*Stub (this issue discussed here). This causes InvalidProtocolBufferException with "Cannot resolve type: type.googleapis.com/google.rpc.DebugInfo" even if the NPE issue is fixed.