chore: refactor entitlements to be a safe object to use #14406
Merged
Conversation
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
Previously, all usage of entitlements requires mutex usage on the api struct directly. This prevents passing the entitlements to a sub package. It also creates the possibility for misuse.
Emyrk
commented
Aug 22, 2024
| "github.com/coder/coder/v2/codersdk" | ||
| ) | ||
|
|
||
| type Set struct { |
There was a problem hiding this comment.
I implemented the methods as I saw them used. There might be a way to reduce the number of methods on this struct.
johnstcn
reviewed
Aug 23, 2024
| return f, ok | ||
| } | ||
|
|
||
| func (l *Set) Enabled(feature codersdk.FeatureName) bool { |
There was a problem hiding this comment.
Potential follow-up: we could replace this with f, ok := Features(name); ok && f.Enabled?
There was a problem hiding this comment.
True. Because before we had access to the whole struct, our usage of it seemed a bit arbitrary at times. Sometimes we grab it and check entitled, most times just enabled.
I'm not trying to fix all our usage right now, but it would be good to audit at some times.
There was a problem hiding this comment.
missing tests for the rest of the Entitlements methods
johnstcn
approved these changes
Aug 23, 2024
|
LGTM pending some more tests, but approving pre-emptively. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Previously, all usage of entitlements requires mutex usage on the
api struct directly. This prevents passing the entitlements to
a sub package. It also creates the possibility for misuse.
I am refactoring this because I want to place some IDP sync code into it's own package.
I'd prefer if the IDP code handled the entitlements (it's enterprise code).