Errors: Introduce error type with Grafana specific metadata (#47504)

2022-06-14 10:50:11 +02:00
parent 2d3cc26aa8
commit 264c2a9d1e
8 changed files with 632 additions and 2 deletions
@@ -0,0 +1,54 @@
+package errutil_test
+
+import (
+	"errors"
+	"fmt"
+
+	"github.com/grafana/grafana/pkg/util/errutil"
+)
+
+func ExampleTemplate() {
+	// Initialization, this is typically done on a package or global
+	// level.
+	var tmpl = errutil.NewBase(errutil.StatusInternal, "template.sample-error").MustTemplate("[{{ .Public.user }}] got error: {{ .Error }}")
+
+	// Construct an error based on the template.
+	err := tmpl.Build(errutil.TemplateData{
+		Public: map[string]interface{}{
+			"user": "grot the bot",
+		},
+		Error: errors.New("oh noes"),
+	})
+
+	fmt.Println(err.Error())
+
+	// Output:
+	// [template.sample-error] [grot the bot] got error: oh noes
+}
+
+func ExampleTemplate_public() {
+	// Initialization, this is typically done on a package or global
+	// level.
+	var tmpl = errutil.
+		NewBase(errutil.StatusInternal, "template.sample-error").
+		MustTemplate(
+			"[{{ .Public.user }}] got error: {{ .Error }}",
+			errutil.WithPublic("Oh, no, error for {{ .Public.user }}"),
+		)
+
+	// Construct an error based on the template.
+	//nolint:errorlint
+	err := tmpl.Build(errutil.TemplateData{
+		Public: map[string]interface{}{
+			"user": "grot the bot",
+		},
+		Error: errors.New("oh noes"),
+	}).(errutil.Error)
+
+	fmt.Println(err.Error())
+	fmt.Println(err.PublicMessage)
+
+	// Output:
+	// [template.sample-error] [grot the bot] got error: oh noes
+	// Oh, no, error for grot the bot
+}