From f3c4ea01067830c02802bdf34f161aa77689a890 Mon Sep 17 00:00:00 2001 From: kim Date: Wed, 28 May 2025 11:36:14 +0200 Subject: [chore] thread_id migration tweaks (#4198) # Description - add a `migrations run` sub command to allow simply starting / stopping the db service, useful if you want to run *only* the migrations, both for testing or if you have a speedier box you want to run them on - tweaks to log messages - moved more stages outside of transactions, on sqlite if the transactions were getting too lengthy it could occasionally show an `sqlite: disk i/o error` ## Checklist - [x] I/we have read the [GoToSocial contribution guidelines](https://codeberg.org/superseriousbusiness/gotosocial/src/branch/main/CONTRIBUTING.md). - [x] I/we have discussed the proposed changes already, either in an issue on the repository, or in the Matrix chat. - [x] I/we have not leveraged AI to create the proposed changes. - [x] I/we have performed a self-review of added code. - [x] I/we have written code that is legible and maintainable by others. - [x] I/we have commented the added code, particularly in hard-to-understand areas. - [ ] I/we have made any necessary changes to documentation. - [ ] I/we have added tests that cover new code. - [x] I/we have run tests and they pass locally with the changes. - [x] I/we have run `go fmt ./...` and `golangci-lint run`. Reviewed-on: https://codeberg.org/superseriousbusiness/gotosocial/pulls/4198 Co-authored-by: kim Co-committed-by: kim --- cmd/gotosocial/action/migration/run.go | 65 ++++++++++++++++++++++++++++++++++ cmd/gotosocial/main.go | 1 + cmd/gotosocial/migrations.go | 43 ++++++++++++++++++++++ 3 files changed, 109 insertions(+) create mode 100644 cmd/gotosocial/action/migration/run.go create mode 100644 cmd/gotosocial/migrations.go (limited to 'cmd') diff --git a/cmd/gotosocial/action/migration/run.go b/cmd/gotosocial/action/migration/run.go new file mode 100644 index 000000000..61cec035b --- /dev/null +++ b/cmd/gotosocial/action/migration/run.go @@ -0,0 +1,65 @@ +// GoToSocial +// Copyright (C) GoToSocial Authors admin@gotosocial.org +// SPDX-License-Identifier: AGPL-3.0-or-later +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU Affero General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// (at your option) any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU Affero General Public License for more details. +// +// You should have received a copy of the GNU Affero General Public License +// along with this program. If not, see . + +package migration + +import ( + "context" + "fmt" + + "code.superseriousbusiness.org/gotosocial/cmd/gotosocial/action" + "code.superseriousbusiness.org/gotosocial/internal/db/bundb" + "code.superseriousbusiness.org/gotosocial/internal/log" + "code.superseriousbusiness.org/gotosocial/internal/state" +) + +// Run will initialize the database, running any available migrations. +var Run action.GTSAction = func(ctx context.Context) error { + var state state.State + + defer func() { + if state.DB != nil { + // Lastly, if database service was started, + // ensure it gets closed now all else stopped. + if err := state.DB.Close(); err != nil { + log.Errorf(ctx, "error stopping database: %v", err) + } + } + + // Finally reached end of shutdown. + log.Info(ctx, "done! exiting...") + }() + + // Initialize caches + state.Caches.Init() + if err := state.Caches.Start(); err != nil { + return fmt.Errorf("error starting caches: %w", err) + } + + log.Info(ctx, "starting db service...") + + // Open connection to the database now caches started. + dbService, err := bundb.NewBunDBService(ctx, &state) + if err != nil { + return fmt.Errorf("error creating dbservice: %s", err) + } + + // Set DB on state. + state.DB = dbService + + return nil +} diff --git a/cmd/gotosocial/main.go b/cmd/gotosocial/main.go index 5124147a7..c9bcef2b8 100644 --- a/cmd/gotosocial/main.go +++ b/cmd/gotosocial/main.go @@ -55,6 +55,7 @@ func main() { rootCmd.AddCommand(serverCommands()) rootCmd.AddCommand(debugCommands()) rootCmd.AddCommand(adminCommands()) + rootCmd.AddCommand(migrationCommands()) // Testrigcmd will only be set when debug is enabled. if testrigCmd := testrigCommands(); testrigCmd != nil { diff --git a/cmd/gotosocial/migrations.go b/cmd/gotosocial/migrations.go new file mode 100644 index 000000000..bd30192ea --- /dev/null +++ b/cmd/gotosocial/migrations.go @@ -0,0 +1,43 @@ +// GoToSocial +// Copyright (C) GoToSocial Authors admin@gotosocial.org +// SPDX-License-Identifier: AGPL-3.0-or-later +// +// This program is free software: you can redistribute it and/or modify +// it under the terms of the GNU Affero General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// (at your option) any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU Affero General Public License for more details. +// +// You should have received a copy of the GNU Affero General Public License +// along with this program. If not, see . + +package main + +import ( + "code.superseriousbusiness.org/gotosocial/cmd/gotosocial/action/migration" + "github.com/spf13/cobra" +) + +// migrationCommands returns the 'migrations' subcommand +func migrationCommands() *cobra.Command { + migrationCmd := &cobra.Command{ + Use: "migrations", + Short: "gotosocial migrations-related tasks", + } + migrationRunCmd := &cobra.Command{ + Use: "run", + Short: "starts and stops the database, running any outstanding migrations", + PreRunE: func(cmd *cobra.Command, args []string) error { + return preRun(preRunArgs{cmd: cmd}) + }, + RunE: func(cmd *cobra.Command, args []string) error { + return run(cmd.Context(), migration.Run) + }, + } + migrationCmd.AddCommand(migrationRunCmd) + return migrationCmd +} -- cgit v1.3