feat: add guestId to dataset

Author: ChengShi-1

src/datasets/domain/models/Dataset.ts

@@ -12,6 +12,7 @@ export interface Dataset {
   alternativePersistentId?: string
   publicationDate?: string
   citationDate?: string
+  guestbookId?: number
   metadataBlocks: DatasetMetadataBlocks
   isPartOf: DvObjectOwnerNode
   datasetType?: string

src/datasets/infra/repositories/transformers/DatasetPayload.ts

@@ -17,6 +17,7 @@ export interface DatasetPayload {
   alternativePersistentId?: string
   publicationDate?: string
   citationDate?: string
+  guestbookId?: number
   fileAccessRequest: boolean
   termsOfAccess?: string
   dataAccessPlace?: string

src/datasets/infra/repositories/transformers/datasetTransformers.ts

@@ -296,6 +296,9 @@ export const transformVersionPayloadToDataset = (
   if ('citationDate' in versionPayload) {
     datasetModel.citationDate = versionPayload.citationDate
   }
+  if ('guestbookId' in versionPayload) {
+    datasetModel.guestbookId = versionPayload.guestbookId
+  }
   if ('datasetType' in versionPayload) {
     datasetModel.datasetType = versionPayload.datasetType
   }

test/environment/docker-compose.yml

@@ -32,7 +32,7 @@ services:
         -Ddataverse.files.localstack1.access-key=default
         -Ddataverse.files.localstack1.secret-key=default
     ports:
-      - '8080:8080'
+      - '8081:8080'
     networks:
       - dataverse
     depends_on:

test/integration/guestbooks/GuestbooksRepository.test.ts

@@ -3,7 +3,12 @@ import { ApiConfig, ReadError, WriteError } from '../../../src'
 import { GuestbooksRepository } from '../../../src/guestbooks/infra/repositories/GuestbooksRepository'
 import { CreateGuestbookDTO } from '../../../src/guestbooks/domain/dtos/CreateGuestbookDTO'
 import { TestConstants } from '../../testHelpers/TestConstants'
-import { createDataset, CreatedDatasetIdentifiers } from '../../../src/datasets'
+import {
+  createDataset,
+  CreatedDatasetIdentifiers,
+  DatasetNotNumberedVersion,
+  getDataset
+} from '../../../src/datasets'
 import { deleteUnpublishedDatasetViaApi } from '../../testHelpers/datasets/datasetHelper'
 import {
   createCollectionViaApi,
@@ -181,6 +186,17 @@ describe('GuestbooksRepository', () => {
         expect(actual).toBeUndefined()
       })
 
+      test('should return guestbookId in dataset response after assigning guestbook', async () => {
+        await sut.assignDatasetGuestbook(testDatasetIds.numericId, assignableGuestbookId)
+
+        const dataset = await getDataset.execute(
+          testDatasetIds.numericId,
+          DatasetNotNumberedVersion.LATEST
+        )
+
+        expect(dataset.guestbookId).toBe(assignableGuestbookId)
+      })
+
       test('should assign guestbook to dataset by persistent id', async () => {
         const actual = await sut.assignDatasetGuestbook(
           testDatasetIds.persistentId,

test/testHelpers/datasets/datasetHelper.ts

@@ -39,7 +39,8 @@ const DATAVERSE_API_REQUEST_HEADERS = {
 
 export const createDatasetModel = (
   license?: DatasetLicense,
-  addOptionalParameters = false
+  addOptionalParameters = false,
+  guestbookId?: number
 ): Dataset => {
   const datasetModel: Dataset = {
     id: 1,
@@ -119,12 +120,16 @@ export const createDatasetModel = (
     datasetModel.publicationDate = '2021-01-01'
     datasetModel.citationDate = '2021-01-01'
   }
+  if (guestbookId !== undefined) {
+    datasetModel.guestbookId = guestbookId
+  }
   return datasetModel
 }
 
 export const createDatasetVersionPayload = (
   license?: DatasetLicense,
-  addOptionalProperties = false
+  addOptionalProperties = false,
+  guestbookId?: number
 ): DatasetPayload => {
   const datasetPayload: DatasetPayload = {
     id: 19,
@@ -256,6 +261,9 @@ export const createDatasetVersionPayload = (
     datasetPayload.publicationDate = '2021-01-01'
     datasetPayload.citationDate = '2021-01-01'
   }
+  if (guestbookId !== undefined) {
+    datasetPayload.guestbookId = guestbookId
+  }
   return datasetPayload
 }