fix(preference): rename columns for preference tables (#9912)

* fix(preference): rename columns for preference tables

* fix(preference): use go based migration instead of sql based

pkg/modules/preference/implpreference/store.go

@@ -25,7 +25,7 @@ func (store *store) GetByOrg(ctx context.Context, orgID valuer.UUID, name prefer
 		BunDB().
 		NewSelect().
 		Model(orgPreference).
-		Where("preference_id = ?", name).
+		Where("name = ?", name).
 		Where("org_id = ?", orgID).
 		Scan(ctx)
 	if err != nil {
@@ -75,7 +75,7 @@ func (store *store) GetByUser(ctx context.Context, userID valuer.UUID, name pref
 		BunDB().
 		NewSelect().
 		Model(userPreference).
-		Where("preference_id = ?", name).
+		Where("name = ?", name).
 		Where("user_id = ?", userID).
 		Scan(ctx)
 	if err != nil {

pkg/modules/user/impluser/store.go

@@ -11,6 +11,7 @@ import (
 	"github.com/SigNoz/signoz/pkg/sqlstore"
 	"github.com/SigNoz/signoz/pkg/types"
 	"github.com/SigNoz/signoz/pkg/types/authtypes"
+	"github.com/SigNoz/signoz/pkg/types/preferencetypes"
 	"github.com/SigNoz/signoz/pkg/valuer"
 	"github.com/uptrace/bun"
 )
@@ -290,14 +291,13 @@ func (store *store) DeleteUser(ctx context.Context, orgID string, id string) err
 		return errors.Wrapf(err, errors.TypeInternal, errors.CodeInternal, "failed to delete API keys")
 	}
 
-	// delete user
+	// delete user_preference
 	_, err = tx.NewDelete().
-		Model(new(types.User)).
-		Where("org_id = ?", orgID).
-		Where("id = ?", id).
+		Model(new(preferencetypes.StorableUserPreference)).
+		Where("user_id = ?", id).
 		Exec(ctx)
 	if err != nil {
-		return errors.Wrapf(err, errors.TypeInternal, errors.CodeInternal, "failed to delete user")
+		return errors.Wrapf(err, errors.TypeInternal, errors.CodeInternal, "failed to delete user preferences")
 	}
 
 	// delete tokens
@@ -309,6 +309,16 @@ func (store *store) DeleteUser(ctx context.Context, orgID string, id string) err
 		return errors.Wrapf(err, errors.TypeInternal, errors.CodeInternal, "failed to delete tokens")
 	}
 
+	// delete user
+	_, err = tx.NewDelete().
+		Model(new(types.User)).
+		Where("org_id = ?", orgID).
+		Where("id = ?", id).
+		Exec(ctx)
+	if err != nil {
+		return errors.Wrapf(err, errors.TypeInternal, errors.CodeInternal, "failed to delete user")
+	}
+
 	err = tx.Commit()
 	if err != nil {
 		return errors.Wrapf(err, errors.TypeInternal, errors.CodeInternal, "failed to commit transaction")

pkg/signoz/provider.go

@@ -157,6 +157,8 @@ func NewSQLMigrationProviderFactories(
 		sqlmigration.NewAddPublicDashboardsFactory(sqlstore, sqlschema),
 		sqlmigration.NewAddRoleFactory(sqlstore, sqlschema),
 		sqlmigration.NewUpdateAuthzFactory(sqlstore, sqlschema),
+		sqlmigration.NewUpdateUserPreferenceFactory(sqlstore, sqlschema),
+		sqlmigration.NewUpdateOrgPreferenceFactory(sqlstore, sqlschema),
 	)
 }
 

pkg/sqlmigration/055_update_user_preference.go

@@ -0,0 +1,155 @@
+package sqlmigration
+
+import (
+	"context"
+
+	"github.com/SigNoz/signoz/pkg/factory"
+	"github.com/SigNoz/signoz/pkg/sqlschema"
+	"github.com/SigNoz/signoz/pkg/sqlstore"
+	"github.com/SigNoz/signoz/pkg/types"
+	"github.com/SigNoz/signoz/pkg/valuer"
+	"github.com/uptrace/bun"
+	"github.com/uptrace/bun/migrate"
+)
+
+type oldStorableUserPreference struct {
+	bun.BaseModel `bun:"table:user_preference"`
+	types.Identifiable
+	Name   string      `bun:"preference_id,type:text,notnull"`
+	Value  string      `bun:"preference_value,type:text,notnull"`
+	UserID valuer.UUID `bun:"user_id,type:text,notnull"`
+}
+
+type newStorableUserPreference struct {
+	bun.BaseModel `bun:"table:user_preference"`
+	types.Identifiable
+	Name   string      `bun:"name,type:text,notnull"`
+	Value  string      `bun:"value,type:text,notnull"`
+	UserID valuer.UUID `bun:"user_id,type:text,notnull"`
+}
+
+type updateUserPreference struct {
+	sqlstore  sqlstore.SQLStore
+	sqlschema sqlschema.SQLSchema
+}
+
+func NewUpdateUserPreferenceFactory(sqlstore sqlstore.SQLStore, sqlschema sqlschema.SQLSchema) factory.ProviderFactory[SQLMigration, Config] {
+	return factory.NewProviderFactory(factory.MustNewName("update_user_preference"), func(ctx context.Context, settings factory.ProviderSettings, config Config) (SQLMigration, error) {
+		return newupdateUserPreference(ctx, settings, config, sqlstore, sqlschema)
+	})
+}
+
+func newupdateUserPreference(_ context.Context, _ factory.ProviderSettings, _ Config, sqlstore sqlstore.SQLStore, sqlschema sqlschema.SQLSchema) (SQLMigration, error) {
+	return &updateUserPreference{
+		sqlstore:  sqlstore,
+		sqlschema: sqlschema,
+	}, nil
+}
+
+func (migration *updateUserPreference) Register(migrations *migrate.Migrations) error {
+	if err := migrations.Register(migration.Up, migration.Down); err != nil {
+		return err
+	}
+
+	return nil
+}
+
+func (migration *updateUserPreference) Up(ctx context.Context, db *bun.DB) error {
+	table, _, err := migration.sqlschema.GetTable(ctx, sqlschema.TableName("user_preference"))
+	if err != nil {
+		return err
+	}
+
+	for _, col := range table.Columns {
+		if col.Name == "name" || col.Name == "value" {
+			return nil
+		}
+	}
+
+	tx, err := db.BeginTx(ctx, nil)
+	if err != nil {
+		return err
+	}
+
+	defer func() {
+		_ = tx.Rollback()
+	}()
+
+	oldUserPreferences := []*oldStorableUserPreference{}
+	err = tx.
+		NewSelect().
+		Model(&oldUserPreferences).
+		Scan(ctx)
+	if err != nil {
+		return err
+	}
+
+	dropSQLs := migration.sqlschema.Operator().DropTable(table)
+	for _, sql := range dropSQLs {
+		if _, err := tx.ExecContext(ctx, string(sql)); err != nil {
+			return err
+		}
+	}
+
+	sqls := [][]byte{}
+	tableSQLs := migration.sqlschema.Operator().CreateTable(&sqlschema.Table{
+		Name: "user_preference",
+		Columns: []*sqlschema.Column{
+			{Name: "id", DataType: sqlschema.DataTypeText, Nullable: false},
+			{Name: "name", DataType: sqlschema.DataTypeText, Nullable: false},
+			{Name: "value", DataType: sqlschema.DataTypeText, Nullable: false},
+			{Name: "user_id", DataType: sqlschema.DataTypeText, Nullable: false},
+		},
+		PrimaryKeyConstraint: &sqlschema.PrimaryKeyConstraint{
+			ColumnNames: []sqlschema.ColumnName{"id"},
+		},
+		ForeignKeyConstraints: []*sqlschema.ForeignKeyConstraint{
+			{
+				ReferencingColumnName: sqlschema.ColumnName("user_id"),
+				ReferencedTableName:   sqlschema.TableName("users"),
+				ReferencedColumnName:  sqlschema.ColumnName("id"),
+			},
+		},
+	})
+	sqls = append(sqls, tableSQLs...)
+
+	indexSQLs := migration.sqlschema.Operator().CreateIndex(&sqlschema.UniqueIndex{TableName: "user_preference", ColumnNames: []sqlschema.ColumnName{"name", "user_id"}})
+	sqls = append(sqls, indexSQLs...)
+
+	for _, sql := range sqls {
+		if _, err := tx.ExecContext(ctx, string(sql)); err != nil {
+			return err
+		}
+	}
+
+	userPreferences := []*newStorableUserPreference{}
+	for _, preference := range oldUserPreferences {
+		userPreferences = append(userPreferences, &newStorableUserPreference{
+			Identifiable: preference.Identifiable,
+			Name:         preference.Name,
+			Value:        preference.Value,
+			UserID:       preference.UserID,
+		})
+	}
+
+	if len(userPreferences) > 0 {
+		_, err = tx.
+			NewInsert().
+			Model(&userPreferences).
+			Exec(ctx)
+		if err != nil {
+			return err
+		}
+	}
+
+	err = tx.Commit()
+	if err != nil {
+		return err
+	}
+
+	return nil
+}
+
+func (migration *updateUserPreference) Down(ctx context.Context, db *bun.DB) error {
+	return nil
+}

pkg/sqlmigration/056_update_org_preference.go

@@ -0,0 +1,155 @@
+package sqlmigration
+
+import (
+	"context"
+
+	"github.com/SigNoz/signoz/pkg/factory"
+	"github.com/SigNoz/signoz/pkg/sqlschema"
+	"github.com/SigNoz/signoz/pkg/sqlstore"
+	"github.com/SigNoz/signoz/pkg/types"
+	"github.com/SigNoz/signoz/pkg/valuer"
+	"github.com/uptrace/bun"
+	"github.com/uptrace/bun/migrate"
+)
+
+type oldStorableOrgPreference struct {
+	bun.BaseModel `bun:"table:org_preference"`
+	types.Identifiable
+	Name  string      `bun:"preference_id,type:text,notnull"`
+	Value string      `bun:"preference_value,type:text,notnull"`
+	OrgID valuer.UUID `bun:"org_id,type:text,notnull"`
+}
+
+type newStorableOrgPreference struct {
+	bun.BaseModel `bun:"table:org_preference"`
+	types.Identifiable
+	Name  string      `bun:"name,type:text,notnull"`
+	Value string      `bun:"value,type:text,notnull"`
+	OrgID valuer.UUID `bun:"org_id,type:text,notnull"`
+}
+
+type updateOrgPreference struct {
+	sqlstore  sqlstore.SQLStore
+	sqlschema sqlschema.SQLSchema
+}
+
+func NewUpdateOrgPreferenceFactory(sqlstore sqlstore.SQLStore, sqlschema sqlschema.SQLSchema) factory.ProviderFactory[SQLMigration, Config] {
+	return factory.NewProviderFactory(factory.MustNewName("update_org_preference"), func(ctx context.Context, settings factory.ProviderSettings, config Config) (SQLMigration, error) {
+		return newupdateOrgPreference(ctx, settings, config, sqlstore, sqlschema)
+	})
+}
+
+func newupdateOrgPreference(_ context.Context, _ factory.ProviderSettings, _ Config, sqlstore sqlstore.SQLStore, sqlschema sqlschema.SQLSchema) (SQLMigration, error) {
+	return &updateOrgPreference{
+		sqlstore:  sqlstore,
+		sqlschema: sqlschema,
+	}, nil
+}
+
+func (migration *updateOrgPreference) Register(migrations *migrate.Migrations) error {
+	if err := migrations.Register(migration.Up, migration.Down); err != nil {
+		return err
+	}
+
+	return nil
+}
+
+func (migration *updateOrgPreference) Up(ctx context.Context, db *bun.DB) error {
+	table, _, err := migration.sqlschema.GetTable(ctx, sqlschema.TableName("org_preference"))
+	if err != nil {
+		return err
+	}
+
+	for _, col := range table.Columns {
+		if col.Name == "name" || col.Name == "value" {
+			return nil
+		}
+	}
+
+	tx, err := db.BeginTx(ctx, nil)
+	if err != nil {
+		return err
+	}
+
+	defer func() {
+		_ = tx.Rollback()
+	}()
+
+	oldOrgPreferences := []*oldStorableOrgPreference{}
+	err = tx.
+		NewSelect().
+		Model(&oldOrgPreferences).
+		Scan(ctx)
+	if err != nil {
+		return err
+	}
+
+	dropSQLs := migration.sqlschema.Operator().DropTable(table)
+	for _, sql := range dropSQLs {
+		if _, err := tx.ExecContext(ctx, string(sql)); err != nil {
+			return err
+		}
+	}
+
+	sqls := [][]byte{}
+	tableSQLs := migration.sqlschema.Operator().CreateTable(&sqlschema.Table{
+		Name: "org_preference",
+		Columns: []*sqlschema.Column{
+			{Name: "id", DataType: sqlschema.DataTypeText, Nullable: false},
+			{Name: "name", DataType: sqlschema.DataTypeText, Nullable: false},
+			{Name: "value", DataType: sqlschema.DataTypeText, Nullable: false},
+			{Name: "org_id", DataType: sqlschema.DataTypeText, Nullable: false},
+		},
+		PrimaryKeyConstraint: &sqlschema.PrimaryKeyConstraint{
+			ColumnNames: []sqlschema.ColumnName{"id"},
+		},
+		ForeignKeyConstraints: []*sqlschema.ForeignKeyConstraint{
+			{
+				ReferencingColumnName: sqlschema.ColumnName("org_id"),
+				ReferencedTableName:   sqlschema.TableName("organizations"),
+				ReferencedColumnName:  sqlschema.ColumnName("id"),
+			},
+		},
+	})
+	sqls = append(sqls, tableSQLs...)
+
+	indexSQLs := migration.sqlschema.Operator().CreateIndex(&sqlschema.UniqueIndex{TableName: "org_preference", ColumnNames: []sqlschema.ColumnName{"name", "org_id"}})
+	sqls = append(sqls, indexSQLs...)
+
+	for _, sql := range sqls {
+		if _, err := tx.ExecContext(ctx, string(sql)); err != nil {
+			return err
+		}
+	}
+
+	orgPreferences := []*newStorableOrgPreference{}
+	for _, preference := range oldOrgPreferences {
+		orgPreferences = append(orgPreferences, &newStorableOrgPreference{
+			Identifiable: preference.Identifiable,
+			Name:         preference.Name,
+			Value:        preference.Value,
+			OrgID:        preference.OrgID,
+		})
+	}
+
+	if len(orgPreferences) > 0 {
+		_, err = tx.
+			NewInsert().
+			Model(&orgPreferences).
+			Exec(ctx)
+		if err != nil {
+			return err
+		}
+	}
+
+	err = tx.Commit()
+	if err != nil {
+		return err
+	}
+
+	return nil
+}
+
+func (migration *updateOrgPreference) Down(ctx context.Context, db *bun.DB) error {
+	return nil
+}

pkg/types/preferencetypes/preference.go

@@ -40,16 +40,16 @@ type UpdatablePreference struct {
 type StorableOrgPreference struct {
 	bun.BaseModel `bun:"table:org_preference"`
 	types.Identifiable
-	Name  Name        `bun:"preference_id,type:text,notnull"`
-	Value string      `bun:"preference_value,type:text,notnull"`
+	Name  Name        `bun:"name,type:text,notnull"`
+	Value string      `bun:"value,type:text,notnull"`
 	OrgID valuer.UUID `bun:"org_id,type:text,notnull"`
 }
 
 type StorableUserPreference struct {
 	bun.BaseModel `bun:"table:user_preference"`
 	types.Identifiable
-	Name   Name        `bun:"preference_id,type:text,notnull"`
-	Value  string      `bun:"preference_value,type:text,notnull"`
+	Name   Name        `bun:"name,type:text,notnull"`
+	Value  string      `bun:"value,type:text,notnull"`
 	UserID valuer.UUID `bun:"user_id,type:text,notnull"`
 }