fix: Respect client sendFeatureFlagEvent option
#2285
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
`getFeatureFlag` and `isFeatureEnabled` now respect the `sendFeatureFlagEvent` client option if not explicitly specified when called.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
|
Size Change: -320 B (-0.01%) Total Size: 5.23 MB
ℹ️ View Unchanged
|
…load` as deprecated This option is not used.
dustinbyrne
force-pushed
the
fix/node-global-send-feature-flags
branch
from
59e96fa to
dae80f8
Compare
There was a problem hiding this comment.
Pull Request Overview
This PR fixes inconsistent feature flag event tracking behavior in the Node SDK by ensuring that getFeatureFlag and isFeatureEnabled methods respect the global sendFeatureFlagEvent client option when no method-level override is provided.
- Modified
getFeatureFlagto use the client'ssendFeatureFlagEventoption as default instead of always defaulting totrue - Added comprehensive tests to verify both methods respect the global client option and allow method-level overrides
- Deprecated the non-functional
sendFeatureFlagEventsoption ingetFeatureFlagPayloadmethod
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| packages/node/src/client.ts | Updates default behavior for sendFeatureFlagEvents to respect client configuration and deprecates unused option |
| packages/node/test/posthog-node.spec.ts | Adds comprehensive test coverage for the new behavior with both global and method-level options |
| .changeset/thin-pets-cut.md | Documents deprecation of unused sendFeatureFlagEvents option |
| .changeset/shaggy-eyes-attack.md | Documents the fix for respecting client sendFeatureFlagEvent option |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
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.
Problem
The Node SDK has some inconsistent behavior with feature flag event tracking. The
getFeatureFlagandisFeatureEnabledmethods were not respecting the globalsendFeatureFlagEventclient option when no method-level override was provided, always defaulting totrueinstead of using the client configuration.Additionally, the
getFeatureFlagPayloadmethod included a non-functionalsendFeatureFlagEventsoption that had no effect, potentially causing confusion.Changes
getFeatureFlagmethod to respect the globalsendFeatureFlagEventclient option when no method-levelsendFeatureFlagEventsoption is providedgetFeatureFlagandisFeatureEnabledperform the correct behavior when a global client option is used and when a method-level option overrides itsendFeatureFlagEventsoption ingetFeatureFlagPayloadmethod has been marked as deprecated since it has no intended effectResolves #2282
Release info Sub-libraries affected
Libraries affected
Checklist
If releasing new changes
pnpm changesetto generate a changeset file