mirror of
https://github.com/zitadel/zitadel.git
synced 2025-08-12 05:07:31 +00:00
feat(user/v1): support composite queries (#6361)
* feat(user/v1): support composite queries * fix: added proper error handling for NotQuery * Added error when there are too many levels of nesting * Add localization keys for english * Update internal/api/grpc/user/query.go
This commit is contained in:
@@ -2,6 +2,7 @@ package query
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"fmt"
|
||||
"reflect"
|
||||
"time"
|
||||
|
||||
@@ -92,27 +93,26 @@ func (q *IsNullQuery) toQuery(query sq.SelectBuilder) sq.SelectBuilder {
|
||||
func (q *IsNullQuery) comp() sq.Sqlizer {
|
||||
return sq.Eq{q.Column.identifier(): nil}
|
||||
}
|
||||
|
||||
func (q *IsNullQuery) Col() Column {
|
||||
return q.Column
|
||||
}
|
||||
|
||||
type orQuery struct {
|
||||
type OrQuery struct {
|
||||
queries []SearchQuery
|
||||
}
|
||||
|
||||
func newOrQuery(queries ...SearchQuery) (*orQuery, error) {
|
||||
func NewOrQuery(queries ...SearchQuery) (*OrQuery, error) {
|
||||
if len(queries) == 0 {
|
||||
return nil, ErrMissingColumn
|
||||
}
|
||||
return &orQuery{queries: queries}, nil
|
||||
return &OrQuery{queries: queries}, nil
|
||||
}
|
||||
|
||||
func (q *orQuery) toQuery(query sq.SelectBuilder) sq.SelectBuilder {
|
||||
func (q *OrQuery) toQuery(query sq.SelectBuilder) sq.SelectBuilder {
|
||||
return query.Where(q.comp())
|
||||
}
|
||||
|
||||
func (q *orQuery) comp() sq.Sqlizer {
|
||||
func (q *OrQuery) comp() sq.Sqlizer {
|
||||
or := make(sq.Or, len(q.queries))
|
||||
for i, query := range q.queries {
|
||||
or[i] = query.comp()
|
||||
@@ -120,7 +120,66 @@ func (q *orQuery) comp() sq.Sqlizer {
|
||||
return or
|
||||
}
|
||||
|
||||
func (q *orQuery) Col() Column {
|
||||
type AndQuery struct {
|
||||
queries []SearchQuery
|
||||
}
|
||||
|
||||
func (q *AndQuery) Col() Column {
|
||||
return Column{}
|
||||
}
|
||||
func NewAndQuery(queries ...SearchQuery) (*AndQuery, error) {
|
||||
if len(queries) == 0 {
|
||||
return nil, ErrMissingColumn
|
||||
}
|
||||
return &AndQuery{queries: queries}, nil
|
||||
}
|
||||
|
||||
func (q *AndQuery) toQuery(query sq.SelectBuilder) sq.SelectBuilder {
|
||||
return query.Where(q.comp())
|
||||
}
|
||||
|
||||
func (q *AndQuery) comp() sq.Sqlizer {
|
||||
and := make(sq.And, len(q.queries))
|
||||
for i, query := range q.queries {
|
||||
and[i] = query.comp()
|
||||
}
|
||||
return and
|
||||
}
|
||||
|
||||
type NotQuery struct {
|
||||
query SearchQuery
|
||||
}
|
||||
|
||||
func (q *NotQuery) Col() Column {
|
||||
return q.query.Col()
|
||||
}
|
||||
func NewNotQuery(query SearchQuery) (*NotQuery, error) {
|
||||
if query == nil {
|
||||
return nil, ErrMissingColumn
|
||||
}
|
||||
return &NotQuery{query: query}, nil
|
||||
}
|
||||
|
||||
func (q *NotQuery) toQuery(query sq.SelectBuilder) sq.SelectBuilder {
|
||||
return query.Where(q.comp())
|
||||
}
|
||||
|
||||
func (notQ NotQuery) ToSql() (sql string, args []interface{}, err error) {
|
||||
querySql, queryArgs, queryErr := notQ.query.comp().ToSql()
|
||||
// Handle the error from the query's ToSql() function.
|
||||
if queryErr != nil {
|
||||
return "", queryArgs, queryErr
|
||||
}
|
||||
// Construct the SQL statement.
|
||||
sql = fmt.Sprintf("NOT (%s)", querySql)
|
||||
return sql, queryArgs, nil
|
||||
}
|
||||
|
||||
func (q *NotQuery) comp() sq.Sqlizer {
|
||||
return q
|
||||
}
|
||||
|
||||
func (q *OrQuery) Col() Column {
|
||||
return Column{}
|
||||
}
|
||||
|
||||
|
@@ -1383,6 +1383,415 @@ func TestNumberComparisonFromMethod(t *testing.T) {
|
||||
}
|
||||
}
|
||||
|
||||
func TestNewOrQuery(t *testing.T) {
|
||||
|
||||
type args struct {
|
||||
queries []SearchQuery
|
||||
}
|
||||
|
||||
singleCorrectQuery, _ := NewTextQuery(testCol, "hello", TextEquals)
|
||||
|
||||
tests := []struct {
|
||||
name string
|
||||
args args
|
||||
want *OrQuery
|
||||
wantErr func(error) bool
|
||||
}{
|
||||
{
|
||||
name: "empty values",
|
||||
args: args{
|
||||
queries: []SearchQuery{},
|
||||
},
|
||||
wantErr: func(err error) bool {
|
||||
return errors.Is(err, ErrMissingColumn)
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "correct",
|
||||
args: args{
|
||||
queries: []SearchQuery{singleCorrectQuery},
|
||||
},
|
||||
want: &OrQuery{
|
||||
queries: []SearchQuery{singleCorrectQuery},
|
||||
},
|
||||
},
|
||||
}
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
got, err := NewOrQuery(tt.args.queries...)
|
||||
if err != nil && tt.wantErr == nil {
|
||||
t.Errorf("NewOrQuery() no error expected got %v", err)
|
||||
return
|
||||
} else if tt.wantErr != nil && !tt.wantErr(err) {
|
||||
t.Errorf("NewOrQuery() unexpeted error = %v", err)
|
||||
return
|
||||
}
|
||||
if !reflect.DeepEqual(got, tt.want) {
|
||||
t.Errorf("NewOrQuery() = %v, want %v", got, tt.want)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
func TestOrQuery_comp(t *testing.T) {
|
||||
q1, _ := NewTextQuery(testCol, "hello1", TextEquals)
|
||||
q2, _ := NewTextQuery(testCol, "hello2", TextEquals)
|
||||
q3, _ := NewTextQuery(testCol2, "world1", TextEquals)
|
||||
q4, _ := NewTextQuery(testCol2, "world2", TextEquals)
|
||||
orq, _ := NewOrQuery(q3, q4)
|
||||
|
||||
type fields struct {
|
||||
queries []SearchQuery
|
||||
}
|
||||
type want struct {
|
||||
query interface{}
|
||||
isNil bool
|
||||
}
|
||||
tests := []struct {
|
||||
name string
|
||||
fields fields
|
||||
want want
|
||||
}{
|
||||
{
|
||||
name: "single input",
|
||||
fields: fields{
|
||||
queries: []SearchQuery{q1},
|
||||
},
|
||||
want: want{
|
||||
query: sq.Or{sq.Eq{"test_table.test_col": "hello1"}},
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "multi input",
|
||||
fields: fields{
|
||||
queries: []SearchQuery{q1, q2},
|
||||
},
|
||||
want: want{
|
||||
query: sq.Or{sq.Eq{"test_table.test_col": "hello1"}, sq.Eq{"test_table.test_col": "hello2"}},
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "nested inputs",
|
||||
fields: fields{
|
||||
queries: []SearchQuery{q1, orq},
|
||||
},
|
||||
want: want{
|
||||
query: sq.Or{sq.Eq{"test_table.test_col": "hello1"}, sq.Or{sq.Eq{"test_table2.test_col2": "world1"}, sq.Eq{"test_table2.test_col2": "world2"}}},
|
||||
},
|
||||
},
|
||||
}
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
s := &OrQuery{
|
||||
queries: tt.fields.queries,
|
||||
}
|
||||
query := s.comp()
|
||||
if query == nil && tt.want.isNil {
|
||||
return
|
||||
} else if tt.want.isNil && query != nil {
|
||||
t.Error("query should not be nil")
|
||||
}
|
||||
|
||||
if !reflect.DeepEqual(query, tt.want.query) {
|
||||
t.Errorf("wrong query: want: %v, (%T), got: %v, (%T)", tt.want.query, tt.want.query, query, query)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
func TestNewAndQuery(t *testing.T) {
|
||||
|
||||
type args struct {
|
||||
queries []SearchQuery
|
||||
}
|
||||
|
||||
singleCorrectQuery, _ := NewTextQuery(testCol, "hello", TextEquals)
|
||||
|
||||
tests := []struct {
|
||||
name string
|
||||
args args
|
||||
want *AndQuery
|
||||
wantErr func(error) bool
|
||||
}{
|
||||
{
|
||||
name: "empty values",
|
||||
args: args{
|
||||
queries: []SearchQuery{},
|
||||
},
|
||||
wantErr: func(err error) bool {
|
||||
return errors.Is(err, ErrMissingColumn)
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "correct",
|
||||
args: args{
|
||||
queries: []SearchQuery{singleCorrectQuery},
|
||||
},
|
||||
want: &AndQuery{
|
||||
queries: []SearchQuery{singleCorrectQuery},
|
||||
},
|
||||
},
|
||||
}
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
got, err := NewAndQuery(tt.args.queries...)
|
||||
if err != nil && tt.wantErr == nil {
|
||||
t.Errorf("NewAndQuery() no error expected got %v", err)
|
||||
return
|
||||
} else if tt.wantErr != nil && !tt.wantErr(err) {
|
||||
t.Errorf("NewAndQuery() unexpeted error = %v", err)
|
||||
return
|
||||
}
|
||||
if !reflect.DeepEqual(got, tt.want) {
|
||||
t.Errorf("NewAndQuery() = %v, want %v", got, tt.want)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestAndQuery_comp(t *testing.T) {
|
||||
q1, _ := NewTextQuery(testCol, "hello1", TextEquals)
|
||||
q2, _ := NewTextQuery(testCol, "hello2", TextEquals)
|
||||
q3, _ := NewTextQuery(testCol2, "world1", TextEquals)
|
||||
q4, _ := NewTextQuery(testCol2, "world2", TextEquals)
|
||||
andq, _ := NewAndQuery(q3, q4)
|
||||
|
||||
type fields struct {
|
||||
queries []SearchQuery
|
||||
}
|
||||
type want struct {
|
||||
query interface{}
|
||||
isNil bool
|
||||
}
|
||||
tests := []struct {
|
||||
name string
|
||||
fields fields
|
||||
want want
|
||||
}{
|
||||
{
|
||||
name: "single input",
|
||||
fields: fields{
|
||||
queries: []SearchQuery{q1},
|
||||
},
|
||||
want: want{
|
||||
query: sq.And{sq.Eq{"test_table.test_col": "hello1"}},
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "multi input",
|
||||
fields: fields{
|
||||
queries: []SearchQuery{q1, q2},
|
||||
},
|
||||
want: want{
|
||||
query: sq.And{sq.Eq{"test_table.test_col": "hello1"}, sq.Eq{"test_table.test_col": "hello2"}},
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "nested inputs",
|
||||
fields: fields{
|
||||
queries: []SearchQuery{q1, andq},
|
||||
},
|
||||
want: want{
|
||||
query: sq.And{sq.Eq{"test_table.test_col": "hello1"}, sq.And{sq.Eq{"test_table2.test_col2": "world1"}, sq.Eq{"test_table2.test_col2": "world2"}}},
|
||||
},
|
||||
},
|
||||
}
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
s := &AndQuery{
|
||||
queries: tt.fields.queries,
|
||||
}
|
||||
query := s.comp()
|
||||
if query == nil && tt.want.isNil {
|
||||
return
|
||||
} else if tt.want.isNil && query != nil {
|
||||
t.Error("query should not be nil")
|
||||
}
|
||||
|
||||
if !reflect.DeepEqual(query, tt.want.query) {
|
||||
t.Errorf("wrong query: want: %v, (%T), got: %v, (%T)", tt.want.query, tt.want.query, query, query)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestNewNotQuery(t *testing.T) {
|
||||
|
||||
type args struct {
|
||||
query SearchQuery
|
||||
}
|
||||
|
||||
singleCorrectQuery, _ := NewTextQuery(testCol, "hello", TextEquals)
|
||||
|
||||
tests := []struct {
|
||||
name string
|
||||
args args
|
||||
want *NotQuery
|
||||
wantErr func(error) bool
|
||||
}{
|
||||
{
|
||||
name: "empty query",
|
||||
args: args{
|
||||
query: nil,
|
||||
},
|
||||
wantErr: func(err error) bool {
|
||||
return errors.Is(err, ErrMissingColumn)
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "correct",
|
||||
args: args{
|
||||
query: singleCorrectQuery,
|
||||
},
|
||||
want: &NotQuery{
|
||||
query: singleCorrectQuery,
|
||||
},
|
||||
},
|
||||
}
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
got, err := NewNotQuery(tt.args.query)
|
||||
if err != nil && tt.wantErr == nil {
|
||||
t.Errorf("NewNotQuery() no error expected got %v", err)
|
||||
return
|
||||
} else if tt.wantErr != nil && !tt.wantErr(err) {
|
||||
t.Errorf("NewNotQuery() unexpeted error = %v", err)
|
||||
return
|
||||
}
|
||||
if !reflect.DeepEqual(got, tt.want) {
|
||||
t.Errorf("NewNotQuery() = %v, want %v", got, tt.want)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestNotQuery_comp(t *testing.T) {
|
||||
q1, _ := NewTextQuery(testCol, "hello1", TextEquals)
|
||||
|
||||
type fields struct {
|
||||
query SearchQuery
|
||||
}
|
||||
type want struct {
|
||||
query interface{}
|
||||
isNil bool
|
||||
}
|
||||
tests := []struct {
|
||||
name string
|
||||
fields fields
|
||||
want want
|
||||
}{
|
||||
{
|
||||
name: "single input",
|
||||
fields: fields{
|
||||
query: q1,
|
||||
},
|
||||
want: want{
|
||||
query: &NotQuery{query: q1},
|
||||
},
|
||||
},
|
||||
}
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
s := &NotQuery{
|
||||
query: tt.fields.query,
|
||||
}
|
||||
query := s.comp()
|
||||
if query == nil && tt.want.isNil {
|
||||
return
|
||||
} else if tt.want.isNil && query != nil {
|
||||
t.Error("query should not be nil")
|
||||
}
|
||||
|
||||
if !reflect.DeepEqual(query, tt.want.query) {
|
||||
t.Errorf("wrong query: want: %v, (%T), got: %v, (%T)", tt.want.query, tt.want.query, query, query)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
func TestNotQuery_ToSql(t *testing.T) {
|
||||
q, _ := NewTextQuery(testCol, "hello1", TextEquals)
|
||||
type fields struct {
|
||||
query SearchQuery
|
||||
}
|
||||
type want struct {
|
||||
query string
|
||||
}
|
||||
tests := []struct {
|
||||
name string
|
||||
fields fields
|
||||
want want
|
||||
}{
|
||||
{
|
||||
name: "single input",
|
||||
fields: fields{
|
||||
query: q,
|
||||
},
|
||||
want: want{
|
||||
query: "NOT (test_table.test_col = hello1)",
|
||||
},
|
||||
},
|
||||
}
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
s := &NotQuery{
|
||||
query: tt.fields.query,
|
||||
}
|
||||
queryStr, _, err := s.ToSql()
|
||||
if err != nil {
|
||||
t.Error("an error raised ")
|
||||
}
|
||||
if queryStr == tt.want.query {
|
||||
t.Errorf("wrong query: want: %v, (%T), got: %v, (%T)", tt.want.query, tt.want.query, queryStr, queryStr)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestAndOrQueryCombo(t *testing.T) {
|
||||
q1, _ := NewTextQuery(testCol, "hello1", TextEquals)
|
||||
q2, _ := NewTextQuery(testCol, "hello2", TextEquals)
|
||||
q3, _ := NewTextQuery(testCol2, "world1", TextEquals)
|
||||
q4, _ := NewTextQuery(testCol2, "world2", TextEquals)
|
||||
andq, _ := NewAndQuery(q3, q4)
|
||||
orq, _ := NewOrQuery(q1, q2, andq)
|
||||
|
||||
type fields struct {
|
||||
query SearchQuery
|
||||
}
|
||||
type want struct {
|
||||
query interface{}
|
||||
isNil bool
|
||||
}
|
||||
tests := []struct {
|
||||
name string
|
||||
fields fields
|
||||
want want
|
||||
}{
|
||||
{
|
||||
name: "OR containing AND query",
|
||||
fields: fields{
|
||||
query: orq,
|
||||
},
|
||||
want: want{
|
||||
query: sq.Or{sq.Eq{"test_table.test_col": "hello1"}, sq.Eq{"test_table.test_col": "hello2"}, sq.And{sq.Eq{"test_table2.test_col2": "world1"}, sq.Eq{"test_table2.test_col2": "world2"}}},
|
||||
},
|
||||
},
|
||||
}
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
s := tt.fields.query
|
||||
query := s.comp()
|
||||
if query == nil && tt.want.isNil {
|
||||
return
|
||||
} else if tt.want.isNil && query != nil {
|
||||
t.Error("query should not be nil")
|
||||
}
|
||||
|
||||
if !reflect.DeepEqual(query, tt.want.query) {
|
||||
t.Errorf("wrong query: want: %v, (%T), got: %v, (%T)", tt.want.query, tt.want.query, query, query)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestNewInTextQuery(t *testing.T) {
|
||||
type args struct {
|
||||
column Column
|
||||
|
@@ -629,6 +629,15 @@ func (r *UserSearchQueries) AppendMyResourceOwnerQuery(orgID string) error {
|
||||
return nil
|
||||
}
|
||||
|
||||
func NewUserOrSearchQuery(values []SearchQuery) (SearchQuery, error) {
|
||||
return NewOrQuery(values...)
|
||||
}
|
||||
func NewUserAndSearchQuery(values []SearchQuery) (SearchQuery, error) {
|
||||
return NewAndQuery(values...)
|
||||
}
|
||||
func NewUserNotSearchQuery(value SearchQuery) (SearchQuery, error) {
|
||||
return NewNotQuery(value)
|
||||
}
|
||||
func NewUserInUserIdsSearchQuery(values []string) (SearchQuery, error) {
|
||||
return NewInTextQuery(UserIDCol, values)
|
||||
}
|
||||
|
@@ -149,7 +149,7 @@ func NewUserGrantWithGrantedQuery(owner string) (SearchQuery, error) {
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return newOrQuery(orgQuery, projectQuery)
|
||||
return NewOrQuery(orgQuery, projectQuery)
|
||||
}
|
||||
|
||||
func NewUserGrantContainsRolesSearchQuery(roles ...string) (SearchQuery, error) {
|
||||
|
Reference in New Issue
Block a user