refactor: Configuration-gate experiments #2517
No reviewers
Labels
No labels
Abandoned
Blocked
Bug
Changelog
Added
Changelog
Missing
Changelog
None
Cherry-picking
Database
Dependencies
Dependencies/Renovate
Difficulty
Easy
Difficulty
Hard
Difficulty
Medium
Documentation
Enhancement
Good first issue
Help wanted
Inherited
Matrix/Administration
Matrix/Appservices
Matrix/Auth
Matrix/Client
Matrix/Core
Matrix/E2EE
Matrix/Federation
Matrix/Hydra
Matrix/MSC
Matrix/Media
Matrix/T&S
Merge
Merge/Manual
Merge/Squash
Meta
Meta/CI
Meta/Packaging
Priority
Blocking
Priority
High
Priority
Low
Security
Status
Confirmed
Status
Duplicate
Status
Invalid
Status
Needs Investigation
Support
bob the builder
compliance
No assignees
4 participants
Notifications
Due date
No due date set.
Dependencies
No dependencies set
Reference
continuwuation/continuwuity!2517
Loading…
Reference in a new issue
No description provided.
Delete branch "nex/refactor/new-unstable-policy"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
This pull request introduces a new unstable features policy (per #1884) and adjusts the existing codebase to adhere to the policy.
This PR also does the following:
Closes #1884
Pull request checklist:
mainbranch, and the branch is named something other thanmain.myself, if applicable. This includes ensuring code compiles.
@ -0,0 +14,4 @@typically only accept implementations of proposals that seem like they are a net positive for alarge portion of the Matrix ecosystem, rather than aiming to "implement everything". As such, theunstable feature list should typically be small and manageable.This needs effectively a copy paste of the bullet points in #1884, plus probably a bit stating that any MSCs that are enabled by default have documented why they meet the criteria or why they are an exception.
Extrapolated into
ed5c51334c; resolve this thread if you think it's satisfactory, let me know if not.@ -0,0 +2,4 @@/// Configuration for experimental features.#[derive(Debug, Deserialize, Default, Clone)]pub struct Experiments {This is missing the bits and bobs to add it to the configuration, check the other nested structs to see how that works
I deliberately omitted it so that people don't just enable experiments without understanding the consequences. I was thinking that if an unstable feature is widely favoured, that'll be reflected in people recommending it in support and such, rather than it being promoted in documentation. This also means the section can't become stale across updates, since the config file will gradually end up containing ghost references to fields that got removed.
Synapse takes a similar approach I believe for similar reasons. If you disagree I'm happy to change it, I just don't feel like it's a good idea for the social and technical reasons.
I think it'd be really annoying for it not to be in the config reference. Not elsewhere in docs is fine, but should definitely be in the reference IMO.
The issue there is the config reference is copied into each continuwuity install via packages, which means there will be config drift:
Hm, but this kind of ends up happening anyways in general, as the config is updated, and at least this way the configuration reference on the website will be canonical and have all the options.
The config isn't frequently updated, the experiments struct is expected to be significantly hotter than the rest of the config file (relatively speaking). I'm sure documenting the experiments somewhere in the docs would be fine, but I'm really against embedding it into the reference config that gets pushed into packages
Having a more striped-down configuration in packages is a different issue/enhancement. Ideally we still have a complete config reference generated automatically and available.
mmm I feel like that's a "we'll fix it later" that will inevitably never happen, but I'll trust on that for now and embed it
Can't get the config generator to play ball... I'll push what I've got now and pick it up later, maybe someone else can crack it in the meantime
@Henry-Hiles figured the issue out and fixed it up, the config ref should now contain all experiments :D