debian-mirror-gitlab/spec/models/concerns/cache_markdown_field_spec.rb

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

453 lines
14 KiB
Ruby
Raw Permalink Normal View History

2019-07-07 11:18:12 +05:30
# frozen_string_literal: true
2016-11-03 12:29:30 +05:30
require 'spec_helper'
2020-07-28 23:09:34 +05:30
RSpec.describe CacheMarkdownField, :clean_gitlab_redis_cache do
2019-09-04 21:01:54 +05:30
let(:ar_class) do
Class.new(ActiveRecord::Base) do
self.table_name = 'issues'
include CacheMarkdownField
cache_markdown_field :title, pipeline: :single_line
cache_markdown_field :description
2022-08-13 15:12:31 +05:30
before_validation -> { self.work_item_type_id = ::WorkItems::Type.default_issue_type.id }
2016-11-03 12:29:30 +05:30
end
2019-09-04 21:01:54 +05:30
end
2016-11-03 12:29:30 +05:30
2019-09-04 21:01:54 +05:30
let(:other_class) do
Class.new do
include CacheMarkdownField
2016-11-03 12:29:30 +05:30
2019-09-04 21:01:54 +05:30
def initialize(args = {})
2021-04-29 21:17:54 +05:30
@title = args[:title]
@description = args[:description]
@cached_markdown_version = args[:cached_markdown_version]
@title_html = args[:title_html]
@description_html = args[:description_html]
@author = args[:author]
@project = args[:project]
2020-10-24 23:57:45 +05:30
@parent_user = args[:parent_user]
2016-11-03 12:29:30 +05:30
end
2019-09-04 21:01:54 +05:30
attr_accessor :title, :description, :cached_markdown_version
2017-08-17 22:00:37 +05:30
2019-09-04 21:01:54 +05:30
cache_markdown_field :title, pipeline: :single_line
cache_markdown_field :description
2017-08-17 22:00:37 +05:30
2019-09-04 21:01:54 +05:30
def cache_key
"cache-key"
2016-11-03 12:29:30 +05:30
end
end
end
2017-08-17 22:00:37 +05:30
let(:markdown) { '`Foo`' }
2019-09-04 21:01:54 +05:30
let(:html) { '<p data-sourcepos="1:1-1:5" dir="auto"><code>Foo</code></p>' }
2016-11-03 12:29:30 +05:30
2017-08-17 22:00:37 +05:30
let(:updated_markdown) { '`Bar`' }
2019-09-04 21:01:54 +05:30
let(:updated_html) { '<p data-sourcepos="1:1-1:5" dir="auto"><code>Bar</code></p>' }
2016-11-03 12:29:30 +05:30
2019-09-04 21:01:54 +05:30
let(:cache_version) { Gitlab::MarkdownCache::CACHE_COMMONMARK_VERSION << 16 }
2017-08-17 22:00:37 +05:30
2020-10-24 23:57:45 +05:30
def thing_subclass(klass, *extra_attributes)
Class.new(klass) { attr_accessor(*extra_attributes) }
2016-11-03 12:29:30 +05:30
end
2019-09-04 21:01:54 +05:30
shared_examples 'a class with cached markdown fields' do
describe '#cached_html_up_to_date?' do
let(:thing) { klass.new(title: markdown, title_html: html, cached_markdown_version: cache_version) }
2018-10-15 14:42:47 +05:30
2019-09-04 21:01:54 +05:30
subject { thing.cached_html_up_to_date?(:title) }
2016-11-03 12:29:30 +05:30
2019-09-04 21:01:54 +05:30
it 'returns false when the version is absent' do
thing.cached_markdown_version = nil
2016-11-03 12:29:30 +05:30
2019-09-04 21:01:54 +05:30
is_expected.to be_falsy
end
2017-08-17 22:00:37 +05:30
2019-09-04 21:01:54 +05:30
it 'returns false when the version is too early' do
thing.cached_markdown_version -= 1
2017-08-17 22:00:37 +05:30
2019-09-04 21:01:54 +05:30
is_expected.to be_falsy
end
2018-10-15 14:42:47 +05:30
2019-09-04 21:01:54 +05:30
it 'returns false when the version is too late' do
thing.cached_markdown_version += 1
2017-08-17 22:00:37 +05:30
2019-09-04 21:01:54 +05:30
is_expected.to be_falsy
end
2018-10-15 14:42:47 +05:30
2019-09-04 21:01:54 +05:30
it 'returns false when the local version was bumped' do
2021-09-30 23:02:18 +05:30
stub_application_setting(local_markdown_version: 2)
2019-09-04 21:01:54 +05:30
thing.cached_markdown_version = cache_version
2018-10-15 14:42:47 +05:30
2019-09-04 21:01:54 +05:30
is_expected.to be_falsy
end
2018-10-15 14:42:47 +05:30
2019-09-04 21:01:54 +05:30
it 'returns true when the local version is default' do
thing.cached_markdown_version = cache_version
2018-10-15 14:42:47 +05:30
2019-09-04 21:01:54 +05:30
is_expected.to be_truthy
end
2017-08-17 22:00:37 +05:30
2019-09-04 21:01:54 +05:30
it 'returns true when the cached version is just right' do
2021-09-30 23:02:18 +05:30
stub_application_setting(local_markdown_version: 2)
2019-09-04 21:01:54 +05:30
thing.cached_markdown_version = cache_version + 2
2017-08-17 22:00:37 +05:30
2019-09-04 21:01:54 +05:30
is_expected.to be_truthy
end
2017-08-17 22:00:37 +05:30
end
2019-09-04 21:01:54 +05:30
describe '#latest_cached_markdown_version' do
let(:thing) { klass.new }
2020-03-13 15:44:24 +05:30
2019-09-04 21:01:54 +05:30
subject { thing.latest_cached_markdown_version }
2019-03-02 22:35:43 +05:30
2019-09-04 21:01:54 +05:30
it 'returns default version' do
thing.cached_markdown_version = nil
is_expected.to eq(cache_version)
end
2018-10-15 14:42:47 +05:30
end
2019-03-02 22:35:43 +05:30
2019-09-04 21:01:54 +05:30
describe '#refresh_markdown_cache' do
let(:thing) { klass.new(description: markdown, description_html: html, cached_markdown_version: cache_version) }
2017-08-17 22:00:37 +05:30
2019-09-04 21:01:54 +05:30
before do
thing.description = updated_markdown
end
2017-08-17 22:00:37 +05:30
2019-09-04 21:01:54 +05:30
it 'fills all html fields' do
thing.refresh_markdown_cache
2017-08-17 22:00:37 +05:30
2019-09-04 21:01:54 +05:30
expect(thing.description_html).to eq(updated_html)
end
2017-08-17 22:00:37 +05:30
2019-09-04 21:01:54 +05:30
it 'does not save the result' do
expect(thing).not_to receive(:save_markdown)
2017-08-17 22:00:37 +05:30
2019-09-04 21:01:54 +05:30
thing.refresh_markdown_cache
end
2017-08-17 22:00:37 +05:30
2019-09-04 21:01:54 +05:30
it 'updates the markdown cache version' do
thing.cached_markdown_version = nil
thing.refresh_markdown_cache
2017-08-17 22:00:37 +05:30
2019-09-04 21:01:54 +05:30
expect(thing.cached_markdown_version).to eq(cache_version)
end
2018-03-17 18:26:18 +05:30
end
2017-08-17 22:00:37 +05:30
2019-09-04 21:01:54 +05:30
describe '#refresh_markdown_cache!' do
let(:thing) { klass.new(description: markdown, description_html: html, cached_markdown_version: cache_version) }
2017-08-17 22:00:37 +05:30
2019-09-04 21:01:54 +05:30
before do
thing.description = updated_markdown
end
2017-08-17 22:00:37 +05:30
2019-09-04 21:01:54 +05:30
it 'fills all html fields' do
thing.refresh_markdown_cache!
2017-08-17 22:00:37 +05:30
2019-09-04 21:01:54 +05:30
expect(thing.description_html).to eq(updated_html)
end
2017-08-17 22:00:37 +05:30
2019-09-04 21:01:54 +05:30
it 'saves the changes' do
expect(thing)
.to receive(:save_markdown)
2022-07-16 23:28:13 +05:30
.with({ "description_html" => updated_html, "title_html" => "", "cached_markdown_version" => cache_version })
2017-08-17 22:00:37 +05:30
2019-09-04 21:01:54 +05:30
thing.refresh_markdown_cache!
end
2017-08-17 22:00:37 +05:30
end
2016-11-03 12:29:30 +05:30
2019-09-04 21:01:54 +05:30
describe '#banzai_render_context' do
let(:thing) { klass.new(title: markdown, title_html: html, cached_markdown_version: cache_version) }
2020-03-13 15:44:24 +05:30
2019-09-04 21:01:54 +05:30
subject(:context) { thing.banzai_render_context(:title) }
2017-08-17 22:00:37 +05:30
2019-09-04 21:01:54 +05:30
it 'sets project to nil if the object lacks a project' do
is_expected.to have_key(:project)
expect(context[:project]).to be_nil
end
2016-11-03 12:29:30 +05:30
2019-09-04 21:01:54 +05:30
it 'excludes author if the object lacks an author' do
is_expected.not_to have_key(:author)
end
2016-11-03 12:29:30 +05:30
2019-09-04 21:01:54 +05:30
it 'raises if the context for an unrecognised field is requested' do
expect { thing.banzai_render_context(:not_found) }.to raise_error(ArgumentError)
end
2016-11-03 12:29:30 +05:30
2019-09-04 21:01:54 +05:30
it 'includes the pipeline' do
title_context = thing.banzai_render_context(:title)
2017-08-17 22:00:37 +05:30
2019-09-04 21:01:54 +05:30
expect(title_context[:pipeline]).to eq(:single_line)
end
2016-11-03 12:29:30 +05:30
2019-09-04 21:01:54 +05:30
it 'returns copies of the context template' do
template = thing.cached_markdown_fields[:description]
copy = thing.banzai_render_context(:description)
2017-08-17 22:00:37 +05:30
2019-09-04 21:01:54 +05:30
expect(copy).not_to be(template)
end
2016-11-03 12:29:30 +05:30
2019-09-04 21:01:54 +05:30
context 'with a project' do
let(:project) { build(:project, group: create(:group)) }
let(:thing) { thing_subclass(klass, :project).new(title: markdown, title_html: html, project: project) }
2016-11-03 12:29:30 +05:30
2019-09-04 21:01:54 +05:30
it 'sets the project in the context' do
is_expected.to have_key(:project)
expect(context[:project]).to eq(project)
end
2016-11-03 12:29:30 +05:30
end
2019-09-04 21:01:54 +05:30
context 'with an author' do
2020-10-24 23:57:45 +05:30
let(:user) { build(:user) }
let(:thing) { thing_subclass(klass, :author).new(title: markdown, title_html: html, author: user) }
2016-11-03 12:29:30 +05:30
2019-09-04 21:01:54 +05:30
it 'sets the author in the context' do
is_expected.to have_key(:author)
2020-10-24 23:57:45 +05:30
expect(context[:author]).to eq(user)
end
end
context 'with a parent_user' do
let(:user) { build(:user) }
let(:thing) { thing_subclass(klass, :author, :parent_user).new(title: markdown, title_html: html, parent_user: user, author: user) }
it 'sets the user in the context' do
is_expected.to have_key(:user)
expect(context[:user]).to eq(user)
end
context 'when the personal_snippet_reference_filters flag is disabled' do
before do
stub_feature_flags(personal_snippet_reference_filters: false)
end
it 'does not set the user in the context' do
is_expected.not_to have_key(:user)
expect(context[:user]).to be_nil
end
2019-09-04 21:01:54 +05:30
end
2016-11-03 12:29:30 +05:30
end
end
2019-09-30 21:07:59 +05:30
describe '#updated_cached_html_for' do
2023-03-04 22:38:38 +05:30
let(:thing) { klass.new(project_id: project.id, namespace_id: project.project_namespace_id, description: markdown, description_html: html, cached_markdown_version: cache_version) }
2019-09-30 21:07:59 +05:30
context 'when the markdown cache is outdated' do
before do
thing.cached_markdown_version += 1
end
2020-05-30 21:06:31 +05:30
it 'calls #refresh_markdown_cache!' do
2021-02-22 17:27:13 +05:30
expect(thing).to receive(:refresh_markdown_cache)
2019-09-30 21:07:59 +05:30
expect(thing.updated_cached_html_for(:description)).to eq(html)
end
end
context 'when the markdown field does not exist' do
it 'returns nil' do
expect(thing.updated_cached_html_for(:something)).to eq(nil)
end
end
context 'when the markdown cache is up to date' do
2020-05-24 23:13:21 +05:30
before do
thing.try(:save)
end
2020-05-30 21:06:31 +05:30
it 'does not call #refresh_markdown_cache!' do
expect(thing).not_to receive(:refresh_markdown_cache!)
2019-09-30 21:07:59 +05:30
expect(thing.updated_cached_html_for(:description)).to eq(html)
end
end
end
2020-04-08 14:13:33 +05:30
describe '#rendered_field_content' do
let(:thing) { klass.new(description: markdown, description_html: nil, cached_markdown_version: cache_version) }
context 'when a field can be cached' do
it 'returns the html' do
thing.description = updated_markdown
expect(thing.rendered_field_content(:description)).to eq updated_html
end
end
context 'when a field cannot be cached' do
it 'returns nil' do
allow(thing).to receive(:can_cache_field?).with(:description).and_return false
expect(thing.rendered_field_content(:description)).to eq nil
end
end
end
2019-09-04 21:01:54 +05:30
end
2016-11-03 12:29:30 +05:30
2021-02-22 17:27:13 +05:30
shared_examples 'a class with mentionable markdown fields' do
2023-03-04 22:38:38 +05:30
let(:mentionable) { klass.new(project_id: project.id, namespace_id: project.project_namespace_id, description: markdown, description_html: html, title: markdown, title_html: html, cached_markdown_version: cache_version) }
2021-02-22 17:27:13 +05:30
context 'when klass is a Mentionable', :aggregate_failures do
before do
klass.send(:include, Mentionable)
klass.send(:attr_mentionable, :description)
end
describe '#mentionable_attributes_changed?' do
message = Struct.new(:text)
let(:changes) do
msg = message.new('test')
changes = {}
changes[msg] = ['', 'some message']
changes[:random_sym_key] = ['', 'some message']
changes["description"] = ['', 'some message']
changes
end
it 'returns true with key string' do
changes["description_html"] = ['', 'some message']
allow(mentionable).to receive(:saved_changes).and_return(changes)
expect(mentionable.send(:mentionable_attributes_changed?)).to be true
end
it 'returns false with key symbol' do
changes[:description_html] = ['', 'some message']
allow(mentionable).to receive(:saved_changes).and_return(changes)
expect(mentionable.send(:mentionable_attributes_changed?)).to be false
end
it 'returns false when no attr_mentionable keys' do
allow(mentionable).to receive(:saved_changes).and_return(changes)
expect(mentionable.send(:mentionable_attributes_changed?)).to be false
end
end
describe '#save' do
context 'when cache is outdated' do
before do
thing.cached_markdown_version += 1
end
context 'when the markdown field also a mentionable attribute' do
2023-03-04 22:38:38 +05:30
let(:thing) { klass.new(project_id: project.id, namespace_id: project.project_namespace_id, description: markdown, description_html: html, cached_markdown_version: cache_version) }
2021-02-22 17:27:13 +05:30
it 'calls #store_mentions!' do
expect(thing).to receive(:mentionable_attributes_changed?).and_return(true)
expect(thing).to receive(:store_mentions!)
thing.try(:save)
expect(thing.description_html).to eq(html)
end
end
context 'when the markdown field is not mentionable attribute' do
2023-03-04 22:38:38 +05:30
let(:thing) { klass.new(project_id: project.id, namespace_id: project.project_namespace_id, title: markdown, title_html: html, cached_markdown_version: cache_version) }
2021-02-22 17:27:13 +05:30
it 'does not call #store_mentions!' do
expect(thing).not_to receive(:store_mentions!)
expect(thing).to receive(:refresh_markdown_cache)
thing.try(:save)
expect(thing.title_html).to eq(html)
end
end
end
context 'when the markdown field does not exist' do
2023-03-04 22:38:38 +05:30
let(:thing) { klass.new(project_id: project.id, namespace_id: project.project_namespace_id, cached_markdown_version: cache_version) }
2021-02-22 17:27:13 +05:30
it 'does not call #store_mentions!' do
expect(thing).not_to receive(:store_mentions!)
thing.try(:save)
end
end
end
end
end
2019-09-04 21:01:54 +05:30
context 'for Active record classes' do
2023-03-04 22:38:38 +05:30
let_it_be(:project) { create(:project) }
2019-09-04 21:01:54 +05:30
let(:klass) { ar_class }
2016-11-03 12:29:30 +05:30
2019-09-04 21:01:54 +05:30
it_behaves_like 'a class with cached markdown fields'
2021-02-22 17:27:13 +05:30
it_behaves_like 'a class with mentionable markdown fields'
2020-05-24 23:13:21 +05:30
describe '#attribute_invalidated?' do
2023-03-04 22:38:38 +05:30
let(:thing) { klass.create!(project_id: project.id, namespace_id: project.project_namespace_id, description: markdown, description_html: html, cached_markdown_version: cache_version) }
2020-05-24 23:13:21 +05:30
it 'returns true when cached_markdown_version is different' do
thing.cached_markdown_version += 1
expect(thing.attribute_invalidated?(:description_html)).to eq(true)
end
it 'returns true when markdown is changed' do
thing.description = updated_markdown
expect(thing.attribute_invalidated?(:description_html)).to eq(true)
end
it 'returns true when both markdown and HTML are changed' do
thing.description = updated_markdown
thing.description_html = updated_html
expect(thing.attribute_invalidated?(:description_html)).to eq(true)
end
it 'returns false when there are no changes' do
expect(thing.attribute_invalidated?(:description_html)).to eq(false)
2022-07-23 23:45:48 +05:30
end
it 'returns false if skip_markdown_cache_validation is true' do
# invalidates the attribute
thing.cached_markdown_version += 1
thing.description = updated_markdown
thing.skip_markdown_cache_validation = true
expect(thing.attribute_invalidated?(:description_html)).to eq(false)
2020-05-24 23:13:21 +05:30
end
end
context 'when cache version is updated' do
let(:old_version) { cache_version - 1 }
let(:old_html) { '<p data-sourcepos="1:1-1:5" dir="auto" class="some-old-class"><code>Foo</code></p>' }
let(:thing) do
# This forces the record to have outdated HTML. We can't use `create` because the `before_create` hook
# would re-render the HTML to the latest version
2023-03-04 22:38:38 +05:30
klass.create!(project_id: project.id, namespace_id: project.project_namespace_id).tap do |thing|
2020-05-24 23:13:21 +05:30
thing.update_columns(description: markdown, description_html: old_html, cached_markdown_version: old_version)
end
end
it 'correctly updates cached HTML even if refresh_markdown_cache is called before updating the attribute' do
thing.refresh_markdown_cache
2021-01-03 14:25:43 +05:30
thing.update!(description: updated_markdown)
2020-05-24 23:13:21 +05:30
expect(thing.description_html).to eq(updated_html)
end
end
2019-09-04 21:01:54 +05:30
end
2016-11-03 12:29:30 +05:30
2019-09-04 21:01:54 +05:30
context 'for other classes' do
2023-03-04 22:38:38 +05:30
let_it_be(:project) { create(:project) }
2019-09-04 21:01:54 +05:30
let(:klass) { other_class }
2016-11-03 12:29:30 +05:30
2019-09-04 21:01:54 +05:30
it_behaves_like 'a class with cached markdown fields'
2016-11-03 12:29:30 +05:30
end
end