Niko/react native template update #548
Open
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
* add precomputed assignments documentation for JS client * very nice! * globally * Update docs/sdks/client-sdks/javascript/precomputed-assignments.mdx Co-authored-by: Sameeran Kunche <[email protected]> --------- Co-authored-by: Sameeran Kunche <[email protected]>
* Update precomputed-assignments.mdx evaluation example * Update docs/sdks/client-sdks/javascript/precomputed-assignments.mdx Co-authored-by: Sameeran Kunche <[email protected]> --------- Co-authored-by: Sameeran Kunche <[email protected]>
✅ Deploy Preview for eppo-data-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
…bandits aren't in the client SDKs per the spreadsheet.
aarsilv
requested changes
Dec 20, 2024
There was a problem hiding this comment.
Thanks for going over the React Native docs as well! Lots of great changes in here 👏
I left a bunch of comments but am requesting changes for a few main reasons:
- We should remove the old React Native section
- Currently, React Native SDK doesn't support persistent caching; we should remove all references
- There are some initialization options not yet exposed to React Native SDK that we should remove
| @@ -0,0 +1,5 @@ | |||
| { | |||
| "label": "React Native", | |||
There was a problem hiding this comment.
We'll want to delete the old react native section
| - String | ||
| - Boolean | ||
| - JSON | ||
| - Numeric |
| - JSON | ||
| - Numeric | ||
|
|
||
| Depending on the values you pass to the getAssignment function, the SDK will return different results based on whether the subject details match the assignment rules you set in the Eppo UI. |
There was a problem hiding this comment.
Consider making getAssignment() displayed as code and with the parenthesis to make it clear it is a function
|
|
||
| This section will cover the different types of assignments that you can make with the Eppo SDK. | ||
|
|
||
| ### Local Storage |
There was a problem hiding this comment.
The React Native SDK uses React Native Async Storage which, according to these docs, uses Local Storage for the web, SQLite for Android, and the filesystem for iOS.
Although we should probably ax this because we don't use it for caching at the moment (EppoAsyncStorage is always expired)
| <FeatureCard | ||
| title="API Reference" | ||
| description="Reference for all SDK methods." | ||
| link="https://github.com/Eppo-exp/react-native-sdk" |
There was a problem hiding this comment.
This is not an API reference. These docs themselves are basically the API reference
| <ApiOptionRef | ||
| name="persistentStore" | ||
| type="IAsyncStore" | ||
| defaultValue="Eppo provided" |
There was a problem hiding this comment.
maybe we should put in parenthesis so it's clear this isn't an actual class. (Eppo provided)
Comment on lines
+97
to
+104
| <ApiOptionRef | ||
| name="skipInitialRequest" | ||
| type="boolean" | ||
| defaultValue="false" | ||
| > | ||
|
|
||
| Skip the initial request for a new configuration during initialization (if polling is enabled, this will still take place later) | ||
| </ApiOptionRef> |
There was a problem hiding this comment.
This one is not an option for React SDK
Comment on lines
+124
to
+145
| <ApiOptionRef | ||
| name="useExpiredCache" | ||
| type="boolean" | ||
| defaultValue="false" | ||
| > | ||
|
|
||
| Consider initialization successfully complete without fetching updates, even if the configuration loaded from the cache is expired | ||
| </ApiOptionRef> | ||
|
|
||
| <ApiOptionRef | ||
| name="updateOnFetch" | ||
| type="'always' | 'expired' | 'empty'" | ||
| defaultValue="'always'" | ||
| > | ||
|
|
||
| Sets how the configuration is updated after a successful fetch: | ||
|
|
||
| - **always** - immediately start using the new configuration | ||
| - **expired** - immediately start using the new configuration only if the current one has expired | ||
| - **empty** - only use the new configuration if the current one is both expired and uninitialized/empty | ||
|
|
||
| </ApiOptionRef> |
There was a problem hiding this comment.
These two are currently not options for the ReactSDK either
Comment on lines
+147
to
+305
|
|
||
| ###### Prioritize fast initialization | ||
| If you want to optimize for the quickest time to initialization and serving assignments--even if those assignments may be out of date, you would want settings that: | ||
| - Immediately start using the new configuration after it is fetched | ||
| - Allow initializing with older configurations | ||
| - Reduce the initial fetch timeout and retries to quickly fall back to default values | ||
|
|
||
| Use the following configuration to achieve those goals: | ||
|
|
||
| ```ts | ||
| import { init } from "@eppo/react-native-sdk"; | ||
|
|
||
| await init({ | ||
| apiKey: 'YOUR_API_KEY', | ||
| updateOnFetch: 'always', // Immediately start using the new configuration once it is fetched | ||
| maxCacheAgeSeconds: 300, // Don't even bother fetching updated configurations unless the last one is more than five minutes old | ||
| useExpiredCache: true, // If the cached configuration is expired, use it to serve assignments until an updated one is fetched | ||
| requestTimeoutMs: 500, // Give up on fetching updated configurations after half a second and--if this is the first-ever initialization--just serve default values | ||
| numInitialRequestRetries: 0, // Don't retry a failed initialization fetch | ||
| }); | ||
| ``` | ||
|
|
||
| Note that when new configurations are loaded, the same flag may start getting a different assignment for the same session. If you want to avoid this, and have consistent assignments until the next initialization, change `updateOnFetch` to `empty`. | ||
| You could consider caches always expired so that it non-blocking loads an updated configuration to be used in the next session. | ||
|
|
||
| ```ts | ||
| import { init } from "@eppo/react-native-sdk"; | ||
|
|
||
| await init({ | ||
| apiKey: 'YOUR_API_KEY', | ||
| maxCacheAgeSeconds: 0, // Always consider cached configurations expired | ||
| // Settings set to non-default values | ||
| updateOnFetch: 'empty', // Immediately start using the new configuration once it is fetched | ||
| useExpiredCache: true, // Always used the previously cached assignments | ||
| requestTimeoutMs: 500, // Give up on fetching updated configurations after half a second and--if this is the first-ever initialization--just serve default values | ||
| numInitialRequestRetries: 0, // Don't retry a failed initialization fetch | ||
| }); | ||
| ``` | ||
|
|
||
| ### Offline initialization | ||
|
|
||
| Eppo's SDK supports offline initialization. This is useful if you want to initialize the SDK with a configuration from your server SDK or other external process. In this mode the SDK will not attempt to fetch a configuration from Eppo's CDN, instead only using the provided values. | ||
|
|
||
| This function is synchronous and ready to handle assignments after it returns. | ||
|
|
||
| ```javascript | ||
| import { offlineInit, Flag, ObfuscatedFlag } from "@eppo/react-native-sdk"; | ||
|
|
||
| // configuration from your server SDK | ||
| const configurationJsonString: string = getConfigurationFromServer(); | ||
|
|
||
| // The configuration will be not-obfuscated from your server SDK. | ||
| // If you have obfuscated flag values, you can use the `ObfuscatedFlag` type. | ||
| const flagsConfiguration: Record<string, Flag | ObfuscatedFlag> = JSON.parse(configurationJsonString); | ||
|
|
||
| offlineInit({ | ||
| flagsConfiguration, | ||
| // If you have obfuscated flag values, you can use the `ObfuscatedFlag` type. | ||
| isObfuscated: true, | ||
| }); | ||
| ``` | ||
|
|
||
| The `offlineInit` function accepts the following optional configuration arguments. | ||
|
|
||
| ### Offline Initialization Options | ||
|
|
||
| <ApiOptionRef | ||
| name="assignmentLogger" | ||
| type="IAssignmentLogger" | ||
| typeUrl="https://github.com/Eppo-exp/js-client-sdk-common/blob/75c2ea1d91101d579138d07d46fca4c6ea4aafaf/src/assignment-logger.ts#L55-L62" | ||
| defaultValue="null" | ||
| > | ||
|
|
||
| A callback that sends each assignment to your data warehouse. Required only for experiment analysis. | ||
| </ApiOptionRef> | ||
| <ApiOptionRef | ||
| name="flagsConfiguration" | ||
| type="Record <string, Flag | ObfuscatedFlag>" | ||
| defaultValue="null" | ||
| > | ||
|
|
||
| The flags configuration to use for the SDK. | ||
| </ApiOptionRef> | ||
|
|
||
| <ApiOptionRef | ||
| name="isObfuscated" | ||
| type="boolean" | ||
| defaultValue="false" | ||
| > | ||
|
|
||
| Whether the flag values are obfuscated. | ||
| </ApiOptionRef> | ||
| <ApiOptionRef | ||
| name="throwOnFailedInitialization" | ||
| type="boolean" | ||
| defaultValue="true" | ||
| > | ||
|
|
||
| Throw an error if an error occurs during initialization. | ||
| </ApiOptionRef> |
There was a problem hiding this comment.
Configuration caching and offline initialization have not yet been exposed to the React SDK. The latter is in the works in a pre-release version. We should make sure part of launching includes updating the documentation.
|
|
||
|
|
||
| ## Advanced Configuration | ||
| Basic initialization is great for most use cases, but the SDK provides options that you can use during initialization to customize the behavior of the SDK. |
There was a problem hiding this comment.
We also have a baseUrl option which is where the SDK fetches configurations from. Some customers override this went they proxy configuration requests.
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.
Updating the React Native SDK docs to use the new template for SDK docs.
Dependent on the Docusaurus 2.x -> 3.x update. Don't merge until that is in.