-
Notifications
You must be signed in to change notification settings - Fork 86
[PLUGIN-1842] Error Management catch known errors [GCSBucketCreate] #1488
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
psainics
merged 1 commit into
data-integrations:develop
from
cloudsufi:fem/action/GCSBucketCreate
Jan 17, 2025
Merged
Changes from all commits
Commits
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
104 changes: 104 additions & 0 deletions
104
src/main/java/io/cdap/plugin/gcp/common/GCPErrorDetailsProviderUtil.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,104 @@ | ||
| /* | ||
| * Copyright © 2025 Cask Data, Inc. | ||
| * | ||
| * 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 io.cdap.plugin.gcp.common; | ||
|
|
||
|
|
||
| import com.google.api.client.googleapis.json.GoogleJsonResponseException; | ||
| import com.google.api.client.http.HttpResponseException; | ||
| import com.google.common.base.Strings; | ||
| import com.google.common.base.Throwables; | ||
| import io.cdap.cdap.api.exception.ErrorCategory; | ||
| import io.cdap.cdap.api.exception.ErrorCodeType; | ||
| import io.cdap.cdap.api.exception.ErrorType; | ||
| import io.cdap.cdap.api.exception.ErrorUtils; | ||
| import io.cdap.cdap.api.exception.ProgramFailureException; | ||
| import io.cdap.cdap.etl.api.exception.ErrorContext; | ||
|
|
||
| import java.io.IOException; | ||
| import java.util.List; | ||
| import javax.annotation.Nullable; | ||
|
|
||
| /** | ||
| * Common functions for GCP error details provider related functionalities. | ||
| */ | ||
| public final class GCPErrorDetailsProviderUtil { | ||
|
|
||
| /** | ||
| * Get a ProgramFailureException with the given error | ||
| * information from {@link HttpResponseException}. | ||
| * | ||
| * @param e The HttpResponseException to get the error information from. | ||
| * @return A ProgramFailureException with the given error information. | ||
| */ | ||
| public static ProgramFailureException getProgramFailureException(HttpResponseException e, String externalDocUrl, | ||
| @Nullable ErrorContext errorContext) { | ||
| Integer statusCode = e.getStatusCode(); | ||
| ErrorUtils.ActionErrorPair pair = ErrorUtils.getActionErrorByStatusCode(statusCode); | ||
| String errorReason = String.format("%s %s. %s", e.getStatusCode(), e.getStatusMessage(), | ||
| pair.getCorrectiveAction()); | ||
| String errorMessage = e.getMessage(); | ||
| String externalDocumentationLink = null; | ||
| if (e instanceof GoogleJsonResponseException) { | ||
| errorMessage = getErrorMessage((GoogleJsonResponseException) e); | ||
| externalDocumentationLink = externalDocUrl; | ||
| if (!Strings.isNullOrEmpty(externalDocumentationLink)) { | ||
| if (!errorReason.endsWith(".")) { | ||
| errorReason = errorReason + "."; | ||
| } | ||
| errorReason = String.format("%s For more details, see %s", errorReason, externalDocumentationLink); | ||
| } | ||
| } | ||
| return ErrorUtils.getProgramFailureException(new ErrorCategory(ErrorCategory.ErrorCategoryEnum.PLUGIN), errorReason, | ||
| errorContext != null ? | ||
| String.format(GCPErrorDetailsProvider.ERROR_MESSAGE_FORMAT, errorContext.getPhase(), e.getClass().getName(), | ||
| errorMessage) : String.format("%s: %s", e.getClass().getName(), errorMessage), pair.getErrorType(), true, | ||
| ErrorCodeType.HTTP, statusCode.toString(), externalDocumentationLink, e); | ||
| } | ||
|
|
||
| public static ProgramFailureException getHttpResponseExceptionDetailsFromChain(Exception e, String errorReason, | ||
itsankit-google marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| ErrorType errorType, | ||
| boolean dependency, | ||
| String externalDocUrl) { | ||
| List<Throwable> causalChain = Throwables.getCausalChain(e); | ||
| for (Throwable t : causalChain) { | ||
| if (t instanceof ProgramFailureException) { | ||
| // Avoid double wrap | ||
| return (ProgramFailureException) t; | ||
| } | ||
| if (t instanceof HttpResponseException) { | ||
| return getProgramFailureException((HttpResponseException) t, externalDocUrl, null); | ||
| } | ||
| } | ||
| // If no HttpResponseException found in the causal chain, return generic program failure exception | ||
| return ErrorUtils.getProgramFailureException(new ErrorCategory(ErrorCategory.ErrorCategoryEnum.PLUGIN), errorReason, | ||
| String.format("%s %s: %s", errorReason, e.getClass().getName(), e.getMessage()), errorType, dependency, e); | ||
| } | ||
|
|
||
| private static String getErrorMessage(GoogleJsonResponseException exception) { | ||
| if (!Strings.isNullOrEmpty(exception.getMessage())) { | ||
| return exception.getMessage(); | ||
| } | ||
| if (exception.getDetails() != null) { | ||
| try { | ||
| return exception.getDetails().toPrettyString(); | ||
| } catch (IOException e) { | ||
| return exception.getDetails().toString(); | ||
| } | ||
| } | ||
| return exception.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.
Uh oh!
There was an error while loading. Please reload this page.