-
Notifications
You must be signed in to change notification settings - Fork 211
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1452 from SamMayWork/query-api
feat: Add an API to allow for querying events under a subscription with additional filtering
- Loading branch information
Showing
31 changed files
with
1,988 additions
and
401 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
74 changes: 74 additions & 0 deletions
74
internal/apiserver/route_get_subscription_events_filtered.go
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,74 @@ | ||
| // Copyright © 2024 Kaleido, Inc. | ||
| // | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| package apiserver | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "net/http" | ||
| "strconv" | ||
|
|
||
| "github.com/hyperledger/firefly-common/pkg/ffapi" | ||
| "github.com/hyperledger/firefly-common/pkg/i18n" | ||
| "github.com/hyperledger/firefly/internal/coremsgs" | ||
| "github.com/hyperledger/firefly/pkg/core" | ||
| "github.com/hyperledger/firefly/pkg/database" | ||
| ) | ||
|
|
||
| var getSubscriptionEventsFiltered = &ffapi.Route{ | ||
| Name: "getSubscriptionEventsFiltered", | ||
| Path: "subscriptions/{subid}/events", | ||
| Method: http.MethodGet, | ||
| PathParams: []*ffapi.PathParam{ | ||
| {Name: "subid", Description: coremsgs.APIParamsSubscriptionID}, | ||
| }, | ||
| QueryParams: []*ffapi.QueryParam{ | ||
| {Name: "startsequence", IsBool: false, Description: coremsgs.APISubscriptionStartSequenceID}, | ||
| {Name: "endsequence", IsBool: false, Description: coremsgs.APISubscriptionEndSequenceID}, | ||
| }, | ||
| FilterFactory: database.EventQueryFactory, | ||
| Description: coremsgs.APIEndpointsGetSubscriptionEventsFiltered, | ||
| JSONInputValue: nil, | ||
| JSONOutputValue: func() interface{} { return []*core.Event{} }, | ||
| JSONOutputCodes: []int{http.StatusOK}, | ||
| Extensions: &coreExtensions{ | ||
| CoreJSONHandler: func(r *ffapi.APIRequest, cr *coreRequest) (output interface{}, err error) { | ||
| subscription, _ := cr.or.GetSubscriptionByID(cr.ctx, r.PP["subid"]) | ||
| var startSeq int | ||
| var endSeq int | ||
|
|
||
| if r.QP["startsequence"] != "" { | ||
| startSeq, err = strconv.Atoi(r.QP["startsequence"]) | ||
| if err != nil { | ||
| return nil, i18n.NewError(cr.ctx, coremsgs.MsgSequenceIDDidNotParseToInt, fmt.Sprintf("startsequence: %s", r.QP["startsequence"])) | ||
| } | ||
| } else { | ||
| startSeq = -1 | ||
| } | ||
|
|
||
| if r.QP["endsequence"] != "" { | ||
| endSeq, err = strconv.Atoi(r.QP["endsequence"]) | ||
| if err != nil { | ||
| return nil, i18n.NewError(cr.ctx, coremsgs.MsgSequenceIDDidNotParseToInt, fmt.Sprintf("endsequence: %s", r.QP["endsequence"])) | ||
| } | ||
| } else { | ||
| endSeq = -1 | ||
| } | ||
|
|
||
| return r.FilterResult(cr.or.GetSubscriptionEventsHistorical(cr.ctx, subscription, r.Filter, startSeq, endSeq)) | ||
| }, | ||
| }, | ||
| } |
85 changes: 85 additions & 0 deletions
85
internal/apiserver/route_get_subscription_events_filtered_test.go
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,85 @@ | ||
| // Copyright © 2024 Kaleido, Inc. | ||
| // | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| package apiserver | ||
|
|
||
| import ( | ||
| "net/http/httptest" | ||
| "testing" | ||
|
|
||
| "github.com/hyperledger/firefly/pkg/core" | ||
| "github.com/stretchr/testify/assert" | ||
| "github.com/stretchr/testify/mock" | ||
| ) | ||
|
|
||
| func TestGetSubscriptionEventsFiltered(t *testing.T) { | ||
| o, r := newTestAPIServer() | ||
| o.On("Authorize", mock.Anything, mock.Anything).Return(nil) | ||
| req := httptest.NewRequest("GET", "/api/v1/namespaces/mynamespace/subscriptions/abcd12345/events?startsequence=100&endsequence=200", nil) | ||
| req.Header.Set("Content-Type", "application/json; charset=utf-8") | ||
| res := httptest.NewRecorder() | ||
|
|
||
| o.On("GetSubscriptionByID", mock.Anything, "abcd12345"). | ||
| Return(&core.Subscription{}, nil) | ||
| o.On("GetSubscriptionEventsHistorical", mock.Anything, mock.Anything, mock.Anything, mock.Anything, mock.Anything). | ||
| Return([]*core.EnrichedEvent{}, nil, nil) | ||
|
|
||
| r.ServeHTTP(res, req) | ||
| assert.Equal(t, 200, res.Result().StatusCode) | ||
| } | ||
|
|
||
| func TestGetSubscriptionEventsFilteredStartSequenceIDDoesNotParse(t *testing.T) { | ||
| o, r := newTestAPIServer() | ||
| o.On("Authorize", mock.Anything, mock.Anything).Return(nil) | ||
| req := httptest.NewRequest("GET", "/api/v1/namespaces/mynamespace/subscriptions/abcd12345/events?startsequence=helloworld", nil) | ||
| req.Header.Set("Content-Type", "application/json; charset=utf-8") | ||
| res := httptest.NewRecorder() | ||
| o.On("GetSubscriptionByID", mock.Anything, "abcd12345"). | ||
| Return(&core.Subscription{}, nil) | ||
|
|
||
| r.ServeHTTP(res, req) | ||
| assert.Equal(t, 400, res.Result().StatusCode) | ||
| assert.Contains(t, res.Body.String(), "helloworld") | ||
| } | ||
|
|
||
| func TestGetSubscriptionEventsFilteredEndSequenceIDDoesNotParse(t *testing.T) { | ||
| o, r := newTestAPIServer() | ||
| o.On("Authorize", mock.Anything, mock.Anything).Return(nil) | ||
| req := httptest.NewRequest("GET", "/api/v1/namespaces/mynamespace/subscriptions/abcd12345/events?endsequence=helloworld", nil) | ||
| req.Header.Set("Content-Type", "application/json; charset=utf-8") | ||
| res := httptest.NewRecorder() | ||
| o.On("GetSubscriptionByID", mock.Anything, "abcd12345"). | ||
| Return(&core.Subscription{}, nil) | ||
|
|
||
| r.ServeHTTP(res, req) | ||
| assert.Equal(t, 400, res.Result().StatusCode) | ||
| assert.Contains(t, res.Body.String(), "helloworld") | ||
| } | ||
|
|
||
| func TestGetSubscriptionEventsFilteredNoSequenceIDsProvided(t *testing.T) { | ||
| o, r := newTestAPIServer() | ||
| o.On("Authorize", mock.Anything, mock.Anything).Return(nil) | ||
| req := httptest.NewRequest("GET", "/api/v1/namespaces/mynamespace/subscriptions/abcd12345/events", nil) | ||
| req.Header.Set("Content-Type", "application/json; charset=utf-8") | ||
| res := httptest.NewRecorder() | ||
| o.On("GetSubscriptionByID", mock.Anything, "abcd12345"). | ||
| Return(&core.Subscription{}, nil) | ||
| o.On("GetSubscriptionEventsHistorical", mock.Anything, mock.Anything, mock.Anything, -1, -1). | ||
| Return([]*core.EnrichedEvent{}, nil, nil) | ||
|
|
||
| r.ServeHTTP(res, req) | ||
| assert.Equal(t, 200, res.Result().StatusCode) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.