mirror of
https://github.com/grafana/grafana.git
synced 2025-02-12 08:35:43 -06:00
966bcd3545
* 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>
83 lines
2.7 KiB
Go
83 lines
2.7 KiB
Go
package pluginscdn
|
|
|
|
import (
|
|
"errors"
|
|
"strings"
|
|
|
|
"github.com/grafana/grafana/pkg/plugins/config"
|
|
)
|
|
|
|
const (
|
|
// cdnAssetPathTemplate is the relative path template used to locate plugin CDN assets
|
|
cdnAssetPathTemplate = "{id}/{version}/public/plugins/{id}/{assetPath}"
|
|
|
|
// systemJSCDNURLTemplate is a special path template used by system.js to identify plugin CDN assets
|
|
systemJSCDNURLTemplate = "plugin-cdn/" + cdnAssetPathTemplate
|
|
)
|
|
|
|
var ErrPluginNotCDN = errors.New("plugin is not a cdn plugin")
|
|
|
|
// Service provides methods for the plugins CDN.
|
|
type Service struct {
|
|
cfg *config.Cfg
|
|
}
|
|
|
|
func ProvideService(cfg *config.Cfg) *Service {
|
|
return &Service{cfg: cfg}
|
|
}
|
|
|
|
// NewCDNURLConstructor returns a new URLConstructor for the provided plugin id and version.
|
|
// The CDN should be enabled for the plugin, otherwise the returned URLConstructor will have
|
|
// and invalid base url.
|
|
func (s *Service) NewCDNURLConstructor(pluginID, pluginVersion string) URLConstructor {
|
|
return URLConstructor{
|
|
cdnURLTemplate: strings.TrimRight(s.cfg.PluginsCDNURLTemplate, "/") + "/" + cdnAssetPathTemplate,
|
|
pluginID: pluginID,
|
|
pluginVersion: pluginVersion,
|
|
}
|
|
}
|
|
|
|
// IsEnabled returns true if the plugins cdn is enabled.
|
|
func (s *Service) IsEnabled() bool {
|
|
return s.cfg.PluginsCDNURLTemplate != ""
|
|
}
|
|
|
|
// PluginSupported returns true if the CDN is enabled in the config and if the specified plugin ID has CDN enabled.
|
|
func (s *Service) PluginSupported(pluginID string) bool {
|
|
return s.IsEnabled() && s.cfg.PluginSettings[pluginID]["cdn"] != ""
|
|
}
|
|
|
|
// BaseURL returns the absolute base URL of the plugins CDN.
|
|
// This is the "fixed" part of the URL (protocol + host + root url).
|
|
// If the plugins CDN is disabled, it returns an empty string.
|
|
func (s *Service) BaseURL() (string, error) {
|
|
if !s.IsEnabled() {
|
|
return "", nil
|
|
}
|
|
return s.cfg.PluginsCDNURLTemplate, nil
|
|
}
|
|
|
|
// SystemJSAssetPath returns a system-js path for the specified asset on the plugins CDN.
|
|
// The returned path will follow the template specified in systemJSCDNURLTemplate.
|
|
// If assetPath is an empty string, the base path for the plugin is returned.
|
|
func (s *Service) SystemJSAssetPath(pluginID, pluginVersion, assetPath string) (string, error) {
|
|
u, err := URLConstructor{
|
|
cdnURLTemplate: systemJSCDNURLTemplate,
|
|
pluginID: pluginID,
|
|
pluginVersion: pluginVersion,
|
|
}.Path(assetPath)
|
|
if err != nil {
|
|
return "", err
|
|
}
|
|
return u.String(), nil
|
|
}
|
|
|
|
// AssetURL returns the URL of a CDN asset for a CDN plugin. If the specified plugin is not a CDN plugin,
|
|
// it returns ErrPluginNotCDN.
|
|
func (s *Service) AssetURL(pluginID, pluginVersion, assetPath string) (string, error) {
|
|
if !s.PluginSupported(pluginID) {
|
|
return "", ErrPluginNotCDN
|
|
}
|
|
return s.NewCDNURLConstructor(pluginID, pluginVersion).StringPath(assetPath)
|
|
}
|