feat: add project info cache size, ttl config

cmd/yorkie/server.go

@@ -50,6 +50,7 @@ var (
 	authWebhookMaxWaitInterval time.Duration
 	authWebhookCacheAuthTTL    time.Duration
 	authWebhookCacheUnauthTTL  time.Duration
+	projectInfoCacheTTL        time.Duration
 
 	etcdEndpoints     []string
 	etcdDialTimeout   time.Duration
@@ -72,6 +73,7 @@ func newServerCmd() *cobra.Command {
 			conf.Backend.AuthWebhookMaxWaitInterval = authWebhookMaxWaitInterval.String()
 			conf.Backend.AuthWebhookCacheAuthTTL = authWebhookCacheAuthTTL.String()
 			conf.Backend.AuthWebhookCacheUnauthTTL = authWebhookCacheUnauthTTL.String()
+			conf.Backend.ProjectInfoCacheTTL = projectInfoCacheTTL.String()
 
 			conf.Housekeeping.Interval = housekeepingInterval.String()
 
@@ -337,6 +339,18 @@ func init() {
 		server.DefaultAuthWebhookCacheUnauthTTL,
 		"TTL value to set when caching unauthorized webhook response.",
 	)
+	cmd.Flags().IntVar(
+		&conf.Backend.ProjectInfoCacheSize,
+		"project-info-cache-size",
+		server.DefaultProjectInfoCacheSize,
+		"The cache size of the project info.",
+	)
+	cmd.Flags().DurationVar(
+		&projectInfoCacheTTL,
+		"project-info-cache-ttl",
+		server.DefaultProjectInfoCacheTTL,
+		"TTL value to set when caching project info.",
+	)
 	cmd.Flags().StringVar(
 		&conf.Backend.Hostname,
 		"hostname",

server/backend/config.go

@@ -70,6 +70,12 @@ type Config struct {
 	// AuthWebhookCacheUnauthTTL is the TTL value to set when caching the unauthorized result.
 	AuthWebhookCacheUnauthTTL string `yaml:"AuthWebhookCacheUnauthTTL"`
 
+	// ProjectInfoCacheSize is the cache size of the project info.
+	ProjectInfoCacheSize int `yaml:"ProjectInfoCacheSize"`
+
+	// ProjectInfoCacheTTL is the TTL value to set when caching the project info.
+	ProjectInfoCacheTTL string `yaml:"ProjectInfoCacheTTL"`
+
 	// Hostname is yorkie server hostname. hostname is used by metrics.
 	Hostname string `yaml:"Hostname"`
 }
@@ -108,6 +114,14 @@ func (c *Config) Validate() error {
 		)
 	}
 
+	if _, err := time.ParseDuration(c.ProjectInfoCacheTTL); err != nil {
+		return fmt.Errorf(
+			`invalid argument "%s" for "--project-info-cache-ttl" flag: %w`,
+			c.ProjectInfoCacheTTL,
+			err,
+		)
+	}
+
 	return nil
 }
 
@@ -154,3 +168,14 @@ func (c *Config) ParseAuthWebhookCacheUnauthTTL() time.Duration {
 
 	return result
 }
+
+// ParseProjectInfoCacheTTL returns TTL for project info cache.
+func (c *Config) ParseProjectInfoCacheTTL() time.Duration {
+	result, err := time.ParseDuration(c.ProjectInfoCacheTTL)
+	if err != nil {
+		fmt.Fprintln(os.Stderr, "parse project info cache ttl: %w", err)
+		os.Exit(1)
+	}
+
+	return result
+}

server/backend/config_test.go

@@ -31,6 +31,7 @@ func TestConfig(t *testing.T) {
 			AuthWebhookMaxWaitInterval: "0ms",
 			AuthWebhookCacheAuthTTL:    "10s",
 			AuthWebhookCacheUnauthTTL:  "10s",
+			ProjectInfoCacheTTL:        "1h",
 		}
 		assert.NoError(t, validConf.Validate())
 
@@ -49,5 +50,9 @@ func TestConfig(t *testing.T) {
 		conf4 := validConf
 		conf4.AuthWebhookCacheUnauthTTL = "s"
 		assert.Error(t, conf4.Validate())
+
+		conf5 := validConf
+		conf5.ProjectInfoCacheTTL = "1 hour"
+		assert.Error(t, conf5.Validate())
 	})
 }

server/config.go

@@ -63,6 +63,8 @@ const (
 	DefaultAuthWebhookCacheSize       = 5000
 	DefaultAuthWebhookCacheAuthTTL    = 10 * time.Second
 	DefaultAuthWebhookCacheUnauthTTL  = 10 * time.Second
+	DefaultProjectInfoCacheSize       = 256
+	DefaultProjectInfoCacheTTL        = time.Hour
 
 	DefaultHostname = ""
 )
@@ -201,6 +203,14 @@ func (c *Config) ensureDefaultValue() {
 		c.Backend.AuthWebhookCacheUnauthTTL = DefaultAuthWebhookCacheUnauthTTL.String()
 	}
 
