-
Notifications
You must be signed in to change notification settings - Fork 1.8k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Introduces an alternate to the legacyCollections and genericCollection that relies on caching resource in memory. The new collection[T] takes inspiration from the legacy collection types but aims to both simplify and break reliance on using the local storage services. The two collection mechanisms will and can coexist until all types are converted to the new mechanism. A single implementation of the new collection exists for the StaticTokens. Additionally, during the conversion process some refactoring will be done to try to better organize and reduce the size of cache.go. In this PR all of the code specific to static tokens was moved out of cache.go and legacy_collections.go and into static_tokens.go. This will allow separating concerns and making it much easier to identify where specific content lives.
- Loading branch information
1 parent
eccea21
commit 3be09f7
Showing
8 changed files
with
503 additions
and
30 deletions.
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,179 @@ | ||
| // Teleport | ||
| // Copyright (C) 2025 Gravitational, Inc. | ||
| // | ||
| // This program is free software: you can redistribute it and/or modify | ||
| // it under the terms of the GNU Affero General Public License as published by | ||
| // the Free Software Foundation, either version 3 of the License, or | ||
| // (at your option) any later version. | ||
| // | ||
| // This program is distributed in the hope that it will be useful, | ||
| // but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
| // GNU Affero General Public License for more details. | ||
| // | ||
| // You should have received a copy of the GNU Affero General Public License | ||
| // along with this program. If not, see <http://www.gnu.org/licenses/>. | ||
|
|
||
| package cache | ||
|
|
||
| import ( | ||
| "context" | ||
|
|
||
| "github.com/gravitational/trace" | ||
|
|
||
| "github.com/gravitational/teleport/api/types" | ||
| ) | ||
|
|
||
| // collection is responsible for managing a resource in the cache. | ||
| type collection[T any, S store[T], U upstream[T]] struct { | ||
| upstream U | ||
| store S | ||
| watch types.WatchKind | ||
| singleton bool | ||
| } | ||
|
|
||
| // upstream is responsible for seeding the cache with resources from | ||
| // the auth server. | ||
| type upstream[T any] interface { | ||
| getAll(ctx context.Context, loadSecrets bool) ([]T, error) | ||
| } | ||
|
|
||
| // store persists the cached resources locally in memory. | ||
| type store[T any] interface { | ||
| // put will create or update a target resource in the cache. | ||
| put(t T) error | ||
| // delete removes a single entry from the cache. | ||
| delete(t T) error | ||
| // clear will delete all target resources of the type in the cache. | ||
| clear() error | ||
| } | ||
|
|
||
| type eventHandler interface { | ||
| // fetch fetches resources and returns a function which will apply said resources to the cache. | ||
| // fetch *must* not mutate cache state outside of the apply function. | ||
| // The provided cacheOK flag indicates whether this collection will be included in the cache generation that is | ||
| // being prepared. If cacheOK is false, fetch shouldn't fetch any resources, but the apply function that it | ||
| // returns must still delete resources from the backend. | ||
| fetch(ctx context.Context, cacheOK bool) (apply func(ctx context.Context) error, err error) | ||
| // onDelete will delete a single target resource from the cache. For | ||
| // singletons, this is usually an alias to clear. | ||
| onDelete(t types.Resource) error | ||
| // onUpdate will update a single target resource from the cache | ||
| onUpdate(t types.Resource) error | ||
| // watchKind returns a watch | ||
| // required for this collection | ||
| watchKind() types.WatchKind | ||
| } | ||
|
|
||
| func (c collection[_, _, _]) watchKind() types.WatchKind { | ||
| return c.watch | ||
| } | ||
|
|
||
| func (c *collection[T, _, _]) onDelete(r types.Resource) error { | ||
| switch t := r.(type) { | ||
| case types.Resource153Unwrapper: | ||
| unwrapped := t.Unwrap() | ||
| tt, ok := unwrapped.(T) | ||
| if !ok { | ||
| return trace.BadParameter("unexpected wrapped type %T (expected %T)", unwrapped, tt) | ||
| } | ||
|
|
||
| c.store.delete(tt) | ||
| return nil | ||
| case T: | ||
| c.store.delete(t) | ||
| return nil | ||
| default: | ||
| return trace.BadParameter("unexpected type %T (expected %T)", r, t) | ||
| } | ||
| } | ||
|
|
||
| func (c *collection[T, _, _]) onUpdate(r types.Resource) error { | ||
| switch t := r.(type) { | ||
| case types.Resource153Unwrapper: | ||
| unwrapped := t.Unwrap() | ||
| tt, ok := unwrapped.(T) | ||
| if !ok { | ||
| return trace.BadParameter("unexpected wrapped type %T (expected %T)", unwrapped, tt) | ||
| } | ||
|
|
||
| c.store.put(tt) | ||
| return nil | ||
| case T: | ||
| c.store.put(t) | ||
| return nil | ||
| default: | ||
| return trace.BadParameter("unexpected type %T (expected %T)", r, t) | ||
| } | ||
| } | ||
|
|
||
| func (c collection[T, _, _]) fetch(ctx context.Context, cacheOK bool) (apply func(context.Context) error, err error) { | ||
| // Singleton objects will only get deleted or updated, not both | ||
| deleteSingleton := false | ||
|
|
||
| var resources []T | ||
| if cacheOK { | ||
| resources, err = c.upstream.getAll(ctx, c.watch.LoadSecrets) | ||
| if err != nil { | ||
| if !trace.IsNotFound(err) { | ||
| return nil, trace.Wrap(err) | ||
| } | ||
| deleteSingleton = true | ||
| } | ||
| } | ||
|
|
||
| return func(ctx context.Context) error { | ||
| // Always perform the delete if this is not a singleton, otherwise | ||
| // only perform the delete if the singleton wasn't found | ||
| // or the resource kind isn't cached in the current generation. | ||
| if !c.singleton || deleteSingleton || !cacheOK { | ||
| if err := c.store.clear(); err != nil { | ||
| if !trace.IsNotFound(err) { | ||
| return trace.Wrap(err) | ||
| } | ||
| } | ||
| } | ||
| // If this is a singleton and we performed a deletion, return here | ||
| // because we only want to update or delete a singleton, not both. | ||
| // Also don't continue if the resource kind isn't cached in the current generation. | ||
| if c.singleton && deleteSingleton || !cacheOK { | ||
| return nil | ||
| } | ||
| for _, resource := range resources { | ||
| if err := c.store.put(resource); err != nil { | ||
| return trace.Wrap(err) | ||
| } | ||
| } | ||
| return nil | ||
| }, nil | ||
| } | ||
|
|
||
| type collections struct { | ||
| byKind map[resourceKind]eventHandler | ||
|
|
||
| staticTokens *collection[types.StaticTokens, *singletonStore[types.StaticTokens], *staticTokensUpstream] | ||
| } | ||
|
|
||
| func setupCollections(c Config, watches []types.WatchKind) (*collections, error) { | ||
| out := &collections{ | ||
| byKind: make(map[resourceKind]eventHandler, 1), | ||
| } | ||
|
|
||
| for _, watch := range watches { | ||
| resourceKind := resourceKindFromWatchKind(watch) | ||
|
|
||
| switch watch.Kind { | ||
| case types.KindStaticTokens: | ||
| collect, err := newStaticTokensCollection(c.ClusterConfig, watch) | ||
| if err != nil { | ||
| return nil, trace.Wrap(err) | ||
| } | ||
|
|
||
| out.staticTokens = collect | ||
| out.byKind[resourceKind] = out.staticTokens | ||
|
|
||
| } | ||
| } | ||
|
|
||
| return out, nil | ||
| } |
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
Oops, something went wrong.