mirror of
https://github.com/andwati/zitadel.git
synced 2026-10-18 13:52:51 +00:00
f04d873270
# Which Problems Are Solved This PR implements the endpoints listed in #10445 using relational tables. - [x] UpdateOrganization - [x] ListOrganizations - [x] DeleteOrganization - [x] DeactivateOrganization - [x] ActivateOrganization # How the Problems Are Solved - **UpdateOrganization:** Implemented logic for `Validate()`, `Execute()` and `Events()`. On CQRS side, updating an organization emits events related to the organization and its domains. Separate commanders have been made for the domain events so that their logic is run accordingly and we keep separation of concerns. Implementation of the domains is left to its own ticket. Because some domain-related data is changed during the organization update, its original values are saved as pointers inside [UpdateOrgCommand](https://github.com/zitadel/zitadel/blob/4f87cd8d0cfd75f290aa13c342e4939cecebef73/backend/v3/domain/org_update.go#L20). These variables will be then used as input for the domain commanders (that will run after the update organization one). - **ListOrganizations:** Implemented logic for `Validate()`, `Execute()`. Utility methods have been made to parse the input queries. This commander is used both by the v2 and v2beta endpoint, so a translation layer has been put in place to translate all v2beta requests into v2. The commander strictly handles v2 request only. The translation layer between v2beta and v2 APIs was made so to make it simple to remove it once the v2beta APIs will be removed (a simple deletion should suffice). A `converter` package [is shipped](https://github.com/zitadel/zitadel/blob/4f87cd8d0cfd75f290aa13c342e4939cecebef73/backend/v3/api/org/v2/convert/README.md#L5) as well with instruction for removal. TODOs have been put in place all over the code to indicate that the related piece of code needs to be removed once v2beta -> v2 transition is complete. - **DeleteOrganization:** Implemented logic for `Validate()`, `Execute()` and `Events()`. The `Events()` method is mostly incomplete as it requires a lot of data that is currently not retrievable due to the lack of their relational tables. - **DeactivateOrganization** and **ActivateOrganization**: Implemented logic for `Validate()`, `Execute()` and `Events()`. No notable remarks. 👉 All endpoints return matching errors to the CQRS counterpart: this way allows re-using the integration tests and 👉 All endpoints have been unit-tested through DB mocking 👉 A bunch of TODOs have been put in place for future reworks that are needed (e.g. `Update()` method on repository should also return a timestamp) # Additional Changes - A test utility method to allow mocking query options have been made. This was necessary because `database.QueryOption` is a function and the only comparison possible with functions is `nil` check. So, to mock this, `database.QueryOption` is converted first to `database.QueryOpts`. See 2276742adaef1998ea4844e1f0dca2079e45ccfb - A `BaseCommand` has been created with the idea to collect methods that are going to be needed by other commands. For the moment, it only offers a method to convert query text operations from gRPC to `domain` model. See bb85456dd101282fa76d2e2ad165eed4c8ef61b9 - SQL operations have been reworked to allow for queries using `ContainsIgnoreCase`, `EndsWithIgnoreCase` and other `IgnoreCase` operations. This change is pending approval and might be reworked. See https://github.com/zitadel/zitadel/pull/10704#discussion_r2392886177 # Additional Context `UpdateOrganization` is partially working because the logic for handling domain updates is not done (there is only a draft of the commanders to showcase the call chain). See https://github.com/zitadel/zitadel/pull/10704#discussion_r2356143178 Permissions are not implemented as they are missing. See https://github.com/zitadel/zitadel/pull/10771 - Closes: #10445 --------- Co-authored-by: Silvan <[email protected]>
87 lines
3.9 KiB
Go
87 lines
3.9 KiB
Go
package domain
|
|
|
|
import (
|
|
"context"
|
|
"time"
|
|
|
|
"github.com/zitadel/zitadel/backend/v3/storage/database"
|
|
)
|
|
|
|
type OrganizationDomain struct {
|
|
InstanceID string `json:"instanceId,omitempty" db:"instance_id"`
|
|
OrgID string `json:"orgId,omitempty" db:"org_id"`
|
|
Domain string `json:"domain,omitempty" db:"domain"`
|
|
IsVerified bool `json:"isVerified,omitempty" db:"is_verified"`
|
|
IsPrimary bool `json:"isPrimary,omitempty" db:"is_primary"`
|
|
ValidationType *DomainValidationType `json:"validationType,omitempty" db:"validation_type"`
|
|
|
|
CreatedAt time.Time `json:"createdAt,omitzero" db:"created_at"`
|
|
UpdatedAt time.Time `json:"updatedAt,omitzero" db:"updated_at"`
|
|
}
|
|
|
|
type AddOrganizationDomain struct {
|
|
InstanceID string `json:"instanceId,omitempty" db:"instance_id"`
|
|
OrgID string `json:"orgId,omitempty" db:"org_id"`
|
|
Domain string `json:"domain,omitempty" db:"domain"`
|
|
IsVerified bool `json:"isVerified,omitempty" db:"is_verified"`
|
|
IsPrimary bool `json:"isPrimary,omitempty" db:"is_primary"`
|
|
ValidationType *DomainValidationType `json:"validationType,omitempty" db:"validation_type"`
|
|
|
|
// CreatedAt is the time when the domain was added.
|
|
// It is set by the repository and should not be set by the caller.
|
|
CreatedAt time.Time `json:"createdAt,omitzero" db:"created_at"`
|
|
// UpdatedAt is the time when the domain was added.
|
|
// It is set by the repository and should not be set by the caller.
|
|
UpdatedAt time.Time `json:"updatedAt,omitzero" db:"updated_at"`
|
|
}
|
|
|
|
type organizationDomainColumns interface {
|
|
domainColumns
|
|
// OrgIDColumn returns the column for the org id field.
|
|
OrgIDColumn() database.Column
|
|
// IsVerifiedColumn returns the column for the is verified field.
|
|
IsVerifiedColumn() database.Column
|
|
// ValidationTypeColumn returns the column for the verification type field.
|
|
ValidationTypeColumn() database.Column
|
|
}
|
|
|
|
type organizationDomainConditions interface {
|
|
domainConditions
|
|
// OrgIDCondition returns a filter on the org id field.
|
|
OrgIDCondition(orgID string) database.Condition
|
|
// IsVerifiedCondition returns a filter on the is verified field.
|
|
IsVerifiedCondition(isVerified bool) database.Condition
|
|
}
|
|
|
|
type organizationDomainChanges interface {
|
|
domainChanges
|
|
// SetVerified sets the is verified column to true.
|
|
SetVerified() database.Change
|
|
// SetValidationType sets the verification type column.
|
|
// If the domain is already verified, this is a no-op.
|
|
SetValidationType(verificationType DomainValidationType) database.Change
|
|
}
|
|
|
|
//go:generate mockgen -typed -package domainmock -destination ./mock/org_domain.mock.go . OrganizationDomainRepository
|
|
|
|
type OrganizationDomainRepository interface {
|
|
organizationDomainColumns
|
|
organizationDomainConditions
|
|
organizationDomainChanges
|
|
|
|
// Get returns a single domain based on the criteria.
|
|
// If no domain is found, it returns an error of type [database.ErrNotFound].
|
|
// If multiple domains are found, it returns an error of type [database.ErrMultipleRows].
|
|
Get(ctx context.Context, client database.QueryExecutor, opts ...database.QueryOption) (*OrganizationDomain, error)
|
|
// List returns a list of domains based on the criteria.
|
|
// If no domains are found, it returns an empty slice.
|
|
List(ctx context.Context, client database.QueryExecutor, opts ...database.QueryOption) ([]*OrganizationDomain, error)
|
|
|
|
// Add adds a new domain to the organization.
|
|
Add(ctx context.Context, client database.QueryExecutor, domain *AddOrganizationDomain) error
|
|
// Update updates an existing domain in the organization.
|
|
Update(ctx context.Context, client database.QueryExecutor, condition database.Condition, changes ...database.Change) (int64, error)
|
|
// Remove removes a domain from the organization.
|
|
Remove(ctx context.Context, client database.QueryExecutor, condition database.Condition) (int64, error)
|
|
}
|