fix(ats): [FSSDK-9023] Fix ODP Exports #812
Merged
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
… Update getVuid to accept undefined return
…813) * refactored event manager and event api manager and removed platform specific checks * moved vuid management to odpManager and removed browserContext altogether * Clean up + fix tests; inject NodeOdpManager * Finish splitting of event manager to variant-specific implementations * Split segment manager logic to variant-specific implementations --------- Co-authored-by: John Nguyen <john.nguyen@optimizely.com>
jaeopt
requested changes
Apr 10, 2023
Contributor
jaeopt
left a comment
jaeopt
left a comment
There was a problem hiding this comment.
Looks good. A quick for sendOdpEvent async.
| type?: string, | ||
| identifiers?: Map<string, string>, | ||
| data?: Map<string, unknown> | ||
| ): Promise<void>; |
Contributor
There was a problem hiding this comment.
Why is this asynchronous while "track" is synchronous?
| identifiers?: Map<string, string>; | ||
| data?: Map<string, unknown>; | ||
| }): Promise<void> { | ||
| public async sendOdpEvent( |
Contributor
There was a problem hiding this comment.
It looks like we need to make it "sync".
Contributor
There was a problem hiding this comment.
line 1705, it await for sync odpManager.sendOdpManager. Is it allowed or maybe some interface error?
Contributor
There was a problem hiding this comment.
I see "async" on identifyUser as well. It can be cleaned up too.
jaeopt
requested changes
Apr 10, 2023
| identifiers?: Map<string, string>; | ||
| data?: Map<string, unknown>; | ||
| }): Promise<void> { | ||
| public async sendOdpEvent( |
Contributor
There was a problem hiding this comment.
I see "async" on identifyUser as well. It can be cleaned up too.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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
Consolidated & patched external-facing interfaces for FSC testing.
Additionally, also refactored internal implementations of Browser/Node-specific implementations to avoid using unnecessary implicit contextual checks.
Breakdown of Changes:
fetchQualifiedSegmentsmethod signature in theOptimizelyUserContextinterface export to include optional parameteroptionsto match expected external-facing interface forOptimizelyUserContext.qualifiedSegmentstoOptimizelyUserContextinterface to match expected exported interface for external-facing interface forOptimizelyUserContext.OptimizelyUserContextinshared_types.tsandoptimizely_user_context/index.tsto couple class implementation with interface in order to avoid future interface mismatches. Renamed the interface toIOptimizelyUserContextwhile keeping the export name the same as before (OptimizelyUserContext) in order to avoid external regression.OptimizelySegmentsOptionto exported values to be exposed to external consumers.BrowserClientto exported values to be exposed to external consumers, enablinggetVuidto be accessible to external consumers as well.sendOdpEvent's method signature from a single object input to four parameters to be consistent with other SDKs.actionparameter's type fromODP_EVENT_ACTIONtostringto accept custom action types that will be defined by end users.BrowserClientback intoClientand addedisBrowserContext()catches for browser-specific functionality increateUserContextandgetVuid.The above changes fix the SDK to expose the expected interfaces to consumers for
fetchQualifiedSegments,qualifiedSegments,OptimizelySegmentsOption,BrowserClient/getVuid(), andsendOdpEvent.Also refactored ODP implementations to avoid implicit platform-specific checks for OdpManager, OdpEventManager, OdpSegmentManager, and related files.
Also refactored top-level ODP API interfaces to be synchronous instead of async (TODO: need to implement VUID initialization promise dependency top-level in a later PR)
Additionally, a reversion in package-lock.json (specifically downgrading lockfileVersion from 2 back to 1) was included in order to temporarily help the JS SDK pass linting. Lockfile version 2 seems to have peer dependency issues with types to some extent - will have to look into updating the SDK with better support for modern Node/NPM options.
Test plan
export_types.ts) and instead are meant to enable the implementation of their corresponding tests in FSC.Issues