Skip to content

feat: add wsproxy implementation for key fetching #14917

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.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 15 commits into from
Oct 14, 2024
Merged

feat: add wsproxy implementation for key fetching #14917

Changes from 1 commit
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
38574ff
feat: add wsproxy implementation for key fetching
sreya Oct 1, 2024
ea5ec77
Refactor CryptoKey usage to use codersdk package
sreya Oct 1, 2024
e6612bd
Refactor wsproxy to use cryptokeys interface
sreya Oct 1, 2024
558ad30
Refactor keycache to improve error handling
sreya Oct 1, 2024
9061a1c
prevent cache slowdown during fetches
sreya Oct 2, 2024
0fef6b0
fix tests
sreya Oct 2, 2024
a801d0c
craft test for race condition
sreya Oct 2, 2024
2ce4876
remove gotestleak...too many unrelated errors
sreya Oct 2, 2024
5eedbf8
optimize Close
sreya Oct 2, 2024
6c2be2c
Refactor CryptoKeyCache to improve concurrency
sreya Oct 4, 2024
a1d4b46
Refactor key refresh to minimize lock duration
sreya Oct 4, 2024
f6cc1cd
Merge branch 'main' into jon/wspkeys
sreya Oct 4, 2024
b33616e
Remove unused interface implementation check
sreya Oct 4, 2024
ee77d8e
Remove redundant CryptoKey cache field
sreya Oct 4, 2024
42eda0b
Merge branch 'main' into jon/wspkeys
sreya Oct 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Remove redundant CryptoKey cache field 
The `latest` field in `CryptoKeyCache` was redundant and has been removed to simplify the code. Instead, the latest crypto key is now directly accessed from the `keys` map using `latestSequence`. This change reduces unnecessary state management and potential for data inconsistency.
  • Loading branch information
@sreya
sreya committed Oct 4, 2024
commit ee77d8ebb81fe770a99208f9919eae1e76648038
29 changes: 14 additions & 15 deletions enterprise/wsproxy/keycache.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,6 @@ type CryptoKeyCache struct {

mu sync.Mutex
keys map[int32]codersdk.CryptoKey
latest codersdk.CryptoKey
lastFetch time.Time
refresher *quartz.Timer
fetching bool
Expand All @@ -57,12 +56,12 @@ func NewCryptoKeyCache(ctx context.Context, log slog.Logger, client Fetcher, opt
cache.refreshCtx, cache.refreshCancel = context.WithCancel(ctx)
cache.refresher = cache.Clock.AfterFunc(refreshInterval, cache.refresh)

m, latest, err := cache.cryptoKeys(ctx)
keys, err := cache.cryptoKeys(ctx)
if err != nil {
cache.refreshCancel()
return nil, xerrors.Errorf("initial fetch: %w", err)
}
cache.keys, cache.latest = m, latest
cache.keys = keys

return cache, nil
}
Expand Down Expand Up @@ -100,15 +99,15 @@ func (k *CryptoKeyCache) cryptoKey(ctx context.Context, sequence int32) (codersd
k.fetching = true
k.mu.Unlock()

keys, latest, err := k.cryptoKeys(ctx)
keys, err := k.cryptoKeys(ctx)
if err != nil {
return codersdk.CryptoKey{}, xerrors.Errorf("get keys: %w", err)
}

k.mu.Lock()
k.lastFetch = k.Clock.Now()
k.refresher.Reset(refreshInterval)
k.keys, k.latest = keys, latest
k.keys = keys
k.fetching = false
k.cond.Broadcast()

Expand All @@ -122,7 +121,7 @@ func (k *CryptoKeyCache) cryptoKey(ctx context.Context, sequence int32) (codersd

func (k *CryptoKeyCache) key(sequence int32) (codersdk.CryptoKey, bool) {
if sequence == latestSequence {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

if you're going to use a special int32 to represent latest, you might as well go whole hog and just insert the crypto key into the map under that special value, and drop k.latest

return k.latest, k.latest.CanSign(k.Clock.Now())
return k.keys[latestSequence], k.keys[latestSequence].CanSign(k.Clock.Now())
}

key, ok := k.keys[sequence]
Expand Down Expand Up @@ -171,7 +170,7 @@ func (k *CryptoKeyCache) refresh() {
k.fetching = true

k.mu.Unlock()
keys, latest, err := k.cryptoKeys(k.refreshCtx)
keys, err := k.cryptoKeys(k.refreshCtx)
if err != nil {
k.logger.Error(k.refreshCtx, "fetch crypto keys", slog.Error(err))
return
Expand All @@ -182,32 +181,32 @@ func (k *CryptoKeyCache) refresh() {

k.lastFetch = k.Clock.Now()
k.refresher.Reset(refreshInterval)
k.keys, k.latest = keys, latest
k.keys = keys
k.fetching = false
k.cond.Broadcast()
}

// cryptoKeys queries the control plane for the crypto keys.
// Outside of initialization, this should only be called by fetch.
func (k *CryptoKeyCache) cryptoKeys(ctx context.Context) (map[int32]codersdk.CryptoKey, codersdk.CryptoKey, error) {
func (k *CryptoKeyCache) cryptoKeys(ctx context.Context) (map[int32]codersdk.CryptoKey, error) {
keys, err := k.fetcher.Fetch(ctx)
if err != nil {
return nil, codersdk.CryptoKey{}, xerrors.Errorf("crypto keys: %w", err)
return nil, xerrors.Errorf("crypto keys: %w", err)
}
cache, latest := toKeyMap(keys, k.Clock.Now())
return cache, latest, nil
cache := toKeyMap(keys, k.Clock.Now())
return cache, nil
}

func toKeyMap(keys []codersdk.CryptoKey, now time.Time) (map[int32]codersdk.CryptoKey, codersdk.CryptoKey) {
func toKeyMap(keys []codersdk.CryptoKey, now time.Time) map[int32]codersdk.CryptoKey {
m := make(map[int32]codersdk.CryptoKey)
var latest codersdk.CryptoKey
for _, key := range keys {
m[key.Sequence] = key
if key.Sequence > latest.Sequence && key.CanSign(now) {
latest = key
m[latestSequence] = key
}
}
return m, latest
return m
}

func (k *CryptoKeyCache) Close() {
Expand Down
Loading