Merge pull request #5879 from neo4j/aggregation-filters

Aggregation filters

.changeset/silly-toys-sing.md

@@ -0,0 +1,13 @@
+---
+"@neo4j/graphql": patch
+---
+
+Add generic filters for aggregations:
+
+```graphql
+{
+    posts(where: { likesAggregate: { node: { rating: { average: { eq: 3.2 } } } } }) {
+        title
+    }
+}
+```

packages/graphql/src/graphql/input-objects/generic-aggregation-filters/BigIntScalarAggregationFilters.ts

@@ -0,0 +1,32 @@
+/*
+ * 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.
+ */
+
+import { GraphQLInputObjectType } from "graphql";
+import { BigIntScalarFilters } from "../generic-operators/BigIntScalarFilters";
+
+export const BigIntScalarAggregationFilters = new GraphQLInputObjectType({
+    name: "BigIntScalarAggregationFilters",
+    description: "Filters for an aggregation of an BigInt field",
+    fields: {
+        average: { type: BigIntScalarFilters },
+        max: { type: BigIntScalarFilters },
+        min: { type: BigIntScalarFilters },
+        sum: { type: BigIntScalarFilters },
+    },
+});

packages/graphql/src/graphql/input-objects/generic-aggregation-filters/DateTimeScalarAggregationFilters.ts

@@ -0,0 +1,30 @@
+/*
+ * 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.
+ */
+
+import { GraphQLInputObjectType } from "graphql";
+import { DateTimeScalarFilters } from "../generic-operators/DateTimeScalarFilters";
+
+export const DateTimeScalarAggregationFilters = new GraphQLInputObjectType({
+    name: "DateTimeScalarAggregationFilters",
+    description: "Filters for an aggregation of an DateTime input field",
+    fields: {
+        max: { type: DateTimeScalarFilters },
+        min: { type: DateTimeScalarFilters },
+    },
+});

packages/graphql/src/graphql/input-objects/generic-aggregation-filters/DurationScalarAggregationFilters.ts

@@ -0,0 +1,31 @@
+/*
+ * 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.
+ */
+
+import { GraphQLInputObjectType } from "graphql";
+import { DurationScalarFilters } from "../generic-operators/DurationScalarFilters";
+
+export const DurationScalarAggregationFilters = new GraphQLInputObjectType({
+    name: "DurationScalarAggregationFilters",
+    description: "Filters for an aggregation of a Dutation input field",
+    fields: {
+        max: { type: DurationScalarFilters },
+        min: { type: DurationScalarFilters },
+        average: { type: DurationScalarFilters },
+    },
+});

packages/graphql/src/graphql/input-objects/generic-aggregation-filters/FloatScalarAggregationFilters.ts

@@ -0,0 +1,32 @@
+/*
+ * 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.
+ */
+
+import { GraphQLInputObjectType } from "graphql";
+import { FloatScalarFilters } from "../generic-operators/FloatScalarFilters";
+
+export const FloatScalarAggregationFilters = new GraphQLInputObjectType({
+    name: "FloatScalarAggregationFilters",
+    description: "Filters for an aggregation of a float field",
+    fields: {
+        average: { type: FloatScalarFilters },
+        max: { type: FloatScalarFilters },
+        min: { type: FloatScalarFilters },
+        sum: { type: FloatScalarFilters },
+    },
+});

packages/graphql/src/graphql/input-objects/generic-aggregation-filters/IDScalarAggregationFilters.ts

@@ -0,0 +1,30 @@
+/*
+ * 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.
+ */
+
+import { GraphQLInputObjectType } from "graphql";
+import { IDScalarFilters } from "../generic-operators/IDScalarFilters";
+
+export const IDScalarAggregationFilters = new GraphQLInputObjectType({
+    name: "IDScalarAggregationFilters",
+    description: "Filters for an aggregation of an ID input field",
+    fields: {
+        max: { type: IDScalarFilters },
+        min: { type: IDScalarFilters },
+    },
+});

packages/graphql/src/graphql/input-objects/generic-aggregation-filters/IntScalarAggregationFilters.ts

@@ -0,0 +1,33 @@
+/*
+ * 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.
+ */
+
+import { GraphQLInputObjectType } from "graphql";
+import { FloatScalarFilters } from "../generic-operators/FloatScalarFilters";
+import { IntScalarFilters } from "../generic-operators/IntScalarFilters";
+
+export const IntScalarAggregationFilters = new GraphQLInputObjectType({
+    name: "IntScalarAggregationFilters",
+    description: "Filters for an aggregation of an int field",
+    fields: {
+        average: { type: FloatScalarFilters },
+        max: { type: IntScalarFilters },
+        min: { type: IntScalarFilters },
+        sum: { type: IntScalarFilters },
+    },
+});

packages/graphql/src/graphql/input-objects/generic-aggregation-filters/LocalDateTimeScalarAggregationFilters.ts

