Skip to content

fix(i18n): add lowercase keys for selected search facets (#5048)#5052

Draft
JohnnyMendesC wants to merge 1 commit intoDSpace:mainfrom
JohnnyMendesC:fix/5048-search-facet-translation-fails-due-to-case-sensitivity-mismatch
Draft

fix(i18n): add lowercase keys for selected search facets (#5048)#5052
JohnnyMendesC wants to merge 1 commit intoDSpace:mainfrom
JohnnyMendesC:fix/5048-search-facet-translation-fails-due-to-case-sensitivity-mismatch

Conversation

@JohnnyMendesC
Copy link

References

Description

This PR fixes a bug where selected search facets (e.g., "Workspace", "Workflow", "Archived") displayed raw, untranslated values due to a case sensitivity mismatch between URL parameters (lowercase) and i18n keys (TitleCase). It adds the necessary lowercase translation keys to en.json5 and pt-BR.json5 to ensure correct display without introducing regressions in other filter types.

Instructions for Reviewers

Context and Analysis:
The issue stems from the fact that DSpace uses different casing for the same concept depending on the context:

  1. Unselected Facets (Sidebar): Values come from Solr/Discovery in TitleCase (e.g., "Workspace"). These rely on the existing TitleCase i18n keys.
  2. Selected Facets (Breadcrumbs/Filter tags): Values come directly from the URL parameter, which uses the internal ID in lowercase (e.g., f.namedresourcetype=workspace or item).

Why this approach?
I investigated fixing this via a code change (capitalizing the selected value in search-facet-selected-option.component.ts), but this caused regressions:

  • Boolean filters broke: Filters like "Withdrawn" use true/false in the URL. Capitalizing them to True broke the lookup against existing lowercase keys (search.filters.withdrawn.true), displaying raw "true" instead of "Yes".
  • Compound IDs broke: Filters like Access Type (open.access) were incorrectly capitalized to Open.access, displaying raw "open.access" instead of "Open Access".

Renaming the existing TitleCase keys to lowercase was also ruled out, as it breaks the translation of the unselected sidebar list returned by Solr.

Solution:
The safest and most robust solution implemented here is to add the lowercase variants of the keys to the translation files. This supports the URL parameters while keeping the existing keys for Solr responses.

List of changes in this PR:

  • Added lowercase translation keys for workflow, workspace, and item (mapped to "Archived") in src/assets/i18n/en.json5.
  • Added the corresponding Portuguese translations in src/assets/i18n/pt-BR.json5.

How to test:

  1. Log in as an Administrator.
  2. Navigate to /admin/workflow or /admin/search.
  3. Filter by Status > Workspace (or "Área de trabalho").
    • Verify: The selected filter label should read "Workspace" (or translated equivalent like "Área de trabalho"), NOT "workspace".
  4. Filter by Status > Archived (if available in MyDSpace or Admin Search).
    • Verify: The selected filter label should read "Archived", NOT "item".
  5. Regression Test: Apply a boolean filter (e.g., Withdrawn > No or Non-discoverable > No).
    • Verify: The label should correctly display "No" (or "Não"), NOT "false".

Checklist

This checklist provides a reminder of what we are going to look for when reviewing your PR. You do not need to complete this checklist prior creating your PR (draft PRs are always welcome).
However, reviewers may request that you complete any actions in this list if you have not done so. If you are unsure about an item in the checklist, don't hesitate to ask. We're here to help!

  • My PR is created against the main branch of code (unless it is a backport or is fixing an issue specific to an older branch).
  • My PR is small in size (e.g. less than 1,000 lines of code, not including comments & specs/tests), or I have provided reasons as to why that's not possible.
  • My PR passes ESLint validation using npm run lint
  • My PR doesn't introduce circular dependencies (verified via npm run check-circ-deps)
  • My PR includes TypeDoc comments for all new (or modified) public methods and classes. It also includes TypeDoc for large or complex private methods.
  • My PR passes all specs/tests and includes new/updated specs or tests based on the Code Testing Guide.
  • My PR aligns with Accessibility guidelines if it makes changes to the user interface.
  • My PR uses i18n (internationalization) keys instead of hardcoded English text, to allow for translations.
  • My PR includes details on how to test it. I've provided clear instructions to reviewers on how to successfully test this fix or feature.
  • If my PR includes new libraries/dependencies (in package.json), I've made sure their licenses align with the DSpace BSD License based on the Licensing of Contributions documentation.
  • If my PR includes new features or configurations, I've provided basic technical documentation in the PR itself.
  • If my PR fixes an issue ticket, I've linked them together.

@JohnnyMendesC JohnnyMendesC marked this pull request as draft January 28, 2026 21:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Workflow search facet translation fails when selected due to case sensitivity mismatch

1 participant