Added: updateCollection use case data access (pending refactor)

Author: GPortas

src/collections/infra/repositories/CollectionsRepository.ts

@@ -185,11 +185,46 @@ export class CollectionsRepository extends ApiRepository implements ICollections
       })
   }
 
-  public updateCollection(
+  public async updateCollection(
     collectionIdOrAlias: string | number,
     updatedCollection: CollectionDTO
   ): Promise<void> {
-    throw new Error('Method not implemented ' + collectionIdOrAlias + ' ' + updatedCollection.alias)
+    const dataverseContacts: NewCollectionContactRequestPayload[] = updatedCollection.contacts.map(
+      (contact) => ({
+        contactEmail: contact
+      })
+    )
+
+    const inputLevelsRequestBody: NewCollectionInputLevelRequestPayload[] =
+      updatedCollection.inputLevels?.map((inputLevel) => ({
+        datasetFieldTypeName: inputLevel.datasetFieldName,
+        include: inputLevel.include,
+        required: inputLevel.required
+      }))
+
+    const requestBody: NewCollectionRequestPayload = {
+      alias: updatedCollection.alias,
+      name: updatedCollection.name,
+      dataverseContacts: dataverseContacts,
+      dataverseType: updatedCollection.type,
+      ...(updatedCollection.description && {
+        description: updatedCollection.description
+      }),
+      ...(updatedCollection.affiliation && {
+        affiliation: updatedCollection.affiliation
+      }),
+      metadataBlocks: {
+        metadataBlockNames: updatedCollection.metadataBlockNames,
+        facetIds: updatedCollection.facetIds,
+        inputLevels: inputLevelsRequestBody
+      }
+    }
+
+    return this.doPut(`/${this.collectionsResourceName}/${collectionIdOrAlias}`, requestBody)
+      .then(() => undefined)
+      .catch((error) => {
+        throw error
+      })
   }
 
   private applyCollectionSearchCriteriaToQueryParams(

test/environment/.env

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

test/integration/collections/CollectionsRepository.test.ts

@@ -464,4 +464,67 @@ describe('CollectionsRepository', () => {
       ).rejects.toThrow(expectedError)
     })
   })
+
+  describe('updateCollection', () => {
+    const testUpdatedCollectionAlias = 'updateCollection-test-updatedAlias'
+
+    afterAll(async () => {
+      await deleteCollectionViaApi(testUpdatedCollectionAlias)
+    })
+
+    test('should update the collection', async () => {
+      // First we create a test collection using a CollectionDTO and createCollection method
+      const collectionDTO = createCollectionDTO('updatedCollection-test-originalAlias')
+      const testUpdateCollectionId = await sut.createCollection(collectionDTO)
+      const createdCollection = await sut.getCollection(testUpdateCollectionId)
+      expect(createdCollection.id).toBe(testUpdateCollectionId)
+      expect(createdCollection.alias).toBe(collectionDTO.alias)
+      expect(createdCollection.name).toBe(collectionDTO.name)
+      expect(createdCollection.affiliation).toBe(collectionDTO.affiliation)
+      expect(createdCollection.inputLevels?.length).toBe(1)
+      const inputLevel = createdCollection.inputLevels?.[0]
+      expect(inputLevel?.datasetFieldName).toBe('geographicCoverage')
+      expect(inputLevel?.include).toBe(true)
+      expect(inputLevel?.required).toBe(true)
+
+      // Now we update CollectionDTO and verify updates are correctly persisted after calling updateCollection method
+      collectionDTO.alias = testUpdatedCollectionAlias
+      const updatedCollectionName = 'updatedCollectionName'
+      collectionDTO.name = updatedCollectionName
+      const updatedCollectionAffiliation = 'updatedCollectionAffiliation'
+      collectionDTO.affiliation = updatedCollectionAffiliation
+      const updatedInputLevels = [
+        {
+          datasetFieldName: 'country',
+          required: false,
+          include: true
+        }
+      ]
+      collectionDTO.inputLevels = updatedInputLevels
+      await sut.updateCollection(testUpdateCollectionId, collectionDTO)
+      const updatedCollection = await sut.getCollection(testUpdateCollectionId)
+      expect(updatedCollection.id).toBe(testUpdateCollectionId)
+      expect(updatedCollection.alias).toBe(testUpdatedCollectionAlias)
+      expect(updatedCollection.name).toBe(updatedCollectionName)
+      expect(updatedCollection.affiliation).toBe(updatedCollectionAffiliation)
+      expect(updatedCollection.inputLevels?.length).toBe(1)
+      const updatedInputLevel = updatedCollection.inputLevels?.[0]
+      expect(updatedInputLevel?.datasetFieldName).toBe('country')
+      expect(updatedInputLevel?.include).toBe(true)
+      expect(updatedInputLevel?.required).toBe(false)
+    })
+
+    test('should return error when collection does not exist', async () => {
+      const expectedError = new WriteError(
+        `[404] Can't find dataverse with identifier='${TestConstants.TEST_DUMMY_COLLECTION_ID}'`
+      )
+      const testCollectionAlias = 'updateCollection-not-found-test'
+      await expect(
+        sut.updateCollection(
+          TestConstants.TEST_DUMMY_COLLECTION_ID,
+          createCollectionDTO(testCollectionAlias)
+        )
+      ).rejects.toThrow(expectedError)
+    })
+  })
 })

