feat: add tenant column to eventstore (#3314)

* feat: add tenant column to eventstore

* feat: read tenant from context on push and filter

* Update 07_events_table.sql

* pass tenant to queryFactory

* fix some query tests

* init in tests

* add missing sql files

Co-authored-by: Livio Amstutz <livio.a@gmail.com>

internal/eventstore/repository/sql/crdb.go

@@ -9,10 +9,11 @@ import (
 	"strings"
 
 	"github.com/caos/logging"
-	caos_errs "github.com/caos/zitadel/internal/errors"
-	"github.com/caos/zitadel/internal/eventstore/repository"
 	"github.com/cockroachdb/cockroach-go/v2/crdb"
 	"github.com/lib/pq"
+
+	caos_errs "github.com/caos/zitadel/internal/errors"
+	"github.com/caos/zitadel/internal/eventstore/repository"
 )
 
 const (
@@ -29,6 +30,7 @@ const (
 		" SELECT MAX(event_sequence) seq, 1 join_me" +
 		" FROM eventstore.events" +
 		" WHERE aggregate_type = $2" +
+		" AND (CASE WHEN $9::STRING IS NULL THEN tenant is null else tenant = $9::STRING END)" +
 		") AS agg_type " +
 		// combined with
 		"LEFT JOIN " +
@@ -37,6 +39,7 @@ const (
 		" SELECT event_sequence seq, resource_owner ro, 1 join_me" +
 		" FROM eventstore.events" +
 		" WHERE aggregate_type = $2 AND aggregate_id = $3" +
+		" AND (CASE WHEN $9::STRING IS NULL THEN tenant is null else tenant = $9::STRING END)" +
 		" ORDER BY event_sequence DESC" +
 		" LIMIT 1" +
 		") AS agg USING(join_me)" +
@@ -51,6 +54,8 @@ const (
 		" editor_user," +
 		" editor_service," +
 		" resource_owner," +
+		" tenant," +
+		" event_sequence," +
 		" previous_aggregate_sequence," +
 		" previous_aggregate_type_sequence" +
 		") " +
@@ -64,11 +69,13 @@ const (
 		" $5::JSONB AS event_data," +
 		" $6::VARCHAR AS editor_user," +
 		" $7::VARCHAR AS editor_service," +
-		" IFNULL((resource_owner), $8::VARCHAR)  AS resource_owner," +
+		" IFNULL((resource_owner), $8::VARCHAR) AS resource_owner," +
+		" $9::VARCHAR AS tenant," +
+		" NEXTVAL(CONCAT('eventstore.', IFNULL($9, 'system'), '_seq'))," +
 		" aggregate_sequence AS previous_aggregate_sequence," +
 		" aggregate_type_sequence AS previous_aggregate_type_sequence " +
 		"FROM previous_data " +
-		"RETURNING id, event_sequence, previous_aggregate_sequence, previous_aggregate_type_sequence, creation_date, resource_owner"
+		"RETURNING id, event_sequence, previous_aggregate_sequence, previous_aggregate_type_sequence, creation_date, resource_owner, tenant"
 
 	uniqueInsert = `INSERT INTO eventstore.unique_constraints
 					(
@@ -113,17 +120,20 @@ func (db *CRDB) Push(ctx context.Context, events []*repository.Event, uniqueCons
 				event.EditorUser,
 				event.EditorService,
 				event.ResourceOwner,
-			).Scan(&event.ID, &event.Sequence, &previousAggregateSequence, &previousAggregateTypeSequence, &event.CreationDate, &event.ResourceOwner)
+				event.Tenant,
+			).Scan(&event.ID, &event.Sequence, &previousAggregateSequence, &previousAggregateTypeSequence, &event.CreationDate, &event.ResourceOwner, &event.Tenant)
 
 			event.PreviousAggregateSequence = uint64(previousAggregateSequence)
 			event.PreviousAggregateTypeSequence = uint64(previousAggregateTypeSequence)
 
 			if err != nil {
-				logging.LogWithFields("SQL-NOqH7",
+				logging.WithFields(
 					"aggregate", event.AggregateType,
 					"aggregateId", event.AggregateID,
 					"aggregateType", event.AggregateType,
-					"eventType", event.Type).WithError(err).Info("query failed")
+					"eventType", event.Type,
+					"tenant", event.Tenant,
+				).WithError(err).Info("query failed")
 				return caos_errs.ThrowInternal(err, "SQL-SBP37", "unable to create event")
 			}
 		}
@@ -152,7 +162,7 @@ func (db *CRDB) handleUniqueConstraints(ctx context.Context, tx *sql.Tx, uniqueC
 		if uniqueConstraint.Action == repository.UniqueConstraintAdd {
 			_, err := tx.ExecContext(ctx, uniqueInsert, uniqueConstraint.UniqueType, uniqueConstraint.UniqueField)
 			if err != nil {
-				logging.LogWithFields("SQL-IP3js",
+				logging.WithFields(
 					"unique_type", uniqueConstraint.UniqueType,
 					"unique_field", uniqueConstraint.UniqueField).WithError(err).Info("insert unique constraint failed")
 
@@ -165,7 +175,7 @@ func (db *CRDB) handleUniqueConstraints(ctx context.Context, tx *sql.Tx, uniqueC
 		} else if uniqueConstraint.Action == repository.UniqueConstraintRemoved {
 			_, err := tx.ExecContext(ctx, uniqueDelete, uniqueConstraint.UniqueType, uniqueConstraint.UniqueField)
 			if err != nil {
-				logging.LogWithFields("SQL-M0vsf",
+				logging.WithFields(
 					"unique_type", uniqueConstraint.UniqueType,
 					"unique_field", uniqueConstraint.UniqueField).WithError(err).Info("delete unique constraint failed")
 				return caos_errs.ThrowInternal(err, "SQL-6n88i", "unable to remove unique constraint ")
@@ -219,6 +229,7 @@ func (db *CRDB) eventQuery() string {
 		", editor_service" +
 		", editor_user" +
 		", resource_owner" +
+		", tenant" +
 		", aggregate_type" +
 		", aggregate_id" +
 		", aggregate_version" +
@@ -239,6 +250,8 @@ func (db *CRDB) columnName(col repository.Field) string {
 		return "event_sequence"
 	case repository.FieldResourceOwner:
 		return "resource_owner"
+	case repository.FieldTenant:
+		return "tenant"
 	case repository.FieldEditorService:
 		return "editor_service"
 	case repository.FieldEditorUser:

internal/eventstore/repository/sql/local_crdb_test.go

@@ -2,37 +2,31 @@ package sql
 
 import (
 	"database/sql"
-	"fmt"
-	"io/ioutil"
 	"os"
-	"path/filepath"
-	"sort"
-	"strconv"
-	"strings"
 	"testing"
 
 	"github.com/caos/logging"
 	"github.com/cockroachdb/cockroach-go/v2/testserver"
+
+	"github.com/caos/zitadel/cmd/admin/initialise"
 )
 
 var (
-	migrationsPath = os.ExpandEnv("${GOPATH}/src/github.com/caos/zitadel/migrations/cockroach")
 	testCRDBClient *sql.DB
 )
 
 func TestMain(m *testing.M) {
 	ts, err := testserver.NewTestServer()
 	if err != nil {
-		logging.LogWithFields("REPOS-RvjLG", "error", err).Fatal("unable to start db")
+		logging.WithFields("error", err).Fatal("unable to start db")
 	}
 
 	testCRDBClient, err = sql.Open("postgres", ts.PGURL().String())
-
 	if err != nil {
-		logging.LogWithFields("REPOS-CF6dQ", "error", err).Fatal("unable to connect to db")
+		logging.WithFields("error", err).Fatal("unable to connect to db")
 	}
 	if err = testCRDBClient.Ping(); err != nil {
-		logging.LogWithFields("REPOS-CF6dQ", "error", err).Fatal("unable to ping db")
+		logging.WithFields("error", err).Fatal("unable to ping db")
 	}
 
 	defer func() {
@@ -40,113 +34,26 @@ func TestMain(m *testing.M) {
 		ts.Stop()
 	}()
 
-	if err = executeMigrations(); err != nil {
-		logging.LogWithFields("REPOS-jehDD", "error", err).Fatal("migrations failed")
+	if err = initDB(testCRDBClient); err != nil {
+		logging.WithFields("error", err).Fatal("migrations failed")
 	}
 
 	os.Exit(m.Run())
 }
 
-func executeMigrations() error {
-	files, err := migrationFilePaths()
+func initDB(db *sql.DB) error {
+	username := "zitadel"
+	database := "zitadel"
+	err := initialise.Initialise(db, initialise.VerifyUser(username, ""),
+		initialise.VerifyDatabase(database),
+		initialise.VerifyGrant(database, username))
 	if err != nil {
 		return err
 	}
-	sort.Sort(files)
-	if err = setPasswordNULL(); err != nil {
-		return err
-	}
-	if err = createFlywayHistory(); err != nil {
-		return err
-	}
-	for _, file := range files {
-		migrationData, err := ioutil.ReadFile(file)
-		if err != nil {
-			return err
-		}
-		migration := os.ExpandEnv(string(migrationData))
-		if _, err = testCRDBClient.Exec(migration); err != nil {
-			return fmt.Errorf("exec file: %v || err: %w", file, err)
-		}
-	}
-	return nil
-}
-
-func setPasswordNULL() error {
-	passwordNames := []string{
-		"eventstorepassword",
-		"managementpassword",
-		"adminapipassword",
-		"authpassword",
-		"notificationpassword",
-		"authzpassword",
-		"queriespassword",
-	}
-	for _, name := range passwordNames {
-		if err := os.Setenv(name, "NULL"); err != nil {
-			return err
-		}
-	}
-	return nil
-}
-
-func createFlywayHistory() error {
-	_, err := testCRDBClient.Exec("CREATE TABLE defaultdb.flyway_schema_history(id TEXT, PRIMARY KEY(id));")
-	return err
+	return initialise.VerifyZitadel(db)
 }
 
 func fillUniqueData(unique_type, field string) error {
 	_, err := testCRDBClient.Exec("INSERT INTO eventstore.unique_constraints (unique_type, unique_field) VALUES ($1, $2)", unique_type, field)
 	return err
 }
-
-type migrationPaths []string
-
-type version struct {
-	major int
-	minor int
-}
-
-func versionFromPath(s string) version {
-	v := s[strings.Index(s, "/V")+2 : strings.Index(s, "__")]
-	splitted := strings.Split(v, ".")
-	res := version{}
-	var err error
-	if len(splitted) >= 1 {
-		res.major, err = strconv.Atoi(splitted[0])
-		if err != nil {
-			panic(err)
-		}
-	}
-
-	if len(splitted) >= 2 {
-		res.minor, err = strconv.Atoi(splitted[1])
-		if err != nil {
-			panic(err)
-		}
-	}
-
-	return res
-}
-
-func (a migrationPaths) Len() int      { return len(a) }
-func (a migrationPaths) Swap(i, j int) { a[i], a[j] = a[j], a[i] }
-func (a migrationPaths) Less(i, j int) bool {
-	versionI := versionFromPath(a[i])
-	versionJ := versionFromPath(a[j])
-
-	return versionI.major < versionJ.major ||
-		(versionI.major == versionJ.major && versionI.minor < versionJ.minor)
-}
-
-func migrationFilePaths() (migrationPaths, error) {
-	files := make(migrationPaths, 0)
-	err := filepath.Walk(migrationsPath, func(path string, info os.FileInfo, err error) error {
-		if err != nil || info.IsDir() || !strings.HasSuffix(info.Name(), ".sql") {
-			return err
-		}
-		files = append(files, path)
-		return nil
-	})
-	return files, err
-}

internal/eventstore/repository/sql/query.go

@@ -9,9 +9,10 @@ import (
 	"strings"
 
 	"github.com/caos/logging"
+	"github.com/lib/pq"
+
 	z_errors "github.com/caos/zitadel/internal/errors"
 	"github.com/caos/zitadel/internal/eventstore/repository"
-	"github.com/lib/pq"
 )
 
 type querier interface {
@@ -48,7 +49,7 @@ func query(ctx context.Context, criteria querier, searchQuery *repository.Search
 
 	rows, err := criteria.db().QueryContext(ctx, query, values...)
 	if err != nil {
-		logging.Log("SQL-HP3Uk").WithError(err).Info("query failed")
+		logging.New().WithError(err).Info("query failed")
 		return z_errors.ThrowInternal(err, "SQL-KyeAx", "unable to filter events")
 	}
 	defer rows.Close()
@@ -108,13 +109,14 @@ func eventsScanner(scanner scan, dest interface{}) (err error) {
 		&event.EditorService,
 		&event.EditorUser,
 		&event.ResourceOwner,
+		&event.Tenant,
 		&event.AggregateType,
 		&event.AggregateID,
 		&event.Version,
 	)
 
 	if err != nil {
-		logging.Log("SQL-3mofs").WithError(err).Warn("unable to scan row")
+		logging.New().WithError(err).Warn("unable to scan row")
 		return z_errors.ThrowInternal(err, "SQL-M0dsf", "unable to scan row")
 	}
 
@@ -147,7 +149,7 @@ func prepareCondition(criteria querier, filters [][]*repository.Filter) (clause
 				var err error
 				value, err = json.Marshal(value)
 				if err != nil {
-					logging.Log("SQL-BSsNy").WithError(err).Warn("unable to marshal search value")
+					logging.New().WithError(err).Warn("unable to marshal search value")
 					continue
 				}
 			}

internal/eventstore/repository/sql/query_test.go

@@ -130,13 +130,13 @@ func Test_prepareColumns(t *testing.T) {
 				dest:    &[]*repository.Event{},
 			},
 			res: res{
-				query: "SELECT creation_date, event_type, event_sequence, previous_aggregate_sequence, previous_aggregate_type_sequence, event_data, editor_service, editor_user, resource_owner, aggregate_type, aggregate_id, aggregate_version FROM eventstore.events",
+				query: "SELECT creation_date, event_type, event_sequence, previous_aggregate_sequence, previous_aggregate_type_sequence, event_data, editor_service, editor_user, resource_owner, tenant, aggregate_type, aggregate_id, aggregate_version FROM eventstore.events",
 				expected: []*repository.Event{
 					{AggregateID: "hodor", AggregateType: "user", Sequence: 5, Data: make(Data, 0)},
 				},
 			},
 			fields: fields{
-				dbRow: []interface{}{time.Time{}, repository.EventType(""), uint64(5), Sequence(0), Sequence(0), Data(nil), "", "", sql.NullString{String: ""}, repository.AggregateType("user"), "hodor", repository.Version("")},
+				dbRow: []interface{}{time.Time{}, repository.EventType(""), uint64(5), Sequence(0), Sequence(0), Data(nil), "", "", sql.NullString{String: ""}, sql.NullString{String: ""}, repository.AggregateType("user"), "hodor", repository.Version("")},
 			},
 		},
 		{
@@ -146,7 +146,7 @@ func Test_prepareColumns(t *testing.T) {
 				dest:    []*repository.Event{},
 			},
 			res: res{
-				query: "SELECT creation_date, event_type, event_sequence, previous_aggregate_sequence, previous_aggregate_type_sequence, event_data, editor_service, editor_user, resource_owner, aggregate_type, aggregate_id, aggregate_version FROM eventstore.events",
+				query: "SELECT creation_date, event_type, event_sequence, previous_aggregate_sequence, previous_aggregate_type_sequence, event_data, editor_service, editor_user, resource_owner, tenant, aggregate_type, aggregate_id, aggregate_version FROM eventstore.events",
 				dbErr: errors.IsErrorInvalidArgument,
 			},
 		},
@@ -158,7 +158,7 @@ func Test_prepareColumns(t *testing.T) {
 				dbErr:   sql.ErrConnDone,
 			},
 			res: res{
-				query: "SELECT creation_date, event_type, event_sequence, previous_aggregate_sequence, previous_aggregate_type_sequence, event_data, editor_service, editor_user, resource_owner, aggregate_type, aggregate_id, aggregate_version FROM eventstore.events",
+				query: "SELECT creation_date, event_type, event_sequence, previous_aggregate_sequence, previous_aggregate_type_sequence, event_data, editor_service, editor_user, resource_owner, tenant, aggregate_type, aggregate_id, aggregate_version FROM eventstore.events",
 				dbErr: errors.IsInternal,
 			},
 		},
@@ -592,7 +592,7 @@ func Test_query_events_mocked(t *testing.T) {
 			},
 			fields: fields{
 				mock: newMockClient(t).expectQuery(t,
-					`SELECT creation_date, event_type, event_sequence, previous_aggregate_sequence, previous_aggregate_type_sequence, event_data, editor_service, editor_user, resource_owner, aggregate_type, aggregate_id, aggregate_version FROM eventstore.events WHERE \( aggregate_type = \$1 \) ORDER BY event_sequence DESC`,
+					`SELECT creation_date, event_type, event_sequence, previous_aggregate_sequence, previous_aggregate_type_sequence, event_data, editor_service, editor_user, resource_owner, tenant, aggregate_type, aggregate_id, aggregate_version FROM eventstore.events WHERE \( aggregate_type = \$1 \) ORDER BY event_sequence DESC`,
 					[]driver.Value{repository.AggregateType("user")},
 				),
 			},
@@ -621,7 +621,7 @@ func Test_query_events_mocked(t *testing.T) {
 			},
 			fields: fields{
 				mock: newMockClient(t).expectQuery(t,
-					`SELECT creation_date, event_type, event_sequence, previous_aggregate_sequence, previous_aggregate_type_sequence, event_data, editor_service, editor_user, resource_owner, aggregate_type, aggregate_id, aggregate_version FROM eventstore.events WHERE \( aggregate_type = \$1 \) ORDER BY event_sequence LIMIT \$2`,
+					`SELECT creation_date, event_type, event_sequence, previous_aggregate_sequence, previous_aggregate_type_sequence, event_data, editor_service, editor_user, resource_owner, tenant, aggregate_type, aggregate_id, aggregate_version FROM eventstore.events WHERE \( aggregate_type = \$1 \) ORDER BY event_sequence LIMIT \$2`,
 					[]driver.Value{repository.AggregateType("user"), uint64(5)},
 				),
 			},
@@ -650,7 +650,7 @@ func Test_query_events_mocked(t *testing.T) {
 			},
 			fields: fields{
 				mock: newMockClient(t).expectQuery(t,
-					`SELECT creation_date, event_type, event_sequence, previous_aggregate_sequence, previous_aggregate_type_sequence, event_data, editor_service, editor_user, resource_owner, aggregate_type, aggregate_id, aggregate_version FROM eventstore.events WHERE \( aggregate_type = \$1 \) ORDER BY event_sequence DESC LIMIT \$2`,
+					`SELECT creation_date, event_type, event_sequence, previous_aggregate_sequence, previous_aggregate_type_sequence, event_data, editor_service, editor_user, resource_owner, tenant, aggregate_type, aggregate_id, aggregate_version FROM eventstore.events WHERE \( aggregate_type = \$1 \) ORDER BY event_sequence DESC LIMIT \$2`,
 					[]driver.Value{repository.AggregateType("user"), uint64(5)},
 				),
 			},
@@ -679,7 +679,7 @@ func Test_query_events_mocked(t *testing.T) {
 			},
 			fields: fields{
 				mock: newMockClient(t).expectQueryErr(t,
-					`SELECT creation_date, event_type, event_sequence, previous_aggregate_sequence, previous_aggregate_type_sequence, event_data, editor_service, editor_user, resource_owner, aggregate_type, aggregate_id, aggregate_version FROM eventstore.events WHERE \( aggregate_type = \$1 \) ORDER BY event_sequence DESC`,
+					`SELECT creation_date, event_type, event_sequence, previous_aggregate_sequence, previous_aggregate_type_sequence, event_data, editor_service, editor_user, resource_owner, tenant, aggregate_type, aggregate_id, aggregate_version FROM eventstore.events WHERE \( aggregate_type = \$1 \) ORDER BY event_sequence DESC`,
 					[]driver.Value{repository.AggregateType("user")},
 					sql.ErrConnDone),
 			},
@@ -708,7 +708,7 @@ func Test_query_events_mocked(t *testing.T) {
 			},
 			fields: fields{
 				mock: newMockClient(t).expectQuery(t,
-					`SELECT creation_date, event_type, event_sequence, previous_aggregate_sequence, previous_aggregate_type_sequence, event_data, editor_service, editor_user, resource_owner, aggregate_type, aggregate_id, aggregate_version FROM eventstore.events WHERE \( aggregate_type = \$1 \) ORDER BY event_sequence DESC`,
+					`SELECT creation_date, event_type, event_sequence, previous_aggregate_sequence, previous_aggregate_type_sequence, event_data, editor_service, editor_user, resource_owner, tenant, aggregate_type, aggregate_id, aggregate_version FROM eventstore.events WHERE \( aggregate_type = \$1 \) ORDER BY event_sequence DESC`,
 					[]driver.Value{repository.AggregateType("user")},
 					&repository.Event{Sequence: 100}),
 			},
@@ -776,7 +776,7 @@ func Test_query_events_mocked(t *testing.T) {
 			},
 			fields: fields{
 				mock: newMockClient(t).expectQuery(t,
-					`SELECT creation_date, event_type, event_sequence, previous_aggregate_sequence, previous_aggregate_type_sequence, event_data, editor_service, editor_user, resource_owner, aggregate_type, aggregate_id, aggregate_version FROM eventstore.events WHERE \( aggregate_type = \$1 \) OR \( aggregate_type = \$2 AND aggregate_id = \$3 \) ORDER BY event_sequence DESC LIMIT \$4`,
+					`SELECT creation_date, event_type, event_sequence, previous_aggregate_sequence, previous_aggregate_type_sequence, event_data, editor_service, editor_user, resource_owner, tenant, aggregate_type, aggregate_id, aggregate_version FROM eventstore.events WHERE \( aggregate_type = \$1 \) OR \( aggregate_type = \$2 AND aggregate_id = \$3 \) ORDER BY event_sequence DESC LIMIT \$4`,
 					[]driver.Value{repository.AggregateType("user"), repository.AggregateType("org"), "asdf42", uint64(5)},
 				),
 			},

internal/eventstore/repository/sql/setup.go

@@ -52,7 +52,7 @@ func (db *CRDB) Step20(ctx context.Context, latestSequence uint64) error {
 		if err = tx.Commit(); err != nil {
 			return err
 		}
-		logging.LogWithFields("SQL-bXVwS", "currentSeq", currentSequence, "events", len(events)).Info("events updated")
+		logging.WithFields("currentSeq", currentSequence, "events", len(events)).Info("events updated")
 	}
 	return nil
 }