Dataplane: Enable dataplane for results of LongToWide (#1057)

* Dataplane: Enable dataplane for results of LongToWide by setting FrameTypeVersion{0, 1} on the results of LongToWide * SSE and Recorded Queries will use a different code path for this, but the behavior should be identical. * If consumers of this function (mainly SQL data sources) find that they need to undo this behavior for some reason, then they can set the frameTypeVersion to {0, 0} on the resulting frame, since this is the only change (e.g. `myWideFrame.Meta.TypeVersion = FrameTypeVersion{0, 0}`)
grafana · Aug 26, 2024 · 96b9aa7 · 96b9aa7
1 parent 7470982
commit 96b9aa7
Show file tree

Hide file tree

Showing 2 changed files with 35 additions and 14 deletions.
diff --git a/data/time_series.go b/data/time_series.go
@@ -263,6 +263,11 @@ func LongToWide(longFrame *Frame, fillMissing *FillMissing) (*Frame, error) {
 		wideFrame.Meta = &FrameMeta{}
 	}
 	wideFrame.Meta.Type = FrameTypeTimeSeriesWide
+
+	// Setting the TypeVersion to greater than [0, 0] (along with Meta.Type being set) indicates that the produced
+	// frame follows the dataplane contract (see https://grafana.com/developers/dataplane/ and https://github.com/grafana/dataplane).
+	// https://grafana.com/developers/dataplane/timeseries#time-series-wide-format-timeserieswide defines TimeSeriesWide in dataplane.
+	wideFrame.Meta.TypeVersion = FrameTypeVersion{0, 1}
 	return wideFrame, nil
 }
 

diff --git a/data/time_series_test.go b/data/time_series_test.go
@@ -78,6 +78,8 @@ func TestTimeSeriesSchema(t *testing.T) {
 	}
 }
 
+var FTV01 = data.FrameTypeVersion{0, 1}
+
 func TestLongToWide(t *testing.T) {
 	tests := []struct {
 		name          string
@@ -121,7 +123,8 @@ func TestLongToWide(t *testing.T) {
 					2.0,
 					4.0,
 				})).SetMeta(&data.FrameMeta{
-				Type: data.FrameTypeTimeSeriesWide,
+				Type:        data.FrameTypeTimeSeriesWide,
+				TypeVersion: FTV01,
 			}),
 			Err: require.NoError,
 		},
@@ -168,7 +171,8 @@ func TestLongToWide(t *testing.T) {
 						2.0,
 						4.0,
 					})).SetMeta(&data.FrameMeta{
-				Type: data.FrameTypeTimeSeriesWide,
+				Type:        data.FrameTypeTimeSeriesWide,
+				TypeVersion: FTV01,
 			}),
 			Err: require.NoError,
 		},
@@ -221,7 +225,8 @@ func TestLongToWide(t *testing.T) {
 					2,
 					4,
 				})).SetMeta(&data.FrameMeta{
-				Type: data.FrameTypeTimeSeriesWide,
+				Type:        data.FrameTypeTimeSeriesWide,
+				TypeVersion: FTV01,
 			}),
 			Err: require.NoError,
 		},
@@ -280,7 +285,8 @@ func TestLongToWide(t *testing.T) {
 					2,
 					4,
 				})).SetMeta(&data.FrameMeta{
-				Type: data.FrameTypeTimeSeriesWide,
+				Type:        data.FrameTypeTimeSeriesWide,
+				TypeVersion: FTV01,
 			}),
 			Err: require.NoError,
 		},
@@ -319,7 +325,8 @@ func TestLongToWide(t *testing.T) {
 					float64Ptr(2.0),
 					float64Ptr(4.0),
 				})).SetMeta(&data.FrameMeta{
-				Type: data.FrameTypeTimeSeriesWide,
+				Type:        data.FrameTypeTimeSeriesWide,
+				TypeVersion: FTV01,
 			}),
 			Err: require.NoError,
 		},
@@ -385,7 +392,8 @@ func TestLongToWide(t *testing.T) {
 					0.0,
 					6.0,
 				})).SetMeta(&data.FrameMeta{
-				Type: data.FrameTypeTimeSeriesWide,
+				Type:        data.FrameTypeTimeSeriesWide,
+				TypeVersion: FTV01,
 			}),
 
 			Err: require.NoError,
@@ -452,7 +460,8 @@ func TestLongToWide(t *testing.T) {
 					nil,
 					float64Ptr(6.0),
 				})).SetMeta(&data.FrameMeta{
-				Type: data.FrameTypeTimeSeriesWide,
+				Type:        data.FrameTypeTimeSeriesWide,
+				TypeVersion: FTV01,
 			}),
 			Err: require.NoError,
 		},
@@ -548,7 +557,8 @@ func TestLongToWide(t *testing.T) {
 					6,
 				}),
 			).SetMeta(&data.FrameMeta{
-				Type: data.FrameTypeTimeSeriesWide,
+				Type:        data.FrameTypeTimeSeriesWide,
+				TypeVersion: FTV01,
 			}),
 			Err: require.NoError,
 		},
@@ -644,7 +654,8 @@ func TestLongToWide(t *testing.T) {
 					int64Ptr(6),
 				}),
 			).SetMeta(&data.FrameMeta{
-				Type: data.FrameTypeTimeSeriesWide,
+				Type:        data.FrameTypeTimeSeriesWide,
+				TypeVersion: FTV01,
 			}),
 			Err: require.NoError,
 		},
@@ -740,7 +751,8 @@ func TestLongToWide(t *testing.T) {
 					int64Ptr(6),
 				}),
 			).SetMeta(&data.FrameMeta{
-				Type: data.FrameTypeTimeSeriesWide,
+				Type:        data.FrameTypeTimeSeriesWide,
+				TypeVersion: FTV01,
 			}),
 			Err: require.NoError,
 		},
@@ -836,7 +848,8 @@ func TestLongToWide(t *testing.T) {
 					int64Ptr(6),
 				}),
 			).SetMeta(&data.FrameMeta{
-				Type: data.FrameTypeTimeSeriesWide,
+				Type:        data.FrameTypeTimeSeriesWide,
+				TypeVersion: FTV01,
 			}),
 			Err: require.NoError,
 		},
@@ -931,7 +944,8 @@ func TestLongToWide(t *testing.T) {
 					int64Ptr(6),
 				}),
 			).SetMeta(&data.FrameMeta{
-				Type: data.FrameTypeTimeSeriesWide,
+				Type:        data.FrameTypeTimeSeriesWide,
+				TypeVersion: FTV01,
 			}),
 			Err: require.NoError,
 		},
@@ -1026,7 +1040,8 @@ func TestLongToWide(t *testing.T) {
 					int64Ptr(6.0),
 				}),
 			).SetMeta(&data.FrameMeta{
-				Type: data.FrameTypeTimeSeriesWide,
+				Type:        data.FrameTypeTimeSeriesWide,
+				TypeVersion: FTV01,
 			}),
 			Err: require.NoError,
 		},
@@ -1086,7 +1101,8 @@ func TestLongToWideBool(t *testing.T) {
 					1.0,
 					3.0,
 				})).SetMeta(&data.FrameMeta{
-				Type: data.FrameTypeTimeSeriesWide,
+				Type:        data.FrameTypeTimeSeriesWide,
+				TypeVersion: FTV01,
 			}),
 			Err: require.NoError,
 		},