save datasetType supplied in "create dataset" JSON #359

Author: pdurbin

src/datasets/domain/repositories/IDatasetsRepository.ts

@@ -44,7 +44,8 @@ export interface IDatasetsRepository {
   createDataset(
     newDataset: DatasetDTO,
     datasetMetadataBlocks: MetadataBlock[],
-    collectionId: string
+    collectionId: string,
+    datasetType?: string
   ): Promise<CreatedDatasetIdentifiers>
   publishDataset(datasetId: number | string, versionUpdateType: VersionUpdateType): Promise<void>
   updateDataset(

src/datasets/domain/useCases/CreateDataset.ts

@@ -27,10 +27,16 @@ export class CreateDataset extends DatasetWriteUseCase<CreatedDatasetIdentifiers
    */
   async execute(
     newDataset: DatasetDTO,
-    collectionId = ROOT_COLLECTION_ID
+    collectionId = ROOT_COLLECTION_ID,
+    datasetType?: string
   ): Promise<CreatedDatasetIdentifiers> {
     const metadataBlocks = await this.getNewDatasetMetadataBlocks(newDataset)
     this.getNewDatasetValidator().validate(newDataset, metadataBlocks)
-    return this.getDatasetsRepository().createDataset(newDataset, metadataBlocks, collectionId)
+    return this.getDatasetsRepository().createDataset(
+      newDataset,
+      metadataBlocks,
+      collectionId,
+      datasetType
+    )
   }
 }

src/datasets/infra/repositories/DatasetsRepository.ts

@@ -203,11 +203,16 @@ export class DatasetsRepository extends ApiRepository implements IDatasetsReposi
   public async createDataset(
     newDataset: DatasetDTO,
     datasetMetadataBlocks: MetadataBlock[],
-    collectionId: string
+    collectionId: string,
+    datasetType?: string
   ): Promise<CreatedDatasetIdentifiers> {
     return this.doPost(
       `/dataverses/${collectionId}/datasets`,
-      transformDatasetModelToNewDatasetRequestPayload(newDataset, datasetMetadataBlocks)
+      transformDatasetModelToNewDatasetRequestPayload(
+        newDataset,
+        datasetMetadataBlocks,
+        datasetType
+      )
     )
       .then((response) => {
         const responseData = response.data.data

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

@@ -35,6 +35,7 @@ export interface NewDatasetRequestPayload {
     license?: DatasetLicense
     metadataBlocks: Record<string, MetadataBlockRequestPayload>
   }
+  datasetType?: string
 }
 
 export interface MetadataBlockRequestPayload {
@@ -96,9 +97,11 @@ export const transformDatasetModelToUpdateDatasetRequestPayload = (
 
 export const transformDatasetModelToNewDatasetRequestPayload = (
   dataset: DatasetDTO,
-  metadataBlocks: MetadataBlock[]
+  metadataBlocks: MetadataBlock[],
+  datasetType?: string
 ): NewDatasetRequestPayload => {
   return {
+    datasetType: datasetType,
     datasetVersion: {
       ...(dataset.license && { license: dataset.license }),
       metadataBlocks: transformMetadataBlockModelsToRequestPayload(

test/functional/datasets/PublishDataset.test.ts

@@ -12,6 +12,10 @@ import {
   waitForNoLocks,
   deletePublishedDatasetViaApi
 } from '../../testHelpers/datasets/datasetHelper'
+import { ROOT_COLLECTION_ID } from '../../../src/collections/domain/models/Collection'
+
+// "dataset" is the default so this is equivalent to not passing a datasetType
+const datasetType = 'dataset'
 
 const testNewDataset = {
   license: {
@@ -61,7 +65,11 @@ describe('execute', () => {
   })
 
   test('should successfully publish a dataset', async () => {
-    const createdDatasetIdentifiers = await createDataset.execute(testNewDataset)
+    const createdDatasetIdentifiers = await createDataset.execute(
+      testNewDataset,
+      ROOT_COLLECTION_ID,
+      datasetType
+    )
 
     const response = await publishDataset.execute(
       createdDatasetIdentifiers.persistentId,
@@ -74,7 +82,11 @@ describe('execute', () => {
   })
 
   test('should successfully publish a dataset with update current version', async () => {
-    const createdDatasetIdentifiers = await createDataset.execute(testNewDataset)
+    const createdDatasetIdentifiers = await createDataset.execute(
+      testNewDataset,
+      ROOT_COLLECTION_ID,
+      datasetType
+    )
 
     const firstPublishResponse = await publishDataset.execute(
       createdDatasetIdentifiers.persistentId,

test/testHelpers/datasets/datasetHelper.ts

@@ -694,9 +694,11 @@ export const createDatasetMetadataBlockModel = (): MetadataBlock => {
 }
 
 export const createNewDatasetRequestPayload = (
-  license?: DatasetLicense
+  license?: DatasetLicense,
+  datasetType?: string
 ): NewDatasetRequestPayload => {
   return {
+    datasetType: datasetType,
     datasetVersion: {
       ...(license && { license }),
       metadataBlocks: {

test/unit/datasets/CreateDataset.test.ts

@@ -51,7 +51,8 @@ describe('execute', () => {
     expect(datasetsRepositoryStub.createDataset).toHaveBeenCalledWith(
       testDataset,
       testMetadataBlocks,
-      ROOT_COLLECTION_ID
+      ROOT_COLLECTION_ID,
+      undefined
     )
   })
 
@@ -111,7 +112,8 @@ describe('execute', () => {
     expect(datasetsRepositoryStub.createDataset).toHaveBeenCalledWith(
       testDataset,
       testMetadataBlocks,
-      ROOT_COLLECTION_ID
+      ROOT_COLLECTION_ID,
+      undefined
     )
   })
 

test/unit/datasets/datasetTransformers.test.ts

@@ -16,7 +16,7 @@ describe('transformNewDatasetModelToRequestPayload', () => {
     expect(actual).toEqual(expectedNewDatasetRequestPayload)
   })
 
-  it('should correctly transform a new dataset model to a new dataset request payload when it contains a license', () => {
+  it('should correctly transform a new dataset model to a new dataset request payload when it contains a license and a datasetType', () => {
     const testDataset = createDatasetDTO(
       undefined,
       undefined,
@@ -26,10 +26,16 @@ describe('transformNewDatasetModelToRequestPayload', () => {
       createDatasetLicenseModel()
     )
     const testMetadataBlocks = [createDatasetMetadataBlockModel()]
+    const datasetType = 'software'
     const expectedNewDatasetRequestPayload = createNewDatasetRequestPayload(
-      createDatasetLicenseModel()
+      createDatasetLicenseModel(),
+      datasetType
+    )
+    const actual = transformDatasetModelToNewDatasetRequestPayload(
+      testDataset,
+      testMetadataBlocks,
+      datasetType
     )
-    const actual = transformDatasetModelToNewDatasetRequestPayload(testDataset, testMetadataBlocks)
 
     expect(actual).toEqual(expectedNewDatasetRequestPayload)
   })