API Generator: Add search argument to OneToManyFilter and `ManyTo…

…ManyFilter` (#2238)

This PR adds search filter to OneToMany and ManyToMany relations, that
can be used where a select is impossible to use because of too many
related entities. Doing a poor-mans fulltext search doesn't have this
problem (also has poor performance on the server side though)

The old method (how search was implemented for list queries) didn't
apply here well, so I decided do go a different approach: Instead of
generating code (the service) that lists all fields to query, we find
those fields at runtime now. We are using (1) MikroORM metadata and (2)
our CrudField resolver, the search boolean. Just as before.

And with this new approach it is possible to do that also for related
entities that makes implementing the search possible.

---------

Co-authored-by: Johannes Obermair <[email protected]>

.changeset/gorgeous-islands-perform.md

@@ -0,0 +1,5 @@
+---
+"@comet/cms-api": major
+---
+
+filtersToMikroOrmQuery: Move second argument (`applyFilter` callback) into an options object

.changeset/sixty-cougars-begin.md

@@ -0,0 +1,7 @@
+---
+"@comet/cms-api": minor
+---
+
+API Generator: Add `search` argument to `OneToManyFilter` and `ManyToManyFilter`
+
+Performs a search like the `search` argument in the list query.

.changeset/ten-buses-lie.md

@@ -0,0 +1,9 @@
+---
+"@comet/cms-api": major
+---
+
+API Generator: Remove generated service
+
+The `Service#getFindCondition` method is replaced with the new `gqlArgsToMikroOrmQuery` function, which detects an entity's searchable fields from its metadata.
+Consequently, the generated service isn't needed anymore and will therefore no longer be generated.
+Remove the service from the module after re-running the API Generator.

demo/admin/src/products/ProductsGrid.tsx

@@ -21,7 +21,7 @@ import {
 import { Add as AddIcon, Edit, StateFilled } from "@comet/admin-icons";
 import { DamImageBlock } from "@comet/cms-admin";
 import { Button, IconButton, useTheme } from "@mui/material";
-import { DataGridPro, GridFilterInputSingleSelect, GridToolbarQuickFilter } from "@mui/x-data-grid-pro";
+import { DataGridPro, GridFilterInputSingleSelect, GridFilterInputValue, GridToolbarQuickFilter } from "@mui/x-data-grid-pro";
 import gql from "graphql-tag";
 import * as React from "react";
 import { FormattedMessage, FormattedNumber, useIntl } from "react-intl";
@@ -150,14 +150,14 @@ export function ProductsGrid() {
             renderCell: (params) => <>{params.row.tags.map((tag) => tag.title).join(", ")}</>,
             filterOperators: [
                 {
-                    value: "contains",
+                    label: "Search",
+                    value: "search",
                     getApplyFilterFn: (filterItem) => {
                         throw new Error("not implemented, we filter server side");
                     },
-                    InputComponent: GridFilterInputSingleSelect,
+                    InputComponent: GridFilterInputValue,
                 },
             ],
-            valueOptions: relationsData?.productTags.nodes.map((i) => ({ value: i.id, label: i.title })),
         },
         {
             field: "inStock",

demo/api/schema.gql

@@ -454,16 +454,6 @@ type ManufacturerCountry {
   used: Float!
 }
 
-type PaginatedManufacturers {
-  nodes: [Manufacturer!]!
-  totalCount: Int!
-}
-
-type PaginatedManufacturerCountries {
-  nodes: [ManufacturerCountry!]!
-  totalCount: Int!
-}
-
 type ProductCategory {
   id: ID!
   title: String!
@@ -563,6 +553,16 @@ enum ProductType {
   Tie
 }
 
+type PaginatedManufacturers {
+  nodes: [Manufacturer!]!
+  totalCount: Int!
+}
+
+type PaginatedManufacturerCountries {
+  nodes: [ManufacturerCountry!]!
+  totalCount: Int!
+}
+
 type PaginatedProducts {
   nodes: [Product!]!
   totalCount: Int!
@@ -915,6 +915,7 @@ input NewsCategoryEnumFilter {
 
 input OneToManyFilter {
   contains: ID
+  search: String
 }
 
 input NewsSort {
@@ -988,6 +989,7 @@ input ManyToOneFilter {
 
 input ManyToManyFilter {
   contains: ID
+  search: String
 }
 
 input ProductSort {

demo/api/src/news/generated/news.resolver.ts

@@ -5,6 +5,7 @@ import {
     BlocksTransformerService,
     DamImageBlock,
     extractGraphqlFields,
+    gqlArgsToMikroOrmQuery,
     RequiredPermission,
     RootBlockDataScalar,
 } from "@comet/cms-api";
@@ -20,14 +21,12 @@ import { NewsComment } from "../entities/news-comment.entity";
 import { NewsInput, NewsUpdateInput } from "./dto/news.input";
 import { NewsListArgs } from "./dto/news-list.args";
 import { PaginatedNews } from "./dto/paginated-news";
-import { NewsService } from "./news.service";
 
 @Resolver(() => News)
 @RequiredPermission(["news"])
 export class NewsResolver {
     constructor(
         private readonly entityManager: EntityManager,
-        private readonly newsService: NewsService,
         @InjectRepository(News) private readonly repository: EntityRepository<News>,
         private readonly blocksTransformer: BlocksTransformerService,
     ) {}
@@ -51,7 +50,7 @@ export class NewsResolver {
         @Args() { scope, status, search, filter, sort, offset, limit }: NewsListArgs,
         @Info() info: GraphQLResolveInfo,
     ): Promise<PaginatedNews> {
-        const where = this.newsService.getFindCondition({ search, filter });
+        const where = gqlArgsToMikroOrmQuery({ search, filter }, this.repository);
         where.status = { $in: status };
         where.scope = scope;
 

demo/api/src/news/news.module.ts

@@ -5,7 +5,6 @@ import { News, NewsContentScope } from "@src/news/entities/news.entity";
 
 import { NewsComment } from "./entities/news-comment.entity";
 import { NewsResolver } from "./generated/news.resolver";
-import { NewsService } from "./generated/news.service";
 import { NewsCommentResolver } from "./news-comment.resolver";
 import { NewsFieldResolver } from "./news-field.resolver";
 
@@ -14,7 +13,6 @@ import { NewsFieldResolver } from "./news-field.resolver";
     providers: [
         NewsResolver,
         NewsCommentResolver,
-        NewsService,
         NewsFieldResolver,
         DependenciesResolverFactory.create(News),
         DependentsResolverFactory.create(News),

demo/api/src/products/generated/manufacturer-country.resolver.ts

@@ -1,6 +1,6 @@
 // This file has been generated by comet api-generator.
 // You may choose to use this file as scaffold by moving this file out of generated folder and removing this comment.
-import { AffectedEntity, RequiredPermission } from "@comet/cms-api";
+import { AffectedEntity, gqlArgsToMikroOrmQuery, RequiredPermission } from "@comet/cms-api";
 import { FindOptions } from "@mikro-orm/core";
 import { InjectRepository } from "@mikro-orm/nestjs";
 import { EntityManager, EntityRepository } from "@mikro-orm/postgresql";
@@ -9,14 +9,12 @@ import { Args, ID, Query, Resolver } from "@nestjs/graphql";
 import { ManufacturerCountry } from "../entities/manufacturer-country.entity";
 import { ManufacturerCountriesArgs } from "./dto/manufacturer-countries.args";
 import { PaginatedManufacturerCountries } from "./dto/paginated-manufacturer-countries";
-import { ManufacturerCountriesService } from "./manufacturer-countries.service";
 
 @Resolver(() => ManufacturerCountry)
 @RequiredPermission(["manufacturerCountries"], { skipScopeCheck: true })
 export class ManufacturerCountryResolver {
     constructor(
         private readonly entityManager: EntityManager,
-        private readonly manufacturerCountriesService: ManufacturerCountriesService,
         @InjectRepository(ManufacturerCountry) private readonly repository: EntityRepository<ManufacturerCountry>,
     ) {}
 
@@ -29,7 +27,7 @@ export class ManufacturerCountryResolver {
 
     @Query(() => PaginatedManufacturerCountries)
     async manufacturerCountries(@Args() { search, filter, offset, limit }: ManufacturerCountriesArgs): Promise<PaginatedManufacturerCountries> {
-        const where = this.manufacturerCountriesService.getFindCondition({ search, filter });
+        const where = gqlArgsToMikroOrmQuery({ search, filter }, this.repository);
 
         const options: FindOptions<ManufacturerCountry> = { offset, limit };
 

demo/api/src/products/generated/manufacturer.resolver.ts

@@ -1,6 +1,6 @@
 // This file has been generated by comet api-generator.
 // You may choose to use this file as scaffold by moving this file out of generated folder and removing this comment.
-import { AffectedEntity, RequiredPermission } from "@comet/cms-api";
+import { AffectedEntity, gqlArgsToMikroOrmQuery, RequiredPermission } from "@comet/cms-api";
 import { FindOptions } from "@mikro-orm/core";
 import { InjectRepository } from "@mikro-orm/nestjs";
 import { EntityManager, EntityRepository } from "@mikro-orm/postgresql";
@@ -10,14 +10,12 @@ import { Manufacturer } from "../entities/manufacturer.entity";
 import { ManufacturerInput, ManufacturerUpdateInput } from "./dto/manufacturer.input";
 import { ManufacturersArgs } from "./dto/manufacturers.args";
 import { PaginatedManufacturers } from "./dto/paginated-manufacturers";
-import { ManufacturersService } from "./manufacturers.service";
 
 @Resolver(() => Manufacturer)
 @RequiredPermission(["manufacturers"], { skipScopeCheck: true })
 export class ManufacturerResolver {
     constructor(
         private readonly entityManager: EntityManager,
-        private readonly manufacturersService: ManufacturersService,
         @InjectRepository(Manufacturer) private readonly repository: EntityRepository<Manufacturer>,
     ) {}
 
@@ -30,7 +28,7 @@ export class ManufacturerResolver {
 
     @Query(() => PaginatedManufacturers)
     async manufacturers(@Args() { search, filter, sort, offset, limit }: ManufacturersArgs): Promise<PaginatedManufacturers> {
-        const where = this.manufacturersService.getFindCondition({ search, filter });
+        const where = gqlArgsToMikroOrmQuery({ search, filter }, this.repository);
 
         const options: FindOptions<Manufacturer> = { offset, limit };
 

demo/api/src/products/generated/product-category.resolver.ts

@@ -1,6 +1,6 @@
 // This file has been generated by comet api-generator.
 // You may choose to use this file as scaffold by moving this file out of generated folder and removing this comment.
-import { AffectedEntity, extractGraphqlFields, RequiredPermission } from "@comet/cms-api";
+import { AffectedEntity, extractGraphqlFields, gqlArgsToMikroOrmQuery, RequiredPermission } from "@comet/cms-api";
 import { FindOptions } from "@mikro-orm/core";
 import { InjectRepository } from "@mikro-orm/nestjs";
 import { EntityManager, EntityRepository } from "@mikro-orm/postgresql";
@@ -12,14 +12,12 @@ import { ProductCategory } from "../entities/product-category.entity";
 import { PaginatedProductCategories } from "./dto/paginated-product-categories";
 import { ProductCategoriesArgs } from "./dto/product-categories.args";
 import { ProductCategoryInput, ProductCategoryUpdateInput } from "./dto/product-category.input";
-import { ProductCategoriesService } from "./product-categories.service";
 
 @Resolver(() => ProductCategory)
 @RequiredPermission(["products"], { skipScopeCheck: true })
 export class ProductCategoryResolver {
     constructor(
         private readonly entityManager: EntityManager,
-        private readonly productCategoriesService: ProductCategoriesService,
         @InjectRepository(ProductCategory) private readonly repository: EntityRepository<ProductCategory>,
     ) {}
 
@@ -42,7 +40,7 @@ export class ProductCategoryResolver {
         @Args() { search, filter, sort, offset, limit }: ProductCategoriesArgs,
         @Info() info: GraphQLResolveInfo,
     ): Promise<PaginatedProductCategories> {
-        const where = this.productCategoriesService.getFindCondition({ search, filter });
+        const where = gqlArgsToMikroOrmQuery({ search, filter }, this.repository);
 
         const fields = extractGraphqlFields(info, { root: "nodes" });
         const populate: string[] = [];

demo/api/src/products/generated/product-tag.resolver.ts

@@ -1,6 +1,6 @@
 // This file has been generated by comet api-generator.
 // You may choose to use this file as scaffold by moving this file out of generated folder and removing this comment.
-import { AffectedEntity, extractGraphqlFields, RequiredPermission } from "@comet/cms-api";
+import { AffectedEntity, extractGraphqlFields, gqlArgsToMikroOrmQuery, RequiredPermission } from "@comet/cms-api";
 import { FindOptions, Reference } from "@mikro-orm/core";
 import { InjectRepository } from "@mikro-orm/nestjs";
 import { EntityManager, EntityRepository } from "@mikro-orm/postgresql";
@@ -13,14 +13,12 @@ import { ProductToTag } from "../entities/product-to-tag.entity";
 import { PaginatedProductTags } from "./dto/paginated-product-tags";
 import { ProductTagInput, ProductTagUpdateInput } from "./dto/product-tag.input";
 import { ProductTagsArgs } from "./dto/product-tags.args";
-import { ProductTagsService } from "./product-tags.service";
 
 @Resolver(() => ProductTag)
 @RequiredPermission(["products"], { skipScopeCheck: true })
 export class ProductTagResolver {
     constructor(
         private readonly entityManager: EntityManager,
-        private readonly productTagsService: ProductTagsService,
         @InjectRepository(ProductTag) private readonly repository: EntityRepository<ProductTag>,
         @InjectRepository(ProductToTag) private readonly productToTagRepository: EntityRepository<ProductToTag>,
         @InjectRepository(Product) private readonly productRepository: EntityRepository<Product>,
@@ -38,7 +36,7 @@ export class ProductTagResolver {
         @Args() { search, filter, sort, offset, limit }: ProductTagsArgs,
         @Info() info: GraphQLResolveInfo,
     ): Promise<PaginatedProductTags> {
-        const where = this.productTagsService.getFindCondition({ search, filter });
+        const where = gqlArgsToMikroOrmQuery({ search, filter }, this.repository);
 
         const fields = extractGraphqlFields(info, { root: "nodes" });
         const populate: string[] = [];