mirror of
https://github.com/zitadel/zitadel.git
synced 2025-12-24 03:47:09 +00:00
This PR initiates the rework of Zitadel's backend to state-persisted objects. This change is a step towards a more scalable and maintainable architecture. ## Changes * **New `/backend/v3` package**: A new package structure has been introduced to house the reworked backend logic. This includes: * `domain`: Contains the core business logic, commands, and repository interfaces. * `storage`: Implements the repository interfaces for database interactions with new transactional tables. * `telemetry`: Provides logging and tracing capabilities. * **Transactional Tables**: New database tables have been defined for `instances`, `instance_domains`, `organizations`, and `org_domains`. * **Projections**: New projections have been created to populate the new relational tables from the existing event store, ensuring data consistency during the migration. * **Repositories**: New repositories provide an abstraction layer for accessing and manipulating the data in the new tables. * **Setup**: A new setup step for `TransactionalTables` has been added to manage the database migrations for the new tables. This PR lays the foundation for future work to fully transition to state-persisted objects for these components, which will improve performance and simplify data access patterns. This PR initiates the rework of ZITADEL's backend to state-persisted objects. This is a foundational step towards a new architecture that will improve performance and maintainability. The following objects are migrated from event-sourced aggregates to state-persisted objects: * Instances * incl. Domains * Orgs * incl. Domains The structure of the new backend implementation follows the software architecture defined in this [wiki page](https://github.com/zitadel/zitadel/wiki/Software-Architecturel). This PR includes: * The initial implementation of the new transactional repositories for the objects listed above. * Projections to populate the new relational tables from the existing event store. * Adjustments to the build and test process to accommodate the new backend structure. This is a work in progress and further changes will be made to complete the migration. --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: Iraq Jaber <iraq+github@zitadel.com> Co-authored-by: Iraq <66622793+kkrime@users.noreply.github.com> Co-authored-by: Tim Möhlmann <tim+github@zitadel.com>
163 lines
5.4 KiB
Go
163 lines
5.4 KiB
Go
//go:build integration
|
|
|
|
package events_test
|
|
|
|
import (
|
|
"testing"
|
|
"time"
|
|
|
|
"github.com/brianvoe/gofakeit/v6"
|
|
"github.com/stretchr/testify/assert"
|
|
"github.com/stretchr/testify/require"
|
|
|
|
"github.com/zitadel/zitadel/backend/v3/storage/database"
|
|
"github.com/zitadel/zitadel/backend/v3/storage/database/repository"
|
|
"github.com/zitadel/zitadel/internal/integration"
|
|
"github.com/zitadel/zitadel/pkg/grpc/system"
|
|
)
|
|
|
|
func TestServer_TestInstanceReduces(t *testing.T) {
|
|
instanceRepo := repository.InstanceRepository(pool)
|
|
|
|
t.Run("test instance add reduces", func(t *testing.T) {
|
|
instanceName := gofakeit.Name()
|
|
beforeCreate := time.Now()
|
|
instance, err := SystemClient.CreateInstance(CTX, &system.CreateInstanceRequest{
|
|
InstanceName: instanceName,
|
|
Owner: &system.CreateInstanceRequest_Machine_{
|
|
Machine: &system.CreateInstanceRequest_Machine{
|
|
UserName: "owner",
|
|
Name: "owner",
|
|
PersonalAccessToken: &system.CreateInstanceRequest_PersonalAccessToken{},
|
|
},
|
|
},
|
|
})
|
|
afterCreate := time.Now()
|
|
|
|
require.NoError(t, err)
|
|
t.Cleanup(func() {
|
|
_, err = SystemClient.RemoveInstance(CTX, &system.RemoveInstanceRequest{
|
|
InstanceId: instance.GetInstanceId(),
|
|
})
|
|
if err != nil {
|
|
t.Logf("Failed to delete instance on cleanup: %v", err)
|
|
}
|
|
})
|
|
|
|
retryDuration, tick := integration.WaitForAndTickWithMaxDuration(CTX, time.Minute)
|
|
assert.EventuallyWithT(t, func(ttt *assert.CollectT) {
|
|
instance, err := instanceRepo.Get(CTX,
|
|
database.WithCondition(instanceRepo.IDCondition(instance.GetInstanceId())),
|
|
)
|
|
require.NoError(ttt, err)
|
|
// event instance.added
|
|
assert.Equal(ttt, instanceName, instance.Name)
|
|
// event instance.default.org.set
|
|
assert.NotNil(t, instance.DefaultOrgID)
|
|
// event instance.iam.project.set
|
|
assert.NotNil(t, instance.IAMProjectID)
|
|
// event instance.iam.console.set
|
|
assert.NotNil(t, instance.ConsoleAppID)
|
|
// event instance.default.language.set
|
|
assert.NotNil(t, instance.DefaultLanguage)
|
|
// event instance.added
|
|
assert.WithinRange(t, instance.CreatedAt, beforeCreate, afterCreate)
|
|
// event instance.added
|
|
assert.WithinRange(t, instance.UpdatedAt, beforeCreate, afterCreate)
|
|
}, retryDuration, tick)
|
|
})
|
|
|
|
t.Run("test instance update reduces", func(t *testing.T) {
|
|
instanceName := gofakeit.Name()
|
|
res, err := SystemClient.CreateInstance(CTX, &system.CreateInstanceRequest{
|
|
InstanceName: instanceName,
|
|
Owner: &system.CreateInstanceRequest_Machine_{
|
|
Machine: &system.CreateInstanceRequest_Machine{
|
|
UserName: "owner",
|
|
Name: "owner",
|
|
PersonalAccessToken: &system.CreateInstanceRequest_PersonalAccessToken{},
|
|
},
|
|
},
|
|
})
|
|
require.NoError(t, err)
|
|
t.Cleanup(func() {
|
|
_, err = SystemClient.RemoveInstance(CTX, &system.RemoveInstanceRequest{
|
|
InstanceId: res.GetInstanceId(),
|
|
})
|
|
if err != nil {
|
|
t.Logf("Failed to delete instance on cleanup: %v", err)
|
|
}
|
|
})
|
|
|
|
// check instance exists
|
|
retryDuration, tick := integration.WaitForAndTickWithMaxDuration(CTX, time.Minute)
|
|
assert.EventuallyWithT(t, func(t *assert.CollectT) {
|
|
instance, err := instanceRepo.Get(CTX,
|
|
database.WithCondition(instanceRepo.IDCondition(res.GetInstanceId())),
|
|
)
|
|
require.NoError(t, err)
|
|
assert.Equal(t, instanceName, instance.Name)
|
|
}, retryDuration, tick)
|
|
|
|
instanceName += "new"
|
|
beforeUpdate := time.Now()
|
|
_, err = SystemClient.UpdateInstance(CTX, &system.UpdateInstanceRequest{
|
|
InstanceId: res.InstanceId,
|
|
InstanceName: instanceName,
|
|
})
|
|
afterUpdate := time.Now()
|
|
require.NoError(t, err)
|
|
|
|
retryDuration, tick = integration.WaitForAndTickWithMaxDuration(CTX, time.Minute)
|
|
assert.EventuallyWithT(t, func(t *assert.CollectT) {
|
|
instance, err := instanceRepo.Get(CTX,
|
|
database.WithCondition(instanceRepo.IDCondition(res.GetInstanceId())),
|
|
)
|
|
require.NoError(t, err)
|
|
// event instance.changed
|
|
assert.Equal(t, instanceName, instance.Name)
|
|
assert.WithinRange(t, instance.UpdatedAt, beforeUpdate, afterUpdate)
|
|
}, retryDuration, tick)
|
|
})
|
|
|
|
t.Run("test instance delete reduces", func(t *testing.T) {
|
|
instanceName := gofakeit.Name()
|
|
res, err := SystemClient.CreateInstance(CTX, &system.CreateInstanceRequest{
|
|
InstanceName: instanceName,
|
|
Owner: &system.CreateInstanceRequest_Machine_{
|
|
Machine: &system.CreateInstanceRequest_Machine{
|
|
UserName: "owner",
|
|
Name: "owner",
|
|
PersonalAccessToken: &system.CreateInstanceRequest_PersonalAccessToken{},
|
|
},
|
|
},
|
|
})
|
|
require.NoError(t, err)
|
|
|
|
// check instance exists
|
|
retryDuration, tick := integration.WaitForAndTickWithMaxDuration(CTX, time.Minute)
|
|
assert.EventuallyWithT(t, func(t *assert.CollectT) {
|
|
instance, err := instanceRepo.Get(CTX,
|
|
database.WithCondition(instanceRepo.IDCondition(res.GetInstanceId())),
|
|
)
|
|
require.NoError(t, err)
|
|
assert.Equal(t, instanceName, instance.Name)
|
|
}, retryDuration, tick)
|
|
|
|
_, err = SystemClient.RemoveInstance(CTX, &system.RemoveInstanceRequest{
|
|
InstanceId: res.InstanceId,
|
|
})
|
|
require.NoError(t, err)
|
|
|
|
retryDuration, tick = integration.WaitForAndTickWithMaxDuration(CTX, time.Minute)
|
|
assert.EventuallyWithT(t, func(t *assert.CollectT) {
|
|
instance, err := instanceRepo.Get(CTX,
|
|
database.WithCondition(instanceRepo.IDCondition(res.GetInstanceId())),
|
|
)
|
|
// event instance.removed
|
|
assert.Nil(t, instance)
|
|
require.ErrorIs(t, err, new(database.NoRowFoundError))
|
|
}, retryDuration, tick)
|
|
})
|
|
}
|