Feature Flags! #4844
There are no files selected for viewing
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,163 @@ | ||
| ---@type string, Private | ||
| local addon, Private = ... | ||
|
|
||
| ---@alias BuildType "dev" | "pr" | "alpha" | "beta" | "release" | ||
|
|
||
| ---@class feature | ||
| ---@field id string | ||
| ---@field autoEnable? BuildType[] | ||
| ---@field requiredByAura? fun(self: self, aura: auraData): boolean | ||
| ---@field enabled? boolean | ||
| ---@field persist? true | ||
| ---@field sub? SubscribableObject | ||
|
|
||
| ---@class Features | ||
| ---@field private db? table<string, boolean> | ||
| ---@field private __feats table<string, feature> | ||
| ---@field private hydrated boolean | ||
| local Features = { | ||
| __feats = {}, | ||
| hydrated = false, | ||
| } | ||
| Private.Features = Features | ||
|
|
||
| ---@param id string | ||
| function Features:Exists(id) | ||
| return self.__feats[id] ~= nil | ||
| end | ||
|
|
||
| ---@param id string | ||
| function Features:Enabled(id) | ||
| return self.hydrated and self:Exists(id) and self.__feats[id].enabled | ||
| end | ||
|
|
||
| ---@param id string | ||
| function Features:Enable(id) | ||
| if not self:Exists(id) then return end | ||
| if not self.hydrated then | ||
| error("Cannot enable a feature before hydration", 2) | ||
| elseif not self.__feats[id].enabled then | ||
| self.__feats[id].enabled = true | ||
| if self.__feats[id].persist then | ||
| self.db[id] = true | ||
| end | ||
| self.__feats[id].sub:Notify("Enable") | ||
| end | ||
| end | ||
|
|
||
| ---@param id string | ||
| function Features:Disable(id) | ||
| if not self:Exists(id) then return end | ||
| if not self.hydrated then | ||
| error("Cannot disable a feature before hydration", 2) | ||
| elseif self.__feats[id].enabled then | ||
| self.__feats[id].enabled = false | ||
| if self.__feats[id].persist then | ||
| self.db[id] = false | ||
| end | ||
| self.__feats[id].sub:Notify("Disable") | ||
| end | ||
| end | ||
|
|
||
| ---@return {id: string, enabled: boolean}[] | ||
| function Features:ListFeatures() | ||
| if not self.hydrated then return {} end | ||
| local list = {} | ||
| for id, feature in pairs(self.__feats) do | ||
| table.insert(list, { | ||
| id = id, | ||
| enabled = feature.enabled | ||
| }) | ||
| end | ||
| table.sort(list, function(a, b) | ||
| return a.id < b.id | ||
| end) | ||
| return list | ||
| end | ||
|
|
||
| function Features:Hydrate() | ||
| self.db = Private.db.features | ||
| for id, feature in pairs(self.__feats) do | ||
| local enable = false | ||
| if self.db[id] ~= nil then | ||
| enable = self.db[id] | ||
| else | ||
| for _, buildType in ipairs(feature.autoEnable or {}) do | ||
| if WeakAuras.buildType == buildType then | ||
| enable = true | ||
| break | ||
| end | ||
| end | ||
| end | ||
| feature.enabled = enable | ||
| end | ||
| self.hydrated = true | ||
| for _, feature in pairs(self.__feats) do | ||
| -- cannot notify before hydrated flag is set, or we risk consumers getting wrong information | ||
| feature.sub:Notify(feature.enabled and "Enable" or "Disable") | ||
| end | ||
| end | ||
|
|
||
| ---@param feature feature | ||
| function Features:Register(feature) | ||
| if self.hydrated then | ||
| error("Cannot register a feature after hydration", 2) | ||
| end | ||
| if not self.__feats[feature.id] then | ||
| self.__feats[feature.id] = feature | ||
| feature.sub = Private.CreateSubscribableObject() | ||
| end | ||
| end | ||
|
|
||
| ---@param id string | ||
| ---@param enabledFunc function | ||
| ---@param disabledFunc? function | ||
| ---hide a code path behind a feature flag, | ||
| ---optionally provide a disabled path | ||
| function Features:Wrap(id, enabledFunc, disabledFunc) | ||
| return function(...) | ||
| if self:Enabled(id) then | ||
| return enabledFunc(...) | ||
| else | ||
| if disabledFunc then | ||
| return disabledFunc(...) | ||
| end | ||
| end | ||
| end | ||
| end | ||
|
|
||
| ---@param data auraData | ||
| ---@return boolean, table<string, boolean> | ||
| function Features:AuraCanFunction(data) | ||
|
There was a problem hiding this comment. Presumably we'd communicate to the user if an aura they had required a disabled feature to function properly, but that sounds touchy to do & i figured we would cross that bridge when we got there |
||
| local enabled = true | ||
| local reasons = {} | ||
|
|
||
| for _, feature in pairs(self.__feats) do | ||
| if feature.requiredByAura and not feature:requiredByAura(data) then | ||
| enabled = false | ||
| reasons[feature.id] = false | ||
| end | ||
| end | ||
|
|
||
| return enabled, reasons | ||
| end | ||
|
|
||
| ---@param id string | ||
| ---@param enable function | ||
| ---@param disable function | ||
| function Features:Subscribe(id, enable, disable) | ||
| local tbl = { | ||
| Enable = enable, | ||
| Disable = disable | ||
| } | ||
| if self:Exists(id) then | ||
| self.__feats[id].sub:AddSubscriber("Enable", tbl) | ||
| self.__feats[id].sub:AddSubscriber("Disable", tbl) | ||
| end | ||
| end | ||
|
|
||
|
|
||
| Features:Register({ | ||
| id = "debug", | ||
| autoEnable = {"dev"} | ||
| }) | ||
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
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
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
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
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
5 ='s, because bigwigs packager will use at most 4 ='s in its own
@flag@replacements