Merge branch '4.0.0' into chore/cypher-query-options

Author: darrellwarde

.changeset/poor-fans-smile.md

@@ -0,0 +1,5 @@
+---
+"@neo4j/graphql": major
+---
+
+`neo4jDatabaseInfo` has been removed from the context. It is our belief that this has little utility in the library. If you regularly use different drivers connected to _different versions_ of Neo4j and require this feature, please raise an issue: https://github.com/neo4j/graphql/issues/new/choose

docs/modules/ROOT/pages/reference/driver-configuration.adoc

@@ -218,43 +218,6 @@ await startStandaloneServer(server, {
 });
 ----
 
-== Specifying Neo4j version
-
-When a connection is established, the library automatically detect the version of the Neo4j instance connected.
-The version will be then stored and used for the following queries.
-It is also possible to specify manually the Neo4j version in the Context.
-
-=== Context
-
-[source, javascript, indent=0]
-----
-import { ApolloServer } from '@apollo/server';
-import { startStandaloneServer } from '@apollo/server/standalone';
-import { Neo4jDatabaseInfo, Neo4jGraphQL } from "@neo4j/graphql";
-import neo4j from "neo4j-driver";
-
-const typeDefs = `#graphql
-    type User {
-        name: String
-    }
-`;
-
-const driver = neo4j.driver(
-    "bolt://localhost:7687",
-    neo4j.auth.basic("neo4j", "password")
-);
-
-const neoSchema = new Neo4jGraphQL({ typeDefs, driver });
-
-const server = new ApolloServer({
-    schema: await neoSchema.getSchema(),
-});
-
-await startStandaloneServer(server, {
-    context: async ({ req }) => ({ req, neo4jDatabaseInfo: new Neo4jDatabaseInfo("4.4") }),
-});
-----
-
 [[driver-configuration-bookmarks]]
 == Specifying Neo4j Bookmarks
 

packages/graphql/src/index.ts

@@ -21,7 +21,6 @@ import { CartesianPoint } from "./graphql/objects/CartesianPoint";
 import { Point } from "./graphql/objects/Point";
 
 export {
-    Neo4jDatabaseInfo,
     Neo4jGraphQL,
     Neo4jGraphQLAuthenticationError,
     Neo4jGraphQLConstructor,

packages/graphql/src/translate/create-aggregate-where-and-params.ts

@@ -18,7 +18,7 @@
  */
 
 import Cypher from "@neo4j/cypher-builder";
-import type { Neo4jDatabaseInfo, Node, Relationship } from "../classes";
+import type { Node, Relationship } from "../classes";
 import type { RelationField, Context, GraphQLWhereArg, PredicateReturn } from "../types";
 import type { AggregationFieldRegexGroups } from "./where/utils";
 import { aggregationFieldRegEx, whereRegEx } from "./where/utils";
@@ -256,8 +256,6 @@ function createEntityOperation(
             param: paramName,
             durationField,
             pointField,
-            // Casting because this is definitely assigned in the wrapper
-            neo4jDatabaseInfo: context.neo4jDatabaseInfo as Neo4jDatabaseInfo,
         });
         const dbFieldName = mapToDbProperty(refNodeOrRelation, fieldName);
         const collectedProperty =

packages/graphql/src/translate/where/property-operations/create-comparison-operation.ts

@@ -17,7 +17,6 @@
  * limitations under the License.
  */
 
-import type { Neo4jDatabaseInfo } from "../../../classes/Neo4jDatabaseInfo";
 import type { PointField, PrimitiveField } from "../../../types";
 import Cypher from "@neo4j/cypher-builder";
 import { createPointComparisonOperation } from "./create-point-comparison-operation";
