From fcb9c0bb8bed51ffb856b8e47f4e047ddd75eb67 Mon Sep 17 00:00:00 2001 From: kim <89579420+NyaaaWhatsUpDoc@users.noreply.github.com> Date: Thu, 24 Nov 2022 08:35:46 +0000 Subject: [PATCH] [chore] cleanup storage implementation, no need for multiple interface types (#1131) Signed-off-by: kim Signed-off-by: kim --- cmd/gotosocial/action/testrig/testrig.go | 2 +- internal/api/client/account/account_test.go | 2 +- internal/api/client/admin/admin_test.go | 2 +- internal/api/client/auth/auth_test.go | 2 +- .../api/client/fileserver/servefile_test.go | 2 +- .../followrequest/followrequest_test.go | 2 +- internal/api/client/instance/instance_test.go | 2 +- internal/api/client/media/mediacreate_test.go | 2 +- internal/api/client/media/mediaupdate_test.go | 2 +- internal/api/client/status/status_test.go | 2 +- internal/api/client/user/user_test.go | 2 +- internal/api/s2s/emoji/emojiget_test.go | 2 +- internal/api/s2s/user/user_test.go | 2 +- internal/api/s2s/webfinger/webfinger_test.go | 2 +- .../dereferencing/dereferencer_test.go | 2 +- internal/federation/federator_test.go | 2 +- internal/media/manager.go | 4 +- internal/media/manager_test.go | 13 ++- internal/media/media_test.go | 2 +- internal/media/processingemoji.go | 2 +- internal/media/processingmedia.go | 2 +- internal/media/util.go | 2 +- internal/processing/account/account_test.go | 2 +- internal/processing/media/media.go | 4 +- internal/processing/media/media_test.go | 2 +- internal/processing/processor.go | 4 +- internal/processing/processor_test.go | 2 +- internal/processing/status/status_test.go | 2 +- internal/storage/local.go | 34 -------- internal/storage/s3.go | 50 ------------ internal/storage/storage.go | 79 +++++++++++++------ testrig/federator.go | 2 +- testrig/mediahandler.go | 2 +- testrig/processor.go | 2 +- testrig/storage.go | 65 +++++++-------- 35 files changed, 129 insertions(+), 178 deletions(-) delete mode 100644 internal/storage/local.go delete mode 100644 internal/storage/s3.go diff --git a/cmd/gotosocial/action/testrig/testrig.go b/cmd/gotosocial/action/testrig/testrig.go index e5436878f..2259f7148 100644 --- a/cmd/gotosocial/action/testrig/testrig.go +++ b/cmd/gotosocial/action/testrig/testrig.go @@ -71,7 +71,7 @@ var Start action.GTSAction = func(ctx context.Context) error { dbService := testrig.NewTestDB() testrig.StandardDBSetup(dbService, nil) router := testrig.NewTestRouter(dbService) - var storageBackend storage.Driver + var storageBackend *storage.Driver if os.Getenv("GTS_STORAGE_BACKEND") == "s3" { storageBackend = testrig.NewS3Storage() } else { diff --git a/internal/api/client/account/account_test.go b/internal/api/client/account/account_test.go index 6275e89c1..90dbd6249 100644 --- a/internal/api/client/account/account_test.go +++ b/internal/api/client/account/account_test.go @@ -45,7 +45,7 @@ type AccountStandardTestSuite struct { // standard suite interfaces suite.Suite db db.DB - storage storage.Driver + storage *storage.Driver mediaManager media.Manager federator federation.Federator processor processing.Processor diff --git a/internal/api/client/admin/admin_test.go b/internal/api/client/admin/admin_test.go index 9303ee3f2..52c2630d9 100644 --- a/internal/api/client/admin/admin_test.go +++ b/internal/api/client/admin/admin_test.go @@ -45,7 +45,7 @@ type AdminStandardTestSuite struct { // standard suite interfaces suite.Suite db db.DB - storage storage.Driver + storage *storage.Driver mediaManager media.Manager federator federation.Federator processor processing.Processor diff --git a/internal/api/client/auth/auth_test.go b/internal/api/client/auth/auth_test.go index d84db058a..75e958418 100644 --- a/internal/api/client/auth/auth_test.go +++ b/internal/api/client/auth/auth_test.go @@ -48,7 +48,7 @@ import ( type AuthStandardTestSuite struct { suite.Suite db db.DB - storage storage.Driver + storage *storage.Driver mediaManager media.Manager federator federation.Federator processor processing.Processor diff --git a/internal/api/client/fileserver/servefile_test.go b/internal/api/client/fileserver/servefile_test.go index 8e9cbe548..a6c46e23f 100644 --- a/internal/api/client/fileserver/servefile_test.go +++ b/internal/api/client/fileserver/servefile_test.go @@ -48,7 +48,7 @@ type ServeFileTestSuite struct { // standard suite interfaces suite.Suite db db.DB - storage storage.Driver + storage *storage.Driver federator federation.Federator tc typeutils.TypeConverter processor processing.Processor diff --git a/internal/api/client/followrequest/followrequest_test.go b/internal/api/client/followrequest/followrequest_test.go index 44c9ef9ea..ca00ea054 100644 --- a/internal/api/client/followrequest/followrequest_test.go +++ b/internal/api/client/followrequest/followrequest_test.go @@ -43,7 +43,7 @@ import ( type FollowRequestStandardTestSuite struct { suite.Suite db db.DB - storage storage.Driver + storage *storage.Driver mediaManager media.Manager federator federation.Federator processor processing.Processor diff --git a/internal/api/client/instance/instance_test.go b/internal/api/client/instance/instance_test.go index efdf86523..26f29027d 100644 --- a/internal/api/client/instance/instance_test.go +++ b/internal/api/client/instance/instance_test.go @@ -44,7 +44,7 @@ type InstanceStandardTestSuite struct { // standard suite interfaces suite.Suite db db.DB - storage storage.Driver + storage *storage.Driver mediaManager media.Manager federator federation.Federator processor processing.Processor diff --git a/internal/api/client/media/mediacreate_test.go b/internal/api/client/media/mediacreate_test.go index e1e84c1c1..2f6fb12a4 100644 --- a/internal/api/client/media/mediacreate_test.go +++ b/internal/api/client/media/mediacreate_test.go @@ -54,7 +54,7 @@ type MediaCreateTestSuite struct { // standard suite interfaces suite.Suite db db.DB - storage *storage.Local + storage *storage.Driver mediaManager media.Manager federator federation.Federator tc typeutils.TypeConverter diff --git a/internal/api/client/media/mediaupdate_test.go b/internal/api/client/media/mediaupdate_test.go index 1596c608f..e5abb0a91 100644 --- a/internal/api/client/media/mediaupdate_test.go +++ b/internal/api/client/media/mediaupdate_test.go @@ -52,7 +52,7 @@ type MediaUpdateTestSuite struct { // standard suite interfaces suite.Suite db db.DB - storage storage.Driver + storage *storage.Driver federator federation.Federator tc typeutils.TypeConverter mediaManager media.Manager diff --git a/internal/api/client/status/status_test.go b/internal/api/client/status/status_test.go index def13a23a..7c3f094f2 100644 --- a/internal/api/client/status/status_test.go +++ b/internal/api/client/status/status_test.go @@ -43,7 +43,7 @@ type StatusStandardTestSuite struct { federator federation.Federator emailSender email.Sender processor processing.Processor - storage storage.Driver + storage *storage.Driver // standard suite models testTokens map[string]*gtsmodel.Token diff --git a/internal/api/client/user/user_test.go b/internal/api/client/user/user_test.go index 18986c98d..cc4fafca9 100644 --- a/internal/api/client/user/user_test.go +++ b/internal/api/client/user/user_test.go @@ -42,7 +42,7 @@ type UserStandardTestSuite struct { federator federation.Federator emailSender email.Sender processor processing.Processor - storage storage.Driver + storage *storage.Driver testTokens map[string]*gtsmodel.Token testClients map[string]*gtsmodel.Client diff --git a/internal/api/s2s/emoji/emojiget_test.go b/internal/api/s2s/emoji/emojiget_test.go index 959204c7e..5a25caf38 100644 --- a/internal/api/s2s/emoji/emojiget_test.go +++ b/internal/api/s2s/emoji/emojiget_test.go @@ -50,7 +50,7 @@ type EmojiGetTestSuite struct { federator federation.Federator emailSender email.Sender processor processing.Processor - storage storage.Driver + storage *storage.Driver oauthServer oauth.Server securityModule *security.Module diff --git a/internal/api/s2s/user/user_test.go b/internal/api/s2s/user/user_test.go index 2c320d640..444e9cab5 100644 --- a/internal/api/s2s/user/user_test.go +++ b/internal/api/s2s/user/user_test.go @@ -45,7 +45,7 @@ type UserStandardTestSuite struct { federator federation.Federator emailSender email.Sender processor processing.Processor - storage storage.Driver + storage *storage.Driver oauthServer oauth.Server securityModule *security.Module diff --git a/internal/api/s2s/webfinger/webfinger_test.go b/internal/api/s2s/webfinger/webfinger_test.go index d4b721300..e5d026d06 100644 --- a/internal/api/s2s/webfinger/webfinger_test.go +++ b/internal/api/s2s/webfinger/webfinger_test.go @@ -50,7 +50,7 @@ type WebfingerStandardTestSuite struct { federator federation.Federator emailSender email.Sender processor processing.Processor - storage storage.Driver + storage *storage.Driver oauthServer oauth.Server securityModule *security.Module diff --git a/internal/federation/dereferencing/dereferencer_test.go b/internal/federation/dereferencing/dereferencer_test.go index 1bf11d668..345d94704 100644 --- a/internal/federation/dereferencing/dereferencer_test.go +++ b/internal/federation/dereferencing/dereferencer_test.go @@ -33,7 +33,7 @@ import ( type DereferencerStandardTestSuite struct { suite.Suite db db.DB - storage storage.Driver + storage *storage.Driver testRemoteStatuses map[string]vocab.ActivityStreamsNote testRemotePeople map[string]vocab.ActivityStreamsPerson diff --git a/internal/federation/federator_test.go b/internal/federation/federator_test.go index be22901a7..1b4e00182 100644 --- a/internal/federation/federator_test.go +++ b/internal/federation/federator_test.go @@ -31,7 +31,7 @@ import ( type FederatorStandardTestSuite struct { suite.Suite db db.DB - storage storage.Driver + storage *storage.Driver tc typeutils.TypeConverter testAccounts map[string]*gtsmodel.Account testStatuses map[string]*gtsmodel.Status diff --git a/internal/media/manager.go b/internal/media/manager.go index 62998156e..d04f161d4 100644 --- a/internal/media/manager.go +++ b/internal/media/manager.go @@ -100,7 +100,7 @@ type Manager interface { type manager struct { db db.DB - storage storage.Driver + storage *storage.Driver emojiWorker *concurrency.WorkerPool[*ProcessingEmoji] mediaWorker *concurrency.WorkerPool[*ProcessingMedia] stopCronJobs func() error @@ -112,7 +112,7 @@ type manager struct { // a limited number of media will be processed in parallel. The numbers of workers // is determined from the $GOMAXPROCS environment variable (usually no. CPU cores). // See internal/concurrency.NewWorkerPool() documentation for further information. -func NewManager(database db.DB, storage storage.Driver) (Manager, error) { +func NewManager(database db.DB, storage *storage.Driver) (Manager, error) { m := &manager{ db: database, storage: storage, diff --git a/internal/media/manager_test.go b/internal/media/manager_test.go index 3955c1b63..659740af6 100644 --- a/internal/media/manager_test.go +++ b/internal/media/manager_test.go @@ -927,14 +927,19 @@ func (suite *ManagerTestSuite) TestSimpleJpegProcessBlockingWithDiskStorage() { temp := fmt.Sprintf("%s/gotosocial-test", os.TempDir()) defer os.RemoveAll(temp) - diskStorage, err := kv.OpenDisk(temp, &storage.DiskConfig{ + disk, err := storage.OpenDisk(temp, &storage.DiskConfig{ LockFile: path.Join(temp, "store.lock"), }) if err != nil { panic(err) } - diskManager, err := media.NewManager(suite.db, >sstorage.Local{KVStore: diskStorage}) + storage := >sstorage.Driver{ + KVStore: kv.New(disk), + Storage: disk, + } + + diskManager, err := media.NewManager(suite.db, storage) if err != nil { panic(err) } @@ -974,7 +979,7 @@ func (suite *ManagerTestSuite) TestSimpleJpegProcessBlockingWithDiskStorage() { suite.NotNil(dbAttachment) // make sure the processed file is in storage - processedFullBytes, err := diskStorage.Get(ctx, attachment.File.Path) + processedFullBytes, err := storage.Get(ctx, attachment.File.Path) suite.NoError(err) suite.NotEmpty(processedFullBytes) @@ -987,7 +992,7 @@ func (suite *ManagerTestSuite) TestSimpleJpegProcessBlockingWithDiskStorage() { suite.Equal(processedFullBytesExpected, processedFullBytes) // now do the same for the thumbnail and make sure it's what we expected - processedThumbnailBytes, err := diskStorage.Get(ctx, attachment.Thumbnail.Path) + processedThumbnailBytes, err := storage.Get(ctx, attachment.Thumbnail.Path) suite.NoError(err) suite.NotEmpty(processedThumbnailBytes) diff --git a/internal/media/media_test.go b/internal/media/media_test.go index e2c3914a3..435994073 100644 --- a/internal/media/media_test.go +++ b/internal/media/media_test.go @@ -31,7 +31,7 @@ type MediaStandardTestSuite struct { suite.Suite db db.DB - storage storage.Driver + storage *storage.Driver manager media.Manager testAttachments map[string]*gtsmodel.MediaAttachment testAccounts map[string]*gtsmodel.Account diff --git a/internal/media/processingemoji.go b/internal/media/processingemoji.go index 2ae403931..a660ad775 100644 --- a/internal/media/processingemoji.go +++ b/internal/media/processingemoji.go @@ -68,7 +68,7 @@ type ProcessingEmoji struct { */ database db.DB - storage storage.Driver + storage *storage.Driver err error // error created during processing, if any diff --git a/internal/media/processingmedia.go b/internal/media/processingmedia.go index c724de849..81eef2f84 100644 --- a/internal/media/processingmedia.go +++ b/internal/media/processingmedia.go @@ -62,7 +62,7 @@ type ProcessingMedia struct { */ database db.DB - storage storage.Driver + storage *storage.Driver err error // error created during processing, if any diff --git a/internal/media/util.go b/internal/media/util.go index 2968ca2f6..316d63dec 100644 --- a/internal/media/util.go +++ b/internal/media/util.go @@ -163,7 +163,7 @@ func (r *lengthReader) Read(b []byte) (int, error) { // putStream either puts a file with a known fileSize into storage directly, and returns the // fileSize unchanged, or it wraps the reader with a lengthReader and returns the discovered // fileSize. -func putStream(ctx context.Context, storage storage.Driver, key string, r io.Reader, fileSize int64) (int64, error) { +func putStream(ctx context.Context, storage *storage.Driver, key string, r io.Reader, fileSize int64) (int64, error) { if fileSize > 0 { return fileSize, storage.PutStream(ctx, key, r) } diff --git a/internal/processing/account/account_test.go b/internal/processing/account/account_test.go index 0755f01c2..84626c199 100644 --- a/internal/processing/account/account_test.go +++ b/internal/processing/account/account_test.go @@ -43,7 +43,7 @@ type AccountStandardTestSuite struct { suite.Suite db db.DB tc typeutils.TypeConverter - storage storage.Driver + storage *storage.Driver mediaManager media.Manager oauthServer oauth.Server fromClientAPIChan chan messages.FromClientAPI diff --git a/internal/processing/media/media.go b/internal/processing/media/media.go index 66575facc..7cd82f838 100644 --- a/internal/processing/media/media.go +++ b/internal/processing/media/media.go @@ -51,12 +51,12 @@ type processor struct { tc typeutils.TypeConverter mediaManager media.Manager transportController transport.Controller - storage storage.Driver + storage *storage.Driver db db.DB } // New returns a new media processor. -func New(db db.DB, tc typeutils.TypeConverter, mediaManager media.Manager, transportController transport.Controller, storage storage.Driver) Processor { +func New(db db.DB, tc typeutils.TypeConverter, mediaManager media.Manager, transportController transport.Controller, storage *storage.Driver) Processor { return &processor{ tc: tc, mediaManager: mediaManager, diff --git a/internal/processing/media/media_test.go b/internal/processing/media/media_test.go index cf73af4e8..f2bb3acaf 100644 --- a/internal/processing/media/media_test.go +++ b/internal/processing/media/media_test.go @@ -37,7 +37,7 @@ type MediaStandardTestSuite struct { suite.Suite db db.DB tc typeutils.TypeConverter - storage storage.Driver + storage *storage.Driver mediaManager media.Manager transportController transport.Controller diff --git a/internal/processing/processor.go b/internal/processing/processor.go index f464a08b4..686cb5015 100644 --- a/internal/processing/processor.go +++ b/internal/processing/processor.go @@ -273,7 +273,7 @@ type processor struct { tc typeutils.TypeConverter oauthServer oauth.Server mediaManager media.Manager - storage storage.Driver + storage *storage.Driver statusTimelines timeline.Manager db db.DB filter visibility.Filter @@ -297,7 +297,7 @@ func NewProcessor( federator federation.Federator, oauthServer oauth.Server, mediaManager media.Manager, - storage storage.Driver, + storage *storage.Driver, db db.DB, emailSender email.Sender, clientWorker *concurrency.WorkerPool[messages.FromClientAPI], diff --git a/internal/processing/processor_test.go b/internal/processing/processor_test.go index 54271cc86..0dc21e94f 100644 --- a/internal/processing/processor_test.go +++ b/internal/processing/processor_test.go @@ -39,7 +39,7 @@ type ProcessingStandardTestSuite struct { // standard suite interfaces suite.Suite db db.DB - storage storage.Driver + storage *storage.Driver mediaManager media.Manager typeconverter typeutils.TypeConverter httpClient *testrig.MockHTTPClient diff --git a/internal/processing/status/status_test.go b/internal/processing/status/status_test.go index e723c6200..bdc1ef812 100644 --- a/internal/processing/status/status_test.go +++ b/internal/processing/status/status_test.go @@ -41,7 +41,7 @@ type StatusStandardTestSuite struct { db db.DB typeConverter typeutils.TypeConverter tc transport.Controller - storage storage.Driver + storage *storage.Driver mediaManager media.Manager federator federation.Federator clientWorker *concurrency.WorkerPool[messages.FromClientAPI] diff --git a/internal/storage/local.go b/internal/storage/local.go deleted file mode 100644 index 9a5f971a2..000000000 --- a/internal/storage/local.go +++ /dev/null @@ -1,34 +0,0 @@ -/* - GoToSocial - Copyright (C) 2021-2022 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 . -*/ - -package storage - -import ( - "context" - "net/url" - - "codeberg.org/gruf/go-store/v2/kv" -) - -type Local struct { - *kv.KVStore -} - -func (l *Local) URL(ctx context.Context, key string) *url.URL { - return nil -} diff --git a/internal/storage/s3.go b/internal/storage/s3.go deleted file mode 100644 index 1ead7efe9..000000000 --- a/internal/storage/s3.go +++ /dev/null @@ -1,50 +0,0 @@ -/* - GoToSocial - Copyright (C) 2021-2022 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 . -*/ - -package storage - -import ( - "context" - "mime" - "net/url" - "path" - "time" - - "codeberg.org/gruf/go-store/v2/kv" - "codeberg.org/gruf/go-store/v2/storage" -) - -type S3 struct { - Proxy bool - Bucket string - Storage *storage.S3Storage - *kv.KVStore -} - -func (s *S3) URL(ctx context.Context, key string) *url.URL { - if s.Proxy { - return nil - } - - // it's safe to ignore the error here, as we just fall back to fetching the file if URL request fails - url, _ := s.Storage.Client().PresignedGetObject(ctx, s.Bucket, key, time.Hour, url.Values{ - "response-content-type": []string{mime.TypeByExtension(path.Ext(key))}, - }) - - return url -} diff --git a/internal/storage/storage.go b/internal/storage/storage.go index 71d4774f7..498ea873a 100644 --- a/internal/storage/storage.go +++ b/internal/storage/storage.go @@ -20,11 +20,11 @@ package storage import ( "context" - "errors" "fmt" - "io" + "mime" "net/url" "path" + "time" "codeberg.org/gruf/go-store/v2/kv" "codeberg.org/gruf/go-store/v2/storage" @@ -33,32 +33,50 @@ import ( "github.com/superseriousbusiness/gotosocial/internal/config" ) -var ( - ErrNotSupported = errors.New("driver does not suppport functionality") - ErrAlreadyExists = storage.ErrAlreadyExists -) +// ErrAlreadyExists is a ptr to underlying storage.ErrAlreadyExists, +// to put the related errors in the same package as our storage wrapper. +var ErrAlreadyExists = storage.ErrAlreadyExists -// Driver implements the functionality to store and retrieve blobs -// (images,video,audio) -type Driver interface { - Get(ctx context.Context, key string) ([]byte, error) - GetStream(ctx context.Context, key string) (io.ReadCloser, error) - PutStream(ctx context.Context, key string, r io.Reader) error - Put(ctx context.Context, key string, value []byte) error - Delete(ctx context.Context, key string) error - URL(ctx context.Context, key string) *url.URL +// Driver wraps a kv.KVStore to also provide S3 presigned GET URLs. +type Driver struct { + // Underlying storage + *kv.KVStore + Storage storage.Storage + + // S3-only parameters + Proxy bool + Bucket string } -func AutoConfig() (Driver, error) { - switch config.GetStorageBackend() { +// URL will return a presigned GET object URL, but only if running on S3 storage with proxying disabled. +func (d *Driver) URL(ctx context.Context, key string) *url.URL { + // Check whether S3 *without* proxying is enabled + s3, ok := d.Storage.(*storage.S3Storage) + if !ok || d.Proxy { + return nil + } + + // If URL request fails, fallback is to fetch the file. So ignore the error here + url, _ := s3.Client().PresignedGetObject(ctx, d.Bucket, key, time.Hour, url.Values{ + "response-content-type": []string{mime.TypeByExtension(path.Ext(key))}, + }) + + return url +} + +func AutoConfig() (*Driver, error) { + var st storage.Storage + + switch backend := config.GetStorageBackend(); backend { case "s3": + // Load runtime configuration endpoint := config.GetStorageS3Endpoint() access := config.GetStorageS3AccessKey() secret := config.GetStorageS3SecretKey() secure := config.GetStorageS3UseSSL() bucket := config.GetStorageS3BucketName() - proxy := config.GetStorageS3Proxy() + // Open the s3 storage implementation s3, err := storage.OpenS3(endpoint, bucket, &storage.S3Config{ CoreOpts: minio.Options{ Creds: credentials.NewStaticV4(access, secret, ""), @@ -75,15 +93,14 @@ func AutoConfig() (Driver, error) { return nil, fmt.Errorf("error opening s3 storage: %w", err) } - return &S3{ - Proxy: proxy, - Bucket: bucket, - Storage: s3, - KVStore: kv.New(s3), - }, nil + // Set storage impl + st = s3 + case "local": + // Load runtime configuration basePath := config.GetStorageLocalBasePath() + // Open the disk storage implementation disk, err := storage.OpenDisk(basePath, &storage.DiskConfig{ // Put the store lockfile in the storage dir itself. // Normally this would not be safe, since we could end up @@ -96,7 +113,17 @@ func AutoConfig() (Driver, error) { return nil, fmt.Errorf("error opening disk storage: %w", err) } - return &Local{kv.New(disk)}, nil + // Set storage impl + st = disk + + default: + return nil, fmt.Errorf("invalid storage backend: %s", backend) } - return nil, fmt.Errorf("invalid storage backend %s", config.GetStorageBackend()) + + return &Driver{ + KVStore: kv.New(st), + Proxy: config.GetStorageS3Proxy(), + Bucket: config.GetStorageS3BucketName(), + Storage: st, + }, nil } diff --git a/testrig/federator.go b/testrig/federator.go index 2c709bc81..519f9ad62 100644 --- a/testrig/federator.go +++ b/testrig/federator.go @@ -29,6 +29,6 @@ import ( ) // NewTestFederator returns a federator with the given database and (mock!!) transport controller. -func NewTestFederator(db db.DB, tc transport.Controller, storage storage.Driver, mediaManager media.Manager, fedWorker *concurrency.WorkerPool[messages.FromFederator]) federation.Federator { +func NewTestFederator(db db.DB, tc transport.Controller, storage *storage.Driver, mediaManager media.Manager, fedWorker *concurrency.WorkerPool[messages.FromFederator]) federation.Federator { return federation.NewFederator(db, NewTestFederatingDB(db, fedWorker), tc, NewTestTypeConverter(db), mediaManager) } diff --git a/testrig/mediahandler.go b/testrig/mediahandler.go index acb5ed16b..12bfb8679 100644 --- a/testrig/mediahandler.go +++ b/testrig/mediahandler.go @@ -25,7 +25,7 @@ import ( ) // NewTestMediaManager returns a media handler with the default test config, and the given db and storage. -func NewTestMediaManager(db db.DB, storage storage.Driver) media.Manager { +func NewTestMediaManager(db db.DB, storage *storage.Driver) media.Manager { m, err := media.NewManager(db, storage) if err != nil { panic(err) diff --git a/testrig/processor.go b/testrig/processor.go index 902cb66bf..9dea6f579 100644 --- a/testrig/processor.go +++ b/testrig/processor.go @@ -30,6 +30,6 @@ import ( ) // NewTestProcessor returns a Processor suitable for testing purposes -func NewTestProcessor(db db.DB, storage storage.Driver, federator federation.Federator, emailSender email.Sender, mediaManager media.Manager, clientWorker *concurrency.WorkerPool[messages.FromClientAPI], fedWorker *concurrency.WorkerPool[messages.FromFederator]) processing.Processor { +func NewTestProcessor(db db.DB, storage *storage.Driver, federator federation.Federator, emailSender email.Sender, mediaManager media.Manager, clientWorker *concurrency.WorkerPool[messages.FromClientAPI], fedWorker *concurrency.WorkerPool[messages.FromFederator]) processing.Processor { return processing.NewProcessor(NewTestTypeConverter(db), federator, NewTestOauthServer(db), mediaManager, storage, db, emailSender, clientWorker, fedWorker) } diff --git a/testrig/storage.go b/testrig/storage.go index e29c82532..20226089c 100644 --- a/testrig/storage.go +++ b/testrig/storage.go @@ -33,15 +33,15 @@ import ( ) // NewInMemoryStorage returns a new in memory storage with the default test config -func NewInMemoryStorage() *gtsstorage.Local { - storage, err := kv.OpenStorage(storage.OpenMemory(200, false)) - if err != nil { - panic(err) +func NewInMemoryStorage() *gtsstorage.Driver { + storage := storage.OpenMemory(200, false) + return >sstorage.Driver{ + KVStore: kv.New(storage), + Storage: storage, } - return >sstorage.Local{KVStore: storage} } -func NewS3Storage() gtsstorage.Driver { +func NewS3Storage() *gtsstorage.Driver { endpoint := config.GetStorageS3Endpoint() access := config.GetStorageS3AccessKey() secret := config.GetStorageS3SecretKey() @@ -65,16 +65,16 @@ func NewS3Storage() gtsstorage.Driver { panic(fmt.Errorf("error opening s3 storage: %w", err)) } - return >sstorage.S3{ + return >sstorage.Driver{ + KVStore: kv.New(s3), + Storage: s3, Proxy: proxy, Bucket: bucket, - Storage: s3, - KVStore: kv.New(s3), } } // StandardStorageSetup populates the storage with standard test entries from the given directory. -func StandardStorageSetup(s gtsstorage.Driver, relativePath string) { +func StandardStorageSetup(storage *gtsstorage.Driver, relativePath string) { storedA := newTestStoredAttachments() a := NewTestAttachments() for k, paths := range storedA { @@ -90,14 +90,14 @@ func StandardStorageSetup(s gtsstorage.Driver, relativePath string) { if err != nil { panic(err) } - if err := s.Put(context.TODO(), pathOriginal, bOriginal); err != nil { + if err := storage.Put(context.TODO(), pathOriginal, bOriginal); err != nil { panic(err) } bSmall, err := os.ReadFile(fmt.Sprintf("%s/%s", relativePath, filenameSmall)) if err != nil { panic(err) } - if err := s.Put(context.TODO(), pathSmall, bSmall); err != nil { + if err := storage.Put(context.TODO(), pathSmall, bSmall); err != nil { panic(err) } } @@ -117,14 +117,14 @@ func StandardStorageSetup(s gtsstorage.Driver, relativePath string) { if err != nil { panic(err) } - if err := s.Put(context.TODO(), pathOriginal, bOriginal); err != nil { + if err := storage.Put(context.TODO(), pathOriginal, bOriginal); err != nil { panic(err) } bStatic, err := os.ReadFile(fmt.Sprintf("%s/%s", relativePath, filenameStatic)) if err != nil { panic(err) } - if err := s.Put(context.TODO(), pathStatic, bStatic); err != nil { + if err := storage.Put(context.TODO(), pathStatic, bStatic); err != nil { panic(err) } } @@ -133,24 +133,27 @@ func StandardStorageSetup(s gtsstorage.Driver, relativePath string) { // StandardStorageTeardown deletes everything in storage so that it's clean for // the next test // nolint:gocritic // complains about the type switch, but it's the cleanest solution -func StandardStorageTeardown(s gtsstorage.Driver) { +func StandardStorageTeardown(storage *gtsstorage.Driver) { defer os.RemoveAll(path.Join(os.TempDir(), "gotosocial")) - switch st := s.(type) { - case *gtsstorage.Local: - iter, err := st.KVStore.Iterator(context.Background(), nil) - if err != nil { - panic(err) - } - keys := []string{} - for iter.Next() { - keys = append(keys, iter.Key()) - } - iter.Release() - for _, k := range keys { - if err := s.Delete(context.TODO(), k); err != nil { - panic(err) - } - } + // Open a storage iterator + iter, err := storage.Iterator(context.Background(), nil) + if err != nil { + panic(err) + } + + var keys []string + + for iter.Next() { + // Collate all of the storage keys + keys = append(keys, iter.Key()) + } + + // Done with iter + iter.Release() + + for _, key := range keys { + // Ignore errors, we just want to attempt delete all + _ = storage.Delete(context.Background(), key) } }