Add format as an optional param to submitGuestbook for download use cases

src/access/domain/repositories/IAccessRepository.ts

@@ -3,22 +3,26 @@ import { GuestbookResponseDTO } from '../dtos/GuestbookResponseDTO'
 export interface IAccessRepository {
   submitGuestbookForDatafileDownload(
     fileId: number | string,
-    guestbookResponse: GuestbookResponseDTO
+    guestbookResponse: GuestbookResponseDTO,
+    format?: string
   ): Promise<string>
 
   submitGuestbookForDatafilesDownload(
     fileIds: string | Array<number | string>,
-    guestbookResponse: GuestbookResponseDTO
+    guestbookResponse: GuestbookResponseDTO,
+    format?: string
   ): Promise<string>
 
   submitGuestbookForDatasetDownload(
     datasetId: number | string,
-    guestbookResponse: GuestbookResponseDTO
+    guestbookResponse: GuestbookResponseDTO,
+    format?: string
   ): Promise<string>
 
   submitGuestbookForDatasetVersionDownload(
     datasetId: number | string,
     versionId: string,
-    guestbookResponse: GuestbookResponseDTO
+    guestbookResponse: GuestbookResponseDTO,
+    format?: string
   ): Promise<string>
 }

src/access/domain/useCases/SubmitGuestbookForDatafileDownload.ts

@@ -12,7 +12,15 @@ export class SubmitGuestbookForDatafileDownload implements UseCase<string> {
    * @param {GuestbookResponseDTO} guestbookResponse - Guestbook response payload.
    * @returns {Promise<string>} - Signed URL for the download.
    */
-  async execute(fileId: number | string, guestbookResponse: GuestbookResponseDTO): Promise<string> {
-    return await this.accessRepository.submitGuestbookForDatafileDownload(fileId, guestbookResponse)
+  async execute(
+    fileId: number | string,
+    guestbookResponse: GuestbookResponseDTO,
+    format?: string
+  ): Promise<string> {
+    return await this.accessRepository.submitGuestbookForDatafileDownload(
+      fileId,
+      guestbookResponse,
+      format
+    )
   }
 }

src/access/domain/useCases/SubmitGuestbookForDatafilesDownload.ts

@@ -14,11 +14,13 @@ export class SubmitGuestbookForDatafilesDownload implements UseCase<string> {
    */
   async execute(
     fileIds: string | Array<number | string>,
-    guestbookResponse: GuestbookResponseDTO
+    guestbookResponse: GuestbookResponseDTO,
+    format?: string
   ): Promise<string> {
     return await this.accessRepository.submitGuestbookForDatafilesDownload(
       fileIds,
-      guestbookResponse
+      guestbookResponse,
+      format
     )
   }
 }

src/access/domain/useCases/SubmitGuestbookForDatasetDownload.ts

@@ -14,11 +14,13 @@ export class SubmitGuestbookForDatasetDownload implements UseCase<string> {
    */
   async execute(
     datasetId: number | string,
-    guestbookResponse: GuestbookResponseDTO
+    guestbookResponse: GuestbookResponseDTO,
+    format?: string
   ): Promise<string> {
     return await this.accessRepository.submitGuestbookForDatasetDownload(
       datasetId,
-      guestbookResponse
+      guestbookResponse,
+      format
     )
   }
 }

src/access/domain/useCases/SubmitGuestbookForDatasetVersionDownload.ts

@@ -16,12 +16,14 @@ export class SubmitGuestbookForDatasetVersionDownload implements UseCase<string>
   async execute(
     datasetId: number | string,
     versionId: string,
-    guestbookResponse: GuestbookResponseDTO
+    guestbookResponse: GuestbookResponseDTO,
+    format?: string
   ): Promise<string> {
     return await this.accessRepository.submitGuestbookForDatasetVersionDownload(
       datasetId,
       versionId,
-      guestbookResponse
+      guestbookResponse,
+      format
     )
   }
 }

src/access/infra/repositories/AccessRepository.ts

