[release/7.0] Add default error response to gRPC transcoding

src/Grpc/JsonTranscoding/src/Microsoft.AspNetCore.Grpc.JsonTranscoding/Internal/JsonRequestHelpers.cs

@@ -10,7 +10,6 @@
 using Google.Protobuf;
 using Google.Protobuf.Reflection;
 using Grpc.Core;
-using Grpc.Gateway.Runtime;
 using Grpc.Shared;
 using Microsoft.AspNetCore.Grpc.JsonTranscoding.Internal.Json;
 using Microsoft.AspNetCore.Http;
@@ -96,9 +95,8 @@ public static async ValueTask SendErrorResponse(HttpResponse response, Encoding
             response.ContentType = MediaType.ReplaceEncoding("application/json", encoding);
         }
 
-        var e = new Error
+        var e = new Google.Rpc.Status
         {
-            Error_ = status.Detail,
             Message = status.Detail,
             Code = (int)status.StatusCode
         };

src/Grpc/JsonTranscoding/src/Microsoft.AspNetCore.Grpc.JsonTranscoding/Microsoft.AspNetCore.Grpc.JsonTranscoding.csproj

@@ -1,4 +1,4 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
     <Description>HTTP API for gRPC ASP.NET Core</Description>
     <PackageTags>gRPC RPC HTTP/2 REST</PackageTags>
@@ -27,11 +27,8 @@
     <Compile Include="..\Shared\HttpRoutePatternParser.cs" Link="Internal\Shared\HttpRoutePatternParser.cs" />
     <Compile Include="$(SharedSourceRoot)ValueTaskExtensions\**\*.cs" LinkBase="Internal\Shared" />
 
-    <Protobuf Include="Internal\Protos\errors.proto" Access="Internal" />
-
     <Reference Include="Google.Api.CommonProtos" />
     <Reference Include="Google.Protobuf" />
     <Reference Include="Grpc.AspNetCore.Server" />
-    <Reference Include="Grpc.Tools" PrivateAssets="All" />
   </ItemGroup>
 </Project>

src/Grpc/JsonTranscoding/src/Microsoft.AspNetCore.Grpc.Swagger/Internal/GrpcJsonTranscodingDescriptionProvider.cs

@@ -65,7 +65,7 @@ private static ApiDescription CreateApiDescription(RouteEndpoint routeEndpoint,
             {
                 // Swagger uses this to group endpoints together.
                 // Group methods together using the service name.
-                ["controller"] = methodDescriptor.Service.FullName
+                ["controller"] = methodDescriptor.Service.Name
             },
             EndpointMetadata = routeEndpoint.Metadata.ToList()
         };
@@ -77,6 +77,12 @@ private static ApiDescription CreateApiDescription(RouteEndpoint routeEndpoint,
             ModelMetadata = new GrpcModelMetadata(ModelMetadataIdentity.ForType(methodDescriptor.OutputType.ClrType)),
             StatusCode = 200
         });
