Skip to content

Commit

Permalink
Skip initing disabled storages (go-gitea#21985)
Browse files Browse the repository at this point in the history
If `Attachment` or `Packages` are disabled, we don't have to init the
storages for them.
  • Loading branch information
wolfogre authored Nov 30, 2022
1 parent 7020c4a commit 67881ae
Show file tree
Hide file tree
Showing 3 changed files with 108 additions and 26 deletions.
32 changes: 32 additions & 0 deletions modules/storage/helper.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@
package storage

import (
"fmt"
"io"
"net/url"
"os"
"reflect"

"code.gitea.io/gitea/modules/json"
Expand Down Expand Up @@ -61,3 +65,31 @@ func toConfig(exemplar, cfg interface{}) (interface{}, error) {
}
return newVal.Elem().Interface(), nil
}

var uninitializedStorage = discardStorage("uninitialized storage")

type discardStorage string

func (s discardStorage) Open(_ string) (Object, error) {
return nil, fmt.Errorf("%s", s)
}

func (s discardStorage) Save(_ string, _ io.Reader, _ int64) (int64, error) {
return 0, fmt.Errorf("%s", s)
}

func (s discardStorage) Stat(_ string) (os.FileInfo, error) {
return nil, fmt.Errorf("%s", s)
}

func (s discardStorage) Delete(_ string) error {
return fmt.Errorf("%s", s)
}

func (s discardStorage) URL(_, _ string) (*url.URL, error) {
return nil, fmt.Errorf("%s", s)
}

func (s discardStorage) IterateObjects(_ func(string, Object) error) error {
return fmt.Errorf("%s", s)
}
50 changes: 50 additions & 0 deletions modules/storage/helper_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
// Copyright 2022 The Gitea Authors. All rights reserved.
// SPDX-License-Identifier: MIT

package storage

import (
"bytes"
"testing"

"github.com/stretchr/testify/assert"
)

func Test_discardStorage(t *testing.T) {
tests := []discardStorage{
uninitializedStorage,
discardStorage("empty"),
}
for _, tt := range tests {
t.Run(string(tt), func(t *testing.T) {
{
got, err := tt.Open("path")
assert.Nil(t, got)
assert.Error(t, err, string(tt))
}
{
got, err := tt.Save("path", bytes.NewReader([]byte{0}), 1)
assert.Equal(t, int64(0), got)
assert.Error(t, err, string(tt))
}
{
got, err := tt.Stat("path")
assert.Nil(t, got)
assert.Error(t, err, string(tt))
}
{
err := tt.Delete("path")
assert.Error(t, err, string(tt))
}
{
got, err := tt.URL("path", "name")
assert.Nil(t, got)
assert.Errorf(t, err, string(tt))
}
{
err := tt.IterateObjects(func(_ string, _ Object) error { return nil })
assert.Error(t, err, string(tt))
}
})
}
}
52 changes: 26 additions & 26 deletions modules/storage/storage.go
Original file line number Diff line number Diff line change
Expand Up @@ -110,46 +110,38 @@ func SaveFrom(objStorage ObjectStorage, p string, callback func(w io.Writer) err

var (
// Attachments represents attachments storage
Attachments ObjectStorage
Attachments ObjectStorage = uninitializedStorage

// LFS represents lfs storage
LFS ObjectStorage
LFS ObjectStorage = uninitializedStorage

// Avatars represents user avatars storage
Avatars ObjectStorage
Avatars ObjectStorage = uninitializedStorage
// RepoAvatars represents repository avatars storage
RepoAvatars ObjectStorage
RepoAvatars ObjectStorage = uninitializedStorage

// RepoArchives represents repository archives storage
RepoArchives ObjectStorage
RepoArchives ObjectStorage = uninitializedStorage

// Packages represents packages storage
Packages ObjectStorage
Packages ObjectStorage = uninitializedStorage
)

// Init init the stoarge
func Init() error {
if err := initAttachments(); err != nil {
return err
}

if err := initAvatars(); err != nil {
return err
}

if err := initRepoAvatars(); err != nil {
return err
}

if err := initLFS(); err != nil {
return err
}

if err := initRepoArchives(); err != nil {
return err
for _, f := range []func() error{
initAttachments,
initAvatars,
initRepoAvatars,
initLFS,
initRepoArchives,
initPackages,
} {
if err := f(); err != nil {
return err
}
}

return initPackages()
return nil
}

// NewStorage takes a storage type and some config and returns an ObjectStorage or an error
Expand All @@ -172,6 +164,10 @@ func initAvatars() (err error) {
}

func initAttachments() (err error) {
if !setting.Attachment.Enabled {
Attachments = discardStorage("Attachment isn't enabled")
return nil
}
log.Info("Initialising Attachment storage with type: %s", setting.Attachment.Storage.Type)
Attachments, err = NewStorage(setting.Attachment.Storage.Type, &setting.Attachment.Storage)
return err
Expand All @@ -196,6 +192,10 @@ func initRepoArchives() (err error) {
}

func initPackages() (err error) {
if !setting.Packages.Enabled {
Packages = discardStorage("Packages isn't enabled")
return nil
}
log.Info("Initialising Packages storage with type: %s", setting.Packages.Storage.Type)
Packages, err = NewStorage(setting.Packages.Storage.Type, &setting.Packages.Storage)
return err
Expand Down

0 comments on commit 67881ae

Please sign in to comment.