[PLUGIN-1807] Implement Program Failure Exception Handling in GCS sink plugins to catch known errors #1445
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,157 @@ | ||
| /* | ||
| * Copyright © 2024 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 io.cdap.cdap.api.exception.ErrorCategory; | ||
| import io.cdap.cdap.api.exception.ErrorCategory.ErrorCategoryEnum; | ||
| import io.cdap.cdap.api.exception.ErrorUtils; | ||
| import io.cdap.cdap.api.exception.ProgramFailureException; | ||
| import java.io.IOException; | ||
|
|
||
| /** | ||
| * Utility class to handle exceptions. | ||
| */ | ||
| public class ExceptionUtils { | ||
|
|
||
| /** Functional interfaces for lambda-friendly method invocations */ | ||
| @FunctionalInterface | ||
| public interface IOOperation { | ||
| void execute() throws IOException; | ||
| } | ||
|
|
||
| /** | ||
| * Functional interfaces for lambda-friendly method invocations. | ||
| * | ||
| * @param <T> the return type of the function | ||
| */ | ||
| @FunctionalInterface | ||
| public interface IOFunction<T> { | ||
| T execute() throws IOException; | ||
| } | ||
|
|
||
| /** Functional interfaces for lambda-friendly method invocations */ | ||
| @FunctionalInterface | ||
| public interface IOInterruptibleOperation { | ||
| void execute() throws IOException, InterruptedException; | ||
| } | ||
|
|
||
| /** | ||
| * Functional interfaces for lambda-friendly method invocations. | ||
| * | ||
| * @param <T> the return type of the function | ||
| */ | ||
| @FunctionalInterface | ||
| public interface IOInterruptibleFunction<T> { | ||
|
|
||
| T execute () throws IOException, InterruptedException; | ||
| } | ||
|
|
||
| // Generic helper method to handle IOException propagation | ||
| public static void invokeWithProgramFailureHandling(IOOperation operation) throws IOException { | ||
| try { | ||
| operation.execute(); | ||
| } catch (IOException e) { | ||
| ProgramFailureException exception = getProgramFailureException(e); | ||
| if (exception != null) { | ||
| throw exception; | ||
| } | ||
| throw e; | ||
| } | ||
| } | ||
|
|
||
| // Helper method for returning values (for methods like {@link OutputCommitter#needsTaskCommit}) | ||
| public static <T> T invokeWithProgramFailureHandling(IOFunction<T> function) throws IOException { | ||
| try { | ||
| return function.execute(); | ||
| } catch (IOException e) { | ||
| ProgramFailureException exception = getProgramFailureException(e); | ||
| if (exception != null) { | ||
| throw exception; | ||
| } | ||
| throw e; | ||
| } | ||
| } | ||
|
|
||
| // Helper method for handling both IOException and InterruptedException | ||
| public static void invokeWithProgramFailureAndInterruptionHandling( | ||
|
There was a problem hiding this comment. You may be able to go with less boilerplate by using generic exceptions: https://www.mscharhag.com/java/java-exceptions-and-generic-types |
||
| IOInterruptibleOperation operation) throws IOException, InterruptedException { | ||
| try { | ||
| operation.execute(); | ||
| } catch (IOException e) { | ||
| ProgramFailureException exception = getProgramFailureException(e); | ||
| if (exception != null) { | ||
| throw exception; | ||
| } | ||
| throw e; | ||
| } | ||
| } | ||
|
|
||
| // Helper method for handling both IOException and InterruptedException | ||
| public static <T> T invokeWithProgramFailureAndInterruptionHandling( | ||
| IOInterruptibleFunction<T> function) throws IOException, InterruptedException { | ||
| try { | ||
| return function.execute(); | ||
| } catch (IOException e) { | ||
| ProgramFailureException exception = getProgramFailureException(e); | ||
| if (exception != null) { | ||
| throw exception; | ||
| } | ||
| throw e; | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * 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. | ||
| */ | ||
| private static ProgramFailureException getProgramFailureException(HttpResponseException e) { | ||
| 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(); | ||
| if (e instanceof GoogleJsonResponseException) { | ||
| GoogleJsonResponseException exception = (GoogleJsonResponseException) e; | ||
| errorMessage = exception.getDetails() != null ? exception.getDetails().getMessage() : | ||
| exception.getMessage(); | ||
| } | ||
|
|
||
| return ErrorUtils.getProgramFailureException(new ErrorCategory(ErrorCategoryEnum.PLUGIN), | ||
| errorReason, errorMessage, pair.getErrorType(), true, e); | ||
| } | ||
|
|
||
| /** | ||
| * Get a ProgramFailureException with the given error | ||
| * information from {@link IOException}. | ||
| * | ||
| * @param e The IOException to get the error information from. | ||
| * @return A ProgramFailureException with the given error information, otherwise null. | ||
| */ | ||
| private static ProgramFailureException getProgramFailureException(IOException e) { | ||
| Throwable target = e instanceof HttpResponseException ? e : e.getCause(); | ||
| if (target instanceof HttpResponseException) { | ||
| return getProgramFailureException((HttpResponseException) target); | ||
| } | ||
| return null; | ||
| } | ||
| } | ||
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
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
Oops, something went wrong.
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: Consider using Callable / Runnable instead of Function / Operation. This terms are more used in Java