507 lines
12 KiB
Go
507 lines
12 KiB
Go
package search
|
|
|
|
import (
|
|
"context"
|
|
"database/sql"
|
|
"encoding/json"
|
|
"errors"
|
|
"fmt"
|
|
"testing"
|
|
"time"
|
|
|
|
"github.com/pocketbase/dbx"
|
|
"github.com/pocketbase/pocketbase/tools/list"
|
|
_ "modernc.org/sqlite"
|
|
)
|
|
|
|
func TestNewProvider(t *testing.T) {
|
|
r := &testFieldResolver{}
|
|
p := NewProvider(r)
|
|
|
|
if p.page != 1 {
|
|
t.Fatalf("Expected page %d, got %d", 1, p.page)
|
|
}
|
|
|
|
if p.perPage != DefaultPerPage {
|
|
t.Fatalf("Expected perPage %d, got %d", DefaultPerPage, p.perPage)
|
|
}
|
|
}
|
|
|
|
func TestProviderQuery(t *testing.T) {
|
|
db := dbx.NewFromDB(nil, "")
|
|
query := db.Select("id").From("test")
|
|
querySql := query.Build().SQL()
|
|
|
|
r := &testFieldResolver{}
|
|
p := NewProvider(r).Query(query)
|
|
|
|
expected := p.query.Build().SQL()
|
|
|
|
if querySql != expected {
|
|
t.Fatalf("Expected %v, got %v", expected, querySql)
|
|
}
|
|
}
|
|
|
|
func TestProviderPage(t *testing.T) {
|
|
r := &testFieldResolver{}
|
|
p := NewProvider(r).Page(10)
|
|
|
|
if p.page != 10 {
|
|
t.Fatalf("Expected page %v, got %v", 10, p.page)
|
|
}
|
|
}
|
|
|
|
func TestProviderPerPage(t *testing.T) {
|
|
r := &testFieldResolver{}
|
|
p := NewProvider(r).PerPage(456)
|
|
|
|
if p.perPage != 456 {
|
|
t.Fatalf("Expected perPage %v, got %v", 456, p.perPage)
|
|
}
|
|
}
|
|
|
|
func TestProviderSort(t *testing.T) {
|
|
initialSort := []SortField{{"test1", SortAsc}, {"test2", SortAsc}}
|
|
r := &testFieldResolver{}
|
|
p := NewProvider(r).
|
|
Sort(initialSort).
|
|
AddSort(SortField{"test3", SortDesc})
|
|
|
|
encoded, _ := json.Marshal(p.sort)
|
|
expected := `[{"name":"test1","direction":"ASC"},{"name":"test2","direction":"ASC"},{"name":"test3","direction":"DESC"}]`
|
|
|
|
if string(encoded) != expected {
|
|
t.Fatalf("Expected sort %v, got \n%v", expected, string(encoded))
|
|
}
|
|
}
|
|
|
|
func TestProviderFilter(t *testing.T) {
|
|
initialFilter := []FilterData{"test1", "test2"}
|
|
r := &testFieldResolver{}
|
|
p := NewProvider(r).
|
|
Filter(initialFilter).
|
|
AddFilter("test3")
|
|
|
|
encoded, _ := json.Marshal(p.filter)
|
|
expected := `["test1","test2","test3"]`
|
|
|
|
if string(encoded) != expected {
|
|
t.Fatalf("Expected filter %v, got \n%v", expected, string(encoded))
|
|
}
|
|
}
|
|
|
|
func TestProviderParse(t *testing.T) {
|
|
initialPage := 2
|
|
initialPerPage := 123
|
|
initialSort := []SortField{{"test1", SortAsc}, {"test2", SortAsc}}
|
|
initialFilter := []FilterData{"test1", "test2"}
|
|
|
|
scenarios := []struct {
|
|
query string
|
|
expectError bool
|
|
expectPage int
|
|
expectPerPage int
|
|
expectSort string
|
|
expectFilter string
|
|
}{
|
|
// empty
|
|
{
|
|
"",
|
|
false,
|
|
initialPage,
|
|
initialPerPage,
|
|
`[{"name":"test1","direction":"ASC"},{"name":"test2","direction":"ASC"}]`,
|
|
`["test1","test2"]`,
|
|
},
|
|
// invalid query
|
|
{
|
|
"invalid;",
|
|
true,
|
|
initialPage,
|
|
initialPerPage,
|
|
`[{"name":"test1","direction":"ASC"},{"name":"test2","direction":"ASC"}]`,
|
|
`["test1","test2"]`,
|
|
},
|
|
// invalid page
|
|
{
|
|
"page=a",
|
|
true,
|
|
initialPage,
|
|
initialPerPage,
|
|
`[{"name":"test1","direction":"ASC"},{"name":"test2","direction":"ASC"}]`,
|
|
`["test1","test2"]`,
|
|
},
|
|
// invalid perPage
|
|
{
|
|
"perPage=a",
|
|
true,
|
|
initialPage,
|
|
initialPerPage,
|
|
`[{"name":"test1","direction":"ASC"},{"name":"test2","direction":"ASC"}]`,
|
|
`["test1","test2"]`,
|
|
},
|
|
// valid query parameters
|
|
{
|
|
"page=3&perPage=456&filter=test3&sort=-a,b,+c&other=123",
|
|
false,
|
|
3,
|
|
456,
|
|
`[{"name":"test1","direction":"ASC"},{"name":"test2","direction":"ASC"},{"name":"a","direction":"DESC"},{"name":"b","direction":"ASC"},{"name":"c","direction":"ASC"}]`,
|
|
`["test1","test2","test3"]`,
|
|
},
|
|
}
|
|
|
|
for i, s := range scenarios {
|
|
r := &testFieldResolver{}
|
|
p := NewProvider(r).
|
|
Page(initialPage).
|
|
PerPage(initialPerPage).
|
|
Sort(initialSort).
|
|
Filter(initialFilter)
|
|
|
|
err := p.Parse(s.query)
|
|
|
|
hasErr := err != nil
|
|
if hasErr != s.expectError {
|
|
t.Errorf("(%d) Expected hasErr %v, got %v (%v)", i, s.expectError, hasErr, err)
|
|
continue
|
|
}
|
|
|
|
if p.page != s.expectPage {
|
|
t.Errorf("(%d) Expected page %v, got %v", i, s.expectPage, p.page)
|
|
}
|
|
|
|
if p.perPage != s.expectPerPage {
|
|
t.Errorf("(%d) Expected perPage %v, got %v", i, s.expectPerPage, p.perPage)
|
|
}
|
|
|
|
encodedSort, _ := json.Marshal(p.sort)
|
|
if string(encodedSort) != s.expectSort {
|
|
t.Errorf("(%d) Expected sort %v, got \n%v", i, s.expectSort, string(encodedSort))
|
|
}
|
|
|
|
encodedFilter, _ := json.Marshal(p.filter)
|
|
if string(encodedFilter) != s.expectFilter {
|
|
t.Errorf("(%d) Expected filter %v, got \n%v", i, s.expectFilter, string(encodedFilter))
|
|
}
|
|
}
|
|
}
|
|
|
|
func TestProviderExecEmptyQuery(t *testing.T) {
|
|
p := NewProvider(&testFieldResolver{}).
|
|
Query(nil)
|
|
|
|
_, err := p.Exec(&[]testTableStruct{})
|
|
if err == nil {
|
|
t.Fatalf("Expected error with empty query, got nil")
|
|
}
|
|
}
|
|
|
|
func TestProviderExecNonEmptyQuery(t *testing.T) {
|
|
testDB, err := createTestDB()
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
defer testDB.Close()
|
|
|
|
query := testDB.Select("*").
|
|
From("test").
|
|
Where(dbx.Not(dbx.HashExp{"test1": nil})).
|
|
OrderBy("test1 ASC")
|
|
|
|
scenarios := []struct {
|
|
name string
|
|
page int
|
|
perPage int
|
|
sort []SortField
|
|
filter []FilterData
|
|
expectError bool
|
|
expectResult string
|
|
expectQueries []string
|
|
}{
|
|
{
|
|
"page normalization",
|
|
-1,
|
|
10,
|
|
[]SortField{},
|
|
[]FilterData{},
|
|
false,
|
|
`{"page":1,"perPage":10,"totalItems":2,"totalPages":1,"items":[{"test1":1,"test2":"test2.1","test3":""},{"test1":2,"test2":"test2.2","test3":""}]}`,
|
|
[]string{
|
|
"SELECT COUNT(DISTINCT [[test.id]]) FROM `test` WHERE NOT (`test1` IS NULL)",
|
|
"SELECT * FROM `test` WHERE NOT (`test1` IS NULL) ORDER BY `test1` ASC LIMIT 10",
|
|
},
|
|
},
|
|
{
|
|
"perPage normalization",
|
|
10, // will be capped by total count
|
|
0, // fallback to default
|
|
[]SortField{},
|
|
[]FilterData{},
|
|
false,
|
|
`{"page":1,"perPage":30,"totalItems":2,"totalPages":1,"items":[{"test1":1,"test2":"test2.1","test3":""},{"test1":2,"test2":"test2.2","test3":""}]}`,
|
|
[]string{
|
|
"SELECT COUNT(DISTINCT [[test.id]]) FROM `test` WHERE NOT (`test1` IS NULL)",
|
|
"SELECT * FROM `test` WHERE NOT (`test1` IS NULL) ORDER BY `test1` ASC LIMIT 30",
|
|
},
|
|
},
|
|
{
|
|
"invalid sort field",
|
|
1,
|
|
10,
|
|
[]SortField{{"unknown", SortAsc}},
|
|
[]FilterData{},
|
|
true,
|
|
"",
|
|
nil,
|
|
},
|
|
{
|
|
"invalid filter",
|
|
1,
|
|
10,
|
|
[]SortField{},
|
|
[]FilterData{"test2 = 'test2.1'", "invalid"},
|
|
true,
|
|
"",
|
|
nil,
|
|
},
|
|
{
|
|
"valid sort and filter fields",
|
|
1,
|
|
5555, // will be limited by MaxPerPage
|
|
[]SortField{{"test2", SortDesc}},
|
|
[]FilterData{"test2 != null", "test1 >= 2"},
|
|
false,
|
|
`{"page":1,"perPage":` + fmt.Sprint(MaxPerPage) + `,"totalItems":1,"totalPages":1,"items":[{"test1":2,"test2":"test2.2","test3":""}]}`,
|
|
[]string{
|
|
"SELECT COUNT(DISTINCT [[test.id]]) FROM `test` WHERE ((NOT (`test1` IS NULL)) AND (((test2 != '' AND test2 IS NOT NULL)))) AND (test1 >= 2)",
|
|
"SELECT * FROM `test` WHERE ((NOT (`test1` IS NULL)) AND (((test2 != '' AND test2 IS NOT NULL)))) AND (test1 >= 2) ORDER BY `test1` ASC, `test2` DESC LIMIT 500",
|
|
},
|
|
},
|
|
{
|
|
"valid sort and filter fields (zero results)",
|
|
1,
|
|
10,
|
|
[]SortField{{"test3", SortAsc}},
|
|
[]FilterData{"test3 != ''"},
|
|
false,
|
|
`{"page":1,"perPage":10,"totalItems":0,"totalPages":0,"items":[]}`,
|
|
[]string{
|
|
"SELECT COUNT(DISTINCT [[test.id]]) FROM `test` WHERE (NOT (`test1` IS NULL)) AND (((test3 != '' AND test3 IS NOT NULL)))",
|
|
"SELECT * FROM `test` WHERE (NOT (`test1` IS NULL)) AND (((test3 != '' AND test3 IS NOT NULL))) ORDER BY `test1` ASC, `test3` ASC LIMIT 10",
|
|
},
|
|
},
|
|
{
|
|
"pagination test",
|
|
3,
|
|
1,
|
|
[]SortField{},
|
|
[]FilterData{},
|
|
false,
|
|
`{"page":2,"perPage":1,"totalItems":2,"totalPages":2,"items":[{"test1":2,"test2":"test2.2","test3":""}]}`,
|
|
[]string{
|
|
"SELECT COUNT(DISTINCT [[test.id]]) FROM `test` WHERE NOT (`test1` IS NULL)",
|
|
"SELECT * FROM `test` WHERE NOT (`test1` IS NULL) ORDER BY `test1` ASC LIMIT 1 OFFSET 1",
|
|
},
|
|
},
|
|
}
|
|
|
|
for _, s := range scenarios {
|
|
testDB.CalledQueries = []string{} // reset
|
|
|
|
testResolver := &testFieldResolver{}
|
|
p := NewProvider(testResolver).
|
|
Query(query).
|
|
Page(s.page).
|
|
PerPage(s.perPage).
|
|
Sort(s.sort).
|
|
Filter(s.filter)
|
|
|
|
result, err := p.Exec(&[]testTableStruct{})
|
|
|
|
hasErr := err != nil
|
|
if hasErr != s.expectError {
|
|
t.Errorf("[%s] Expected hasErr %v, got %v (%v)", s.name, s.expectError, hasErr, err)
|
|
continue
|
|
}
|
|
|
|
if hasErr {
|
|
continue
|
|
}
|
|
|
|
if testResolver.UpdateQueryCalls != 1 {
|
|
t.Errorf("[%s] Expected resolver.Update to be called %d, got %d", s.name, 1, testResolver.UpdateQueryCalls)
|
|
}
|
|
|
|
encoded, _ := json.Marshal(result)
|
|
if string(encoded) != s.expectResult {
|
|
t.Errorf("[%s] Expected result %v, got \n%v", s.name, s.expectResult, string(encoded))
|
|
}
|
|
|
|
if len(s.expectQueries) != len(testDB.CalledQueries) {
|
|
t.Errorf("[%s] Expected %d queries, got %d: \n%v", s.name, len(s.expectQueries), len(testDB.CalledQueries), testDB.CalledQueries)
|
|
continue
|
|
}
|
|
|
|
for _, q := range testDB.CalledQueries {
|
|
if !list.ExistInSliceWithRegex(q, s.expectQueries) {
|
|
t.Fatalf("[%s] Didn't expect query \n%v \nin \n%v", s.name, q, s.expectQueries)
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
func TestProviderParseAndExec(t *testing.T) {
|
|
testDB, err := createTestDB()
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
defer testDB.Close()
|
|
|
|
query := testDB.Select("*").
|
|
From("test").
|
|
Where(dbx.Not(dbx.HashExp{"test1": nil})).
|
|
OrderBy("test1 ASC")
|
|
|
|
scenarios := []struct {
|
|
queryString string
|
|
expectError bool
|
|
expectResult string
|
|
}{
|
|
// empty
|
|
{
|
|
"",
|
|
false,
|
|
`{"page":1,"perPage":123,"totalItems":2,"totalPages":1,"items":[{"test1":1,"test2":"test2.1","test3":""},{"test1":2,"test2":"test2.2","test3":""}]}`,
|
|
},
|
|
// invalid query
|
|
{
|
|
"invalid;",
|
|
true,
|
|
"",
|
|
},
|
|
// invalid page
|
|
{
|
|
"page=a",
|
|
true,
|
|
"",
|
|
},
|
|
// invalid perPage
|
|
{
|
|
"perPage=a",
|
|
true,
|
|
"",
|
|
},
|
|
// invalid sorting field
|
|
{
|
|
"sort=-unknown",
|
|
true,
|
|
"",
|
|
},
|
|
// invalid filter field
|
|
{
|
|
"filter=unknown>1",
|
|
true,
|
|
"",
|
|
},
|
|
// valid query params
|
|
{
|
|
"page=3&perPage=9999&filter=test1>1&sort=-test2,test3",
|
|
false,
|
|
`{"page":1,"perPage":500,"totalItems":1,"totalPages":1,"items":[{"test1":2,"test2":"test2.2","test3":""}]}`,
|
|
},
|
|
}
|
|
|
|
for i, s := range scenarios {
|
|
testDB.CalledQueries = []string{} // reset
|
|
|
|
testResolver := &testFieldResolver{}
|
|
provider := NewProvider(testResolver).
|
|
Query(query).
|
|
Page(2).
|
|
PerPage(123).
|
|
Sort([]SortField{{"test2", SortAsc}}).
|
|
Filter([]FilterData{"test1 > 0"})
|
|
|
|
result, err := provider.ParseAndExec(s.queryString, &[]testTableStruct{})
|
|
|
|
hasErr := err != nil
|
|
if hasErr != s.expectError {
|
|
t.Errorf("(%d) Expected hasErr %v, got %v (%v)", i, s.expectError, hasErr, err)
|
|
continue
|
|
}
|
|
|
|
if hasErr {
|
|
continue
|
|
}
|
|
|
|
if testResolver.UpdateQueryCalls != 1 {
|
|
t.Errorf("(%d) Expected resolver.Update to be called %d, got %d", i, 1, testResolver.UpdateQueryCalls)
|
|
}
|
|
|
|
if len(testDB.CalledQueries) != 2 {
|
|
t.Errorf("(%d) Expected %d db queries, got %d: \n%v", i, 2, len(testDB.CalledQueries), testDB.CalledQueries)
|
|
}
|
|
|
|
encoded, _ := json.Marshal(result)
|
|
if string(encoded) != s.expectResult {
|
|
t.Errorf("(%d) Expected result %v, got \n%v", i, s.expectResult, string(encoded))
|
|
}
|
|
}
|
|
}
|
|
|
|
// -------------------------------------------------------------------
|
|
// Helpers
|
|
// -------------------------------------------------------------------
|
|
|
|
type testTableStruct struct {
|
|
Test1 int `db:"test1" json:"test1"`
|
|
Test2 string `db:"test2" json:"test2"`
|
|
Test3 string `db:"test3" json:"test3"`
|
|
}
|
|
|
|
type testDB struct {
|
|
*dbx.DB
|
|
CalledQueries []string
|
|
}
|
|
|
|
// NB! Don't forget to call `db.Close()` at the end of the test.
|
|
func createTestDB() (*testDB, error) {
|
|
sqlDB, err := sql.Open("sqlite", ":memory:")
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
db := testDB{DB: dbx.NewFromDB(sqlDB, "sqlite")}
|
|
db.CreateTable("test", map[string]string{"id": "int default 0", "test1": "int default 0", "test2": "text default ''", "test3": "text default ''"}).Execute()
|
|
db.Insert("test", dbx.Params{"id": 1, "test1": 1, "test2": "test2.1"}).Execute()
|
|
db.Insert("test", dbx.Params{"id": 2, "test1": 2, "test2": "test2.2"}).Execute()
|
|
db.QueryLogFunc = func(ctx context.Context, t time.Duration, sql string, rows *sql.Rows, err error) {
|
|
db.CalledQueries = append(db.CalledQueries, sql)
|
|
}
|
|
|
|
return &db, nil
|
|
}
|
|
|
|
// ---
|
|
|
|
type testFieldResolver struct {
|
|
UpdateQueryCalls int
|
|
ResolveCalls int
|
|
}
|
|
|
|
func (t *testFieldResolver) UpdateQuery(query *dbx.SelectQuery) error {
|
|
t.UpdateQueryCalls++
|
|
return nil
|
|
}
|
|
|
|
func (t *testFieldResolver) Resolve(field string) (*ResolverResult, error) {
|
|
t.ResolveCalls++
|
|
|
|
if field == "unknown" {
|
|
return nil, errors.New("test error")
|
|
}
|
|
|
|
return &ResolverResult{Identifier: field}, nil
|
|
}
|