Remove run first column

.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]
             }
         `;

packages/graphql/src/schema/validation/validate-document.test.ts

@@ -171,6 +171,7 @@ describe("validateDocument", () => {
                           post.id = randomUUID()
                         RETURN post
                         """
+                        columnName: "post"
                     )
             }
 
@@ -277,6 +278,7 @@ describe("validateDocument", () => {
                                       s.salaryReviewDate = salary.salaryReviewDate
                         RETURN s
                         """
+                        columnName: "s"
                     )
 
                 mergeEmploymentRecords(employmentRecords: [EmpRecord]): [EmploymentRecord]
@@ -303,6 +305,7 @@ describe("validateDocument", () => {
                         MERGE (er)-[:PAYS_SALARY]->(s)
                         RETURN er
                         """
+                        columnName: "er"
                     )
             }
         `;
@@ -319,7 +322,7 @@ describe("validateDocument", () => {
                 }
 
                 type Query {
-                    nodes: [Test] @cypher(statement: "")
+                    nodes: [Test] @cypher(statement: "", columnName: "")
                 }
             `;
 
@@ -374,10 +377,15 @@ describe("validateDocument", () => {
                 }
 
                 extend type Order {
-                    subTotal: Float @cypher(statement: "MATCH (this)-[:CONTAINS]->(b:Book) RETURN sum(b.price)")
+                    subTotal: Float
+                        @cypher(
+                            statement: "MATCH (this)-[:CONTAINS]->(b:Book) RETURN sum(b.price) as result"
+                            columnName: "result"
+                        )
                     shippingCost: Float
                         @cypher(
-                            statement: "MATCH (this)-[:SHIPS_TO]->(a:Address) RETURN round(0.01 * distance(a.location, Point({latitude: 40.7128, longitude: -74.0060})) / 1000, 2)"
+                            statement: "MATCH (this)-[:SHIPS_TO]->(a:Address) RETURN round(0.01 * distance(a.location, Point({latitude: 40.7128, longitude: -74.0060})) / 1000, 2) as result"
+                            columnName: "result"
                         )
                     estimatedDelivery: DateTime @customResolver
                 }
@@ -389,6 +397,7 @@ describe("validateDocument", () => {
                     recommended(limit: Int = 3): [Book]
                         @cypher(
                             statement: "MATCH (this)-[:PLACED]->(:Order)-[:CONTAINS]->(:Book)<-[:CONTAINS]-(:Order)<-[:PLACED]-(c:Customer) MATCH (c)-[:PLACED]->(:Order)-[:CONTAINS]->(rec:Book) WHERE NOT exists((this)-[:PLACED]->(:Order)-[:CONTAINS]->(rec)) RETURN rec LIMIT $limit"
+                            columnName: "rec"
                         )
                 }
 
@@ -402,6 +411,7 @@ describe("validateDocument", () => {
                     currentWeather: Weather
                         @cypher(
                             statement: "CALL apoc.load.json('https://www.7timer.info/bin/civil.php?lon=' + this.location.longitude + '&lat=' + this.location.latitude + '&ac=0&unit=metric&output=json&tzshift=0') YIELD value WITH value.dataseries[0] as weather RETURN {temperature: weather.temp2m, windSpeed: weather.wind10m.speed, windDirection: weather.wind10m.direction, precipitation: weather.prec_type, summary: weather.weather} AS conditions"
+                            columnName: "conditions"
                         )
                 }
 
@@ -435,6 +445,7 @@ describe("validateDocument", () => {
                             ORDER BY jaccard DESC
                             RETURN b LIMIT 1
                             """
+                            columnName: "b"
                         )
                 }
 
@@ -467,6 +478,7 @@ describe("validateDocument", () => {
                             MERGE (t)-[:ABOUT]->(s)
                             RETURN s
                             """
+                            columnName: "s"
                         )
                 }
 
@@ -477,6 +489,7 @@ describe("validateDocument", () => {
                             CALL db.index.fulltext.queryNodes('bookIndex', $searchString+'~')
                             YIELD node RETURN node
                             """
+                            columnName: "node"
                         )
                 }
             `;

packages/graphql/src/translate/projection/subquery/translate-cypher-directive-projection.ts

@@ -147,7 +147,6 @@ export function translateCypherDirectiveProjection({
         }
     }
 
-    let customCypherClause: Cypher.Clause | undefined;
     const nodeRef = new Cypher.NamedNode(chainStr);
 
     // Null default argument values are not passed into the resolve tree therefore these are not being passed to
@@ -161,23 +160,12 @@ export function translateCypherDirectiveProjection({
     );
     const extraArgs = { ...nullArgumentValues, ...field.args };
 
-    if (!cypherField.columnName) {
-        const runCypherInApocClause = createCypherDirectiveApocProcedure({
-            nodeRef,
-            expectMultipleValues,
-            context,
-            cypherField,
-            extraArgs,
-        });
-        customCypherClause = new Cypher.Unwind([runCypherInApocClause, param]);
-    } else {
-        customCypherClause = createCypherDirectiveSubquery({
-            cypherField,
-            nodeRef,
-            resultVariable: param,
-            extraArgs,
-        });
-    }
+    const customCypherClause = createCypherDirectiveSubquery({
+        cypherField,
+        nodeRef,
+        resultVariable: param,
+        extraArgs,
+    });
 
     const unionExpression = hasUnionLabelsPredicate ? new Cypher.With("*").where(hasUnionLabelsPredicate) : undefined;
 
@@ -210,40 +198,6 @@ export function translateCypherDirectiveProjection({
     return res;
 }
 
-function createCypherDirectiveApocProcedure({
-    cypherField,
-    expectMultipleValues,
-    context,
-    nodeRef,
-    extraArgs,
-}: {
-    cypherField: CypherField;
-    expectMultipleValues: boolean;
-    context: Context;
-    nodeRef: Cypher.Node;
-    extraArgs: Record<string, any>;
-}): Cypher.apoc.RunFirstColumn {
-    const rawApocParams = Object.entries(extraArgs);
-
-    const apocParams: Record<string, Cypher.Param> = rawApocParams.reduce((acc, [key, value]) => {
-        acc[key] = new Cypher.Param(value);
-        return acc;
-    }, {});
-
-    const apocParamsMap = new Cypher.Map({
-        ...apocParams,
-        this: nodeRef,
-        ...(context.auth && { auth: new Cypher.NamedParam("auth") }),
-        ...(Boolean(context.cypherParams) && { cypherParams: new Cypher.NamedParam("cypherParams") }),
-    });
-    const apocClause = new Cypher.apoc.RunFirstColumn(
-        cypherField.statement,
-        apocParamsMap,
-        Boolean(expectMultipleValues)
-    );
-    return apocClause;
-}
-
 function createCypherDirectiveSubquery({
     cypherField,
     nodeRef,

packages/graphql/src/translate/translate-top-level-cypher.ts

@@ -158,18 +158,10 @@ export function translateTopLevelCypher({
     const apocParamsStr = `{${apocParams.strs.length ? `${apocParams.strs.join(", ")}` : ""}}`;
 
     if (type === "Query") {
-        if (field.columnName) {
-            const experimentalCypherStatement = createCypherDirectiveSubquery({
-                field,
-            });
-            cypherStrs.push(...experimentalCypherStatement);
-        } else {
-            const legacyCypherStatement = createCypherDirectiveApocProcedure({
-                field,
-                apocParams: apocParamsStr,
-            });
-            cypherStrs.push(...legacyCypherStatement);
-        }
+        const cypherStatement = createCypherDirectiveSubquery({
+            field,
+        });
+        cypherStrs.push(...cypherStatement);
     } else {
         cypherStrs.push(`
             CALL apoc.cypher.doIt("${statement}", ${apocParamsStr}) YIELD value
@@ -207,27 +199,6 @@ export function translateTopLevelCypher({
     }).build();
 }
 
-function createCypherDirectiveApocProcedure({
-    field,
-    apocParams,
-}: {
-    field: CypherField;
-    apocParams: string;
-}): string[] {
-    const isArray = field.typeMeta.array;
-    const expectMultipleValues = !field.isScalar && !field.isEnum && isArray;
-    const cypherStrs: string[] = [];
-
-    if (expectMultipleValues) {
-        cypherStrs.push(`WITH apoc.cypher.runFirstColumnMany("${field.statement}", ${apocParams}) as x`);
-    } else {
-        cypherStrs.push(`WITH apoc.cypher.runFirstColumnSingle("${field.statement}", ${apocParams}) as x`);
-    }
-
-    cypherStrs.push("UNWIND x as this\nWITH this");
-    return cypherStrs;
-}
-
 function createCypherDirectiveSubquery({ field }: { field: CypherField }): string[] {
     const cypherStrs: string[] = [];
     cypherStrs.push("CALL {", field.statement, "}");

packages/graphql/tests/integration/connections/sort.int.test.ts

@@ -49,7 +49,7 @@ describe("connections sort", () => {
             title: String!
             runtime: Int!
             actors: [${Actor}!]! @relationship(type: "ACTED_IN", direction: IN, properties: "ActedIn")
-            numberOfActors: Int! @cypher(statement: "MATCH (actor:${Actor})-[:ACTED_IN]->(this) RETURN count(actor)")
+            numberOfActors: Int! @cypher(statement: "MATCH (actor:${Actor})-[:ACTED_IN]->(this) RETURN count(actor) as count", columnName: "count")
         }
 
         type ${Series} implements Production {
@@ -66,8 +66,9 @@ describe("connections sort", () => {
                 @cypher(
                     statement: """
                     MATCH (this)-[r:ACTED_IN]->(:${Movie})
-                    RETURN sum(r.screenTime)
-                    """
+                    RETURN sum(r.screenTime) as sum
+                    """,
+                    columnName: "sum"
                 )
         }
         interface ActedIn @relationshipProperties {