Enhance Error Execution Utilities: Add Retry, Timeout, Cancellation, and Advanced Error Handling #153
+112
−3
Conversation
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
…and advanced error handling This commit introduces several improvements to the error execution utilities to make them more robust and production-ready. The following changes have been implemented: 1. **Timeout and Cancellation Support**: - Updated `ErrExec` and `ErrExecWithTimeout` to support context-based cancellation and timeout. This ensures that functions can be terminated early if they take too long or if the operation is canceled. 2. **Retry Logic**: - Added a `RetryExec` function to retry failed functions a configurable number of times with delays in between retries. - Added `ErrExecWithRetry` to execute functions concurrently while automatically retrying any failed ones. 3. **Advanced Error Handling**: - Enhanced `ErrExecSequential` to accumulate errors and stop execution based on custom error types (e.g., stop on `CustomError` with a critical severity). - Introduced `CustomError` with logic to control whether execution should stop upon encountering a specific error. 4. **Logging and Monitoring**: - Added `LogExecution` to log the execution time of functions. This helps in monitoring performance and debugging execution times. These improvements make the utilities more flexible, resilient, and suitable for handling complex scenarios in production systems, such as dealing with timeouts, retries, and advanced error handling. Signed-off-by: UTSAV SINGHAL <[email protected]>
…ogic, and logging - Added timeout and cancellation support to ErrExec and ErrExecWithTimeout functions. - Introduced retry logic in RetryExec to handle temporary failures with a configurable retry count and delay. - Updated ErrExecSequential to support more flexible error accumulation and early termination on critical errors using CustomError. - Added LogExecution to track function execution time, integrated with ErrExecWithLogging for concurrent function execution. - Improved error handling for functions, allowing for retries and graceful error reporting. These changes improve the robustness and flexibility of error handling in concurrent and sequential function executions. Signed-off-by: UTSAV SINGHAL <[email protected]>
|
Hi @shubham19may @zriyanshdz ,please review this PR and update if any necessary changes required. |
|
cc - @shubham19may @hash-data |
hash-data
reviewed
Mar 18, 2025
| func ErrExec(functions ...func() error) error { | ||
| group, _ := errgroup.WithContext(context.Background()) | ||
| group, ctx := errgroup.WithContext(context.Background()) |
There was a problem hiding this comment.
this ctx is not passed to any function so no cancellation will happen.
Comment on lines
+19
to
+26
| group.Go(func() error { | ||
| select { | ||
| case <-ctx.Done(): // Check if the context is canceled or times out | ||
| return ctx.Err() | ||
| default: | ||
| return one() | ||
| } | ||
| }) |
Comment on lines
+55
to
+68
| func RetryExec(function func() error, retries int, delay time.Duration) error { | ||
| var err error | ||
| for i := 0; i <= retries; i++ { | ||
| err = function() | ||
| if err == nil { | ||
| return nil // Function succeeded | ||
| } | ||
| log.Printf("Attempt %d failed: %v", i+1, err) | ||
| time.Sleep(delay) // Wait before retrying | ||
| } | ||
|
|
||
| return fmt.Errorf("failed after %d retries: %w", retries, err) | ||
| } | ||
|
|
There was a problem hiding this comment.
already available check backoff
Comment on lines
+115
to
+146
| // CustomError represents a custom error type with an additional field to indicate if execution should stop. | ||
| type CustomError struct { | ||
| Message string | ||
| Severity string | ||
| } | ||
|
|
||
| func (e *CustomError) Error() string { | ||
| return e.Message | ||
| } | ||
|
|
||
| // ShouldStop checks if the custom error indicates that execution should be halted. | ||
| func (e *CustomError) ShouldStop() bool { | ||
| return e.Severity == "critical" // Example logic: Stop on "critical" errors | ||
| } | ||
|
|
||
| // LogExecution logs the execution of a function (can be customized as needed). | ||
| func LogExecution(functionName string, startTime time.Time) { | ||
| duration := time.Since(startTime) | ||
| log.Printf("Function '%s' executed in %v", functionName, duration) | ||
| } | ||
|
|
||
| // ErrExecWithLogging executes a list of functions concurrently and logs execution time for each. | ||
| func ErrExecWithLogging(functions ...func() error) error { | ||
| group, ctx := errgroup.WithContext(context.Background()) | ||
|
|
||
| for _, one := range functions { | ||
| group.Go(func() error { | ||
| startTime := time.Now() | ||
| defer LogExecution("Function", startTime) // Log execution after function completes | ||
| return one() | ||
| }) | ||
| } |
There was a problem hiding this comment.
dont think so it is required right now.
|
@UTSAVS26 closing this as currently its not needed. most of the changes done are not needed or already implemented as a part of other function. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR enhances the existing error execution utilities with new features such as timeout, cancellation, retry logic, and execution logging. Specifically:
ErrExecSequentialto accumulate errors and stop execution on critical errors using a custom error type.These improvements make the error handling system more robust, especially for real-world applications where failures can occur intermittently and tasks need to be managed carefully.
Fixes #130
Type of change
How Has This Been Tested?