test/unit/collections/CollectionsRepository.test.ts

@@ -191,6 +191,64 @@ describe('CollectionsRepository', () => {
     })
   })
 
+  describe('updateCollection', () => {
+    const testUpdatedCollection = createCollectionDTO()
+    const testAlias = 'testCollectionAlias'
+
+    const testCreatedCollectionId = 1
+    const testCreateCollectionResponse = {
+      data: {
+        status: 'OK',
+        data: {
+          id: testCreatedCollectionId
+        }
+      }
+    }
+
+    const expectedUpdatedCollectionRequestPayloadJson = JSON.stringify(
+      createNewCollectionRequestPayload()
+    )
+    const expectedApiEndpoint = `${TestConstants.TEST_API_URL}/dataverses/${testAlias}`
+
+    test('should call the API with a correct request payload', async () => {
+      jest.spyOn(axios, 'put').mockResolvedValue(testCreateCollectionResponse)
+
+      // API Key auth
+      await sut.updateCollection(testAlias, testUpdatedCollection)
+
+      expect(axios.put).toHaveBeenCalledWith(
+        expectedApiEndpoint,
+        expectedUpdatedCollectionRequestPayloadJson,
+        TestConstants.TEST_EXPECTED_AUTHENTICATED_REQUEST_CONFIG_API_KEY
+      )
+
+      // Session cookie auth
+      ApiConfig.init(TestConstants.TEST_API_URL, DataverseApiAuthMechanism.SESSION_COOKIE)
+
+      await sut.updateCollection(testAlias, testUpdatedCollection)
+
+      expect(axios.put).toHaveBeenCalledWith(
+        expectedApiEndpoint,
+        expectedUpdatedCollectionRequestPayloadJson,
+        TestConstants.TEST_EXPECTED_AUTHENTICATED_REQUEST_CONFIG_SESSION_COOKIE
+      )
+    })
+
+    test('should return error result on error response', async () => {
+      jest.spyOn(axios, 'put').mockRejectedValue(TestConstants.TEST_ERROR_RESPONSE)
+
+      let error = undefined as unknown as WriteError
+      await sut.updateCollection(testAlias, testUpdatedCollection).catch((e) => (error = e))
+
+      expect(axios.put).toHaveBeenCalledWith(
+        expectedApiEndpoint,
+        expectedUpdatedCollectionRequestPayloadJson,
+        TestConstants.TEST_EXPECTED_AUTHENTICATED_REQUEST_CONFIG_API_KEY
+      )
+      expect(error).toBeInstanceOf(Error)
+    })
+  })
+
   describe('getCollectionFacets', () => {
     const testFacetsSuccessfulResponse = {
       data: {