apitech
/
grafana
mirror of https://github.com/grafana/grafana
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Plugins: Introduce HTTP 207 Multi Status response to api/ds/query (#48550)

Browse Source 
* feature toggles

* return HTTP 207 from ds/query

* add ft check

* add API test

* add 207 check for qr

* change to OR

* revert check

* add explicit toggle check for cloudwatch

* remove unused import

* remove from defaults.ini

* add status codes to md and update swagger

* new fangled http api tests pattern

* update swagger

* Update docs/sources/http_api/data_source.md

Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com>

* add missing word and reformat

Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com>
pull/48647/head
Will Browne 4 years ago committed by GitHub
parent 88eeb878a4
commit 4ecd57f49c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
11 changed files with 150 additions and 45 deletions
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Show Stats Download Patch File Download Diff File
  1. 10
      docs/sources/http_api/data_source.md
  2. 1
      packages/grafana-data/src/types/featureToggles.gen.ts
  3. 1
      pkg/api/docs/definitions/ds.go
  4. 13
      pkg/api/metrics.go
  5. 51
      pkg/api/metrics_test.go
  6. 12
      pkg/api/plugins_test.go
  7. 5
      pkg/services/featuremgmt/registry.go
  8. 4
      pkg/services/featuremgmt/toggles_gen.go
  9. 46
      public/api-merged.json
  10. 46
      public/api-spec.json
  11. 6
      public/app/plugins/datasource/cloudwatch/datasource.ts

10
docs/sources/http_api/data_source.md
Unescape View File

@ -691,6 +691,16 @@ In addition, specific properties of each data source should be added in a reques
}
```
#### Status codes
| Code | Description |
| ---- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 200 | All data source queries returned a successful response. |
| 400 | Bad request due to invalid JSON, missing content type, missing or invalid fields, etc. Or one or more data source queries were unsuccessful. Refer to the body for more details. |
| 403 | Access denied. |
| 404 | Either the data source or plugin required to fulfil the request could not be found. |
| 500 | Unexpected error. Refer to the body and/or server logs for more details. |
## Deprecated resources
The following resources have been deprecated. They will be removed in a future release.

1
packages/grafana-data/src/types/featureToggles.gen.ts
Unescape View File

@ -58,4 +58,5 @@ export interface FeatureToggles {
commandPalette?: boolean;
savedItems?: boolean;
cloudWatchDynamicLabels?: boolean;
datasourceQueryMultiStatus?: boolean;
}

1
pkg/api/docs/definitions/ds.go
Unescape View File

@ -14,6 +14,7 @@ import (
//
// Responses:
// 200: queryDataResponse
// 207: queryDataResponse
// 401: unauthorisedError
// 400: badRequestError
// 403: forbiddenError

13
pkg/api/metrics.go
Unescape View File

@ -31,7 +31,7 @@ func (hs *HTTPServer) QueryMetricsV2(c *models.ReqContext) response.Response {
if err != nil {
return hs.handleQueryMetricsError(err)
}
return toJsonStreamingResponse(resp)
return hs.toJsonStreamingResponse(resp)
}
func (hs *HTTPServer) handleQueryMetricsError(err error) *response.NormalResponse {
@ -147,7 +147,7 @@ func (hs *HTTPServer) QueryMetricsFromDashboard(c *models.ReqContext) response.R
if err != nil {
return hs.handleQueryMetricsError(err)
}
return toJsonStreamingResponse(resp)
return hs.toJsonStreamingResponse(resp)
}
// QueryMetrics returns query metrics
@ -198,11 +198,16 @@ func (hs *HTTPServer) QueryMetrics(c *models.ReqContext) response.Response {
return response.JSON(statusCode, &legacyResp)
}
func toJsonStreamingResponse(qdr *backend.QueryDataResponse) response.Response {
func (hs *HTTPServer) toJsonStreamingResponse(qdr *backend.QueryDataResponse) response.Response {
statusWhenError := http.StatusBadRequest
if hs.Features.IsEnabled(featuremgmt.FlagDatasourceQueryMultiStatus) {
statusWhenError = http.StatusMultiStatus
}
statusCode := http.StatusOK
for _, res := range qdr.Responses {
if res.Error != nil {
statusCode = http.StatusBadRequest
statusCode = statusWhenError
}
}

51
pkg/api/metrics_test.go
Unescape View File

@ -12,6 +12,7 @@ import (
acmock "github.com/grafana/grafana/pkg/services/accesscontrol/mock"
"github.com/grafana/grafana/pkg/services/featuremgmt"
"github.com/grafana/grafana/pkg/services/sqlstore/mockstore"
"github.com/grafana/grafana/pkg/web/webtest"
"golang.org/x/oauth2"
@ -19,12 +20,14 @@ import (
"github.com/grafana/grafana/pkg/components/simplejson"
"github.com/grafana/grafana/pkg/models"
"github.com/grafana/grafana/pkg/plugins"
fakeDatasources "github.com/grafana/grafana/pkg/services/datasources/fakes"
datasources "github.com/grafana/grafana/pkg/services/datasources/service"
"github.com/grafana/grafana/pkg/services/query"
"github.com/grafana/grafana/pkg/services/secrets/fakes"
"github.com/grafana/grafana/pkg/services/secrets/kvstore"
secretsManager "github.com/grafana/grafana/pkg/services/secrets/manager"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
var (
@ -500,3 +503,51 @@ func TestAPIEndpoint_Metrics_ParseDashboardQueryParams(t *testing.T) {
})
}
}
// `/ds/query` endpoint test
func TestAPIEndpoint_Metrics_QueryMetricsV2(t *testing.T) {
qds := query.ProvideService(
nil,
nil,
nil,
&fakePluginRequestValidator{},
&fakeDatasources.FakeDataSourceService{},
&fakePluginClient{
QueryDataHandlerFunc: func(ctx context.Context, req *backend.QueryDataRequest) (*backend.QueryDataResponse, error) {
resp := backend.Responses{
"A": backend.DataResponse{
Error: fmt.Errorf("query failed"),
},
}
return &backend.QueryDataResponse{Responses: resp}, nil
},
},
&fakeOAuthTokenService{},
)
serverFeatureEnabled := SetupAPITestServer(t, func(hs *HTTPServer) {
hs.queryDataService = qds
hs.Features = featuremgmt.WithFeatures(featuremgmt.FlagDatasourceQueryMultiStatus, true)
})
serverFeatureDisabled := SetupAPITestServer(t, func(hs *HTTPServer) {
hs.queryDataService = qds
hs.Features = featuremgmt.WithFeatures(featuremgmt.FlagDatasourceQueryMultiStatus, false)
})
t.Run("Status code is 400 when data source response has an error and feature toggle is disabled", func(t *testing.T) {
req := serverFeatureDisabled.NewPostRequest("/api/ds/query", strings.NewReader(queryDatasourceInput))
webtest.RequestWithSignedInUser(req, &models.SignedInUser{UserId: 1, OrgId: 1, OrgRole: models.ROLE_VIEWER})
resp, err := serverFeatureDisabled.SendJSON(req)
require.NoError(t, err)
require.NoError(t, resp.Body.Close())
require.Equal(t, http.StatusBadRequest, resp.StatusCode)
})
t.Run("Status code is 207 when data source response has an error and feature toggle is enabled", func(t *testing.T) {
req := serverFeatureEnabled.NewPostRequest("/api/ds/query", strings.NewReader(queryDatasourceInput))
webtest.RequestWithSignedInUser(req, &models.SignedInUser{UserId: 1, OrgId: 1, OrgRole: models.ROLE_VIEWER})
resp, err := serverFeatureEnabled.SendJSON(req)
require.NoError(t, err)
require.NoError(t, resp.Body.Close())
require.Equal(t, http.StatusMultiStatus, resp.StatusCode)
})
}

12
pkg/api/plugins_test.go
Unescape View File

@ -249,9 +249,11 @@ type fakePluginClient struct {
plugins.Client
req *backend.CallResourceRequest
backend.QueryDataHandlerFunc
}
func (c *fakePluginClient) CallResource(ctx context.Context, req *backend.CallResourceRequest, sender backend.CallResourceResponseSender) error {
func (c *fakePluginClient) CallResource(_ context.Context, req *backend.CallResourceRequest, sender backend.CallResourceResponseSender) error {
c.req = req
bytes, err := json.Marshal(map[string]interface{}{
"message": "hello",
@ -266,3 +268,11 @@ func (c *fakePluginClient) CallResource(ctx context.Context, req *backend.CallRe
Body: bytes,
})
}
func (c *fakePluginClient) QueryData(ctx context.Context, req *backend.QueryDataRequest) (*backend.QueryDataResponse, error) {
if c.QueryDataHandlerFunc != nil {
return c.QueryDataHandlerFunc.QueryData(ctx, req)
}
return backend.NewQueryDataResponse(), nil
}

5
pkg/services/featuremgmt/registry.go
Unescape View File

@ -236,5 +236,10 @@ var (
Description: "Use dynamic labels instead of alias patterns in CloudWatch datasource",
State: FeatureStateStable,
},
{
Name: "datasourceQueryMultiStatus",
Description: "Introduce HTTP 207 Multi Status for api/ds/query",
State: FeatureStateAlpha,
},
}
)

4
pkg/services/featuremgmt/toggles_gen.go
Unescape View File

@ -174,4 +174,8 @@ const (
// FlagCloudWatchDynamicLabels
// Use dynamic labels instead of alias patterns in CloudWatch datasource
FlagCloudWatchDynamicLabels = "cloudWatchDynamicLabels"
// FlagDatasourceQueryMultiStatus
// Introduce HTTP 207 Multi Status for api/ds/query
FlagDatasourceQueryMultiStatus = "datasourceQueryMultiStatus"
)

46
public/api-merged.json
Unescape View File

@ -4692,15 +4692,15 @@
"parameters": [
{
"type": "string",
"x-go-name": "DatasourceID",
"name": "datasource_id",
"x-go-name": "PermissionID",
"name": "permissionId",
"in": "path",
"required": true
},
{
"type": "string",
"x-go-name": "PermissionID",
"name": "permissionId",
"x-go-name": "DatasourceID",
"name": "datasource_id",
"in": "path",
"required": true
}
@ -4745,6 +4745,9 @@
"200": {
"$ref": "#/responses/queryDataResponse"
},
"207": {
"$ref": "#/responses/queryDataResponse"
},
"400": {
"$ref": "#/responses/badRequestError"
},
@ -8258,14 +8261,6 @@
"summary": "Add External Group.",
"operationId": "addTeamGroupApi",
"parameters": [
{
"type": "integer",
"format": "int64",
"x-go-name": "TeamID",
"name": "teamId",
"in": "path",
"required": true
},
{
"x-go-name": "Body",
"name": "body",
@ -8274,6 +8269,14 @@
"schema": {
"$ref": "#/definitions/TeamGroupMapping"
}
},
{
"type": "integer",
"format": "int64",
"x-go-name": "TeamID",
"name": "teamId",
"in": "path",
"required": true
}
],
"responses": {
@ -8307,16 +8310,16 @@
{
"type": "integer",
"format": "int64",
"x-go-name": "TeamID",
"name": "teamId",
"x-go-name": "GroupID",
"name": "groupId",
"in": "path",
"required": true
},
{
"type": "integer",
"format": "int64",
"x-go-name": "GroupID",
"name": "groupId",
"x-go-name": "TeamID",
"name": "teamId",
"in": "path",
"required": true
}
@ -10534,6 +10537,9 @@
"ApiKeyDTO": {
"type": "object",
"properties": {
"accessControl": {
"$ref": "#/definitions/Metadata"
},
"expiration": {
"type": "string",
"format": "date-time",
@ -10555,7 +10561,7 @@
"x-go-name": "Role"
}
},
"x-go-package": "github.com/grafana/grafana/pkg/models"
"x-go-package": "github.com/grafana/grafana/pkg/api/dtos"
},
"ApiRuleNode": {
"type": "object",
@ -13632,7 +13638,7 @@
"properties": {
"id": {
"type": "string",
"x-go-name": "Id"
"x-go-name": "ID"
},
"target": {
"type": "string",
@ -13647,7 +13653,7 @@
"x-go-name": "Url"
}
},
"x-go-package": "github.com/grafana/grafana/pkg/models"
"x-go-package": "github.com/grafana/grafana/pkg/services/preference"
},
"NavbarPreference": {
"type": "object",
@ -14739,7 +14745,7 @@
"x-go-name": "HomeTab"
}
},
"x-go-package": "github.com/grafana/grafana/pkg/models"
"x-go-package": "github.com/grafana/grafana/pkg/services/preference"
},
"Receiver": {
"type": "object",

46
public/api-spec.json
Unescape View File

@ -3754,15 +3754,15 @@
"parameters": [
{
"type": "string",
"x-go-name": "DatasourceID",
"name": "datasource_id",
"x-go-name": "PermissionID",
"name": "permissionId",
"in": "path",
"required": true
},
{
"type": "string",
"x-go-name": "PermissionID",
"name": "permissionId",
"x-go-name": "DatasourceID",
"name": "datasource_id",
"in": "path",
"required": true
}
@ -3807,6 +3807,9 @@
"200": {
"$ref": "#/responses/queryDataResponse"
},
"207": {
"$ref": "#/responses/queryDataResponse"
},
"400": {
"$ref": "#/responses/badRequestError"
},
@ -6667,14 +6670,6 @@
"summary": "Add External Group.",
"operationId": "addTeamGroupApi",
"parameters": [
{
"type": "integer",
"format": "int64",
"x-go-name": "TeamID",
"name": "teamId",
"in": "path",
"required": true
},
{
"x-go-name": "Body",
"name": "body",
@ -6683,6 +6678,14 @@
"schema": {
"$ref": "#/definitions/TeamGroupMapping"
}
},
{
"type": "integer",
"format": "int64",
"x-go-name": "TeamID",
"name": "teamId",
"in": "path",
"required": true
}
],
"responses": {
@ -6716,16 +6719,16 @@
{
"type": "integer",
"format": "int64",
"x-go-name": "TeamID",
"name": "teamId",
"x-go-name": "GroupID",
"name": "groupId",
"in": "path",
"required": true
},
{
"type": "integer",
"format": "int64",
"x-go-name": "GroupID",
"name": "groupId",
"x-go-name": "TeamID",
"name": "teamId",
"in": "path",
"required": true
}
@ -8626,6 +8629,9 @@
"ApiKeyDTO": {
"type": "object",
"properties": {
"accessControl": {
"$ref": "#/definitions/Metadata"
},
"expiration": {
"type": "string",
"format": "date-time",
@ -8647,7 +8653,7 @@
"x-go-name": "Role"
}
},
"x-go-package": "github.com/grafana/grafana/pkg/models"
"x-go-package": "github.com/grafana/grafana/pkg/api/dtos"
},
"BrandingOptionsDTO": {
"type": "object",
@ -10715,7 +10721,7 @@
"properties": {
"id": {
"type": "string",
"x-go-name": "Id"
"x-go-name": "ID"
},
"target": {
"type": "string",
@ -10730,7 +10736,7 @@
"x-go-name": "Url"
}
},
"x-go-package": "github.com/grafana/grafana/pkg/models"
"x-go-package": "github.com/grafana/grafana/pkg/services/preference"
},
"NavbarPreference": {
"type": "object",
@ -11191,7 +11197,7 @@
"x-go-name": "HomeTab"
}
},
"x-go-package": "github.com/grafana/grafana/pkg/models"
"x-go-package": "github.com/grafana/grafana/pkg/services/preference"
},
"RecordingRuleJSON": {
"description": "RecordingRuleJSON is the external representation of a recording rule",

6
public/app/plugins/datasource/cloudwatch/datasource.ts
Unescape View File

@ -29,6 +29,8 @@ import { VariableWithMultiSupport } from 'app/features/variables/types';
import { store } from 'app/store/store';
import { AppNotificationTimeout } from 'app/types';
import config from '../../../core/config';
import { CloudWatchAnnotationSupport } from './annotationSupport';
import { SQLCompletionItemProvider } from './cloudwatch-sql/completion/CompletionItemProvider';
import { ThrottlingErrorMessage } from './components/ThrottlingErrorMessage';
@ -669,6 +671,10 @@ export class CloudWatchDatasource
return this.awsRequest(DS_QUERY_ENDPOINT, requestParams, headers).pipe(
map((response) => resultsToDataFrames({ data: response })),
catchError((err: FetchError) => {
if (config.featureToggles.datasourceQueryMultiStatus && err.status === 207) {
throw err;
}
if (err.status === 400) {
throw err;
}

Write Preview
Loading…
Cancel
Save