Merge pull request #3270 from SeedCompany/filter-partnership-types

Author: CarsonF

src/common/filter-field.ts

@@ -1,5 +1,5 @@
 import { applyDecorators } from '@nestjs/common';
-import { Field } from '@nestjs/graphql';
+import { Field, FieldOptions } from '@nestjs/graphql';
 import { Type } from 'class-transformer';
 import { ValidateNested } from 'class-validator';
 import { Constructor, HasRequiredKeys } from 'type-fest';
@@ -15,14 +15,15 @@ export const FilterField = <T extends object>(
      * There are no external fields on the filter, so don't expose to GQL.
      */
     internal?: boolean;
-  },
+  } & Pick<FieldOptions, 'description'>,
 ): PropertyDecorator =>
   applyDecorators(
     ...(options?.internal
       ? []
       : [
           Field(type as unknown as () => Constructor<T>, {
             nullable: true,
+            description: options?.description,
           }),
         ]),
     Type(type),

src/components/partnership/dto/list-partnership.dto.ts

@@ -1,12 +1,14 @@
-import { InputType, ObjectType } from '@nestjs/graphql';
+import { Field, InputType, ObjectType } from '@nestjs/graphql';
+import { Transform } from 'class-transformer';
+import { uniq } from 'lodash';
 import {
   FilterField,
   ID,
   PaginatedList,
   SecuredList,
   SortablePaginationInput,
 } from '~/common';
-import { PartnerFilters } from '../../partner/dto';
+import { PartnerFilters, PartnerType } from '../../partner/dto';
 import { Partnership } from './partnership.dto';
 
 @InputType()
@@ -15,6 +17,15 @@ export abstract class PartnershipFilters {
 
   @FilterField(() => PartnerFilters)
   readonly partner?: PartnerFilters & {};
+
+  @Field(() => [PartnerType], { nullable: true })
+  @Transform(({ value }) => {
+    const types = uniq(value);
+    return types.length > 0 && types.length < PartnerType.values.size
+      ? types
+      : undefined;
+  })
+  readonly types?: readonly PartnerType[];
 }
 
 @InputType()

src/components/partnership/partnership.repository.ts

@@ -406,6 +406,7 @@ export class PartnershipRepository extends DtoRepository<
 
 export const partnershipFilters = filter.define(() => PartnershipFilters, {
   projectId: filter.skip,
+  types: filter.intersectsProp(),
   partner: filter.sub(() => partnerFilters)((sub) =>
     sub
       .with('node as partnership')

src/components/project/dto/list-projects.dto.ts

@@ -109,6 +109,11 @@ export abstract class ProjectFilters {
 
   readonly userId?: ID;
 
+  @FilterField(() => PartnershipFilters, {
+    description: 'Only projects with _any_ partnerships matching these filters',
+  })
+  readonly partnerships?: PartnershipFilters & {};
+
   @FilterField(() => PartnershipFilters)
   readonly primaryPartnership?: PartnershipFilters & {};
 

src/components/project/project-filters.query.ts

@@ -100,6 +100,15 @@ export const projectFilters = filter.define(() => ProjectFilters, {
             .with('*')
             .where({ sensitivity: inArray(value) })
         : query,
+  partnerships: filter.sub(() => partnershipFilters)((sub) =>
+    sub
+      .with('node as project')
+      .match([
+        node('project'),
+        relation('out', '', 'partnership', ACTIVE),
+        node('node', 'Partnership'),
+      ]),
+  ),
   primaryPartnership: filter.sub(() => partnershipFilters)((sub) =>
     sub
       .with('node as project')

src/core/database/query/comparators.ts

@@ -0,0 +1,9 @@
+import type { Comparator } from 'cypher-query-builder/dist/typings/clauses/where-comparators';
+import type { Variable } from '../query-augmentation/condition-variables';
+
+export const intersects =
+  (value: readonly string[] | Variable, paramName?: string): Comparator =>
+  (params, name) => {
+    const param = params.addParam(value, paramName ?? name.split('.').at(-1));
+    return `size(apoc.coll.intersection(${name}, ${String(param)})) > 0`;
+  };

src/core/database/query/filters.ts

@@ -16,6 +16,7 @@ import { identity, isFunction } from 'lodash';
 import { AbstractClass, ConditionalKeys } from 'type-fest';
 import { DateTimeFilter } from '~/common';
 import { variable } from '../query-augmentation/condition-variables';
+import { intersects } from './comparators';
 import { collect } from './cypher-functions';
 import { escapeLuceneSyntax, FullTextIndex } from './full-text';
 import { ACTIVE } from './matching';
@@ -132,6 +133,20 @@ export const propPartialVal =
     return { [prop ?? key]: { value: regexp(`.*${value}.*`, true) } };
   };
 
+export const intersectsProp =
+  <T, K extends ConditionalKeys<Required<T>, readonly string[]>>(
+    prop?: string,
+  ): Builder<T, K> =>
+  ({ key, value, query }) => {
+    prop ??= key;
+    query.match([
+      node('node'),
+      relation('out', '', prop, ACTIVE),
+      node(prop, 'Property'),
+    ]);
+    return { [`${prop}.value`]: intersects(value as readonly string[], prop) };
+  };
+
 export const stringListProp =
   <T, K extends ConditionalKeys<Required<T>, readonly string[]>>(
     prop?: string,
@@ -234,7 +249,11 @@ export const sub =
         sub
           .apply(matchSubNode)
           .apply(subBuilder()(value))
-          .return(`true as ${key}FiltersApplied`),
+          .return(`true as ${key}FiltersApplied`)
+          // Prevent filter from increasing cardinality above 1.
+          // This happens with `1-Many` relationships matched in `matchSubNode`.
+          // Note they are allowed to reduce cardinality to 0.
+          .raw('limit 1'),
       )
       .with('*');