-
Notifications
You must be signed in to change notification settings - Fork 1.1k
chore(bqjdbc): enhance exception messages to include chained exception message #12996
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
d289988
chore(bqjdbc): ehance exception messages to include chained exception…
logachev de534f3
Merge branch 'main' into kirl/ehanced_exception_message
logachev 604828c
lint
logachev 371f317
feedback
logachev 5ec73d4
Merge branch 'main' into kirl/ehanced_exception_message
logachev File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 hidden or 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
40 changes: 40 additions & 0 deletions
40
...ry-jdbc/src/main/java/com/google/cloud/bigquery/exception/BigQueryJdbcExceptionUtils.java
This file contains hidden or 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,40 @@ | ||
| /* | ||
| * Copyright 2026 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.cloud.bigquery.exception; | ||
|
|
||
| /** Utility class for JDBC exceptions. */ | ||
| final class BigQueryJdbcExceptionUtils { | ||
|
|
||
| private BigQueryJdbcExceptionUtils() { | ||
| // Utility class, prevent instantiation | ||
| } | ||
|
|
||
| /** | ||
| * Formats the exception message by appending the cause's message (or toString if null) on a | ||
| * newline. | ||
| * | ||
| * @param message The custom detail message. | ||
| * @param cause The underlying cause of the exception. | ||
| * @return The formatted message. | ||
| */ | ||
| public static String formatMessage(String message, Throwable cause) { | ||
| return message | ||
| + (cause != null | ||
| ? "\n" + (cause.getMessage() != null ? cause.getMessage() : cause.toString()) | ||
| : ""); | ||
| } | ||
|
logachev marked this conversation as resolved.
|
||
| } | ||
This file contains hidden or 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 hidden or 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
78 changes: 78 additions & 0 deletions
78
...ery-jdbc/src/test/java/com/google/cloud/bigquery/exception/BigQueryJdbcExceptionTest.java
This file contains hidden or 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,78 @@ | ||
| /* | ||
| * Copyright 2026 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.cloud.bigquery.exception; | ||
|
|
||
| import static org.junit.jupiter.api.Assertions.assertEquals; | ||
|
|
||
| import com.google.cloud.bigquery.BigQueryException; | ||
| import java.util.stream.Stream; | ||
| import org.junit.jupiter.api.Test; | ||
| import org.junit.jupiter.params.ParameterizedTest; | ||
| import org.junit.jupiter.params.provider.Arguments; | ||
| import org.junit.jupiter.params.provider.MethodSource; | ||
|
|
||
| public class BigQueryJdbcExceptionTest { | ||
|
|
||
| @FunctionalInterface | ||
| interface ExceptionCreator { | ||
| Throwable create(String message, Throwable cause); | ||
| } | ||
|
|
||
| static Stream<Arguments> exceptionProvider() { | ||
| return Stream.of( | ||
| Arguments.of( | ||
| (ExceptionCreator) | ||
| (msg, cause) -> new BigQueryJdbcException(msg, (BigQueryException) cause)), | ||
| Arguments.of((ExceptionCreator) BigQueryJdbcException::new), | ||
| Arguments.of((ExceptionCreator) BigQueryJdbcRuntimeException::new), | ||
| Arguments.of((ExceptionCreator) BigQueryConversionException::new), | ||
| Arguments.of( | ||
| (ExceptionCreator) | ||
| (msg, cause) -> new BigQueryJdbcCoercionException((Exception) cause)), | ||
| Arguments.of( | ||
| (ExceptionCreator) | ||
| (msg, cause) -> | ||
| new BigQueryJdbcSqlSyntaxErrorException(msg, (BigQueryException) cause))); | ||
| } | ||
|
|
||
| @ParameterizedTest | ||
| @MethodSource("exceptionProvider") | ||
| public void testExceptionMessageFormatting(ExceptionCreator creator) { | ||
| String message = "Custom error message"; | ||
| Throwable cause = new BigQueryException(500, "Underlying error"); | ||
|
|
||
| Throwable ex = creator.create(message, cause); | ||
|
|
||
| String expectedPrefix = | ||
| ex instanceof BigQueryJdbcCoercionException ? "Coercion error" : message; | ||
| String expectedMessage = expectedPrefix + "\n" + cause.getMessage(); | ||
|
logachev marked this conversation as resolved.
|
||
|
|
||
| assertEquals(expectedMessage, ex.getMessage()); | ||
| assertEquals(cause, ex.getCause()); | ||
| } | ||
|
|
||
| @Test | ||
| public void testException_withCauseHavingNullMessage() { | ||
| String message = "Custom error message"; | ||
| Throwable cause = new RuntimeException(); // Null message | ||
|
|
||
| BigQueryJdbcException ex = new BigQueryJdbcException(message, cause); | ||
|
|
||
| String expectedMessage = message + "\n" + cause.toString(); | ||
| assertEquals(expectedMessage, ex.getMessage()); | ||
| } | ||
| } | ||
This file contains hidden or 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
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: My latest PR removes the severe logs from the exception classes. You can leave these unedited, it will be removed later.