Remove deprecated subscriptions

.changeset/curly-taxis-sleep.md

@@ -0,0 +1,8 @@
+---
+"@neo4j/graphql": major
+---
+
+Remove support for relationship subscriptions:
+
+-   `*RelationshipCreated`
+-   `*RelatiosnhipDeleted`

.changeset/great-beans-sell.md

@@ -0,0 +1,29 @@
+---
+"@neo4j/graphql": major
+---
+
+Removes support for non-cdc subscriptions. This means the only available engine for subscriptions is `Neo4jGraphQLSubscriptionsCDCEngine`:
+
+```ts
+new Neo4jGraphQL({
+    typeDefs,
+    driver,
+    features: {
+        subscriptions: new Neo4jGraphQLSubscriptionsCDCEngine({
+            driver,
+        }),
+    },
+});
+```
+
+The default behaviour of subscriptions has also been updated to use CDC, so now passing `true` will use the CDC engine with the default parameters and driver:
+
+```ts
+new Neo4jGraphQL({
+    typeDefs,
+    driver,
+    features: {
+        subscriptions: true,
+    },
+});
+```

packages/graphql/src/classes/Neo4jGraphQL.ts

@@ -46,7 +46,7 @@ import { getNeo4jDatabaseInfo } from "./Neo4jDatabaseInfo";
 import type Node from "./Node";
 import type Relationship from "./Relationship";
 import { Neo4jGraphQLAuthorization } from "./authorization/Neo4jGraphQLAuthorization";
-import { Neo4jGraphQLSubscriptionsDefaultEngine } from "./subscription/Neo4jGraphQLSubscriptionsDefaultEngine";
+import { Neo4jGraphQLSubscriptionsCDCEngine } from "./subscription/Neo4jGraphQLSubscriptionsCDCEngine";
 import type { AssertIndexesAndConstraintsOptions } from "./utils/asserts-indexes-and-constraints";
 import { assertIndexesAndConstraints } from "./utils/asserts-indexes-and-constraints";
 import { generateResolverComposition } from "./utils/generate-resolvers-composition";
