blob: 13c20d74364160e32b9090aec6736b32dcd906b6 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
|
# Gitlab::SafeRequestStore
A safer abstraction of `RequestStore` that comes with [`request_store` gem](https://github.com/steveklabnik/request_store).
This gem works as a proxy to `RequestStore` allowing you to use the same interface even when the Request Store
is not active. In this case a `NullStore` is being used under the hood providing no-ops when the Request Store
is not active.
## Usage
When request store is active it works the same as `RequestStore`:
```ruby
Gitlab::SafeRequestStore.active? # => true
Gitlab::SafeRequestStore[:test] = 123
Gitlab::SafeRequestStore[:test] # => 123
```
When request store is not active it does nothing:
```ruby
Gitlab::SafeRequestStore.active? # => false
Gitlab::SafeRequestStore[:test] = 123
Gitlab::SafeRequestStore[:test] # => nil
```
You can enforce the request store to temporarily be active using:
```ruby
Gitlab::SafeRequestStore.active? # => false
Gitlab::SafeRequestStore.ensure_request_store do
Gitlab::SafeRequestStore.active? # => true
# do something...
end
Gitlab::SafeRequestStore.active? # => false
```
## Development
Follow the GitLab [gems development guidelines](../../doc/development/gems.md).
|
