Feat: Add Combine by Channel Name (#64)

* working

* remove channel_id when combining assets

* add datatype

* handle multiple types. change option name

* add tests

* switch back to labels

* tooltip change

Author: nathan-sift

pkg/plugin/datasource.go

@@ -62,6 +62,34 @@ var ValidSiftGrafanaDataTypes = []string{
 	// Note: No bytes
 }
 
+// Provides a more concise data_type label
+func dataTypeLabel(dataType string) string {
+	switch dataType {
+	case "CHANNEL_DATA_TYPE_DOUBLE":
+		return "double"
+	case "CHANNEL_DATA_TYPE_FLOAT":
+		return "float"
+	case "CHANNEL_DATA_TYPE_INT_32":
+		return "int32"
+	case "CHANNEL_DATA_TYPE_INT_64":
+		return "int64"
+	case "CHANNEL_DATA_TYPE_UINT_32":
+		return "uint32"
+	case "CHANNEL_DATA_TYPE_UINT_64":
+		return "uint64"
+	case "CHANNEL_DATA_TYPE_BOOL":
+		return "bool"
+	case "CHANNEL_DATA_TYPE_STRING":
+		return "string"
+	case "CHANNEL_DATA_TYPE_ENUM":
+		return "enum"
+	case "CHANNEL_DATA_TYPE_BIT_FIELD":
+		return "bitfield"
+	default:
+		return dataType
+	}
+}
+
 const cacheTimeToLiveMax = time.Minute * 10
 const cacheTimeToLiveMin = cacheTimeToLiveMax / 2
 const cachePurgeTime = time.Minute * 5
@@ -250,6 +278,7 @@ type queryModel struct {
 	commonQueryProperties
 	ChannelDataQueries []channelDataQuery `json:"channelDataQueries"`
 	CombineRuns        bool               `json:"combineRuns"`
+	GroupByChannelName bool               `json:"groupByChannelName"`
 	EnumDisplay        string             `json:"enumDisplay"`
 	QueryVersion       string             `json:"queryVersion"`
 	AnnotationType     string             `json:"annotationType"`
@@ -352,7 +381,11 @@ type bitFieldElementValues struct {
 }
 
 type frameKey struct {
-	channelId           string
+	// channelId when groupByChannelName=false, channelName when groupByChannelName=true
+	channelIdentifier string
+	// dataType is used to differentiate channels in the event groupByChannelName=true
+	// and two or more channels share a name, but not a type
+	dataType            string
 	runId               string
 	bitFieldElementName string
 	isEnumString        bool
@@ -425,9 +458,9 @@ func (d *SiftDatasource) query(ctx context.Context, pCtx backend.PluginContext,
 	var frame *data.Frame
 	if fqm.AnnotationType != "" {
 		// Any annotationType set means we want the flat annotation frame format
-		frame, err = generateAnnotationFrame(responseData, calculatedChannelKeys, fqm.CombineRuns, fqm.EnumDisplay)
+		frame, err = generateAnnotationFrame(responseData, calculatedChannelKeys, fqm.CombineRuns, fqm.GroupByChannelName, fqm.EnumDisplay)
 	} else {
-		frame, err = generateDataFrame(responseData, calculatedChannelKeys, fqm.CombineRuns, fqm.EnumDisplay)
+		frame, err = generateDataFrame(responseData, calculatedChannelKeys, fqm.CombineRuns, fqm.GroupByChannelName, fqm.EnumDisplay)
 	}
 	if err != nil {
 		return backend.ErrDataResponse(backend.StatusBadRequest, fmt.Sprintf("error generating data frame: %v", err.Error()))
@@ -583,7 +616,7 @@ func runDataQueries(ctx context.Context, pCtx backend.PluginContext, queries []s
 	return allData, nil
 }
 
-func generateDataFrame(responseData []queryResponseData, calculatedChannelKeys map[string]calculatedChannelKey, combineRuns bool, enumDisplay string) (*data.Frame, error) {
+func generateDataFrame(responseData []queryResponseData, calculatedChannelKeys map[string]calculatedChannelKey, combineRuns bool, groupByChannelName bool, enumDisplay string) (*data.Frame, error) {
 	// create data frame response.
 	// For an overview on data frames and how grafana handles them:
 	// https://grafana.com/developers/plugin-tools/introduction/data-frames
@@ -592,11 +625,15 @@ func generateDataFrame(responseData []queryResponseData, calculatedChannelKeys m
 	allData := map[frameKey]map[int64]any{}
 
 	for _, d := range responseData {
+		channelIdentifier := d.Metadata.Channel.ChannelId
+		if groupByChannelName {
+			channelIdentifier = d.Metadata.Channel.Name
+		}
 		switch d.Metadata.DataType {
 		case "CHANNEL_DATA_TYPE_BIT_FIELD":
 			for _, bitFieldElement := range d.Metadata.Channel.BitFieldElements {
 				key := frameKey{
-					channelId:           d.Metadata.Channel.ChannelId,
+					channelIdentifier:   channelIdentifier,
 					bitFieldElementName: bitFieldElement.Name,
 				}
 				if !combineRuns {
@@ -610,8 +647,8 @@ func generateDataFrame(responseData []queryResponseData, calculatedChannelKeys m
 		case "CHANNEL_DATA_TYPE_ENUM":
 			if enumDisplay == EnumDisplayCombined {
 				key := frameKey{
-					channelId:      d.Metadata.Channel.ChannelId,
-					isEnumCombined: true,
+					channelIdentifier: channelIdentifier,
+					isEnumCombined:    true,
 				}
 				if !combineRuns {
 					key.runId = d.Metadata.Run.RunId
@@ -623,8 +660,8 @@ func generateDataFrame(responseData []queryResponseData, calculatedChannelKeys m
 			} else {
 				for _, v := range []bool{true, false} {
 					key := frameKey{
-						channelId:    d.Metadata.Channel.ChannelId,
-						isEnumString: v,
+						channelIdentifier: channelIdentifier,
+						isEnumString:      v,
 					}
 					if !combineRuns {
 						key.runId = d.Metadata.Run.RunId
@@ -637,7 +674,8 @@ func generateDataFrame(responseData []queryResponseData, calculatedChannelKeys m
 			}
 		default:
 			key := frameKey{
-				channelId: d.Metadata.Channel.ChannelId,
+				channelIdentifier: channelIdentifier,
+				dataType:          d.Metadata.DataType,
 			}
 			if !combineRuns {
 				key.runId = d.Metadata.Run.RunId
@@ -832,7 +870,7 @@ func generateDataFrame(responseData []queryResponseData, calculatedChannelKeys m
 		allDataKeys = append(allDataKeys, k)
 	}
 	sort.SliceStable(allDataKeys, func(i, j int) bool {
-		return allDataKeys[i].runId < allDataKeys[j].runId && allDataKeys[i].channelId < allDataKeys[j].channelId
+		return allDataKeys[i].runId < allDataKeys[j].runId && allDataKeys[i].channelIdentifier < allDataKeys[j].channelIdentifier
 	})
 
 	// Track enum field base names for filtering later
@@ -859,23 +897,31 @@ func generateDataFrame(responseData []queryResponseData, calculatedChannelKeys m
 		if m.Run.RunId != "" && !combineRuns {
 			labels["run_id"] = m.Run.RunId
 		}
-		if m.Asset.Name != "" {
+		groupedAcrossAssets := false
+		if groupByChannelName {
+			firstAssetId := dataMap[key][0].Metadata.Asset.AssetId
+			for _, d := range dataMap[key][1:] {
+				if d.Metadata.Asset.AssetId != firstAssetId {
+					groupedAcrossAssets = true
+					break
+				}
+			}
+		}
+		if m.Asset.Name != "" && !groupedAcrossAssets {
 			labels["asset"] = m.Asset.Name
 		}
-		if m.Asset.AssetId != "" {
+		if m.Asset.AssetId != "" && !groupedAcrossAssets {
 			labels["asset_id"] = m.Asset.AssetId
 		}
-		if len(m.Channel.BitFieldElements) > 0 {
-			for _, bitFieldElement := range m.Channel.BitFieldElements {
-				if key.bitFieldElementName == bitFieldElement.Name {
-					labels["bitfield_element"] = bitFieldElement.Name
-				}
-			}
+		if key.bitFieldElementName != "" {
+			labels["bitfield_element"] = key.bitFieldElementName
 		}
-		if include_channel_id {
+		if include_channel_id && !groupedAcrossAssets {
 			labels["channel_id"] = m.Channel.ChannelId
 		}
 
+		labels["data_type"] = dataTypeLabel(m.DataType)
+
 		switch m.DataType {
 		default:
 			return nil, fmt.Errorf("unknown data type: %v", m.DataType)
@@ -1006,13 +1052,13 @@ func generateDataFrame(responseData []queryResponseData, calculatedChannelKeys m
 
 // generateAnnotationFrame creates an annotation-compatible data frame by reusing generateDataFrame
 // and converting it to a flat row-per-event format with metadata columns.
-func generateAnnotationFrame(responseData []queryResponseData, calculatedChannelKeys map[string]calculatedChannelKey, combineRuns bool, enumDisplay string) (*data.Frame, error) {
+func generateAnnotationFrame(responseData []queryResponseData, calculatedChannelKeys map[string]calculatedChannelKey, combineRuns bool, groupByChannelName bool, enumDisplay string) (*data.Frame, error) {
 	// Use combined mode for enums so we get a single "string (number)" field
 	annotationEnumDisplay := enumDisplay
 	if annotationEnumDisplay == "" || annotationEnumDisplay == EnumDisplayBoth {
 		annotationEnumDisplay = EnumDisplayCombined
 	}
-	sourceFrame, err := generateDataFrame(responseData, calculatedChannelKeys, combineRuns, annotationEnumDisplay)
+	sourceFrame, err := generateDataFrame(responseData, calculatedChannelKeys, combineRuns, groupByChannelName, annotationEnumDisplay)
 	if err != nil {
 		return nil, err
 	}