+        apiDescription.SupportedResponseTypes.Add(new ApiResponseType
+        {
+            ApiResponseFormats = { new ApiResponseFormat { MediaType = "application/json" } },
+            ModelMetadata = new GrpcModelMetadata(ModelMetadataIdentity.ForType(typeof(Google.Rpc.Status))),
+            IsDefaultResponse = true
+        });
         var explorerSettings = routeEndpoint.Metadata.GetMetadata<ApiExplorerSettingsAttribute>();
         if (explorerSettings != null)
         {

src/Grpc/JsonTranscoding/src/Microsoft.AspNetCore.Grpc.Swagger/Microsoft.AspNetCore.Grpc.Swagger.csproj

@@ -1,4 +1,4 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
     <Description>Swagger for gRPC ASP.NET Core</Description>
     <PackageTags>gRPC RPC HTTP/2 REST Swagger OpenAPI</PackageTags>

src/Grpc/JsonTranscoding/test/Microsoft.AspNetCore.Grpc.JsonTranscoding.Tests/ServerStreamingServerCallHandlerTests.cs

@@ -106,7 +106,6 @@ public async Task HandleCallAsync_MessageThenError_MessageThenErrorReturned()
         var line2 = await ReadLineAsync(pipe.Reader).DefaultTimeout();
         using var responseJson2 = JsonDocument.Parse(line2!);
         Assert.Equal("Exception was thrown by handler.", responseJson2.RootElement.GetProperty("message").GetString());
-        Assert.Equal("Exception was thrown by handler.", responseJson2.RootElement.GetProperty("error").GetString());
         Assert.Equal(2, responseJson2.RootElement.GetProperty("code").GetInt32());
 
         await callTask.DefaultTimeout();
@@ -140,7 +139,6 @@ public async Task HandleCallAsync_ErrorWithDetailedErrors_DetailedErrorResponse(
         var line = await ReadLineAsync(pipe.Reader).DefaultTimeout();
         using var responseJson = JsonDocument.Parse(line!);
         Assert.Equal("Exception was thrown by handler. Exception: Exception!", responseJson.RootElement.GetProperty("message").GetString());
-        Assert.Equal("Exception was thrown by handler. Exception: Exception!", responseJson.RootElement.GetProperty("error").GetString());
         Assert.Equal(2, responseJson.RootElement.GetProperty("code").GetInt32());
 
         await callTask.DefaultTimeout();

src/Grpc/JsonTranscoding/test/Microsoft.AspNetCore.Grpc.JsonTranscoding.Tests/UnaryServerCallHandlerTests.cs

@@ -445,7 +445,6 @@ public async Task HandleCallAsync_MalformedRequestBody_BadRequestReturned(string
         httpContext.Response.Body.Seek(0, SeekOrigin.Begin);
         using var responseJson = JsonDocument.Parse(httpContext.Response.Body);
         Assert.Equal(expectedError, responseJson.RootElement.GetProperty("message").GetString());
-        Assert.Equal(expectedError, responseJson.RootElement.GetProperty("error").GetString());
         Assert.Equal((int)StatusCode.InvalidArgument, responseJson.RootElement.GetProperty("code").GetInt32());
     }
 
@@ -484,7 +483,6 @@ public async Task HandleCallAsync_MalformedRequestBody_RepeatedBody_BadRequestRe
         httpContext.Response.Body.Seek(0, SeekOrigin.Begin);
         using var responseJson = JsonDocument.Parse(httpContext.Response.Body);
         Assert.Equal(expectedError, responseJson.RootElement.GetProperty("message").GetString());
-        Assert.Equal(expectedError, responseJson.RootElement.GetProperty("error").GetString());
         Assert.Equal((int)StatusCode.InvalidArgument, responseJson.RootElement.GetProperty("code").GetInt32());
     }
 
@@ -515,7 +513,6 @@ public async Task HandleCallAsync_BadContentType_BadRequestReturned(string conte
         httpContext.Response.Body.Seek(0, SeekOrigin.Begin);
         using var responseJson = JsonDocument.Parse(httpContext.Response.Body);
         Assert.Equal(expectedError, responseJson.RootElement.GetProperty("message").GetString());
-        Assert.Equal(expectedError, responseJson.RootElement.GetProperty("error").GetString());
         Assert.Equal((int)StatusCode.InvalidArgument, responseJson.RootElement.GetProperty("code").GetInt32());
     }
 
@@ -540,7 +537,6 @@ public async Task HandleCallAsync_RpcExceptionReturned_StatusReturned()
         httpContext.Response.Body.Seek(0, SeekOrigin.Begin);
         using var responseJson = JsonDocument.Parse(httpContext.Response.Body);
         Assert.Equal("Detail!", responseJson.RootElement.GetProperty("message").GetString());
-        Assert.Equal("Detail!", responseJson.RootElement.GetProperty("error").GetString());
         Assert.Equal((int)StatusCode.Unauthenticated, responseJson.RootElement.GetProperty("code").GetInt32());
     }
 
