New style sorting/filtering for Orgs, Partners, Partnerships

Author: CarsonF

src/components/organization/organization.repository.ts

@@ -11,6 +11,8 @@ import { DtoRepository } from '~/core/database';
 import {
   ACTIVE,
   createNode,
+  defineSorters,
+  filter,
   matchProjectScopedRoles,
   matchProjectSens,
   matchProps,
@@ -19,11 +21,12 @@ import {
   paginate,
   rankSens,
   requestingUser,
-  sorting,
+  sortWith,
 } from '~/core/database/query';
 import {
   CreateOrganization,
   Organization,
+  OrganizationFilters,
   OrganizationListInput,
   UpdateOrganization,
 } from './dto';
@@ -111,20 +114,12 @@ export class OrganizationRepository extends DtoRepository<
         );
   }
 
-  async list({ filter, ...input }: OrganizationListInput, session: Session) {
+  async list(input: OrganizationListInput, session: Session) {
     const query = this.db
       .query()
       .matchNode('node', 'Organization')
-      .match([
-        ...(filter?.userId && session.userId
-          ? [
-              node('node'),
-              relation('in', '', 'organization', ACTIVE),
-              node('user', 'User', { id: filter.userId }),
-            ]
-          : []),
-      ])
       .match(requestingUser(session))
+      .apply(organizationFilters(input.filter))
       .apply(
         this.privileges.forUser(session).filterToReadable({
           wrapContext: (inner) => (query) =>
@@ -141,8 +136,18 @@ export class OrganizationRepository extends DtoRepository<
               .apply(oncePerProject(inner)),
         }),
       )
-      .apply(sorting(Organization, input))
+      .apply(sortWith(organizationSorters, input))
       .apply(paginate(input, this.hydrate(session)));
     return (await query.first())!; // result from paginate() will always have 1 row.
   }
 }
+
+export const organizationFilters = filter.define(() => OrganizationFilters, {
+  userId: filter.pathExists((id) => [
+    node('node'),
+    relation('in', '', 'organization', ACTIVE),
+    node('', 'User', { id }),
+  ]),
+});
+
+export const organizationSorters = defineSorters(Organization, {});

src/components/partner/partner.repository.ts

@@ -16,6 +16,7 @@ import {
   collect,
   createNode,
   createRelationships,
+  defineSorters,
   filter as filters,
   matchProjectScopedRoles,
   matchProjectSens,
@@ -25,9 +26,15 @@ import {
   paginate,
   rankSens,
   requestingUser,
-  sorting,
+  sortWith,
 } from '~/core/database/query';
-import { CreatePartner, Partner, PartnerListInput, UpdatePartner } from './dto';
+import {
+  CreatePartner,
+  Partner,
+  PartnerFilters,
+  PartnerListInput,
+  UpdatePartner,
+} from './dto';
 
 @Injectable()
 export class PartnerRepository extends DtoRepository<
@@ -262,28 +269,12 @@ export class PartnerRepository extends DtoRepository<
         );
   }
 
-  async list({ filter, ...input }: PartnerListInput, session: Session) {
+  async list(input: PartnerListInput, session: Session) {
     const result = await this.db
       .query()
       .matchNode('node', 'Partner')
-      .match([
-        ...(filter?.userId && session.userId
-          ? [
-              node('node'),
-              relation('out', '', 'organization', ACTIVE),
-              node('', 'Organization'),
-              relation('in', '', 'organization', ACTIVE),
-              node('user', 'User', { id: filter.userId }),
-            ]
-          : []),
-      ])
       .match(requestingUser(session))
-      .apply(
-        filters.builder(filter ?? {}, {
-          pinned: filters.isPinned,
-          userId: filters.skip, // already applied above
-        }),
-      )
+      .apply(partnerFilters(input.filter))
       .apply(
         this.privileges.forUser(session).filterToReadable({
           wrapContext: (inner) => (query) =>
@@ -298,22 +289,33 @@ export class PartnerRepository extends DtoRepository<
               .apply(oncePerProject(inner)),
         }),
       )
-      .apply(
-        sorting(Partner, input, {
-          name: (query) =>
-            query
-              .match([
-                node('node'),
-                relation('out', '', 'organization', ACTIVE),
-                node('organization', 'Organization'),
-                relation('out', '', 'name', ACTIVE),
-                node('prop', 'Property'),
-              ])
-              .return<{ sortValue: string }>('prop.value as sortValue'),
-        }),
-      )
+      .apply(sortWith(partnerSorters, input))
       .apply(paginate(input, this.hydrate(session)))
       .first();
     return result!; // result from paginate() will always have 1 row.
   }
 }
+
+export const partnerFilters = filters.define(() => PartnerFilters, {
+  pinned: filters.isPinned,
+  userId: filters.pathExists((id) => [
+    node('node'),
+    relation('out', '', 'organization', ACTIVE),
+    node('', 'Organization'),
+    relation('in', '', 'organization', ACTIVE),
+    node('', 'User', { id }),
+  ]),
+});
+
+export const partnerSorters = defineSorters(Partner, {
+  name: (query) =>
+    query
+      .match([
+        node('node'),
+        relation('out', '', 'organization', ACTIVE),
+        node('organization', 'Organization'),
+        relation('out', '', 'name', ACTIVE),
+        node('prop', 'Property'),
+      ])
+      .return<{ sortValue: string }>('prop.value as sortValue'),
+});

src/components/partnership/partnership.repository.ts

@@ -20,6 +20,8 @@ import {
   coalesce,
   createNode,
   createRelationships,
+  defineSorters,
+  filter,
   INACTIVE,
   matchChangesetAndChangedProps,
   matchProps,
@@ -28,7 +30,7 @@ import {
   oncePerProject,
   paginate,
   requestingUser,
-  sorting,
+  sortWith,
   whereNotDeletedInChangeset,
 } from '~/core/database/query';
 import { FileService } from '../file';
@@ -37,6 +39,7 @@ import {
   CreatePartnership,
   Partnership,
   PartnershipAgreementStatus,
+  PartnershipFilters,
   PartnershipListInput,
   UpdatePartnership,
 } from './dto';
@@ -233,12 +236,13 @@ export class PartnershipRepository extends DtoRepository<
           ),
       )
       .match(requestingUser(session))
+      .apply(partnershipFilters(input.filter))
       .apply(
         this.privileges.forUser(session).filterToReadable({
           wrapContext: oncePerProject,
         }),
       )
-      .apply(sorting(Partnership, input))
+      .apply(sortWith(partnershipSorters, input))
       .apply(paginate(input, this.hydrate(session, viewOfChangeset(changeset))))
       .first();
     return result!; // result from paginate() will always have 1 row.
@@ -398,3 +402,9 @@ export class PartnershipRepository extends DtoRepository<
     };
   }
 }
+
+export const partnershipFilters = filter.define(() => PartnershipFilters, {
+  projectId: filter.skip,
+});
+
+export const partnershipSorters = defineSorters(Partnership, {});