Merge pull request #21 from NeedleInAJayStack/feature/hisread-with-filter

feature: Adds "HisRead with filter" query

Author: NeedleInAJayStack

README.md

@@ -5,12 +5,14 @@ This is a [Grafana](https://grafana.com/grafana/) plugin that supports direct co
 and supports standard Haystack API operations as well as custom Axon execution, which is supported by
 [SkySpark](https://skyfoundry.com/product) and [Haxall](https://haxall.io/).
 
+You can find more information on the
+[Haystack Grafana Plugin Page](https://grafana.com/grafana/plugins/needleinajaystack-haystack-datasource/)
+
 ![Dashboard Example](src/img/screenshot/dashboard.png)
 
 ## Installation
 
-Long term, the goal is to get this into the Grafana plugin repository. Until then, I must manually sign the plugin
-for your particular Grafana URL. If interested, please contact me at [email protected].
+This data source plugin may be installed within the Grafana "Connect data" UI on compliant versions.  
 
 ## Usage
 
@@ -22,7 +24,3 @@ the instructions in the [plugin readme](./src/README.md)
 Contributions are very welcome! For details on how to develop this plugin, see the
 [development guide](./DEVELOPMENT_GUIDE.md).
 
-## Continuing Work
-
-- [ ] Publish plugin
-- [ ] Consider enabling multi-point hisRead (through filters)

pkg/plugin/datasource.go

@@ -96,16 +96,15 @@ func (datasource *Datasource) QueryData(ctx context.Context, req *backend.QueryD
 }
 
 type QueryModel struct {
-	Type    string  `json:"type"`
-	Nav     *string `json:"nav"` // A zinc-encoded Ref or null
-	Eval    string  `json:"eval"`
-	HisRead string  `json:"hisRead"`
-	Read    string  `json:"read"`
+	Type          string  `json:"type"`
+	Nav           *string `json:"nav"` // A zinc-encoded Ref or null
+	Eval          string  `json:"eval"`
+	HisRead       string  `json:"hisRead"`
+	HisReadFilter string  `json:"hisReadFilter"`
+	Read          string  `json:"read"`
 }
 
 func (datasource *Datasource) query(ctx context.Context, pCtx backend.PluginContext, query backend.DataQuery) backend.DataResponse {
-	var response backend.DataResponse
-
 	// Unmarshal the JSON into our queryModel.
 	var model QueryModel
 
@@ -122,58 +121,92 @@ func (datasource *Datasource) query(ctx context.Context, pCtx backend.PluginCont
 		"$__interval":        haystack.NewNumber(query.Interval.Minutes(), "min").ToZinc(),
 	}
 
-	var grid haystack.Grid
 	switch model.Type {
+	case "":
+		// If no type is specified, just return an empty response.
+		return responseFromGrids([]haystack.Grid{})
 	case "ops":
 		ops, err := datasource.ops()
 		if err != nil {
 			log.DefaultLogger.Error(err.Error())
 			return backend.ErrDataResponse(backend.StatusBadRequest, fmt.Sprintf("Ops failure: %v", err.Error()))
 		}
-		grid = ops
+		return responseFromGrids([]haystack.Grid{ops})
 	case "nav":
 		nav, err := datasource.nav(model.Nav)
 		if err != nil {
 			log.DefaultLogger.Error(err.Error())
 			return backend.ErrDataResponse(backend.StatusBadRequest, fmt.Sprintf("Nav failure: %v", err.Error()))
 		}
-		grid = nav
+		return responseFromGrids([]haystack.Grid{nav})
 	case "eval":
 		eval, err := datasource.eval(model.Eval, variables)
 		if err != nil {
 			log.DefaultLogger.Error(err.Error())
 			return backend.ErrDataResponse(backend.StatusBadRequest, fmt.Sprintf("Eval failure: %v", err.Error()))
 		}
-		grid = eval
+		return responseFromGrids([]haystack.Grid{eval})
 	case "hisRead":
-		hisRead, err := datasource.hisRead(model.HisRead, query.TimeRange)
+		hisRead, err := datasource.hisRead(haystack.NewRef(model.HisRead, ""), query.TimeRange)
 		if err != nil {
 			log.DefaultLogger.Error(err.Error())
 			return backend.ErrDataResponse(backend.StatusBadRequest, fmt.Sprintf("HisRead failure: %v", err.Error()))
 		}
-		grid = hisRead
+		return responseFromGrids([]haystack.Grid{hisRead})
+	case "hisReadFilter":
+		points, readErr := datasource.read(model.HisReadFilter, variables)
+		if readErr != nil {
+			log.DefaultLogger.Error(readErr.Error())
+			return backend.ErrDataResponse(backend.StatusBadRequest, fmt.Sprintf("HisReadFilter failure: %v", readErr.Error()))
+		}
+
+		grids := []haystack.Grid{}
+		for _, point := range points.Rows() {
+			id := point.Get("id")
+			var ref haystack.Ref
+			switch id.(type) {
+			case haystack.Ref:
+				ref = id.(haystack.Ref)
+			default:
+				errMsg := fmt.Sprintf("id is not a ref: %v", id)
+				log.DefaultLogger.Error(errMsg)
+				return backend.ErrDataResponse(backend.StatusBadRequest, errMsg)
+			}
+			hisRead, err := datasource.hisRead(ref, query.TimeRange)
+			if err != nil {
+				log.DefaultLogger.Error(err.Error())
+				return backend.ErrDataResponse(backend.StatusBadRequest, fmt.Sprintf("HisReadFilter failure: %v", err.Error()))
+			}
+			grids = append(grids, hisRead)
+		}
+		return responseFromGrids(grids)
 	case "read":
 		read, err := datasource.read(model.Read, variables)
 		if err != nil {
 			log.DefaultLogger.Error(err.Error())
 			return backend.ErrDataResponse(backend.StatusBadRequest, fmt.Sprintf("Read failure: %v", err.Error()))
 		}
-		grid = read
+		return responseFromGrids([]haystack.Grid{read})
 	default:
-		log.DefaultLogger.Warn("No valid input, returning empty Grid")
-		grid = haystack.EmptyGrid()
-	}
-
-	frame, frameErr := dataFrameFromGrid(grid)
-	if frameErr != nil {
-		log.DefaultLogger.Error(frameErr.Error())
-		return backend.ErrDataResponse(backend.StatusBadRequest, fmt.Sprintf("Frame conversion failure: %v", frameErr.Error()))
+		warnMsg := fmt.Sprintf("Invalid type %s, returning empty Grid", model.Type)
+		log.DefaultLogger.Warn(warnMsg)
+		return backend.ErrDataResponse(backend.StatusBadRequest, warnMsg)
 	}
+}
 
-	// add the frames to the response.
-	response.Frames = append(response.Frames, frame)
-	response.Status = backend.StatusOK
+func responseFromGrids(grids []haystack.Grid) backend.DataResponse {
+	var response backend.DataResponse
+	for _, grid := range grids {
+		frame, frameErr := dataFrameFromGrid(grid)
+		if frameErr != nil {
+			log.DefaultLogger.Error(frameErr.Error())
+			return backend.ErrDataResponse(backend.StatusBadRequest, fmt.Sprintf("Frame conversion failure: %v", frameErr.Error()))
+		}
 
+		// add the frames to the response.
+		response.Frames = append(response.Frames, frame)
+		response.Status = backend.StatusOK
+	}
 	return response
 }
 
@@ -220,14 +253,13 @@ func (datasource *Datasource) eval(expr string, variables map[string]string) (ha
 	)
 }
 
-func (datasource *Datasource) hisRead(id string, timeRange backend.TimeRange) (haystack.Grid, error) {
-	ref := haystack.NewRef(id, "")
+func (datasource *Datasource) hisRead(id haystack.Ref, timeRange backend.TimeRange) (haystack.Grid, error) {
 	start := haystack.NewDateTimeFromGo(timeRange.From.UTC())
 	end := haystack.NewDateTimeFromGo(timeRange.To.UTC())
 
 	return datasource.withRetry(
 		func() (haystack.Grid, error) {
-			return datasource.client.HisReadAbsDateTime(ref, start, end)
+			return datasource.client.HisReadAbsDateTime(id, start, end)
 		},
 	)
 }

src/README.md

@@ -24,7 +24,8 @@ Haystack query that should be performed. The supported queries are:
 
 - Eval: Evaluate a free-form Axon expression. _Note: Not all Haystack servers support this functionality_
 - HisRead: Display the history of a single point over the selected time range.
-- Read: Display the records matching a filter. Since this is not timeseries data, it can only be viewed in Grafana's
+- HisRead via filter: Read multiple points using a filter, and display their histories over the selected time range.
+- Read: Display the records matching a filter. Since this is not timeseries data, it is best viewed in Grafana's
   "Table" view.
 
 #### Variable Usage

src/components/HaystackQueryInput.tsx

@@ -38,6 +38,18 @@ export function HaystackQueryInput({ query, onChange }: HaystackQueryInputProps)
           />
         </InlineField>
       );
+    case "hisReadFilter":
+      return (
+        <InlineField>
+          <Input
+            width={width}
+            prefix={<Icon name="filter" />}
+            onChange={onQueryChange}
+            value={query.hisReadFilter}
+            placeholder={DEFAULT_QUERY.hisReadFilter}
+          />
+        </InlineField>
+      );
     case "read":
       return (
         <InlineField>

src/components/QueryEditor.tsx

@@ -13,10 +13,12 @@ export function QueryEditor({ datasource, query, onChange, onRunQuery }: Props)
     onChange({ ...query, type: newType });
   };
   const onQueryChange = (newQuery: string) => {
-    if (query.type === "hisRead") {
-      onChange({ ...query, hisRead: newQuery });
-    } else if (query.type === "eval") {
+    if (query.type === "eval") {
       onChange({ ...query, eval: newQuery });
+    } else if (query.type === "hisRead") {
+      onChange({ ...query, hisRead: newQuery });
+    } else if (query.type === "hisReadFilter") {
+      onChange({ ...query, hisReadFilter: newQuery });
     } else if (query.type === "read") {
       onChange({ ...query, read: newQuery });
     }

src/datasource.ts

@@ -22,9 +22,15 @@ import {
 import { firstValueFrom } from 'rxjs';
 
 export const queryTypes: QueryType[] = [
-  { label: 'Read', value: 'read', apiRequirements: ['read'], description: 'Read the records matched by a filter' },
-  { label: 'HisRead', value: 'hisRead', apiRequirements: ['hisRead'], description: 'Read the history of a point' },
   { label: 'Eval', value: 'eval', apiRequirements: ['eval'], description: 'Evaluate an Axon expression' },
+  { label: 'HisRead', value: 'hisRead', apiRequirements: ['hisRead'], description: 'Read the history of a point' },
+  {
+    label: 'HisRead via filter',
+    value: 'hisReadFilter',
+    apiRequirements: ['read', 'hisRead'],
+    description: 'Read the history of points found using a filter',
+  },
+  { label: 'Read', value: 'read', apiRequirements: ['read'], description: 'Read the records matched by a filter' },
 ];
 
 export class DataSource extends DataSourceWithBackend<HaystackQuery, HaystackDataSourceOptions> {

src/types.ts

@@ -4,6 +4,7 @@ export interface HaystackQuery extends DataQuery {
   type: string; // Defines the type of query that should be executed
   eval: string;
   hisRead: string;
+  hisReadFilter: string;
   read: string;
 }
 
@@ -12,6 +13,7 @@ export class OpsQuery implements HaystackQuery {
   type = 'ops';
   eval = '';
   hisRead = '';
+  hisReadFilter = '';
   read = '';
 
   refId: string;
@@ -34,7 +36,8 @@ export const DEFAULT_QUERY: Partial<HaystackQuery> = {
   type: 'eval',
   eval: '[{ts: $__timeRange_start, v0: 0}, {ts: $__timeRange_end, v0: 10}].toGrid',
   hisRead: 'abcdef-123456',
-  read: 'point and temp and air and outside',
+  hisReadFilter: 'point and his and temp and air and outside',
+  read: 'equip and ahu',
 };
 
 /**