feat(BreadcrumbsIntegration): add e2e tests

Author: MellyGray

src/sections/shared/hierarchy/BreadcrumbsGenerator.tsx

@@ -69,7 +69,7 @@ const LinkToDvObject = ({
   return (
     <LinkToPage
       page={dvObjectTypeToRoute[type]}
-      searchParams={{ ...(version ? { version } : {}), ...idParam }}>
+      searchParams={{ ...idParam, ...(version ? { version } : {}) }}>
       {name}
     </LinkToPage>
   )

tests/component/dataset/infrastructure/mappers/JSDatasetMapper.spec.ts

@@ -60,7 +60,12 @@ const jsDataset = {
     uri: 'http://creativecommons.org/publicdomain/zero/1.0',
     iconUri: 'https://licensebuttons.net/p/zero/1.0/88x31.png'
   },
-  thumbnail: undefined
+  thumbnail: undefined,
+  isPartOf: {
+    type: 'DATAVERSE',
+    identifier: 'root',
+    displayName: 'Root'
+  }
 }
 const citation =
   'Finch, Fiona, 2023, "Darwin\'s Finches", <a href="https://doi.org/10.5072/FK2/B4B2MJ" target="_blank">https://doi.org/10.5072/FK2/B4B2MJ</a>, Root, DRAFT VERSION'
@@ -172,8 +177,8 @@ const expectedDataset = {
   hierarchy: new UpwardHierarchyNode(
     "Darwin's Finches",
     DvObjectType.DATASET,
-    undefined,
-    undefined,
+    'doi:10.5072/FK2/B4B2MJ',
+    '0.0',
     new UpwardHierarchyNode('Root', DvObjectType.COLLECTION, 'root')
   )
 }
@@ -279,8 +284,8 @@ const expectedDatasetAlternateVersion = {
   hierarchy: new UpwardHierarchyNode(
     "Darwin's Finches",
     DvObjectType.DATASET,
-    undefined,
-    undefined,
+    'doi:10.5072/FK2/B4B2MJ',
+    '0.0',
     new UpwardHierarchyNode('Root', DvObjectType.COLLECTION, 'root')
   )
 }
@@ -295,6 +300,7 @@ describe('JS Dataset Mapper', () => {
       jsDatasetFilesTotalOriginalDownloadSize,
       jsDatasetFilesTotalArchivalDownloadSize
     )
+
     expect(expectedDataset).to.deep.equal(mapped)
   })
   it('maps jsDataset model to the domain Dataset model for alternate version', () => {

tests/component/sections/shared/hierarchy/BreadcrumbsGenerator.spec.tsx

@@ -16,7 +16,7 @@ describe('BreadcrumbsGenerator', () => {
       name: 'Dataset',
       parent: collection,
       version: '1.0',
-      persistentId: 'doi:10.5072/FK2/ABC123'
+      id: 'doi:10.5072/FK2/ABC123'
     })
     const file = UpwardHierarchyNodeMother.createFile({ name: 'File', parent: dataset })
 

tests/component/shared/hierarchy/domain/models/UpwardHierarchyNodeMother.ts

@@ -9,8 +9,8 @@ export class UpwardHierarchyNodeMother {
     return new UpwardHierarchyNode(
       props?.name ?? faker.lorem.word(),
       props?.type ?? faker.helpers.arrayElement(Object.values(DvObjectType)),
-      props?.id ?? undefined,
-      undefined,
+      props?.id ?? faker.datatype.uuid(),
+      props?.version ?? undefined,
       props?.parent ?? undefined
     )
   }

tests/e2e-integration/e2e/sections/dataset/Dataset.spec.tsx

@@ -3,6 +3,7 @@ import { TestsUtils } from '../../../shared/TestsUtils'
 import { DatasetHelper, DatasetResponse } from '../../../shared/datasets/DatasetHelper'
 import { FileHelper } from '../../../shared/files/FileHelper'
 import moment from 'moment-timezone'
+import { CollectionHelper } from '../../../shared/collection/CollectionHelper'
 
 type Dataset = {
   datasetVersion: { metadataBlocks: { citation: { fields: { value: string }[] } } }
@@ -170,6 +171,23 @@ describe('Dataset', () => {
           cy.findByText(DatasetLabelValue.DEACCESSIONED).should('exist')
         })
     })
+
+    it('loads correctly the breadcrumbs when the dataset is part of a subcollection', () => {
+      cy.wrap(
+        CollectionHelper.create('subcollection').then((collection) =>
+          DatasetHelper.create(collection.id)
+        )
+      )
+        .its('persistentId')
+        .then((persistentId: string) => {
+          cy.visit(`/spa/datasets?persistentId=${persistentId}`)
+
+          cy.findByText('Root').should('exist')
+          cy.findByRole('link', { name: 'Subcollection' }).should('exist').click()
+
+          cy.findAllByText('Subcollection').should('exist')
+        })
+    })
   })
 
   describe('Visualizing the Files Tab', () => {

tests/e2e-integration/e2e/sections/file/File.spec.tsx

@@ -95,5 +95,22 @@ describe('File', () => {
       cy.visit(`/spa/files?id=wrong-id`)
       cy.findByText('Page Not Found').should('exist')
     })
+
+    it('loads correctly the breadcrumbs', () => {
+      cy.wrap(
+        DatasetHelper.createWithFile(FileHelper.create()).then(
+          (datasetResponse) => datasetResponse.file
+        )
+      )
+        .its('id')
+        .then((id: string) => {
+          cy.visit(`/spa/files?id=${id}`)
+
+          cy.findByText('Root').should('exist')
+          cy.findByRole('link', { name: "Darwin's Finches" }).should('exist').click({ force: true })
+
+          cy.findByRole('heading', { name: "Darwin's Finches" }).should('exist')
+        })
+    })
   })
 })

