Introspector to produce @mutation instead of @exclude (#3743)

* fix: remove unnecessary readonly (#3735) * chore(deps): update dependency eslint-config-prettier to v8.10.0 * chore(deps): update dependency jest-extended to v4.0.1 * Introspector to produce `@mutation` instead of `@exclude` --------- Co-authored-by: Thomas Wiss <[email protected]> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
neo4j · Aug 8, 2023 · 85b3c06 · 85b3c06
1 parent 37ced64
commit 85b3c06
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 61 deletions.
diff --git a/.changeset/rotten-avocados-knock.md b/.changeset/rotten-avocados-knock.md
@@ -0,0 +1,5 @@
+---
+"@neo4j/introspector": patch
+---
+
+Introspector now produces `@mutation` directive instead on `@exclude` when readonly
diff --git a/packages/introspector/src/transforms/neo4j-graphql/directives/Exclude.ts b/packages/introspector/src/transforms/neo4j-graphql/directives/Exclude.ts
diff --git a/packages/introspector/src/transforms/neo4j-graphql/graphql.ts b/packages/introspector/src/transforms/neo4j-graphql/graphql.ts
@@ -25,7 +25,6 @@ import { GraphQLNode } from "./GraphQLNode";
 import generateRelationshipPropsName from "./utils/generate-relationship-props-name";
 import { RelationshipPropertiesDirective } from "./directives/RelationshipProperties";
 import createRelationshipFields from "./utils/create-relationship-fields";
-import { ExcludeDirective } from "./directives/Exclude";
 import generateGraphQLSafeName from "./utils/generate-graphql-safe-name";
 import nodeKey from "../../utils/node-key";
 
@@ -35,15 +34,19 @@ type GraphQLNodeMap = {
 
 export default function graphqlFormatter(neo4jStruct: Neo4jStruct, readonly = false): string {
     const { nodes, relationships } = neo4jStruct;
-    const bareNodes = transformNodes(nodes, readonly);
+    const bareNodes = transformNodes(nodes);
     const withRelationships = hydrateWithRelationships(bareNodes, relationships);
     const sorted = Object.keys(withRelationships).sort((a, b) => {
         return withRelationships[a].typeName > withRelationships[b].typeName ? 1 : -1;
     });
-    return sorted.map((typeName) => withRelationships[typeName].toString()).join("\n\n");
+    const sortedWithRelationships = sorted.map((typeName) => withRelationships[typeName].toString());
+    if (readonly) {
+        sortedWithRelationships.push("extend schema @mutation(operations: [])");
+    }
+    return sortedWithRelationships.join("\n\n");
 }
 
-function transformNodes(nodes: NodeMap, readonly: boolean): GraphQLNodeMap {
+function transformNodes(nodes: NodeMap): GraphQLNodeMap {
     const out = {};
     const takenTypeNames: string[] = [];
     Object.keys(nodes).forEach((nodeType) => {
@@ -68,13 +71,6 @@ function transformNodes(nodes: NodeMap, readonly: boolean): GraphQLNodeMap {
         if (nodeDirective.toString().length) {
             node.addDirective(nodeDirective);
         }
-        if (readonly) {
-            const excludeDirective = new ExcludeDirective();
-            excludeDirective.addOperation("CREATE");
-            excludeDirective.addOperation("DELETE");
-            excludeDirective.addOperation("UPDATE");
-            node.addDirective(excludeDirective);
-        }
 
         const fields = createNodeFields(neo4jNode.properties, node.typeName);
         fields.forEach((f) => node.addField(f));

diff --git a/packages/introspector/tests/integration/graphql/nodes.test.ts b/packages/introspector/tests/integration/graphql/nodes.test.ts
@@ -376,13 +376,15 @@ describe("GraphQL - Infer Schema nodes basic tests", () => {
         const typeDefs = await toGraphQLTypeDefs(sessionFactory(bm), true);
 
         expect(typeDefs).toMatchInlineSnapshot(`
-            "type TestLabel @exclude(operations: [CREATE, DELETE, UPDATE]) {
+            "type TestLabel {
             	strProp: String!
             }
 
-            type TestLabel2 @node(labels: [\\"TestLabel2\\", \\"TestLabel3\\"]) @exclude(operations: [CREATE, DELETE, UPDATE]) {
+            type TestLabel2 @node(labels: [\\"TestLabel2\\", \\"TestLabel3\\"]) {
             	singleProp: BigInt!
-            }"
+            }
+
+            extend schema @mutation(operations: [])"
         `);
 
         const neoSchema = new Neo4jGraphQL({ typeDefs, driver });