Merge pull request #3253 from SeedCompany/full-text-filters

Author: CarsonF

src/components/engagement/dto/list-engagements.dto.ts

@@ -24,6 +24,11 @@ export abstract class EngagementFilters {
   })
   readonly type?: 'language' | 'internship';
 
+  @Field({
+    nullable: true,
+  })
+  readonly name?: string;
+
   @Field(() => [EngagementStatus], {
     nullable: true,
   })

src/components/engagement/engagement.repository.ts

@@ -32,6 +32,7 @@ import {
   createRelationships,
   defineSorters,
   filter,
+  FullTextIndex,
   INACTIVE,
   matchChangesetAndChangedProps,
   matchProjectSens,
@@ -514,6 +515,12 @@ export class EngagementRepository extends CommonRepository {
   private createIndexes() {
     return this.getConstraintsFor(IEngagement);
   }
+  @OnIndex('schema')
+  private async createSchemaIndexes() {
+    await this.db.query().apply(NameIndex.create()).run();
+    await this.db.query().apply(LanguageNameIndex.create()).run();
+    await this.db.query().apply(InternshipNameIndex.create()).run();
+  }
 }
 
 export const engagementFilters = filter.define(() => EngagementFilters, {
@@ -526,6 +533,25 @@ export const engagementFilters = filter.define(() => EngagementFilters, {
     ),
   }),
   status: filter.stringListProp(),
+  name: filter.fullText({
+    index: () => NameIndex,
+    matchToNode: (q) =>
+      q.match([
+        node('node', 'Engagement'),
+        relation('either', '', undefined, ACTIVE),
+        node('', 'BaseNode'),
+        relation('out', '', undefined, ACTIVE),
+        node('match'),
+      ]),
+    // UI joins project & language/intern names with dash
+    // Remove it from search if users type it
+    normalizeInput: (v) => v.replaceAll(/ -/g, ''),
+    // Treat each word as a separate search term
+    // Each word could point to a different node
+    // i.e. "project - language"
+    separateQueryForEachWord: true,
+    minScore: 0.9,
+  }),
   projectId: filter.pathExists((id) => [
     node('node'),
     relation('in', '', 'engagement'),
@@ -658,3 +684,22 @@ const multiPropsAsSortString = (props: string[]) =>
     ' + ',
     props.map((prop) => `coalesce(${prop}.value, "")`),
   ) + ' as sortValue';
+
+const NameIndex = FullTextIndex({
+  indexName: 'EngagementName',
+  labels: ['ProjectName', 'LanguageName', 'LanguageDisplayName', 'UserName'],
+  properties: 'value',
+  analyzer: 'standard-folding',
+});
+const LanguageNameIndex = FullTextIndex({
+  indexName: 'LanguageEngagementName',
+  labels: ['ProjectName', 'LanguageName', 'LanguageDisplayName'],
+  properties: 'value',
+  analyzer: 'standard-folding',
+});
+const InternshipNameIndex = FullTextIndex({
+  indexName: 'InternshipEngagementName',
+  labels: ['ProjectName', 'UserName'],
+  properties: 'value',
+  analyzer: 'standard-folding',
+});

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

@@ -30,6 +30,11 @@ export abstract class EthnologueLanguageFilters {
 
 @InputType()
 export abstract class LanguageFilters {
+  @Field({
+    nullable: true,
+  })
+  readonly name?: string;
+
   @Field(() => [Sensitivity], {
     description: 'Only languages with these sensitivities',
     nullable: true,

src/components/language/language.repository.ts

@@ -17,7 +17,7 @@ import {
   Session,
   UnsecuredDto,
 } from '~/common';
-import { DtoRepository, UniquenessError } from '~/core/database';
+import { DtoRepository, OnIndex, UniquenessError } from '~/core/database';
 import {
   ACTIVE,
   any,
@@ -27,6 +27,7 @@ import {
   defineSorters,
   exp,
   filter,
+  FullTextIndex,
   matchChangesetAndChangedProps,
   matchProjectScopedRoles,
   matchProjectSens,
@@ -268,9 +269,23 @@ export class LanguageRepository extends DtoRepository<
       .first();
     return !!res;
   }
+
+  @OnIndex('schema')
+  private async createSchemaIndexes() {
+    await this.db.query().apply(NameIndex.create()).run();
+  }
 }
 
 export const languageFilters = filter.define(() => LanguageFilters, {
+  name: filter.fullText({
+    index: () => NameIndex,
+    matchToNode: (q) =>
+      q.match([
+        node('node', 'Language'),
+        relation('out', '', undefined, ACTIVE),
+        node('match'),
+      ]),
+  }),
   sensitivity: filter.stringListProp(),
   leastOfThese: filter.propVal(),
   isSignLanguage: filter.propVal(),
@@ -355,3 +370,10 @@ export const languageSorters = defineSorters(Language, {
 });
 
 const ethnologueSorters = defineSorters(EthnologueLanguage, {});
+
+const NameIndex = FullTextIndex({
+  indexName: 'LanguageName',
+  labels: ['LanguageName', 'LanguageDisplayName'],
+  properties: 'value',
+  analyzer: 'standard-folding',
+});

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

@@ -23,6 +23,11 @@ import {
 
 @InputType()
 export abstract class ProjectFilters {
+  @Field({
+    nullable: true,
+  })
+  readonly name?: string;
+
   @Field(() => [ProjectType], {
     description: 'Only projects of these types',
     nullable: true,

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

@@ -1,8 +1,19 @@
 import { greaterThan, inArray, node, relation } from 'cypher-query-builder';
 import { ACTIVE, filter, matchProjectSens, path } from '~/core/database/query';
 import { ProjectFilters } from './dto';
+import { ProjectNameIndex } from './project.repository';
 
 export const projectFilters = filter.define(() => ProjectFilters, {
+  name: filter.fullText({
+    index: () => ProjectNameIndex,
+    matchToNode: (q) =>
+      q.match([
+        node('node', 'Project'),
+        relation('out', '', 'name', ACTIVE),
+        node('match'),
+      ]),
+    minScore: 0.8,
+  }),
   type: filter.stringListBaseNodeProp(),
   status: filter.stringListProp(),
   onlyMultipleEngagements:

src/components/project/project.repository.ts

@@ -17,6 +17,7 @@ import {
   createNode,
   createRelationships,
   defineSorters,
+  FullTextIndex,
   matchChangesetAndChangedProps,
   matchProjectSens,
   matchPropsAndProjectSensAndScopedRoles,
@@ -323,8 +324,19 @@ export class ProjectRepository extends CommonRepository {
   private createIndexes() {
     return this.getConstraintsFor(IProject);
   }
+  @OnIndex('schema')
+  private async createSchemaIndexes() {
+    await this.db.query().apply(ProjectNameIndex.create()).run();
+  }
 }
 
+export const ProjectNameIndex = FullTextIndex({
+  indexName: 'ProjectName',
+  labels: 'ProjectName',
+  properties: 'value',
+  analyzer: 'standard-folding',
+});
+
 export const projectSorters = defineSorters(IProject, {
   sensitivity: (query) =>
     query

src/components/user/dto/user.dto.ts

@@ -52,15 +52,19 @@ export class User extends Interfaces {
   email: SecuredStringNullable;
 
   @NameField()
+  @DbLabel('UserName')
   realFirstName: SecuredString;
 
   @NameField()
+  @DbLabel('UserName')
   realLastName: SecuredString;
 
   @NameField()
+  @DbLabel('UserName')
   displayFirstName: SecuredString;
 
   @NameField()
+  @DbLabel('UserName')
   displayLastName: SecuredString;
 
   @Field()

src/components/user/migrations/add-user-name-label.migration.ts

@@ -0,0 +1,19 @@
+import { BaseMigration, Migration } from '~/core/database';
+
+@Migration('2024-06-21T09:00:00')
+export class AddUserNameLabelMigration extends BaseMigration {
+  async up() {
+    await this.db.query().raw`
+      call {
+        match ()-[:realFirstName { active: true }]->(node:Property) return node
+        union
+        match ()-[:realLastName { active: true }]->(node:Property) return node
+        union
+        match ()-[:displayFirstName { active: true }]->(node:Property) return node
+        union
+        match ()-[:displayLastName { active: true }]->(node:Property) return node
+      }
+      set node:UserName
+    `.executeAndLogStats();
+  }
+}

src/components/user/user.module.ts

@@ -13,6 +13,7 @@ import { EducationModule } from './education/education.module';
 import { KnownLanguageRepository } from './known-language.repository';
 import { KnownLanguageResolver } from './known-language.resolver';
 import { AddActorLabelMigration } from './migrations/add-actor-label.migration';
+import { AddUserNameLabelMigration } from './migrations/add-user-name-label.migration';
 import { SystemAgentEdgeDBRepository } from './system-agent.edgedb.repository';
 import { SystemAgentNeo4jRepository } from './system-agent.neo4j.repository';
 import { SystemAgentRepository } from './system-agent.repository';
@@ -49,6 +50,7 @@ import { UserService } from './user.service';
       provide: SystemAgentRepository,
     },
     AddActorLabelMigration,
+    AddUserNameLabelMigration,
   ],
   exports: [
     UserService,