zitadel/backend/v3/storage/database/change.go

package database

import (
	"fmt"
	"reflect"
	"slices"

	"go.uber.org/mock/gomock"

	"github.com/zitadel/zitadel/backend/v3/instrumentation/logging"
)

// Change represents a change to a column in a database table.
// Its written in the SET clause of an UPDATE statement.
type Change interface {
	gomock.Matcher
	argWriter
	// Write writes the change to the given statement builder.
	Write(builder *StatementBuilder) error
	// IsOnColumn checks if the change is on the given column.
	IsOnColumn(col Column) bool
}

// NoChange can be implemented by Changes that might not result in any actual change,
// resp. when the change has no set statement, e.g. [CTEChange] with no change function.
type NoChange interface {
	NoChange() bool
}

type change[V Value] struct {
	column Column
	value  V
}

// Matches implements [gomock.Matcher].
func (c *change[V]) Matches(x any) bool {
	toMatch, ok := x.(*change[V])
	if !ok {
		return false
	}
	colMatch := c.column.Equals(toMatch.column)
	valueMatch := reflect.DeepEqual(c.value, toMatch.value)
	return colMatch && valueMatch
}

// String implements [gomock.Matcher].
func (c *change[V]) String() string {
	return "database.change"
}

// WriteArg implements [Change].
func (c change[V]) WriteArg(builder *StatementBuilder) {
	err := c.Write(builder)
	logging.New(logging.StreamRuntime).Debug("write arg failed", "error", err)
}

// Write implements [Change].
func (c change[V]) Write(builder *StatementBuilder) error {
	c.column.WriteUnqualified(builder)
	builder.WriteString(" = ")
	builder.WriteArg(c.value)
	return nil
}

// IsOnColumn implements [Change].
func (c change[V]) IsOnColumn(col Column) bool {
	return c.column.Equals(col)
}

var (
	_ Change         = (*change[string])(nil)
	_ gomock.Matcher = (*change[string])(nil)
)

// NewChange creates a new Change for the given column and value.
// If you want to set a column to NULL, use [NewChangePtr].
func NewChange[V Value](col Column, value V) Change {
	return &change[V]{
		column: col,
		value:  value,
	}
}

// NewChangePtr creates a new Change for the given column and value pointer.
// If the value pointer is nil, the column will be set to NULL.
func NewChangePtr[V Value](col Column, value *V) Change {
	if value == nil {
		return NewChange(col, NullInstruction)
	}
	return NewChange(col, *value)
}

type Changes []Change

func NewChanges(cols ...Change) Changes {
	return Changes(cols)
}

// IsOnColumn implements [Change].
func (c Changes) IsOnColumn(col Column) bool {
	return slices.ContainsFunc(c, func(change Change) bool {
		return change.IsOnColumn(col)
	})
}

// Write implements [Change].
func (c Changes) Write(builder *StatementBuilder) error {
	var hadChanges bool
	for _, change := range c {
		ch, ok := change.(NoChange)
		hasChanges := !ok || !ch.NoChange()
		// if the previous change actually wrote a change to the builder
		// and this change has changes, add a comma
		if hadChanges && hasChanges {
			builder.WriteString(", ")
		}
		if err := change.Write(builder); err != nil {
			return err
		}
		// if the change had changes, mark that we had changes for the next iteration
		if hasChanges {
			hadChanges = hasChanges
		}
	}
	return nil
}

// Matches implements [gomock.Matcher].
func (c Changes) Matches(x any) bool {
	toMatch, ok := x.(Changes)
	if !ok {
		return false
	}
	if len(c) != len(toMatch) {
		return false
	}
	for i := range c {
		if !c[i].Matches(toMatch[i]) {
			return false
		}
	}
	return true
}

// String implements [gomock.Matcher].
func (c Changes) String() string {
	return "database.Changes"
}

// NoChange implements [NoChange].
// It returns false if any of the changes writes to the builder.
func (c Changes) NoChange() bool {
	for _, change := range c {
		no, ok := change.(NoChange)
		if !ok {
			return false
		}
		if no.NoChange() {
			return true
		}
	}
	return true
}

