GraphQL: DX Relational Where Query #6255

Moumouls · 2019-12-03T17:50:33Z

Allow to execute complexe relational queries like:

Query: Find countries containing companies that contains at least one employee named "John"

query {
  countries(where: {
    companies: { employees: { name: { equalTo: "John" } } },
  }) {
    edges {
      node {
        id
        objectId
        companies {
          edges {
            node {
              id
              objectId
              name
              employees {
                edges {
                  node {
                    name
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

This system works for Pointer and Relation Parse fields

codecov · 2019-12-03T19:17:08Z

Codecov Report

Merging #6255 into master will decrease coverage by 0.09%.
The diff coverage is 93.65%.

@@            Coverage Diff            @@
##           master    #6255     +/-   ##
=========================================
- Coverage   94.01%   93.92%   -0.1%     
=========================================
  Files         169      169             
  Lines       11529    11564     +35     
=========================================
+ Hits        10839    10861     +22     
- Misses        690      703     +13

Impacted Files	Coverage Δ
src/GraphQL/loaders/parseClassQueries.js	`97.95% <ø> (+0.08%)`	⬆️
src/GraphQL/loaders/parseClassTypes.js	`94.23% <100%> (-0.65%)`	⬇️
src/GraphQL/helpers/objectsQueries.js	`90.35% <100%> (ø)`	⬆️
src/GraphQL/loaders/defaultGraphQLTypes.js	`97.03% <100%> (ø)`	⬆️
src/GraphQL/transformers/constraintType.js	`86.95% <75%> (-8.05%)`	⬇️
src/GraphQL/transformers/query.js	`76.74% <93.75%> (+2.83%)`	⬆️
src/middlewares.js	`97.17% <0%> (-1.12%)`	⬇️
src/Adapters/Storage/Mongo/MongoStorageAdapter.js	`92.74% <0%> (-0.71%)`	⬇️
... and 7 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 1f54d02...e1be5ae. Read the comment docs.

Moumouls · 2019-12-03T19:17:51Z

Everything should be okay now 🚀

davimacedo

Great job! I have few comments.

davimacedo · 2019-12-03T20:07:14Z

src/GraphQL/loaders/defaultGraphQLTypes.js

@@ -964,8 +921,6 @@ const STRING_WHERE_INPUT = new GraphQLInputObjectType({
    in: inOp(GraphQLString),
    notIn: notIn(GraphQLString),
    exists,
-    inQueryKey,


I think we should not remove these options from string, float, id, etc. With these options, the users are currently able to do something like:

countries(where: { continent: { inQueryKey: { query: { className: "Country", where: { name: { equalTo: "US" } } }, key: "continent" } } }) { ... }

Hummm, from my point of view it's hard to understand this query without reading a documentation. The inQueryKey feature is interesting to implement but i think we need first to re-design the input before re-implementing this feature. 😄 ? like playing with Enum for key and className, but this is not the purpose of this PR... We need to avoid people using inputs that can be deprecated in a near futur 😄

So I think it would be better keep it here while we don't improve. Someone can be already using this feature and they will have no alternative.

src/GraphQL/loaders/parseClassTypes.js

src/GraphQL/transformers/constraintType.js

src/GraphQL/transformers/query.js

Moumouls · 2019-12-04T15:15:00Z

So, to avoid some confusion between regular where and relational where, and improve DX complex relational queries i choose to use key have & haveNot

I added support of exists on Relation too, via $inQuery

Result:

{
  countries(
    where: { companies: { haveNot: { name: { equalTo: "imACompany1" } }, } }
  ) {
    edges {
      node {
        name
        president {
          name
        }
        companies {
          edges {
            node {
              name
            }
          }
        }
      }
    }
  }
}

Moumouls · 2019-12-04T16:21:47Z

Tests are okay (postgres tested with my local set up), just (again) a Postgres fail...

dplewis · 2019-12-04T16:25:05Z

@vitaly-t We have a flaky test with Postgres on Travis-CI. here

could not write to file "pg_xlog/xlogtemp.8833": No space left on device

Is there a way to turn off WAL or logging? Any help would be appreciated.

davimacedo · 2019-12-04T17:55:15Z

@Moumouls great job with the have, haveNot, and exists!

I think have (and haveNot) are perfect names for the pointer:

persons(where: { spouse: { have: { name: { equalTo: "John" } } } }) { ... }

But for relation is little bit strange to me:

persons(where: { children: { have: { name: { equalTo: "John" } } } }) { ... }

It looks to me that it should only return persons whose ALL children have name equal to "John". But that's not the case, right?

I can't think a better name though. Maybe existWith? I am not good in giving names :) so if you prefer I am also okay in moving forward with the current ones.

Another minor comment. For relation, it should probably be better exist instead of exists:

countries(where: { companies: { exist: true } }) { ... }

davimacedo · 2019-12-04T17:58:36Z

@dplewis Postgres tests are hanging in many branches. Sometimes it works for all of them then it stops working for all of them. I guess it is a Travis issue or at least some misconfiguration from our side...

dplewis · 2019-12-04T17:59:24Z

@davimacedo I opened a PR to address this. Hopefully it works

vitaly-t · 2019-12-04T18:16:17Z

@dplewis I'm not sure about logging, as it does not seem relevant to the pg-promise library, which does not log those things...

Especially for the error related to writing something to a file. The library never writes anything to a file.

dplewis · 2019-12-04T19:20:13Z

@Moumouls The build should be good now.

Moumouls · 2019-12-04T22:34:09Z

@Moumouls great job with the have, haveNot, and exists!

I think have (and haveNot) are perfect names for the pointer:
persons(where: { spouse: { have: { name: { equalTo: "John" } } } }) { ... }
But for relation is little bit strange to me:
persons(where: { children: { have: { name: { equalTo: "John" } } } }) { ... }
It looks to me that it should only return persons whose ALL children have name equal to "John". But that's not the case, right?

I can't think a better name though. Maybe existWith? I am not good in giving names :) so if you prefer I am also okay in moving forward with the current ones.

Another minor comment. For relation, it should probably be better exist instead of exists:
countries(where: { companies: { exist: true } }) { ... }

I think we will keep the have, need more documentation on the field maybe.

davimacedo · 2019-12-04T23:30:11Z

Ok. No problem. Can you please only address my last open conversation and let's go to merge?

…rse-server into gql-relational-query

Moumouls · 2019-12-05T09:39:01Z

Seems to have a random should work either with global id or object id test

davimacedo

Nice job! LGTM!

* DX Relational Where Query * Remove WherePointer & fix tests * Add have, haveNot, exists on Pointer/Relation where input * Merge branch 'master' into gql-relational-query * Enable inQueryKey * better descrption

DX Relational Where Query

0dfe7c8

Moumouls requested a review from davimacedo December 3, 2019 17:50

Moumouls changed the title ~~GraphQL: Relational Where Query~~ GraphQL: DX Relational Where Query Dec 3, 2019

Remove WherePointer & fix tests

eb314e6

davimacedo reviewed Dec 3, 2019

View reviewed changes

Add have, haveNot, exists on Pointer/Relation where input

8255693

Merge branch 'master' into gql-relational-query

a910736

Moumouls added 3 commits December 5, 2019 10:13

Enable inQueryKey

7ab1f60

better descrption

9669df2

Merge branch 'gql-relational-query' of https://github.com/Moumouls/pa…

e1be5ae

…rse-server into gql-relational-query

Moumouls mentioned this pull request Dec 5, 2019

GraphQL Docs for Parse Server 3.10.0 parse-community/docs#688

Merged

davimacedo approved these changes Dec 5, 2019

View reviewed changes

davimacedo merged commit 5d76b2f into parse-community:master Dec 5, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

GraphQL: DX Relational Where Query #6255

GraphQL: DX Relational Where Query #6255

Moumouls commented Dec 3, 2019 •

edited

Loading

codecov bot commented Dec 3, 2019 •

edited

Loading

Moumouls commented Dec 3, 2019

davimacedo left a comment

davimacedo Dec 3, 2019

Moumouls Dec 4, 2019

davimacedo Dec 4, 2019

Moumouls commented Dec 4, 2019 •

edited

Loading

Moumouls commented Dec 4, 2019

dplewis commented Dec 4, 2019 •

edited

Loading

davimacedo commented Dec 4, 2019 •

edited

Loading

davimacedo commented Dec 4, 2019 •

edited

Loading

dplewis commented Dec 4, 2019 •

edited

Loading

vitaly-t commented Dec 4, 2019 •

edited

Loading

dplewis commented Dec 4, 2019

Moumouls commented Dec 4, 2019

davimacedo commented Dec 4, 2019

Moumouls commented Dec 5, 2019

davimacedo left a comment

GraphQL: DX Relational Where Query #6255

GraphQL: DX Relational Where Query #6255

Conversation

Moumouls commented Dec 3, 2019 • edited Loading

codecov bot commented Dec 3, 2019 • edited Loading

Codecov Report

Moumouls commented Dec 3, 2019

davimacedo left a comment

Choose a reason for hiding this comment

davimacedo Dec 3, 2019

Choose a reason for hiding this comment

Moumouls Dec 4, 2019

Choose a reason for hiding this comment

davimacedo Dec 4, 2019

Choose a reason for hiding this comment

Moumouls commented Dec 4, 2019 • edited Loading

Moumouls commented Dec 4, 2019

dplewis commented Dec 4, 2019 • edited Loading

davimacedo commented Dec 4, 2019 • edited Loading

davimacedo commented Dec 4, 2019 • edited Loading

dplewis commented Dec 4, 2019 • edited Loading

vitaly-t commented Dec 4, 2019 • edited Loading

dplewis commented Dec 4, 2019

Moumouls commented Dec 4, 2019

davimacedo commented Dec 4, 2019

Moumouls commented Dec 5, 2019

davimacedo left a comment

Choose a reason for hiding this comment

Moumouls commented Dec 3, 2019 •

edited

Loading

codecov bot commented Dec 3, 2019 •

edited

Loading

Moumouls commented Dec 4, 2019 •

edited

Loading

dplewis commented Dec 4, 2019 •

edited

Loading

davimacedo commented Dec 4, 2019 •

edited

Loading

davimacedo commented Dec 4, 2019 •

edited

Loading

dplewis commented Dec 4, 2019 •

edited

Loading

vitaly-t commented Dec 4, 2019 •

edited

Loading