Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(GraphQL): Support auth with custom DQL #7775

Merged
merged 37 commits into from
May 26, 2021
Merged
Show file tree
Hide file tree
Changes from 27 commits
Commits
Show all changes
37 commits
Select commit Hold shift + click to select a range
3323ed7
initial commit
minhaj-shakeel May 3, 2021
389349e
minor fix
minhaj-shakeel May 3, 2021
84c82c5
change Root Query
minhaj-shakeel May 4, 2021
8dec57e
add support for @groupby in AsString
minhaj-shakeel May 4, 2021
41a4eac
attach rewriter to custom resolver
minhaj-shakeel May 4, 2021
af4479b
add unit tests
minhaj-shakeel May 4, 2021
1e048ce
minor fix
minhaj-shakeel May 6, 2021
e74fadb
support for multiple query blocks
minhaj-shakeel May 6, 2021
04e5502
support var query with rbac = Negative
minhaj-shakeel May 6, 2021
181684d
fix AsString
minhaj-shakeel May 7, 2021
f050f8d
fix test case
minhaj-shakeel May 7, 2021
2afba2a
add auth rules on children
minhaj-shakeel May 10, 2021
d4f0031
fix var block auth query
minhaj-shakeel May 10, 2021
0b295b7
fix test name
minhaj-shakeel May 10, 2021
c6e8e2a
fix AsString
minhaj-shakeel May 10, 2021
fa81419
fix AsString
minhaj-shakeel May 10, 2021
9fbe48f
insert quotes in the argument
minhaj-shakeel May 11, 2021
4da6db7
remove redundant function
minhaj-shakeel May 11, 2021
188a4d2
fix for filter arguments
minhaj-shakeel May 11, 2021
b4977db
handle filter attribute
minhaj-shakeel May 11, 2021
f45a91f
fix rewriting of test cases
minhaj-shakeel May 11, 2021
55149db
add some comments
minhaj-shakeel May 11, 2021
f786c23
modify unit tests
minhaj-shakeel May 11, 2021
b19f215
handle has function
minhaj-shakeel May 12, 2021
c124b59
add e2e test cases
minhaj-shakeel May 12, 2021
f4bcf9c
fix var query for RBAC negative
minhaj-shakeel May 12, 2021
b54cc0c
fix test
minhaj-shakeel May 12, 2021
ba1aa4a
address comments
minhaj-shakeel May 13, 2021
e8a3de4
add e2e test for interface auth
minhaj-shakeel May 17, 2021
84f1af2
clean code
minhaj-shakeel May 17, 2021
8359e73
add example of order
minhaj-shakeel May 17, 2021
0abd898
add e2e case for interfaces
minhaj-shakeel May 17, 2021
7e21e44
minor fix
minhaj-shakeel May 17, 2021
434cdcd
fmt
minhaj-shakeel May 17, 2021
a1f7cad
address Rajas's comments
minhaj-shakeel May 24, 2021
209e2de
fix indent
minhaj-shakeel May 24, 2021
fee9e14
add Todo
minhaj-shakeel May 24, 2021
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
119 changes: 109 additions & 10 deletions graphql/dgraph/graphquery.go
Original file line number Diff line number Diff line change
Expand Up @@ -65,10 +65,24 @@ func writeQuery(b *strings.Builder, query *gql.GraphQuery, prefix string) {
x.Check2(b.WriteString(query.Alias))
x.Check2(b.WriteString(" : "))
}
x.Check2(b.WriteString(query.Attr))

if query.IsCount {
x.Check2(b.WriteString(fmt.Sprintf("count(%s)", query.Attr)))
} else if query.Attr != "val" {
x.Check2(b.WriteString(query.Attr))
} else if isAggregateFn(query.Func) {
x.Check2(b.WriteString("sum(val("))
writeNeedVar(b, query)
x.Check2(b.WriteRune(')'))
} else {
x.Check2(b.WriteString("val("))
writeNeedVar(b, query)
x.Check2(b.WriteRune(')'))
}

if query.Func != nil {
writeRoot(b, query)
x.Check2(b.WriteRune(')'))
}

if query.Filter != nil {
Expand All @@ -93,6 +107,12 @@ func writeQuery(b *strings.Builder, query *gql.GraphQuery, prefix string) {
}
}

