Plugins: Remove pkg/infra/fs, pkg/infra/tracing and pkg/infra/process dependencies from pkg/plugins (#115798)
* remove dependency on packages * update tests * trigger
This commit is contained in:
Will Browne
@@ -1,167 +0,0 @@
|
||||
package util
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"fmt"
|
||||
"os"
|
||||
"path/filepath"
|
||||
)
|
||||
|
||||
// ErrWalkSkipDir is the Error returned when we want to skip descending into a directory
|
||||
var ErrWalkSkipDir = errors.New("skip this directory")
|
||||
|
||||
// WalkFunc is a callback function called for each path as a directory is walked
|
||||
// If resolvedPath != "", then we are following symbolic links.
|
||||
type WalkFunc func(resolvedPath string, info os.FileInfo, err error) error
|
||||
|
||||
type walker struct {
|
||||
rootDir string
|
||||
}
|
||||
|
||||
// newWalker creates a new walker
|
||||
func newWalker(rootDir string) *walker {
|
||||
return &walker{rootDir: rootDir}
|
||||
}
|
||||
|
||||
// Walk walks a path, optionally following symbolic links, and for each path,
|
||||
// it calls the walkFn passed.
|
||||
//
|
||||
// It is similar to filepath.Walk, except that it supports symbolic links and
|
||||
// can detect infinite loops while following symlinks.
|
||||
// It solves the issue where your WalkFunc needs a path relative to the symbolic link
|
||||
// (resolving links within walkfunc loses the path to the symbolic link for each traversal).
|
||||
func Walk(path string, followSymlinks bool, detectSymlinkInfiniteLoop bool, walkFn WalkFunc) error {
|
||||
info, err := os.Lstat(path)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
var symlinkPathsFollowed map[string]bool
|
||||
var resolvedPath string
|
||||
if followSymlinks {
|
||||
resolvedPath = path
|
||||
if detectSymlinkInfiniteLoop {
|
||||
symlinkPathsFollowed = make(map[string]bool, 8)
|
||||
}
|
||||
}
|
||||
|
||||
return newWalker(path).walk(path, info, resolvedPath, symlinkPathsFollowed, walkFn)
|
||||
}
|
||||
|
||||
// walk walks the path. It is a helper/sibling function to Walk.
|
||||
// It takes a resolvedPath into consideration. This way, paths being walked are
|
||||
// always relative to the path argument, even if symbolic links were resolved).
|
||||
//
|
||||
// If resolvedPath is "", then we are not following symbolic links.
|
||||
// If symlinkPathsFollowed is not nil, then we need to detect infinite loop.
|
||||
func (w *walker) walk(path string, info os.FileInfo, resolvedPath string, symlinkPathsFollowed map[string]bool, walkFn WalkFunc) error {
|
||||
if info == nil {
|
||||
return errors.New("walk: Nil FileInfo passed")
|
||||
}
|
||||
err := walkFn(resolvedPath, info, nil)
|
||||
if err != nil {
|
||||
if info.IsDir() && errors.Is(err, ErrWalkSkipDir) {
|
||||
err = nil
|
||||
}
|
||||
return err
|
||||
}
|
||||
|
||||
if resolvedPath != "" && info.Mode()&os.ModeSymlink == os.ModeSymlink {
|
||||
// We only want to lstat on directories. If this entry is a symbolic link to a file, no need to recurse.
|
||||
statInfo, err := os.Stat(resolvedPath)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
if !statInfo.IsDir() {
|
||||
return nil
|
||||
}
|
||||
|
||||
path2, err := filepath.EvalSymlinks(resolvedPath)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
// vout("SymLink Path: %v, links to: %v", resolvedPath, path2)
|
||||
if symlinkPathsFollowed != nil {
|
||||
if _, ok := symlinkPathsFollowed[path2]; ok {
|
||||
errMsg := "potential symLink infinite loop, path: %v, link to: %v"
|
||||
return fmt.Errorf(errMsg, resolvedPath, path2)
|
||||
}
|
||||
symlinkPathsFollowed[path2] = true
|
||||
}
|
||||
info2, err := os.Lstat(path2)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
return w.walk(path, info2, path2, symlinkPathsFollowed, walkFn)
|
||||
} else if info.IsDir() {
|
||||
list, err := os.ReadDir(path)
|
||||
if err != nil {
|
||||
return walkFn(resolvedPath, info, err)
|
||||
}
|
||||
var subFiles = make([]subFile, 0)
|
||||
for _, file := range list {
|
||||
path2 := filepath.Join(path, file.Name())
|
||||
var resolvedPath2 string
|
||||
if resolvedPath != "" {
|
||||
resolvedPath2 = filepath.Join(resolvedPath, file.Name())
|
||||
}
|
||||
fileInfo, err := file.Info()
|
||||
if err != nil {
|
||||
return fmt.Errorf("unable to read file info: %v, path: %v", file.Name(), path2)
|
||||
}
|
||||
|
||||
subFiles = append(subFiles, subFile{path: path2, resolvedPath: resolvedPath2, fileInfo: fileInfo})
|
||||
}
|
||||
|
||||
if w.containsDistFolder(subFiles) {
|
||||
err := w.walk(
|
||||
filepath.Join(path, "dist"),
|
||||
info,
|
||||
filepath.Join(resolvedPath, "dist"),
|
||||
symlinkPathsFollowed,
|
||||
walkFn)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
} else {
|
||||
for _, p := range subFiles {
|
||||
err = w.walk(p.path, p.fileInfo, p.resolvedPath, symlinkPathsFollowed, walkFn)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
}
|
||||
}
|
||||
return nil
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
// containsDistFolder returns true if the provided subFiles is a folder named "dist".
|
||||
func (w *walker) containsDistFolder(subFiles []subFile) bool {
|
||||
for _, p := range subFiles {
|
||||
if p.fileInfo.IsDir() && p.fileInfo.Name() == "dist" {
|
||||
return true
|
||||
}
|
||||
}
|
||||
return false
|
||||
}
|
||||
|
||||
type subFile struct {
|
||||
path, resolvedPath string
|
||||
fileInfo os.FileInfo
|
||||
}
|
||||
|
||||
// CleanRelativePath returns the shortest path name equivalent to path
|
||||
// by purely lexical processing. It makes sure the provided path is rooted
|
||||
// and then uses filepath.Clean and filepath.Rel to make sure the path
|
||||
// doesn't include any separators or elements that shouldn't be there
|
||||
// like ., .., //.
|
||||
func CleanRelativePath(path string) (string, error) {
|
||||
cleanPath := filepath.Clean(filepath.Join("/", path))
|
||||
rel, err := filepath.Rel("/", cleanPath)
|
||||
if err != nil {
|
||||
// slash is prepended above therefore this is not expected to fail
|
||||
return "", err
|
||||
}
|
||||
|
||||
return rel, nil
|
||||
}
|
||||
@@ -1,39 +0,0 @@
|
||||
package util
|
||||
|
||||
import (
|
||||
"path/filepath"
|
||||
"testing"
|
||||
|
||||
"github.com/stretchr/testify/assert"
|
||||
)
|
||||
|
||||
func TestCleanRelativePath(t *testing.T) {
|
||||
testcases := []struct {
|
||||
input string
|
||||
expectedPath string
|
||||
}{
|
||||
{
|
||||
input: "",
|
||||
expectedPath: ".",
|
||||
},
|
||||
{
|
||||
input: filepath.Join(string(filepath.Separator), "test", "test.txt"),
|
||||
expectedPath: filepath.Join("test", "test.txt"),
|
||||
},
|
||||
{
|
||||
input: filepath.Join("..", "..", "test", "test.txt"),
|
||||
expectedPath: filepath.Join("test", "test.txt"),
|
||||
},
|
||||
{
|
||||
// since filepath.Join will remove the leading dot, we need to build the path manually
|
||||
input: "." + string(filepath.Separator) + filepath.Join("..", "test", "test.txt"),
|
||||
expectedPath: filepath.Join("test", "test.txt"),
|
||||
},
|
||||
}
|
||||
|
||||
for _, tt := range testcases {
|
||||
path, err := CleanRelativePath(tt.input)
|
||||
assert.NoError(t, err)
|
||||
assert.Equal(t, tt.expectedPath, path)
|
||||
}
|
||||
}
|
||||
@@ -8,6 +8,7 @@ import (
|
||||
"strings"
|
||||
|
||||
claims "github.com/grafana/authlib/types"
|
||||
|
||||
"github.com/grafana/grafana/pkg/apimachinery/identity"
|
||||
)
|
||||
|
||||
@@ -91,12 +92,6 @@ func ClearCookieHeader(req *http.Request, keepCookiesNames []string, skipCookies
|
||||
}
|
||||
}
|
||||
|
||||
// SetProxyResponseHeaders sets proxy response headers.
|
||||
// Sets Content-Security-Policy: sandbox
|
||||
func SetProxyResponseHeaders(header http.Header) {
|
||||
header.Set("Content-Security-Policy", "sandbox")
|
||||
}
|
||||
|
||||
// SetViaHeader adds Grafana's reverse proxy to the proxy chain.
|
||||
// Defined in RFC 9110 7.6.3 https://datatracker.ietf.org/doc/html/rfc9110#name-via
|
||||
func SetViaHeader(header http.Header, major, minor int) {
|
||||
|
||||
@@ -11,6 +11,7 @@ import (
|
||||
|
||||
glog "github.com/grafana/grafana/pkg/infra/log"
|
||||
"github.com/grafana/grafana/pkg/middleware/requestmeta"
|
||||
"github.com/grafana/grafana/pkg/plugins/manager/client"
|
||||
"github.com/grafana/grafana/pkg/services/contexthandler"
|
||||
)
|
||||
|
||||
@@ -102,7 +103,7 @@ func modifyResponse(logger glog.Logger) func(resp *http.Response) error {
|
||||
resp.Header.Del(header)
|
||||
}
|
||||
|
||||
SetProxyResponseHeaders(resp.Header)
|
||||
client.SetCSPHeader(resp.Header)
|
||||
SetViaHeader(resp.Header, resp.ProtoMajor, resp.ProtoMinor)
|
||||
|
||||
requestmeta.WithStatusSource(resp.Request.Context(), resp.StatusCode)
|
||||
|
||||
Reference in New Issue
Block a user