@@ -0,0 +1,30 @@
+/*
+ * 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.
+ */
+
+import { GraphQLInputObjectType } from "graphql";
+import { LocalDateTimeScalarFilters } from "../generic-operators/LocalDateTimeScalarFilters";
+
+export const LocalDateTimeScalarAggregationFilters = new GraphQLInputObjectType({
+    name: "LocalDateTimeScalarAggregationFilters",
+    description: "Filters for an aggregation of an LocalDateTime input field",
+    fields: {
+        max: { type: LocalDateTimeScalarFilters },
+        min: { type: LocalDateTimeScalarFilters },
+    },
+});

packages/graphql/src/graphql/input-objects/generic-aggregation-filters/LocalTimeScalarAggregationFilters.ts

@@ -0,0 +1,30 @@
+/*
+ * 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.
+ */
+
+import { GraphQLInputObjectType } from "graphql";
+import { LocalTimeScalarFilters } from "../generic-operators/LocalTimeScalarFilters";
+
+export const LocalTimeScalarAggregationFilters = new GraphQLInputObjectType({
+    name: "LocalTimeScalarAggregationFilters",
+    description: "Filters for an aggregation of an LocalTime input field",
+    fields: {
+        max: { type: LocalTimeScalarFilters },
+        min: { type: LocalTimeScalarFilters },
+    },
+});

packages/graphql/src/graphql/input-objects/generic-aggregation-filters/StringScalarAggregationFilters.ts

@@ -0,0 +1,32 @@
+/*
+ * 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.
+ */
+
+import { GraphQLInputObjectType } from "graphql";
+import { FloatScalarFilters } from "../generic-operators/FloatScalarFilters";
+import { IntScalarFilters } from "../generic-operators/IntScalarFilters";
+
+export const StringScalarAggregationFilters = new GraphQLInputObjectType({
+    name: "StringScalarAggregationFilters",
+    description: "Filters for an aggregation of a string field",
+    fields: {
+        averageLength: { type: FloatScalarFilters },
+        shortestLength: { type: IntScalarFilters },
+        longestLength: { type: IntScalarFilters },
+    },
+});

packages/graphql/src/graphql/input-objects/generic-aggregation-filters/TimeScalarAggregationFilters.ts

@@ -0,0 +1,30 @@
+/*
+ * 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.
+ */
+
+import { GraphQLInputObjectType } from "graphql";
+import { TimeScalarFilters } from "../generic-operators/TimeScalarFilters";
+
+export const TimeScalarAggregationFilters = new GraphQLInputObjectType({
+    name: "TimeScalarAggregationFilters",
+    description: "Filters for an aggregation of an Time input field",
+    fields: {
+        max: { type: TimeScalarFilters },
+        min: { type: TimeScalarFilters },
+    },
+});

packages/graphql/src/schema/generation/aggregate-types.ts

@@ -26,6 +26,7 @@ import type {
     SchemaComposer,
 } from "graphql-compose";
 import { AGGREGATION_COMPARISON_OPERATORS, DEPRECATED } from "../../constants";
+import { IntScalarFilters } from "../../graphql/input-objects/generic-operators/IntScalarFilters";
 import type { AttributeAdapter } from "../../schema-model/attribute/model-adapters/AttributeAdapter";
 import { ConcreteEntityAdapter } from "../../schema-model/entity/model-adapters/ConcreteEntityAdapter";
 import { InterfaceEntityAdapter } from "../../schema-model/entity/model-adapters/InterfaceEntityAdapter";
@@ -35,6 +36,7 @@ import type { Neo4jFeaturesSettings } from "../../types";
 import type { AggregationTypesMapper } from "../aggregations/aggregation-types-mapper";
 import { numericalResolver } from "../resolvers/field/numerical";
 import { graphqlDirectivesToCompose } from "../to-compose";
+import { getAggregationFilterFromAttributeType } from "./get-aggregation-filter-from-attribute-type";
 
 export function withAggregateSelectionType({
     entityAdapter,
@@ -106,6 +108,7 @@ export function withAggregateInputType({
             count_LTE: GraphQLInt,
             count_GT: GraphQLInt,
             count_GTE: GraphQLInt,
+            count: IntScalarFilters,
         },
     });
 
@@ -190,6 +193,9 @@ function makeAggregationFields(
     const fields: InputTypeComposerFieldConfigMapDefinition = {};
     for (const attribute of attributes) {
         addAggregationFieldsByType(attribute, userDefinedDirectivesOnTargetFields?.get(attribute.name), fields);
+        if (attribute.isAggregationWhereField()) {
+            fields[attribute.name] = getAggregationFilterFromAttributeType(attribute);
+        }
     }
     return fields;
 }
@@ -218,6 +224,7 @@ function addAggregationFieldsByType(
                 directives: deprecatedDirectives,
             };
         }
+
         return fields;
     }
     if (attribute.typeHelper.isNumeric() || attribute.typeHelper.isDuration()) {
@@ -247,6 +254,7 @@ function addAggregationFieldsByType(
                   : GraphQLFloat;
             fields[`${attribute.name}_AVERAGE_${operator}`] = { type: averageType, directives: deprecatedDirectives };
         }
+
         return fields;
     }
     for (const operator of AGGREGATION_COMPARISON_OPERATORS) {