Add a frontend version tag to Footer.tsx by ekraffmiller · Pull Request #960 · IQSS/dataverse-frontend

ekraffmiller · 2026-04-20T13:48:42Z

What this PR does / why we need it:

Adds a frontend version label to the footer so the SPA shows either the official release version or, for non-release builds, the short commit SHA. The footer still shows the Dataverse backend version as before; this PR adds the SPA version alongside it. The display logic prefers the package version when the build is on an exact matching release tag and otherwise falls back to the commit hash.

Which issue(s) this PR closes:

Closes Feature Request/Idea: Show the version of the SPA #959

Special notes for your reviewer:

To force the footer to update and show the version, disable the local cache in your browser

Suggestions on how to test this:

build the App and review the footer display. Is the right wording?

Does this PR introduce a user interface change? If mockups are available, please link/include them here:

Is there a release notes or changelog update needed for this change?:

Additional documentation:

Copilot

Pull request overview

This PR adds a visible SPA (frontend) version string to the application footer to help users report bugs with precise build context, aligning with issue #959.

Changes:

Inject build/version metadata (package version, commit SHA, tag/ref) into the SPA at build time via Vite define.
Add SPA version resolution helpers (resolveSpaVersionDisplay, spaVersion) plus unit tests.
Render the SPA version in Footer and add corresponding i18n strings and layout styling; update dev-env Vite configs to also define version metadata.

Reviewed changes

Copilot reviewed 11 out of 12 changed files in this pull request and generated 6 comments.

Show a summary per file

File	Description
`vite.config.ts`	Computes version metadata from package/git/GitHub env and injects it via `define`.
`src/version/resolveSpaVersionDisplay.ts`	New helper to choose displayed version (release version vs commit SHA).
`src/version/spaVersion.ts`	Central exported SPA version string based on injected build metadata.
`src/vite-env.d.ts`	Adds TypeScript typings for the new `import.meta.env` keys.
`src/sections/layout/footer/Footer.tsx`	Displays the SPA version in the footer using i18n.
`src/sections/layout/footer/Footer.module.scss`	Adjusts footer layout to accommodate SPA + Dataverse version rows.
`public/locales/en/footer.json`	Adds `spaVersion` translation.
`public/locales/es/footer.json`	Adds `spaVersion` translation (currently English text).
`tests/component/version/resolveSpaVersionDisplay.spec.ts`	Adds unit tests for version display selection logic.
`tests/component/sections/layout/footer/Footer.spec.tsx`	Updates footer test expectations to include SPA version (currently mismatched).
`dev-env/vite.config.ts`	Adds version metadata injection for dev env, plus `root`/alias adjustments.
`dev-env/shib-dev-env/vite.config.ts`	Adds version metadata injection for shib dev env, plus `root`/alias adjustments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-04-20T13:53:42Z

+  const projectRoot = candidates.find((candidate) => {
+    return Boolean(readTextFile(path.join(candidate, 'package.json'))) && Boolean(readTextFile(path.join(candidate, '.git')))
+  })


resolveProjectRoot tries to detect the repo root by calling readTextFile(..., '.git'). In a normal clone .git is a directory, so readFileSync throws and readTextFile returns undefined, causing the root detection to fail and projectRoot to incorrectly fall back to configDir. Use an existence check that works for directories (e.g., existsSync / statSync) or rework the condition to treat a .git directory as present.

Copilot · 2026-04-20T13:53:42Z

+  const projectRoot = candidates.find((candidate) => {
+    return Boolean(readTextFile(path.join(candidate, 'package.json'))) && Boolean(readTextFile(path.join(candidate, '.git')))
+  })


resolveProjectRoot uses readTextFile to check for .git, but .git is typically a directory. This makes the project root detection fail and can break root/alias resolution. Switch to an existence check that supports directories (e.g., existsSync / statSync) or otherwise handle .git directories explicitly.

Copilot · 2026-04-20T13:53:43Z

