Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: add support for StorageError (#1391)
* feat: add support for StorageError * 🦉 Updates from OwlBot See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * add license header * add error parsing in doneCallback * address feedback * add test case for onDone * 🦉 Updates from OwlBot See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * refactor code * lint * 🦉 Updates from OwlBot See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * apply changes from code review Co-authored-by: BenWhitehead <BenWhitehead@users.noreply.github.com> * add integration test for onDoneCallback * make error check more vigorous Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com> Co-authored-by: BenWhitehead <BenWhitehead@users.noreply.github.com>
- Loading branch information
3 people
committed
Nov 15, 2021
1 parent
38f5eb9
commit 176dc8b
Showing
4 changed files
with
327 additions
and
5 deletions.
There are no files selected for viewing
149 changes: 149 additions & 0 deletions
149
...-cloud-bigquerystorage/src/main/java/com/google/cloud/bigquery/storage/v1/Exceptions.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,149 @@ | ||
| /* | ||
| * Copyright 2021 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 | ||
| * | ||
| * https://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.cloud.bigquery.storage.v1; | ||
|
|
||
| import com.google.api.gax.grpc.GrpcStatusCode; | ||
| import com.google.common.collect.ImmutableMap; | ||
| import com.google.protobuf.Any; | ||
| import com.google.protobuf.InvalidProtocolBufferException; | ||
| import io.grpc.Status; | ||
| import io.grpc.Status.Code; | ||
| import java.util.regex.Matcher; | ||
| import java.util.regex.Pattern; | ||
| import javax.annotation.Nullable; | ||
|
|
||
| /** Exceptions for Storage Client Libraries. */ | ||
| public final class Exceptions { | ||
| /** Main Storage Exception. Might contain map of streams to errors for that stream. */ | ||
| public static class StorageException extends RuntimeException { | ||
|
|
||
| private final ImmutableMap<String, GrpcStatusCode> errors; | ||
| private final String streamName; | ||
|
|
||
| private StorageException() { | ||
| this(null, null, null, ImmutableMap.of()); | ||
| } | ||
|
|
||
| private StorageException( | ||
| @Nullable String message, | ||
| @Nullable Throwable cause, | ||
| @Nullable String streamName, | ||
| ImmutableMap<String, GrpcStatusCode> errors) { | ||
| super(message, cause); | ||
| this.streamName = streamName; | ||
| this.errors = errors; | ||
| } | ||
|
|
||
| public ImmutableMap<String, GrpcStatusCode> getErrors() { | ||
| return errors; | ||
| } | ||
|
|
||
| public String getStreamName() { | ||
| return streamName; | ||
| } | ||
| } | ||
|
|
||
| /** Stream has already been finalized. */ | ||
| public static final class StreamFinalizedException extends StorageException { | ||
| protected StreamFinalizedException(String name, String message, Throwable cause) { | ||
| super(message, cause, name, ImmutableMap.of()); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * There was a schema mismatch due to bigquery table with fewer fields than the input message. | ||
| * This can be resolved by updating the table's schema with the message schema. | ||
| */ | ||
| public static final class SchemaMismatchedException extends StorageException { | ||
| protected SchemaMismatchedException(String name, String message, Throwable cause) { | ||
| super(message, cause, name, ImmutableMap.of()); | ||
| } | ||
| } | ||
|
|
||
| private static StorageError toStorageError(com.google.rpc.Status rpcStatus) { | ||
| for (Any detail : rpcStatus.getDetailsList()) { | ||
| if (detail.is(StorageError.class)) { | ||
| try { | ||
| return detail.unpack(StorageError.class); | ||
| } catch (InvalidProtocolBufferException protoException) { | ||
| throw new IllegalStateException(protoException); | ||
| } | ||
| } | ||
| } | ||
| return null; | ||
| } | ||
|
|
||
| /** | ||
| * Converts a c.g.rpc.Status into a StorageException, if possible. Examines the embedded | ||
| * StorageError, and potentially returns a {@link StreamFinalizedException} or {@link | ||
| * SchemaMismatchedException} (both derive from StorageException). If there is no StorageError, or | ||
| * the StorageError is a different error it will return NULL. | ||
| */ | ||
| @Nullable | ||
| public static StorageException toStorageException( | ||
| com.google.rpc.Status rpcStatus, Throwable exception) { | ||
| StorageError error = toStorageError(rpcStatus); | ||
| if (error == null) { | ||
| return null; | ||
| } | ||
| switch (error.getCode()) { | ||
| case STREAM_FINALIZED: | ||
| return new StreamFinalizedException(error.getEntity(), error.getErrorMessage(), exception); | ||
|
|
||
| case SCHEMA_MISMATCH_EXTRA_FIELDS: | ||
| return new SchemaMismatchedException(error.getEntity(), error.getErrorMessage(), exception); | ||
|
|
||
| default: | ||
| return null; | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Converts a Throwable into a StorageException, if possible. Examines the embedded error message, | ||
| * and potentially returns a {@link StreamFinalizedException} or {@link SchemaMismatchedException} | ||
| * (both derive from StorageException). If there is no StorageError, or the StorageError is a | ||
| * different error it will return NULL. | ||
| */ | ||
| @Nullable | ||
| public static StorageException toStorageException(Throwable exception) { | ||
| // TODO: switch to using rpcStatus when cl/408735437 is rolled out | ||
| // com.google.rpc.Status rpcStatus = StatusProto.fromThrowable(exception); | ||
| Status grpcStatus = Status.fromThrowable(exception); | ||
| String message = exception.getMessage(); | ||
| String streamPatternString = "projects/[^/]+/datasets/[^/]+/tables/[^/]+/streams/[^/]+"; | ||
| Pattern streamPattern = Pattern.compile(streamPatternString); | ||
| if (message == null) { | ||
| return null; | ||
| } | ||
| // TODO: SWTICH TO CHECK SCHEMA_MISMATCH_EXTRA_FIELDS IN THE ERROR CODE | ||
| if (grpcStatus.getCode().equals(Code.INVALID_ARGUMENT) | ||
| && message.toLowerCase().contains("input schema has more fields than bigquery schema")) { | ||
| Matcher streamMatcher = streamPattern.matcher(message); | ||
| String entity = streamMatcher.find() ? streamMatcher.group() : "streamName unkown"; | ||
| return new SchemaMismatchedException(entity, message, exception); | ||
| } | ||
| // TODO: SWTICH TO CHECK STREAM_FINALIZED IN THE ERROR CODE | ||
| if (grpcStatus.getCode().equals(Code.INVALID_ARGUMENT) | ||
| && message.toLowerCase().contains("stream has been finalized and cannot be appended")) { | ||
| Matcher streamMatcher = streamPattern.matcher(message); | ||
| String entity = streamMatcher.find() ? streamMatcher.group() : "streamName unkown"; | ||
| return new StreamFinalizedException(entity, message, exception); | ||
| } | ||
| return null; | ||
| } | ||
|
|
||
| private Exceptions() {} | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters