feat: instance domain APIs with relational tables (#11051)

# Which Problems Are Solved

This PR implements the endpoints listed in
https://github.com/zitadel/zitadel/issues/10444 .

# How the Problems Are Solved

The implementation follows the same pattern as the Instance one. The
`Add` and `Remove` are implementing the `Commander` interface, while
`List` Domains endpoints are implementing the `Querier` interace.

The PR adds also some forgotten calls to the relational logic for the
Instance API. The commits are identifiable by the label `instance:`
prepended to them. This is the complete list: bafce01b0 , 6fe7257ab ,
e27bc9c34 , 8133ede73 , fde667953 , a3e1135ed , ee1a6f9c1

# Additional Context

- Closes #10444

---------

Co-authored-by: Elio Bischof <[email protected]>
Co-authored-by: Lebogang Phoshoko <[email protected]>
Co-authored-by: Wim Van Laer <[email protected]>
Co-authored-by: Max Peintner <[email protected]>
Co-authored-by: Gayathri Vijayan <[email protected]>
This commit is contained in:
Marco A.
2025-12-17 12:01:09 +01:00
committed by GitHub
co-authored by Elio Bischof Lebogang Phoshoko Wim Van Laer Max Peintner Gayathri Vijayan
parent d79bfe6eba
commit b339a3e696
49 changed files with 5670 additions and 1466 deletions
+113 -26
View File
@@ -2,61 +2,62 @@ package instancev2
import (
"context"
"errors"
"connectrpc.com/connect"
"google.golang.org/protobuf/types/known/timestamppb"
"github.com/zitadel/zitadel/backend/v3/api/instance/v2/convert"
"github.com/zitadel/zitadel/backend/v3/domain"
"github.com/zitadel/zitadel/backend/v3/storage/database"
"github.com/zitadel/zitadel/backend/v3/storage/database/repository"
"github.com/zitadel/zitadel/internal/zerrors"
filter "github.com/zitadel/zitadel/pkg/grpc/filter/v2beta"
instance "github.com/zitadel/zitadel/pkg/grpc/instance/v2beta"
filter_v2 "github.com/zitadel/zitadel/pkg/grpc/filter/v2"
filter_v2beta "github.com/zitadel/zitadel/pkg/grpc/filter/v2beta"
instance_v2 "github.com/zitadel/zitadel/pkg/grpc/instance/v2"
instance_v2beta "github.com/zitadel/zitadel/pkg/grpc/instance/v2beta"
)
func DeleteInstance(ctx context.Context, request *connect.Request[instance.DeleteInstanceRequest]) (*connect.Response[instance.DeleteInstanceResponse], error) {
// =================
// v2Beta endpoints
// =================
func DeleteInstanceBeta(ctx context.Context, request *connect.Request[instance_v2beta.DeleteInstanceRequest]) (*connect.Response[instance_v2beta.DeleteInstanceResponse], error) {
instanceDeleteCmd := domain.NewDeleteInstanceCommand(request.Msg.GetInstanceId())
err := domain.Invoke(ctx, instanceDeleteCmd, domain.WithInstanceRepo(repository.InstanceRepository()))
if err != nil {
if errors.Is(err, &database.NoRowFoundError{}) {
return nil, zerrors.ThrowNotFound(err, "INST-QVrUwc", "instance not found")
}
return nil, err
}
return &connect.Response[instance.DeleteInstanceResponse]{
Msg: &instance.DeleteInstanceResponse{
var deletionDate *timestamppb.Timestamp
if instanceDeleteCmd.DeleteTime != nil {
deletionDate = timestamppb.New(*instanceDeleteCmd.DeleteTime)
}
return &connect.Response[instance_v2beta.DeleteInstanceResponse]{
Msg: &instance_v2beta.DeleteInstanceResponse{
// TODO(IAM-Marco): Change this with the real update date when OrganizationRepo.Update()
// returns the timestamp
DeletionDate: timestamppb.Now(),
DeletionDate: deletionDate,
},
}, nil
}
func GetInstance(ctx context.Context, request *connect.Request[instance.GetInstanceRequest]) (*connect.Response[instance.GetInstanceResponse], error) {
func GetInstanceBeta(ctx context.Context, request *connect.Request[instance_v2beta.GetInstanceRequest]) (*connect.Response[instance_v2beta.GetInstanceResponse], error) {
instanceGetCmd := domain.NewGetInstanceCommand(request.Msg.GetInstanceId())
err := domain.Invoke(ctx, instanceGetCmd, domain.WithInstanceRepo(repository.InstanceRepository()))
if err != nil {
if errors.Is(err, &database.NoRowFoundError{}) {
return nil, zerrors.ThrowNotFound(err, "INST-QVrUwc", "instance not found")
}
return nil, err
}
return &connect.Response[instance.GetInstanceResponse]{
Msg: &instance.GetInstanceResponse{
Instance: convert.DomainInstanceModelToGRPCResponse(instanceGetCmd.Result()),
return &connect.Response[instance_v2beta.GetInstanceResponse]{
Msg: &instance_v2beta.GetInstanceResponse{
Instance: convert.DomainInstanceModelToGRPCBetaResponse(instanceGetCmd.Result()),
},
}, nil
}
func UpdateInstance(ctx context.Context, request *connect.Request[instance.UpdateInstanceRequest]) (*connect.Response[instance.UpdateInstanceResponse], error) {
func UpdateInstanceBeta(ctx context.Context, request *connect.Request[instance_v2beta.UpdateInstanceRequest]) (*connect.Response[instance_v2beta.UpdateInstanceResponse], error) {
instanceUpdateCmd := domain.NewUpdateInstanceCommand(request.Msg.GetInstanceId(), request.Msg.GetInstanceName())
err := domain.Invoke(ctx, instanceUpdateCmd, domain.WithInstanceRepo(repository.InstanceRepository()))
@@ -65,8 +66,8 @@ func UpdateInstance(ctx context.Context, request *connect.Request[instance.Updat
return nil, err
}
return &connect.Response[instance.UpdateInstanceResponse]{
Msg: &instance.UpdateInstanceResponse{
return &connect.Response[instance_v2beta.UpdateInstanceResponse]{
Msg: &instance_v2beta.UpdateInstanceResponse{
// TODO(IAM-Marco): Change this with the real update date when InstanceRepo.Update()
// returns the timestamp
ChangeDate: timestamppb.Now(),
@@ -74,7 +75,93 @@ func UpdateInstance(ctx context.Context, request *connect.Request[instance.Updat
}, nil
}
func ListInstances(ctx context.Context, request *connect.Request[instance.ListInstancesRequest]) (*connect.Response[instance.ListInstancesResponse], error) {
func ListInstancesBeta(ctx context.Context, request *connect.Request[instance_v2beta.ListInstancesRequest]) (*connect.Response[instance_v2beta.ListInstancesResponse], error) {
instancesListCmd := domain.NewListInstancesCommand(convert.ListInstancesBetaRequestToV2Request(request.Msg))
err := domain.Invoke(
ctx,
instancesListCmd,
domain.WithInstanceRepo(repository.InstanceRepository()),
domain.WithInstanceDomainRepo(repository.InstanceDomainRepository()),
)
if err != nil {
return nil, err
}
instances := instancesListCmd.Result()
return &connect.Response[instance_v2beta.ListInstancesResponse]{
Msg: &instance_v2beta.ListInstancesResponse{
Instances: convert.DomainInstanceListModelToGRPCBetaResponse(instances),
Pagination: &filter_v2beta.PaginationResponse{
// TODO(IAM-Marco): return correct value. Tracked in https://github.com/zitadel/zitadel/issues/10955
TotalResult: uint64(len(instances)),
AppliedLimit: uint64(request.Msg.GetPagination().GetLimit()),
},
},
}, nil
}
// =================
// v2 endpoints
// =================
func DeleteInstance(ctx context.Context, request *connect.Request[instance_v2.DeleteInstanceRequest]) (*connect.Response[instance_v2.DeleteInstanceResponse], error) {
instanceDeleteCmd := domain.NewDeleteInstanceCommand(request.Msg.GetInstanceId())
err := domain.Invoke(ctx, instanceDeleteCmd, domain.WithInstanceRepo(repository.InstanceRepository()))
if err != nil {
return nil, err
}
var deletionDate *timestamppb.Timestamp
if instanceDeleteCmd.DeleteTime != nil {
deletionDate = timestamppb.New(*instanceDeleteCmd.DeleteTime)
}
return &connect.Response[instance_v2.DeleteInstanceResponse]{
Msg: &instance_v2.DeleteInstanceResponse{
// TODO(IAM-Marco): Change this with the real update date when OrganizationRepo.Update()
// returns the timestamp
DeletionDate: deletionDate,
},
}, nil
}
func GetInstance(ctx context.Context, request *connect.Request[instance_v2.GetInstanceRequest]) (*connect.Response[instance_v2.GetInstanceResponse], error) {
instanceGetCmd := domain.NewGetInstanceCommand(request.Msg.GetInstanceId())
err := domain.Invoke(ctx, instanceGetCmd, domain.WithInstanceRepo(repository.InstanceRepository()))
if err != nil {
return nil, err
}
return &connect.Response[instance_v2.GetInstanceResponse]{
Msg: &instance_v2.GetInstanceResponse{
Instance: convert.DomainInstanceModelToGRPCResponse(instanceGetCmd.Result()),
},
}, nil
}
func UpdateInstance(ctx context.Context, request *connect.Request[instance_v2.UpdateInstanceRequest]) (*connect.Response[instance_v2.UpdateInstanceResponse], error) {
instanceUpdateCmd := domain.NewUpdateInstanceCommand(request.Msg.GetInstanceId(), request.Msg.GetInstanceName())
err := domain.Invoke(ctx, instanceUpdateCmd, domain.WithInstanceRepo(repository.InstanceRepository()))
if err != nil {
return nil, err
}
return &connect.Response[instance_v2.UpdateInstanceResponse]{
Msg: &instance_v2.UpdateInstanceResponse{
// TODO(IAM-Marco): Change this with the real update date when InstanceRepo.Update()
// returns the timestamp
ChangeDate: timestamppb.Now(),
},
}, nil
}
func ListInstances(ctx context.Context, request *connect.Request[instance_v2.ListInstancesRequest]) (*connect.Response[instance_v2.ListInstancesResponse], error) {
instancesListCmd := domain.NewListInstancesCommand(request.Msg)
err := domain.Invoke(
@@ -88,10 +175,10 @@ func ListInstances(ctx context.Context, request *connect.Request[instance.ListIn
}
instances := instancesListCmd.Result()
return &connect.Response[instance.ListInstancesResponse]{
Msg: &instance.ListInstancesResponse{
return &connect.Response[instance_v2.ListInstancesResponse]{
Msg: &instance_v2.ListInstancesResponse{
Instances: convert.DomainInstanceListModelToGRPCResponse(instances),
Pagination: &filter.PaginationResponse{
Pagination: &filter_v2.PaginationResponse{
// TODO(IAM-Marco): return correct value. Tracked in https://github.com/zitadel/zitadel/issues/10955
TotalResult: uint64(len(instances)),
AppliedLimit: uint64(request.Msg.GetPagination().GetLimit()),