mirror of
https://github.com/zitadel/zitadel.git
synced 2025-12-24 04:36:48 +00:00
cccfc816f6
This pull request introduces a significant refactoring of the database interaction layer, focusing on improving explicitness, transactional control, and error handling. The core change is the removal of the stateful `QueryExecutor` from repository instances. Instead, it is now passed as an argument to each method that interacts with the database. This change makes transaction management more explicit and flexible, as the same repository instance can be used with a database pool or a specific transaction without needing to be re-instantiated. ### Key Changes - **Explicit `QueryExecutor` Passing:** - All repository methods (`Get`, `List`, `Create`, `Update`, `Delete`, etc.) in `InstanceRepository`, `OrganizationRepository`, `UserRepository`, and their sub-repositories now require a `database.QueryExecutor` (e.g., a `*pgxpool.Pool` or `pgx.Tx`) as the first argument. - Repository constructors no longer accept a `QueryExecutor`. For example, `repository.InstanceRepository(pool)` is now `repository.InstanceRepository()`. - **Enhanced Error Handling:** - A new `database.MissingConditionError` is introduced to enforce required query conditions, such as ensuring an `instance_id` is always present in `UPDATE` and `DELETE` operations. - The database error wrapper in the `postgres` package now correctly identifies and wraps `pgx.ErrTooManyRows` and similar errors from the `scany` library into a `database.MultipleRowsFoundError`. - **Improved Database Conditions:** - The `database.Condition` interface now includes a `ContainsColumn(Column) bool` method. This allows for runtime checks to ensure that critical filters (like `instance_id`) are included in a query, preventing accidental cross-tenant data modification. - A new `database.Exists()` condition has been added to support `EXISTS` subqueries, enabling more complex filtering logic, such as finding an organization that has a specific domain. - **Repository and Interface Refactoring:** - The method for loading related entities (e.g., domains for an organization) has been changed from a boolean flag (`Domains(true)`) to a more explicit, chainable method (`LoadDomains()`). This returns a new repository instance configured to load the sub-resource, promoting immutability. - The custom `OrgIdentifierCondition` has been removed in favor of using the standard `database.Condition` interface, simplifying the API. - **Code Cleanup and Test Updates:** - Unnecessary struct embeddings and metadata have been removed. - All integration and repository tests have been updated to reflect the new method signatures, passing the database pool or transaction object explicitly. - New tests have been added to cover the new `ExistsDomain` functionality and other enhancements. These changes make the data access layer more robust, predictable, and easier to work with, especially in the context of database transactions.
85 lines
3.8 KiB
Go
85 lines
3.8 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
|
|
}
|
|
|
|
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)
|
|
}
|