feat: Search authors by username or display name

ExpediaGroup · Apr 6, 2023 · 687bf1f · 687bf1f
1 parent 8438b81
commit 687bf1f
Show file tree

Hide file tree

Showing 3 changed files with 57 additions and 4 deletions.
diff --git a/packages/frontend/src/pages/search-page/components/search-bar/search-syntax.tsx b/packages/frontend/src/pages/search-page/components/search-bar/search-syntax.tsx
@@ -47,7 +47,7 @@ export const SearchSyntax = () => {
           </Tooltip>
         </Box>
       </PopoverTrigger>
-      <PopoverContent zIndex={9000} {...useBreakpointValue({ base: {}, lg: { width: 'auto', maxWidth: '3xl' } })}>
+      <PopoverContent zIndex={9000} {...useBreakpointValue({ base: {}, lg: { width: 'auto', maxWidth: '4xl' } })}>
         <PopoverArrow />
         <PopoverCloseButton />
         <PopoverHeader>
@@ -110,6 +110,8 @@ export const SearchSyntax = () => {
                 <HStack>
                   <Code>author:username</Code>
                   <Text>/</Text>
+                  <Code whiteSpace="nowrap">author:"Full Name"</Code>
+                  <Text>/</Text>
                   <Code>@username</Code>
                 </HStack>
                 <Text>Insight author</Text>

diff --git a/packages/shared/src/search.ts b/packages/shared/src/search.ts
@@ -151,6 +151,36 @@ export class SearchTerm implements SearchClause {
       return {};
     }
 
+    if (this.key === 'author') {
+      // Special case for supporting either username or display name
+      return {
+        bool: {
+          filter: [
+            {
+              bool: {
+                should: [
+                  {
+                    term: {
+                      'contributors.userName.keyword': {
+                        value: this.value
+                      }
+                    }
+                  },
+                  {
+                    term: {
+                      'contributors.displayName.keyword': {
+                        value: this.value
+                      }
+                    }
+                  }
+                ]
+              }
+            }
+          ]
+        }
+      };
+    }
+
     return {
       bool: {
         filter: [
@@ -169,7 +199,7 @@ export class SearchTerm implements SearchClause {
   toString(): string {
     switch (this.key) {
       case 'author':
-        return `@${this.value}`;
+        return this.value.includes(' ') ? `author:"${this.value}"` : `@${this.value}`;
       case 'tag':
         return `#${this.value}`;
       default:

diff --git a/packages/shared/test/search.test.ts b/packages/shared/test/search.test.ts
@@ -342,7 +342,14 @@ describe('search', () => {
         bool: {
           filter: [
             { term: { 'tags.keyword': { value: 'demo' } } },
-            { term: { 'contributors.userName.keyword': { value: 'username' } } }
+            {
+              bool: {
+                should: [
+                  { term: { 'contributors.userName.keyword': { value: 'username' } } },
+                  { term: { 'contributors.displayName.keyword': { value: 'username' } } }
+                ]
+              }
+            }
           ],
           should: [
             {
@@ -394,7 +401,16 @@ describe('search', () => {
       const es = parseToElasticsearch('author:username');
       expect(es).toMatchObject({
         bool: {
-          filter: [{ term: { 'contributors.userName.keyword': { value: 'username' } } }]
+          filter: [
+            {
+              bool: {
+                should: [
+                  { term: { 'contributors.userName.keyword': { value: 'username' } } },
+                  { term: { 'contributors.displayName.keyword': { value: 'username' } } }
+                ]
+              }
+            }
+          ]
         }
       });
     });
@@ -451,5 +467,10 @@ describe('search', () => {
       const query = toSearchQuery(clauses);
       expect(query).toBe('updatedDate:>=2020-03-01 updatedDate:<=2020-10-01');
     });
+    test('author full name', () => {
+      const clauses: any[] = parseSearchQuery('author:"John Doe"');
+      const query = toSearchQuery(clauses);
+      expect(query).toBe('author:"John Doe"');
+    });
   });
 });