Global Search - Timeout Page
What does this MR do?
Closes #300203 (closed)
This change rescues the query timeout that sometimes occurs are broad/massive searches done on the Global Search page. Currently when this happens the fallback 500 page is rendered which is confusing to users.
Instead we rescue the response and render the view with the @timeout
variable. This in turn renders the the search page with a timeout message. This allows users to both refine their current search as well as understand what went wrong instead of just being hit with a blanket 500.
How to test
Getting your GDK to timeout by itself will be a great challenge. Instead I have provided a small patch that will force the search queries to timeout almost every time.
- Download the patch force_timeout.txt
- Fetch and checkout this branch
git fetch origin 300203-global-search-timeout-page
&git checkout 300203-global-search-timeout-page
- Copy the entire file contents from the patch you downloaded in step 1
- Run the command
pbpaste | git apply
from your/gitlab
directory - This should add some local code changes - Navigate to Global Search
http://127.0.0.1:3000/search
and search something - It should timeout, but if it doesn't try a few more times/changing tabs/etc.
Screenshots (strongly suggested)
w/o promotion | w/ promotion | |
---|---|---|
Timeout w/ Sidebar | ||
Timeout w/o Sidebar | ||
Results w/ Sidebar (No Change) | ||
Results w/o Sidebar (No Change) |
Does this MR meet the acceptance criteria?
Conformity
-
I have included changelog trailers, or none are needed. (Does this MR need a changelog?) -
I have added/updated documentation, or it's not needed. (Is documentation required?) -
I have properly separated EE content from FOSS, or this MR is FOSS only. (Where should EE code go?) -
I have added information for database reviewers in the MR description, or it's not needed. (Does this MR have database related changes?) -
I have self-reviewed this MR per code review guidelines. -
This MR does not harm performance, or I have asked a reviewer to help assess the performance impact. (Merge request performance guidelines) -
I have followed the style guides. -
This change is backwards compatible across updates, or this does not apply.
Availability and Testing
-
I have added/updated tests following the Testing Guide, or it's not needed. (Consider all test levels. See the Test Planning Process.) -
I have tested this MR in all supported browsers, or it's not needed. -
I have informed the Infrastructure department of a default or new setting change per definition of done, or it's not needed.
Security
Does this MR contain changes to processing or storing of credentials or tokens, authorization and authentication methods or other items described in the security review guidelines? If not, then delete this Security section.
- [-] Label as security and @ mention
@gitlab-com/gl-security/appsec
- [-] The MR includes necessary changes to maintain consistency between UI, API, email, or other methods
- [-] Security reports checked/validated by a reviewer from the AppSec team
Related to #300203 (closed)