fix: Hooks gracefully return with an error message when optimizely prop is null #154
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
opti-jnguyen
commented
Mar 16, 2022
| @@ -1,5 +1,5 @@ | |||
| /** | |||
| * Copyright 2018-2019, Optimizely | |||
| * Copyright 2022, Optimizely | |||
There was a problem hiding this comment.
2018-2019, 2022
opti-jnguyen
commented
Mar 16, 2022
src/hooks.ts
Outdated
| if (!optimizely) { | ||
| throw new Error('optimizely prop must be supplied via a parent <OptimizelyProvider>'); | ||
| hooksLogger.warn(`Unable to use decision ${flagKey}. optimizely prop must be supplied via a parent <OptimizelyProvider>`); |
There was a problem hiding this comment.
Move conditional above overrideAttrs
opti-jnguyen
commented
Mar 16, 2022
src/hooks.ts
Outdated
| hooksLogger.warn(`Unable to use decision ${flagKey}. optimizely prop must be supplied via a parent <OptimizelyProvider>`); | ||
| return [ | ||
| createFailedDecision(flagKey, 'Optimizely SDK not configured properly yet.', { | ||
| id: overrides.overrideUserId || null, |
There was a problem hiding this comment.
Return null for user items bc user depends on Optimizely object
|
@zashraf1985 - let me know when you get a chance to review. Thanks in advance! |
zashraf1985
approved these changes
Mar 24, 2022
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.
Summary
Enables usage of hooks within the Optimizely Provider without passing in the
optimizelyprop.Previously, attempting to use hooks within an Optimizely Provider with a missing
optimizelyprop led to an error being thrown resulting in a crash.With this change, hooks now return pessimistic results when the
optimizelyprop isnull.Addresses this issue:
Also related:
Note:
optimizelyprop is null.Test Plan
Refactored tests that expect hooks to throw errors when Optimizely provider is not present.