Files
zitadel/cmd/setup/40.go
10087e7389 fix: connection handling in setup after migration steps 40, 64 and 70 (#12293)
# Which Problems Are Solved

During the setup step we saw rare cases which caused setup to fail after
executing steps 40, 64 and 70.

# How the Problems Are Solved

Close currently open database connections so that they fetch the correct
type mapping for the `eventstore.command2` database type.

# Additional Changes

Ensure correct order of setup steps 64 and 70.

# Additional Context

None

---------

Co-authored-by: Livio Spring <9405495+livio-a@users.noreply.github.com>
2026-06-16 15:09:00 +00:00

121 lines
3.0 KiB
Go

package setup
import (
"context"
"database/sql"
"embed"
"fmt"
"io/fs"
"path"
"strings"
"text/template"
"github.com/zitadel/zitadel/backend/v3/instrumentation/logging"
"github.com/zitadel/zitadel/internal/database"
"github.com/zitadel/zitadel/internal/eventstore"
)
// query filenames
const (
fileInTxOrderType = "00_in_tx_order_type.sql"
fileType = "01_type.sql"
fileFunc = "02_func.sql"
)
var (
//go:embed 40/*.sql
initPushFunc embed.FS
)
type InitPushFunc struct {
dbClient *database.DB
}
func (mig *InitPushFunc) Execute(ctx context.Context, _ eventstore.Event) (err error) {
conn, err := mig.dbClient.Conn(ctx)
if err != nil {
return err
}
defer func() {
closeErr := conn.Close()
logging.OnError(ctx, closeErr).Debug("failed to release connection")
// Force the pool to reopen connections to apply the new types
mig.dbClient.Pool.Reset()
}()
statements, err := mig.prepareStatements(ctx)
if err != nil {
return err
}
for _, stmt := range statements {
logging.Info(ctx, "execute statement", "file", stmt.file, "migration", mig.String())
if _, err := conn.ExecContext(ctx, stmt.query); err != nil {
return fmt.Errorf("%s %s: %w", mig.String(), stmt.file, err)
}
}
// close idle connections to prevent them from using the old prepared statement with the wrong type
// and having wrong plan of `eventstore.command2`-type
for _, conn := range mig.dbClient.Pool.AcquireAllIdle(ctx) {
logging.OnError(ctx, conn.Conn().Close(ctx)).Debug("failed to close idle connection")
conn.Release()
}
return nil
}
func (mig *InitPushFunc) String() string {
return "40_init_push_func_v4"
}
func (mig *InitPushFunc) prepareStatements(ctx context.Context) ([]statement, error) {
funcTmpl, err := template.ParseFS(initPushFunc, mig.filePath(fileFunc))
if err != nil {
return nil, fmt.Errorf("prepare steps: %w", err)
}
typeName, err := mig.inTxOrderType(ctx)
if err != nil {
return nil, fmt.Errorf("prepare steps: %w", err)
}
var funcStep strings.Builder
err = funcTmpl.Execute(&funcStep, struct {
InTxOrderType string
}{
InTxOrderType: typeName,
})
if err != nil {
return nil, fmt.Errorf("prepare steps: %w", err)
}
typeStatement, err := fs.ReadFile(initPushFunc, mig.filePath(fileType))
if err != nil {
return nil, fmt.Errorf("prepare steps: %w", err)
}
return []statement{
{
file: fileType,
query: string(typeStatement),
},
{
file: fileFunc,
query: funcStep.String(),
},
}, nil
}
func (mig *InitPushFunc) inTxOrderType(ctx context.Context) (typeName string, err error) {
query, err := fs.ReadFile(initPushFunc, mig.filePath(fileInTxOrderType))
if err != nil {
return "", fmt.Errorf("get in_tx_order_type: %w", err)
}
err = mig.dbClient.QueryRowContext(ctx, func(row *sql.Row) error {
return row.Scan(&typeName)
}, string(query))
if err != nil {
return "", fmt.Errorf("get in_tx_order_type: %w", err)
}
return typeName, nil
}
func (mig *InitPushFunc) filePath(fileName string) string {
return path.Join("40", fileName)
}