[chore/performance] Update media prune logic, add extra CLI command (#1474)

* start updating media prune stuff a wee bit

* continue prune / uncache work

* more tidying + consistency stuff

* add prune CLI command

* docs

* arg

cmd/gotosocial/action/admin/media/prune/common.go

@@ -0,0 +1,78 @@
+/*
+   GoToSocial
+   Copyright (C) 2021-2023 GoToSocial Authors admin@gotosocial.org
+
+   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 <http://www.gnu.org/licenses/>.
+*/
+
+package prune
+
+import (
+	"context"
+	"fmt"
+
+	"github.com/superseriousbusiness/gotosocial/internal/db"
+	"github.com/superseriousbusiness/gotosocial/internal/db/bundb"
+	"github.com/superseriousbusiness/gotosocial/internal/media"
+	"github.com/superseriousbusiness/gotosocial/internal/state"
+	gtsstorage "github.com/superseriousbusiness/gotosocial/internal/storage"
+)
+
+type prune struct {
+	dbService db.DB
+	storage   *gtsstorage.Driver
+	manager   media.Manager
+}
+
+func setupPrune(ctx context.Context) (*prune, error) {
+	var state state.State
+	state.Caches.Init()
+
+	dbService, err := bundb.NewBunDBService(ctx, &state)
+	if err != nil {
+		return nil, fmt.Errorf("error creating dbservice: %w", err)
+	}
+
+	storage, err := gtsstorage.AutoConfig() //nolint:contextcheck
+	if err != nil {
+		return nil, fmt.Errorf("error creating storage backend: %w", err)
+	}
+
+	manager, err := media.NewManager(dbService, storage) //nolint:contextcheck
+	if err != nil {
+		return nil, fmt.Errorf("error instantiating mediamanager: %w", err)
+	}
+
+	return &prune{
+		dbService: dbService,
+		storage:   storage,
+		manager:   manager,
+	}, nil
+}
+
+func (p *prune) shutdown(ctx context.Context) error {
+	if err := p.storage.Close(); err != nil {
+		return fmt.Errorf("error closing storage backend: %w", err)
+	}
+
+	if err := p.dbService.Stop(ctx); err != nil {
+		return fmt.Errorf("error closing dbservice: %w", err)
+	}
+
+	if err := p.manager.Stop(); err != nil {
+		return fmt.Errorf("error closing media manager: %w", err)
+	}
+
+	return nil
+}

cmd/gotosocial/action/admin/media/prune/orphaned.go

@@ -24,53 +24,28 @@ import (
 
 	"github.com/superseriousbusiness/gotosocial/cmd/gotosocial/action"
 	"github.com/superseriousbusiness/gotosocial/internal/config"
-	"github.com/superseriousbusiness/gotosocial/internal/db/bundb"
 	"github.com/superseriousbusiness/gotosocial/internal/log"
-	"github.com/superseriousbusiness/gotosocial/internal/media"
-	"github.com/superseriousbusiness/gotosocial/internal/state"
-	gtsstorage "github.com/superseriousbusiness/gotosocial/internal/storage"
 )
 
 // Orphaned prunes orphaned media from storage.
 var Orphaned action.GTSAction = func(ctx context.Context) error {
-	var state state.State
-	state.Caches.Init()
-
-	dbService, err := bundb.NewBunDBService(ctx, &state)
+	prune, err := setupPrune(ctx)
 	if err != nil {
-		return fmt.Errorf("error creating dbservice: %s", err)
-	}
-
-	storage, err := gtsstorage.AutoConfig()
-	if err != nil {
-		return fmt.Errorf("error creating storage backend: %w", err)
-	}
-
-	manager, err := media.NewManager(dbService, storage)
-	if err != nil {
-		return fmt.Errorf("error instantiating mediamanager: %s", err)
+		return err
 	}
 
 	dry := config.GetAdminMediaPruneDryRun()
 
-	pruned, err := manager.PruneOrphaned(ctx, dry)
+	pruned, err := prune.manager.PruneOrphaned(ctx, dry)
 	if err != nil {
 		return fmt.Errorf("error pruning: %s", err)
 	}
 
 	if dry /* dick heyyoooooo */ {
-		log.Infof("DRY RUN: %d stored items are orphaned and eligible to be pruned", pruned)
+		log.Infof("DRY RUN: %d items are orphaned and eligible to be pruned", pruned)
 	} else {
-		log.Infof("%d stored items were orphaned and pruned", pruned)
+		log.Infof("%d orphaned items were pruned", pruned)
 	}
 
-	if err := storage.Close(); err != nil {
-		return fmt.Errorf("error closing storage backend: %w", err)
-	}
-
-	if err := dbService.Stop(ctx); err != nil {
-		return fmt.Errorf("error closing dbservice: %s", err)
-	}
-
-	return nil
+	return prune.shutdown(ctx)
 }

cmd/gotosocial/action/admin/media/prune/remote.go

@@ -0,0 +1,58 @@
+/*
+   GoToSocial
+   Copyright (C) 2021-2023 GoToSocial Authors admin@gotosocial.org
+
+   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 <http://www.gnu.org/licenses/>.
+*/
+
+package prune
+
+import (
+	"context"
+	"fmt"
+
+	"github.com/superseriousbusiness/gotosocial/cmd/gotosocial/action"
+	"github.com/superseriousbusiness/gotosocial/internal/config"
+	"github.com/superseriousbusiness/gotosocial/internal/log"
+)
+
+// Remote prunes old and/or unused remote media.
+var Remote action.GTSAction = func(ctx context.Context) error {
+	prune, err := setupPrune(ctx)
+	if err != nil {
+		return err
+	}
+
+	dry := config.GetAdminMediaPruneDryRun()
+
+	pruned, err := prune.manager.PruneUnusedRemote(ctx, dry)
+	if err != nil {
+		return fmt.Errorf("error pruning: %w", err)
+	}
+
+	uncached, err := prune.manager.UncacheRemote(ctx, config.GetMediaRemoteCacheDays(), dry)
+	if err != nil {
+		return fmt.Errorf("error pruning: %w", err)
+	}
+
+	total := pruned + uncached
+
+	if dry /* dick heyyoooooo */ {
+		log.Infof("DRY RUN: %d remote items are unused/stale and eligible to be pruned", total)
+	} else {
+		log.Infof("%d unused/stale remote items were pruned", pruned)
+	}
+
+	return prune.shutdown(ctx)
+}

cmd/gotosocial/action/server/server.go

@@ -231,11 +231,6 @@ var Start action.GTSAction = func(ctx context.Context) error {
 		return fmt.Errorf("error starting gotosocial service: %s", err)
 	}
 
-	// perform initial media prune in case value of MediaRemoteCacheDays changed
-	if err := processor.AdminMediaPrune(ctx, config.GetMediaRemoteCacheDays()); err != nil {
-		return fmt.Errorf("error during initial media prune: %s", err)
-	}
-
 	// catch shutdown signals from the operating system
 	sigs := make(chan os.Signal, 1)
 	signal.Notify(sigs, syscall.SIGINT, syscall.SIGTERM)

cmd/gotosocial/admin.go

@@ -169,7 +169,6 @@ func adminCommands() *cobra.Command {
 		Use:   "prune",
 		Short: "admin commands for pruning unused/orphaned media from storage",
 	}
-	config.AddAdminMediaPrune(adminMediaPruneCmd)
 
 	adminMediaPruneOrphanedCmd := &cobra.Command{
 		Use:   "orphaned",
@@ -184,6 +183,19 @@ func adminCommands() *cobra.Command {
 	config.AddAdminMediaPrune(adminMediaPruneOrphanedCmd)
 	adminMediaPruneCmd.AddCommand(adminMediaPruneOrphanedCmd)
 
+	adminMediaPruneRemoteCmd := &cobra.Command{
+		Use:   "remote",
+		Short: "prune unused/stale remote media from storage, older than given number of days",
+		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(), prune.Remote)
+		},
+	}
+	config.AddAdminMediaPrune(adminMediaPruneRemoteCmd)
+	adminMediaPruneCmd.AddCommand(adminMediaPruneRemoteCmd)
+
 	adminMediaCmd.AddCommand(adminMediaPruneCmd)
 
 	adminCmd.AddCommand(adminMediaCmd)