feat: add QueryTag and query comments information

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## 2.0.0 (not released yet)
 
+### ⭐ Added
+- Add a query tag that includes relevant Grafana context information.
+
+
 ## 1.9.1
 
 ### 🔨 Changed

pkg/check_health.go

@@ -4,6 +4,8 @@ import (
 	"context"
 	"database/sql"
 	"fmt"
+	"github.com/michelin/snowflake-grafana-datasource/pkg/data"
+	"github.com/michelin/snowflake-grafana-datasource/pkg/utils"
 
 	"github.com/grafana/grafana-plugin-sdk-go/backend"
 	_ "github.com/snowflakedb/gosnowflake"
@@ -32,7 +34,7 @@ func (td *SnowflakeDatasource) CheckHealth(ctx context.Context, req *backend.Che
 	}
 	defer td.db.Close()
 
-	row, err := td.db.QueryContext(ctx, "SELECT 1")
+	row, err := td.db.QueryContext(utils.AddQueryTagInfos(ctx, &data.QueryConfigStruct{}), "SELECT 1")
 	if err != nil {
 		return &backend.CheckHealthResult{
 			Status:  backend.HealthStatusError,

pkg/data/type.go

@@ -0,0 +1,51 @@
+package data
+
+import (
+	"database/sql"
+	"github.com/grafana/grafana-plugin-sdk-go/backend"
+	"time"
+)
+
+type QueryResult struct {
+	Tables []Table
+}
+
+// DataTable structure containing columns and rows
+type Table struct {
+	Columns []*sql.ColumnType
+	Rows    [][]interface{}
+}
+
+const TimeSeriesType = "time series"
+
+func (qc *QueryConfigStruct) IsTimeSeriesType() bool {
+	return qc.QueryType == TimeSeriesType
+}
+
+type QueryConfigStruct struct {
+	FinalQuery    string
+	QueryType     string
+	RawQuery      string
+	TimeColumns   []string
+	TimeRange     backend.TimeRange
+	Interval      time.Duration
+	MaxDataPoints int64
+	FillMode      string
+	FillValue     float64
+}
+
+type QueryTagStruct struct {
+	PluginVersion string                `json:"pluginVersion,omitempty"`
+	QueryType     string                `json:"queryType,omitempty"`
+	From          string                `json:"from,omitempty"`
+	To            string                `json:"to,omitempty"`
+	Grafana       QueryTagGrafanaStruct `json:"grafana,omitempty"`
+}
+
+type QueryTagGrafanaStruct struct {
+	Version      string `json:"version,omitempty"`
+	Host         string `json:"host,omitempty"`
+	OrgId        int64  `json:"orgId,omitempty"`
+	User         string `json:"user,omitempty"`
+	DatasourceId string `json:"datasourceId,omitempty"`
+}

pkg/macros.go

@@ -2,6 +2,8 @@ package main
 
 import (
 	"fmt"
+	"github.com/michelin/snowflake-grafana-datasource/pkg/data"
+	"github.com/michelin/snowflake-grafana-datasource/pkg/utils"
 	"math"
 	"regexp"
 	"strconv"
@@ -30,7 +32,7 @@ func ReplaceAllStringSubmatchFunc(re *regexp.Regexp, str string, repl func([]str
 	return result + str[lastIndex:]
 }
 
-func Interpolate(configStruct *queryConfigStruct) (string, error) {
+func Interpolate(configStruct *data.QueryConfigStruct) (string, error) {
 	rExp, _ := regexp.Compile(sExpr)
 	var macroError error
 
@@ -58,7 +60,7 @@ func Interpolate(configStruct *queryConfigStruct) (string, error) {
 	return sql, nil
 }
 
-func SetupFillmode(configStruct *queryConfigStruct, fillmode string) error {
+func SetupFillmode(configStruct *data.QueryConfigStruct, fillmode string) error {
 	switch fillmode {
 	case "NULL":
 		configStruct.FillMode = NullFill
@@ -77,7 +79,7 @@ func SetupFillmode(configStruct *queryConfigStruct, fillmode string) error {
 }
 
 // evaluateMacro convert macro expression to sql expression
-func evaluateMacro(name string, args []string, configStruct *queryConfigStruct) (string, error) {
+func evaluateMacro(name string, args []string, configStruct *data.QueryConfigStruct) (string, error) {
 	timeRange := configStruct.TimeRange
 
 	switch name {
@@ -146,7 +148,7 @@ func evaluateMacro(name string, args []string, configStruct *queryConfigStruct)
 		if len(args) < 2 {
 			return "", fmt.Errorf("macro %v needs time column and interval and optional fill value", name)
 		}
-		interval, err := ParseInterval(strings.Trim(args[1], `'`))
+		interval, err := utils.ParseInterval(strings.Trim(args[1], `'`))
 		if err != nil {
 			return "", fmt.Errorf("error parsing interval %v", args[1])
 		}
@@ -182,7 +184,7 @@ func evaluateMacro(name string, args []string, configStruct *queryConfigStruct)
 		if len(args) < 2 {
 			return "", fmt.Errorf("macro %v needs time column and interval and optional fill value", name)
 		}
-		interval, err := ParseInterval(strings.Trim(args[1], `'`))
+		interval, err := utils.ParseInterval(strings.Trim(args[1], `'`))
 		if err != nil {
 			return "", fmt.Errorf("error parsing interval %v", args[1])
 		}

pkg/macros_test.go

@@ -2,6 +2,7 @@ package main
 
 import (
 	"fmt"
+	"github.com/michelin/snowflake-grafana-datasource/pkg/data"
 	"testing"
 	"time"
 
@@ -16,14 +17,14 @@ func TestEvaluateMacro(t *testing.T) {
 		To:   time.Now().Add(time.Minute),
 	}
 
-	configStruct := queryConfigStruct{
+	configStruct := data.QueryConfigStruct{
 		TimeRange: timeRange,
 	}
 
 	tcs := []struct {
 		args      []string
 		name      string
-		config    queryConfigStruct
+		config    data.QueryConfigStruct
 		response  string
 		err       string
 		fillMode  string
@@ -128,13 +129,13 @@ func TestEvaluateMacro(t *testing.T) {
 func TestInterpolate(t *testing.T) {
 	tests := []struct {
 		name          string
-		configStruct  *queryConfigStruct
+		configStruct  *data.QueryConfigStruct
 		expectedSQL   string
 		expectedError string
 	}{
 		{
 			name: "valid macro",
-			configStruct: &queryConfigStruct{
+			configStruct: &data.QueryConfigStruct{
 				RawQuery: "SELECT * FROM table WHERE $__timeFilter(col)",
 				TimeRange: backend.TimeRange{
 					From: time.Date(2020, 1, 1, 0, 0, 0, 0, time.UTC),
@@ -146,31 +147,31 @@ func TestInterpolate(t *testing.T) {
 		},
 		{
 			name: "missing time column argument",
-			configStruct: &queryConfigStruct{
+			configStruct: &data.QueryConfigStruct{
 				RawQuery: "SELECT * FROM table WHERE $__timeFilter()",
 			},
 			expectedSQL:   "",
 			expectedError: "missing time column argument for macro __timeFilter",
 		},
 		{
 			name: "valid snowflake system macro",
-			configStruct: &queryConfigStruct{
+			configStruct: &data.QueryConfigStruct{
 				RawQuery: "SELECT SYSTEM$TYPEOF('a')",
 			},
 			expectedSQL:   "SELECT SYSTEM$TYPEOF('a')",
 			expectedError: "",
 		},
 		{
 			name: "unknown macro",
-			configStruct: &queryConfigStruct{
+			configStruct: &data.QueryConfigStruct{
 				RawQuery: "SELECT * FROM table WHERE $__unknownMacro(col)",
 			},
 			expectedSQL:   "",
 			expectedError: "unknown macro \"__unknownMacro\"",
 		},
 		{
 			name: "check __timeRoundTo with default 15min",
-			configStruct: &queryConfigStruct{
+			configStruct: &data.QueryConfigStruct{
 				RawQuery: "SELECT * FROM table WHERE $__timeRoundTo()",
 				TimeRange: backend.TimeRange{
 					From: time.Date(2020, 1, 1, 0, 7, 0, 0, time.UTC),
@@ -182,7 +183,7 @@ func TestInterpolate(t *testing.T) {
 		},
 		{
 			name: "check __timeRoundFrom with default 15min",
-			configStruct: &queryConfigStruct{
+			configStruct: &data.QueryConfigStruct{
 				RawQuery: "SELECT * FROM table WHERE $__timeRoundFrom()",
 				TimeRange: backend.TimeRange{
 					From: time.Date(2020, 1, 1, 0, 7, 0, 0, time.UTC),
@@ -194,7 +195,7 @@ func TestInterpolate(t *testing.T) {
 		},
 		{
 			name: "check __timeRoundTo with 5min",
-			configStruct: &queryConfigStruct{
+			configStruct: &data.QueryConfigStruct{
 				RawQuery: "SELECT * FROM table WHERE $__timeRoundTo(5)",
 				TimeRange: backend.TimeRange{
 					From: time.Date(2020, 1, 1, 0, 7, 0, 0, time.UTC),
@@ -206,7 +207,7 @@ func TestInterpolate(t *testing.T) {
 		},
 		{
 			name: "check __timeRoundFrom with 5min",
-			configStruct: &queryConfigStruct{
+			configStruct: &data.QueryConfigStruct{
 				RawQuery: "SELECT * FROM table WHERE $__timeRoundFrom(5)",
 				TimeRange: backend.TimeRange{
 					From: time.Date(2020, 1, 1, 0, 7, 0, 0, time.UTC),
@@ -218,7 +219,7 @@ func TestInterpolate(t *testing.T) {
 		},
 		{
 			name: "check __timeRoundTo with 10min",
-			configStruct: &queryConfigStruct{
+			configStruct: &data.QueryConfigStruct{
 				RawQuery: "SELECT * FROM table WHERE $__timeRoundTo(10)",
 				TimeRange: backend.TimeRange{
 					From: time.Date(2020, 1, 1, 0, 7, 0, 0, time.UTC),
@@ -230,7 +231,7 @@ func TestInterpolate(t *testing.T) {
 		},
 		{
 			name: "check __timeRoundFrom with 10min",
-			configStruct: &queryConfigStruct{
+			configStruct: &data.QueryConfigStruct{
 				RawQuery: "SELECT * FROM table WHERE $__timeRoundFrom(10)",
 				TimeRange: backend.TimeRange{
 					From: time.Date(2020, 1, 1, 0, 7, 0, 0, time.UTC),
@@ -242,7 +243,7 @@ func TestInterpolate(t *testing.T) {
 		},
 		{
 			name: "check __timeRoundTo with 30min",
-			configStruct: &queryConfigStruct{
+			configStruct: &data.QueryConfigStruct{
 				RawQuery: "SELECT * FROM table WHERE $__timeRoundTo(30)",
 				TimeRange: backend.TimeRange{
 					From: time.Date(2020, 1, 1, 0, 7, 0, 0, time.UTC),
@@ -254,7 +255,7 @@ func TestInterpolate(t *testing.T) {
 		},
 		{
 			name: "check __timeRoundFrom with 30min",
-			configStruct: &queryConfigStruct{
+			configStruct: &data.QueryConfigStruct{
 				RawQuery: "SELECT * FROM table WHERE $__timeRoundFrom(30)",
 				TimeRange: backend.TimeRange{
 					From: time.Date(2020, 1, 1, 0, 59, 0, 0, time.UTC),
@@ -266,7 +267,7 @@ func TestInterpolate(t *testing.T) {
 		},
 		{
 			name: "check __timeRoundTo with 1440min",
-			configStruct: &queryConfigStruct{
+			configStruct: &data.QueryConfigStruct{
 				RawQuery: "SELECT * FROM table WHERE $__timeRoundTo(1440)",
 				TimeRange: backend.TimeRange{
 					From: time.Date(2020, 1, 1, 0, 7, 0, 0, time.UTC),
@@ -278,7 +279,7 @@ func TestInterpolate(t *testing.T) {
 		},
 		{
 			name: "check __timeRoundFrom with 1440min",
-			configStruct: &queryConfigStruct{
+			configStruct: &data.QueryConfigStruct{
 				RawQuery: "SELECT * FROM table WHERE $__timeRoundFrom(1440)",
 				TimeRange: backend.TimeRange{
 					From: time.Date(2020, 1, 1, 0, 59, 0, 0, time.UTC),