[Proposal] Add new RolloutBucketID field #1590
Open
Conversation
This file contains 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
RolloutBucketId allows the client to report a (somewhat) fixed value to XLWebServices for purposes of canary determination. This change allows Dalamud to perform staged rollouts (e.g. 1%, 20%, 50%, 100%), multiple canaries at once, and similar.
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.
This pull request aims to add a new field to the updater, namely
RolloutBucketId. This field allows the launcher to report a (somewhat) fixed value to XLWebServices for purposes of canary determination.This change specifically allows Dalamud to perform a staged rollout (e.g. 1%, 20%, 50%, 100%), multiple canaries at once, and other server-side logic behaviors. As an example, the existing
RolloutBucketfield will now be set from the BucketID if it does not already exist.Currently, this field has a precision of 1,000 buckets, calculated by the creation time of the
Addonfolder. This roughly correlates to the user's initial installation time. This was chosen specifically since it's relatively difficult to control with precision meaning users cannot "sign up" for canary releases. This is considered a feature, as users wishing to test still have the option of using thestgbuilds.This feature does introduce a minor privacy risk, as users are now slotted into one of these 1,000 buckets. I believe, however, that our user counts and the source of this data (ticks mod 1000) make this effectively useless for tracking.
Eventually, we may expose this field to Dalamud proper so that plugins may also perform similar canary logic (e.g. limited rollouts via PluginMaster/D17, or feature flags in-code).