tests/e2e-integration/fixtures/new-collection-data.json

@@ -0,0 +1,15 @@
+{
+  "name": "Subcollection",
+  "alias": "science",
+  "dataverseContacts": [
+    {
+      "contactEmail": "pi@example.edu"
+    },
+    {
+      "contactEmail": "student@example.edu"
+    }
+  ],
+  "affiliation": "Scientific Research University",
+  "description": "We do all the science.",
+  "dataverseType": "LABORATORY"
+}

tests/e2e-integration/shared/collection/CollectionHelper.ts

@@ -0,0 +1,32 @@
+import { DataverseApiHelper } from '../DataverseApiHelper'
+import newCollectionData from '../../fixtures/new-collection-data.json'
+
+export interface CollectionResponse {
+  id: string
+}
+
+interface CollectionPayload {
+  alias: string
+}
+
+export class CollectionHelper extends DataverseApiHelper {
+  static async create(id = 'subcollection'): Promise<CollectionResponse> {
+    const collection: CollectionPayload | undefined = await this.request<CollectionPayload>(
+      `/dataverses/${id}`,
+      'GET'
+    ).catch(() => undefined)
+    if (collection) {
+      return { id: collection.alias }
+    }
+
+    const newCollection: CollectionPayload = await this.request<CollectionPayload>(
+      `/dataverses/root`,
+      'POST',
+      {
+        ...newCollectionData,
+        alias: id
+      }
+    )
+    return { id: newCollection.alias }
+  }
+}

tests/e2e-integration/shared/datasets/DatasetHelper.ts

@@ -16,8 +16,12 @@ export interface DatasetFileResponse {
 }
 
 export class DatasetHelper extends DataverseApiHelper {
-  static async create(): Promise<DatasetResponse> {
-    return this.request<DatasetResponse>(`/dataverses/root/datasets`, 'POST', newDatasetData)
+  static async create(collectionId = 'root'): Promise<DatasetResponse> {
+    return this.request<DatasetResponse>(
+      `/dataverses/${collectionId}/datasets`,
+      'POST',
+      newDatasetData
+    )
   }
 
   static async createWithTitle(title: string): Promise<DatasetResponse> {