Plugins: Fix plugins CDN not working when plugins are not in domain's root path (#63202)

* Plugins CDN: Add support for different CDN root path * Plugins CDN: Make frontendsettings return the correct CDN base path * Update comments * Fix version detection * Undo frontend changes * Fix system.js asset path construction * fix(plugins): translate all plugin css asset paths loaded via cdn * refactor(plugins): rename extractPluginNameVersionFromUrl and add comments * Fix typo in comment Co-authored-by: Will Browne <wbrowne@users.noreply.github.com> * Hardcode CDN URL structure /{id}/{version}/public/plugins/{id}/{assetPath} is not required anymore in the cdn url template config --------- Co-authored-by: Jack Westbrook <jack.westbrook@gmail.com> Co-authored-by: Will Browne <wbrowne@users.noreply.github.com>
2025-02-25 18:55:37 -06:00 · 2023-02-24 14:28:13 +01:00
parent b3c0e7e977
commit 966bcd3545
8 changed files with 153 additions and 99 deletions
--- a/pkg/plugins/manager/loader/assetpath/assetpath_test.go
+++ b/pkg/plugins/manager/loader/assetpath/assetpath_test.go
@@ -1,6 +1,7 @@
 package assetpath

 import (
+	"strings"
 	"testing"

 	"github.com/grafana/grafana/pkg/plugins"
@@ -14,75 +15,101 @@ func extPath(pluginID string) string {
 }

 func TestService(t *testing.T) {
-	svc := ProvideService(pluginscdn.ProvideService(&config.Cfg{
-		PluginsCDNURLTemplate: "https://cdn.example.com/{id}/{version}/public/plugins/{id}/{assetPath}",
-		PluginSettings: map[string]map[string]string{
-			"one": {"cdn": "true"},
-			"two": {},
+	for _, tc := range []struct {
+		name       string
+		cdnBaseURL string
+	}{
+		{
+			name:       "Simple",
+			cdnBaseURL: "https://cdn.example.com",
 		},
-	}))
+		{
+			name:       "Not root",
+			cdnBaseURL: "https://cdn.example.com/plugins",
+		},
+		{
+			name:       "End slashes",
+			cdnBaseURL: "https://cdn.example.com/plugins////",
+		},
+	} {
+		t.Run(tc.name, func(t *testing.T) {
+			svc := ProvideService(pluginscdn.ProvideService(&config.Cfg{
+				PluginsCDNURLTemplate: tc.cdnBaseURL,
+				PluginSettings: map[string]map[string]string{
+					"one": {"cdn": "true"},
+					"two": {},
+				},
+			}))

-	const tableOldPath = "/grafana/public/app/plugins/panel/table-old"
-	jsonData := map[string]plugins.JSONData{
-		"table-old": {ID: "table-old", Info: plugins.Info{Version: "1.0.0"}},
+			const tableOldPath = "/grafana/public/app/plugins/panel/table-old"
+			jsonData := map[string]plugins.JSONData{
+				"table-old": {ID: "table-old", Info: plugins.Info{Version: "1.0.0"}},

-		"one": {ID: "one", Info: plugins.Info{Version: "1.0.0"}},
-		"two": {ID: "two", Info: plugins.Info{Version: "2.0.0"}},
+				"one": {ID: "one", Info: plugins.Info{Version: "1.0.0"}},
+				"two": {ID: "two", Info: plugins.Info{Version: "2.0.0"}},
+			}
+
+			t.Run("CDN Base URL", func(t *testing.T) {
+				base, err := svc.cdn.BaseURL()
+				require.NoError(t, err)
+				require.Equal(t, tc.cdnBaseURL, base)
+			})
+
+			t.Run("Base", func(t *testing.T) {
+				base, err := svc.Base(jsonData["one"], plugins.External, extPath("one"))
+				require.NoError(t, err)
+				require.Equal(t, "plugin-cdn/one/1.0.0/public/plugins/one", base)
+
+				base, err = svc.Base(jsonData["two"], plugins.External, extPath("two"))
+				require.NoError(t, err)
+				require.Equal(t, "public/plugins/two", base)
+
+				base, err = svc.Base(jsonData["table-old"], plugins.Core, tableOldPath)
+				require.NoError(t, err)
+				require.Equal(t, "public/app/plugins/table-old", base)
+			})
+
+			t.Run("Module", func(t *testing.T) {
+				module, err := svc.Module(jsonData["one"], plugins.External, extPath("one"))
+				require.NoError(t, err)
+				require.Equal(t, "plugin-cdn/one/1.0.0/public/plugins/one/module", module)
+
+				module, err = svc.Module(jsonData["two"], plugins.External, extPath("two"))
+				require.NoError(t, err)
+				require.Equal(t, "plugins/two/module", module)
+
+				module, err = svc.Module(jsonData["table-old"], plugins.Core, tableOldPath)
+				require.NoError(t, err)
+				require.Equal(t, "app/plugins/table-old/module", module)
+			})
+
+			t.Run("RelativeURL", func(t *testing.T) {
+				pluginsMap := map[string]*plugins.Plugin{
+					"one": {
+						JSONData: plugins.JSONData{ID: "one", Info: plugins.Info{Version: "1.0.0"}},
+						BaseURL:  "plugin-cdn/one/1.0.0/public/pluginsMap/one",
+					},
+					"two": {
+						JSONData: plugins.JSONData{ID: "two", Info: plugins.Info{Version: "2.0.0"}},
+						BaseURL:  "public/pluginsMap/two",
+					},
+				}
+				u, err := svc.RelativeURL(pluginsMap["one"], "", "default")
+				require.NoError(t, err)
+				require.Equal(t, "default", u)
+
+				u, err = svc.RelativeURL(pluginsMap["one"], "path/to/file.txt", "default")
+				require.NoError(t, err)
+				require.Equal(t, strings.TrimRight(tc.cdnBaseURL, "/")+"/one/1.0.0/public/plugins/one/path/to/file.txt", u)
+
+				u, err = svc.RelativeURL(pluginsMap["two"], "path/to/file.txt", "default")
+				require.NoError(t, err)
+				require.Equal(t, "public/pluginsMap/two/path/to/file.txt", u)
+
+				u, err = svc.RelativeURL(pluginsMap["two"], "default", "default")
+				require.NoError(t, err)
+				require.Equal(t, "default", u)
+			})
+		})
 	}
-
-	t.Run("Base", func(t *testing.T) {
-		base, err := svc.Base(jsonData["one"], plugins.External, extPath("one"))
-		require.NoError(t, err)
-		require.Equal(t, "plugin-cdn/one/1.0.0/public/plugins/one", base)
-
-		base, err = svc.Base(jsonData["two"], plugins.External, extPath("two"))
-		require.NoError(t, err)
-		require.Equal(t, "public/plugins/two", base)
-
-		base, err = svc.Base(jsonData["table-old"], plugins.Core, tableOldPath)
-		require.NoError(t, err)
-		require.Equal(t, "public/app/plugins/table-old", base)
-	})
-
-	t.Run("Module", func(t *testing.T) {
-		module, err := svc.Module(jsonData["one"], plugins.External, extPath("one"))
-		require.NoError(t, err)
-		require.Equal(t, "plugin-cdn/one/1.0.0/public/plugins/one/module", module)
-
-		module, err = svc.Module(jsonData["two"], plugins.External, extPath("two"))
-		require.NoError(t, err)
-		require.Equal(t, "plugins/two/module", module)
-
-		module, err = svc.Module(jsonData["table-old"], plugins.Core, tableOldPath)
-		require.NoError(t, err)
-		require.Equal(t, "app/plugins/table-old/module", module)
-	})
-
-	t.Run("RelativeURL", func(t *testing.T) {
-		pluginsMap := map[string]*plugins.Plugin{
-			"one": {
-				JSONData: plugins.JSONData{ID: "one", Info: plugins.Info{Version: "1.0.0"}},
-				BaseURL:  "plugin-cdn/one/1.0.0/public/pluginsMap/one",
-			},
-			"two": {
-				JSONData: plugins.JSONData{ID: "two", Info: plugins.Info{Version: "2.0.0"}},
-				BaseURL:  "public/pluginsMap/two",
-			},
-		}
-		u, err := svc.RelativeURL(pluginsMap["one"], "", "default")
-		require.NoError(t, err)
-		require.Equal(t, "default", u)
-
-		u, err = svc.RelativeURL(pluginsMap["one"], "path/to/file.txt", "default")
-		require.NoError(t, err)
-		require.Equal(t, "https://cdn.example.com/one/1.0.0/public/plugins/one/path/to/file.txt", u)
-
-		u, err = svc.RelativeURL(pluginsMap["two"], "path/to/file.txt", "default")
-		require.NoError(t, err)
-		require.Equal(t, "public/pluginsMap/two/path/to/file.txt", u)
-
-		u, err = svc.RelativeURL(pluginsMap["two"], "default", "default")
-		require.NoError(t, err)
-		require.Equal(t, "default", u)
-	})
 }
--- a/pkg/plugins/manager/loader/loader_test.go
+++ b/pkg/plugins/manager/loader/loader_test.go
@@ -412,7 +412,7 @@ func TestLoader_Load(t *testing.T) {
 			name:  "Load CDN plugin",
 			class: plugins.External,
 			cfg: &config.Cfg{
-				PluginsCDNURLTemplate: "https://cdn.example.com/{id}/{version}/public/plugins/{id}/{assetPath}",
+				PluginsCDNURLTemplate: "https://cdn.example.com",
 				PluginSettings: setting.PluginSettings{
 					"grafana-worldmap-panel": {"cdn": "true"},
 				},