experimental: DataQuery: switch from timeRange to _timeRange (#1420)

* experimental: DataQuery: switch from timeRange to _timeRange

* added explanation

Author: gabor

experimental/apis/data/v0alpha1/conversions_test.go

@@ -54,7 +54,7 @@ func TestToBackendDataQueryJSON(t *testing.T) {
 	require.Equal(t, time.UnixMilli(12345678).UTC(), bq.TimeRange.From)
 	require.Equal(t, time.UnixMilli(87654321).UTC(), bq.TimeRange.To)
 
-	jsonData := `{"refId":"A","timeRange":{"from":"12345678","to":"87654321"},"datasource":{"type":"prometheus","uid":"hello-world"},"queryType":"interesting","maxDataPoints":42,"intervalMs":15,"key1":"value1","key2":"value2"}`
+	jsonData := `{"refId":"A","_timeRange":{"from":"12345678","to":"87654321"},"datasource":{"type":"prometheus","uid":"hello-world"},"queryType":"interesting","maxDataPoints":42,"intervalMs":15,"key1":"value1","key2":"value2"}`
 
 	require.Equal(t, jsonData, string(bq.JSON))
 }

experimental/apis/data/v0alpha1/query.go

@@ -269,7 +269,7 @@ func writeQuery(g *DataQuery, stream *j.Stream) {
 
 	if q.TimeRange != nil {
 		stream.WriteMore()
-		stream.WriteObjectField("timeRange")
+		stream.WriteObjectField("_timeRange")
 		stream.WriteVal(g.TimeRange)
 	}
 
@@ -347,7 +347,9 @@ func (g *CommonQueryProperties) readQuery(iter *jsoniter.Iterator,
 			g.RefID, err = iter.ReadString()
 		case "resultAssertions":
 			err = iter.ReadVal(&g.ResultAssertions)
-		case "timeRange":
+		case "timeRange": // temporarily kept for backward compatibility
+			err = iter.ReadVal(&g.TimeRange)
+		case "_timeRange":
 			err = iter.ReadVal(&g.TimeRange)
 		case "datasource":
 			// Old datasource values may just be a string

experimental/apis/data/v0alpha1/query_test.go

@@ -56,6 +56,18 @@ func TestParseQueriesIntoQueryDataRequest(t *testing.T) {
 					"from": "100",
 					"to": "200"
 				}
+			},
+			{
+				"refId": "Q",
+				"datasource": {
+					"type": "prometheus",
+					"uid": "u-i-d"
+				},
+				"expr": "42",
+				"_timeRange": {
+					"from": "10",
+					"to": "20"
+				}
 			}
 		],
 		"from": "1692624667389",
@@ -67,7 +79,7 @@ func TestParseQueriesIntoQueryDataRequest(t *testing.T) {
 	require.NoError(t, err)
 
 	t.Run("verify raw unmarshal", func(t *testing.T) {
-		require.Len(t, req.Queries, 2)
+		require.Len(t, req.Queries, 3)
 		require.Equal(t, "b1808c48-9fc9-4045-82d7-081781f8a553", req.Queries[0].Datasource.UID)
 		require.Equal(t, "spreadsheetID", req.Queries[0].GetString("spreadsheet"))
 
@@ -84,21 +96,42 @@ func TestParseQueriesIntoQueryDataRequest(t *testing.T) {
 		require.Equal(t, int64(10), req.Queries[1].MaxDataPoints) // input was a string
 
 		// The second query has an explicit time range, and legacy datasource name
+		require.NotNil(t, req.Queries[1].TimeRange)
+		require.Equal(t, "100", req.Queries[1].TimeRange.From)
+		require.Equal(t, "200", req.Queries[1].TimeRange.To)
 		out, err = json.MarshalIndent(req.Queries[1], "", "  ")
 		require.NoError(t, err)
-		// fmt.Printf("%s\n", string(out))
 		require.JSONEq(t, `{
 			"datasource": {
 			  "type": "", ` /* NOTE! this implies legacy naming */ +`
 			  "uid": "old"
 			},
 			"maxDataPoints": 10,
 			"refId": "Z",
-			"timeRange": {
+			"_timeRange": {
 			  "from": "100",
 			  "to": "200"
 			}
 		  }`, string(out))
+
+		// The third query has a time-range with an underscore prefix
+		require.NotNil(t, req.Queries[2].TimeRange)
+		require.Equal(t, "10", req.Queries[2].TimeRange.From)
+		require.Equal(t, "20", req.Queries[2].TimeRange.To)
+		out, err = json.MarshalIndent(req.Queries[2], "", "  ")
+		require.NoError(t, err)
+		require.JSONEq(t, `{
+			"datasource": {
+			  "type": "prometheus",
+			  "uid": "u-i-d"
+			},
+			"expr": "42",
+			"refId": "Q",
+			"_timeRange": {
+			  "from": "10",
+			  "to": "20"
+			}
+		  }`, string(out))
 	})
 
 	t.Run("verify deep copy", func(t *testing.T) {