[master < T0869] Implement GraphQL compatibility #1018

gvolfing · 2023-06-16T11:45:12Z

Closes #869

Initial version of an e2e testing framework that can be used to run graphql queries end to end with memgraph. For the 'create' graphql query to work, the awesome memgraph function, randomUUID, had to be added. Further more a temporary query module is loaded in the workload to emulate the initial query to the database. This should be changed later.

The incoming queries should be inspected and certain keywords should be swapped into memgraph specific ones. As this is modifying the query string itself, the interpreter should not be modified because of this.

src/query/graphql_checker.hpp

The added procedures can not be named mgp.*, that way they won't show up in the module registry. The path to the GraphQL library specifying js files has been changed.

The util.validate procedure could not be added as a simple query procedure, because the procedure itself does not return anything, which is something we do not support atm, and we do not have the ability to evaluate expressions from query procedures. They it has been solved, is that the during parsing, we check if the given CALL procedure does not YIELD, and if the fully qualified name of the procedure matches util.validate and based on this, we can instantiate an appropriate cursur and put that into the pull-chain instead of the regular CallProcedureCursor. On top of this '_' is sometimes generated as a variable name we did not support. Support for that has been added as well.

Add config js files to be able to test graphql capabilites against basic CRUD operations. Add a setup file that is installing the dependencies.

src/memgraph.cpp

src/query/frontend/ast/ast.hpp

src/query/frontend/ast/cypher_main_visitor.cpp

src/query/procedure/graphql_checker.cpp

Add tests to be able to test the basic CRUD functionality of memgraph when running it against GraphQL.

Instead of hardcoding the mappings in memory, use a json config file to read in the mappings between procedure names. Add flag 'callable_mappings_path' to be able to specify the path to said config file. Make names more generic.

andrejtonev

Looks OK, main issue I have is that the CALL without YIELD logic should be generic and not implemented to work just for the validate procedure. Other than that, it's mostly just some small comments.
I also think we are calling FindAlias twice when we could call it just once.

init

src/query/frontend/ast/ast.hpp

src/query/frontend/ast/cypher_main_visitor.cpp

src/query/plan/operator.cpp

src/query/procedure/callable_alias_mapper.cpp

src/query/procedure/module.cpp

src/query/frontend/ast/cypher_main_visitor.cpp

as51340

Nice job gabor! I added some comments, let me know what you think

init

src/query/frontend/opencypher/grammar/MemgraphCypherLexer.g4

src/query/plan/operator.cpp

tests/e2e/graphql/graphql_server.py

tests/e2e/graphql/graphql_crud.py

tests/setup.sh

src/query/frontend/ast/cypher_main_visitor.cpp

src/query/plan/operator.cpp

as51340

Comments about existing stuff and few smaller things

init

src/query/plan/operator.cpp

src/query/procedure/callable_alias_mapper.cpp

tests/e2e/graphql/graphql_crud.py

tests/e2e/graphql/temporary_procedures/mgps.py

Added additional sleepint to the startup process as it seems that other parts of the testing setup are not finished initializing as the GraphQL server itself. Reversed logic when reading the alias mapping config.

src/memgraph.cpp

Make sure nothing runs on the dedicated port upon process startup, this can be problematic if the process was stuck before, than the subsequent process spawn attempts will be meaningless.

There was a slight linking issue with adding query realated objects, like TypedValue to utils, so a templated class has been used instead. A concepts that enforces the used functions of TypedValue has been created and a Dummy mock version of it is being used in the unit tests.

as51340

I really like the refactoring job you made and have just 2-3 more questions/suggestions.

init

tests/e2e/graphql/workloads.yaml

src/utils/java_string_formatter.hpp

katarinasupe · 2023-07-28T11:40:33Z

Trying to run create mutation and get the following error message:
"message": "There is no procedure named 'dbms.components'."
The flag callable_mappings_path is set to /home/ubuntu/memgraph/build/settings-graphql.json and the content of that is:

{
"dbms.components": "mgps.components",
"apoc.util.validate": "mgps.validate"
}

What am I doing wrong here?

gvolfing · 2023-07-28T12:23:57Z