@@ -7,10 +7,13 @@ export class AccessRepository extends ApiRepository implements IAccessRepository
 
   public async submitGuestbookForDatafileDownload(
     fileId: number | string,
-    guestbookResponse: GuestbookResponseDTO
+    guestbookResponse: GuestbookResponseDTO,
+    format?: string
   ): Promise<string> {
     const endpoint = this.buildApiEndpoint(`${this.accessResourceName}/datafile`, undefined, fileId)
-    return this.doPost(endpoint, guestbookResponse, { signed: true })
+    const queryParams = format ? { signed: true, format } : { signed: true }
+
+    return this.doPost(endpoint, guestbookResponse, queryParams)
       .then((response) => {
         const signedUrl = response.data.data.signedUrl
         return signedUrl
@@ -22,15 +25,18 @@ export class AccessRepository extends ApiRepository implements IAccessRepository
 
   public async submitGuestbookForDatafilesDownload(
     fileIds: Array<number>,
-    guestbookResponse: GuestbookResponseDTO
+    guestbookResponse: GuestbookResponseDTO,
+    format?: string
   ): Promise<string> {
+    const queryParams = format ? { signed: true, format } : { signed: true }
+
     return this.doPost(
       this.buildApiEndpoint(
         this.accessResourceName,
         `datafiles/${Array.isArray(fileIds) ? fileIds.join(',') : fileIds}`
       ),
       guestbookResponse,
-      { signed: true }
+      queryParams
     )
       .then((response) => {
         const signedUrl = response.data.data.signedUrl
@@ -43,14 +49,17 @@ export class AccessRepository extends ApiRepository implements IAccessRepository
 
   public async submitGuestbookForDatasetDownload(
     datasetId: number | string,
-    guestbookResponse: GuestbookResponseDTO
+    guestbookResponse: GuestbookResponseDTO,
+    format?: string
   ): Promise<string> {
     const endpoint = this.buildApiEndpoint(
       `${this.accessResourceName}/dataset`,
       undefined,
       datasetId
     )
-    return this.doPost(endpoint, guestbookResponse, { signed: true })
+    const queryParams = format ? { signed: true, format } : { signed: true }
+
+    return this.doPost(endpoint, guestbookResponse, queryParams)
       .then((response) => {
         const signedUrl = response.data.data.signedUrl
         return signedUrl
@@ -63,14 +72,17 @@ export class AccessRepository extends ApiRepository implements IAccessRepository
   public async submitGuestbookForDatasetVersionDownload(
     datasetId: number | string,
     versionId: string,
-    guestbookResponse: GuestbookResponseDTO
+    guestbookResponse: GuestbookResponseDTO,
+    format?: string
   ): Promise<string> {
     const endpoint = this.buildApiEndpoint(
       `${this.accessResourceName}/dataset`,
       `versions/${versionId}`,
       datasetId
     )
-    return this.doPost(endpoint, guestbookResponse, { signed: true })
+    const queryParams = format ? { signed: true, format } : { signed: true }
+
+    return this.doPost(endpoint, guestbookResponse, queryParams)
       .then((response) => {
         const signedUrl = response.data.data.signedUrl
         return signedUrl

test/integration/access/AccessRepository.test.ts

@@ -97,6 +97,17 @@ describe('AccessRepository', () => {
       expect(() => new URL(actual)).not.toThrow()
     })
 
+    test('should preserve format=tab in signed url for dataset download', async () => {
+      const actual = await sut.submitGuestbookForDatasetDownload(
+        testDatasetIds.numericId,
+        guestbookResponse,
+        'original'
+      )
+      const signedUrl = new URL(actual)
+
+      expect(signedUrl.searchParams.get('format')).toEqual('original')
+    })
+
     test('should return error when dataset does not exist', async () => {
       const nonExistentId = 999999999
       await expect(

test/unit/access/SubmitGuestbookDownloads.test.ts

@@ -22,10 +22,31 @@ describe('access download use cases', () => {
 
     const actual = await sut.execute(1, guestbookResponse)
 
-    expect(repository.submitGuestbookForDatafileDownload).toHaveBeenCalledWith(1, guestbookResponse)
+    expect(repository.submitGuestbookForDatafileDownload).toHaveBeenCalledWith(
+      1,
+      guestbookResponse,
+      undefined
+    )
     expect(actual).toEqual('https://signed.datafile')
   })
 
+  test('should submit datafile download with format and return signed url', async () => {
+    const repository: IAccessRepository = {} as IAccessRepository
+    repository.submitGuestbookForDatafileDownload = jest
+      .fn()
+      .mockResolvedValue('https://signed.datafile?format=original')
+    const sut = new SubmitGuestbookForDatafileDownload(repository)
+
+    const actual = await sut.execute(1, guestbookResponse, 'original')
+
+    expect(repository.submitGuestbookForDatafileDownload).toHaveBeenCalledWith(
+      1,
+      guestbookResponse,
+      'original'
+    )
+    expect(actual).toEqual('https://signed.datafile?format=original')
+  })
+
   test('should submit datafiles download and return signed url', async () => {
     const repository: IAccessRepository = {} as IAccessRepository
     repository.submitGuestbookForDatafilesDownload = jest
@@ -37,11 +58,29 @@ describe('access download use cases', () => {
 
     expect(repository.submitGuestbookForDatafilesDownload).toHaveBeenCalledWith(
       [1, 2],
-      guestbookResponse
+      guestbookResponse,
+      undefined
     )
     expect(actual).toEqual('https://signed.datafiles')
   })
 
+  test('should submit datafiles download with format and return signed url', async () => {
+    const repository: IAccessRepository = {} as IAccessRepository
+    repository.submitGuestbookForDatafilesDownload = jest
+      .fn()
+      .mockResolvedValue('https://signed.datafiles?format=original')
+    const sut = new SubmitGuestbookForDatafilesDownload(repository)
+
+    const actual = await sut.execute([1, 2], guestbookResponse, 'original')
+
+    expect(repository.submitGuestbookForDatafilesDownload).toHaveBeenCalledWith(
+      [1, 2],
+      guestbookResponse,
+      'original'
+    )
+    expect(actual).toEqual('https://signed.datafiles?format=original')
+  })
+
   test('should submit dataset download and return signed url', async () => {
     const repository: IAccessRepository = {} as IAccessRepository
     repository.submitGuestbookForDatasetDownload = jest
@@ -53,11 +92,29 @@ describe('access download use cases', () => {
 
     expect(repository.submitGuestbookForDatasetDownload).toHaveBeenCalledWith(
       'doi:10.5072/FK2/TEST',
-      guestbookResponse
+      guestbookResponse,
+      undefined
     )
     expect(actual).toEqual('https://signed.dataset')
   })
 
+  test('should submit dataset download with format and return signed url', async () => {
+    const repository: IAccessRepository = {} as IAccessRepository
+    repository.submitGuestbookForDatasetDownload = jest
+      .fn()
+      .mockResolvedValue('https://signed.dataset?format=original')
+    const sut = new SubmitGuestbookForDatasetDownload(repository)
+
+    const actual = await sut.execute('doi:10.5072/FK2/TEST', guestbookResponse, 'original')
+
+    expect(repository.submitGuestbookForDatasetDownload).toHaveBeenCalledWith(
+      'doi:10.5072/FK2/TEST',
+      guestbookResponse,
+      'original'
+    )
+    expect(actual).toEqual('https://signed.dataset?format=original')
+  })
+
   test('should throw WriteError when dataset version download fails', async () => {
     const repository: IAccessRepository = {} as IAccessRepository
     repository.submitGuestbookForDatasetVersionDownload = jest
@@ -66,5 +123,29 @@ describe('access download use cases', () => {
     const sut = new SubmitGuestbookForDatasetVersionDownload(repository)
 
     await expect(sut.execute(10, '2.0', guestbookResponse)).rejects.toThrow(WriteError)
+    expect(repository.submitGuestbookForDatasetVersionDownload).toHaveBeenCalledWith(
+      10,
+      '2.0',
+      guestbookResponse,
+      undefined
+    )
+  })
+
+  test('should submit dataset version download with format and return signed url', async () => {
+    const repository: IAccessRepository = {} as IAccessRepository
+    repository.submitGuestbookForDatasetVersionDownload = jest
+      .fn()
+      .mockResolvedValue('https://signed.dataset.version?format=original')
+    const sut = new SubmitGuestbookForDatasetVersionDownload(repository)
+
+    const actual = await sut.execute(10, '2.0', guestbookResponse, 'original')
+
+    expect(repository.submitGuestbookForDatasetVersionDownload).toHaveBeenCalledWith(
+      10,
+      '2.0',
+      guestbookResponse,
+      'original'
+    )
+    expect(actual).toEqual('https://signed.dataset.version?format=original')
   })
 })