feat: project cache (#48)

* feat: eventstore repository * fix: remove gorm * version * feat: pkg * feat: add some files for project * feat: eventstore without eventstore-lib * rename files * gnueg * fix: key json * fix: add object * fix: change imports * fix: internal models * fix: some imports * fix: global model * fix: add some functions on repo * feat(eventstore): sdk * fix(eventstore): search query * fix(eventstore): rename app to eventstore * delete empty test * remove unused func * merge master * fix(eventstore): tests * fix(models): delete unused struct * fix: some funcitons * feat(eventstore): implemented push events * fix: move project eventstore to project package * fix: change project eventstore funcs * feat(eventstore): overwrite context data * fix: change project eventstore * fix: add project repo to mgmt server * feat(types): SQL-config * fix: commented code * feat(eventstore): options to overwrite editor * feat: auth interceptor and cockroach migrations * fix: migrations * fix: fix filter * fix: not found on getbyid * fix: add sequence * fix: add some tests * fix(eventstore): nullable sequence * fix: add some tests * merge * fix: add some tests * fix(migrations): correct statements for sequence * fix: add some tests * fix: add some tests * fix: changes from mr * Update internal/eventstore/models/field.go Co-Authored-By: livio-a <livio.a@gmail.com> * fix(eventstore): code quality * fix: add types to aggregate/Event-types * fix(eventstore): rename modifier* to editor* * fix(eventstore): delete editor_org * fix(migrations): remove editor_org field, rename modifier_* to editor_* * fix: generate files * fix(eventstore): tests * fix(eventstore): rename modifier to editor * fix(migrations): add cluster migration, fix(migrations): fix typo of host in clean clsuter * fix(eventstore): move health * fix(eventstore): AggregateTypeFilter aggregateType as param * code quality * feat: add member funcs * feat: add member model * feat: add member events * feat: add member repo model * fix: project member funcs * fix: add tests * fix: add tests * feat: implement member requests * fix: merge master * fix: read existing in project repo * fix: fix tests * feat: add internal cache * feat: add cache mock * fix: return values of cache mock * fix: add cache config * fix: use eventstore sdk * Update internal/project/model/project_member.go Co-Authored-By: Silvan <silvan.reusser@gmail.com> * fix: use get project func * fix: return err not nil * fix: change err types * Update internal/cache/bigcache/cache.go Co-Authored-By: livio-a <livio.a@gmail.com> * Update internal/cache/config/config.go Co-Authored-By: livio-a <livio.a@gmail.com> * Update internal/cache/config/config.go Co-Authored-By: livio-a <livio.a@gmail.com> * fix: config * fix: config * resolve conversations * fix: mr changes * fix: fix decode of bigcache * feat: test caches * fix: remove unnecessary code Co-authored-by: adlerhurst <silvan.reusser@gmail.com> Co-authored-by: livio-a <livio.a@gmail.com>
2025-08-11 21:17:32 +00:00 · 2020-04-20 15:16:33 +02:00
parent 28166dd5e0
commit 802bb56ea1
21 changed files with 840 additions and 35 deletions
--- a/internal/project/repository/eventsourcing/cache.go
+++ b/internal/project/repository/eventsourcing/cache.go
@@ -0,0 +1,34 @@
+package eventsourcing
+
+import (
+	"github.com/caos/logging"
+	"github.com/caos/zitadel/internal/cache"
+	"github.com/caos/zitadel/internal/cache/config"
+	"github.com/caos/zitadel/internal/eventstore/models"
+)
+
+type ProjectCache struct {
+	projectCache cache.Cache
+}
+
+func StartCache(conf *config.CacheConfig) (*ProjectCache, error) {
+	projectCache, err := conf.Config.NewCache()
+	logging.Log("EVENT-vDneN").OnError(err).Panic("unable to create project cache")
+
+	return &ProjectCache{projectCache: projectCache}, nil
+}
+
+func (c *ProjectCache) getProject(ID string) (project *Project) {
+	project = &Project{ObjectRoot: models.ObjectRoot{ID: ID}}
+	if err := c.projectCache.Get(ID, project); err != nil {
+		logging.Log("EVENT-4eTZh").WithError(err).Debug("error in getting cache")
+	}
+	return project
+}
+
+func (c *ProjectCache) cacheProject(project *Project) {
+	err := c.projectCache.Set(project.ID, project)
+	if err != nil {
+		logging.Log("EVENT-ThnBb").WithError(err).Debug("error in setting project cache")
+	}
+}
--- a/internal/project/repository/eventsourcing/eventstore.go
+++ b/internal/project/repository/eventsourcing/eventstore.go
@@ -2,8 +2,7 @@ package eventsourcing

 import (
 	"context"
-	"github.com/caos/zitadel/internal/eventstore/models"
-
+	"github.com/caos/zitadel/internal/cache/config"
 	caos_errs "github.com/caos/zitadel/internal/errors"
 	es_int "github.com/caos/zitadel/internal/eventstore"
 	es_sdk "github.com/caos/zitadel/internal/eventstore/sdk"
@@ -12,28 +11,38 @@ import (

 type ProjectEventstore struct {
 	es_int.Eventstore
+	projectCache *ProjectCache
 }

 type ProjectConfig struct {
 	es_int.Eventstore
+	Cache *config.CacheConfig
 }

 func StartProject(conf ProjectConfig) (*ProjectEventstore, error) {
-	return &ProjectEventstore{Eventstore: conf.Eventstore}, nil
+	projectCache, err := StartCache(conf.Cache)
+	if err != nil {
+		return nil, err
+	}
+	return &ProjectEventstore{
+		Eventstore:   conf.Eventstore,
+		projectCache: projectCache,
+	}, nil
 }

-func (es *ProjectEventstore) ProjectByID(ctx context.Context, project *proj_model.Project) (*proj_model.Project, error) {
+func (es *ProjectEventstore) ProjectByID(ctx context.Context, id string) (*proj_model.Project, error) {
+	project := es.projectCache.getProject(id)
+
 	query, err := ProjectByIDQuery(project.ID, project.Sequence)
 	if err != nil {
 		return nil, err
 	}
-
-	p := ProjectFromModel(project)
-	err = es_sdk.Filter(ctx, es.FilterEvents, p.AppendEvents, query)
+	err = es_sdk.Filter(ctx, es.FilterEvents, project.AppendEvents, query)
 	if err != nil {
 		return nil, err
 	}
-	return ProjectToModel(p), nil
+	es.projectCache.cacheProject(project)
+	return ProjectToModel(project), nil
 }

 func (es *ProjectEventstore) CreateProject(ctx context.Context, project *proj_model.Project) (*proj_model.Project, error) {
@@ -49,6 +58,7 @@ func (es *ProjectEventstore) CreateProject(ctx context.Context, project *proj_mo
 		return nil, err
 	}

+	es.projectCache.cacheProject(repoProject)
 	return ProjectToModel(repoProject), nil
 }

@@ -56,7 +66,7 @@ func (es *ProjectEventstore) UpdateProject(ctx context.Context, project *proj_mo
 	if !project.IsValid() {
 		return nil, caos_errs.ThrowPreconditionFailed(nil, "EVENT-9dk45", "Name is required")
 	}
-	existingProject, err := es.ProjectByID(ctx, &proj_model.Project{ObjectRoot: models.ObjectRoot{ID: project.ID, Sequence: 0}})
+	existingProject, err := es.ProjectByID(ctx, project.ID)
 	if err != nil {
 		return nil, err
 	}
@@ -69,11 +79,12 @@ func (es *ProjectEventstore) UpdateProject(ctx context.Context, project *proj_mo
 		return nil, err
 	}

+	es.projectCache.cacheProject(repoExisting)
 	return ProjectToModel(repoExisting), nil
 }

 func (es *ProjectEventstore) DeactivateProject(ctx context.Context, id string) (*proj_model.Project, error) {
-	existing, err := es.ProjectByID(ctx, &proj_model.Project{ObjectRoot: models.ObjectRoot{ID: id, Sequence: 0}})
+	existing, err := es.ProjectByID(ctx, id)
 	if err != nil {
 		return nil, err
 	}
@@ -84,11 +95,13 @@ func (es *ProjectEventstore) DeactivateProject(ctx context.Context, id string) (
 	repoExisting := ProjectFromModel(existing)
 	aggregate := ProjectDeactivateAggregate(es.AggregateCreator(), repoExisting)
 	es_sdk.Push(ctx, es.PushAggregates, repoExisting.AppendEvents, aggregate)
+
+	es.projectCache.cacheProject(repoExisting)
 	return ProjectToModel(repoExisting), nil
 }

 func (es *ProjectEventstore) ReactivateProject(ctx context.Context, id string) (*proj_model.Project, error) {
-	existing, err := es.ProjectByID(ctx, &proj_model.Project{ObjectRoot: models.ObjectRoot{ID: id, Sequence: 0}})
+	existing, err := es.ProjectByID(ctx, id)
 	if err != nil {
 		return nil, err
 	}
@@ -99,6 +112,8 @@ func (es *ProjectEventstore) ReactivateProject(ctx context.Context, id string) (
 	repoExisting := ProjectFromModel(existing)
 	aggregate := ProjectReactivateAggregate(es.AggregateCreator(), repoExisting)
 	es_sdk.Push(ctx, es.PushAggregates, repoExisting.AppendEvents, aggregate)
+
+	es.projectCache.cacheProject(repoExisting)
 	return ProjectToModel(repoExisting), nil
 }

@@ -106,7 +121,7 @@ func (es *ProjectEventstore) ProjectMemberByIDs(ctx context.Context, member *pro
 	if member.UserID == "" {
 		return nil, caos_errs.ThrowPreconditionFailed(nil, "EVENT-ld93d", "userID missing")
 	}
-	project, err := es.ProjectByID(ctx, &proj_model.Project{ObjectRoot: models.ObjectRoot{ID: member.ID, Sequence: 0}})
+	project, err := es.ProjectByID(ctx, member.ID)
 	if err != nil {
 		return nil, err
 	}
@@ -122,7 +137,7 @@ func (es *ProjectEventstore) AddProjectMember(ctx context.Context, member *proj_
 	if !member.IsValid() {
 		return nil, caos_errs.ThrowPreconditionFailed(nil, "EVENT-9dk45", "UserID and Roles are required")
 	}
-	existing, err := es.ProjectByID(ctx, &proj_model.Project{ObjectRoot: models.ObjectRoot{ID: member.ID, Sequence: 0}})
+	existing, err := es.ProjectByID(ctx, member.ID)
 	if err != nil {
 		return nil, err
 	}
@@ -134,6 +149,10 @@ func (es *ProjectEventstore) AddProjectMember(ctx context.Context, member *proj_

 	addAggregate := ProjectMemberAddedAggregate(es.Eventstore.AggregateCreator(), repoProject, repoMember)
 	err = es_sdk.Push(ctx, es.PushAggregates, repoProject.AppendEvents, addAggregate)
+	if err != nil {
+		return nil, err
+	}
+	es.projectCache.cacheProject(repoProject)
 	for _, m := range repoProject.Members {
 		if m.UserID == member.UserID {
 			return ProjectMemberToModel(m), nil
@@ -146,7 +165,7 @@ func (es *ProjectEventstore) ChangeProjectMember(ctx context.Context, member *pr
 	if !member.IsValid() {
 		return nil, caos_errs.ThrowPreconditionFailed(nil, "EVENT-9dk45", "UserID and Roles are required")
 	}
-	existing, err := es.ProjectByID(ctx, &proj_model.Project{ObjectRoot: models.ObjectRoot{ID: member.ID, Sequence: 0}})
+	existing, err := es.ProjectByID(ctx, member.ID)
 	if err != nil {
 		return nil, err
 	}
@@ -158,7 +177,7 @@ func (es *ProjectEventstore) ChangeProjectMember(ctx context.Context, member *pr

 	projectAggregate := ProjectMemberChangedAggregate(es.Eventstore.AggregateCreator(), repoProject, repoMember)
 	err = es_sdk.Push(ctx, es.PushAggregates, repoProject.AppendEvents, projectAggregate)
-
+	es.projectCache.cacheProject(repoProject)
 	for _, m := range repoProject.Members {
 		if m.UserID == member.UserID {
 			return ProjectMemberToModel(m), nil
@@ -171,7 +190,7 @@ func (es *ProjectEventstore) RemoveProjectMember(ctx context.Context, member *pr
 	if member.UserID == "" {
 		return caos_errs.ThrowPreconditionFailed(nil, "EVENT-d43fs", "UserID and Roles are required")
 	}
-	existing, err := es.ProjectByID(ctx, &proj_model.Project{ObjectRoot: models.ObjectRoot{ID: member.ID, Sequence: 0}})
+	existing, err := es.ProjectByID(ctx, member.ID)
 	if err != nil {
 		return err
 	}
@@ -183,5 +202,6 @@ func (es *ProjectEventstore) RemoveProjectMember(ctx context.Context, member *pr

 	projectAggregate := ProjectMemberRemovedAggregate(es.Eventstore.AggregateCreator(), repoProject, repoMember)
 	err = es_sdk.Push(ctx, es.PushAggregates, repoProject.AppendEvents, projectAggregate)
+	es.projectCache.cacheProject(repoProject)
 	return err
 }
--- a/internal/project/repository/eventsourcing/eventstore_mock_test.go
+++ b/internal/project/repository/eventsourcing/eventstore_mock_test.go
@@ -2,12 +2,20 @@ package eventsourcing

 import (
 	"encoding/json"
+	mock_cache "github.com/caos/zitadel/internal/cache/mock"
 	"github.com/caos/zitadel/internal/eventstore/mock"
 	es_models "github.com/caos/zitadel/internal/eventstore/models"
 	"github.com/caos/zitadel/internal/project/model"
 	"github.com/golang/mock/gomock"
 )

+func GetMockCache(ctrl *gomock.Controller) *ProjectCache {
+	mockCache := mock_cache.NewMockCache(ctrl)
+	mockCache.EXPECT().Get(gomock.Any(), gomock.Any()).Return(nil).AnyTimes()
+	mockCache.EXPECT().Set(gomock.Any(), gomock.Any()).Return(nil).AnyTimes()
+	return &ProjectCache{projectCache: mockCache}
+}
+
 func GetMockProjectByIDOK(ctrl *gomock.Controller) *ProjectEventstore {
 	data, _ := json.Marshal(Project{Name: "Name"})
 	events := []*es_models.Event{
@@ -15,14 +23,14 @@ func GetMockProjectByIDOK(ctrl *gomock.Controller) *ProjectEventstore {
 	}
 	mockEs := mock.NewMockEventstore(ctrl)
 	mockEs.EXPECT().FilterEvents(gomock.Any(), gomock.Any()).Return(events, nil)
-	return &ProjectEventstore{Eventstore: mockEs}
+	return &ProjectEventstore{Eventstore: mockEs, projectCache: GetMockCache(ctrl)}
 }

 func GetMockProjectByIDNoEvents(ctrl *gomock.Controller) *ProjectEventstore {
 	events := []*es_models.Event{}
 	mockEs := mock.NewMockEventstore(ctrl)
 	mockEs.EXPECT().FilterEvents(gomock.Any(), gomock.Any()).Return(events, nil)
-	return &ProjectEventstore{Eventstore: mockEs}
+	return &ProjectEventstore{Eventstore: mockEs, projectCache: GetMockCache(ctrl)}
 }

 func GetMockManipulateProject(ctrl *gomock.Controller) *ProjectEventstore {
@@ -34,7 +42,7 @@ func GetMockManipulateProject(ctrl *gomock.Controller) *ProjectEventstore {
 	mockEs.EXPECT().FilterEvents(gomock.Any(), gomock.Any()).Return(events, nil)
 	mockEs.EXPECT().AggregateCreator().Return(es_models.NewAggregateCreator("TEST"))
 	mockEs.EXPECT().PushAggregates(gomock.Any(), gomock.Any()).Return(nil)
-	return &ProjectEventstore{Eventstore: mockEs}
+	return &ProjectEventstore{Eventstore: mockEs, projectCache: GetMockCache(ctrl)}
 }

 func GetMockManipulateInactiveProject(ctrl *gomock.Controller) *ProjectEventstore {
@@ -47,7 +55,7 @@ func GetMockManipulateInactiveProject(ctrl *gomock.Controller) *ProjectEventstor
 	mockEs.EXPECT().FilterEvents(gomock.Any(), gomock.Any()).Return(events, nil)
 	mockEs.EXPECT().AggregateCreator().Return(es_models.NewAggregateCreator("TEST"))
 	mockEs.EXPECT().PushAggregates(gomock.Any(), gomock.Any()).Return(nil)
-	return &ProjectEventstore{Eventstore: mockEs}
+	return &ProjectEventstore{Eventstore: mockEs, projectCache: GetMockCache(ctrl)}
 }

 func GetMockManipulateProjectWithMember(ctrl *gomock.Controller) *ProjectEventstore {
@@ -61,7 +69,7 @@ func GetMockManipulateProjectWithMember(ctrl *gomock.Controller) *ProjectEventst
 	mockEs.EXPECT().FilterEvents(gomock.Any(), gomock.Any()).Return(events, nil)
 	mockEs.EXPECT().AggregateCreator().Return(es_models.NewAggregateCreator("TEST"))
 	mockEs.EXPECT().PushAggregates(gomock.Any(), gomock.Any()).Return(nil)
-	return &ProjectEventstore{Eventstore: mockEs}
+	return &ProjectEventstore{Eventstore: mockEs, projectCache: GetMockCache(ctrl)}
 }

 func GetMockManipulateProjectNoEvents(ctrl *gomock.Controller) *ProjectEventstore {
@@ -70,7 +78,7 @@ func GetMockManipulateProjectNoEvents(ctrl *gomock.Controller) *ProjectEventstor
 	mockEs.EXPECT().FilterEvents(gomock.Any(), gomock.Any()).Return(events, nil)
 	mockEs.EXPECT().AggregateCreator().Return(es_models.NewAggregateCreator("TEST"))
 	mockEs.EXPECT().PushAggregates(gomock.Any(), gomock.Any()).Return(nil)
-	return &ProjectEventstore{Eventstore: mockEs}
+	return &ProjectEventstore{Eventstore: mockEs, projectCache: GetMockCache(ctrl)}
 }

 func GetMockProjectMemberByIDsOK(ctrl *gomock.Controller) *ProjectEventstore {
@@ -82,5 +90,5 @@ func GetMockProjectMemberByIDsOK(ctrl *gomock.Controller) *ProjectEventstore {
 	}
 	mockEs := mock.NewMockEventstore(ctrl)
 	mockEs.EXPECT().FilterEvents(gomock.Any(), gomock.Any()).Return(events, nil)
-	return &ProjectEventstore{Eventstore: mockEs}
+	return &ProjectEventstore{Eventstore: mockEs, projectCache: GetMockCache(ctrl)}
 }
--- a/internal/project/repository/eventsourcing/eventstore_test.go
+++ b/internal/project/repository/eventsourcing/eventstore_test.go
@@ -61,7 +61,7 @@ func TestProjectByID(t *testing.T) {
 	}
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
-			result, err := tt.args.es.ProjectByID(nil, tt.args.project)
+			result, err := tt.args.es.ProjectByID(nil, tt.args.project.ID)

 			if !tt.res.wantErr && result.ID != tt.res.project.ID {
 				t.Errorf("got wrong result name: expected: %v, actual: %v ", tt.res.project.ID, result.ID)