Plugins: Add file store abstraction for handling plugin files (#65432)
* add file store * fix markdown fetch bug * add markdown tests * fix var name
This commit is contained in:
@@ -3,7 +3,6 @@ package dashboards
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"io/fs"
|
||||
"strings"
|
||||
|
||||
"github.com/grafana/grafana/pkg/plugins"
|
||||
@@ -13,17 +12,24 @@ import (
|
||||
var _ FileStore = (*FileStoreManager)(nil)
|
||||
|
||||
type FileStoreManager struct {
|
||||
pluginStore plugins.Store
|
||||
pluginStore plugins.Store
|
||||
pluginFileStore plugins.FileStore
|
||||
}
|
||||
|
||||
func ProvideFileStoreManager(pluginStore plugins.Store) *FileStoreManager {
|
||||
func ProvideFileStoreManager(pluginStore plugins.Store, pluginFileStore plugins.FileStore) *FileStoreManager {
|
||||
return &FileStoreManager{
|
||||
pluginStore: pluginStore,
|
||||
pluginStore: pluginStore,
|
||||
pluginFileStore: pluginFileStore,
|
||||
}
|
||||
}
|
||||
|
||||
var openDashboardFile = func(p plugins.PluginDTO, name string) (fs.File, error) {
|
||||
return p.File(name)
|
||||
var openDashboardFile = func(ctx context.Context, pluginFileStore plugins.FileStore, pluginID, name string) (*plugins.File, error) {
|
||||
f, err := pluginFileStore.File(ctx, pluginID, name)
|
||||
if err != nil {
|
||||
return &plugins.File{}, err
|
||||
}
|
||||
|
||||
return f, nil
|
||||
}
|
||||
|
||||
func (m *FileStoreManager) ListPluginDashboardFiles(ctx context.Context, args *ListPluginDashboardFilesArgs) (*ListPluginDashboardFilesResult, error) {
|
||||
@@ -86,12 +92,12 @@ func (m *FileStoreManager) GetPluginDashboardFileContents(ctx context.Context, a
|
||||
return nil, err
|
||||
}
|
||||
|
||||
file, err := openDashboardFile(plugin, cleanPath)
|
||||
file, err := openDashboardFile(ctx, m.pluginFileStore, plugin.ID, cleanPath)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
return &GetPluginDashboardFileContentsResult{
|
||||
Content: file,
|
||||
Content: file.Content,
|
||||
}, nil
|
||||
}
|
||||
|
||||
@@ -3,7 +3,6 @@ package dashboards
|
||||
import (
|
||||
"context"
|
||||
"io"
|
||||
"io/fs"
|
||||
"testing"
|
||||
"testing/fstest"
|
||||
|
||||
@@ -131,10 +130,13 @@ func TestDashboardFileStore(t *testing.T) {
|
||||
Data: []byte("dash2"),
|
||||
},
|
||||
}
|
||||
openDashboardFile = func(p plugins.PluginDTO, name string) (fs.File, error) {
|
||||
openDashboardFile = func(ctx context.Context, pluginFiles plugins.FileStore, pluginID, name string) (*plugins.File, error) {
|
||||
f, err := mapFs.Open(name)
|
||||
require.NoError(t, err)
|
||||
return f, nil
|
||||
|
||||
b, err := io.ReadAll(f)
|
||||
require.NoError(t, err)
|
||||
return &plugins.File{Content: b}, nil
|
||||
}
|
||||
t.Cleanup(func() {
|
||||
openDashboardFile = origOpenDashboardFile
|
||||
@@ -157,10 +159,7 @@ func TestDashboardFileStore(t *testing.T) {
|
||||
})
|
||||
require.NoError(t, err)
|
||||
require.NotNil(t, res)
|
||||
require.NotNil(t, res.Content)
|
||||
b, err := io.ReadAll(res.Content)
|
||||
require.NoError(t, err)
|
||||
require.Equal(t, "dash1", string(b))
|
||||
require.Equal(t, "dash1", string(res.Content))
|
||||
})
|
||||
|
||||
t.Run("Should return file content for dashboards/dash2.json", func(t *testing.T) {
|
||||
@@ -170,10 +169,7 @@ func TestDashboardFileStore(t *testing.T) {
|
||||
})
|
||||
require.NoError(t, err)
|
||||
require.NotNil(t, res)
|
||||
require.NotNil(t, res.Content)
|
||||
b, err := io.ReadAll(res.Content)
|
||||
require.NoError(t, err)
|
||||
require.Equal(t, "dash2", string(b))
|
||||
require.Equal(t, "dash2", string(res.Content))
|
||||
})
|
||||
|
||||
t.Run("Should return error when trying to read relative file", func(t *testing.T) {
|
||||
|
||||
@@ -2,7 +2,6 @@ package dashboards
|
||||
|
||||
import (
|
||||
"context"
|
||||
"io"
|
||||
)
|
||||
|
||||
// FileStore is the interface for plugin dashboard file storage.
|
||||
@@ -31,5 +30,5 @@ type GetPluginDashboardFileContentsArgs struct {
|
||||
|
||||
// GetPluginDashboardFileContentsResult get plugin dashboard file content result model.
|
||||
type GetPluginDashboardFileContentsResult struct {
|
||||
Content io.ReadCloser
|
||||
Content []byte
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user