Merge pull request #2769 from angrykoala/remove-run-first-column

Remove run first column

Author: angrykoala

.changeset/orange-bats-add.md

@@ -0,0 +1,21 @@
+---
+"@neo4j/graphql": major
+---
+
+`@cypher` directive now requires the parameter `columnName`.
+
+This requires all cypher queries to be made with a valid alias that must be referred in this new parameter.
+
+For Example:
+
+**@neo4j/graphql@3**
+
+```
+@cypher(statement: "MATCH (i:Item) WHERE i.public=true RETURN i.name")
+```
+
+**@neo4j/graphql@4**
+
+```
+@cypher(statement: "MATCH (i:Item) WHERE i.public=true RETURN i.name as result", columnName: "result")
+```

docs/contributing/DEVELOPING.md

@@ -113,6 +113,14 @@ run the following from `packages/graphql`:
 yarn test:tck
 ```
 
+### Verify TCK Tests
+
+You can run all the TCK tests against the database to check that the Cypher generated is valid. This can be done with the env variable `VERIFY_TCK`
+
+```bash
+VERIFY_TCK yarn test:tck
+```
+
 ### Testing using docker
 
 ```bash

examples/neo-place/typedefs.graphql

@@ -12,6 +12,7 @@ type Query {
             ORDER BY p.position ASC
             RETURN collect(color) as canvas
             """
+            columnName: "canvas"
         )
         @auth(rules: [{ isAuthenticated: true }])
 }

examples/neo-push/server/src/gql/Blog.ts

@@ -14,6 +14,7 @@ export const typeDefs = gql`
                 WITH creator IS NOT NULL AS isCreator
                 RETURN isCreator
                 """
+                columnName: "isCreator"
             )
         isAuthor: Boolean
             @cypher(
@@ -22,6 +23,7 @@ export const typeDefs = gql`
                 WITH author IS NOT NULL AS isAuthor
                 RETURN isAuthor
                 """
+                columnName: "isAuthor"
             )
         createdAt: DateTime @timestamp(operations: [CREATE])
         updatedAt: DateTime @timestamp(operations: [UPDATE])

examples/neo-push/server/src/gql/Comment.ts

@@ -21,6 +21,7 @@ export const typeDefs = gql`
                 ) AS canDelete
                 RETURN canDelete
                 """
+                columnName: "canDelete"
             )
         createdAt: DateTime @timestamp(operations: [CREATE])
         updatedAt: DateTime @timestamp(operations: [UPDATE])

examples/neo-push/server/src/gql/Post.ts

@@ -22,6 +22,7 @@ export const typeDefs = gql`
                 ) AS canEdit
                 RETURN canEdit
                 """
+                columnName: "canEdit"
             )
         canDelete: Boolean
             @cypher(
@@ -35,6 +36,7 @@ export const typeDefs = gql`
                 ) AS canDelete
                 RETURN canDelete
                 """
+                columnName: "canDelete"
             )
         createdAt: DateTime @timestamp(operations: [CREATE])
         updatedAt: DateTime @timestamp(operations: [UPDATE])

examples/subscriptions/apollo_rabbitmq/server.js

@@ -40,7 +40,7 @@ const plugin = new Neo4jGraphQLSubscriptionsAMQPPlugin({
 });
 
 //Alternatively, we can remove the AMQP server if we are only using a development server
-// const plugin = new new Neo4jGraphQLSubscriptionsSingleInstancePlugin();
+// const plugin = new Neo4jGrapghQLSubscriptionsSingleInstancePlugin();
 
 if (!process.argv[2]) throw new Error("Usage node server.js [port]");
 

packages/graphql/src/constants.ts

@@ -22,12 +22,7 @@ const DEBUG_PREFIX = "@neo4j/graphql";
 export const AUTH_FORBIDDEN_ERROR = "@neo4j/graphql/FORBIDDEN";
 export const AUTH_UNAUTHENTICATED_ERROR = "@neo4j/graphql/UNAUTHENTICATED";
 export const MIN_VERSIONS = [{ majorMinor: "4.3", neo4j: "4.3.2" }];
-export const REQUIRED_APOC_FUNCTIONS = [
-    "apoc.util.validatePredicate",
-    "apoc.cypher.runFirstColumnSingle",
-    "apoc.cypher.runFirstColumnMany",
-    "apoc.date.convertFormat",
-];
+export const REQUIRED_APOC_FUNCTIONS = ["apoc.util.validatePredicate", "apoc.date.convertFormat"];
 export const REQUIRED_APOC_PROCEDURES = ["apoc.util.validate", "apoc.do.when", "apoc.cypher.doIt"];
 export const DEBUG_ALL = `${DEBUG_PREFIX}:*`;
 export const DEBUG_AUTH = `${DEBUG_PREFIX}:auth`;

packages/graphql/src/graphql/directives/cypher.ts

@@ -31,9 +31,8 @@ export const cypherDirective = new GraphQLDirective({
             type: new GraphQLNonNull(GraphQLString),
         },
         columnName: {
-            description:
-                "[Experimental] Name of the returned variable from the Cypher statement, if provided, the query will be optimized to improve performance.",
-            type: GraphQLString,
+            description: "Name of the returned variable from the Cypher statement.",
+            type: new GraphQLNonNull(GraphQLString),
         },
     },
 });

packages/graphql/src/schema/make-augmented-schema.test.ts

@@ -182,7 +182,7 @@ describe("makeAugmentedSchema", () => {
                 }
 
                 type Query {
-                    movies: [Movie!]! @cypher(statement: "")
+                    movies: [Movie!]! @cypher(statement: "RETURN 5 as a", columnName: "a")
                 }
             `;
 
@@ -225,7 +225,7 @@ describe("makeAugmentedSchema", () => {
                 name: String
             }
 
-            interface ActedIn @cypher(statement: "RETURN rand()") {
+            interface ActedIn @cypher(statement: "RETURN rand() as rand", columnName: "rand") {
                 screenTime: Int
             }
         `;
@@ -282,7 +282,7 @@ describe("makeAugmentedSchema", () => {
             }
 
             interface ActedIn {
-                id: ID @cypher(statement: "RETURN id(this)")
+                id: ID @cypher(statement: "RETURN id(this) as id", columnName: "id")
                 roles: [String]
             }
         `;