feat: refactor search services to use text search and improve logging in SearchQueryDTO

Author: tomast1337

server/src/search/search.service.ts

@@ -20,21 +20,32 @@ export class SearchService {
   }
 
   public async search(queryBody: SearchQueryDTO) {
-    this.logger.debug(`Searching for ${JSON.stringify(queryBody)}`);
-
     queryBody.query = (queryBody.query || '').trim().toLowerCase();
 
     const {
       query,
       page = 1,
       limit = 10,
       sort,
-      order = false,
+      order,
       category,
       searchSongs,
       searchUsers,
     } = queryBody;
 
+    this.logger.debug(
+      `Searching for ${JSON.stringify({
+        query,
+        page,
+        limit,
+        sort,
+        order,
+        category,
+        searchSongs,
+        searchUsers,
+      })}`,
+    );
+
     const { users, total: totalUsers } = searchUsers
       ? await this.userService.search({
           ...queryBody,

server/src/song/song.service.ts

@@ -479,25 +479,19 @@ export class SongService {
 
     const songs: SongViewDto[] = await this.songModel.aggregate([
       {
-        /**
-        $search: {
-           index: 'song_search_index', 
-           text: {
-                query: query,
-            },
-        },
-         */
         $match: {
-          $or: [
-            { originalAuthor: { $regex: query, $options: 'i' } },
-            { title: { $regex: query, $options: 'i' } },
-            { description: { $regex: query, $options: 'i' } },
-          ],
-          //category: category,
+          $text: {
+            $search: query,
+            $caseSensitive: false,
+            $diacriticSensitive: false,
+          },
+          ...(category && { category: category }),
         },
       },
       {
-        $sort: { [sort]: sortOrder },
+        $sort: {
+          [sort]: sortOrder,
+        },
       },
       {
         $skip: skip,
@@ -550,12 +544,12 @@ export class SongService {
         },
          */
         $match: {
-          $or: [
-            { originalAuthor: { $regex: query, $options: 'i' } },
-            { title: { $regex: query, $options: 'i' } },
-            { description: { $regex: query, $options: 'i' } },
-          ],
-          category: category,
+          $text: {
+            $search: query,
+            $caseSensitive: false, // Case-insensitive search
+            $diacriticSensitive: false, // Diacritic-insensitive search
+          },
+          ...(category && { category: category }),
         },
       },
       {

server/src/user/user.service.ts

@@ -77,23 +77,12 @@ export class UserService {
       profileImage: string;
     }[] = await this.userModel.aggregate([
       {
-        /*
-        $search: {
-          index: 'user_search_index',
-          text: {
-            query: query,
-            path: {
-              wildcard: '*',
-            },
-          },
-        },
-        */
         $match: {
-          $or: [
-            { username: { $regex: query, $options: 'i' } },
-            { publicName: { $regex: query, $options: 'i' } },
-            // { description: { $regex: query, $options: 'i' } },
-          ],
+          $text: {
+            $search: query,
+            $caseSensitive: false,
+            $diacriticSensitive: false,
+          },
         },
       },
       {
@@ -103,31 +92,24 @@ export class UserService {
         },
       },
       {
-        $sort: { [sort]: sortOrder }, // Sort the results
+        $sort: { [sort]: sortOrder },
       },
       {
-        $skip: skip, // Skip the first 'skip' results
+        $skip: skip,
       },
       {
-        $limit: limit, // Limit the results to 'limit'
+        $limit: limit,
       },
     ]);
 
     const totalResult = await this.userModel.aggregate([
       {
-        /*
-        $search: {
-          index: 'user_search_index',
-          text: {
-            query: query,
-          },
-        },*/
         $match: {
-          $or: [
-            { username: { $regex: query, $options: 'i' } },
-            { publicName: { $regex: query, $options: 'i' } },
-            // { description: { $regex: query, $options: 'i' } },
-          ],
+          $text: {
+            $search: query,
+            $caseSensitive: false,
+            $diacriticSensitive: false,
+          },
         },
       },
       {

shared/validation/common/dto/SearchQuery.dto.ts

@@ -15,7 +15,6 @@ export class SearchQueryDTO {
   @ApiProperty({
     example: 'Nirvana - Dumb',
     description: 'Natural language query.',
-    required: false,
   })
   query?: string;
 
@@ -32,17 +31,15 @@ export class SearchQueryDTO {
   @ApiProperty({
     example: 1,
     description: 'Page number.',
-    required: false,
   })
-  page?: number = 1;
+  page?: number;
 
   @IsNumber({ maxDecimalPlaces: 0 })
   @Min(1)
   @Max(100)
   @ApiProperty({
     example: 20,
     description: 'Number of results per page.',
-    required: false,
   })
   limit?: number = 20;
 
@@ -53,7 +50,7 @@ export class SearchQueryDTO {
     description: 'Sort field.',
     required: false,
   })
-  sort?: string = 'createdAt';
+  sort?: string;
 
   @IsBoolean()
   @Transform(({ value }) => value === 'true')
@@ -62,25 +59,23 @@ export class SearchQueryDTO {
     description: 'Sort in ascending order if true, descending if false.',
     required: false,
   })
-  order?: boolean = false;
+  order?: boolean;
 
   @IsOptional()
   @IsBoolean()
   @ApiProperty({
     example: true,
     description: 'Search Users.',
-    required: false,
   })
-  searchUsers?: boolean = true;
+  searchUsers?: boolean;
 
   @IsOptional()
   @IsBoolean()
   @ApiProperty({
     example: true,
     description: 'Search Songs.',
-    required: false,
   })
-  searchSongs?: boolean = true;
+  searchSongs?: boolean;
 
   constructor(partial: Partial<SearchQueryDTO>) {
     Object.assign(this, partial);