Dashboard : Allow applying variable regex to display text (#114426)

* Ability to apply regex to display text

* Frontend tests

* scenes-react version

* lock file

* adjust tests input

* adjust inputs

* unused variable

* change data type

* unit tests

* bump scenes

* bump scenes

* Update docs

* V2->V1 conversion

* re-generate files

* update openai snapshots

apps/dashboard/pkg/migration/conversion/testdata/input/v1beta1.variable-conversions.json

@@ -42,7 +42,7 @@
           "regex": "",
           "skipUrlSync": false,
           "refresh": 1
-        },
+      },
         {
           "name": "query_var",
           "type": "query",
@@ -81,6 +81,7 @@
           "allValue": ".*",
           "multi": true,
           "regex": "/.*9090.*/",
+          "regexApplyTo": "text",
           "skipUrlSync": false,
           "refresh": 2,
           "sort": 1,
@@ -107,7 +108,7 @@
             },
             {
               "selected": false,
-              "text": "staging", 
+              "text": "staging",
               "value": "staging"
             },
             {
@@ -335,6 +336,7 @@
           "allValue": "*",
           "multi": true,
           "regex": "/host[0-9]+/",
+          "regexApplyTo": "value",
           "skipUrlSync": false,
           "refresh": 1,
           "sort": 2,
@@ -354,4 +356,4 @@
     },
     "links": []
   }
-} 
+}

apps/dashboard/pkg/migration/conversion/testdata/output/v1beta1.variable-conversions.v0alpha1.json

@@ -94,6 +94,7 @@
           "query": "label_values(up, instance)",
           "refresh": 2,
           "regex": "/.*9090.*/",
+          "regexApplyTo": "text",
           "skipUrlSync": false,
           "sort": 1,
           "tagValuesQuery": "",
@@ -362,6 +363,7 @@
           },
           "refresh": 1,
           "regex": "/host[0-9]+/",
+          "regexApplyTo": "value",
           "skipUrlSync": false,
           "sort": 2,
           "tagValuesQuery": "",

apps/dashboard/pkg/migration/conversion/testdata/output/v1beta1.variable-conversions.v2alpha1.json

@@ -110,6 +110,7 @@
             }
           },
           "regex": "/.*9090.*/",
+          "regexApplyTo": "text",
           "sort": "alphabeticalAsc",
           "definition": "label_values(up, instance)",
           "options": [
@@ -401,6 +402,7 @@
             }
           },
           "regex": "/host[0-9]+/",
+          "regexApplyTo": "value",
           "sort": "alphabeticalDesc",
           "definition": "terms field:@host size:100",
           "options": [],

apps/dashboard/pkg/migration/conversion/testdata/output/v1beta1.variable-conversions.v2beta1.json

@@ -111,6 +111,7 @@
             }
           },
           "regex": "/.*9090.*/",
+          "regexApplyTo": "text",
           "sort": "alphabeticalAsc",
           "definition": "label_values(up, instance)",
           "options": [
@@ -404,6 +405,7 @@
             }
           },
           "regex": "/host[0-9]+/",
+          "regexApplyTo": "value",
           "sort": "alphabeticalDesc",
           "definition": "terms field:@host size:100",
           "options": [],

apps/dashboard/pkg/migration/conversion/v1beta1_to_v2alpha1.go

@@ -229,6 +229,16 @@ func getBoolField(m map[string]interface{}, key string, defaultValue bool) bool
 	return defaultValue
 }
 
+func getUnionField[T ~string](m map[string]interface{}, key string) *T {
+	if val, ok := m[key]; ok {
+		if str, ok := val.(string); ok && str != "" {
+			result := T(str)
+			return &result
+		}
+	}
+	return nil
+}
+
 // Helper function to create int64 pointer
 func int64Ptr(i int64) *int64 {
 	return &i
@@ -1195,6 +1205,7 @@ func buildQueryVariable(ctx context.Context, varMap map[string]interface{}, comm
 			Refresh:          transformVariableRefreshToEnum(varMap["refresh"]),
 			Sort:             transformVariableSortToEnum(varMap["sort"]),
 			Regex:            schemaversion.GetStringValue(varMap, "regex"),
+			RegexApplyTo:     getUnionField[dashv2alpha1.DashboardVariableRegexApplyTo](varMap, "regexApplyTo"),
 			Query:            buildDataQueryKindForVariable(varMap["query"], datasourceType),
 			AllowCustomValue: getBoolField(varMap, "allowCustomValue", true),
 		},

apps/dashboard/pkg/migration/conversion/v2alpha1_to_v1beta1.go

@@ -1312,6 +1312,9 @@ func convertQueryVariableToV1(variable *dashv2alpha1.DashboardQueryVariableKind)
 	if spec.Definition != nil {
 		varMap["definition"] = *spec.Definition
 	}
+	if spec.RegexApplyTo != nil {
+		varMap["regexApplyTo"] = string(*spec.RegexApplyTo)
+	}
 	varMap["allowCustomValue"] = spec.AllowCustomValue
 
 	// Convert query - handle LEGACY_STRING_VALUE_KEY

apps/dashboard/pkg/migration/conversion/v2alpha1_to_v2beta1.go

@@ -767,6 +767,7 @@ func convertQueryVariableSpec_V2alpha1_to_V2beta1(in *dashv2alpha1.DashboardQuer
 	out.SkipUrlSync = in.SkipUrlSync
 	out.Description = in.Description
 	out.Regex = in.Regex
+	out.RegexApplyTo = (*dashv2beta1.DashboardVariableRegexApplyTo)(in.RegexApplyTo)
 	out.Sort = dashv2beta1.DashboardVariableSort(in.Sort)
 	out.Definition = in.Definition
 	out.Options = convertVariableOptions_V2alpha1_to_V2beta1(in.Options)

apps/dashboard/pkg/migration/conversion/v2beta1_to_v2alpha1.go

@@ -806,6 +806,7 @@ func convertQueryVariableSpec_V2beta1_to_V2alpha1(in *dashv2beta1.DashboardQuery
 	out.SkipUrlSync = in.SkipUrlSync
 	out.Description = in.Description
 	out.Regex = in.Regex
+	out.RegexApplyTo = (*dashv2alpha1.DashboardVariableRegexApplyTo)(in.RegexApplyTo)
 	out.Sort = dashv2alpha1.DashboardVariableSort(in.Sort)
 	out.Definition = in.Definition
 	out.Options = convertVariableOptions_V2beta1_to_V2alpha1(in.Options)