if query.IsGroupby {
x.Check2(b.WriteString(" @groupby("))
writeGroupByAttributes(b, query.GroupbyAttrs)
x.Check2(b.WriteRune(')'))
}

switch {
case len(query.Children) > 0:
prefixAdd := ""
Expand All @@ -112,7 +132,40 @@ func writeQuery(b *strings.Builder, query *gql.GraphQuery, prefix string) {
}
}

func writeUIDFunc(b *strings.Builder, uids []uint64, args []gql.Arg) {
func writeNeedVar(b *strings.Builder, query *gql.GraphQuery) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

add a comment

for i, v := range query.NeedsVar {
if i != 0 {
x.Check2(b.WriteString(", "))
}
x.Check2(b.WriteString(v.Name))
}
}

func isAggregateFn(f *gql.Function) bool {
if f == nil {
return false
}
switch f.Name {
case "min", "max", "avg", "sum":
return true
}
return false
}

func writeGroupByAttributes(b *strings.Builder, attrList []gql.GroupByAttr) {
for i, attr := range attrList {
if i != 0 {
x.Check2(b.WriteString(", "))
}
if attr.Alias != "" {
x.Check2(b.WriteString(attr.Alias))
x.Check2(b.WriteString(" : "))
}
x.Check2(b.WriteString(attr.Attr))
}
}

func writeUIDFunc(b *strings.Builder, uids []uint64, args []gql.Arg, needVar []gql.VarContext) {
x.Check2(b.WriteString("uid("))
if len(uids) > 0 {
// uid function with uint64 - uid(0x123, 0x456, ...)
Expand All @@ -122,14 +175,21 @@ func writeUIDFunc(b *strings.Builder, uids []uint64, args []gql.Arg) {
}
x.Check2(b.WriteString(fmt.Sprintf("%#x", uid)))
}
} else {
} else if len(args) > 0 {
// uid function with a Dgraph query variable - uid(Post1)
for i, arg := range args {
if i != 0 {
x.Check2(b.WriteString(", "))
}
x.Check2(b.WriteString(arg.Value))
}
} else {
for i, v := range needVar {
if i != 0 {
x.Check2(b.WriteString(", "))
}
x.Check2(b.WriteString(v.Name))
}
}
x.Check2(b.WriteString(")"))
}
Expand All @@ -145,25 +205,49 @@ func writeRoot(b *strings.Builder, q *gql.GraphQuery) {
}

switch {
case q.Func.Name == "has":
x.Check2(b.WriteString(fmt.Sprintf("(func: has(%s)", q.Func.Attr)))
case q.Func.Name == "uid":
x.Check2(b.WriteString("(func: "))
writeUIDFunc(b, q.Func.UID, q.Func.Args)
writeUIDFunc(b, q.Func.UID, q.Func.Args, q.Func.NeedsVar)
case q.Func.Name == "type" && len(q.Func.Args) == 1:
x.Check2(b.WriteString(fmt.Sprintf("(func: type(%s)", q.Func.Args[0].Value)))
case q.Func.Name == "eq":
x.Check2(b.WriteString("(func: eq("))
writeFilterArguments(b, q.Func.Args)
writeFilterArguments(b, q.Func.Args, q.Func.Attr, q.Func.Name)
x.Check2(b.WriteRune(')'))
}
writeOrderAndPage(b, q, true)
x.Check2(b.WriteRune(')'))
}