@katarinasupe
We need another query module to be able to communicate with the GraphQL Server.
Take the one that already exist on memgraph/tests/e2e/graphql/temporary_procedures/mgps.py copy that somewhere and specify the path to its containing directory with the --query-modules-directory flag, that should load the query module on startup, so the alias mapping should find it when the GraphQL Library sends it through bolt protocol.

katarinasupe · 2023-07-28T15:04:58Z

By running delete query, I got Error message: Query should either create or update something, or return results! when wanting to run MATCH (n)-[r]->(m) RETURN r, n, m after deletion. I tried running that query two times, and I did not succeed. Then I ran MATCH (n) RETURN n, got weird results in Lab and then I managed to run MATCH (n)-[r]->(m) RETURN r, n, m successfully. After running the delete, and doing other stuff in db, then running MATCH (n) RETURN n again, I randomly reproduce the same error.

Weird results in Lab (this is style related and style depends on Labels + properties so I would say it's that kind of issues, something doing with Node objects not being good):

logs:

[2023-07-28 14:51:03.967] [memgraph_log] [debug] [Run] 'MATCH (this:`Post`)
WHERE this.content = $param0
DETACH DELETE this'
[2023-07-28 14:51:04.043] [memgraph_log] [debug] [Run] 'SHOW STORAGE INFO'
[2023-07-28 14:51:04.150] [memgraph_log] [debug] [Run] 'MATCH (APP_INTERNAL_EXEC_VAR) return COUNT(APP_INTERNAL_EXEC_VAR) as cnt'
[2023-07-28 14:51:07.042] [memgraph_log] [debug] [Run] 'SHOW STORAGE INFO'
[2023-07-28 14:51:07.146] [memgraph_log] [debug] [Run] 'MATCH (APP_INTERNAL_EXEC_VAR) return COUNT(APP_INTERNAL_EXEC_VAR) as cnt'
[2023-07-28 14:51:10.040] [memgraph_log] [debug] [Run] 'SHOW STORAGE INFO'
[2023-07-28 14:51:10.144] [memgraph_log] [debug] [Run] 'MATCH (APP_INTERNAL_EXEC_VAR) return COUNT(APP_INTERNAL_EXEC_VAR) as cnt'
[2023-07-28 14:51:12.254] [memgraph_log] [debug] [Run] 'MATCH (n)-[r]->(m)'
[2023-07-28 14:51:12.255] [memgraph_log] [trace] Error message: Query should either create or update something, or return results!
[2023-07-28 14:51:12.318] [memgraph_log] [trace] Reset received
[2023-07-28 14:51:13.044] [memgraph_log] [debug] [Run] 'SHOW STORAGE INFO'
[2023-07-28 14:51:13.159] [memgraph_log] [debug] [Run] 'MATCH (APP_INTERNAL_EXEC_VAR) return COUNT(APP_INTERNAL_EXEC_VAR) as cnt'
[2023-07-28 14:51:16.040] [memgraph_log] [debug] [Run] 'SHOW STORAGE INFO'
[2023-07-28 14:51:16.157] [memgraph_log] [debug] [Run] 'MATCH (APP_INTERNAL_EXEC_VAR) return COUNT(APP_INTERNAL_EXEC_VAR) as cnt'
[2023-07-28 14:51:17.110] [memgraph_log] [debug] [Run] 'MATCH (n)-[r]->(m)'
[2023-07-28 14:51:17.110] [memgraph_log] [trace] Error message: Query should either create or update something, or return results!
[2023-07-28 14:51:17.162] [memgraph_log] [trace] Reset received
[2023-07-28 14:51:19.076] [memgraph_log] [debug] [Run] 'SHOW STORAGE INFO'
[2023-07-28 14:51:19.191] [memgraph_log] [debug] [Run] 'MATCH (APP_INTERNAL_EXEC_VAR) return COUNT(APP_INTERNAL_EXEC_VAR) as cnt'
[2023-07-28 14:51:22.044] [memgraph_log] [debug] [Run] 'SHOW STORAGE INFO'
[2023-07-28 14:51:22.156] [memgraph_log] [debug] [Run] 'MATCH (APP_INTERNAL_EXEC_VAR) return COUNT(APP_INTERNAL_EXEC_VAR) as cnt'
[2023-07-28 14:51:24.618] [memgraph_log] [debug] [Run] 'MATCH (n)

RETURN n'
[2023-07-28 14:51:25.042] [memgraph_log] [debug] [Run] 'SHOW STORAGE INFO'
[2023-07-28 14:51:25.147] [memgraph_log] [debug] [Run] 'MATCH (APP_INTERNAL_EXEC_VAR) return COUNT(APP_INTERNAL_EXEC_VAR) as cnt'
[2023-07-28 14:51:28.041] [memgraph_log] [debug] [Run] 'SHOW STORAGE INFO'
[2023-07-28 14:51:28.146] [memgraph_log] [debug] [Run] 'MATCH (APP_INTERNAL_EXEC_VAR) return COUNT(APP_INTERNAL_EXEC_VAR) as cnt'
[2023-07-28 14:51:31.054] [memgraph_log] [debug] [Run] 'SHOW STORAGE INFO'
[2023-07-28 14:51:31.169] [memgraph_log] [debug] [Run] 'MATCH (APP_INTERNAL_EXEC_VAR) return COUNT(APP_INTERNAL_EXEC_VAR) as cnt'
[2023-07-28 14:51:34.049] [memgraph_log] [debug] [Run] 'SHOW STORAGE INFO'
[2023-07-28 14:51:34.155] [memgraph_log] [debug] [Run] 'MATCH (APP_INTERNAL_EXEC_VAR) return COUNT(APP_INTERNAL_EXEC_VAR) as cnt'
[2023-07-28 14:51:37.041] [memgraph_log] [debug] [Run] 'SHOW STORAGE INFO'
[2023-07-28 14:51:37.145] [memgraph_log] [debug] [Run] 'MATCH (APP_INTERNAL_EXEC_VAR) return COUNT(APP_INTERNAL_EXEC_VAR) as cnt'
[2023-07-28 14:51:40.044] [memgraph_log] [debug] [Run] 'SHOW STORAGE INFO'
[2023-07-28 14:51:40.181] [memgraph_log] [debug] [Run] 'MATCH (APP_INTERNAL_EXEC_VAR) return COUNT(APP_INTERNAL_EXEC_VAR) as cnt'
[2023-07-28 14:51:43.043] [memgraph_log] [debug] [Run] 'SHOW STORAGE INFO'
[2023-07-28 14:51:43.169] [memgraph_log] [debug] [Run] 'MATCH (APP_INTERNAL_EXEC_VAR) return COUNT(APP_INTERNAL_EXEC_VAR) as cnt'
[2023-07-28 14:51:45.331] [memgraph_log] [debug] [Run] 'MATCH (n)-[r]->(m)

RETURN n,r,m'
[2023-07-28 14:51:46.047] [memgraph_log] [debug] [Run] 'SHOW STORAGE INFO'

Here are the steps to reproduce:

Load the dataset. Here is cypherl:

CREATE INDEX ON :__mg_vertex__(__mg_id__);
CREATE (:__mg_vertex__:`User` {__mg_id__: 0, `name`: "katarina", `id`: "06daddb7-1657-4e6a-8a7d-b11ec6d2698f"});
CREATE (:__mg_vertex__:`Post` {__mg_id__: 2, `id`: "69626a62-ac56-4681-bc52-af6f28e97ffb", `content`: "new hello world!"});
CREATE (:__mg_vertex__:`User` {__mg_id__: 3, `name`: "karmen", `id`: "938ab1fd-f70a-4026-933c-9c83a11a8738"});
CREATE (:__mg_vertex__:`User` {__mg_id__: 4, `name`: "ante", `id`: "f4d847df-8c97-4c16-bd06-1141010e2961"});
CREATE (:__mg_vertex__:`User` {__mg_id__: 5, `name`: "buda", `id`: "e79e2279-df6f-4d52-9742-c588b26897c0"});
CREATE (:__mg_vertex__:`Post` {__mg_id__: 7, `id`: "c5c27035-c075-4c07-a96d-9e9f0e1b8ca9", `content`: "Another post!"});
CREATE (:__mg_vertex__:`Post` {__mg_id__: 8, `content`: "New post!"});
MATCH (u:__mg_vertex__), (v:__mg_vertex__) WHERE u.__mg_id__ = 0 AND v.__mg_id__ = 2 CREATE (u)-[:`HAS_POST`]->(v);
MATCH (u:__mg_vertex__), (v:__mg_vertex__) WHERE u.__mg_id__ = 3 AND v.__mg_id__ = 8 CREATE (u)-[:`HAS_POST`]->(v);
MATCH (u:__mg_vertex__), (v:__mg_vertex__) WHERE u.__mg_id__ = 4 AND v.__mg_id__ = 7 CREATE (u)-[:`HAS_POST`]->(v);
DROP INDEX ON :__mg_vertex__(__mg_id__);
MATCH (u) REMOVE u:__mg_vertex__, u.__mg_id__;

Run the following mutation:

mutation {
  deletePosts(where: {content: "New post!"}){
    nodesDeleted,
    relationshipsDeleted
  }
}

Try running MATCH queries in db (I reproduced it with MATCH (n)-[r]->(m) RETURN r, n, m and MATCH (n) RETURN n

katarinasupe · 2023-07-28T15:25:05Z

@gvolfing please ignore my bug report above. I used the older version of Lab (2.7.0) and hence experienced such issues since I was running with 'Run selected' which was not working well. When I updated to Lab 2.7.1, deletes are working as expected so far.

katarinasupe · 2023-07-28T15:48:06Z

I tried out some basic queries and aggregation queries. I also tried to create, update and delete mutations. Let me know if something needs to be added. My test examples and dataset can be found in Notion under Testing.

src/memgraph.cpp

* Add callable mappings feature * Implement mgps.validate (void procedure) * Make '_' a valid variable name

gvolfing mentioned this pull request May 18, 2023

Implement GraphQL compatibility #869

Closed

1 task

Add query inspection before the interpreter

ceb9160

The incoming queries should be inspected and certain keywords should be swapped into memgraph specific ones. As this is modifying the query string itself, the interpreter should not be modified because of this.

gitbuda reviewed Jun 21, 2023

View reviewed changes

src/query/graphql_checker.hpp Outdated Show resolved Hide resolved

gvolfing self-assigned this Jun 22, 2023

gitbuda added this to the mg-v2.10.0 milestone Jun 22, 2023

gvolfing added 3 commits June 26, 2023 14:34

Fix failing graphql library initialization

91aaaed

The added procedures can not be named mgp.*, that way they won't show up in the module registry. The path to the GraphQL library specifying js files has been changed.

Add graphql config files for CRUD testing

2524517

Add config js files to be able to test graphql capabilites against basic CRUD operations. Add a setup file that is installing the dependencies.

gitbuda reviewed Jul 19, 2023

View reviewed changes

src/memgraph.cpp Outdated Show resolved Hide resolved

gitbuda reviewed Jul 19, 2023

View reviewed changes

src/query/frontend/ast/ast.hpp Outdated Show resolved Hide resolved

gitbuda reviewed Jul 19, 2023

View reviewed changes

src/query/frontend/ast/cypher_main_visitor.cpp Outdated Show resolved Hide resolved

gitbuda reviewed Jul 19, 2023

View reviewed changes

src/query/procedure/graphql_checker.cpp Outdated Show resolved Hide resolved

gvolfing and others added 7 commits July 20, 2023 16:10

Add testing for CRUD operations through GraphQL

67955eb

Add tests to be able to test the basic CRUD functionality of memgraph when running it against GraphQL.

Rearrange include order, remove print() from test

53a5914

Read in procedure aliases from a file

bc78692

Instead of hardcoding the mappings in memory, use a json config file to read in the mappings between procedure names. Add flag 'callable_mappings_path' to be able to specify the path to said config file. Make names more generic.

Add proper setup to run graphql e2e test under CI

b3b2454

Change hardcoded paths to relative ones

582d6bd

Merge branch 'master' into T0869-MG-implement-graphql-compatibility

85c645a

NOLINTNEXTLINE

644a2b7

andrejtonev reviewed Jul 24, 2023

View reviewed changes

Rename variables, remove unused ones.

740419e

gvolfing marked this pull request as ready for review July 25, 2023 10:55

gvolfing requested review from as51340 and andrejtonev July 25, 2023 10:55

gvolfing added 2 commits July 25, 2023 13:16

Modify npm packaging

f28e320

Deleted package-lock.json

6237f16

as51340 requested changes Jul 25, 2023

View reviewed changes

memgraph deleted a comment from as51340 Jul 25, 2023

as51340 reviewed Jul 25, 2023

View reviewed changes

src/query/plan/operator.cpp Outdated Show resolved Hide resolved

as51340 requested changes Jul 27, 2023

View reviewed changes

Fix failing graphql e2e tests

b0fa66f

Added additional sleepint to the startup process as it seems that other parts of the testing setup are not finished initializing as the GraphQL server itself. Reversed logic when reading the alias mapping config.

gitbuda reviewed Jul 27, 2023

View reviewed changes

src/memgraph.cpp Outdated Show resolved Hide resolved

gvolfing added 6 commits July 27, 2023 10:32

Improve process initialization of e2e framework

78d6125

Make sure nothing runs on the dedicated port upon process startup, this can be problematic if the process was stuck before, than the subsequent process spawn attempts will be meaningless.

React to PR comments

892a89a

Merge branch 'master' into T0869-MG-implement-graphql-compatibility

bf4c8fe

Correct assertions

b2cd12f

Refactor e2e graphql tests.

e297aed

gvolfing requested review from andrejtonev and as51340 July 27, 2023 19:43

as51340 approved these changes Jul 28, 2023

View reviewed changes

init Show resolved Hide resolved

tests/e2e/graphql/workloads.yaml Show resolved Hide resolved

src/utils/java_string_formatter.hpp Show resolved Hide resolved

gitbuda and others added 2 commits July 28, 2023 11:13

Unify node version setup

066b269

Increase timeout that waits memgraph to start up

d71c49b

Merge branch 'master' into T0869-MG-implement-graphql-compatibility

d33720c

gitbuda reviewed Jul 31, 2023

View reviewed changes

src/memgraph.cpp Outdated Show resolved Hide resolved

gvolfing added 5 commits July 31, 2023 09:13

Improve checking for initialized subprocesses

246c527

Rename callable mapping flag

496c664

Enhance e2e tests with on-disk workload

930163e

Merge branch 'master' into T0869-MG-implement-graphql-compatibility

a3530e9

Resolve failing build after merge

99232f8

gitbuda approved these changes Jul 31, 2023

View reviewed changes

gitbuda merged commit 210bea8 into master Jul 31, 2023
6 checks passed

gitbuda deleted the T0869-MG-implement-graphql-compatibility branch July 31, 2023 12:48

as51340 pushed a commit that referenced this pull request Nov 10, 2023

Add GraphQL transpilation compatibility (#1018)

91d9795

* Add callable mappings feature * Implement mgps.validate (void procedure) * Make '_' a valid variable name

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[master < T0869] Implement GraphQL compatibility #1018

[master < T0869] Implement GraphQL compatibility #1018

gvolfing commented Jun 16, 2023 •

edited by gitbuda

Loading

andrejtonev left a comment

as51340 left a comment

as51340 left a comment

as51340 left a comment •

edited

Loading

katarinasupe commented Jul 28, 2023

gvolfing commented Jul 28, 2023

katarinasupe commented Jul 28, 2023

katarinasupe commented Jul 28, 2023

katarinasupe commented Jul 28, 2023 •

edited

Loading

[master < T0869] Implement GraphQL compatibility #1018

[master < T0869] Implement GraphQL compatibility #1018

Conversation

gvolfing commented Jun 16, 2023 • edited by gitbuda Loading

andrejtonev left a comment

Choose a reason for hiding this comment

as51340 left a comment

Choose a reason for hiding this comment

as51340 left a comment

Choose a reason for hiding this comment

as51340 left a comment • edited Loading

Choose a reason for hiding this comment

katarinasupe commented Jul 28, 2023

gvolfing commented Jul 28, 2023

katarinasupe commented Jul 28, 2023

katarinasupe commented Jul 28, 2023

katarinasupe commented Jul 28, 2023 • edited Loading

gvolfing commented Jun 16, 2023 •

edited by gitbuda

Loading

as51340 left a comment •

edited

Loading

katarinasupe commented Jul 28, 2023 •

edited

Loading