// WriteArg implements [Change].
func (c Changes) WriteArg(builder *StatementBuilder) {
	err := c.Write(builder)
	logging.New(logging.StreamRuntime).Debug("write arg failed", "error", err)
}

var _ Change = Changes(nil)

func NewChangeToNull(col Column) Change {
	return NewChange(col, NullInstruction)
}

func NewChangeToColumn(to, from Column) Change {
	return &changeToColumn{to: to, from: from}
}

type changeToColumn struct {
	to   Column
	from Column
}

// IsOnColumn implements [Change].
func (c *changeToColumn) IsOnColumn(col Column) bool {
	return c.to.Equals(col)
}

// Matches implements [Change].
func (c *changeToColumn) Matches(x any) bool {
	toMatch, ok := x.(*changeToColumn)
	if !ok {
		return false
	}
	return c.to.Equals(toMatch.to) && c.from.Equals(toMatch.from)
}

// String implements [Change].
func (c *changeToColumn) String() string {
	return "database.changeToColumn"
}

// Write implements [Change].
func (c *changeToColumn) Write(builder *StatementBuilder) error {
	c.to.WriteUnqualified(builder)
	builder.WriteString(" = ")
	c.from.WriteQualified(builder)
	return nil
}

// WriteArg implements [Change].
func (c *changeToColumn) WriteArg(builder *StatementBuilder) {
	err := c.Write(builder)
	logging.New(logging.StreamRuntime).Debug("write arg failed", "error", err)
}

var _ Change = (*changeToColumn)(nil)

type incrementColumnChange[V Value] struct {
	column Column
	value  V
}

func NewIncrementColumnChange[V Value](col Column, value V) *incrementColumnChange[V] {
	return &incrementColumnChange[V]{
		column: col,
		value:  value,
	}
}

// IsOnColumn implements [Change].
func (i incrementColumnChange[V]) IsOnColumn(col Column) bool {
	return i.column.Equals(col)
}

// Matches implements [Change].
func (i *incrementColumnChange[V]) Matches(x any) bool {
	toMatch, ok := x.(*incrementColumnChange[V])
	if !ok {
		return false
	}
	return i.column.Equals(toMatch.column)
}

// String implements [Change].
func (i incrementColumnChange[V]) String() string {
	return "database.incrementColumnChange"
}

// Write implements [Change].
func (i incrementColumnChange[V]) Write(builder *StatementBuilder) error {
	i.column.WriteUnqualified(builder)
	builder.WriteString(" = ")
	builder.WriteArg(i.value)
	builder.WriteString(" + 1")
	return nil
}

// WriteArg implements [Change].
func (i incrementColumnChange[V]) WriteArg(builder *StatementBuilder) {
	err := i.Write(builder)
	logging.New(logging.StreamRuntime).Debug("write arg failed", "error", err)
}

var _ Change = (*incrementColumnChange[any])(nil)

func NewChangeToStatement(col Column, stmt func(builder *StatementBuilder)) Change {
	return &changeToStatement{
		column: col,
		stmt:   stmt,
	}
}

type changeToStatement struct {
	column Column
	stmt   func(builder *StatementBuilder)
}

// IsOnColumn implements [Change].
func (c *changeToStatement) IsOnColumn(col Column) bool {
	return c.column.Equals(col)
}

// Matches implements [Change].
func (c *changeToStatement) Matches(x any) bool {
	toMatch, ok := x.(*changeToStatement)
	if !ok {
		return false
	}
	var expectedBuilder, actualBuilder StatementBuilder
	c.stmt(&expectedBuilder)
	toMatch.stmt(&actualBuilder)

	if expectedBuilder.String() != actualBuilder.String() {
		return false
	}
	if !slices.Equal(expectedBuilder.Args(), actualBuilder.Args()) {
		return false
	}
	return c.column.Equals(toMatch.column)
}

// String implements [Change].
func (c *changeToStatement) String() string {
	return "database.changeToStatement"
}

