Added a migration for migrating to int64-ids

.github/workflows/test_migration.yml

@@ -36,6 +36,7 @@ jobs:
         env:
           CI_EXIT_AFTER_MIGRATION: "true"
           CI_AUTO_MIGRATION: "false"
+          DB_NAME: campus_db
           DB_DSN: root:super_secret_passw0rd@tcp(localhost:3306)/campus_db?charset=utf8mb4&parseTime=True&loc=Local
           ENVIRONMENT: dev
       - name: run auto migrations
@@ -44,6 +45,7 @@ jobs:
         env:
           CI_EXIT_AFTER_MIGRATION: "true"
           CI_AUTO_MIGRATION: "true"
+          DB_NAME: campus_db
           DB_DSN: root:super_secret_passw0rd@tcp(localhost:3300)/campus_db?charset=utf8mb4&parseTime=True&loc=Local
           ENVIRONMENT: dev
       - uses: ariga/setup-atlas@master

.vscode/launch.json

@@ -11,7 +11,8 @@
             "mode": "auto",
             "program": "${workspaceFolder}/server/main.go",
             "env": {
-                "DB_DSN": "gorm:GORM_USER_PASSWORD@tcp(localhost:3306)/campus_backend"
+                "DB_DSN": "gorm:GORM_USER_PASSWORD@tcp(localhost:3306)/campus_backend",
+                "DB_NAME": "campus_backend"
             }
         },
         {

README.md

@@ -62,6 +62,7 @@ To start the server there are environment variables, as well as command line opt
 ```bash
 cd  server
 export DB_DSN="Your gorm DB connection string for example: gorm:GORM_USER_PASSWORD@tcp(localhost:3306)/campus_backend"
+export DB_DSN="The DB-name from above string for example: campus_backend"
 go run ./main.go
 ```
 
@@ -70,6 +71,7 @@ go run ./main.go
 There are a few environment variables available:
 
 * [REQUIRED] `DB_DSN`: The [GORM](https://gorm.io/) [DB connection string](https://gorm.io/docs/connecting_to_the_database.html#MySQL) for connecting to the MySQL DB. Example: `gorm@tcp(localhost:3306)/campus_backend`
+* [REQUIRED] `DB_DSN`: The name of the database from above connection string. Example: `campus_backend`
 * [OPTIONAL] `SENTRY_DSN`: The Sentry [Data Source Name](https://sentry-docs-git-patch-1.sentry.dev/product/sentry-basics/dsn-explainer/) for reporting issues and crashes.
 
 ## Running the Server (Docker)

deployment/charts/backend/templates/deployments/backend-v2.yaml

@@ -85,6 +85,8 @@ spec:
                   key: SMTP_PORT
             - name: DB_DSN
               value: "{{ $db.username }}:{{ $db.password }}@tcp(tca-backend-mariadb.{{ $.Values.namespace }}.svc.cluster.local:3306)/{{ $db.database }}?charset=utf8mb4&parseTime=True&loc=Local"
+            - name: DB_NAME
+              value: {{ $db.database }}
           volumeMounts:
             - mountPath: /Storage/
               name: storage-vol

docker-compose.yaml

@@ -10,6 +10,7 @@ services:
       - 50051:50051
     environment:
       - DB_DSN=root:${DB_ROOT_PASSWORD}@tcp(db:${DB_PORT:-3306})/${DB_NAME}?charset=utf8mb4&parseTime=True&loc=Local
+      - DB_NAME=${DB_NAME}
       - ENVIRONMENT=dev
       - SENTRY_DSN=${SENTRY_DSN}
       - OMDB_API_KEY=${OMDB_API_KEY}

server/backend/migration/20240316000000.go

@@ -0,0 +1,197 @@
+package migration
+
+import (
+	"fmt"
+
+	"github.com/go-gormigrate/gormigrate/v2"
+	"gorm.io/gorm"
+)
+
+type tableWithWrongfield struct {
+	table string
+	field string
+}
+type fkNeedingMigration struct {
+	fromTable      string
+	fromColumn     string
+	toTable        string
+	toColumn       string
+	constraintName string
+}
+
+func tablesWithWrongId() []tableWithWrongfield {
+	return []tableWithWrongfield{
+		// PKs which are int32
+		{"alarm_ban", "ban"},
+		{"alarm_log", "alarm"},
+		{"barrierFree_moreInfo", "id"},
+		{"barrierFree_persons", "id"},
+		{"chat_message", "message"},
+		{"chat_room2members", "room2members"},
+		{"crontab", "cron"},
+		{"curricula", "curriculum"},
+		{"dish2dishflags", "dish2dishflags"},
+		{"dish2mensa", "dish2mensa"},
+		{"feedback", "id"},
+		{"log", "log"},
+		{"mensaplan_mensa", "id"},
+		{"mensaprices", "price"},
+		{"modules", "module"},
+		{"news_alert", "news_alert"},
+		{"openinghours", "id"},
+		{"recover", "recover"},
+		{"reports", "report"},
+		{"ticket_admin2group", "ticket_admin2group"},
+		{"ticket_history", "ticket_history"},
+		{"wifi_measurement", "id"},
+		{"update_note", "version_code"},
+		// should have been a fk, but is an index
+		{"question", "member"},
+		// multi-pk-indexes
+		{"roomfinder_buildings2maps", "map_id"},
+		{"roomfinder_maps", "map_id"},
+		{"roomfinder_rooms", "room_id"},
+		{"roomfinder_rooms2maps", "room_id"},
+		{"roomfinder_rooms2maps", "map_id"},
+		{"roomfinder_schedules", "room_id"},
+	}
+}
+
+// tablesWithWrongFk tells a user which FKs exist that have a int-ish type
+// can be generated via:
+// ```sql
+// with fks as (select fks.table_name            as from_table,
+//
+//	               group_concat(kcu.COLUMN_NAME
+//	                            order by position_in_unique_constraint separator ', ')
+//	                                         as from_columns,
+//	               fks.referenced_table_name as to_table,
+//	               group_concat(kcu.REFERENCED_COLUMN_NAME
+//	                            order by position_in_unique_constraint separator ', ')
+//	                                         as to_columns,
+//	               fks.constraint_name
+//	        from information_schema.referential_constraints fks
+//	                 join information_schema.key_column_usage kcu
+//	                      on fks.constraint_schema = kcu.table_schema
+//	                          and fks.table_name = kcu.table_name
+//	                          and fks.constraint_name = kcu.constraint_name
+//	        where fks.constraint_schema = 'campus_db'
+//	        group by fks.constraint_schema,
+//	                 fks.table_name,
+//	                 fks.unique_constraint_schema,
+//	                 fks.referenced_table_name,
+//	                 fks.constraint_name
+//	        order by fks.constraint_schema,
+//	                 fks.table_name),
+//	tables_with_matching_type as (SELECT TABLE_NAME, COLUMN_NAME
+//	                              from information_schema.columns
+//	                              WHERE DATA_TYPE like '%int%'
+//	                                and TABLE_SCHEMA = 'campus_db')
+//
+// SELECT f.*
+// from fks f
+// WHERE EXISTS(SELECT *
+//
+//	FROM tables_with_matching_type t
+//	where t.TABLE_NAME = f.from_table
+//	  and t.COLUMN_NAME = f.from_columns);
+func tablesWithWrongFk() []fkNeedingMigration {
+	return []fkNeedingMigration{
+		{"chat_message", "member", "member", "member", "chat_message_ibfk_1"},
+		{"chat_message", "room", "chat_room", "room", "FK_chat_message_chat_room"},
+		{"chat_room2members", "room", "chat_room", "room", "FK_chat_room2members_chat_room"},
+		{"chat_room2members", "member", "member", "member", "chat_room2members_ibfk_2"},
+		{"device2stats", "device", "devices", "device", "device2stats_ibfk_2"},
+		{"devices", "member", "member", "member", "devices_ibfk_1"},
+		{"dish2dishflags", "dish", "dish", "dish", "dish2dishflags_ibfk_1"},
+		{"dish2dishflags", "flag", "dishflags", "flag", "dish2dishflags_ibfk_2"},
+		{"dish2mensa", "mensa", "mensa", "mensa", "dish2mensa_ibfk_1"},
+		{"dish2mensa", "dish", "dish", "dish", "dish2mensa_ibfk_2"},
+		{"dish_rating", "dishID", "dish", "dish", "dish_rating_dish_dish_fk"},
+		{"event", "news", "news", "news", "fkNews"},
+		{"event", "kino", "kino", "kino", "fkKino"},
+		{"event", "file", "files", "file", "fkEventFile"},
+		{"event", "ticket_group", "ticket_group", "ticket_group", "fkEventGroup"},
+		{"kino", "cover", "files", "file", "kino_ibfk_1"},
+		{"log", "user_executed", "users", "user", "fkLog2UsersEx"},
+		{"log", "user_affected", "users", "user", "fkLog2UsersAf"},
+		{"log", "action", "actions", "action", "fkLog2Actions"},
+		{"menu", "right", "rights", "right", "menu_ibfk_1"},
+		{"menu", "parent", "menu", "menu", "menu_ibfk_2"},
+		{"modules", "right", "rights", "right", "fkMod2Rights"},
+		{"news", "src", "newsSource", "source", "news_ibfk_1"},
+		{"news", "file", "files", "file", "news_ibfk_2"},
+		{"newsSource", "icon", "files", "file", "newsSource_ibfk_1"},
+		{"notification", "type", "notification_type", "type", "notification_ibfk_1"},
+		{"notification", "location", "location", "location", "notification_ibfk_2"},
+		{"notification_confirmation", "notification", "notification", "notification", "notification_confirmation_ibfk_1"},
+		{"notification_confirmation", "device", "devices", "device", "notification_confirmation_ibfk_2"},
+		{"question2answer", "question", "question", "question", "question2answer_question_question_fk"},
+		{"question2answer", "answer", "questionAnswers", "answer", "question2answer_questionAnswers_answer_fk"},
+		{"question2answer", "member", "member", "member", "question2answer_member_member_fk"},
+		{"question2faculty", "question", "question", "question", "question2faculty_ibfk_1"},
+		{"question2faculty", "faculty", "faculty", "faculty", "question2faculty_ibfk_2"},
+		{"recover", "user", "users", "user", "fkRecover2User"},
+		{"reports", "device", "devices", "device", "reports_ibfk_3"},
+		{"roles2rights", "role", "roles", "role", "fkRole"},
+		{"roles2rights", "right", "rights", "right", "fkRight"},
+		{"ticket_admin2group", "ticket_admin", "ticket_admin", "ticket_admin", "fkTicketAdmin"},
+		{"ticket_admin2group", "ticket_group", "ticket_group", "ticket_group", "fkTicketGroup"},
+		{"ticket_history", "member", "member", "member", "fkMember"},
+		{"ticket_history", "ticket_payment", "ticket_payment", "ticket_payment", "fkTicketPayment"},
+		{"ticket_history", "ticket_type", "ticket_type", "ticket_type", "fkTicketType"},
+		{"ticket_type", "event", "event", "event", "fkEvent"},
+		{"ticket_type", "ticket_payment", "ticket_payment", "ticket_payment", "fkPayment"},
+		{"users2info", "user", "users", "user", "fkUsers"},
+		{"users2roles", "user", "users", "user", "fkUser2RolesUser"},
+		{"users2roles", "role", "roles", "role", "fkUser2RolesRole"},
+	}
+}
+
+func migrateField(tx *gorm.DB, table string, field string, typeDefiniton string) error {
+	// change both the origin of the fk and the destination to be a bigint
+	if err := tx.Exec(fmt.Sprintf("ALTER TABLE `%s` CHANGE `%s` `%s` %s", table, field, field, typeDefiniton)).Error; err != nil {
+		return err
+	}
+	// data is still stored as int32, but we can change this
+	if err := tx.Exec(fmt.Sprintf("UPDATE `%s` SET `%s` = CAST(`%s` AS UNSIGNED INTEGER)", table, field, field)).Error; err != nil {
+		return err
+	}
+	return nil
+}
+
+// migrate20240316000000
+// made sure that all ids are int64
+func migrate20240316000000() *gormigrate.Migration {
+	return &gormigrate.Migration{
+		ID: "20240316000000",
+		Migrate: func(tx *gorm.DB) error {
+			for _, f := range tablesWithWrongFk() {
+				if err := tx.Exec(fmt.Sprintf("alter table `%s` DROP FOREIGN KEY `%s`", f.fromTable, f.constraintName)).Error; err != nil {
+					return err
+				}
+			}
+			for _, f := range tablesWithWrongFk() {
+				if err := migrateField(tx, f.fromTable, f.fromColumn, "BIGINT NOT NULL"); err != nil {
+					return err
+				}
+				if err := migrateField(tx, f.toTable, f.toColumn, "BIGINT NOT NULL AUTO_INCREMENT"); err != nil {
+					return err
+				}
+			}
+			for _, f := range tablesWithWrongFk() {
+				if err := tx.Exec(fmt.Sprintf("ALTER TABLE `%s` ADD CONSTRAINT `%s` FOREIGN KEY (`%s`) REFERENCES `%s` (`%s`)", f.fromTable, f.constraintName, f.fromColumn, f.toTable, f.toColumn)).Error; err != nil {
+					return err
+				}
+			}
+			// because we have migrated all fk relationships, this does not mean that we have migrated all primary keys => this is done this way
+			for _, t := range tablesWithWrongId() {
+				if err := migrateField(tx, t.table, t.field, "BIGINT NOT NULL"); err != nil {
+					return err
+				}
+			}
+			return nil
+		},
+		// intentionally no rollback function as this would be lossy!
+	}
+}