Unselecting or selecting a sub-category scrolls back to the top of the list when switching from search to browse mode

[amdomanska]

Introduce stringSearch flag

Please don't delete any sections when completing this PR template; instead enter N/A for checkboxes or sections which are not applicable, unless otherwise stated below
See #2832

Describe the scope/purpose of the PR here in as much detail as you like

Categorisation

This PR...

• has scripts to run
• has migrations to run
• adds new infrastructure
• changes the CI pipeline
• affects the public site
• affects the editorial area
• affects the publisher area
• affects the monitoring

Basic PR Checklist

Instructions for developers:

• For each checklist item, if it is N/A to your PR check the N/A box
• For each item that you have done and confirmed for yourself, check Developer box (including if you have checked the N/A box)

Instructions for reviewers:

• For each checklist item that has been confirmed by the Developer, check the Reviewer box if you agree
• For multiple reviewers, feel free to add your own checkbox with your github username next to it if that helps with review tracking

Code Style

• No deprecated methods are used

  • N/A
  • Developer
  • Reviewer

• No magic strings/numbers - all strings are in constants or messages files

  • N/A
  • Developer
  • Reviewer

• ES queries are wrapped in a Query object rather than inlined in the code

  • N/A
  • Developer
  • Reviewer

• Where possible our common library functions have been used (e.g. dates manipulated via dates)

  • N/A
  • Developer
  • Reviewer

• Cleaned up commented out code, etc

  • N/A
  • Developer
  • Reviewer

• Urls are constructed with url_for not hard-coded

  • N/A
  • Developer
  • Reviewer

Testing

• Unit tests have been added/modified

  • N/A
  • Developer
  • Reviewer

• Functional tests have been added/modified

  • N/A
  • Developer
  • Reviewer

• Code has been run manually in development, and functional tests followed locally

  • N/A
  • Developer
  • Reviewer

• Have CSS/style changes been implemented? If they are of a global scope (e.g. on base HTML elements) have the downstream impacts of the change in other areas of the system been considered?

  • N/A
  • Developer
  • Reviewer

Documentation

• FeatureMap annotations have been added

  • N/A
  • Developer
  • Reviewer

• Documentation updates - if needed - have been identified and prepared for inclusion into main documentation (e.g. added and highlighted/commented as appropriate to this PR)

  • N/A
  • Developer
  • Reviewer

• Core model documentation has been added to if needed: https://docs.google.com/spreadsheets/d/1lun2S9vwGbyfy3WjIjgXBm05D-3wWDZ4bp8xiIYfImM/edit

  • N/A
  • Developer
  • Reviewer

• Events and consumers documentation has been added if needed: https://docs.google.com/spreadsheets/d/1oIeG5vg-blm2MZCE-7YhwulUlSz6TOUeY8jAftdP9JE/edit

  • N/A
  • Developer
  • Reviewer

• The docs for this branch have been generated and pushed to the doc site (see docs/README.md for details)

  • N/A
  • Developer
  • Reviewer

Release Readiness

• If needed, migration has been created and tested locally

  • N/A
  • Developer
  • Reviewer

• Release sheet has been created, and completed as far as is possible https://docs.google.com/spreadsheets/d/1Bqx23J1MwXzjrmAygbqlU3YHxN1Wf7zkkRv14eTVLZQ/edit

  • N/A
  • Developer
  • Reviewer

• There has been a recent merge up from develop (or other base branch). List the dates of the merges up from develop below

  • 23/09/24

Testing

Requirements doc: https://docs.google.com/spreadsheets/d/1T_zIXfmWd7i0MyMbrL8hpg6zczml39-gcejTwDVvWAo/edit?gid=0#gid=0

List the Functional Tests that must be run to confirm this feature

1. Subject Facet

Deployment

What deployment considerations are there? (delete any sections you don't need)

Configuration changes

What configuration changes are included in this PR, and do we need to set specific values for production

Scripts

What scripts need to be run from the PR (e.g. if this is a report generating feature), and when (once, regularly, etc).

Migrations

What migrations need to be run to deploy this

Monitoring

What additional monitoring is required of the application as a result of this feature

New Infrastructure

What new infrastructure does this PR require (e.g. new services that need to run on the back-end).

Continuous Integration

What CI changes are required for this

[RK206]

Tested the functionality. Selection is preserved.
But, I have some observations. Not sure if these are issues to be considered. Listing my observations below.

1. Enter the text in the search and select any category. Now remove the text in the search and the selection of the category is disappeared.
2. Selection of sub category does not auto select the top level category.
3. Similarly deletion of top level category does not delete sub categories
4. Top level and sub level categories displayed separately at selected categories

Adding some screenshots for reference.

[richard-jones]

I can see the issues that @RK206 has raised when I use this too, and they are introducing different behaviours to the existing search, and we need to resolve them. The PR is quite small, so I'm not sure what creates the changes, but I would guess that code which needs to execute to maintain context is not being executed any more.

In addition I found the following issue:

If you select multiple sub categories from different parts of the tree, and then remove one of them from the "selected filters" pill navigation at the top, the scroll position doesn't necessarily make sense. If you remove all of the selections from the pill navigation, the scroll position does not return to the top, which I think it probably should.

I think that this change is actually complex enough that we need to lay out the behaviours first more clearly before we try to reimplement.

[richard-jones]

I've provided feedback in the issue, this needs to go round development again

[richard-jones]

This is much closer but there's still a mismatch to our expectations. See Testing Round 2 in this spreadsheet https://docs.google.com/spreadsheets/d/1T_zIXfmWd7i0MyMbrL8hpg6zczml39-gcejTwDVvWAo/edit#gid=419458697

[amdomanska]

Develop merged into the branch 23/09/24