generated from mrz1836/go-template
-
Notifications
You must be signed in to change notification settings - Fork 14
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(SPV-793): add function that allows parsing query params into new…
… search params struct.
- Loading branch information
1 parent
8b853de
commit 10f94a4
Showing
12 changed files
with
225 additions
and
7 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
package query | ||
|
||
import ( | ||
"time" | ||
|
||
"github.com/bitcoin-sv/spv-wallet/models/filter" | ||
"github.com/gin-gonic/gin" | ||
"github.com/mitchellh/mapstructure" | ||
) | ||
|
||
func ParseSearchParams[T any](c *gin.Context, _ T) (*filter.SearchParams[T], error) { | ||
var params filter.SearchParams[T] | ||
|
||
dicts, err := ShouldGetQueryNestedMap(c) | ||
if err != nil { | ||
return nil, err | ||
} | ||
|
||
config := mapstructure.DecoderConfig{ | ||
DecodeHook: mapstructure.StringToTimeHookFunc(time.RFC3339), | ||
WeaklyTypedInput: true, | ||
Result: ¶ms, | ||
TagName: "json", // Small hax to reuse json tags which we have already defined | ||
} | ||
|
||
decoder, err := mapstructure.NewDecoder(&config) | ||
if err != nil { | ||
return nil, err | ||
} | ||
|
||
err = decoder.Decode(dicts) | ||
if err != nil { | ||
return nil, err | ||
} | ||
|
||
return ¶ms, nil | ||
} |
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,122 @@ | ||
package query | ||
|
||
import ( | ||
"net/http" | ||
"net/url" | ||
"testing" | ||
"time" | ||
|
||
"github.com/bitcoin-sv/spv-wallet/models/filter" | ||
"github.com/gin-gonic/gin" | ||
"github.com/stretchr/testify/require" | ||
) | ||
|
||
func TestParseSearchParamsSuccessfully(t *testing.T) { | ||
tests := map[string]struct { | ||
url string | ||
expectedResult filter.SearchParams[ExampleConditionsForTests] | ||
}{ | ||
"empty query": { | ||
url: "", | ||
expectedResult: filter.SearchParams[ExampleConditionsForTests]{}, | ||
}, | ||
"query page": { | ||
url: "?page=2&size=200&order=asc&sortBy=id", | ||
expectedResult: filter.SearchParams[ExampleConditionsForTests]{ | ||
Page: filter.Page{ | ||
Number: 2, | ||
Size: 200, | ||
Order: "asc", | ||
SortBy: "id", | ||
}, | ||
}, | ||
}, | ||
"query conditions model filter": { | ||
url: "?includeDeleted=true&createdRange[from]=2021-01-01T00:00:00Z&createdRange[to]=2021-01-02T00:00:00Z&updatedRange[from]=2021-02-01T00:00:00Z&updatedRange[to]=2021-02-02T00:00:00Z", | ||
expectedResult: filter.SearchParams[ExampleConditionsForTests]{ | ||
Conditions: ExampleConditionsForTests{ | ||
ModelFilter: filter.ModelFilter{ | ||
IncludeDeleted: ptr(true), | ||
CreatedRange: &filter.TimeRange{ | ||
From: ptr(time.Date(2021, 1, 1, 0, 0, 0, 0, time.UTC)), | ||
To: ptr(time.Date(2021, 1, 2, 0, 0, 0, 0, time.UTC)), | ||
}, | ||
UpdatedRange: &filter.TimeRange{ | ||
From: ptr(time.Date(2021, 2, 1, 0, 0, 0, 0, time.UTC)), | ||
To: ptr(time.Date(2021, 2, 2, 0, 0, 0, 0, time.UTC)), | ||
}, | ||
}, | ||
}, | ||
}, | ||
}, | ||
"query conditions without nested structs": { | ||
url: "?xBoolean=true&xString=some%20string&xInt=5", | ||
expectedResult: filter.SearchParams[ExampleConditionsForTests]{ | ||
Conditions: ExampleConditionsForTests{ | ||
XBoolean: ptr(true), | ||
XString: ptr("some string"), | ||
XInt: ptr(5), | ||
}, | ||
}, | ||
}, | ||
"query conditions nested struct": { | ||
url: "?nested[isNested]=true&nested[name]=some%20name&nested[number]=10", | ||
expectedResult: filter.SearchParams[ExampleConditionsForTests]{ | ||
Conditions: ExampleConditionsForTests{ | ||
Nested: &ExampleNestedConditionsForTests{ | ||
IsNested: ptr(true), | ||
Name: ptr("some name"), | ||
Number: ptr(10), | ||
}, | ||
}, | ||
}, | ||
}, | ||
"query metadata": { | ||
url: "?metadata[key]=value1&metadata[key2][nested]=value2&metadata[key3][nested][]=value3&metadata[key3][nested][]=value4", | ||
expectedResult: filter.SearchParams[ExampleConditionsForTests]{ | ||
Metadata: map[string]interface{}{ | ||
"key": "value1", | ||
"key2": map[string]interface{}{ | ||
"nested": "value2", | ||
}, | ||
"key3": map[string]interface{}{ | ||
"nested": []string{"value3", "value4"}, | ||
}, | ||
}, | ||
}, | ||
}, | ||
} | ||
for name, test := range tests { | ||
t.Run(name, func(t *testing.T) { | ||
u, err := url.Parse(test.url) | ||
require.NoError(t, err) | ||
|
||
c := &gin.Context{ | ||
Request: &http.Request{ | ||
URL: u, | ||
}, | ||
} | ||
|
||
params, err := ParseSearchParams(c, ExampleConditionsForTests{}) | ||
require.NoError(t, err) | ||
require.EqualValues(t, test.expectedResult, *params) | ||
}) | ||
} | ||
} | ||
|
||
type ExampleConditionsForTests struct { | ||
filter.ModelFilter `json:",inline,squash"` | ||
XBoolean *bool `json:"xBoolean,omitempty"` | ||
XString *string `json:"xString,omitempty"` | ||
XInt *int `json:"xInt,omitempty"` | ||
Nested *ExampleNestedConditionsForTests `json:"nested,omitempty"` | ||
} | ||
type ExampleNestedConditionsForTests struct { | ||
IsNested *bool `json:"isNested,omitempty"` | ||
Name *string `json:"name,omitempty"` | ||
Number *int `json:"number,omitempty"` | ||
} | ||
|
||
func ptr[T any](value T) *T { | ||
return &value | ||
} |
File renamed without changes.
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,45 @@ | ||
package mappings | ||
|
||
import ( | ||
"github.com/bitcoin-sv/spv-wallet/engine/datastore" | ||
"github.com/bitcoin-sv/spv-wallet/models/filter" | ||
) | ||
|
||
const ( | ||
defaultPage = 1 | ||
defaultPageSize = 50 | ||
defaultSortBy = "created_at" | ||
defaultOrder = "desc" | ||
) | ||
|
||
// MapToDbQueryParams converts filter.QueryParams from models to matching datastore.QueryParams | ||
func MapToDbQueryParams(model *filter.Page) *datastore.QueryParams { | ||
if model == nil { | ||
return &datastore.QueryParams{ | ||
Page: defaultPage, | ||
PageSize: defaultPageSize, | ||
OrderByField: defaultOrder, | ||
SortDirection: defaultOrder, | ||
} | ||
} | ||
return &datastore.QueryParams{ | ||
Page: getNumberOrDefault(model.Number, defaultPage), | ||
PageSize: getNumberOrDefault(model.Size, defaultPageSize), | ||
OrderByField: getStringOrDefalut(model.SortBy, defaultSortBy), | ||
SortDirection: getStringOrDefalut(model.Order, defaultOrder), | ||
} | ||
} | ||
|
||
func getNumberOrDefault(value int, defaultValue int) int { | ||
if value == 0 { | ||
return defaultValue | ||
} | ||
return value | ||
} | ||
|
||
func getStringOrDefalut(value string, defaultValue string) string { | ||
if value == "" { | ||
return defaultValue | ||
} | ||
return value | ||
} |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
package filter | ||
|
||
type Page struct { | ||
Number int `json:"page,omitempty"` | ||
Size int `json:"size,omitempty"` | ||
Order string `json:"order,omitempty"` | ||
SortBy string `json:"sortBy,omitempty"` | ||
} | ||
|
||
type SearchParams[T any] struct { | ||
Page Page `json:"paging,squash"` | ||
Conditions T `json:"conditions,squash"` | ||
Metadata map[string]interface{} `json:"metadata,omitempty"` | ||
} |
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