@@ -29,14 +28,12 @@ export function createComparisonOperation({
     param,
     durationField,
     pointField,
-    neo4jDatabaseInfo,
 }: {
     operator: string | undefined;
     propertyRefOrCoalesce: Cypher.Property | Cypher.Function | Cypher.Variable;
     param: Cypher.Param | Cypher.Property | Cypher.Function;
     durationField: PrimitiveField | undefined;
     pointField: PointField | undefined;
-    neo4jDatabaseInfo: Neo4jDatabaseInfo;
 }): Cypher.ComparisonOp {
     // TODO: consider if this conditional is the correct solution - should we make the function compatible?
     if (!(param instanceof Cypher.Function) && pointField) {
@@ -45,7 +42,6 @@ export function createComparisonOperation({
             propertyRefOrCoalesce,
             param,
             pointField,
-            neo4jDatabaseInfo,
         });
     }
 

packages/graphql/src/translate/where/property-operations/create-point-comparison-operation.ts

@@ -17,7 +17,6 @@
  * limitations under the License.
  */
 
-import type { Neo4jDatabaseInfo } from "../../../classes/Neo4jDatabaseInfo";
 import type { PointField } from "../../../types";
 import Cypher from "@neo4j/cypher-builder";
 
@@ -27,15 +26,13 @@ export function createPointComparisonOperation({
     propertyRefOrCoalesce,
     param,
     pointField,
-    neo4jDatabaseInfo,
 }: {
     operator: string | undefined;
     propertyRefOrCoalesce: Cypher.Property | Cypher.Function | Cypher.Variable;
     param: Cypher.Param | Cypher.Property;
     pointField: PointField;
-    neo4jDatabaseInfo: Neo4jDatabaseInfo;
 }): Cypher.ComparisonOp {
-    const pointDistance = createPointDistanceExpression(propertyRefOrCoalesce, param, neo4jDatabaseInfo);
+    const pointDistance = createPointDistanceExpression(propertyRefOrCoalesce, param);
     const distanceRef = param.property("distance");
 
     switch (operator || "EQ") {
@@ -77,14 +74,7 @@ function createPointListComprehension(param: Cypher.Param | Cypher.Property): Cy
     return new Cypher.ListComprehension(comprehensionVar, param).map(mapPoint);
 }
 
-function createPointDistanceExpression(
-    property: Cypher.Expr,
-    param: Cypher.Param | Cypher.Property,
-    neo4jDatabaseInfo: Neo4jDatabaseInfo
-): Cypher.Function {
+function createPointDistanceExpression(property: Cypher.Expr, param: Cypher.Param | Cypher.Property): Cypher.Function {
     const nestedPointRef = param.property("point");
-    if (neo4jDatabaseInfo.gte("4.4")) {
-        return Cypher.pointDistance(property, Cypher.point(nestedPointRef));
-    }
-    return Cypher.distance(property, Cypher.point(nestedPointRef));
+    return Cypher.pointDistance(property, Cypher.point(nestedPointRef));
 }

packages/graphql/src/translate/where/property-operations/create-property-where.ts

@@ -19,7 +19,7 @@
 
 import type { Context, PredicateReturn } from "../../../types";
 import Cypher from "@neo4j/cypher-builder";
-import type { GraphElement, Neo4jDatabaseInfo } from "../../../classes";
+import type { GraphElement } from "../../../classes";
 import { Node } from "../../../classes";
 import type { WhereRegexGroups } from "../utils";
 import { whereRegEx } from "../utils";
@@ -168,8 +168,6 @@ export function createPropertyWhere({
         operator,
         durationField,
         pointField,
-        // Casting because this is definitely assigned in the wrapper
-        neo4jDatabaseInfo: context.neo4jDatabaseInfo as Neo4jDatabaseInfo,
     });
     if (isNot) {
         return {

packages/graphql/src/types/index.ts

@@ -24,7 +24,7 @@ import type { Directive } from "graphql-compose";
 import type { ResolveTree } from "graphql-parse-resolve-info";
 import type { JWTVerifyOptions, RemoteJWKSetOptions } from "jose";
 import type { Integer } from "neo4j-driver";
-import type { Node, Relationship } from "../classes";
+import type { Neo4jDatabaseInfo, Node, Relationship } from "../classes";
 import type { Executor } from "../classes/Executor";
 import type { RelationshipNestedOperationsOption, RelationshipQueryDirectionOption } from "../constants";
 import type { Neo4jGraphQLSchemaModel } from "../schema-model/Neo4jGraphQLSchemaModel";
@@ -61,6 +61,7 @@ export interface Context extends Neo4jGraphQLContext {
     executor: Executor;
     extensions?: Record<string, any>;
     authorization: AuthorizationContext;
+    neo4jDatabaseInfo?: Neo4jDatabaseInfo;
     [k: string]: any;
 }
 

packages/graphql/src/types/neo4j-graphql-context.ts

@@ -19,7 +19,6 @@
 
 import type { Driver, Session, Transaction } from "neo4j-driver";
 import type { CypherQueryOptions, DriverConfig, RequestLike } from ".";
-import type { Neo4jDatabaseInfo } from "../classes";
 import type { JWTPayload } from "jose";
 
 export interface Neo4jGraphQLContext {
@@ -54,24 +53,6 @@ export interface Neo4jGraphQLContext {
      * ```
      */
     jwt?: JWTPayload;
-    /**
-     * @deprecated This property will be removed in 4.0.0.
-     */
-    neo4jDatabaseInfo?: Neo4jDatabaseInfo;
-    /**
-     * HTTP request object containing authorization header for use in authentication and authorization.
-     * Alias for {@link request}.
-     *
-     * @deprecated Will be removed in 4.0.0 alongside `@auth` - use the {@link token} property to provide the bearer token for the new authorization features.
-     */
-    req?: RequestLike;
-    /**
-     * HTTP request object containing authorization header for use in authentication and authorization.
-     * Alias for {@link req}.
-     *
-     * @deprecated Will be removed in 4.0.0 alongside `@auth` - use the {@link token} property to provide the bearer token for the new authorization features.
-     */
-    request?: RequestLike;
     /**
      * The bearer token to be decoded/verified for use in authentication and authorization.
      * Normally found in the Authorization HTTP header. Can be provided with or without authentication scheme.

packages/graphql/tests/e2e/neo4jgraphql/neo4j-database-info.test.ts

@@ -20,11 +20,12 @@
 import type { Driver } from "neo4j-driver";
 import type { Response } from "supertest";
 import supertest from "supertest";
-import { Neo4jDatabaseInfo, Neo4jGraphQL } from "../../../src/";
+import { Neo4jGraphQL } from "../../../src/";
 import { UniqueType } from "../../utils/graphql-types";
 import type { TestGraphQLServer } from "../setup/apollo-server";
 import { ApolloTestServer } from "../setup/apollo-server";
 import Neo4j from "../setup/neo4j";
+import { Neo4jDatabaseInfo } from "../../../src/classes";
 
 describe("Create with specific neo4jDatabaseInfo set correctly", () => {
     let neo4j: Neo4j;