- Notifications
You must be signed in to change notification settings - Fork1.1k
chore: refactor entitlements to be a safe object to use#14406
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Merged
Uh oh!
There was an error while loading.Please reload this page.
Merged
Changes fromall commits
Commits
Show all changes
7 commits Select commitHold shift + click to select a range
33b8199 chore: refactor entitlements to be a safe object to use
Emyrk66b363c chore: refactor entitlements to be passable as an argument
Emyrk65fd791 linting
Emyrk8d90083 linting and fix
Emyrk3e44716 update test
Emyrk04d9b03 update to rlocks
Emyrkaaea397 some extra tests
EmyrkFile filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
8 changes: 8 additions & 0 deletionscoderd/coderd.go
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
109 changes: 109 additions & 0 deletionscoderd/entitlements/entitlements.go
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,109 @@ | ||
| package entitlements | ||
| import ( | ||
| "encoding/json" | ||
| "net/http" | ||
| "sync" | ||
| "time" | ||
| "github.com/coder/coder/v2/codersdk" | ||
| ) | ||
| type Set struct { | ||
MemberAuthor There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. I implemented the methods as I saw them used. There might be a way to reduce the number of methods on this struct. | ||
| entitlementsMu sync.RWMutex | ||
| entitlements codersdk.Entitlements | ||
| } | ||
| func New() *Set { | ||
| return &Set{ | ||
| // Some defaults for an unlicensed instance. | ||
| // These will be updated when coderd is initialized. | ||
| entitlements: codersdk.Entitlements{ | ||
| Features: map[codersdk.FeatureName]codersdk.Feature{}, | ||
| Warnings: nil, | ||
| Errors: nil, | ||
| HasLicense: false, | ||
| Trial: false, | ||
| RequireTelemetry: false, | ||
| RefreshedAt: time.Time{}, | ||
| }, | ||
| } | ||
| } | ||
| // AllowRefresh returns whether the entitlements are allowed to be refreshed. | ||
| // If it returns false, that means it was recently refreshed and the caller should | ||
| // wait the returned duration before trying again. | ||
| func (l *Set) AllowRefresh(now time.Time) (bool, time.Duration) { | ||
| l.entitlementsMu.RLock() | ||
| defer l.entitlementsMu.RUnlock() | ||
| diff := now.Sub(l.entitlements.RefreshedAt) | ||
| if diff < time.Minute { | ||
| return false, time.Minute - diff | ||
| } | ||
| return true, 0 | ||
| } | ||
| func (l *Set) Feature(name codersdk.FeatureName) (codersdk.Feature, bool) { | ||
| l.entitlementsMu.RLock() | ||
| defer l.entitlementsMu.RUnlock() | ||
| f, ok := l.entitlements.Features[name] | ||
| return f, ok | ||
| } | ||
| func (l *Set) Enabled(feature codersdk.FeatureName) bool { | ||
Member There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. Potential follow-up: we could replace this with MemberAuthor There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. 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. | ||
| l.entitlementsMu.RLock() | ||
| defer l.entitlementsMu.RUnlock() | ||
| f, ok := l.entitlements.Features[feature] | ||
| if !ok { | ||
| return false | ||
| } | ||
| return f.Enabled | ||
| } | ||
| // AsJSON is used to return this to the api without exposing the entitlements for | ||
| // mutation. | ||
| func (l *Set) AsJSON() json.RawMessage { | ||
| l.entitlementsMu.RLock() | ||
| defer l.entitlementsMu.RUnlock() | ||
| b, _ := json.Marshal(l.entitlements) | ||
| return b | ||
| } | ||
| func (l *Set) Replace(entitlements codersdk.Entitlements) { | ||
| l.entitlementsMu.Lock() | ||
| defer l.entitlementsMu.Unlock() | ||
| l.entitlements = entitlements | ||
| } | ||
| func (l *Set) Update(do func(entitlements *codersdk.Entitlements)) { | ||
| l.entitlementsMu.Lock() | ||
| defer l.entitlementsMu.Unlock() | ||
| do(&l.entitlements) | ||
| } | ||
| func (l *Set) FeatureChanged(featureName codersdk.FeatureName, newFeature codersdk.Feature) (initial, changed, enabled bool) { | ||
| l.entitlementsMu.RLock() | ||
| defer l.entitlementsMu.RUnlock() | ||
| oldFeature := l.entitlements.Features[featureName] | ||
| if oldFeature.Enabled != newFeature.Enabled { | ||
| return false, true, newFeature.Enabled | ||
| } | ||
| return false, false, newFeature.Enabled | ||
| } | ||
| func (l *Set) WriteEntitlementWarningHeaders(header http.Header) { | ||
| l.entitlementsMu.RLock() | ||
| defer l.entitlementsMu.RUnlock() | ||
| for _, warning := range l.entitlements.Warnings { | ||
| header.Add(codersdk.EntitlementsWarningHeader, warning) | ||
| } | ||
| } | ||
63 changes: 63 additions & 0 deletionscoderd/entitlements/entitlements_test.go
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,63 @@ | ||
| package entitlements_test | ||
| import ( | ||
| "testing" | ||
| "time" | ||
| "github.com/stretchr/testify/require" | ||
| "github.com/coder/coder/v2/coderd/entitlements" | ||
| "github.com/coder/coder/v2/codersdk" | ||
| ) | ||
| func TestUpdate(t *testing.T) { | ||
| t.Parallel() | ||
| set := entitlements.New() | ||
| require.False(t, set.Enabled(codersdk.FeatureMultipleOrganizations)) | ||
| set.Update(func(entitlements *codersdk.Entitlements) { | ||
| entitlements.Features[codersdk.FeatureMultipleOrganizations] = codersdk.Feature{ | ||
| Enabled: true, | ||
| Entitlement: codersdk.EntitlementEntitled, | ||
| } | ||
| }) | ||
| require.True(t, set.Enabled(codersdk.FeatureMultipleOrganizations)) | ||
| } | ||
| func TestAllowRefresh(t *testing.T) { | ||
| t.Parallel() | ||
| now := time.Now() | ||
| set := entitlements.New() | ||
| set.Update(func(entitlements *codersdk.Entitlements) { | ||
| entitlements.RefreshedAt = now | ||
| }) | ||
| ok, wait := set.AllowRefresh(now) | ||
| require.False(t, ok) | ||
| require.InDelta(t, time.Minute.Seconds(), wait.Seconds(), 5) | ||
| set.Update(func(entitlements *codersdk.Entitlements) { | ||
| entitlements.RefreshedAt = now.Add(time.Minute * -2) | ||
| }) | ||
| ok, wait = set.AllowRefresh(now) | ||
| require.True(t, ok) | ||
| require.Equal(t, time.Duration(0), wait) | ||
| } | ||
| func TestReplace(t *testing.T) { | ||
| t.Parallel() | ||
| set := entitlements.New() | ||
| require.False(t, set.Enabled(codersdk.FeatureMultipleOrganizations)) | ||
| set.Replace(codersdk.Entitlements{ | ||
| Features: map[codersdk.FeatureName]codersdk.Feature{ | ||
| codersdk.FeatureMultipleOrganizations: { | ||
| Enabled: true, | ||
| }, | ||
| }, | ||
| }) | ||
| require.True(t, set.Enabled(codersdk.FeatureMultipleOrganizations)) | ||
| } |
6 changes: 6 additions & 0 deletionscodersdk/deployment.go
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
72 changes: 30 additions & 42 deletionsenterprise/coderd/coderd.go
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
Oops, something went wrong.
Uh oh!
There was an error while loading.Please reload this page.
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.