setting max page limit for pagination via grafana config (#1075)

Co-authored-by: ivanahuckova <[email protected]>

Author: yesoreyeram

.changeset/soft-lobsters-enjoy.md

@@ -0,0 +1,5 @@
+---
+'grafana-infinity-datasource': minor
+---
+
+Setting backend pagination max page size via grafana config (ini file)

conf/grafana.ini

@@ -0,0 +1,2 @@
+[plugin.yesoreyeram-infinity-datasource]
+pagination_max_pages=8

docker-compose.yaml

@@ -11,10 +11,12 @@ services:
     volumes:
       - ./provisioning/dashboards-actual/:/dashboards/
       - ./provisioning:/etc/grafana/provisioning
+      - ./conf:/grafana-config
       - ./dist:/var/lib/grafana/plugins/yesoreyeram-infinity-datasource
     environment:
       - TERM=linux
       - GF_DEFAULT_APP_MODE=development
+      - GF_PATHS_CONFIG=/grafana-config/grafana.ini 
       - GF_AUTH_ANONYMOUS_ENABLED=true
       - GF_AUTH_ANONYMOUS_ORG_ROLE=Admin
       - GF_SECURITY_ANGULAR_SUPPORT_ENABLED=false

pkg/models/grafana_config.go

@@ -0,0 +1,19 @@
+package models
+
+import (
+	"context"
+	"fmt"
+	"os"
+	"strings"
+
+	"github.com/grafana/grafana-plugin-sdk-go/backend"
+)
+
+// GetGrafanaConfig allow you to retrieve config set via grafana.ini file
+func GetGrafanaConfig(ctx context.Context, pCtx *backend.PluginContext, key string) (output string) {
+	key = strings.TrimSpace(strings.ToUpper(key))
+	if v := strings.TrimSpace(os.Getenv(fmt.Sprintf("GF_PLUGIN_%s", key))); v != "" {
+		output = v
+	}
+	return output
+}

pkg/models/query.go

@@ -6,6 +6,7 @@ import (
 	"errors"
 	"fmt"
 	"net/http"
+	"strconv"
 	"strings"
 
 	"github.com/grafana/grafana-plugin-sdk-go/backend"
@@ -188,7 +189,7 @@ type InfinityDataOverride struct {
 	Override string   `json:"override"`
 }
 
-func ApplyDefaultsToQuery(ctx context.Context, query Query, settings InfinitySettings) Query {
+func ApplyDefaultsToQuery(ctx context.Context, pCtx *backend.PluginContext, query Query, settings InfinitySettings) Query {
 	if query.Type == "" {
 		query.Type = QueryTypeJSON
 		if query.Source == "" {
@@ -254,12 +255,7 @@ func ApplyDefaultsToQuery(ctx context.Context, query Query, settings InfinitySet
 	}
 	if query.Parser == InfinityParserBackend && query.Source == "url" && !(query.PageMode == "" || query.PageMode == PaginationModeNone) {
 		if query.PageMode != PaginationModeNone {
-			if query.PageMaxPages <= 0 {
-				query.PageMaxPages = 1
-			}
-			if query.PageMaxPages >= 5 {
-				query.PageMaxPages = 5
-			}
+			query.PageMaxPages = GetPaginationMaxPagesValue(ctx, pCtx, query)
 			if query.PageParamSizeFieldName == "" {
 				query.PageParamSizeFieldName = "limit"
 			}
@@ -315,10 +311,28 @@ func LoadQuery(ctx context.Context, backendQuery backend.DataQuery, pluginContex
 	if err != nil {
 		return query, backend.DownstreamError(fmt.Errorf("error while parsing the query json. %w", err))
 	}
-	query = ApplyDefaultsToQuery(ctx, query, settings)
+	query = ApplyDefaultsToQuery(ctx, &pluginContext, query, settings)
 	if query.PageMode == PaginationModeList && strings.TrimSpace(query.PageParamListFieldName) == "" {
 		// Downstream error as user input is not correct
 		return query, backend.DownstreamError(errors.New("pagination_param_list_field_name cannot be empty"))
 	}
 	return ApplyMacros(ctx, query, backendQuery.TimeRange, pluginContext)
 }
+
+func GetPaginationMaxPagesValue(ctx context.Context, pCtx *backend.PluginContext, query Query) int {
+	maxPages := 5
+	if query.PageMaxPages <= 0 {
+		maxPages = 1
+	}
+	if query.PageMaxPages >= 5 {
+		maxPages = 5
+	}
+	maxPageFromEnv := GetGrafanaConfig(ctx, pCtx, "pagination_max_pages")
+	if maxPageFromEnvValue, err := strconv.Atoi(maxPageFromEnv); err == nil && maxPageFromEnvValue > 0 {
+		maxPages = maxPageFromEnvValue
+	}
+	if query.PageMaxPages <= maxPages && query.PageMaxPages > 0 {
+		return query.PageMaxPages
+	}
+	return maxPages
+}

pkg/models/query_test.go

@@ -134,3 +134,49 @@ func TestLoadQuery(t *testing.T) {
 		})
 	}
 }
+
+func TestGetPaginationMaxPagesValue(t *testing.T) {
+	tests := []struct {
+		name    string
+		pCtx    *backend.PluginContext
+		envVars map[string]string
+		query   models.Query
+		want    int
+	}{
+		{
+			name: "should return 1 if no defaults set",
+			want: 1,
+		},
+		{
+			name:  "should return 1 if negative values set in query",
+			query: models.Query{PageMaxPages: -5},
+			want:  1,
+		},
+		{
+			name:  "should return 5 if higher values set",
+			query: models.Query{PageMaxPages: 100},
+			want:  5,
+		},
+		{
+			name:    "should respect GF_PLUGIN_pagination_max_pages key",
+			query:   models.Query{PageMaxPages: 100},
+			envVars: map[string]string{"GF_PLUGIN_PAGINATION_MAX_PAGES": "10"},
+			want:    10,
+		},
+		{
+			name:    "should respect query page max if the value is lesser than environment variable",
+			query:   models.Query{PageMaxPages: 6},
+			envVars: map[string]string{"GF_PLUGIN_PAGINATION_MAX_PAGES": "8"},
+			want:    6,
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			for k, v := range tt.envVars {
+				t.Setenv(k, v)
+			}
+			got := models.GetPaginationMaxPagesValue(context.TODO(), tt.pCtx, tt.query)
+			require.Equal(t, tt.want, got)
+		})
+	}
+}

src/editors/query/query.pagination.tsx

@@ -1,6 +1,6 @@
 import React from 'react';
-import { InlineLabel, Input, Select, Stack } from '@grafana/ui';
-import { SelectableValue } from '@grafana/data';
+import { FeatureBadge, InlineLabel, Input, Select, Stack } from '@grafana/ui';
+import { FeatureState, SelectableValue } from '@grafana/data';
 import { EditorField } from './../../components/extended/EditorField';
 import { EditorRow } from './../../components/extended/EditorRow';
 import type { InfinityQuery, PaginationParamType, PaginationType } from './../../types';
@@ -30,22 +30,21 @@ type PaginationEditorProps = {
 export const PaginationEditor = (props: PaginationEditorProps) => {
   const { query, onChange } = props;
   return (
-    <EditorRow label={'Pagination'} collapsible={true} collapsed={false} title={() => 'beta'}>
+    <EditorRow label={'Pagination'} collapsible={true} collapsed={false} title={() => <FeatureBadge featureState={FeatureState.beta} />}>
       <Stack direction="row" wrap={'wrap'}>
         <Stack wrap={'nowrap'} direction="column">
           <EditorField label="Pagination Type">
             <Select<PaginationType> width={30} value={query.pagination_mode || 'none'} options={paginationTypes} onChange={(e) => onChange({ ...query, pagination_mode: e.value || 'none' })} />
           </EditorField>
           {query.pagination_mode && query.pagination_mode !== 'none' && (
-            <EditorField label="Max pages" tooltip={'maximum of 5 pages. minimum of 1 page. Default 1'}>
+            <EditorField label="Max pages" tooltip={'Enter a value between 1 and a maximum of 5 pages, or the maximum page limit set in the Grafana configuration for the Infinity plugin.'}>
               <Input
                 type={'number'}
                 min={1}
-                max={5}
                 width={30}
                 value={query.pagination_max_pages}
                 onChange={(e) => onChange({ ...query, pagination_max_pages: e.currentTarget.valueAsNumber || 1 })}
-                placeholder="min:1, max:5"
+                placeholder="1"
               />
             </EditorField>
           )}