Schema model refactoring (#3689)

* Add directive annotations (#3615)

* feat: add alias directive annotation

* feat: add queryOptions directive annotation

* feat: parse Kind.INT and Kind.Float into JS numbers

* feat: add default directive annotation

* feat: add coalesce directive annotation

* feat: add customResolver annotation

* feat: add ID directive annotation

* refactor: use makeDirectiveNode in key-annotation tests

* feat: add mutation directive annotation

* feat: add plural directive annotation

* feat: add filterable directive annotation

* feat: add fulltext directive annotation

* feat: add node directive annotation

* feat: add populatedBy directive annotation

* feat: add query directive annotation

* feat: add private directive annotation

* feat: add relationshipProperties annotation

* feat: add selectable directive annotation

* feat: add settable directive annotation

* feat: add timestamp directive annotation

* feat: add unique directive annotation

* feat: add subscription directive annotation

* feat: add jwt-claim directive annotation

* feat: add jwt-payload directive annotation

* feat: add directives to Annotation

---------

Co-authored-by: MacondoExpress <[email protected]>

* Schema model re-design (#3596)

* initial refactor of the schema model

* add unit tests for schema model Attributes

* include initial design for the GraphQL models

* add Attribute tests, improve Attribute models

* merge schema model changes with authorization changes

* fix relationship-field parsing on schema model

* organise parser folder

* Add missing GraphQL models to the Schema Models

* change Schema Model test to showcase how to dynamically get EntityModels from relationships

* improve coverage on the Attribute Models

* add more tests to the ConcreteEntityModel

* Apply suggestions from code review

Co-authored-by: angrykoala <[email protected]>

* lint fixes

* rename graphql-models to model-adapters

* remove @relationshipProperties annotation as it is implicit within the Relationship class

* remove code duplicity around leadingUnderscores utility and test it

* parseArguments of directive using default values, add Schema Model tests for annotations and relationships

* remove not necessary node directive

* polishing

* add license header

* Update packages/graphql/src/schema-model/parser/parse-arguments.ts

* add graphqlDefaultValue to Attribute

* remove the graphqlDefault logic

* add comment on the PluralAnnotation

---------

Co-authored-by: Michael Webb <[email protected]>
Co-authored-by: angrykoala <[email protected]>

Author: 3 people

packages/graphql/src/classes/Node.ts

@@ -44,6 +44,7 @@ import { GraphElement } from "./GraphElement";
 import type { NodeDirective } from "./NodeDirective";
 import type { QueryOptionsDirective } from "./QueryOptionsDirective";
 import type { SchemaConfiguration } from "../schema/schema-configuration";
+import { leadingUnderscores } from "../utils/leading-underscore";
 
 export interface NodeConstructor extends GraphElementConstructor {
     name: string;
@@ -169,8 +170,8 @@ class Node extends GraphElement {
             ...this.temporalFields,
             ...this.enumFields,
             ...this.objectFields,
-            ...this.scalarFields,
-            ...this.primitiveFields,
+            ...this.scalarFields, // these are just custom scalars
+            ...this.primitiveFields, // these are instead built-in scalars
             ...this.interfaceFields,
             ...this.objectFields,
             ...this.unionFields,
@@ -179,6 +180,7 @@ class Node extends GraphElement {
     }
 
     /** Fields you can apply auth allow and bind to */
+    // Maybe we can remove this as they may not be used anymore in the new auth system
     public get authableFields(): AuthableField[] {
         return [
             ...this.primitiveFields,
@@ -233,6 +235,7 @@ class Node extends GraphElement {
         };
     }
 
+
     public get fulltextTypeNames(): FulltextTypeNames {
         return {
             result: `${this.pascalCaseSingular}FulltextResult`,
@@ -318,20 +321,14 @@ class Node extends GraphElement {
     private generateSingular(): string {
         const singular = camelcase(this.name);
 
-        return `${this.leadingUnderscores(this.name)}${singular}`;
+        return `${leadingUnderscores(this.name)}${singular}`;
     }
 
     private generatePlural(inputPlural: string | undefined): string {
         const name = inputPlural || this.plural || this.name;
         const plural = inputPlural || this.plural ? camelcase(name) : pluralize(camelcase(name));
 
-        return `${this.leadingUnderscores(name)}${plural}`;
-    }
-
-    private leadingUnderscores(name: string): string {
-        const re = /^(_+).+/;
-        const match = re.exec(name);
-        return match?.[1] || "";
+        return `${leadingUnderscores(name)}${plural}`;
     }
 }
 

packages/graphql/src/constants.ts

@@ -72,7 +72,7 @@ export const NODE_OR_EDGE_KEYS = ["node", "edge"];
 export const LOGICAL_OPERATORS = ["AND", "OR", "NOT"] as const;
 
 // aggregation
-export const AGGREGATION_COMPARISON_OPERATORS = ["EQUAL", "GT", "GTE", "LT", "LTE"];
+export const AGGREGATION_COMPARISON_OPERATORS = ["EQUAL", "GT", "GTE", "LT", "LTE"] as const;
 export const AGGREGATION_AGGREGATE_COUNT_OPERATORS = ["count", "count_LT", "count_LTE", "count_GT", "count_GTE"];
 
 export const WHERE_AGGREGATION_TYPES = [

packages/graphql/src/graphql/directives/arguments/enums/PopulatedByOperation.ts

@@ -23,7 +23,7 @@ export const PopulatedByOperationEnum = new GraphQLEnumType({
     name: "PopulatedByOperation",
     description: "*For use in the @populatedBy directive only*",
     values: {
-        CREATE: {},
-        UPDATE: {},
+        CREATE: { value: "CREATE" },
+        UPDATE: { value: "UPDATE"},
     },
 });

packages/graphql/src/schema-model/Neo4jGraphQLSchemaModel.ts

@@ -24,6 +24,8 @@ import { annotationToKey } from "./annotation/Annotation";
 import { CompositeEntity } from "./entity/CompositeEntity";
 import { ConcreteEntity } from "./entity/ConcreteEntity";
 import type { Entity } from "./entity/Entity";
+import { ConcreteEntityAdapter } from "./entity/model-adapters/ConcreteEntityAdapter";
+
 export type Operations = {
     Query?: Operation;
     Mutation?: Operation;
@@ -52,6 +54,7 @@ export class Neo4jGraphQLSchemaModel {
             acc.set(entity.name, entity);
             return acc;
         }, new Map<string, Entity>());
+
         this.concreteEntities = concreteEntities;
         this.compositeEntities = compositeEntities;
         this.operations = operations;
@@ -65,6 +68,11 @@ export class Neo4jGraphQLSchemaModel {
         return this.entities.get(name);
     }
 
+    public getConcreteEntityAdapter(name: string): ConcreteEntityAdapter | undefined {
+        const concreteEntity = this.concreteEntities.find((entity) => entity.name === name);
+        return concreteEntity ? new ConcreteEntityAdapter(concreteEntity) : undefined;
+    }
+
     public getEntitiesByLabels(labels: string[]): ConcreteEntity[] {
         return this.concreteEntities.filter((entity) => entity.matchLabels(labels));
     }

packages/graphql/src/schema-model/annotation/Annotation.ts

@@ -19,23 +19,81 @@
 
 import { AuthenticationAnnotation } from "./AuthenticationAnnotation";
 import { AuthorizationAnnotation } from "./AuthorizationAnnotation";
+import { CoalesceAnnotation } from "./CoalesceAnnotation";
+import { CustomResolverAnnotation } from "./CustomResolverAnnotation";
 import { CypherAnnotation } from "./CypherAnnotation";
+import { DefaultAnnotation } from "./DefaultAnnotation";
+import { FilterableAnnotation } from "./FilterableAnnotation";
+import { FullTextAnnotation } from "./FullTextAnnotation";
+import { IDAnnotation } from "./IDAnnotation";
+import { JWTClaimAnnotation } from "./JWTClaimAnnotation";
+import { JWTPayloadAnnotation } from "./JWTPayloadAnnotation";
 import { KeyAnnotation } from "./KeyAnnotation";
+import { MutationAnnotation } from "./MutationAnnotation";
+import { PluralAnnotation } from "./PluralAnnotation";
+import { PopulatedByAnnotation } from "./PopulatedByAnnotation";
+import { PrivateAnnotation } from "./PrivateAnnotation";
+import { QueryAnnotation } from "./QueryAnnotation";
+import { QueryOptionsAnnotation } from "./QueryOptionsAnnotation";
+import { SelectableAnnotation } from "./SelectableAnnotation";
+import { SettableAnnotation } from "./SettableAnnotation";
+import { SubscriptionAnnotation } from "./SubscriptionAnnotation";
 import { SubscriptionsAuthorizationAnnotation } from "./SubscriptionsAuthorizationAnnotation";
+import { TimestampAnnotation } from "./TimestampAnnotation";
+import { UniqueAnnotation } from "./UniqueAnnotation";
 
 export type Annotation =
     | CypherAnnotation
     | AuthorizationAnnotation
     | AuthenticationAnnotation
     | KeyAnnotation
-    | SubscriptionsAuthorizationAnnotation;
+    | SubscriptionsAuthorizationAnnotation
+    | QueryOptionsAnnotation
+    | DefaultAnnotation
+    | CoalesceAnnotation
+    | CustomResolverAnnotation
+    | IDAnnotation
+    | MutationAnnotation
+    | PluralAnnotation
+    | FilterableAnnotation
+    | FullTextAnnotation
+    | PopulatedByAnnotation
+    | QueryAnnotation
+    | PrivateAnnotation
+    | SelectableAnnotation
+    | SettableAnnotation
+    | TimestampAnnotation
+    | UniqueAnnotation
+    | SubscriptionAnnotation
+    | JWTClaimAnnotation
+    | JWTPayloadAnnotation;
+
 
 export enum AnnotationsKey {
-    cypher = "cypher",
-    authorization = "authorization",
     authentication = "authentication",
+    authorization = "authorization",
+    coalesce = "coalesce",
+    customResolver = "customResolver",
+    cypher = "cypher",
+    default = "default",
+    filterable = "filterable",
+    fulltext = "fulltext",
+    id = "id",
+    jwtClaim = "jwtClaim",
+    jwtPayload = "jwtPayload",
     key = "key",
+    mutation = "mutation",
+    plural = "plural",
+    populatedBy = "populatedBy",
+    private = "private",
+    query = "query",
+    queryOptions = "queryOptions",
+    selectable = "selectable",
+    settable = "settable",
+    subscription = "subscription",
     subscriptionsAuthorization = "subscriptionsAuthorization",
+    timestamp = "timestamp",
+    unique = "unique",
 }
 
 export type Annotations = {
@@ -44,6 +102,25 @@ export type Annotations = {
     [AnnotationsKey.authentication]: AuthenticationAnnotation;
     [AnnotationsKey.key]: KeyAnnotation;
     [AnnotationsKey.subscriptionsAuthorization]: SubscriptionsAuthorizationAnnotation;
+    [AnnotationsKey.queryOptions]: QueryOptionsAnnotation;
+    [AnnotationsKey.default]: DefaultAnnotation;
+    [AnnotationsKey.coalesce]: CoalesceAnnotation;
+    [AnnotationsKey.customResolver]: CustomResolverAnnotation;
+    [AnnotationsKey.id]: IDAnnotation;
+    [AnnotationsKey.mutation]: MutationAnnotation;
+    [AnnotationsKey.plural]: PluralAnnotation;
+    [AnnotationsKey.filterable]: FilterableAnnotation;
+    [AnnotationsKey.fulltext]: FullTextAnnotation;
+    [AnnotationsKey.populatedBy]: PopulatedByAnnotation;
+    [AnnotationsKey.query]: QueryAnnotation;
+    [AnnotationsKey.private]: PrivateAnnotation;
+    [AnnotationsKey.selectable]: SelectableAnnotation;
+    [AnnotationsKey.settable]: SettableAnnotation;
+    [AnnotationsKey.timestamp]: TimestampAnnotation;
+    [AnnotationsKey.unique]: UniqueAnnotation;
+    [AnnotationsKey.subscription]: SubscriptionAnnotation;
+    [AnnotationsKey.jwtClaim]: JWTClaimAnnotation;
+    [AnnotationsKey.jwtPayload]: JWTPayloadAnnotation;
 };
 
 export function annotationToKey(ann: Annotation): keyof Annotations {
@@ -52,5 +129,24 @@ export function annotationToKey(ann: Annotation): keyof Annotations {
     if (ann instanceof AuthenticationAnnotation) return AnnotationsKey.authentication;
     if (ann instanceof KeyAnnotation) return AnnotationsKey.key;
     if (ann instanceof SubscriptionsAuthorizationAnnotation) return AnnotationsKey.subscriptionsAuthorization;
+    if (ann instanceof QueryOptionsAnnotation) return AnnotationsKey.queryOptions;
+    if (ann instanceof DefaultAnnotation) return AnnotationsKey.default;
+    if (ann instanceof CoalesceAnnotation) return AnnotationsKey.coalesce;
+    if (ann instanceof CustomResolverAnnotation) return AnnotationsKey.customResolver;
+    if (ann instanceof IDAnnotation) return AnnotationsKey.id;
+    if (ann instanceof MutationAnnotation) return AnnotationsKey.mutation;
+    if (ann instanceof PluralAnnotation) return AnnotationsKey.plural;
+    if (ann instanceof FilterableAnnotation) return AnnotationsKey.filterable;
+    if (ann instanceof FullTextAnnotation) return AnnotationsKey.fulltext;
+    if (ann instanceof PopulatedByAnnotation) return AnnotationsKey.populatedBy;
+    if (ann instanceof QueryAnnotation) return AnnotationsKey.query;
+    if (ann instanceof PrivateAnnotation) return AnnotationsKey.private;
+    if (ann instanceof SelectableAnnotation) return AnnotationsKey.selectable;
+    if (ann instanceof SettableAnnotation) return AnnotationsKey.settable;
+    if (ann instanceof TimestampAnnotation) return AnnotationsKey.timestamp;
+    if (ann instanceof UniqueAnnotation) return AnnotationsKey.unique;
+    if (ann instanceof SubscriptionAnnotation) return AnnotationsKey.subscription;
+    if (ann instanceof JWTClaimAnnotation) return AnnotationsKey.jwtClaim;
+    if (ann instanceof JWTPayloadAnnotation) return AnnotationsKey.jwtPayload;
     throw new Error("annotation not known");
 }

packages/graphql/src/schema-model/annotation/CoalesceAnnotation.ts

@@ -0,0 +1,28 @@
+/*
+ * Copyright (c) "Neo4j"
+ * Neo4j Sweden AB [http://neo4j.com]
+ *
+ * This file is part of Neo4j.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+export type CoalesceAnnotationValue = string | number | boolean;
+
+export class CoalesceAnnotation {
+    public readonly value: CoalesceAnnotationValue;
+
+    constructor({ value }: { value: CoalesceAnnotationValue }) {
+        this.value = value;
+    }
+}

packages/graphql/src/schema-model/annotation/CustomResolverAnnotation.ts

@@ -0,0 +1,26 @@
+/*
+ * Copyright (c) "Neo4j"
+ * Neo4j Sweden AB [http://neo4j.com]
+ *
+ * This file is part of Neo4j.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+export class CustomResolverAnnotation {
+    public readonly requires: string;
+
+    constructor({ requires }: { requires: string }) {
+        this.requires = requires;
+    }
+}

packages/graphql/src/schema-model/annotation/CypherAnnotation.ts

@@ -17,11 +17,12 @@
  * limitations under the License.
  */
 
-
 export class CypherAnnotation {
     public statement: string;
+    public columnName: string;
 
-    constructor({ statement }: { statement: string }) {
+    constructor({ statement, columnName }: { statement: string, columnName: string }) {
         this.statement = statement;
+        this.columnName = columnName;
     }
 }

packages/graphql/src/schema-model/annotation/DefaultAnnotation.ts

@@ -0,0 +1,28 @@
+/*
+ * Copyright (c) "Neo4j"
+ * Neo4j Sweden AB [http://neo4j.com]
+ *
+ * This file is part of Neo4j.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+export type DefaultAnnotationValue = string | number | boolean;
+
+export class DefaultAnnotation {
+    public readonly value: DefaultAnnotationValue;
+
+    constructor({ value }: { value: DefaultAnnotationValue }) {
+        this.value = value;
+    }
+}

packages/graphql/src/schema-model/annotation/FilterableAnnotation.ts

@@ -0,0 +1,28 @@
+/*
+ * Copyright (c) "Neo4j"
+ * Neo4j Sweden AB [http://neo4j.com]
+ *
+ * This file is part of Neo4j.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+export class FilterableAnnotation {
+    public readonly byValue: boolean;
+    public readonly byAggregate: boolean;
+
+    constructor({ byValue, byAggregate }: { byValue: boolean; byAggregate: boolean }) {
+        this.byValue = byValue;
+        this.byAggregate = byAggregate;
+    }
+}