Skip to content

feat: warn that payload filtering has no effect with FDv2 - #518

Merged
beekld merged 4 commits into
mainfrom
devin/1788468576-fdv2-payload-filter-warning
Sep 8, 2026
Merged

feat: warn that payload filtering has no effect with FDv2#518
beekld merged 4 commits into
mainfrom
devin/1788468576-fdv2-payload-filter-warning

Conversation

@beekld

@beekld beekld commented Sep 3, 2026

Copy link
Copy Markdown
Contributor

Documents and warns that payload_filter_key has no effect when the FDv2 data system is used.

Closes SDK-2973.

  • Config.payload_filter_key / AsyncConfig.payload_filter_key docs now state payload filtering is unsupported with FDv2
  • FDv2 data system logs a warning at construction when a filter key is configured
  • FDv1 behavior is unchanged; the shared option is not deprecated, since FDv1 still supports it

Requirements

  • I have added test coverage for new or changed functionality
  • I have followed the repository's pull request submission guidelines
  • I have validated my changes against all supported platform versions

Related issues

SDK-2973, part of SDK-2575. Same change as java-core#209 and go-server-sdk#440, adapted for the shared option.

Implementation details

Unlike Go and Java, Python has no FDv2-specific filter setter — payload_filter_key is a top-level option shared by FDv1 and FDv2 — so it cannot be deprecated at the language level without also deprecating supported FDv1 usage. Instead the docstrings call out the FDv2 limitation and FDv2.__init__ warns once when the option is set.

The FDv2 data sources still append ?filter= to /sdk/poll and /sdk/stream requests. That is intentional for now: on the delivery side, FDv2 (internal/fdcore in streamer) reads the filter query param only for observability (fdrequest.Info.HasPayloadFilter, surfaced as a dogfood context attribute) and never uses it to select a payload, so the parameter is inert rather than harmful. Dropping it would also break the environment_filter_key contract-test scenarios that the pinned harness (v3.0.0-alpha.6) still runs, requiring suppressions until the harness pin is bumped past sdk-test-harness#431. Removing the parameter belongs with that bump in the removal phase.

Testing: make lint, make test (1420 passed).

Link to Devin session: https://app.devin.ai/sessions/ed604c6db94d452ea9f2dc35d6acc398
Open in Devin Desktop: https://app.devin.ai/desktop/session/ed604c6db94d452ea9f2dc35d6acc398?variant=devin
Requested by: @beekld


Note

Overview
Clarifies that payload_filter_key still applies to default FDv1 streaming/polling, but does not filter FDv2 payloads.

Config and AsyncConfig docstrings (constructor param and payload_filter_key property) now state that filtering is unsupported with the FDv2 data system. FDv2 and AsyncFDv2 emit a one-time warning at construction when a filter key is set, without changing runtime behavior or deprecating the shared option for FDv1.

Tests assert the warning appears when a filter key is configured and is absent when it is not, for both sync and async FDv2.

Reviewed by Cursor Bugbot for commit eaa3d72. Bugbot is set up for automated code reviews on this repo. Configure here.

Co-Authored-By: Bee Klimt <bklimt@launchdarkly.com>
@devin-ai-integration

Copy link
Copy Markdown
Contributor

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment, CI, and merge conflict monitoring

Comment thread ldclient/impl/datasystem/fdv2.py
@beekld
beekld marked this pull request as ready for review September 4, 2026 20:52
@beekld
beekld requested a review from a team as a code owner September 4, 2026 20:52
@beekld
beekld requested a review from jsonbailey September 8, 2026 19:07
beekld added a commit to launchdarkly/js-core that referenced this pull request Sep 8, 2026
Documents that the shared `payloadFilterKey` option has no effect with
the FDv2 data system, and logs a warning when it's configured alongside
FDv2.

