Search: Counts endpoint respond with 408 for query timeouts
requested to merge 334961-search-counts-endpoint-instead-of-responding-with-500-respond-with-408-request-timeout into master
What does this MR do?
Related to #334961 (closed)
Detect and respond to the search/count
endpoint with a 408 Request Timeout response code and empty JSON response if an ActiveRecord::QueryTimeout occurs.
Screenshots or Screencasts (strongly suggested)
When timeouts occur the counts will not load as shown below
How to test
I've provided a small patch that will force the search count queries to timeout.
- Download the patch force_count_timeout.txt
- Fetch and checkout this branch
git fetch origin 334961-search-counts-endpoint-instead-of-responding-with-500-respond-with-408-request-timeout
&git checkout 334961-search-counts-endpoint-instead-of-responding-with-500-respond-with-408-request-timeout
- 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 - All of the count tab calls should timeout, but if it doesn't try a few more times/changing tabs/etc.
- You can verify the timeouts using the developer tools or the
development.log
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
Edited by Terri Chu