mirror of
https://github.com/zitadel/zitadel.git
synced 2025-12-23 12:16:42 +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.
84 lines
2.0 KiB
Go
84 lines
2.0 KiB
Go
package database
|
|
|
|
import (
|
|
"encoding/hex"
|
|
"strconv"
|
|
"strings"
|
|
)
|
|
|
|
type Instruction string
|
|
|
|
const (
|
|
DefaultInstruction Instruction = "DEFAULT"
|
|
NowInstruction Instruction = "NOW()"
|
|
NullInstruction Instruction = "NULL"
|
|
)
|
|
|
|
// StatementBuilder is a helper to build SQL statement.
|
|
type StatementBuilder struct {
|
|
strings.Builder
|
|
args []any
|
|
existingArgs map[any]string
|
|
}
|
|
|
|
type argWriter interface {
|
|
WriteArg(builder *StatementBuilder)
|
|
}
|
|
|
|
// WriteArgs adds the argument to the statement and writes the placeholder to the query.
|
|
func (b *StatementBuilder) WriteArg(arg any) {
|
|
if writer, ok := arg.(argWriter); ok {
|
|
writer.WriteArg(b)
|
|
return
|
|
}
|
|
b.WriteString(b.AppendArg(arg))
|
|
}
|
|
|
|
// WriteArgs adds the arguments to the statement and writes the placeholders to the query.
|
|
// The placeholders are comma separated.
|
|
func (b *StatementBuilder) WriteArgs(args ...any) {
|
|
for i, arg := range args {
|
|
if i > 0 {
|
|
b.WriteString(", ")
|
|
}
|
|
b.WriteArg(arg)
|
|
}
|
|
}
|
|
|
|
// AppendArg adds the argument to the statement and returns the placeholder.
|
|
func (b *StatementBuilder) AppendArg(arg any) (placeholder string) {
|
|
if b.existingArgs == nil {
|
|
b.existingArgs = make(map[any]string)
|
|
}
|
|
// the key is used to work around the following panic:
|
|
// runtime error: hash of unhashable type []uint8
|
|
key := arg
|
|
if argBytes, ok := arg.([]uint8); ok {
|
|
key = `\\bytes-` + hex.EncodeToString(argBytes)
|
|
}
|
|
if placeholder, ok := b.existingArgs[key]; ok {
|
|
return placeholder
|
|
}
|
|
if instruction, ok := arg.(Instruction); ok {
|
|
return string(instruction)
|
|
}
|
|
|
|
b.args = append(b.args, arg)
|
|
placeholder = "$" + strconv.Itoa(len(b.args))
|
|
b.existingArgs[key] = placeholder
|
|
return placeholder
|
|
}
|
|
|
|
// AppendArgs adds the arguments to the statement and doesn't return the placeholders.
|
|
// If an argument is already added, it will not be added again.
|
|
func (b *StatementBuilder) AppendArgs(args ...any) {
|
|
for _, arg := range args {
|
|
b.AppendArg(arg)
|
|
}
|
|
}
|
|
|
|
// Args returns the arguments added to the statement.
|
|
func (b *StatementBuilder) Args() []any {
|
|
return b.args
|
|
}
|