feat: add childCount property to Collection Model

Author: g-saracca

src/collections/domain/models/Collection.ts

@@ -15,6 +15,7 @@ export interface Collection {
   contacts?: CollectionContact[]
   isMetadataBlockRoot: boolean
   isFacetRoot: boolean
+  childCount: number
 }
 
 export interface CollectionInputLevel {

src/collections/infra/repositories/CollectionsRepository.ts

@@ -70,7 +70,8 @@ export class CollectionsRepository extends ApiRepository implements ICollections
     collectionIdOrAlias: number | string = ROOT_COLLECTION_ID
   ): Promise<Collection> {
     return this.doGet(`/${this.collectionsResourceName}/${collectionIdOrAlias}`, true, {
-      returnOwners: true
+      returnOwners: true,
+      returnChildCount: true
     })
       .then((response) => transformCollectionResponseToCollection(response))
       .catch((error) => {

src/collections/infra/repositories/transformers/CollectionPayload.ts

@@ -13,6 +13,7 @@ export interface CollectionPayload {
   dataverseType: string
   isMetadataBlockRoot: boolean
   isFacetRoot: boolean
+  childCount: number
 }
 
 export interface CollectionInputLevelPayload {

src/collections/infra/repositories/transformers/collectionTransformers.ts

@@ -53,6 +53,7 @@ const transformPayloadToCollection = (collectionPayload: CollectionPayload): Col
     type: collectionPayload.dataverseType as CollectionType,
     isMetadataBlockRoot: collectionPayload.isMetadataBlockRoot,
     isFacetRoot: collectionPayload.isFacetRoot,
+    childCount: collectionPayload.childCount,
     ...(collectionPayload.description && {
       description: transformHtmlToMarkdown(collectionPayload.description)
     }),

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=11255-child-count-get-collection-ext
 DATAVERSE_BOOTSTRAP_TIMEOUT=5m

test/integration/collections/CollectionsRepository.test.ts

@@ -128,6 +128,34 @@ describe('CollectionsRepository', () => {
         )
       })
     })
+
+    test('should return childCount correctly', async () => {
+      const parentCollectionAlias = 'childCountTestCollection'
+      const childCollectionAlias = 'childCountTestChildCollection'
+
+      await createCollectionViaApi(parentCollectionAlias, ROOT_COLLECTION_ALIAS)
+      await createCollectionViaApi(childCollectionAlias, parentCollectionAlias)
+      const { numericId: childDatasetNumericId } = await createDataset.execute(
+        TestConstants.TEST_NEW_DATASET_DTO,
+        parentCollectionAlias
+      )
+
+      const actual = await sut.getCollection(parentCollectionAlias)
+
+      expect(actual.childCount).toBe(2)
+
+      await deleteCollectionViaApi(childCollectionAlias)
+
+      const actualAfterDeletion = await sut.getCollection(parentCollectionAlias)
+
+      expect(actualAfterDeletion.childCount).toBe(1)
+
+      await deleteUnpublishedDatasetViaApi(childDatasetNumericId)
+
+      const actualAfterDatasetDeletion = await sut.getCollection(parentCollectionAlias)
+
+      expect(actualAfterDatasetDeletion.childCount).toBe(0)
+    })
   })
 
   describe('publishCollection', () => {

test/testHelpers/collections/collectionHelper.ts

@@ -47,7 +47,8 @@ export const createCollectionModel = (): Collection => {
       }
     ],
     isMetadataBlockRoot: true,
-    isFacetRoot: true
+    isFacetRoot: true,
+    childCount: 0
   }
   return collectionModel
 }
@@ -76,7 +77,8 @@ export const createCollectionPayload = (): CollectionPayload => {
       }
     ],
     isMetadataBlockRoot: true,
-    isFacetRoot: true
+    isFacetRoot: true,
+    childCount: 0
   }
   return collectionPayload
 }

test/unit/auth/BearerTokenMechanism.test.ts

@@ -46,7 +46,8 @@ describe('BearerTokenMechanism', () => {
     const expectedRequestConfigBearerToken = {
       headers: TestConstants.TEST_EXPECTED_AUTHENTICATED_REQUEST_CONFIG_BEARER_TOKEN.headers,
       params: {
-        returnOwners: true
+        returnOwners: true,
+        returnChildCount: true
       }
     }
 

test/unit/collections/CollectionsRepository.test.ts

@@ -66,7 +66,8 @@ describe('CollectionsRepository', () => {
   describe('getCollection', () => {
     const expectedRequestConfigApiKey = {
       params: {
-        returnOwners: true
+        returnOwners: true,
+        returnChildCount: true
       },
       headers: TestConstants.TEST_EXPECTED_AUTHENTICATED_REQUEST_CONFIG_API_KEY.headers
     }