Closes [SDK-2974](https://launchdarkly.atlassian.net/browse/SDK-2974),
part of [SDK-2575](https://launchdarkly.atlassian.net/browse/SDK-2575).

- `payloadFilterKey` remains fully supported for FDv1, so the option
itself is neither deprecated nor removed.
- Server-side warning is emitted from `constructFDv2`; client-side
warning from the shared `createFDv2DataManagerBase` (covers browser,
react-native and node-client).
- The `?filter=` query param is still sent on FDv2 requests during this
deprecation period; the FDv2 backend path doesn't use it to select the
payload.

**Requirements**

- [x] I have added test coverage for new or changed functionality
- [x] I have followed the repository's [pull request submission
guidelines](../blob/main/CONTRIBUTING.md#submitting-pull-requests)
- [x] I have validated my changes against all supported platform
versions

<details>
<summary>Implementation details</summary>

**Related issues**

Follows the same approach as the Go (launchdarkly/go-server-sdk#440) and
Java (launchdarkly/java-core#209) deprecations, and the parallel Python
(launchdarkly/python-server-sdk#518) / Ruby
(launchdarkly/ruby-server-sdk#434) PRs. Payload-filter scenarios for
FDv2 were removed from the test harness in
launchdarkly/sdk-test-harness#431.

**Describe the solution you've provided**

- `packages/shared/sdk-server/src/api/options/LDOptions.ts` and
`packages/shared/sdk-client/src/api/LDOptions.ts`: doc comments note
that payload filtering isn't supported with FDv2.
- `packages/shared/sdk-server/src/LDClientImpl.ts`: warns in
`constructFDv2` when `payloadFilterKey` is configured.
- `packages/shared/sdk-client/src/datasource/FDv2DataManagerBase.ts`:
warns when `serviceEndpoints.payloadFilterKey` is configured.
Centralizing it here covers every client-side SDK, since browser,
react-native and node-client all build on this manager.

**Describe alternatives you've considered**

- Deprecating or removing the option outright: rejected, since it's
shared with FDv1 where it's still supported.
- Dropping `?filter=` from FDv2 request URLs now: deferred to the
removal phase so this change is behavior-preserving.

**Additional context**

Verified: `yarn workspace @launchdarkly/js-server-sdk-common test` (53
suites, 1022 passed) and `lint`; `yarn workspace
@launchdarkly/js-client-sdk-common test` (57 suites, 866 passed) and
`lint`.

</details>


Link to Devin session:
https://app.devin.ai/sessions/ed604c6db94d452ea9f2dc35d6acc398
Open in Devin Desktop:
https://app.devin.ai/desktop/session/ed604c6db94d452ea9f2dc35d6acc398?variant=devin
Requested by: @beekld

[SDK-2974]:
https://launchdarkly.atlassian.net/browse/SDK-2974?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ
[SDK-2575]:
https://launchdarkly.atlassian.net/browse/SDK-2575?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ

<!-- CURSOR_SUMMARY -->
---

> [!NOTE]
> **Overview**
> When **`payloadFilterKey`** is set while using the **FDv2 data
system**, the SDK now **logs a warning** that payload filtering is
unsupported and has **no effect** on FDv2 requests. **`payloadFilterKey`
is unchanged for FDv1** and is not removed or deprecated.
> 
> Warnings are emitted at **server** FDv2 setup in **`constructFDv2`**
(`LDClientImpl`) and at shared **client** FDv2 setup in
**`createFDv2DataManagerBase`** (browser, React Native, node-client).
**LDOptions** doc comments on client and server now state the same
limitation.
> 
> Tests cover both code paths (warn when a filter key is present, no
matching warn when absent).
> 
> <sup>Reviewed by [Cursor Bugbot](https://cursor.com/bugbot) for commit
cfaa48b. Bugbot is set up for automated
code reviews on this repo. Configure
[here](https://www.cursor.com/dashboard/bugbot).</sup>
<!-- /CURSOR_SUMMARY -->

Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
@beekld
beekld merged commit 296311f into main Sep 8, 2026
15 checks passed
@beekld
beekld deleted the devin/1788468576-fdv2-payload-filter-warning branch September 8, 2026 21:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants