kotovalexarian-likes-gitlab
/
gitlab-org--gitlab-foss
1
0
Fork 0
Code Releases Activity
gitlab-org--gitlab-foss/lib/gitlab/markdown_cache.rb

17 lines
555 B
Ruby
Raw Normal View History

Use Redis for CacheMarkDownField on non AR models This allows using `CacheMarkdownField` for models that are not backed by ActiveRecord. When the including class inherits `ActiveRecord::Base` we include `Gitlab::MarkdownCache::ActiveRecord::Extension`. This will cause the markdown fields to be rendered and the generated HTML stored in a `<field>_html` attribute on the record. We also store the version used for generating the markdown. All other classes that include this model will include the `Gitlab::MarkdownCache::Redis::Extension`. This add the `<field>_html` attributes to that model and will generate the html in them. The generated HTML will be cached in redis under the key `markdown_cache:<class>:<id>`. The class this included in must therefore respond to `id`.
2019-06-05 04:59:48 +00:00
# frozen_string_literal: true
module Gitlab
module MarkdownCache
Add latest changes from gitlab-org/gitlab@master
2021-05-12 12:10:24 +00:00
# Increment this number every time the renderer changes its output.
# Changing this value puts strain on the database, as every row with
# cached markdown needs to be updated. As a result, this line should
# not be changed.
# See: https://gitlab.com/gitlab-org/gitlab/-/issues/330313
Add latest changes from gitlab-org/gitlab@master
2021-05-05 03:10:18 +00:00
CACHE_COMMONMARK_VERSION = 28
Use Redis for CacheMarkDownField on non AR models This allows using `CacheMarkdownField` for models that are not backed by ActiveRecord. When the including class inherits `ActiveRecord::Base` we include `Gitlab::MarkdownCache::ActiveRecord::Extension`. This will cause the markdown fields to be rendered and the generated HTML stored in a `<field>_html` attribute on the record. We also store the version used for generating the markdown. All other classes that include this model will include the `Gitlab::MarkdownCache::Redis::Extension`. This add the `<field>_html` attributes to that model and will generate the html in them. The generated HTML will be cached in redis under the key `markdown_cache:<class>:<id>`. The class this included in must therefore respond to `id`.
2019-06-05 04:59:48 +00:00
CACHE_COMMONMARK_VERSION_START = 10
BaseError = Class.new(StandardError)
UnsupportedClassError = Class.new(BaseError)
end
end