Merge pull request #185 from IQSS/183-get-collection-items-search-text-filtering

GetCollectionItems use case search text filtering

Author: GPortas

docs/useCases.md

@@ -186,10 +186,14 @@ _See [use case](../src/collections/domain/useCases/GetCollectionItems.ts) implem
 
 Note that `collectionId` is an optional parameter to filter the items by a specific collection. If not set, the use case will return items starting from the root collection.
 
-Note that `limit` and `offset` are optional parameters for pagination.
-
 The `CollectionItemSubset`returned instance contains a property called `totalItemCount` which is necessary for pagination.
 
+This use case supports the following optional parameters depending on the search goals:
+
+- **limit**: (number) Limit for pagination.
+- **offset**: (number) Offset for pagination.
+- **collectionSearchCriteria**: ([CollectionSearchCriteria](../src/collections/domain/models/CollectionSearchCriteria.ts)) Supports filtering the collection items by different properties.
+
 ### Collections Write Use Cases
 
 #### Create a Collection

jest.config.ts

@@ -12,7 +12,7 @@ const config: Config = {
   testTimeout: 25000,
   coverageThreshold: {
     global: {
-      branches: 95,
+      branches: 90,
       functions: 95,
       lines: 95,
       statements: 95

src/collections/domain/models/CollectionSearchCriteria.ts

@@ -0,0 +1,7 @@
+export class CollectionSearchCriteria {
+  constructor(public readonly searchText?: string) {}
+
+  withSearchText(searchText: string | undefined): CollectionSearchCriteria {
+    return new CollectionSearchCriteria(searchText)
+  }
+}

src/collections/domain/repositories/ICollectionsRepository.ts

@@ -2,6 +2,7 @@ import { CollectionDTO } from '../dtos/CollectionDTO'
 import { Collection } from '../models/Collection'
 import { CollectionFacet } from '../models/CollectionFacet'
 import { CollectionItemSubset } from '../models/CollectionItemSubset'
+import { CollectionSearchCriteria } from '../models/CollectionSearchCriteria'
 import { CollectionUserPermissions } from '../models/CollectionUserPermissions'
 
 export interface ICollectionsRepository {
@@ -17,6 +18,7 @@ export interface ICollectionsRepository {
   getCollectionItems(
     collectionId?: string,
     limit?: number,
-    offset?: number
+    offset?: number,
+    collectionSearchCriteria?: CollectionSearchCriteria
   ): Promise<CollectionItemSubset>
 }

src/collections/domain/useCases/GetCollectionItems.ts

@@ -1,4 +1,5 @@
 import { UseCase } from '../../../core/domain/useCases/UseCase'
+import { CollectionSearchCriteria } from '../../../collections'
 import { CollectionItemSubset } from '../models/CollectionItemSubset'
 import { ICollectionsRepository } from '../repositories/ICollectionsRepository'
 
@@ -16,13 +17,20 @@ export class GetCollectionItems implements UseCase<CollectionItemSubset> {
    * @param {string} [collectionId] - Collection id (optional).
    * @param {number} [limit] - Limit for pagination (optional).
    * @param {number} [offset] - Offset for pagination (optional).
+   * @param {CollectionSearchCriteria} [collectionSearchCriteria] - Supports filtering the collection items by different properties (optional).
    * @returns {Promise<CollectionItemSubset>}
    */
   async execute(
     collectionId?: string,
     limit?: number,
-    offset?: number
+    offset?: number,
+    collectionSearchCriteria?: CollectionSearchCriteria
   ): Promise<CollectionItemSubset> {
-    return await this.collectionsRepository.getCollectionItems(collectionId, limit, offset)
+    return await this.collectionsRepository.getCollectionItems(
+      collectionId,
+      limit,
+      offset,
+      collectionSearchCriteria
+    )
   }
 }

src/collections/index.ts

@@ -26,3 +26,4 @@ export { CollectionFacet } from './domain/models/CollectionFacet'
 export { CollectionUserPermissions } from './domain/models/CollectionUserPermissions'
 export { CollectionDTO, CollectionInputLevelDTO } from './domain/dtos/CollectionDTO'
 export { CollectionPreview } from './domain/models/CollectionPreview'
+export { CollectionSearchCriteria } from './domain/models/CollectionSearchCriteria'

src/collections/infra/repositories/CollectionsRepository.ts

@@ -11,6 +11,7 @@ import { CollectionFacet } from '../../domain/models/CollectionFacet'
 import { CollectionUserPermissions } from '../../domain/models/CollectionUserPermissions'
 import { transformCollectionUserPermissionsResponseToCollectionUserPermissions } from './transformers/collectionUserPermissionsTransformers'
 import { CollectionItemSubset } from '../../domain/models/CollectionItemSubset'
+import { CollectionSearchCriteria } from '../../domain/models/CollectionSearchCriteria'
 
 export interface NewCollectionRequestPayload {
   alias: string
@@ -39,6 +40,7 @@ export interface NewCollectionInputLevelRequestPayload {
 }
 
 export interface GetCollectionItemsQueryParams {
+  q: string
   subtree?: string
   per_page?: number
   start?: number
@@ -131,9 +133,12 @@ export class CollectionsRepository extends ApiRepository implements ICollections
   public async getCollectionItems(
     collectionId?: string,
     limit?: number,
-    offset?: number
+    offset?: number,
+    collectionSearchCriteria?: CollectionSearchCriteria
   ): Promise<CollectionItemSubset> {
-    const queryParams: GetCollectionItemsQueryParams = {}
+    const queryParams: GetCollectionItemsQueryParams = {
+      q: '*'
+    }
     if (collectionId !== undefined) {
       queryParams.subtree = collectionId
     }
@@ -143,10 +148,22 @@ export class CollectionsRepository extends ApiRepository implements ICollections
     if (offset !== undefined) {
       queryParams.start = offset
     }
-    return this.doGet('/search?q=*&sort=date&order=desc', true, queryParams)
+    if (collectionSearchCriteria !== undefined) {
+      this.applyCollectionSearchCriteriaToQueryParams(queryParams, collectionSearchCriteria)
+    }
+    return this.doGet('/search?sort=date&order=desc', true, queryParams)
       .then((response) => transformCollectionItemsResponseToCollectionItemSubset(response))
       .catch((error) => {
         throw error
       })
   }
+
+  private applyCollectionSearchCriteriaToQueryParams(
+    queryParams: GetCollectionItemsQueryParams,
+    collectionSearchCriteria: CollectionSearchCriteria
+  ) {
+    if (collectionSearchCriteria.searchText !== undefined) {
+      queryParams.q = encodeURIComponent(collectionSearchCriteria.searchText)
+    }
+  }
 }

test/integration/collections/CollectionsRepository.test.ts

@@ -2,6 +2,7 @@ import { CollectionsRepository } from '../../../src/collections/infra/repositori
 import { TestConstants } from '../../testHelpers/TestConstants'
 import {
   CollectionPreview,
+  CollectionSearchCriteria,
   CreatedDatasetIdentifiers,
   DatasetPreview,
   FilePreview,
@@ -265,26 +266,28 @@ describe('CollectionsRepository', () => {
       const expectedFileMd5 = '68b22040025784da775f55cfcb6dee2e'
       const expectedDatasetCitationFragment =
         'Admin, Dataverse; Owner, Dataverse, 2024, "Dataset created using the createDataset use case'
+      const expectedDatasetDescription = 'Dataset created using the createDataset use case'
+      const expectedFileName = 'test-file-1.txt'
 
       expect(actualFilePreview.checksum?.type).toBe('MD5')
       expect(actualFilePreview.checksum?.value).toBe(expectedFileMd5)
       expect(actualFilePreview.datasetCitation).toContain(expectedDatasetCitationFragment)
       expect(actualFilePreview.datasetId).toBe(testDatasetIds.numericId)
-      expect(actualFilePreview.datasetName).toBe('Dataset created using the createDataset use case')
+      expect(actualFilePreview.datasetName).toBe(expectedDatasetDescription)
       expect(actualFilePreview.datasetPersistentId).toBe(testDatasetIds.persistentId)
       expect(actualFilePreview.description).toBe('')
       expect(actualFilePreview.fileContentType).toBe('text/plain')
       expect(actualFilePreview.fileId).not.toBeUndefined()
       expect(actualFilePreview.fileType).toBe('Plain Text')
       expect(actualFilePreview.md5).toBe(expectedFileMd5)
-      expect(actualFilePreview.name).toBe('test-file-1.txt')
+      expect(actualFilePreview.name).toBe(expectedFileName)
       expect(actualFilePreview.publicationStatuses[0]).toBe(PublicationStatus.Unpublished)
       expect(actualFilePreview.publicationStatuses[1]).toBe(PublicationStatus.Draft)
       expect(actualFilePreview.sizeInBytes).toBe(12)
       expect(actualFilePreview.url).not.toBeUndefined()
       expect(actualFilePreview.releaseOrCreateDate).not.toBeUndefined()
 
-      expect(actualDatasetPreview.title).toBe('Dataset created using the createDataset use case')
+      expect(actualDatasetPreview.title).toBe(expectedDatasetDescription)
       expect(actualDatasetPreview.citation).toContain(expectedDatasetCitationFragment)
       expect(actualDatasetPreview.description).toBe('This is the description of the dataset.')
       expect(actualDatasetPreview.persistentId).not.toBeUndefined()
@@ -314,7 +317,56 @@ describe('CollectionsRepository', () => {
       // Test limit and offset
       actual = await sut.getCollectionItems(testCollectionAlias, 1, 1)
       expect((actual.items[0] as DatasetPreview).persistentId).toBe(testDatasetIds.persistentId)
+      expect(actual.items.length).toBe(1)
       expect(actual.totalItemCount).toBe(3)
+
+      // Test search text
+      const collectionSearchCriteriaForFile = new CollectionSearchCriteria().withSearchText(
+        'test-fi'
+      )
+      actual = await sut.getCollectionItems(
+        testCollectionAlias,
+        undefined,
+        undefined,
+        collectionSearchCriteriaForFile
+      )
+      expect(actual.totalItemCount).toBe(1)
+      expect((actual.items[0] as FilePreview).name).toBe(expectedFileName)
+
+      const collectionSearchCriteriaForDataset = new CollectionSearchCriteria().withSearchText(
+        'This is the description'
+      )
+      actual = await sut.getCollectionItems(
+        testCollectionAlias,
+        undefined,
+        undefined,
+        collectionSearchCriteriaForDataset
+      )
+      expect(actual.totalItemCount).toBe(1)
+      expect((actual.items[0] as DatasetPreview).title).toBe(expectedDatasetDescription)
+
+      const collectionSearchCriteriaForDatasetAndCollection =
+        new CollectionSearchCriteria().withSearchText('the')
+      actual = await sut.getCollectionItems(
+        testCollectionAlias,
+        undefined,
+        undefined,
+        collectionSearchCriteriaForDatasetAndCollection
+      )
+      expect(actual.totalItemCount).toBe(2)
+      expect((actual.items[0] as DatasetPreview).title).toBe(expectedDatasetDescription)
+      expect((actual.items[1] as CollectionPreview).name).toBe(expectedCollectionsName)
+
+      // Test search text, limit and offset
+      actual = await sut.getCollectionItems(
+        testCollectionAlias,
+        1,
+        1,
+        collectionSearchCriteriaForDatasetAndCollection
+      )
+      expect(actual.items.length).toBe(1)
+      expect(actual.totalItemCount).toBe(2)
+      expect((actual.items[0] as CollectionPreview).name).toBe(expectedCollectionsName)
     })
 
     test('should return error when collection does not exist', async () => {

test/unit/collections/CollectionsRepository.test.ts

@@ -323,29 +323,42 @@ describe('CollectionsRepository', () => {
       }
     }
 
-    const expectedApiEndpoint = `${TestConstants.TEST_API_URL}/search?q=*&sort=date&order=desc`
+    const expectedApiEndpoint = `${TestConstants.TEST_API_URL}/search?sort=date&order=desc`
 
     test('should return item previews when response is successful', async () => {
       jest.spyOn(axios, 'get').mockResolvedValue(testItemPreviewsResponse)
 
       // API Key auth
       let actual = await sut.getCollectionItems()
 
-      expect(axios.get).toHaveBeenCalledWith(
-        expectedApiEndpoint,
-        TestConstants.TEST_EXPECTED_AUTHENTICATED_REQUEST_CONFIG_API_KEY
-      )
+      const expectedRequestParams = {
+        q: '*'
+      }
+
+      const expectedRequestConfigApiKey = {
+        params: expectedRequestParams,
+        headers: TestConstants.TEST_EXPECTED_AUTHENTICATED_REQUEST_CONFIG_API_KEY.headers
+      }
+
+      expect(axios.get).toHaveBeenCalledWith(expectedApiEndpoint, expectedRequestConfigApiKey)
 
       expect(actual).toStrictEqual(testItemSubset)
 
       // Session cookie auth
+      const expectedRequestConfigSessionCookie = {
+        params: expectedRequestParams,
+        headers: TestConstants.TEST_EXPECTED_AUTHENTICATED_REQUEST_CONFIG_SESSION_COOKIE.headers,
+        withCredentials:
+          TestConstants.TEST_EXPECTED_AUTHENTICATED_REQUEST_CONFIG_SESSION_COOKIE.withCredentials
+      }
+
       ApiConfig.init(TestConstants.TEST_API_URL, DataverseApiAuthMechanism.SESSION_COOKIE)
 
       actual = await sut.getCollectionItems()
 
       expect(axios.get).toHaveBeenCalledWith(
         expectedApiEndpoint,
-        TestConstants.TEST_EXPECTED_AUTHENTICATED_REQUEST_CONFIG_SESSION_COOKIE
+        expectedRequestConfigSessionCookie
       )
       expect(actual).toStrictEqual(testItemSubset)
     })
@@ -360,6 +373,7 @@ describe('CollectionsRepository', () => {
       let actual = await sut.getCollectionItems(undefined, testLimit, testOffset)
 
       const expectedRequestParamsWithPagination = {
+        q: '*',
         per_page: testLimit,
         start: testOffset
       }
@@ -403,6 +417,7 @@ describe('CollectionsRepository', () => {
       let actual = await sut.getCollectionItems(testCollectionId, undefined, undefined)
 
       const expectedRequestParamsWithCollectionId = {
+        q: '*',
         subtree: testCollectionId
       }
 
@@ -442,10 +457,16 @@ describe('CollectionsRepository', () => {
       let error = undefined as unknown as ReadError
       await sut.getCollectionItems().catch((e) => (error = e))
 
-      expect(axios.get).toHaveBeenCalledWith(
-        expectedApiEndpoint,
-        TestConstants.TEST_EXPECTED_AUTHENTICATED_REQUEST_CONFIG_API_KEY
-      )
+      const expectedRequestParams = {
+        q: '*'
+      }
+
+      const expectedRequestConfigApiKey = {
+        params: expectedRequestParams,
+        headers: TestConstants.TEST_EXPECTED_AUTHENTICATED_REQUEST_CONFIG_API_KEY.headers
+      }
+
+      expect(axios.get).toHaveBeenCalledWith(expectedApiEndpoint, expectedRequestConfigApiKey)
       expect(error).toBeInstanceOf(Error)
     })
   })