adds graceful failure mode; all public functions have a try/catch (FF… #16
Conversation
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
aarsilv
reviewed
Sep 27, 2023
| export default class EppoClient implements IEppoClient { | ||
| private queuedEvents: IAssignmentEvent[] = []; | ||
| private assignmentLogger: IAssignmentLogger | undefined; | ||
| private isGracefulFailureMode = true; |
Comment on lines
+125
to
+127
| try { | ||
| return ( | ||
| this.getAssignmentVariation( |
There was a problem hiding this comment.
Since all these functions do is immediately delegate to getAssignmentVariation(), I'm thinking it would be cleaner to just have the try-catch in that method and forgo it in these user-facing syntactic sugar wrappers.
src/client/eppo-client.ts
Outdated
| ); | ||
| } catch (error) { | ||
| if (this.isGracefulFailureMode) { | ||
| console.error(`[Eppo SDK] Error getting assignment: ${error.message}`); |
There was a problem hiding this comment.
Consider just logging the error so we get the stack trace as well.
console.error('[Eppo SDK] Error getting assignment', error.message);
Comment on lines
+340
to
+342
| public setIsGracefulFailureMode(gracefulFailureMode: boolean) { | ||
| this.isGracefulFailureMode = gracefulFailureMode; | ||
| } |
There was a problem hiding this comment.
yea thank you - good idea!
aarsilv
approved these changes
Sep 28, 2023
| }, | ||
| }; | ||
|
|
||
| describe('error encountered', () => { |
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.
…-968)
labels: mergeable
Fixes: #issue
Motivation and Context
Exceptions within the Eppo SDK should not bubble up to the customers' applications.
Description
By default the graceful mode is enabled; all exceptions are captured in the top level public methods and logged.
For development the graceful mode can be disabled:
How has this been tested?
It was easy to test the logger because we can pass a mock - it wasn't obvious to me how to trigger an exception to be able to test the graceful mode. We'd need to stub
getAssignmentVariationbut this seems unnecessary.Suggestions welcome.
deployment plan
Bump version number and import into upstream.