Skip to content

Add technical hint to avoid redirect loops #12

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
rudibatt wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Add technical hint to avoid redirect loops #12

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
b592ba0
Add technical hint to avoid redirect loops
rudibatt May 12, 2026
56616ed
Add example to redirect hint + duplicate to separate story
rudibatt May 12, 2026
b9f8522
Refine once more
rudibatt May 12, 2026
f2465d6
Change defined behaviour for redirected URL
rudibatt May 13, 2026
7424ec2
Fix strange sentence
rudibatt May 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions docs/smartquery/user-stories.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,14 @@ Acceptance criteria
- internal systems can access https://query.searchhub.io/ to perform the search phrase check
- internal systems can access https://import.searchhub.io/ to send and receive data updates

Technical hint
- It is possible that search managers create redirects to filtered search result pages of that same query, for example "running shoes" are redirected to ``..?q=running+shoes&cat=Sports/Running``.
The problem is that without a "safety switch," the system might receive a redirect-URL from smartQuery and try to redirect the user all over again, creating an infinite loop.
To prevent this, all redirects should generally be flagged as "redirected" and handled again by smartQuery.
Example:
- Set the Redirect Flag: When a search query is mapped to a redirect, that URL must explicitly be flagged: For example by appending ``&redirected=true`` or ``&sh=0`` to the request URL.
- System Behavior: At your smartQuery integration this flag must be used to skip the usage of smartQuery.


smartQuery Query Testing Support
--------------------------------
Expand Down Expand Up @@ -71,12 +79,22 @@ Technical Guidance
searchHub Redirects
-------------------

*This story is actually included in the standard smartQuery integration. However it can be used to split the integration into separate steps.*

Story
As a search manager, I want users to be redirected to specific landing pages for certain queries based on the configurations set within searchHub.

Acceptance criteria
- When a query is configured for a redirect, users should be directed to the corresponding landing page or URL.

Technical hint
- It is possible that search managers create redirects to filtered search result pages of that same query, for example "running shoes" are redirected to ``..?q=running+shoes&cat=Sports/Running``.
The problem is that without a "safety switch," the system might receive a redirect-URL from smartQuery and try to redirect the user all over again, creating an infinite loop.
To prevent this, all redirects should generally be flagged as "redirected" and handled again by smartQuery.
Example:
- Set the Redirect Flag: When a search query is mapped to a redirect, that URL must explicitly be flagged: For example by appending ``&redirected=true`` or ``&sh=0`` to the request URL.
- System Behavior: At your smartQuery integration this flag must be used to skip the usage of smartQuery.


Allow Static IP Address for Redirect URL Monitoring
---------------------------------------------------
Expand Down