Skip to content

Fix #6054: Hide fixed filter queries from search labels component - #6089

Open
guillermo-escire wants to merge 8 commits into
DSpace:mainfrom
guillermo-escire:feature/6054
Open

Fix #6054: Hide fixed filter queries from search labels component#6089
guillermo-escire wants to merge 8 commits into
DSpace:mainfrom
guillermo-escire:feature/6054

Conversation

@guillermo-escire

Copy link
Copy Markdown
Contributor

References

Fixes #6054

Description

Fixed filter queries were being displayed as visible broken badges in the search UI since DSpace v9, even though they are meant to be invisible to the user

Instructions for Reviewers

List of changes in this PR:

  • Added fixedFilterQuery @input to SearchLabelsComponent
  • Added visibleFilters$ getter that filters out applied filters matching the fixedFilterQuery
  • Updated search-labels.component.html to use visibleFilters$ instead of appliedFilters$
  • Updated search.component.html to pass fixedFilterQuery to ds-search-labels

How to test:

  1. Navigate to a Person entity page that has a search component (e.g. /entities/person/<UUID>)
  2. Scroll down to the publications search section
  3. Verify the broken badge Search.Filters.Applied.F.IsAuthorOfPublication: <UUID> no longer appears
  4. Verify that normal applied filters (added by the user) still display correctly as badges

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 follows all coding best practices based on the Code Conventions Guide
  • 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.

@alexandrevryghem alexandrevryghem left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@guillermo-escire: I haven't tested this functionality yet, but this code recreates the observable during every change detection cycle, which is bad for performance. Could you address my feedback in the comments below?

@@ -41,4 +47,20 @@ export class SearchLabelsComponent implements OnInit {
this.appliedFilters$ = this.searchService.appliedFilters$;
}

get visibleFilters$() {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please rewrite this to:

  1. Save the fixedFilterQuery in a BehaviourSubject (fixedFilterQuery$) in ngOnChanges
  2. Remove the visibleFilters$() getter
  3. Create a new visibleFilters() method that uses a combineLatest on both the this.searchService.appliedFilters$ & the fixedFilterQuery$ you created in step one. In the pipe of this combineLatest you can then use the map you created in your old visibleFilters$() getter (I assume that this works properly)

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @alexandrevryghem!

Done! I've refactored the component as suggested:

  • Added fixedFilterQuery$ as a BehaviorSubject updated in ngOnChanges
  • Removed the getter and replaced it with a visibleFilters$ Observable

initialized in ngOnInit using combineLatest

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@guillermo-escire: Thnx this looks much better now could you also add some inline docs explaining the purpose of the fixedFilterQuery$ & visibleFilters$

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @alexandrevryghem , I've added inline docs for both fixedFilterQuery$ and visibleFilters$ explaining their purpose.

Comment thread src/app/shared/search/search-labels/search-labels.component.html
@lgeggleston lgeggleston added bug component: Item (Archived) Item display or editing ux User Experience related works port to dspace-9_x This PR needs to be ported to `dspace-9_x` branch for next bug-fix release port to dspace-10_x This PR needs to be ported to `dspace-10_x` branch for next bug-fix release labels Aug 11, 2026
@lgeggleston lgeggleston moved this to 🙋 Needs Reviewers Assigned in DSpace 11.0 Release Aug 11, 2026
@github-project-automation github-project-automation Bot moved this from 🙋 Needs Reviewers Assigned to 👀 Under Review in DSpace 11.0 Release Aug 11, 2026
@lgeggleston lgeggleston moved this from 👀 Under Review to 🙋 Needs Reviewers Assigned in DSpace 11.0 Release Aug 11, 2026
@lgeggleston lgeggleston moved this from 🙋 Needs Reviewers Assigned to 👀 Under Review in DSpace 11.0 Release Aug 11, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug component: Item (Archived) Item display or editing port to dspace-9_x This PR needs to be ported to `dspace-9_x` branch for next bug-fix release port to dspace-10_x This PR needs to be ported to `dspace-10_x` branch for next bug-fix release ux User Experience related works

Projects

Status: 👀 Under Review

Development

Successfully merging this pull request may close these issues.

Fixed filter queries displayed as broken badges on search component

4 participants