WPB-27912: Deprecate backgroundEffects feature flag at API v17 - #5431
Open
blackheaven wants to merge 11 commits into
Open
WPB-27912: Deprecate backgroundEffects feature flag at API v17#5431blackheaven wants to merge 11 commits into
blackheaven wants to merge 11 commits into
Conversation
zebot
added
the
ok-to-test
Mark BackgroundEffectsConfig with a DEPRECATED pragma and flip its default from disabled+locked to enabled+locked. The flag is purely declarative (no backend behavioral code), so no consumer needed neutralizing. Gate the public GET/PUT /teams/:tid/features/backgroundEffects and the internal lock-status PUT to 404 at API v17 (available through v16), matching the meetingsPremium (WPB-26771) deprecation pattern. Split the single FeatureAPIGetPut route + handler into separate version-gated GET and PUT. The aggregate GET /feature-configs and GET /teams/:tid/features endpoints remain version-agnostic and continue to include the flag. Remove the Helm configuration override (charts/wire-server values.yaml + galley configmap.yaml); stale operator overrides are now inert. Update config docs and add changelogs.
blackheaven
force-pushed
the
gdifolco/WPB-27912-background-effects-ff-deprecation
branch
from
August 10, 2026 16:14
d6a6f95 to
60e6e51
Compare
supersven
reviewed
Aug 11, 2026
Comment on lines
102
to
+103
| :<|> Until 'V17 ::> IFeatureStatusLockStatusPut MeetingsPremiumConfig | ||
| :<|> IFeatureStatusLockStatusPut BackgroundEffectsConfig | ||
| :<|> Until 'V17 ::> IFeatureStatusLockStatusPut BackgroundEffectsConfig |
Contributor
There was a problem hiding this comment.
AFAIK we don't use internal endpoints in a versioned manner. Please check that this doesn't break e.g. stern.
Contributor
Author
There was a problem hiding this comment.
The Until 'V17 on the internal endpoint is safe: internal calls omit X-Wire-API-Version, so getVersionHeader defaults to V0, and the gate V0 >= V17 is False (never fires). Matches the existing
MeetingsPremiumConfig precedent on the adjacent line; plus, there is no reference in stern.
supersven
reviewed
Aug 11, 2026
supersven
reviewed
Aug 11, 2026
Comment on lines
+44
to
+47
| bindResponse (baseRequest owner Galley (ExplicitVersion 17) p >>= submit "GET") $ \resp -> do | ||
| resp.status `shouldMatchInt` 404 | ||
| bindResponse (baseRequest owner Galley (ExplicitVersion 17) p <&> addJSON body >>= submit "PUT") $ \resp -> do | ||
| resp.status `shouldMatchInt` 404 |
supersven
reviewed
Aug 11, 2026
supersven
reviewed
Aug 11, 2026
Co-authored-by: Sven Tennie <sven.tennie@wire.com>
Co-authored-by: Sven Tennie <sven.tennie@wire.com>
Co-authored-by: Sven Tennie <sven.tennie@wire.com>
supersven
reviewed
Aug 11, 2026
Comment on lines
+89
to
+90
| <@> mkNamedAPI @'("get", BackgroundEffectsConfig) getFeature | ||
| <@> mkNamedAPI @'("put", BackgroundEffectsConfig) setFeature |
Contributor
There was a problem hiding this comment.
Hm, why do we need this change? Or, what changes it? 🤔
supersven
reviewed
Aug 11, 2026
Comment on lines
+2432
to
+2434
| -- /Deprecated (WPB-27912)./ This feature flag no longer affects meeting | ||
| -- behaviour and is kept solely for API compatibility. It defaults to | ||
| -- /enabled and locked/. Scheduled for removal in a future release. |
Contributor
There was a problem hiding this comment.
This should probably be Haddock of the data BackgroundEffectsConfig type.
supersven
reviewed
Aug 11, 2026
Comment on lines
+89
to
+90
| :<|> Deprecated ::> Until 'V17 ::> FeatureAPIGet BackgroundEffectsConfig | ||
| :<|> Deprecated ::> Until 'V17 ::> FeatureAPIPut BackgroundEffectsConfig |
Contributor
There was a problem hiding this comment.
See https://github.com/wireapp/wire-server/pull/5431/changes#r3758084593 - I unfortunately don't understand this split 🤔
Contributor
Author
There was a problem hiding this comment.
I have squashed them
supersven
requested changes
Aug 11, 2026
Address review feedback (@supersven): - Simplify the deprecated/v17-gated backgroundEffects Get/Put endpoints to a single `Deprecated ::> Until 'V17 ::> FeatureAPIGetPut` arm served by `hoistAPI id featureAPIGetPut`, matching the MLSConfig pattern. The split was unnecessary since `Deprecated` and `Until` are server/client-transparent (`ServerT (... :> api) = ServerT api`), so routing, v17 404-gating and the OpenAPI `deprecated` flagging are unchanged. - Attach the deprecation note as a `-- |` Haddock on `data BackgroundEffectsConfig`.
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
3 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.
https://wearezeta.atlassian.net/browse/WPB-27912
Checklist
changelog.d