Cloudwatch: Refactor dimension keys resource request (#57148)

* use new layered architecture in get dimension keys request * go lint fixes * pr feedback * more pr feedback * remove not used code * refactor route middleware * change signature * add integration tests for the dimension keys route * use request suffix instead of query * use typed args also in frontend * remove unused import * harmonize naming * fix merge conflict
2022-10-20 12:53:28 +02:00
parent 7f3536a6d2
commit b0c2ca6c1b
37 changed files with 1015 additions and 486 deletions
@@ -0,0 +1,88 @@
+package models
+
+import (
+	"encoding/json"
+	"fmt"
+	"net/url"
+
+	"github.com/grafana/grafana/pkg/tsdb/cloudwatch/constants"
+)
+
+type DimensionKeysRequestType uint32
+
+const (
+	StandardDimensionKeysRequest DimensionKeysRequestType = iota
+	FilterDimensionKeysRequest
+	CustomMetricDimensionKeysRequest
+)
+
+type Dimension struct {
+	Name  string
+	Value string
+}
+
+type DimensionKeysRequest struct {
+	Region          string `json:"region"`
+	Namespace       string `json:"namespace"`
+	MetricName      string `json:"metricName"`
+	DimensionFilter []*Dimension
+}
+
+func (q *DimensionKeysRequest) Type() DimensionKeysRequestType {
+	if _, exist := constants.NamespaceMetricsMap[q.Namespace]; !exist {
+		return CustomMetricDimensionKeysRequest
+	}
+
+	if len(q.DimensionFilter) > 0 {
+		return FilterDimensionKeysRequest
+	}
+
+	return StandardDimensionKeysRequest
+}
+
+func GetDimensionKeysRequest(parameters url.Values) (*DimensionKeysRequest, error) {
+	req := &DimensionKeysRequest{
+		Region:          parameters.Get("region"),
+		Namespace:       parameters.Get("namespace"),
+		MetricName:      parameters.Get("metricName"),
+		DimensionFilter: []*Dimension{},
+	}
+
+	if req.Region == "" {
+		return nil, fmt.Errorf("region is required")
+	}
+
+	dimensionFilters := map[string]interface{}{}
+	dimensionFilterJson := []byte(parameters.Get("dimensionFilters"))
+	if len(dimensionFilterJson) > 0 {
+		err := json.Unmarshal(dimensionFilterJson, &dimensionFilters)
+		if err != nil {
+			return nil, fmt.Errorf("error unmarshaling dimensionFilters: %v", err)
+		}
+	}
+	addDimension := func(key string, value string) {
+		d := &Dimension{
+			Name: key,
+		}
+		// if value is not specified or a wildcard is used, simply don't use the value field
+		if value != "" && value != "*" {
+			d.Value = value
+		}
+		req.DimensionFilter = append(req.DimensionFilter, d)
+	}
+
+	for k, v := range dimensionFilters {
+		// due to legacy, value can be a string, a string slice or nil
+		if vv, ok := v.(string); ok {
+			addDimension(k, vv)
+		} else if vv, ok := v.([]interface{}); ok {
+			for _, v := range vv {
+				addDimension(k, v.(string))
+			}
+		} else if v == nil {
+			addDimension(k, "")
+		}
+	}
+
+	return req, nil
+}
@@ -0,0 +1,72 @@
+package models
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+)
+
+func TestDimensionKeyQuery(t *testing.T) {
+	t.Run("Should parse parameters without dimension filter", func(t *testing.T) {
+		req, err := GetDimensionKeysRequest(map[string][]string{
+			"region":     {"us-east-1"},
+			"namespace":  {"AWS/EC2"},
+			"metricName": {"CPUUtilization"}},
+		)
+		require.NoError(t, err)
+		assert.Equal(t, "us-east-1", req.Region)
+		assert.Equal(t, "AWS/EC2", req.Namespace)
+		assert.Equal(t, "CPUUtilization", req.MetricName)
+	})
+
+	t.Run("Should parse parameters with single valued dimension filter", func(t *testing.T) {
+		req, err := GetDimensionKeysRequest(map[string][]string{
+			"region":           {"us-east-1"},
+			"namespace":        {"AWS/EC2"},
+			"metricName":       {"CPUUtilization"},
+			"dimensionFilters": {"{\"InstanceId\": \"i-1234567890abcdef0\"}"},
+		})
+		require.NoError(t, err)
+		assert.Equal(t, "us-east-1", req.Region)
+		assert.Equal(t, "AWS/EC2", req.Namespace)
+		assert.Equal(t, "CPUUtilization", req.MetricName)
+		assert.Equal(t, 1, len(req.DimensionFilter))
+		assert.Equal(t, "InstanceId", req.DimensionFilter[0].Name)
+		assert.Equal(t, "i-1234567890abcdef0", req.DimensionFilter[0].Value)
+	})
+
+	t.Run("Should parse parameters with multi-valued dimension filter", func(t *testing.T) {
+		req, err := GetDimensionKeysRequest(map[string][]string{
+			"region":           {"us-east-1"},
+			"namespace":        {"AWS/EC2"},
+			"metricName":       {"CPUUtilization"},
+			"dimensionFilters": {"{\"InstanceId\": [\"i-1234567890abcdef0\", \"i-1234567890abcdef1\"]}"},
+		})
+		require.NoError(t, err)
+		assert.Equal(t, "us-east-1", req.Region)
+		assert.Equal(t, "AWS/EC2", req.Namespace)
+		assert.Equal(t, "CPUUtilization", req.MetricName)
+		assert.Equal(t, 2, len(req.DimensionFilter))
+		assert.Equal(t, "InstanceId", req.DimensionFilter[0].Name)
+		assert.Equal(t, "i-1234567890abcdef0", req.DimensionFilter[0].Value)
+		assert.Equal(t, "InstanceId", req.DimensionFilter[1].Name)
+		assert.Equal(t, "i-1234567890abcdef1", req.DimensionFilter[1].Value)
+	})
+
+	t.Run("Should parse parameters with wildcard dimension filter", func(t *testing.T) {
+		req, err := GetDimensionKeysRequest(map[string][]string{
+			"region":           {"us-east-1"},
+			"namespace":        {"AWS/EC2"},
+			"metricName":       {"CPUUtilization"},
+			"dimensionFilters": {"{\"InstanceId\": [\"*\"]}"},
+		})
+		require.NoError(t, err)
+		assert.Equal(t, "us-east-1", req.Region)
+		assert.Equal(t, "AWS/EC2", req.Namespace)
+		assert.Equal(t, "CPUUtilization", req.MetricName)
+		assert.Equal(t, 1, len(req.DimensionFilter))
+		assert.Equal(t, "InstanceId", req.DimensionFilter[0].Name)
+		assert.Equal(t, "", req.DimensionFilter[0].Value)
+	})
+}
@@ -0,0 +1,22 @@
+package models
+
+import "fmt"
+
+type HttpError struct {
+	Message    string
+	Error      string
+	StatusCode int
+}
+
+func NewHttpError(message string, statusCode int, err error) *HttpError {
+	httpError := &HttpError{
+		Message:    message,
+		StatusCode: statusCode,
+	}
+	if err != nil {
+		httpError.Error = err.Error()
+		httpError.Message = fmt.Sprintf("%s: %s", message, err)
+	}
+
+	return httpError
+}
@@ -0,0 +1,19 @@
+package models
+
+import (
+	"github.com/aws/aws-sdk-go/service/cloudwatch"
+)
+
+type ListMetricsProvider interface {
+	GetDimensionKeysByDimensionFilter(*DimensionKeysRequest) ([]string, error)
+	GetHardCodedDimensionKeysByNamespace(string) ([]string, error)
+	GetDimensionKeysByNamespace(string) ([]string, error)
+}
+
+type MetricsClientProvider interface {
+	ListMetricsWithPageLimit(params *cloudwatch.ListMetricsInput) ([]*cloudwatch.Metric, error)
+}
+
+type CloudWatchMetricsAPIProvider interface {
+	ListMetricsPages(*cloudwatch.ListMetricsInput, func(*cloudwatch.ListMetricsOutput, bool) bool) error
+}
@@ -1,5 +1,19 @@
 package models

+import (
+	"net/url"
+
+	"github.com/grafana/grafana-plugin-sdk-go/backend"
+)
+
+type Clients struct {
+	MetricsClientProvider MetricsClientProvider
+}
+
+type ClientsFactoryFunc func(pluginCtx backend.PluginContext, region string) (clients Clients, err error)
+
+type RouteHandlerFunc func(pluginCtx backend.PluginContext, clientFactory ClientsFactoryFunc, parameters url.Values) ([]byte, *HttpError)
+
 type cloudWatchLink struct {
 	View    string        `json:"view"`
 	Stacked bool          `json:"stacked"`