fix(oxygen-sdk): document event sending and align event sending logic with other edge sdks - #1844
Open
joker23 wants to merge 1 commit into
Open
fix(oxygen-sdk): document event sending and align event sending logic with other edge sdks#1844joker23 wants to merge 1 commit into
joker23 wants to merge 1 commit into
Conversation
with other edge sdks
joker23
marked this pull request as ready for review
August 7, 2026 14:24
Contributor
|
@launchdarkly/js-sdk-common size report |
Contributor
|
@launchdarkly/js-client-sdk-common size report |
Contributor
|
@launchdarkly/js-client-sdk size report |
Contributor
|
@launchdarkly/browser size report |
![devin-ai-integration[bot]](https://avatars.githubusercontent.com/in/811515?s=60&v=4){kind=small}
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
This PR will align the event sending configurations for Oxygen SDK with the other edge sdks:
sendEventoptiondisableBackgroundEventFlushtotrueThis PR also adds more documentation and comments to clarify event sending behavior and options.
Note
Low Risk
Changes are limited to the Oxygen SDK’s event-delivery model and documentation; they mirror the existing Fastly edge pattern and do not touch shared auth or data paths.
Overview
Aligns the Shopify Oxygen SDK with other edge runtimes by passing
disableBackgroundEventFlush: trueinto the server client so periodic flush timers are not started when each request spins up its own client.OxygenLDOptionsnow officially includessendEvents, and the README explains the per-request lifecycle: optionalawait ldClient.flush()before returning (required for analytics delivery), that skipping flush discards buffered events, and thatclose()does not flush.Adds a unit test that mocks
EventProcessorand asserts the processor is constructed with background flush disabled, plus clearer comments on Oxygen-specific defaults.Reviewed by Cursor Bugbot for commit 6f3b484. Bugbot is set up for automated code reviews on this repo. Configure here.