Dev (#92)

* feat: moved caching logic to own implementation sub package.

* chore: applied goimports

* test: added more tests for cache package

* feat: updated minimum value of cache ttl settings

Minimum value of CacheTTL in Services.{Users,Profiles,Checks} have been updated from 0 to 1 to avoid creating caches with no TTL.

* feat: Configuration parameter change for caches

Removed configuration parameter Services.{Checks,Users,Profiles}.CacheTTL and replaced with Service.{Checks,Users,Profiles}.Cache.

New Configuration struct called CacheConfig with members TTL and CleanupInterval. TTL member is the replacement of deleted CacheTTL. CleanupInterval is net new. Both are of type time.Duration. The ConfigProvider library supports passing inputs through time.ParseDuration allowing for config values such as "1s" and "10ms".

* chore: removed unused code

* chore: added otel collector, prometheus and grafana to local dev setup

* test: added more tests

* feat: cache no longer extends expiry when setting a value

* cache migrated to new package with 100% coverage

* updated renovate config to allow automerging

* format code

Author: MadsRC

.idea/copyright/Sophrosyne.xml

@@ -11,6 +11,7 @@ protoc-gen-go = "1.34.1"
 protoc-gen-go-grpc = "1.3.0"
 node = "22.2.0"
 "go:github.com/goreleaser/goreleaser" = "1.26.1"
+"go:golang.org/x/pkgsite/cmd/pkgsite" = "latest"
 
 [settings]
 experimental = true

.mise.toml

@@ -44,5 +44,5 @@ if test "$check" = 0; then
     exit 0
   fi
 else
-  goimports -w -local github.com/madsrc/sophrosyne -e .
+  goimports -w -local github.com/madsrc/sophrosyne -e $(find . -name "*.go" | grep -v "\./build\|\./internal/mocks\|.*\.pb\.go")
 fi

.mise/tasks/dev/format

@@ -28,5 +28,6 @@ SOPH_LOGGING_LEVEL=debug \
   SOPH_TRACING_ENABLED=true \
   OTEL_EXPORTER_OTLP_ENDPOINT="http://localhost:4318" \
   OTEL_TRACES_EXPORTER="otlp" \
+  OTEL_METRICS_EXPORTER="otlp" \
   OTEL_EXPORTER_OTLP_PROTOCOL="http/protobuf" \
 go run cmd/sophrosyne/main.go --config configurations/dev.yaml run

.mise/tasks/dev/run

@@ -112,104 +112,3 @@ type UpdateCheckResponse struct {
 type DeleteCheckRequest struct {
 	Name string `json:"name" validate:"required"`
 }
-
-type CheckServiceCache struct {
-	cache          *Cache
-	checkService   CheckService
-	tracingService TracingService
-}
-
-func NewCheckServiceCache(config *Config, checkService CheckService, tracingService TracingService) *CheckServiceCache {
-	return &CheckServiceCache{
-		cache:          NewCache(config.Services.Profiles.CacheTTL),
-		checkService:   checkService,
-		tracingService: tracingService,
-	}
-}
-
-func (c CheckServiceCache) GetCheck(ctx context.Context, id string) (Check, error) {
-	ctx, span := c.tracingService.StartSpan(ctx, "CheckServiceCache.GetCheck")
-	v, ok := c.cache.Get(id)
-	if ok {
-		span.End()
-		return v.(Check), nil
-	}
-
-	profile, err := c.checkService.GetCheck(ctx, id)
-	if err != nil {
-		span.End()
-		return Check{}, err
-	}
-
-	c.cache.Set(id, profile)
-	span.End()
-	return profile, nil
-}
-
-func (c CheckServiceCache) GetCheckByName(ctx context.Context, name string) (Check, error) {
-	ctx, span := c.tracingService.StartSpan(ctx, "CheckServiceCache.GetCheckByName")
-	profile, err := c.checkService.GetCheckByName(ctx, name)
-	if err != nil {
-		span.End()
-		return Check{}, err
-	}
-
-	c.cache.Set(profile.ID, profile)
-	span.End()
-	return profile, nil
-}
-
-func (c CheckServiceCache) GetChecks(ctx context.Context, cursor *DatabaseCursor) ([]Check, error) {
-	ctx, span := c.tracingService.StartSpan(ctx, "CheckServiceCache.GetChecks")
-	profiles, err := c.checkService.GetChecks(ctx, cursor)
-	if err != nil {
-		span.End()
-		return nil, err
-	}
-
-	for _, user := range profiles {
-		c.cache.Set(user.ID, user)
-	}
-
-	span.End()
-	return profiles, nil
-}
-
-func (c CheckServiceCache) CreateCheck(ctx context.Context, check CreateCheckRequest) (Check, error) {
-	ctx, span := c.tracingService.StartSpan(ctx, "CheckServiceCache.CreateCheck")
-	createProfile, err := c.checkService.CreateCheck(ctx, check)
-	if err != nil {
-		span.End()
-		return Check{}, err
-	}
-
-	c.cache.Set(createProfile.ID, createProfile)
-	span.End()
-	return createProfile, nil
-}
-
-func (c CheckServiceCache) UpdateCheck(ctx context.Context, check UpdateCheckRequest) (Check, error) {
-	ctx, span := c.tracingService.StartSpan(ctx, "CheckServiceCache.UpdateCheck")
-	updateProfile, err := c.checkService.UpdateCheck(ctx, check)
-	if err != nil {
-		span.End()
-		return Check{}, err
-	}
-
-	c.cache.Set(updateProfile.ID, updateProfile)
-	span.End()
-	return updateProfile, nil
-}
-
-func (c CheckServiceCache) DeleteCheck(ctx context.Context, id string) error {
-	ctx, span := c.tracingService.StartSpan(ctx, "CheckServiceCache.DeleteCheck")
-	err := c.checkService.DeleteCheck(ctx, id)
-	if err != nil {
-		span.End()
-		return err
-	}
-
-	c.cache.Delete(id)
-	span.End()
-	return nil
-}

cache.go

@@ -28,6 +28,8 @@ import (
 	"syscall"
 	"time"
 
+	"github.com/madsrc/sophrosyne/internal/cache"
+
 	"github.com/urfave/cli/v2"
 	"gopkg.in/yaml.v3"
 
@@ -266,7 +268,7 @@ func run(c *cli.Context) error {
 		return err
 	}
 
-	checkService := sophrosyne.NewCheckServiceCache(config, checkServiceDatabase, otelService)
+	checkService := cache.NewCheckServiceCache(config, checkServiceDatabase, otelService)
 
 	profileServiceDatabase, err := pgx.NewProfileService(ctx, config, logger, checkService)
 	if err != nil {
@@ -278,15 +280,9 @@ func run(c *cli.Context) error {
 		return err
 	}
 
-	userService := sophrosyne.NewUserServiceCache(config, userServiceDatabase, otelService)
-	if err != nil {
-		return err
-	}
+	userService := cache.NewUserServiceCache(config, userServiceDatabase, otelService)
 
-	profileService := sophrosyne.NewProfileServiceCache(config, profileServiceDatabase, otelService)
-	if err != nil {
-		return err
-	}
+	profileService := cache.NewProfileServiceCache(config, profileServiceDatabase, otelService)
 
 	authzProvider, err := cedar.NewAuthorizationProvider(ctx, logger, userService, otelService, profileService, checkService)