Changed: update dataset request transform

Author: GPortas

src/datasets/infra/repositories/DatasetsRepository.ts

@@ -1,15 +1,18 @@
 import { ApiRepository } from '../../../core/infra/repositories/ApiRepository'
 import { IDatasetsRepository } from '../../domain/repositories/IDatasetsRepository'
 import { Dataset, VersionUpdateType } from '../../domain/models/Dataset'
-import { transformVersionResponseToDataset } from './transformers/datasetTransformers'
+import {
+  transformVersionResponseToDataset,
+  transformDatasetModelToUpdateDatasetRequestPayload
+} from './transformers/datasetTransformers'
 import { DatasetUserPermissions } from '../../domain/models/DatasetUserPermissions'
 import { transformDatasetUserPermissionsResponseToDatasetUserPermissions } from './transformers/datasetUserPermissionsTransformers'
 import { DatasetLock } from '../../domain/models/DatasetLock'
 import { CreatedDatasetIdentifiers } from '../../domain/models/CreatedDatasetIdentifiers'
 import { DatasetPreviewSubset } from '../../domain/models/DatasetPreviewSubset'
 import { DatasetDTO } from '../../domain/dtos/DatasetDTO'
 import { MetadataBlock } from '../../../metadataBlocks'
-import { transformDatasetModelToRequestPayload } from './transformers/datasetTransformers'
+import { transformDatasetModelToNewDatasetRequestPayload } from './transformers/datasetTransformers'
 import { transformDatasetLocksResponseToDatasetLocks } from './transformers/datasetLocksTransformers'
 import { transformDatasetPreviewsResponseToDatasetPreviewSubset } from './transformers/datasetPreviewsTransformers'
 