+	if c.Backend.ProjectInfoCacheSize == 0 {
+		c.Backend.ProjectInfoCacheSize = DefaultProjectInfoCacheSize
+	}
+
+	if c.Backend.ProjectInfoCacheTTL == "" {
+		c.Backend.ProjectInfoCacheTTL = DefaultProjectInfoCacheTTL.String()
+	}
+
 	if c.Mongo != nil {
 		if c.Mongo.ConnectionURI == "" {
 			c.Mongo.ConnectionURI = DefaultMongoConnectionURI

server/config.sample.yml

@@ -74,6 +74,12 @@ Backend:
   # AuthWebhookCacheUnauthTTL is the TTL value to set when caching the unauthorized result.
   AuthWebhookCacheUnauthTTL: "10s"
 
+  # ProjectInfoCacheSize is the size of the project info cache.
+  ProjectInfoCacheSize: 256
+
+  # ProjectInfoCacheTTL is the TTL value to set when caching the project info.
+  ProjectInfoCacheTTL: "1h"
+
   # Hostname is the hostname of the server. If not provided, the hostname will be
   # determined automatically by the OS (Optional, default: os.Hostname()).
   Hostname: ""

server/config_test.go

@@ -77,5 +77,9 @@ func TestNewConfigFromFile(t *testing.T) {
 		authWebhookCacheUnauthTTL, err := time.ParseDuration(conf.Backend.AuthWebhookCacheUnauthTTL)
 		assert.NoError(t, err)
 		assert.Equal(t, authWebhookCacheUnauthTTL, server.DefaultAuthWebhookCacheUnauthTTL)
+
+		projectInfoCacheTTL, err := time.ParseDuration(conf.Backend.ProjectInfoCacheTTL)
+		assert.NoError(t, err)
+		assert.Equal(t, projectInfoCacheTTL, server.DefaultProjectInfoCacheTTL)
 	})
 }

server/rpc/interceptors/context.go

@@ -21,10 +21,6 @@ import (
 	"context"
 	"fmt"
 	"strings"
-	"time"
-
-	"github.com/yorkie-team/yorkie/pkg/cache"
-	"github.com/yorkie-team/yorkie/server/logging"
 
 	grpcmiddleware "github.com/grpc-ecosystem/go-grpc-middleware"
 	"google.golang.org/grpc"
@@ -33,15 +29,14 @@ import (
 	grpcstatus "google.golang.org/grpc/status"
 
 	"github.com/yorkie-team/yorkie/api/types"
+	"github.com/yorkie-team/yorkie/pkg/cache"
 	"github.com/yorkie-team/yorkie/server/backend"
+	"github.com/yorkie-team/yorkie/server/logging"
 	"github.com/yorkie-team/yorkie/server/projects"
 	"github.com/yorkie-team/yorkie/server/rpc/grpchelper"
 	"github.com/yorkie-team/yorkie/server/rpc/metadata"
 )
 
-const projectInfoCacheSize = 256
-const projectInfoCacheTTL = time.Hour
-
 // ContextInterceptor is an interceptor for building additional context.
 type ContextInterceptor struct {
 	backend          *backend.Backend
@@ -50,7 +45,7 @@ type ContextInterceptor struct {
 
 // NewContextInterceptor creates a new instance of ContextInterceptor.
 func NewContextInterceptor(be *backend.Backend) *ContextInterceptor {
-	projectInfoCache, err := cache.NewLRUExpireCache[string, *types.Project](projectInfoCacheSize)
+	projectInfoCache, err := cache.NewLRUExpireCache[string, *types.Project](be.Config.ProjectInfoCacheSize)
 	if err != nil {
 		logging.DefaultLogger().Fatal("Failed to create project info cache: %v", err)
 	}
@@ -170,7 +165,7 @@ func (i *ContextInterceptor) buildContext(ctx context.Context) (context.Context,
 		if err != nil {
 			return nil, grpchelper.ToStatusError(err)
 		}
-		i.projectInfoCache.Add(cacheKey, project, projectInfoCacheTTL)
+		i.projectInfoCache.Add(cacheKey, project, i.backend.Config.ParseProjectInfoCacheTTL())
 		ctx = projects.With(ctx, project)
 	}
 

server/rpc/server_test.go

@@ -76,6 +76,8 @@ func TestMain(m *testing.M) {
 		ClientDeactivateThreshold: helper.ClientDeactivateThreshold,
 		SnapshotThreshold:         helper.SnapshotThreshold,
 		AuthWebhookCacheSize:      helper.AuthWebhookSize,
+		ProjectInfoCacheSize:      helper.ProjectInfoCacheSize,
+		ProjectInfoCacheTTL:       helper.ProjectInfoCacheTTL.String(),
 		AdminTokenDuration:        helper.AdminTokenDuration,
 	}, &mongo.Config{
 		ConnectionURI:     helper.MongoConnectionURI,

test/helper/helper.go

@@ -69,6 +69,8 @@ var (
 	AuthWebhookSize            = 100
 	AuthWebhookCacheAuthTTL    = 10 * gotime.Second
 	AuthWebhookCacheUnauthTTL  = 10 * gotime.Second
+	ProjectInfoCacheSize       = 256
+	ProjectInfoCacheTTL        = 5 * gotime.Second
 
 	MongoConnectionURI     = "mongodb://localhost:27017"
 	MongoConnectionTimeout = "5s"
@@ -238,6 +240,8 @@ func TestConfig() *server.Config {
 			AuthWebhookCacheSize:       AuthWebhookSize,
 			AuthWebhookCacheAuthTTL:    AuthWebhookCacheAuthTTL.String(),
 			AuthWebhookCacheUnauthTTL:  AuthWebhookCacheUnauthTTL.String(),
+			ProjectInfoCacheSize:       ProjectInfoCacheSize,
+			ProjectInfoCacheTTL:        ProjectInfoCacheTTL.String(),
 		},
 		Mongo: &mongo.Config{
 			ConnectionURI:     MongoConnectionURI,

test/integration/auth_webhook_test.go

@@ -161,6 +161,8 @@ func TestProjectAuthWebhook(t *testing.T) {
 		)
 		assert.NoError(t, err)
 
+		projectInfoCacheTTL := 5 * time.Second
+		time.Sleep(projectInfoCacheTTL)
 		cli, err := client.Dial(
 			svr.RPCAddr(),
 			client.WithAPIKey(project.PublicKey),