@@ -565,7 +561,6 @@ public async Task HandleCallAsync_RpcExceptionThrown_StatusReturned()
         httpContext.Response.Body.Seek(0, SeekOrigin.Begin);
         using var responseJson = JsonDocument.Parse(httpContext.Response.Body);
         Assert.Equal("Detail!", responseJson.RootElement.GetProperty("message").GetString());
-        Assert.Equal("Detail!", responseJson.RootElement.GetProperty("error").GetString());
         Assert.Equal((int)StatusCode.Unauthenticated, responseJson.RootElement.GetProperty("code").GetInt32());
     }
 
@@ -591,7 +586,6 @@ public async Task HandleCallAsync_StatusSet_StatusReturned()
         httpContext.Response.Body.Seek(0, SeekOrigin.Begin);
         using var responseJson = JsonDocument.Parse(httpContext.Response.Body);
         Assert.Equal(@"Detail!", responseJson.RootElement.GetProperty("message").GetString());
-        Assert.Equal(@"Detail!", responseJson.RootElement.GetProperty("error").GetString());
         Assert.Equal((int)StatusCode.Unauthenticated, responseJson.RootElement.GetProperty("code").GetInt32());
     }
 
@@ -1000,7 +994,6 @@ public async Task HandleCallAsync_ExceptionThrown_StatusReturned()
         httpContext.Response.Body.Seek(0, SeekOrigin.Begin);
         using var responseJson = JsonDocument.Parse(httpContext.Response.Body);
         Assert.Equal("Exception was thrown by handler.", responseJson.RootElement.GetProperty("message").GetString());
-        Assert.Equal("Exception was thrown by handler.", responseJson.RootElement.GetProperty("error").GetString());
         Assert.Equal((int)StatusCode.Unknown, responseJson.RootElement.GetProperty("code").GetInt32());
     }
 

src/Grpc/JsonTranscoding/test/Microsoft.AspNetCore.Grpc.Swagger.Tests/GrpcSwaggerServiceExtensionsTests.cs

@@ -45,7 +45,9 @@ public void AddGrpcSwagger_GrpcServiceRegistered_ReturnSwaggerWithGrpcOperation(
         Assert.Single(swagger.Paths);
 
         var path = swagger.Paths["/v1/greeter/{name}"];
-        Assert.True(path.Operations.ContainsKey(OperationType.Get));
+        Assert.True(path.Operations.TryGetValue(OperationType.Get, out var operation));
+        Assert.Equal("Success", operation.Responses["200"].Description);
+        Assert.Equal("Error", operation.Responses["default"].Description);
     }
 
     [Fact]

src/Grpc/JsonTranscoding/test/Microsoft.AspNetCore.Grpc.Swagger.Tests/XmlComments/XmlDocumentationIntegrationTests.cs

@@ -30,7 +30,7 @@ public void ServiceDescription_ModelHasXmlDocs_UseXmlDocs()
         var swagger = GetOpenApiDocument<XmlDocServiceWithComments>();
 
         // Assert
-        Assert.Equal("xmldoc.XmlDoc", swagger.Tags[0].Name);
+        Assert.Equal("XmlDoc", swagger.Tags[0].Name);
         Assert.Equal("XmlDocServiceWithComments XML comment!", swagger.Tags[0].Description);
     }
 
@@ -41,7 +41,7 @@ public void ServiceDescription_ModelDoesntHaveXmlDocs_UseProtoDocs()
         var swagger = GetOpenApiDocument<XmlDocService>();
 
         // Assert
-        Assert.Equal("xmldoc.XmlDoc", swagger.Tags[0].Name);
+        Assert.Equal("XmlDoc", swagger.Tags[0].Name);
         Assert.Equal("XmlDoc!", swagger.Tags[0].Description);
     }