func writeFilterArguments(b *strings.Builder, args []gql.Arg) {
func maybeQuoteArg(fn string, arg interface{}) string {
switch arg := arg.(type) {
case string: // dateTime also parsed as string
if fn == "regexp" {
return arg
}
return fmt.Sprintf("%q", arg)
case float64, float32:
return fmt.Sprintf("\"%v\"", arg)
default:
return fmt.Sprintf("%v", arg)
}
}

func writeFilterArguments(b *strings.Builder, args []gql.Arg, attr, fn string) {
if attr != "" {
x.Check2(b.WriteString(attr))
if len(args) != 0 {
x.Check2(b.WriteString(", "))
}
}
for i, arg := range args {
if i != 0 {
x.Check2(b.WriteString(", "))
}
if attr != "" {
arg.Value = maybeQuoteArg(fn, arg.Value)
}
x.Check2(b.WriteString(arg.Value))
}
}
Expand All @@ -175,10 +259,10 @@ func writeFilterFunction(b *strings.Builder, f *gql.Function) {

switch {
case f.Name == "uid":
writeUIDFunc(b, f.UID, f.Args)
writeUIDFunc(b, f.UID, f.Args, f.NeedsVar)
default:
x.Check2(b.WriteString(fmt.Sprintf("%s(", f.Name)))
writeFilterArguments(b, f.Args)
writeFilterArguments(b, f.Args, f.Attr, f.Name)
x.Check2(b.WriteRune(')'))
}
}
Expand Down Expand Up @@ -215,6 +299,15 @@ func hasOrderOrPage(q *gql.GraphQuery) bool {
return len(q.Order) > 0 || hasFirst || hasOffset
}

func IsValueVar(attr string, q *gql.GraphQuery) bool {
for _, vars := range q.NeedsVar {
if attr == vars.Name && vars.Typ == 2 {
return true
}
}
return false
}

func writeOrderAndPage(b *strings.Builder, query *gql.GraphQuery, root bool) {
var wroteOrder, wroteFirst bool

Expand All @@ -227,7 +320,13 @@ func writeOrderAndPage(b *strings.Builder, query *gql.GraphQuery, root bool) {
} else {
x.Check2(b.WriteString("orderasc: "))
}
x.Check2(b.WriteString(ord.Attr))
if IsValueVar(ord.Attr, query) {
x.Check2(b.WriteString("val("))
x.Check2(b.WriteString(ord.Attr))
x.Check2(b.WriteRune(')'))
} else {
x.Check2(b.WriteString(ord.Attr))
}
wroteOrder = true
}

Expand Down
116 changes: 116 additions & 0 deletions graphql/e2e/auth/auth_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -322,6 +322,122 @@ func (s Student) add(t *testing.T) {
require.JSONEq(t, result, string(gqlResponse.Data))
}

func TestAuthWithCustomDQL(t *testing.T) {
TestCases := []TestCase{
{
name: "RBAC OR filter query; RBAC Pass",
query: `
query{
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: indent

queryProjectsOrderByName{
name
}
}
`,
role: "ADMIN",
result: `{"queryProjectsOrderByName":[{"name": "Project1"},{"name": "Project2"}]}`,
},
{
name: "RBAC OR filter query; RBAC fail",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: RBAC false or user1 projects.

query: `
query{
queryProjectsOrderByName{
name
}
}
`,
role: "USER",
user: "user1",
result: `{"queryProjectsOrderByName":[{"name": "Project1"}]}`,
},
{
name: "RBAC OR filter query; missing jwt",
query: `
query{
queryProjectsOrderByName{
name
}
}
`,
result: `{"queryProjectsOrderByName":[]}`,
},
{
name: "var query; RBAC AND filter query; RBAC pass",
query: `
query{
queryIssueSortedByOwnerAge{
msg
}
}
`,
role: "ADMIN",
user: "user2",
result: `{"queryIssueSortedByOwnerAge": [{"msg": "Issue2"}]}`,
},
{
name: "var query; RBAC AND filter query; RBAC fail",
query: `
query{
queryIssueSortedByOwnerAge{
msg
}
}
`,
role: "USER",
user: "user2",
result: `{"queryIssueSortedByOwnerAge": []}`,
},
{
name: "DQL query with @cascade and pagination",
query: `
query{
queryFirstTwoMovieWithNonNullRegion{
content
code
regionsAvailable{
name
}
}
}
`,
role: "ADMIN",
user: "user1",
result: `{"queryFirstTwoMovieWithNonNullRegion": [
{
"content": "Movie3",
"code": "m3",
"regionsAvailable": [
{
"name": "Region1"
}
]
},
{
"content": "Movie4",
"code": "m4",
"regionsAvailable": [
{
"name": "Region5"
}
]
}
]
}`,
},
}

for _, tcase := range TestCases {
t.Run(tcase.name, func(t *testing.T) {
getUserParams := &common.GraphQLParams{
Headers: common.GetJWT(t, tcase.user, tcase.role, metaInfo),
Query: tcase.query,
}
gqlResponse := getUserParams.ExecuteAsPost(t, common.GraphqlURL)
common.RequireNoGQLErrors(t, gqlResponse)
require.JSONEq(t, tcase.result, string(gqlResponse.Data))
})
}
}

func TestAddMutationWithXid(t *testing.T) {
mutation := `
mutation addTweets($tweet: AddTweetsInput!){
Expand Down
Loading