Merge pull request #122 from K-Phoen/fix-long-uid

Prevent long UIDs from being used

dashboard/dashboard.go

@@ -1,6 +1,10 @@
 package dashboard
 
 import (
+	// We're not using it for security stuff, so it's fine.
+	//nolint:gosec
+	"crypto/sha1"
+	"encoding/hex"
 	"encoding/json"
 
 	"github.com/K-Phoen/grabana/row"
@@ -120,7 +124,16 @@ func ID(id uint) Option {
 // UID sets the UID used by the dashboard.
 func UID(uid string) Option {
 	return func(builder *Builder) {
-		builder.board.UID = uid
+		validUID := uid
+
+		if len(uid) > 40 {
+			// We're not using it for security stuff, so it's fine.
+			//nolint:gosec
+			sha := sha1.Sum([]byte(uid))
+			validUID = hex.EncodeToString(sha[:])
+		}
+
+		builder.board.UID = validUID
 	}
 }
 

dashboard/dashboard_test.go

@@ -74,6 +74,16 @@ func TestDashboardUIDCanBeSet(t *testing.T) {
 	req.Equal("foo", panel.board.UID)
 }
 
+func TestDashboardUIDWillBeHashedWhenTooLongForGrafana(t *testing.T) {
+	req := require.New(t)
+
+	originalUID := "this-uid-is-more-than-forty-characters-and-grafana-does-not-like-it"
+	panel := New("", UID(originalUID))
+
+	req.NotEqual(originalUID, panel.board.UID)
+	req.Len(panel.board.UID, 40)
+}
+
 func TestDashboardCanBeMadeReadOnly(t *testing.T) {
 	req := require.New(t)