@@ -295,7 +295,7 @@ class Neo4jGraphQL {
 
         const isSubscriptionEnabled = !!this.features.subscriptions;
         const wrapSubscriptionResolverArgs = {
-            subscriptionsEngine: this.features.subscriptions,
+            subscriptionsEngine: this.features.subscriptionsEngine,
             schemaModel: this.schemaModel,
             authorization: this.authorization,
             jwtPayloadFieldsMap: this.jwtFieldsMap,
@@ -338,14 +338,20 @@ class Neo4jGraphQL {
     private parseNeo4jFeatures(features: Neo4jFeaturesSettings | undefined): ContextFeatures {
         let subscriptionPlugin: Neo4jGraphQLSubscriptionsEngine | undefined;
         if (features?.subscriptions === true) {
-            subscriptionPlugin = new Neo4jGraphQLSubscriptionsDefaultEngine();
+            if (!this.driver) {
+                throw new Error("Driver required for CDC subscriptions");
+            }
+
+            subscriptionPlugin = new Neo4jGraphQLSubscriptionsCDCEngine({
+                driver: this.driver,
+            });
         } else {
             subscriptionPlugin = features?.subscriptions || undefined;
         }
 
         return {
             ...features,
-            subscriptions: subscriptionPlugin,
+            subscriptionsEngine: subscriptionPlugin,
         };
     }
 
@@ -485,7 +491,7 @@ class Neo4jGraphQL {
         }
 
         const setup = async () => {
-            const subscriptionsEngine = this.features?.subscriptions;
+            const subscriptionsEngine = this.features?.subscriptionsEngine;
             if (subscriptionsEngine) {
                 subscriptionsEngine.events.setMaxListeners(0); // Removes warning regarding leak. >10 listeners are expected
                 if (subscriptionsEngine.init) {

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

@@ -54,7 +54,6 @@ import { attributeAdapterToComposeFields, graphqlDirectivesToCompose } from "./t
 // GraphQL type imports
 import type { GraphQLToolsResolveMethods } from "graphql-compose/lib/SchemaComposer";
 import type { Subgraph } from "../classes/Subgraph";
-import { Neo4jGraphQLSubscriptionsCDCEngine } from "../classes/subscription/Neo4jGraphQLSubscriptionsCDCEngine";
 import { SHAREABLE } from "../constants";
 import { CreateInfo } from "../graphql/objects/CreateInfo";
 import { DeleteInfo } from "../graphql/objects/DeleteInfo";
@@ -294,7 +293,8 @@ function makeAugmentedSchema({
     });
 
     if (features?.subscriptions && nodes.length) {
-        const isCDCEngine = features.subscriptions instanceof Neo4jGraphQLSubscriptionsCDCEngine;
+        // TODO: Update CDC
+        const isCDCEngine = true;
         generateSubscriptionTypes({
             schemaComposer: composer,
             schemaModel,

packages/graphql/src/schema/resolvers/mutation/create.ts

@@ -49,7 +49,7 @@ export function createResolver({
             info,
         });
 
-        publishEventsToSubscriptionMechanism(executeResult, context.features?.subscriptions, context.schemaModel);
+        publishEventsToSubscriptionMechanism(executeResult, context.features?.subscriptionsEngine, context.schemaModel);
 
         const nodeProjection = info.fieldNodes[0]?.selectionSet?.selections.find(
             (selection): selection is FieldNode =>

packages/graphql/src/schema/resolvers/mutation/delete.ts

@@ -55,7 +55,7 @@ export function deleteResolver({
             info,
         });
 
-        publishEventsToSubscriptionMechanism(executeResult, context.features?.subscriptions, context.schemaModel);
+        publishEventsToSubscriptionMechanism(executeResult, context.features?.subscriptionsEngine, context.schemaModel);
 
         return executeResult.statistics;
     }

packages/graphql/src/schema/resolvers/mutation/update.ts

@@ -66,7 +66,7 @@ export function updateResolver({
             info,
         });
 
-        publishEventsToSubscriptionMechanism(executeResult, context.features?.subscriptions, context.schemaModel);
+        publishEventsToSubscriptionMechanism(executeResult, context.features?.subscriptionsEngine, context.schemaModel);
 
         const nodeProjection = info.fieldNodes[0]?.selectionSet?.selections.find(
             (selection): selection is FieldNode =>

packages/graphql/src/schema/resolvers/subscriptions/subscribe.ts

@@ -93,6 +93,7 @@ export function generateSubscribeMethod({
             });
         }
 
+        // TODO: Remove
         if (["create_relationship", "delete_relationship"].includes(type)) {
             return filterAsyncIterator<SubscriptionsEvent[]>(iterable, (data) => {
                 if (!isRelationshipSubscriptionEvent(data[0])) {

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

@@ -31,7 +31,7 @@ import type {
     TypeNode,
     UnionTypeDefinitionNode,
 } from "graphql";
-import { extendSchema, GraphQLSchema, Kind, specifiedDirectives, validateSchema } from "graphql";
+import { GraphQLSchema, Kind, extendSchema, specifiedDirectives, validateSchema } from "graphql";
 import { specifiedSDLRules } from "graphql/validation/specifiedRules";
 import pluralize from "pluralize";
 import * as directives from "../../graphql/directives";

packages/graphql/src/types/index.ts

@@ -24,6 +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 { Neo4jGraphQLSubscriptionsCDCEngine } from "../classes/subscription/Neo4jGraphQLSubscriptionsCDCEngine";
 import type { RelationshipNestedOperationsOption, RelationshipQueryDirectionOption } from "../constants";
 import type { Neo4jGraphQLSchemaModel } from "../schema-model/Neo4jGraphQLSchemaModel";
 import type { DefaultAnnotationValue } from "../schema-model/annotation/DefaultAnnotation";
@@ -470,7 +471,7 @@ export type Neo4jFeaturesSettings = {
     filters?: Neo4jFiltersSettings;
     populatedBy?: Neo4jPopulatedBySettings;
     authorization?: Neo4jAuthorizationSettings;
-    subscriptions?: Neo4jGraphQLSubscriptionsEngine | boolean;
+    subscriptions?: boolean | Neo4jGraphQLSubscriptionsCDCEngine;
     /** If set to `true`, removes `@neo4j/graphql` fields that are marked as deprecated to reduce schema size.
      *
      * NOTE: this will not remove user defined deprecated fields
@@ -485,11 +486,8 @@ export type Neo4jFeaturesSettings = {
 };
 
 /** Parsed features used in context */
-export type ContextFeatures = {
-    filters?: Neo4jFiltersSettings;
-    populatedBy?: Neo4jPopulatedBySettings;
-    authorization?: Neo4jAuthorizationSettings;
-    subscriptions?: Neo4jGraphQLSubscriptionsEngine;
+export type ContextFeatures = Neo4jFeaturesSettings & {
+    subscriptionsEngine?: Neo4jGraphQLSubscriptionsEngine;
 };
 
 export type PredicateReturn = {

packages/graphql/tests/e2e/setup/ws-client.ts

@@ -65,7 +65,7 @@ export class WebSocketTestClient {
             };
             const timeout = setTimeout(() => {
                 this.eventsEmitter.removeListener(NEW_EVENT, newEventListener);
-                reject("Timed out.");
+                reject("[waitForEvents] Timed out.");
             }, 500);
             this.eventsEmitter.on(NEW_EVENT, newEventListener);
         });

packages/graphql/tests/e2e/subscriptions/authorization/authentication-roles.int.test.ts

@@ -17,43 +17,23 @@
  * limitations under the License.
  */
 
-import type { Driver } from "neo4j-driver";
 import type { Response } from "supertest";
 import supertest from "supertest";
-import { Neo4jGraphQLSubscriptionsCDCEngine, type Neo4jGraphQLSubscriptionsEngine } from "../../../../src";
-import { Neo4jGraphQLSubscriptionsDefaultEngine } from "../../../../src/classes/subscription/Neo4jGraphQLSubscriptionsDefaultEngine";
 import { createBearerToken } from "../../../utils/create-bearer-token";
 import type { UniqueType } from "../../../utils/graphql-types";
 import { TestHelper } from "../../../utils/tests-helper";
 import type { TestGraphQLServer } from "../../setup/apollo-server";
 import { ApolloTestServer } from "../../setup/apollo-server";
 import { WebSocketTestClient } from "../../setup/ws-client";
 
-describe.each([
-    {
-        name: "Neo4jGraphQLSubscriptionsDefaultEngine",
-        engine: (_driver: Driver, _db: string) => new Neo4jGraphQLSubscriptionsDefaultEngine(),
-    },
-    {
-        name: "Neo4jGraphQLSubscriptionsCDCEngine",
-        engine: (driver: Driver, db: string) =>
-            new Neo4jGraphQLSubscriptionsCDCEngine({
-                driver,
-                pollTime: 100,
-                queryConfig: {
-                    database: db,
-                },
-            }),
-    },
-])("$name - Subscription authentication roles", ({ engine }) => {
+describe("Subscription authentication roles", () => {
     const testHelper = new TestHelper({ cdc: true });
 
     let typeMovie: UniqueType;
 
     let jwtToken: string;
     let server: TestGraphQLServer;
     let wsClient: WebSocketTestClient;
-    let subscriptionEngine: Neo4jGraphQLSubscriptionsEngine;
 
     let typeDefs: string;
 
@@ -74,15 +54,13 @@ describe.each([
 
         jwtToken = createBearerToken("secret", { roles: ["admin"] });
 
-        const driver = await testHelper.getDriver();
-        subscriptionEngine = engine(driver, testHelper.database);
         const neoSchema = await testHelper.initNeo4jGraphQL({
             typeDefs,
             features: {
                 authorization: {
                     key: "secret",
                 },
-                subscriptions: subscriptionEngine,
+                subscriptions: await testHelper.getSubscriptionEngine(),
             },
         });
 
@@ -102,7 +80,6 @@ describe.each([
 
     afterAll(async () => {
         await server.close();
-        subscriptionEngine.close();
         await testHelper.close();
     });