// Write implements [Change].
func (c *changeToStatement) Write(builder *StatementBuilder) error {
	_, ok := c.column.(Columns)
	if ok {
		builder.WriteRune('(')
	}
	c.column.WriteUnqualified(builder)
	if ok {
		builder.WriteRune(')')
	}
	builder.WriteString(" = (")
	c.stmt(builder)
	builder.WriteString(")")
	return nil
}

// WriteArg implements [Change].
func (c *changeToStatement) WriteArg(builder *StatementBuilder) {
	err := c.Write(builder)
	logging.New(logging.StreamRuntime).Debug("write arg failed", "error", err)
}

var _ Change = (*changeToStatement)(nil)

// CTEChange represents a change that uses a Common Table Expression (CTE).
// It intercepts the Write process to first write the CTE part, and then the main change part.
type CTEChange interface {
	Change
	// WriteCTE writes the CTE part of the change to the given statement builder.
	// It writes the part inside the brackets meaning without the "WITH cte_name AS (" and the ending ")".
	WriteCTE(builder *StatementBuilder)
	// SetName sets the name of the CTE.
	// This is defined by the caller to ensure uniqueness.
	// The name is used to reference the CTE in the main change.
	SetName(name string)
}

func NewCTEChange(cte func(builder *StatementBuilder), change func(name string) Change) CTEChange {
	return &cteChange{
		cte:    cte,
		change: change,
	}
}

type cteChange struct {
	name   string
	cte    func(builder *StatementBuilder)
	change func(name string) Change
}

// IsOnColumn implements [CTEChange].
func (c cteChange) IsOnColumn(col Column) bool {
	return false
}

// Matches implements [CTEChange].
func (c *cteChange) Matches(x any) bool {
	toMatch, ok := x.(*cteChange)
	if !ok {
		return false
	}
	var expectedCTEBuilder, actualCTEBuilder StatementBuilder
	c.cte(&expectedCTEBuilder)
	if c.change != nil {
		if err := c.change(c.name).Write(&expectedCTEBuilder); err != nil {
			return false
		}
	}
	toMatch.cte(&actualCTEBuilder)
	if toMatch.change != nil {
		if err := toMatch.change(toMatch.name).Write(&actualCTEBuilder); err != nil {
			return false
		}
	}

	if expectedCTEBuilder.String() != actualCTEBuilder.String() {
		return false
	}

	if len(expectedCTEBuilder.Args()) != len(actualCTEBuilder.Args()) {
		return false
	}

	for i, e := range expectedCTEBuilder.Args() {
		/*	This comparison is an oversimplification because it compares only the types. If the type
		 *	is a struct, we would need to type assert that and come up with a custom comparator.
		 *	In some cases, like for [domain.SessionFactorUser] it can become quite tricky because
		 *	it includes a [time.Time] value, for which you will need to do comparisons in range rather
		 *	than equal matches. Of course, this is just an example, but we could have much more complex
		 *	structs that makes it very hard to forecast what kind of code we need to write here
		 */
		expectedType, actualType := fmt.Sprintf("%T", e), fmt.Sprintf("%T", actualCTEBuilder.Args()[i])
		if expectedType != actualType {
			return false
		}
	}

	return true
}

// SetName implements [CTEChange].
func (c *cteChange) SetName(name string) {
	c.name = name
}

// String implements [CTEChange].
func (c *cteChange) String() string {
	return "database.cteChange"
}

// Write implements [CTEChange].
func (c cteChange) Write(builder *StatementBuilder) error {
	if c.change == nil {
		return nil
	}
	return c.change(c.name).Write(builder)
}

// WriteCTE implements [CTEChange].
func (c cteChange) WriteCTE(builder *StatementBuilder) {
	c.cte(builder)
}

// NoChange implements [NoChange].
// It returns true if there is no change function defined.
func (c cteChange) NoChange() bool {
	return c.change == nil
}

// WriteArg implements [Change].
func (c cteChange) WriteArg(builder *StatementBuilder) {
	err := c.Write(builder)
	logging.New(logging.StreamRuntime).Debug("write arg failed", "error", err)
}