+function resolveSpaVersionDisplay({
+  packageVersion,
+  commitSha,
+  exactTag,
+  refName,
+  refType


The resolveSpaVersionDisplay logic is duplicated here even though an equivalent helper now exists in src/version/resolveSpaVersionDisplay.ts (and is imported by the root vite.config.ts). Consider importing the shared helper instead of maintaining another copy to avoid drift between dev-env and production version formatting.

Copilot · 2026-04-20T13:53:43Z

+function resolveSpaVersionDisplay({
+  packageVersion,
+  commitSha,
+  exactTag,
+  refName,
+  refType


This config duplicates resolveSpaVersionDisplay even though the same logic exists in src/version/resolveSpaVersionDisplay.ts. Importing the shared helper would reduce duplication and prevent dev-env version display from diverging from production builds.

Copilot · 2026-04-20T13:53:43Z

    cy.findByText('Privacy Policy').should('exist')
    cy.findByAltText('The Dataverse Project logo').should('exist')
    cy.findByText(testVersion).should('exist')
+    cy.findByText(`SPA: ${spaVersion}`).should('exist')


The footer now renders the SPA version via the i18n string t('spaVersion', { version: spaVersion }), but this test asserts a hard-coded SPA: ${spaVersion} string. This will fail with the current footer.json values (e.g. "frontend version: {{version}}"). Update the assertion to match the translated output (or assert on the spaVersion key’s resolved text).

Suggested change

cy.findByText(`SPA: ${spaVersion}`).should('exist')

cy.findByText(spaVersion).should('exist')

add spanish translation Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

coveralls · 2026-04-20T14:21:04Z

coverage: 97.515% (-0.06%) from 97.57% — 959-display-version into develop

…se-frontend into 959-display-version

ChengShi-1

Looks good

ChengShi-1

Looks good with new banner

add a frontend version tag to Footer.tsx

9009323

ekraffmiller requested a review from Copilot April 20, 2026 13:49

Copilot started reviewing on behalf of ekraffmiller April 20, 2026 13:49 View session

Copilot AI reviewed Apr 20, 2026

View reviewed changes

ekraffmiller and others added 2 commits April 20, 2026 09:58

Update public/locales/es/footer.json

89291ac

add spanish translation Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

fix unit test

c35fb6d

ekraffmiller added 4 commits April 20, 2026 15:24

Merge branch '959-display-version' of https://github.com/IQSS/dataver…

28e9330

…se-frontend into 959-display-version

fix the Cypress/dev Vite config

7608a93

centralize the logic for determining the display version

e7b1c33

add item to CHANGELOG.md

80b42df

ekraffmiller added this to IQSS Dataverse Project Apr 21, 2026

ekraffmiller marked this pull request as ready for review April 21, 2026 17:38

ekraffmiller moved this to Ready for Review ⏩ in IQSS Dataverse Project Apr 21, 2026

ekraffmiller added GREI Re-arch GREI re-architecture-related FY26 Sprint 21 FY26 Sprint 21 (2026-04-08 - 2026-04-22) labels Apr 21, 2026

ChengShi-1 self-assigned this Apr 22, 2026

ChengShi-1 self-requested a review April 22, 2026 14:51

ChengShi-1 approved these changes Apr 22, 2026

View reviewed changes

github-project-automation Bot moved this from Ready for Review ⏩ to Ready for QA ⏩ in IQSS Dataverse Project Apr 22, 2026

ekraffmiller added the Project: HDV SPA Rollout label Apr 22, 2026

cmbz added the FY26 Sprint 22 FY26 Sprint 22 (2026-04-22 - 2026-05-06) label Apr 22, 2026

ChengShi-1 removed their assignment Apr 23, 2026

ekraffmiller added 2 commits April 23, 2026 05:44

add configurable banner message

32f63fc

add test for banner message

7b4a63c

ChengShi-1 approved these changes Apr 23, 2026

View reviewed changes

ekraffmiller added 2 commits April 23, 2026 09:47

add changelog item for banner message

d4f7ab7

resolve merge conflicts

3fbb446

jp-tosca self-assigned this Apr 23, 2026

jp-tosca merged commit 3895667 into develop Apr 24, 2026
16 of 22 checks passed

github-project-automation Bot moved this from Ready for QA ⏩ to Merged 🚀 in IQSS Dataverse Project Apr 24, 2026

jp-tosca removed their assignment Apr 24, 2026

scolapasta moved this from Merged 🚀 to Done 🧹 in IQSS Dataverse Project Apr 28, 2026

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add a frontend version tag to Footer.tsx#960

Add a frontend version tag to Footer.tsx#960
jp-tosca merged 11 commits intodevelopfrom
959-display-version

ekraffmiller commented Apr 20, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Copilot AI Apr 20, 2026

Uh oh!

Copilot AI Apr 20, 2026

Uh oh!

Copilot AI Apr 20, 2026

Uh oh!

Copilot AI Apr 20, 2026

Uh oh!

Copilot AI Apr 20, 2026

Uh oh!

coveralls commented Apr 20, 2026 •

edited

Loading

Uh oh!

ChengShi-1 left a comment

Uh oh!

ChengShi-1 left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

	cy.findByText(`SPA: ${spaVersion}`).should('exist')
	cy.findByText(spaVersion).should('exist')

Conversation

ekraffmiller commented Apr 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What this PR does / why we need it:

Which issue(s) this PR closes:

Special notes for your reviewer:

Suggestions on how to test this:

Does this PR introduce a user interface change? If mockups are available, please link/include them here:

Is there a release notes or changelog update needed for this change?:

Additional documentation:

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Copilot AI Apr 20, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 20, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 20, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 20, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 20, 2026

Choose a reason for hiding this comment

Uh oh!

coveralls commented Apr 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ChengShi-1 left a comment

Choose a reason for hiding this comment

Uh oh!

ChengShi-1 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

ekraffmiller commented Apr 20, 2026 •

edited

Loading

coveralls commented Apr 20, 2026 •

edited

Loading