use special key ':root', rather than alias 'root' to get the root collection

ekraffmiller · ekraffmiller · commit 37f9617260a8 · 2024-10-28T10:23:56.000-04:00
diff --git a/src/collections/domain/models/Collection.ts b/src/collections/domain/models/Collection.ts
@@ -17,4 +17,4 @@ export interface CollectionInputLevel {
   required: boolean
 }
 
-export const ROOT_COLLECTION_ALIAS = 'root'
+export const ROOT_COLLECTION_KEY = ':root'
diff --git a/src/collections/domain/useCases/CreateCollection.ts b/src/collections/domain/useCases/CreateCollection.ts
@@ -1,6 +1,6 @@
 import { UseCase } from '../../../core/domain/useCases/UseCase'
 import { CollectionDTO } from '../dtos/CollectionDTO'
-import { ROOT_COLLECTION_ALIAS } from '../models/Collection'
+import { ROOT_COLLECTION_KEY } from '../models/Collection'
 import { ICollectionsRepository } from '../repositories/ICollectionsRepository'
 
 export class CreateCollection implements UseCase<number> {
@@ -20,7 +20,7 @@ export class CreateCollection implements UseCase<number> {
    */
   async execute(
     newCollection: CollectionDTO,
-    parentCollectionId: number | string = ROOT_COLLECTION_ALIAS
+    parentCollectionId: number | string = ROOT_COLLECTION_KEY
   ): Promise<number> {
     return await this.collectionsRepository.createCollection(newCollection, parentCollectionId)
   }
diff --git a/src/collections/domain/useCases/GetCollection.ts b/src/collections/domain/useCases/GetCollection.ts
@@ -1,6 +1,6 @@
 import { UseCase } from '../../../core/domain/useCases/UseCase'
 import { ICollectionsRepository } from '../repositories/ICollectionsRepository'
-import { Collection, ROOT_COLLECTION_ALIAS } from '../models/Collection'
+import { Collection, ROOT_COLLECTION_KEY } from '../models/Collection'
 
 export class GetCollection implements UseCase<Collection> {
   private collectionsRepository: ICollectionsRepository
@@ -16,7 +16,7 @@ export class GetCollection implements UseCase<Collection> {
    * If this parameter is not set, the default value is: 'root'
    * @returns {Promise<Collection>}
    */
-  async execute(collectionIdOrAlias: number | string = ROOT_COLLECTION_ALIAS): Promise<Collection> {
+  async execute(collectionIdOrAlias: number | string = ROOT_COLLECTION_KEY): Promise<Collection> {
     return await this.collectionsRepository.getCollection(collectionIdOrAlias)
   }
 }
diff --git a/src/collections/domain/useCases/GetCollectionFacets.ts b/src/collections/domain/useCases/GetCollectionFacets.ts
@@ -1,6 +1,6 @@
 import { UseCase } from '../../../core/domain/useCases/UseCase'
 import { ICollectionsRepository } from '../repositories/ICollectionsRepository'
-import { ROOT_COLLECTION_ALIAS } from '../models/Collection'
+import { ROOT_COLLECTION_KEY } from '../models/Collection'
 import { CollectionFacet } from '../models/CollectionFacet'
 
 export class GetCollectionFacets implements UseCase<CollectionFacet[]> {
@@ -18,7 +18,7 @@ export class GetCollectionFacets implements UseCase<CollectionFacet[]> {
    * @returns {Promise<string[]>}
    */
   async execute(
-    collectionIdOrAlias: number | string = ROOT_COLLECTION_ALIAS
+    collectionIdOrAlias: number | string = ROOT_COLLECTION_KEY
   ): Promise<CollectionFacet[]> {
     return await this.collectionsRepository.getCollectionFacets(collectionIdOrAlias)
   }
diff --git a/src/collections/infra/repositories/CollectionsRepository.ts b/src/collections/infra/repositories/CollectionsRepository.ts
@@ -5,7 +5,7 @@ import {
   transformCollectionItemsResponseToCollectionItemSubset,
   transformCollectionResponseToCollection
 } from './transformers/collectionTransformers'
-import { Collection, ROOT_COLLECTION_ALIAS } from '../../domain/models/Collection'
+import { Collection, ROOT_COLLECTION_KEY } from '../../domain/models/Collection'
 import { CollectionDTO } from '../../domain/dtos/CollectionDTO'
 import { CollectionFacet } from '../../domain/models/CollectionFacet'
 import { CollectionUserPermissions } from '../../domain/models/CollectionUserPermissions'
@@ -52,7 +52,7 @@ export class CollectionsRepository extends ApiRepository implements ICollections
   private readonly collectionsResourceName: string = 'dataverses'
 
   public async getCollection(
-    collectionIdOrAlias: number | string = ROOT_COLLECTION_ALIAS
+    collectionIdOrAlias: number | string = ROOT_COLLECTION_KEY
   ): Promise<Collection> {
     return this.doGet(`/${this.collectionsResourceName}/${collectionIdOrAlias}`, true, {
       returnOwners: true
@@ -65,7 +65,7 @@ export class CollectionsRepository extends ApiRepository implements ICollections
 
   public async createCollection(
     collectionDTO: CollectionDTO,
-    parentCollectionId: number | string = ROOT_COLLECTION_ALIAS
+    parentCollectionId: number | string = ROOT_COLLECTION_KEY
   ): Promise<number> {
     const dataverseContacts: NewCollectionContactRequestPayload[] = collectionDTO.contacts.map(
       (contact) => ({
diff --git a/src/datasets/domain/useCases/CreateDataset.ts b/src/datasets/domain/useCases/CreateDataset.ts
@@ -3,7 +3,7 @@ import { DatasetDTO } from '../dtos/DatasetDTO'
 import { ResourceValidator } from '../../../core/domain/useCases/validators/ResourceValidator'
 import { IMetadataBlocksRepository } from '../../../metadataBlocks/domain/repositories/IMetadataBlocksRepository'
 import { CreatedDatasetIdentifiers } from '../models/CreatedDatasetIdentifiers'
-import { ROOT_COLLECTION_ALIAS } from '../../../collections/domain/models/Collection'
+import { ROOT_COLLECTION_KEY } from '../../../collections/domain/models/Collection'
 import { DatasetWriteUseCase } from './DatasetWriteUseCase'
 
 export class CreateDataset extends DatasetWriteUseCase<CreatedDatasetIdentifiers> {
@@ -27,7 +27,7 @@ export class CreateDataset extends DatasetWriteUseCase<CreatedDatasetIdentifiers
    */
   async execute(
     newDataset: DatasetDTO,
-    collectionId = ROOT_COLLECTION_ALIAS
+    collectionId = ROOT_COLLECTION_KEY
   ): Promise<CreatedDatasetIdentifiers> {
     const metadataBlocks = await this.getNewDatasetMetadataBlocks(newDataset)
     this.getNewDatasetValidator().validate(newDataset, metadataBlocks)
diff --git a/src/metadataBlocks/domain/useCases/GetCollectionMetadataBlocks.ts b/src/metadataBlocks/domain/useCases/GetCollectionMetadataBlocks.ts
@@ -1,6 +1,6 @@
 import { UseCase } from '../../../core/domain/useCases/UseCase'
 import { MetadataBlock } from '../..'
-import { ROOT_COLLECTION_ALIAS } from '../../../collections/domain/models/Collection'
+import { ROOT_COLLECTION_KEY } from '../../../collections/domain/models/Collection'
 import { IMetadataBlocksRepository } from '../repositories/IMetadataBlocksRepository'
 
 export class GetCollectionMetadataBlocks implements UseCase<MetadataBlock[]> {
@@ -19,7 +19,7 @@ export class GetCollectionMetadataBlocks implements UseCase<MetadataBlock[]> {
    * @returns {Promise<MetadataBlock[]>}
    */
   async execute(
-    collectionIdOrAlias: number | string = ROOT_COLLECTION_ALIAS,
+    collectionIdOrAlias: number | string = ROOT_COLLECTION_KEY,
     onlyDisplayedOnCreate = false
   ): Promise<MetadataBlock[]> {
     return await this.metadataBlocksRepository.getCollectionMetadataBlocks(
diff --git a/test/functional/collections/GetCollectionFacets.test.ts b/test/functional/collections/GetCollectionFacets.test.ts
@@ -1,7 +1,8 @@
 import { ApiConfig, CollectionFacet, ReadError, getCollectionFacets } from '../../../src'
 import { TestConstants } from '../../testHelpers/TestConstants'
 import { DataverseApiAuthMechanism } from '../../../src/core/infra/repositories/ApiConfig'
-import { ROOT_COLLECTION_ALIAS } from '../../../src/collections/domain/models/Collection'
+
+import { ROOT_COLLECTION_ALIAS } from '../../testHelpers/collections/collectionHelper'
 
 describe('execute', () => {
   beforeEach(async () => {
diff --git a/test/functional/collections/GetCollectionUserPermissions.test.ts b/test/functional/collections/GetCollectionUserPermissions.test.ts
@@ -6,7 +6,8 @@ import {
 } from '../../../src'
 import { TestConstants } from '../../testHelpers/TestConstants'
 import { DataverseApiAuthMechanism } from '../../../src/core/infra/repositories/ApiConfig'
-import { ROOT_COLLECTION_ALIAS } from '../../../src/collections/domain/models/Collection'
+
+import { ROOT_COLLECTION_ALIAS } from '../../testHelpers/collections/collectionHelper'
 
 describe('execute', () => {
   beforeEach(async () => {
diff --git a/test/integration/collections/CollectionsRepository.test.ts b/test/integration/collections/CollectionsRepository.test.ts
@@ -16,9 +16,9 @@ import { DataverseApiAuthMechanism } from '../../../src/core/infra/repositories/
 import {
   createCollectionDTO,
   createCollectionViaApi,
-  deleteCollectionViaApi
+  deleteCollectionViaApi,
+  ROOT_COLLECTION_ALIAS
 } from '../../testHelpers/collections/collectionHelper'
-import { ROOT_COLLECTION_ALIAS } from '../../../src/collections/domain/models/Collection'
 import { CollectionPayload } from '../../../src/collections/infra/repositories/transformers/CollectionPayload'
 import { uploadFileViaApi } from '../../testHelpers/files/filesHelper'
 import { deleteUnpublishedDatasetViaApi } from '../../testHelpers/datasets/datasetHelper'
diff --git a/test/integration/datasets/DatasetsRepository.test.ts b/test/integration/datasets/DatasetsRepository.test.ts
@@ -26,10 +26,10 @@ import {
   DatasetContact,
   DatasetDescription
 } from '../../../src/datasets/domain/models/Dataset'
-import { ROOT_COLLECTION_ALIAS } from '../../../src/collections/domain/models/Collection'
 import {
   createCollectionViaApi,
-  deleteCollectionViaApi
+  deleteCollectionViaApi,
+  ROOT_COLLECTION_ALIAS
 } from '../../testHelpers/collections/collectionHelper'
 
 describe('DatasetsRepository', () => {
diff --git a/test/testHelpers/collections/collectionHelper.ts b/test/testHelpers/collections/collectionHelper.ts
@@ -186,3 +186,4 @@ export const createCollectionFacetRequestPayload = (): CollectionFacetPayload =>
     displayName: 'testDisplayName'
   }
 }
+export const ROOT_COLLECTION_ALIAS = 'root'
diff --git a/test/unit/collections/CollectionsRepository.test.ts b/test/unit/collections/CollectionsRepository.test.ts
@@ -13,7 +13,7 @@ import {
 } from '../../testHelpers/collections/collectionHelper'
 import { TestConstants } from '../../testHelpers/TestConstants'
 import { ReadError, WriteError } from '../../../src'
-import { ROOT_COLLECTION_ALIAS } from '../../../src/collections/domain/models/Collection'
+import { ROOT_COLLECTION_KEY } from '../../../src/collections/domain/models/Collection'
 import {
   createCollectionUserPermissionsModel,
   createCollectionUserPermissionsPayload
@@ -109,7 +109,7 @@ describe('CollectionsRepository', () => {
     describe('by default root id', () => {
       test('should return a Collection when no collection id, using ROOT instead is successful', async () => {
         jest.spyOn(axios, 'get').mockResolvedValue(testCollectionSuccessfulResponse)
-        const expectedApiEndpoint = `${TestConstants.TEST_API_URL}/dataverses/${ROOT_COLLECTION_ALIAS}`
+        const expectedApiEndpoint = `${TestConstants.TEST_API_URL}/dataverses/${ROOT_COLLECTION_KEY}`
 
         // API Key auth
         const actual = await sut.getCollection()
@@ -120,7 +120,7 @@ describe('CollectionsRepository', () => {
 
       test('should return error on repository read error', async () => {
         jest.spyOn(axios, 'get').mockRejectedValue(TestConstants.TEST_ERROR_RESPONSE)
-        const expectedApiEndpoint = `${TestConstants.TEST_API_URL}/dataverses/${ROOT_COLLECTION_ALIAS}`
+        const expectedApiEndpoint = `${TestConstants.TEST_API_URL}/dataverses/${ROOT_COLLECTION_KEY}`
 
         let error = undefined as unknown as ReadError
 
@@ -148,7 +148,7 @@ describe('CollectionsRepository', () => {
     const expectedNewCollectionRequestPayloadJson = JSON.stringify(
       createNewCollectionRequestPayload()
     )
-    const expectedApiEndpoint = `${TestConstants.TEST_API_URL}/dataverses/root`
+    const expectedApiEndpoint = `${TestConstants.TEST_API_URL}/dataverses/:root`
 
     test('should call the API with a correct request payload', async () => {
       jest.spyOn(axios, 'post').mockResolvedValue(testCreateCollectionResponse)
diff --git a/test/unit/datasets/CreateDataset.test.ts b/test/unit/datasets/CreateDataset.test.ts
@@ -9,7 +9,7 @@ import {
 import { ResourceValidationError } from '../../../src/core/domain/useCases/validators/errors/ResourceValidationError'
 import { WriteError, ReadError } from '../../../src'
 import { IMetadataBlocksRepository } from '../../../src/metadataBlocks/domain/repositories/IMetadataBlocksRepository'
-import { ROOT_COLLECTION_ALIAS } from '../../../src/collections/domain/models/Collection'
+import { ROOT_COLLECTION_KEY } from '../../../src/collections/domain/models/Collection'
 
 describe('execute', () => {
   const testDataset = createDatasetDTO()
@@ -51,7 +51,7 @@ describe('execute', () => {
     expect(datasetsRepositoryStub.createDataset).toHaveBeenCalledWith(
       testDataset,
       testMetadataBlocks,
-      ROOT_COLLECTION_ALIAS
+      ROOT_COLLECTION_KEY
     )
   })
 
@@ -111,7 +111,7 @@ describe('execute', () => {
     expect(datasetsRepositoryStub.createDataset).toHaveBeenCalledWith(
       testDataset,
       testMetadataBlocks,
-      ROOT_COLLECTION_ALIAS
+      ROOT_COLLECTION_KEY
     )
   })
 

Original file line number	Diff line number	Diff line change
`@@ -17,4 +17,4 @@ export interface CollectionInputLevel {`
`17`	`17`	`required: boolean`
`18`	`18`	`}`
`19`	`19`
`20`		`-export const ROOT_COLLECTION_ALIAS = 'root'`
	`20`	`+export const ROOT_COLLECTION_KEY = ':root'`