-
Notifications
You must be signed in to change notification settings - Fork 19
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Fix transform crash for empty hydrate items. Fix plugin and table lev…
…el error handling defaults. Respect retry config in DefaultGetConfig. Closes #325 If a hydrate function fails, instead of passing an empty struct to transform functions (which could cause casting errors), do not call the transform function at all.
- Loading branch information
1 parent
6ddc378
commit 348c461
Showing
16 changed files
with
319 additions
and
181 deletions.
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,61 +1 @@ | ||
| package plugin | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
| "log" | ||
| "time" | ||
|
|
||
| "github.com/sethvargo/go-retry" | ||
| "github.com/turbot/go-kit/helpers" | ||
| "google.golang.org/grpc/codes" | ||
| "google.golang.org/grpc/status" | ||
| ) | ||
|
|
||
| // RetryHydrate function invokes the hydrate function with retryable errors and retries the function until the maximum attemptes before throwing error | ||
| func RetryHydrate(ctx context.Context, d *QueryData, hydrateData *HydrateData, hydrateFunc HydrateFunc, retryConfig *RetryConfig) (interface{}, error) { | ||
| backoff, err := retry.NewFibonacci(100 * time.Millisecond) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| var hydrateResult interface{} | ||
| shouldRetryErrorFunc := retryConfig.ShouldRetryError | ||
|
|
||
| err = retry.Do(ctx, retry.WithMaxRetries(10, backoff), func(ctx context.Context) error { | ||
| hydrateResult, err = hydrateFunc(ctx, d, hydrateData) | ||
| if err != nil && shouldRetryErrorFunc(err) { | ||
| err = retry.RetryableError(err) | ||
| } | ||
| return err | ||
| }) | ||
| return hydrateResult, err | ||
| } | ||
|
|
||
| // WrapHydrate is a higher order function which returns a HydrateFunc which handles Ignorable errors | ||
| func WrapHydrate(hydrateFunc HydrateFunc, ignoreConfig *IgnoreConfig) HydrateFunc { | ||
| return func(ctx context.Context, d *QueryData, h *HydrateData) (item interface{}, err error) { | ||
| defer func() { | ||
| if r := recover(); r != nil { | ||
| log.Printf("[WARN] recovered a panic from a wrapped hydrate function: %v\n", r) | ||
| err = status.Error(codes.Internal, fmt.Sprintf("hydrate function %s failed with panic %v", helpers.GetFunctionName(hydrateFunc), r)) | ||
| } | ||
| }() | ||
| // call the underlying get function | ||
| item, err = hydrateFunc(ctx, d, h) | ||
| if err != nil { | ||
| log.Printf("[TRACE] wrapped hydrate call %s returned error %v\n", helpers.GetFunctionName(hydrateFunc), err) | ||
| // see if the ignoreConfig defines a should ignore function | ||
| if ignoreConfig.ShouldIgnoreError != nil && ignoreConfig.ShouldIgnoreError(err) { | ||
| log.Printf("[TRACE] wrapped hydrate call %s returned error but we are ignoring it: %v", helpers.GetFunctionName(hydrateFunc), err) | ||
| return nil, nil | ||
| } | ||
| if ignoreConfig.ShouldIgnoreErrorFunc != nil && ignoreConfig.ShouldIgnoreErrorFunc(ctx, d, h, err) { | ||
| log.Printf("[TRACE] wrapped hydrate call %s returned error but we are ignoring it: %v", helpers.GetFunctionName(hydrateFunc), err) | ||
| return nil, nil | ||
| } | ||
| // pass any other error on | ||
| return nil, err | ||
| } | ||
| return item, nil | ||
| } | ||
| } |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,85 @@ | ||
| package plugin | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
| "github.com/sethvargo/go-retry" | ||
| "github.com/turbot/go-kit/helpers" | ||
| "google.golang.org/grpc/codes" | ||
| "google.golang.org/grpc/status" | ||
| "log" | ||
| "time" | ||
| ) | ||
|
|
||
| // RetryHydrate function invokes the hydrate function with retryable errors and retries the function until the maximum attemptes before throwing error | ||
| func RetryHydrate(ctx context.Context, d *QueryData, hydrateData *HydrateData, hydrateFunc HydrateFunc, retryConfig *RetryConfig) (interface{}, error) { | ||
| backoff, err := retry.NewFibonacci(100 * time.Millisecond) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| var hydrateResult interface{} | ||
|
|
||
| err = retry.Do(ctx, retry.WithMaxRetries(10, backoff), func(ctx context.Context) error { | ||
| hydrateResult, err = hydrateFunc(ctx, d, hydrateData) | ||
| if err != nil { | ||
| if shouldRetryError(ctx, d, hydrateData, err, retryConfig) { | ||
| err = retry.RetryableError(err) | ||
| } | ||
| } | ||
| return err | ||
| }) | ||
|
|
||
| return hydrateResult, err | ||
| } | ||
|
|
||
| // WrapHydrate is a higher order function which returns a HydrateFunc which handles Ignorable errors | ||
| func WrapHydrate(hydrateFunc HydrateFunc, ignoreConfig *IgnoreConfig) HydrateFunc { | ||
| log.Printf("[TRACE] WrapHydrate %s, ignore config %s\n", helpers.GetFunctionName(hydrateFunc), ignoreConfig.String()) | ||
|
|
||
| return func(ctx context.Context, d *QueryData, h *HydrateData) (item interface{}, err error) { | ||
| defer func() { | ||
| if r := recover(); r != nil { | ||
| log.Printf("[WARN] recovered a panic from a wrapped hydrate function: %v\n", r) | ||
| err = status.Error(codes.Internal, fmt.Sprintf("hydrate function %s failed with panic %v", helpers.GetFunctionName(hydrateFunc), r)) | ||
| } | ||
| }() | ||
| // call the underlying get function | ||
| item, err = hydrateFunc(ctx, d, h) | ||
| if err != nil { | ||
| log.Printf("[TRACE] wrapped hydrate call %s returned error %v, ignore config %s\n", helpers.GetFunctionName(hydrateFunc), err, ignoreConfig.String()) | ||
| // see if the ignoreConfig defines a should ignore function | ||
| if ignoreConfig.ShouldIgnoreError != nil && ignoreConfig.ShouldIgnoreError(err) { | ||
| log.Printf("[TRACE] wrapped hydrate call %s returned error but we are ignoring it: %v", helpers.GetFunctionName(hydrateFunc), err) | ||
| return nil, nil | ||
| } | ||
| if ignoreConfig.ShouldIgnoreErrorFunc != nil && ignoreConfig.ShouldIgnoreErrorFunc(ctx, d, h, err) { | ||
| log.Printf("[TRACE] wrapped hydrate call %s returned error but we are ignoring it: %v", helpers.GetFunctionName(hydrateFunc), err) | ||
| return nil, nil | ||
| } | ||
| // pass any other error on | ||
| return nil, err | ||
| } | ||
| return item, nil | ||
| } | ||
| } | ||
|
|
||
| func shouldRetryError(ctx context.Context, d *QueryData, h *HydrateData, err error, retryConfig *RetryConfig) bool { | ||
| log.Printf("[TRACE] shouldRetryError err: %v, retryConfig: %s", err, retryConfig.String()) | ||
|
|
||
| if retryConfig == nil { | ||
| log.Printf("[TRACE] shouldRetryError nil retry config - return false") | ||
| return false | ||
| } | ||
|
|
||
| if retryConfig.ShouldRetryError != nil { | ||
| log.Printf("[TRACE] shouldRetryError - calling legacy ShouldRetryError") | ||
| return retryConfig.ShouldRetryError(err) | ||
| } | ||
|
|
||
| if retryConfig.ShouldRetryErrorFunc != nil { | ||
| log.Printf("[TRACE] shouldRetryError - calling ShouldRetryFunc") | ||
| return retryConfig.ShouldRetryErrorFunc(ctx, d, h, err) | ||
| } | ||
|
|
||
| return false | ||
| } |
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
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
Oops, something went wrong.