feat!: Improves error handling.

In particular includes more information on GoogleApiException.Message when possible.

Closes #8206

BREAKING CHANGE: If calling code depended on exact exception message.

Author: amanda-tarafa

apis/Google.Cloud.BigQuery.V2/Google.Cloud.BigQuery.V2.IntegrationTests/InsertTest.cs

@@ -147,6 +147,30 @@ public void InsertRow_BadData_Throws(InsertOptions options, int[] errorRowsIndex
             }
         }
 
+        [Fact]
+        public void InsertRow_Single_Throws()
+        {
+            var client = BigQueryClient.Create(_fixture.ProjectId);
+            var dataset = client.GetDataset(_fixture.DatasetId);
+            // Don't insert into a table used by other tests...
+            var table = dataset.CreateTable(
+                _fixture.CreateTableId(),
+                new TableSchemaBuilder { { "year", BigQueryDbType.Int64 } }.Build());
+            var row = new BigQueryInsertRow { { "noSuchField", 10 } };
+
+            var exception = Assert.Throws<GoogleApiException>(() => table.InsertRow(row));
+
+            Assert.Equal(
+                "The service bigquery has thrown an exception. " +
+                "No HttpStatusCode was specified. " +
+                "Error inserting data: 1 error(s). " +
+                "Status: NoRowsInserted. " +
+                "First error message: Error in row 0. no such field: noSuchField.",
+                exception.Message);
+            Assert.Equal(1, exception.Error.Errors.Count);
+            Assert.Contains(exception.Error.Errors, e => e.Message.ToLower().Contains($"in row 0"));
+        }
+
         public static IEnumerable<object[]> BadDataSilentOptions
         {
             get

apis/Google.Cloud.BigQuery.V2/Google.Cloud.BigQuery.V2/BigQueryInsertResults.cs

@@ -94,6 +94,7 @@ public BigQueryInsertResults(BigQueryClient client, InsertOptions options, IRead
             int originalRowsWithErrors = 0;
             _errors = errorsByRow
                 .Select(rowErrors => new BigQueryInsertRowErrors(GetRow(rowErrors.Key), rowErrors.ToList().AsReadOnly()))
+                .OrderBy(rowErrors => rowErrors.OriginalRowIndex ?? long.MaxValue)
                 .ToList().AsReadOnly();
 
             OriginalRowsWithErrors = originalRowsWithErrors;
@@ -125,7 +126,7 @@ public BigQueryInsertResults ThrowOnNoneInserted() =>
 
         /// <summary>
         /// Throws <see cref="GoogleApiException"/> if there were insert errors.
-        /// The excetpion will contain details of these errors.
+        /// The exception will contain details of these errors.
         /// </summary>
         /// <exception cref="GoogleApiException">There were insert errors.</exception>
         public BigQueryInsertResults ThrowOnAnyError()
@@ -135,14 +136,17 @@ public BigQueryInsertResults ThrowOnAnyError()
                 return this;
             }
 
-            var exception = new GoogleApiException(_client.Service.Name, $"Error inserting data. Status: {Status}")
+            var flattenedErrors = Errors.SelectMany(rowErrors => rowErrors).ToList();
+            throw new GoogleApiException(_client.Service.Name)
             {
                 Error = new RequestError
                 {
-                    Errors = Errors.SelectMany(rowErrors => rowErrors).ToList()
+                    Errors = flattenedErrors,
+                    Message = $"Error inserting data: {flattenedErrors.Count} error(s). " +
+                        $"Status: {Status}. " +
+                        $"First error message: { flattenedErrors.First().Message }"
                 }
             };
-            throw exception;
         }
 
         internal BigQueryInsertResults ThrowIfNotSuppressing(bool? suppressInsertErrors) =>

apis/Google.Cloud.BigQuery.V2/Google.Cloud.BigQuery.V2/BigQueryJob.cs

@@ -107,17 +107,18 @@ public BigQueryJob ThrowOnAnyError()
             var errors = Resource.Status?.Errors;
             if (errors?.Count > 0)
             {
-                throw new GoogleApiException(_client.Service.Name, $"Job {Reference?.ProjectId}/{Reference?.Location}/{Reference?.JobId} contained errors")
+                throw new GoogleApiException(_client.Service.Name)
                 {
                     Error = new RequestError
                     {
                         Errors = errors.Select(error => new SingleError
-                            {
-                                Location = error.Location,
-                                Reason = error.Reason,
-                                Message = error.Message
-                            })
-                            .ToList()
+                        {
+                            Location = error.Location,
+                            Reason = error.Reason,
+                            Message = error.Message
+                        }).ToList(),
+                        Message = $"Job {Reference?.ProjectId}/{Reference?.Location}/{Reference?.JobId} contained {errors.Count} error(s). " +
+                            $"First error message: {errors.First().Message}"
                     }
                 };
             }

apis/Google.Cloud.BigQuery.V2/Google.Cloud.BigQuery.V2/BigQueryResults.cs

@@ -216,7 +216,7 @@ public BigQueryResults ThrowOnAnyError()
             var errors = _response.Errors;
             if (errors?.Count > 0)
             {
-                throw new GoogleApiException(_client.Service.Name, $"Job {JobReference.ProjectId}/{JobReference.Location}/{JobReference.JobId} contained errors")
+                throw new GoogleApiException(_client.Service.Name)
                 {
                     Error = new RequestError
                     {
@@ -225,8 +225,9 @@ public BigQueryResults ThrowOnAnyError()
                             Location = error.Location,
                             Reason = error.Reason,
                             Message = error.Message
-                        })
-                        .ToList()
+                        }).ToList(),
+                        Message = $"Job {JobReference.ProjectId}/{JobReference.Location}/{JobReference.JobId} contained {errors.Count} error(s). " +
+                            $"First error message: {errors.First().Message}"
                     }
                 };
             }