2025-09-05 10:54:34 +02:00
|
|
|
package sql
|
|
|
|
|
|
|
|
|
|
import (
|
|
|
|
|
"context"
|
|
|
|
|
"database/sql"
|
|
|
|
|
|
|
|
|
|
"github.com/zitadel/zitadel/backend/v3/storage/database"
|
|
|
|
|
)
|
|
|
|
|
|
|
|
|
|
type sqlConn struct {
|
|
|
|
|
*sql.Conn
|
|
|
|
|
}
|
|
|
|
|
|
fix(eventstore): Make Eventstore Compatible with Relational Table Package (#10687)
Improves compatibility of eventstore and related database components
with the new relational table package.
## Which problems are solved
1. **Incompatible Database Interfaces**: The existing eventstore was
tightly coupled to the database package, which is incompatible with the
new, more abstract relational table package in v3. This prevented the
new command-side logic from pushing events to the legacy eventstore.
2. **Missing Health Checks**: The database interfaces in the new package
lacked a Ping method, making it impossible to perform health checks on
database connections.
3. **Event Publishing Logic**: The command handling logic in domain
needed a way to collect and push events to the legacy eventstore after a
command was successfully executed.
## How the problems are solved
1. **`LegacyEventstore` Interface**:
* A new `LegacyEventstore` interface is introduced in the new
`database/eventstore` . This interface exposes a `PushWithNewClient`
method that accepts the new `database.QueryExecutor` interface,
decoupling the v3 domain from the legacy implementation.
* The `internal/eventstore.Eventstore` now implements this interface. A
wrapper, PushWithClient, is added to convert the old database client
types (`*sql.DB`, `*sql.Tx`) into the new `QueryExecutor` types before
calling `PushWithNewClient`.
2. **Database Interface Updates**:
* The `database.Pool` and `database.Client` interfaces in
`storage/eventstore` have been updated to include a Ping method,
allowing for consistent health checks across different database
dialects.
* The `postgres` and `sql` dialect implementations have been updated to
support this new method.
3. **Command and Invoker Refactoring**:
* The `Commander` interface in domain now includes an `Events()
[]legacy_es.Command` method. This allows commands to declare which
events they will generate.
* The `eventCollector` in the invoker logic has been redesigned. It now
ensures a database transaction is started before executing a command.
After successful execution, it calls the `Events()` method on the
command to collect the generated events and appends them to a list.
* The `eventStoreInvoker` then pushes all collected events to the legacy
eventstore using the new `LegacyEventstore` interface, ensuring that
events are only pushed if the entire command (and any sub-commands)
executes successfully within the transaction.
4. **Testing**:
* New unit tests have been added for the invoker to verify that events
are correctly collected from single commands, batched commands, and
nested commands.
These changes create a clean bridge between the new v3 command-side
logic and the existing v1 eventstore, allowing for incremental adoption
of the new architecture while maintaining full functionality.
## Additional Information
closes https://github.com/zitadel/zitadel/issues/10442
2025-09-16 18:58:49 +02:00
|
|
|
func SQLConn(conn *sql.Conn) database.Client {
|
|
|
|
|
return &sqlConn{Conn: conn}
|
|
|
|
|
}
|
|
|
|
|
|
2025-09-05 10:54:34 +02:00
|
|
|
var _ database.Client = (*sqlConn)(nil)
|
|
|
|
|
|
|
|
|
|
// Release implements [database.Client].
|
|
|
|
|
func (c *sqlConn) Release(_ context.Context) error {
|
|
|
|
|
return c.Close()
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// Begin implements [database.Client].
|
|
|
|
|
func (c *sqlConn) Begin(ctx context.Context, opts *database.TransactionOptions) (database.Transaction, error) {
|
|
|
|
|
tx, err := c.BeginTx(ctx, transactionOptionsToSQL(opts))
|
|
|
|
|
if err != nil {
|
|
|
|
|
return nil, wrapError(err)
|
|
|
|
|
}
|
fix(eventstore): Make Eventstore Compatible with Relational Table Package (#10687)
Improves compatibility of eventstore and related database components
with the new relational table package.
## Which problems are solved
1. **Incompatible Database Interfaces**: The existing eventstore was
tightly coupled to the database package, which is incompatible with the
new, more abstract relational table package in v3. This prevented the
new command-side logic from pushing events to the legacy eventstore.
2. **Missing Health Checks**: The database interfaces in the new package
lacked a Ping method, making it impossible to perform health checks on
database connections.
3. **Event Publishing Logic**: The command handling logic in domain
needed a way to collect and push events to the legacy eventstore after a
command was successfully executed.
## How the problems are solved
1. **`LegacyEventstore` Interface**:
* A new `LegacyEventstore` interface is introduced in the new
`database/eventstore` . This interface exposes a `PushWithNewClient`
method that accepts the new `database.QueryExecutor` interface,
decoupling the v3 domain from the legacy implementation.
* The `internal/eventstore.Eventstore` now implements this interface. A
wrapper, PushWithClient, is added to convert the old database client
types (`*sql.DB`, `*sql.Tx`) into the new `QueryExecutor` types before
calling `PushWithNewClient`.
2. **Database Interface Updates**:
* The `database.Pool` and `database.Client` interfaces in
`storage/eventstore` have been updated to include a Ping method,
allowing for consistent health checks across different database
dialects.
* The `postgres` and `sql` dialect implementations have been updated to
support this new method.
3. **Command and Invoker Refactoring**:
* The `Commander` interface in domain now includes an `Events()
[]legacy_es.Command` method. This allows commands to declare which
events they will generate.
* The `eventCollector` in the invoker logic has been redesigned. It now
ensures a database transaction is started before executing a command.
After successful execution, it calls the `Events()` method on the
command to collect the generated events and appends them to a list.
* The `eventStoreInvoker` then pushes all collected events to the legacy
eventstore using the new `LegacyEventstore` interface, ensuring that
events are only pushed if the entire command (and any sub-commands)
executes successfully within the transaction.
4. **Testing**:
* New unit tests have been added for the invoker to verify that events
are correctly collected from single commands, batched commands, and
nested commands.
These changes create a clean bridge between the new v3 command-side
logic and the existing v1 eventstore, allowing for incremental adoption
of the new architecture while maintaining full functionality.
## Additional Information
closes https://github.com/zitadel/zitadel/issues/10442
2025-09-16 18:58:49 +02:00
|
|
|
return &Transaction{tx}, nil
|
2025-09-05 10:54:34 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// Query implements sql.Client.
|
|
|
|
|
// Subtle: this method shadows the method (*Conn).Query of pgxConn.Conn.
|
|
|
|
|
func (c *sqlConn) Query(ctx context.Context, sql string, args ...any) (database.Rows, error) {
|
|
|
|
|
//nolint:rowserrcheck // Rows.Close is called by the caller
|
|
|
|
|
rows, err := c.QueryContext(ctx, sql, args...)
|
|
|
|
|
if err != nil {
|
|
|
|
|
return nil, wrapError(err)
|
|
|
|
|
}
|
|
|
|
|
return &Rows{rows}, nil
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// QueryRow implements sql.Client.
|
|
|
|
|
// Subtle: this method shadows the method (*Conn).QueryRow of pgxConn.Conn.
|
|
|
|
|
func (c *sqlConn) QueryRow(ctx context.Context, sql string, args ...any) database.Row {
|
|
|
|
|
return &Row{c.QueryRowContext(ctx, sql, args...)}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// Exec implements [database.Pool].
|
|
|
|
|
// Subtle: this method shadows the method (Pool).Exec of pgxPool.Pool.
|
|
|
|
|
func (c *sqlConn) Exec(ctx context.Context, sql string, args ...any) (int64, error) {
|
|
|
|
|
res, err := c.ExecContext(ctx, sql, args...)
|
|
|
|
|
if err != nil {
|
|
|
|
|
return 0, wrapError(err)
|
|
|
|
|
}
|
|
|
|
|
return res.RowsAffected()
|
|
|
|
|
}
|
|
|
|
|
|
fix(eventstore): Make Eventstore Compatible with Relational Table Package (#10687)
Improves compatibility of eventstore and related database components
with the new relational table package.
## Which problems are solved
1. **Incompatible Database Interfaces**: The existing eventstore was
tightly coupled to the database package, which is incompatible with the
new, more abstract relational table package in v3. This prevented the
new command-side logic from pushing events to the legacy eventstore.
2. **Missing Health Checks**: The database interfaces in the new package
lacked a Ping method, making it impossible to perform health checks on
database connections.
3. **Event Publishing Logic**: The command handling logic in domain
needed a way to collect and push events to the legacy eventstore after a
command was successfully executed.
## How the problems are solved
1. **`LegacyEventstore` Interface**:
* A new `LegacyEventstore` interface is introduced in the new
`database/eventstore` . This interface exposes a `PushWithNewClient`
method that accepts the new `database.QueryExecutor` interface,
decoupling the v3 domain from the legacy implementation.
* The `internal/eventstore.Eventstore` now implements this interface. A
wrapper, PushWithClient, is added to convert the old database client
types (`*sql.DB`, `*sql.Tx`) into the new `QueryExecutor` types before
calling `PushWithNewClient`.
2. **Database Interface Updates**:
* The `database.Pool` and `database.Client` interfaces in
`storage/eventstore` have been updated to include a Ping method,
allowing for consistent health checks across different database
dialects.
* The `postgres` and `sql` dialect implementations have been updated to
support this new method.
3. **Command and Invoker Refactoring**:
* The `Commander` interface in domain now includes an `Events()
[]legacy_es.Command` method. This allows commands to declare which
events they will generate.
* The `eventCollector` in the invoker logic has been redesigned. It now
ensures a database transaction is started before executing a command.
After successful execution, it calls the `Events()` method on the
command to collect the generated events and appends them to a list.
* The `eventStoreInvoker` then pushes all collected events to the legacy
eventstore using the new `LegacyEventstore` interface, ensuring that
events are only pushed if the entire command (and any sub-commands)
executes successfully within the transaction.
4. **Testing**:
* New unit tests have been added for the invoker to verify that events
are correctly collected from single commands, batched commands, and
nested commands.
These changes create a clean bridge between the new v3 command-side
logic and the existing v1 eventstore, allowing for incremental adoption
of the new architecture while maintaining full functionality.
## Additional Information
closes https://github.com/zitadel/zitadel/issues/10442
2025-09-16 18:58:49 +02:00
|
|
|
// Ping implements [database.Pool].
|
|
|
|
|
func (c *sqlConn) Ping(ctx context.Context) error {
|
|
|
|
|
return wrapError(c.PingContext(ctx))
|
|
|
|
|
}
|
|
|
|
|
|
2025-09-05 10:54:34 +02:00
|
|
|
// Migrate implements [database.Migrator].
|
|
|
|
|
func (c *sqlConn) Migrate(ctx context.Context) error {
|
|
|
|
|
return ErrMigrate
|
|
|
|
|
}
|