diff options
author | Thong Kuah <tkuah@gitlab.com> | 2019-08-18 08:57:24 +0000 |
---|---|---|
committer | Thong Kuah <tkuah@gitlab.com> | 2019-08-18 08:57:24 +0000 |
commit | af19f8ca1f09007d6dbdef94536bae702686f737 (patch) | |
tree | 3dfa04bf4a8ea6715c7907fcbd2ab4ea7c50046a | |
parent | 1068483f7260e5866c7d54f1f09b716dbf463c80 (diff) | |
download | gitlab-ce-docs-testing-n-1-request-sepcs.tar.gz |
Require request specs when testing N+1 for controllersdocs-testing-n-1-request-sepcs
-rw-r--r-- | doc/development/query_recorder.md | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/doc/development/query_recorder.md b/doc/development/query_recorder.md index a6b60149ea4..4fbf289b596 100644 --- a/doc/development/query_recorder.md +++ b/doc/development/query_recorder.md @@ -36,6 +36,13 @@ it "avoids N+1 database queries" do end ``` +## Use request specs instead of controller specs + +Use a [request spec](https://relishapp.com/rspec/rspec-rails/v/3-8/docs/request-specs/request-spec) when writing a N+1 test on the controller level. + +Controller specs should not be used to write N+1 tests as the controller is only initialized once per example. +This could lead to false successes where subsequent "requests" could have queries reduced (e.g. because of memoization). + ## Finding the source of the query It may be useful to identify the source of the queries by looking at the call backtrace. |