@@ -144,7 +147,7 @@ export class DatasetsRepository extends ApiRepository implements IDatasetsReposi
   ): Promise<CreatedDatasetIdentifiers> {
     return this.doPost(
       `/dataverses/${collectionId}/datasets`,
-      transformDatasetModelToRequestPayload(newDataset, datasetMetadataBlocks)
+      transformDatasetModelToNewDatasetRequestPayload(newDataset, datasetMetadataBlocks)
     )
       .then((response) => {
         const responseData = response.data.data
@@ -182,7 +185,8 @@ export class DatasetsRepository extends ApiRepository implements IDatasetsReposi
   ): Promise<void> {
     return this.doPut(
       this.buildApiEndpoint(this.datasetsResourceName, `editMetadata`, datasetId),
-      transformDatasetModelToRequestPayload(dataset, datasetMetadataBlocks)
+      transformDatasetModelToUpdateDatasetRequestPayload(dataset, datasetMetadataBlocks),
+      { replace: true }
     )
       .then(() => undefined)
       .catch((error) => {

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

@@ -55,7 +55,46 @@ export type MetadataFieldValueRequestPayload =
   | Record<string, MetadataFieldRequestPayload>
   | Record<string, MetadataFieldRequestPayload>[]
 
-export const transformDatasetModelToRequestPayload = (
+export interface UpdateDatasetRequestPayload {
+  fields: MetadataFieldRequestPayload[]
+}
+
+export const transformDatasetModelToUpdateDatasetRequestPayload = (
+  dataset: DatasetDTO,
+  metadataBlocks: MetadataBlock[]
+): UpdateDatasetRequestPayload => {
+  const metadataFieldsRequestPayload: MetadataFieldRequestPayload[] = []
+  const datasetMetadataBlocksValues: DatasetMetadataBlockValuesDTO[] = dataset.metadataBlockValues
+  datasetMetadataBlocksValues.forEach(function (
+    newDatasetMetadataBlockValues: DatasetMetadataBlockValuesDTO
+  ) {
+    const metadataBlock: MetadataBlock = metadataBlocks.find(
+      (metadataBlock) => metadataBlock.name == newDatasetMetadataBlockValues.name
+    )
+    const metadataBlockFieldsPayload: MetadataFieldRequestPayload[] = []
+    const metadataBlockFields = metadataBlock.metadataFields
+    const datasetMetadataFields = newDatasetMetadataBlockValues.fields
+    for (const metadataFieldKey of Object.keys(datasetMetadataFields)) {
+      const datasetMetadataFieldValue: DatasetMetadataFieldValueDTO =
+        datasetMetadataFields[metadataFieldKey]
+      metadataBlockFieldsPayload.push({
+        value: transformMetadataFieldValueToRequestPayload(
+          datasetMetadataFieldValue,
+          metadataBlockFields[metadataFieldKey]
+        ),
+        typeClass: metadataBlockFields[metadataFieldKey].typeClass,
+        multiple: metadataBlockFields[metadataFieldKey].multiple,
+        typeName: metadataFieldKey
+      })
+    }
+    metadataFieldsRequestPayload.push(...metadataBlockFieldsPayload)
+  })
+  return {
+    fields: metadataFieldsRequestPayload
+  }
+}
+
+export const transformDatasetModelToNewDatasetRequestPayload = (
   dataset: DatasetDTO,
   metadataBlocks: MetadataBlock[]
 ): NewDatasetRequestPayload => {

test/integration/datasets/DatasetsRepository.test.ts

@@ -588,15 +588,12 @@ describe('DatasetsRepository', () => {
         (actualCreatedDataset.metadataBlocks[0].fields.dsDescription[0] as DatasetDescription)
           .dsDescriptionValue
       ).toBe('This is the description of the dataset.')
-      
+
       const updatedDsDescription = 'This is the updated description of the dataset.'
-      testDataset.metadataBlockValues[0].fields.dsDescription[0].dsDescriptionValue = updatedDsDescription
+      testDataset.metadataBlockValues[0].fields.dsDescription[0].dsDescriptionValue =
+        updatedDsDescription
 
-      await sut.updateDataset(
-        createdDataset.numericId,
-        testDataset,
-        [citationMetadataBlock]
-      )
+      await sut.updateDataset(createdDataset.numericId, testDataset, [citationMetadataBlock])
 
       const actualUpdatedDataset = await sut.getDataset(
         createdDataset.numericId,

test/testHelpers/datasets/datasetHelper.ts

@@ -13,7 +13,10 @@ import {
   DatasetMetadataFieldValueDTO
 } from '../../../src/datasets/domain/dtos/DatasetDTO'
 import { MetadataBlock, MetadataFieldType } from '../../../src'
-import { NewDatasetRequestPayload } from '../../../src/datasets/infra/repositories/transformers/datasetTransformers'
+import {
+  NewDatasetRequestPayload,
+  UpdateDatasetRequestPayload
+} from '../../../src/datasets/infra/repositories/transformers/datasetTransformers'
 import {
   MetadataFieldWatermark,
   MetadataFieldTypeClass
@@ -615,7 +618,9 @@ export const createDatasetMetadataBlockModel = (): MetadataBlock => {
   }
 }
 
-export const createDatasetRequestPayload = (license?: DatasetLicense): NewDatasetRequestPayload => {
+export const createNewDatasetRequestPayload = (
+  license?: DatasetLicense
+): NewDatasetRequestPayload => {
   return {
     datasetVersion: {
       ...(license && { license }),
@@ -676,3 +681,57 @@ export const createDatasetRequestPayload = (license?: DatasetLicense): NewDatase
     }
   }
 }
+
+export const createUpdateDatasetRequestPayload = (): UpdateDatasetRequestPayload => {
+  return {
+    fields: [
+      {
+        value: 'test dataset',
+        typeClass: 'primitive',
+        multiple: false,
+        typeName: 'title'
+      },
+      {
+        value: [
+          {
+            authorName: {
+              value: 'Admin, Dataverse',
+              typeClass: 'primitive',
+              multiple: false,
+              typeName: 'authorName'
+            },
+            authorAffiliation: {
+              value: 'Dataverse.org',
+              typeClass: 'primitive',
+              multiple: false,
+              typeName: 'authorAffiliation'
+            }
+          },
+          {
+            authorName: {
+              value: 'Owner, Dataverse',
+              typeClass: 'primitive',
+              multiple: false,
+              typeName: 'authorName'
+            },
+            authorAffiliation: {
+              value: 'Dataverse.org',
+              typeClass: 'primitive',
+              multiple: false,
+              typeName: 'authorAffiliation'
+            }
+          }
+        ],
+        typeClass: 'compound',
+        multiple: true,
+        typeName: 'author'
+      },
+      {
+        value: ['alternative1', 'alternative2'],
+        typeClass: 'primitive',
+        multiple: true,
+        typeName: 'alternativeRequiredTitle'
+      }
+    ]
+  }
+}

test/unit/datasets/DatasetsRepository.test.ts

@@ -8,7 +8,8 @@ import {
 import {
   createDatasetModel,
   createDatasetVersionPayload,
-  createDatasetLicenseModel
+  createDatasetLicenseModel,
+  createUpdateDatasetRequestPayload
 } from '../../testHelpers/datasets/datasetHelper'
 import { TestConstants } from '../../testHelpers/TestConstants'
 import { DatasetNotNumberedVersion, DatasetPreviewSubset } from '../../../src/datasets'
@@ -24,7 +25,7 @@ import {
 import {
   createDatasetDTO,
   createDatasetMetadataBlockModel,
-  createDatasetRequestPayload
+  createNewDatasetRequestPayload
 } from '../../testHelpers/datasets/datasetHelper'
 import { WriteError } from '../../../src'
 import { VersionUpdateType } from '../../../src/datasets/domain/models/Dataset'
@@ -717,7 +718,7 @@ describe('DatasetsRepository', () => {
     const testNewDataset = createDatasetDTO()
     const testMetadataBlocks = [createDatasetMetadataBlockModel()]
     const testCollectionName = 'test'
-    const expectedNewDatasetRequestPayloadJson = JSON.stringify(createDatasetRequestPayload())
+    const expectedNewDatasetRequestPayloadJson = JSON.stringify(createNewDatasetRequestPayload())
 
     const testCreatedDatasetIdentifiers = {
       persistentId: 'test',
@@ -835,7 +836,16 @@ describe('DatasetsRepository', () => {
   describe('updateDataset', () => {
     const testNewDataset = createDatasetDTO()
     const testMetadataBlocks = [createDatasetMetadataBlockModel()]
-    const expectedNewDatasetRequestPayloadJson = JSON.stringify(createDatasetRequestPayload())
+    const expectedNewDatasetRequestPayloadJson = JSON.stringify(createUpdateDatasetRequestPayload())
+
+    const expectedApiKeyRequestConfig = {
+      ...TestConstants.TEST_EXPECTED_AUTHENTICATED_REQUEST_CONFIG_API_KEY,
+      params: { replace: true }
+    }
+    const expectedCookieRequestConfig = {
+      ...TestConstants.TEST_EXPECTED_AUTHENTICATED_REQUEST_CONFIG_SESSION_COOKIE,
+      params: { replace: true }
+    }
 
     const expectedApiEndpoint = `${TestConstants.TEST_API_URL}/datasets/${testDatasetModel.id}/editMetadata`
 
@@ -848,7 +858,7 @@ describe('DatasetsRepository', () => {
       expect(axios.put).toHaveBeenCalledWith(
         expectedApiEndpoint,
         expectedNewDatasetRequestPayloadJson,
-        TestConstants.TEST_EXPECTED_AUTHENTICATED_REQUEST_CONFIG_API_KEY
+        expectedApiKeyRequestConfig
       )
       expect(actual).toBeUndefined()
 
@@ -860,7 +870,7 @@ describe('DatasetsRepository', () => {
       expect(axios.put).toHaveBeenCalledWith(
         expectedApiEndpoint,
         expectedNewDatasetRequestPayloadJson,
-        TestConstants.TEST_EXPECTED_AUTHENTICATED_REQUEST_CONFIG_SESSION_COOKIE
+        expectedCookieRequestConfig
       )
       expect(actual).toBeUndefined()
     })
@@ -876,7 +886,7 @@ describe('DatasetsRepository', () => {
       expect(axios.put).toHaveBeenCalledWith(
         expectedApiEndpoint,
         expectedNewDatasetRequestPayloadJson,
-        TestConstants.TEST_EXPECTED_AUTHENTICATED_REQUEST_CONFIG_API_KEY
+        expectedApiKeyRequestConfig
       )
       expect(error).toBeInstanceOf(Error)
     })

test/unit/datasets/datasetTransformers.test.ts

@@ -1,17 +1,17 @@
 import {
   createDatasetMetadataBlockModel,
   createDatasetDTO,
-  createDatasetRequestPayload
+  createNewDatasetRequestPayload
 } from '../../testHelpers/datasets/datasetHelper'
-import { transformDatasetModelToRequestPayload } from '../../../src/datasets/infra/repositories/transformers/datasetTransformers'
 import { createDatasetLicenseModel } from '../../testHelpers/datasets/datasetHelper'
+import { transformDatasetModelToNewDatasetRequestPayload } from '../../../src/datasets/infra/repositories/transformers/datasetTransformers'
 
 describe('transformNewDatasetModelToRequestPayload', () => {
   test('should correctly transform a new dataset model to a new dataset request payload', async () => {
     const testDataset = createDatasetDTO()
     const testMetadataBlocks = [createDatasetMetadataBlockModel()]
-    const expectedNewDatasetRequestPayload = createDatasetRequestPayload()
-    const actual = transformDatasetModelToRequestPayload(testDataset, testMetadataBlocks)
+    const expectedNewDatasetRequestPayload = createNewDatasetRequestPayload()
+    const actual = transformDatasetModelToNewDatasetRequestPayload(testDataset, testMetadataBlocks)
 
     expect(actual).toEqual(expectedNewDatasetRequestPayload)
   })
@@ -26,10 +26,10 @@ describe('transformNewDatasetModelToRequestPayload', () => {
       createDatasetLicenseModel()
     )
     const testMetadataBlocks = [createDatasetMetadataBlockModel()]
-    const expectedNewDatasetRequestPayload = createDatasetRequestPayload(
+    const expectedNewDatasetRequestPayload = createNewDatasetRequestPayload(
       createDatasetLicenseModel()
     )
-    const actual = transformDatasetModelToRequestPayload(testDataset, testMetadataBlocks)
+    const actual = transformDatasetModelToNewDatasetRequestPayload(testDataset, testMetadataBlocks)
 
     expect(actual).toEqual(expectedNewDatasetRequestPayload)
   })