IntenseWebs/grafana
3
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-02-25 18:55:37 -06:00
Code Issues Packages Projects Releases Wiki Activity

Plugins: Improve plugin installer error messages (#34437)

Browse Source 
* fix and improve error messages

* enrich error message

* ignore previous changes

* revert manual version bump

* remove condition

* fix version param
This commit is contained in:
Will Browne 2021-05-20 15:11:07 +02:00 committed by GitHub
parent 23939eab10
commit c4dcfdef56
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 25 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
pkg/plugins/manager/installer/installer.go
View File

@ -58,32 +58,23 @@ func (e *BadRequestError) Error() string {
} }
type ErrVersionUnsupported struct { type ErrVersionUnsupported struct {
PluginID string PluginID string
RequestedVersion string RequestedVersion string
RecommendedVersion string SystemInfo string
} }
func (e ErrVersionUnsupported) Error() string { func (e ErrVersionUnsupported) Error() string {
if len(e.RecommendedVersion) > 0 { return fmt.Sprintf("%s v%s is not supported on your system (%s)", e.PluginID, e.RequestedVersion, e.SystemInfo)
return fmt.Sprintf("%s v%s is not supported on your architecture and OS, latest suitable version is %s",
e.PluginID, e.RequestedVersion, e.RecommendedVersion)
}
return fmt.Sprintf("%s v%s is not supported on your architecture and OS", e.PluginID, e.RequestedVersion)
} }
type ErrVersionNotFound struct { type ErrVersionNotFound struct {
PluginID string PluginID string
RequestedVersion string RequestedVersion string
RecommendedVersion string SystemInfo string
} }
func (e ErrVersionNotFound) Error() string { func (e ErrVersionNotFound) Error() string {
if len(e.RecommendedVersion) > 0 { return fmt.Sprintf("%s v%s either does not exist or is not supported on your system (%s)", e.PluginID, e.RequestedVersion, e.SystemInfo)
return fmt.Sprintf("%s v%s is not supported on your architecture and OS, latest suitable version is %s",
e.PluginID, e.RequestedVersion, e.RecommendedVersion)
}
return fmt.Sprintf("could not find a version %s for %s. The latest suitable version is %s", e.RequestedVersion,
e.PluginID, e.RecommendedVersion)
} }
func New(skipTLSVerify bool, grafanaVersion string, logger plugins.PluginInstallerLogger) *Installer { func New(skipTLSVerify bool, grafanaVersion string, logger plugins.PluginInstallerLogger) *Installer {
@ -114,7 +105,7 @@ func (i *Installer) Install(ctx context.Context, pluginID, version, pluginsDir,
return err return err
} }
v, err := selectVersion(&plugin, version) v, err := i.selectVersion(&plugin, version)
if err != nil { if err != nil {
return err return err
} }
@ -429,7 +420,7 @@ func normalizeVersion(version string) string {
// selectVersion returns latest version if none is specified or the specified version. If the version string is not // selectVersion returns latest version if none is specified or the specified version. If the version string is not
// matched to existing version it errors out. It also errors out if version that is matched is not available for current // matched to existing version it errors out. It also errors out if version that is matched is not available for current
// os and platform. It expects plugin.Versions to be sorted so the newest version is first. // os and platform. It expects plugin.Versions to be sorted so the newest version is first.
func selectVersion(plugin *Plugin, version string) (*Version, error) { func (i *Installer) selectVersion(plugin *Plugin, version string) (*Version, error) {
var ver Version var ver Version
latestForArch := latestSupportedVersion(plugin) latestForArch := latestSupportedVersion(plugin)
@ -437,6 +428,7 @@ func selectVersion(plugin *Plugin, version string) (*Version, error) {
return nil, ErrVersionUnsupported{ return nil, ErrVersionUnsupported{
PluginID: plugin.ID, PluginID: plugin.ID,
RequestedVersion: version, RequestedVersion: version,
SystemInfo: i.fullSystemInfoString(),
} }
} }
@ -451,24 +443,32 @@ func selectVersion(plugin *Plugin, version string) (*Version, error) {
} }
if len(ver.Version) == 0 { if len(ver.Version) == 0 {
i.log.Debugf("Requested plugin version %s v%s not found but potential fallback version '%s' was found",
plugin.ID, version, latestForArch.Version)
return nil, ErrVersionNotFound{ return nil, ErrVersionNotFound{
PluginID: plugin.ID, PluginID: plugin.ID,
RequestedVersion: version, RequestedVersion: version,
RecommendedVersion: latestForArch.Version, SystemInfo: i.fullSystemInfoString(),
} }
} }
if !supportsCurrentArch(&ver) { if !supportsCurrentArch(&ver) {
i.log.Debugf("Requested plugin version %s v%s not found but potential fallback version '%s' was found",
plugin.ID, version, latestForArch.Version)
return nil, ErrVersionUnsupported{ return nil, ErrVersionUnsupported{
PluginID: plugin.ID, PluginID: plugin.ID,
RequestedVersion: version, RequestedVersion: version,
RecommendedVersion: latestForArch.Version, SystemInfo: i.fullSystemInfoString(),
} }
} }
return &ver, nil return &ver, nil
} }
func (i *Installer) fullSystemInfoString() string {
return fmt.Sprintf("Grafana v%s %s", i.grafanaVersion, osAndArchString())
}
func osAndArchString() string { func osAndArchString() string {
osString := strings.ToLower(runtime.GOOS) osString := strings.ToLower(runtime.GOOS)
arch := runtime.GOARCH arch := runtime.GOARCH