Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
G
gitlab-ce
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
Léo-Paul Géneau
gitlab-ce
Commits
d5c7fe29
Commit
d5c7fe29
authored
Jun 21, 2018
by
Lin Jen-Shin
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Add docs for RequestCache, moved from comments
parent
14e35ac9
Changes
2
Show whitespace changes
Inline
Side-by-side
Showing
2 changed files
with
42 additions
and
36 deletions
+42
-36
doc/development/utilities.md
doc/development/utilities.md
+41
-0
lib/gitlab/cache/request_cache.rb
lib/gitlab/cache/request_cache.rb
+1
-36
No files found.
doc/development/utilities.md
View file @
d5c7fe29
...
@@ -135,3 +135,44 @@ We developed a number of utilities to ease development.
...
@@ -135,3 +135,44 @@ We developed a number of utilities to ease development.
Find.new.clear_memoization(:result)
Find.new.clear_memoization(:result)
```
```
## [`RequestCache`](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/lib/gitlab/cache/request_cache.rb)
This module provides a simple way to cache values in RequestStore,
and the cache key would be based on the class name, method name,
optionally customized instance level values, optionally customized
method level values, and optional method arguments.
A simple example that only uses the instance level customised values:
```
ruby
class
UserAccess
extend
Gitlab
::
Cache
::
RequestCache
request_cache_key
do
[
user
&
.
id
,
project
&
.
id
]
end
request_cache
def
can_push_to_branch?
(
ref
)
# ...
end
end
```
This way, the result of
`can_push_to_branch?`
would be cached in
`RequestStore.store`
based on the cache key. If
`RequestStore`
is not
currently active, then it would be stored in a hash saved in an
instance variable, so the cache logic would be the same.
We can also set different strategies for different methods:
```
ruby
class
Commit
extend
Gitlab
::
Cache
::
RequestCache
def
author
User
.
find_by_any_email
(
author_email
.
downcase
)
end
request_cache
(
:author
)
{
author_email
.
downcase
}
end
```
lib/gitlab/cache/request_cache.rb
View file @
d5c7fe29
module
Gitlab
module
Gitlab
module
Cache
module
Cache
# This module provides a simple way to cache values in RequestStore,
# See https://docs.gitlab.com/ee/development/utilities.html#requestcache
# and the cache key would be based on the class name, method name,
# optionally customized instance level values, optionally customized
# method level values, and optional method arguments.
#
# A simple example:
#
# class UserAccess
# extend Gitlab::Cache::RequestCache
#
# request_cache_key do
# [user&.id, project&.id]
# end
#
# request_cache def can_push_to_branch?(ref)
# # ...
# end
# end
#
# This way, the result of `can_push_to_branch?` would be cached in
# `RequestStore.store` based on the cache key. If RequestStore is not
# currently active, then it would be stored in a hash saved in an
# instance variable, so the cache logic would be the same.
# Here's another example using customized method level values:
#
# class Commit
# extend Gitlab::Cache::RequestCache
#
# def author
# User.find_by_any_email(author_email.downcase)
# end
# request_cache(:author) { author_email.downcase }
# end
#
# So that we could have different strategies for different methods
#
module
RequestCache
module
RequestCache
def
self
.
extended
(
klass
)
def
self
.
extended
(
klass
)
return
if
klass
<
self
return
if
klass
<
self
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment