Database governance built for humans and agents — controlling changes and access across every major database.
Go cicddata-governancedata-maskingdata-securitydatabase-accessdatabase-governancedevopsdevsecopsflywaygitopsliquibasemongodbmysqloraclepostgresqlschema-migrationssecuritysql-clientsqlservertidb
perf(store): cache the auth secret for the life of the Store (#21457)
Danny Xue7d051b27c77
diff --git a/backend/store/instance_project_test.go b/backend/store/instance_project_test.goindex 27369eb978..d7efa294ef 100644--- a/backend/store/instance_project_test.go+++ b/backend/store/instance_project_test.go@@ -124,6 +124,30 @@ func TestCreateAndListProjectInstance(t *testing.T) {require.Equal(t, &projectID, allInstances[0].ProjectID)}+func TestListAllInstancesDeobfuscatesAcrossWorkspaces(t *testing.T) {+ t.Parallel()+ ctx, db, s := newInstanceProjectFixture(t)+ _, err := db.ExecContext(ctx, `INSERT INTO workspace (resource_id) VALUES ('other')`)+ require.NoError(t, err)+ for _, workspace := range []string{"default", "other"} {+ metadata := testInstanceMetadata()+ metadata.DataSources[0].Password = workspace + "-password"+ _, err := s.CreateInstance(ctx, &store.InstanceMessage{+ ResourceID: workspace + "-instance",+ Workspace: workspace,+ Metadata: metadata,+ })+ require.NoError(t, err)+ }++ instances, err := s.ListAllInstances(ctx, false)+ require.NoError(t, err)+ require.Len(t, instances, 2)+ for _, instance := range instances {+ require.Equal(t, instance.Workspace+"-password", instance.Metadata.GetDataSources()[0].GetPassword())+ }+}+func TestUpdateInstanceWithoutWorkspace(t *testing.T) {t.Parallel()ctx, _, s := newInstanceProjectFixture(t)diff --git a/backend/store/runner_queries.go b/backend/store/runner_queries.goindex daf3f7d251..dc0c346c16 100644--- a/backend/store/runner_queries.go+++ b/backend/store/runner_queries.go@@ -185,17 +185,9 @@ func (s *Store) ListAllInstances(ctx context.Context, showDeleted bool) ([]*Instreturn nil, err}- // Deobfuscate per-workspace (group by workspace to avoid redundant secret lookups).- byWorkspace := make(map[string][]*InstanceMessage)- for _, inst := range instances {- byWorkspace[inst.Workspace] = append(byWorkspace[inst.Workspace], inst)- }- for _, wsInstances := range byWorkspace {- if err := s.deobfuscateInstances(ctx, wsInstances); err != nil {- return nil, err- }+ if err := s.deobfuscateInstances(ctx, instances); err != nil {+ return nil, err}-for _, instance := range instances {s.instanceCache.Add(getInstanceCacheKey(instance.ResourceID), instance)}diff --git a/backend/store/server_config.go b/backend/store/server_config.goindex de09116b52..46be41c446 100644--- a/backend/store/server_config.go+++ b/backend/store/server_config.go@@ -26,10 +26,17 @@ func (s *Store) GetServerConfig(ctx context.Context) (*storepb.ServerConfigPaylo}// GetAuthSecret returns the global auth secret used for JWT signing.+// Only migrations write server_config, so the first successful read is kept for+// the life of the Store, even when the cache is disabled.func (s *Store) GetAuthSecret(ctx context.Context) (string, error) {+ if cached := s.authSecret.Load(); cached != nil {+ return *cached, nil+ }config, err := s.GetServerConfig(ctx)if err != nil {return "", err}- return config.AuthSecret, nil+ secret := config.AuthSecret+ s.authSecret.Store(&secret)+ return secret, nil}diff --git a/backend/store/server_config_test.go b/backend/store/server_config_test.gonew file mode 100644index 0000000000..873f70f2d6--- /dev/null+++ b/backend/store/server_config_test.go@@ -0,0 +1,34 @@+package store_test++import (+ "context"+ "testing"++ "github.com/stretchr/testify/require"++ "github.com/bytebase/bytebase/backend/common/testcontainer"+)++func TestGetAuthSecretKeepsFirstSuccessfulRead(t *testing.T) {+ t.Parallel()+ ctx := context.Background()+ // NewMetadataDB disables the store cache, as HA does.+ db, s, _ := testcontainer.NewMetadataDB(t)++ _, err := db.ExecContext(ctx, `DELETE FROM server_config`)+ require.NoError(t, err)+ _, err = s.GetAuthSecret(ctx)+ require.Error(t, err)++ _, err = db.ExecContext(ctx, `INSERT INTO server_config (payload) VALUES ('{"authSecret": "first"}')`)+ require.NoError(t, err)+ secret, err := s.GetAuthSecret(ctx)+ require.NoError(t, err)+ require.Equal(t, "first", secret)++ _, err = db.ExecContext(ctx, `UPDATE server_config SET payload = '{"authSecret": "second"}'`)+ require.NoError(t, err)+ secret, err = s.GetAuthSecret(ctx)+ require.NoError(t, err)+ require.Equal(t, "first", secret)+}diff --git a/backend/store/store.go b/backend/store/store.goindex 3f086aec76..3965eae15b 100644--- a/backend/store/store.go+++ b/backend/store/store.go@@ -3,6 +3,7 @@ package storeimport ("sync"+ "sync/atomic""context""database/sql"@@ -22,7 +23,7 @@ type Store struct {enableCache bool// Cache.- Secret string+ authSecret atomic.Pointer[string]userEmailCache *lru.Cache[string, *UserMessage]instanceCache *lru.Cache[string, *InstanceMessage]databaseCache *lru.Cache[string, *DatabaseMessage]