feat: update model

Author: ChengShi-1

docs/useCases.md

@@ -821,14 +821,25 @@ import { getDatasetDownloadCount } from '@iqss/dataverse-client-javascript'
 const datasetId = 1
 const includeMDC = true
 
-getDatasetDownloadCount.execute(datasetId, includeMDC)
+getDatasetDownloadCount
+  .execute(datasetId, includeMDC)
+  .then((datasetDownloadCount: DatasetDownloadCount) => {
+    /* ... */
+  })
 
 /* ... */
 ```
 
 _See [use case](../src/datasets/domain/useCases/GetDatasetDownloadCount.ts) implementation_.
+
 The `datasetId` parameter is a number for numeric identifiers.
-The `includeMDC` parameter is optional. If MDC is enabled the count will be limited to the time before MDC start if the optional `includeMDC` parameter is not included or set to False. Setting `includeMDC` to True will ignore the `:MDCStartDate` setting and return a total count.
+The `includeMDC` parameter is optional.
+
+Note:
+
+- Setting `includeMDC` to True will ignore the `MDCStartDate` setting and return a total count.
+- If MDC isn't enabled, the download count will return a total count, without `MDCStartDate`.
+- If MDC is enabled but the `includeMDC` is false, the count will be limited to the time before `MDCStartDate`
 
 ## Files
 

src/datasets/domain/models/DatasetDownloadCount.ts

@@ -0,0 +1,5 @@
+export interface DatasetDownloadCount {
+  id: number
+  downloadCount: number
+  MDCStartDate?: string
+}

src/datasets/domain/repositories/IDatasetsRepository.ts

@@ -7,6 +7,7 @@ import { DatasetDTO } from '../dtos/DatasetDTO'
 import { DatasetDeaccessionDTO } from '../dtos/DatasetDeaccessionDTO'
 import { MetadataBlock } from '../../../metadataBlocks'
 import { DatasetVersionDiff } from '../models/DatasetVersionDiff'
+import { DatasetDownloadCount } from '../models/DatasetDownloadCount'
 
 export interface IDatasetsRepository {
   getDataset(
@@ -51,5 +52,5 @@ export interface IDatasetsRepository {
     datasetVersionId: string,
     deaccessionDTO: DatasetDeaccessionDTO
   ): Promise<void>
-  getDatasetDownloadCount(datasetId: number, includeMDC?: boolean): Promise<number>
+  getDatasetDownloadCount(datasetId: number, includeMDC?: boolean): Promise<DatasetDownloadCount>
 }

src/datasets/domain/useCases/GetDatasetDownloadCount.ts

@@ -1,20 +1,22 @@
 import { UseCase } from '../../../core/domain/useCases/UseCase'
+import { DatasetDownloadCount } from '../models/DatasetDownloadCount'
 import { IDatasetsRepository } from '../repositories/IDatasetsRepository'
-export class GetDatasetDownloadCount implements UseCase<number> {
+
+export class GetDatasetDownloadCount implements UseCase<DatasetDownloadCount> {
   private datasetsRepository: IDatasetsRepository
 
   constructor(datasetsRepository: IDatasetsRepository) {
     this.datasetsRepository = datasetsRepository
   }
 
   /**
-   * Returns the Dataset Download Count.
+   * Returns a DatasetDownloadCount instance, with dataset id, count and MDCStartDate(optional).
    *
    * @param {number} [datasetId] - The dataset identifier.
    * @param {boolean} [includeMDC(optional)] - Indicates whether to consider include counts from MDC start date or not. The default value is false
-   * @returns {Promise<number>}
+   * @returns {Promise<DatasetDownloadCount>}
    */
-  async execute(datasetId: number, includeMDC?: boolean): Promise<number> {
+  async execute(datasetId: number, includeMDC?: boolean): Promise<DatasetDownloadCount> {
     return await this.datasetsRepository.getDatasetDownloadCount(datasetId, includeMDC)
   }
 }

src/datasets/infra/repositories/DatasetsRepository.ts

@@ -18,6 +18,7 @@ import { transformDatasetLocksResponseToDatasetLocks } from './transformers/data
 import { transformDatasetPreviewsResponseToDatasetPreviewSubset } from './transformers/datasetPreviewsTransformers'
 import { DatasetVersionDiff } from '../../domain/models/DatasetVersionDiff'
 import { transformDatasetVersionDiffResponseToDatasetVersionDiff } from './transformers/datasetVersionDiffTransformers'
+import { DatasetDownloadCount } from '../../domain/models/DatasetDownloadCount'
 
 export interface GetAllDatasetPreviewsQueryParams {
   per_page?: number
@@ -236,7 +237,10 @@ export class DatasetsRepository extends ApiRepository implements IDatasetsReposi
       })
   }
 
-  public async getDatasetDownloadCount(datasetId: number, includeMDC?: boolean): Promise<number> {
+  public async getDatasetDownloadCount(
+    datasetId: number,
+    includeMDC?: boolean
+  ): Promise<DatasetDownloadCount> {
     const queryParams = includeMDC !== undefined ? { includeMDC } : {}
 
     return this.doGet(

test/environment/.env

@@ -1,6 +1,6 @@
 POSTGRES_VERSION=13
 DATAVERSE_DB_USER=dataverse
-SOLR_VERSION=9.3.0
+SOLR_VERSION=9.8.0
 DATAVERSE_IMAGE_REGISTRY=docker.io
 DATAVERSE_IMAGE_TAG=unstable
 DATAVERSE_BOOTSTRAP_TIMEOUT=5m

test/functional/datasets/GetDatasetDownloadCount.test.ts

@@ -60,9 +60,9 @@ describe('execute', () => {
 
     await publishDataset.execute(createdDatasetIdentifiers.persistentId, VersionUpdateType.MAJOR)
 
-    const downloadCount = await getDatasetDownloadCount.execute(createdDatasetIdentifiers.numericId)
+    const actual = await getDatasetDownloadCount.execute(createdDatasetIdentifiers.numericId)
 
-    expect(downloadCount).toBe(0)
+    expect(actual.downloadCount).toBe(0)
 
     await deletePublishedDatasetViaApi(createdDatasetIdentifiers.persistentId)
   })
@@ -72,12 +72,9 @@ describe('execute', () => {
 
     await publishDataset.execute(createdDatasetIdentifiers.persistentId, VersionUpdateType.MAJOR)
 
-    const downloadCount = await getDatasetDownloadCount.execute(
-      createdDatasetIdentifiers.numericId,
-      true
-    )
+    const actual = await getDatasetDownloadCount.execute(createdDatasetIdentifiers.numericId, true)
 
-    expect(downloadCount).toBe(0)
+    expect(actual.downloadCount).toBe(0)
 
     await deletePublishedDatasetViaApi(createdDatasetIdentifiers.persistentId)
   })
@@ -89,9 +86,9 @@ describe('execute', () => {
   test('should return zero if dataset has no downloads', async () => {
     const createdDatasetIdentifiers = await createDataset.execute(testDataset)
 
-    const downloadCount = await getDatasetDownloadCount.execute(createdDatasetIdentifiers.numericId)
+    const actual = await getDatasetDownloadCount.execute(createdDatasetIdentifiers.numericId)
 
-    expect(downloadCount).toBe(0)
+    expect(actual.downloadCount).toBe(0)
 
     await deleteUnpublishedDatasetViaApi(createdDatasetIdentifiers.numericId)
   })

test/integration/datasets/DatasetsRepository.test.ts

@@ -939,7 +939,7 @@ describe('DatasetsRepository', () => {
       await waitForNoLocks(testDatasetIds.numericId, 10)
       const actual = await sut.getDatasetDownloadCount(testDatasetIds.numericId)
 
-      expect(actual).toBe(0)
+      expect(actual.downloadCount).toBe(0)
 
       await deletePublishedDatasetViaApi(testDatasetIds.persistentId)
     })
@@ -951,7 +951,7 @@ describe('DatasetsRepository', () => {
 
       const actual = await sut.getDatasetDownloadCount(testDatasetIds.numericId, true)
 
-      expect(actual).toBe(0)
+      expect(actual.downloadCount).toBe(0)
 
       await deletePublishedDatasetViaApi(testDatasetIds.persistentId)
     })

test/unit/datasets/DatasetsRepository.test.ts

@@ -30,6 +30,7 @@ import {
 } from '../../testHelpers/datasets/datasetHelper'
 import { WriteError } from '../../../src'
 import { VersionUpdateType } from '../../../src/datasets/domain/models/Dataset'
+import { DatasetDownloadCount } from '../../../src/datasets/domain/models/DatasetDownloadCount'
 
 describe('DatasetsRepository', () => {
   const sut: DatasetsRepository = new DatasetsRepository()
@@ -1014,4 +1015,36 @@ describe('DatasetsRepository', () => {
       expect(error).toBeInstanceOf(Error)
     })
   })
+
+  describe('getDatasetDownloaCount', () => {
+    const testDatasetDownloadCount: DatasetDownloadCount = {
+      id: testDatasetModel.id,
+      downloadCount: 1,
+      MDCStartDate: '2021-01-01'
+    }
+    test('should return citation when response is successful', async () => {
+      jest.spyOn(axios, 'get').mockResolvedValue(testDatasetDownloadCount)
+
+      const actual = await sut.getDatasetDownloadCount(testDatasetModel.id)
+
+      expect(axios.get).toHaveBeenCalledWith(
+        `${TestConstants.TEST_API_URL}/datasets/${testDatasetModel.id}/download/count`,
+        TestConstants.TEST_EXPECTED_UNAUTHENTICATED_REQUEST_CONFIG
+      )
+      expect(actual).toStrictEqual(testDatasetDownloadCount)
+    })
+
+    test('should return error on repository read error', async () => {
+      jest.spyOn(axios, 'get').mockRejectedValue(TestConstants.TEST_ERROR_RESPONSE)
+
+      let error = undefined as unknown as ReadError
+      await sut.getDatasetDownloadCount(testDatasetModel.id).catch((e) => (error = e))
+
+      expect(axios.get).toHaveBeenCalledWith(
+        `${TestConstants.TEST_API_URL}/datasets/${testDatasetModel.id}/download/count`,
+        TestConstants.TEST_EXPECTED_UNAUTHENTICATED_REQUEST_CONFIG
+      )
+      expect(error).toBeInstanceOf(Error)
+    })
+  })
 })

test/unit/datasets/GetDatasetDownloadCount.test.ts

@@ -1,19 +1,26 @@
 import { GetDatasetDownloadCount } from '../../../src/datasets/domain/useCases/GetDatasetDownloadCount'
 import { IDatasetsRepository } from '../../../src/datasets/domain/repositories/IDatasetsRepository'
 import { ReadError } from '../../../src/core/domain/repositories/ReadError'
+import { DatasetDownloadCount } from '../../../src/datasets/domain/models/DatasetDownloadCount'
 
 describe('execute', () => {
   const testDatasetId = 1
-  const testCount = 10
+  const testDatasetDownloadCount: DatasetDownloadCount = {
+    id: testDatasetId,
+    downloadCount: 1,
+    MDCStartDate: '2021-01-01'
+  }
 
   test('should return count on repository success filtering by id', async () => {
     const filesRepositoryStub: IDatasetsRepository = {} as IDatasetsRepository
-    filesRepositoryStub.getDatasetDownloadCount = jest.fn().mockResolvedValue(testCount)
+    filesRepositoryStub.getDatasetDownloadCount = jest
+      .fn()
+      .mockResolvedValue(testDatasetDownloadCount)
     const sut = new GetDatasetDownloadCount(filesRepositoryStub)
 
     const actual = await sut.execute(testDatasetId)
 
-    expect(actual).toBe(testCount)
+    expect(actual).toBe(testDatasetDownloadCount)
     expect(filesRepositoryStub.getDatasetDownloadCount).toHaveBeenCalledWith(
       testDatasetId,
       undefined