diff options
Diffstat (limited to 'spec/lib/gitlab/pagination')
| -rw-r--r-- | spec/lib/gitlab/pagination/keyset/iterator_spec.rb | 141 | ||||
| -rw-r--r-- | spec/lib/gitlab/pagination/keyset/order_spec.rb | 6 | ||||
| -rw-r--r-- | spec/lib/gitlab/pagination/offset_pagination_spec.rb | 74 |
3 files changed, 159 insertions, 62 deletions
diff --git a/spec/lib/gitlab/pagination/keyset/iterator_spec.rb b/spec/lib/gitlab/pagination/keyset/iterator_spec.rb index 656ae73945e..d8e79287745 100644 --- a/spec/lib/gitlab/pagination/keyset/iterator_spec.rb +++ b/spec/lib/gitlab/pagination/keyset/iterator_spec.rb @@ -18,110 +18,127 @@ RSpec.describe Gitlab::Pagination::Keyset::Iterator do Gitlab::Pagination::Keyset::Order.build([ Gitlab::Pagination::Keyset::ColumnOrderDefinition.new( attribute_name: column, - column_expression: klass.arel_table[column], - order_expression: ::Gitlab::Database.nulls_order(column, direction, nulls_position), - reversed_order_expression: ::Gitlab::Database.nulls_order(column, reverse_direction, reverse_nulls_position), - order_direction: direction, - nullable: nulls_position, - distinct: false + column_expression: klass.arel_table[column], + order_expression: ::Gitlab::Database.nulls_order(column, direction, nulls_position), + reversed_order_expression: ::Gitlab::Database.nulls_order(column, reverse_direction, reverse_nulls_position), + order_direction: direction, + nullable: nulls_position, + distinct: false ), Gitlab::Pagination::Keyset::ColumnOrderDefinition.new( attribute_name: 'id', - order_expression: klass.arel_table[:id].send(direction), - add_to_projections: true + order_expression: klass.arel_table[:id].send(direction) ) ]) end let(:scope) { project.issues.reorder(custom_reorder) } - subject { described_class.new(scope: scope) } + shared_examples 'iterator examples' do + describe '.each_batch' do + it 'yields an ActiveRecord::Relation when a block is given' do + iterator.each_batch(of: 1) do |relation| + expect(relation).to be_a_kind_of(ActiveRecord::Relation) + end + end - describe '.each_batch' do - it 'yields an ActiveRecord::Relation when a block is given' do - subject.each_batch(of: 1) do |relation| - expect(relation).to be_a_kind_of(ActiveRecord::Relation) + it 'raises error when ordering configuration cannot be automatically determined' do + expect do + described_class.new(scope: MergeRequestDiffCommit.order(:merge_request_diff_id, :relative_order)) + end.to raise_error /The order on the scope does not support keyset pagination/ end - end - it 'accepts a custom batch size' do - count = 0 + it 'accepts a custom batch size' do + count = 0 - subject.each_batch(of: 2) { |relation| count += relation.count(:all) } + iterator.each_batch(of: 2) { |relation| count += relation.count(:all) } - expect(count).to eq(9) - end + expect(count).to eq(9) + end - it 'allows updating of the yielded relations' do - time = Time.current + it 'allows updating of the yielded relations' do + time = Time.current - subject.each_batch(of: 2) do |relation| - relation.update_all(updated_at: time) - end + iterator.each_batch(of: 2) do |relation| + Issue.connection.execute("UPDATE issues SET updated_at = '#{time.to_s(:inspect)}' WHERE id IN (#{relation.reselect(:id).to_sql})") + end - expect(Issue.where(updated_at: time).count).to eq(9) - end + expect(Issue.pluck(:updated_at)).to all(be_within(5.seconds).of(time)) + end - context 'with ordering direction' do - context 'when ordering asc' do - it 'orders ascending by default, including secondary order column' do - positions = [] + context 'with ordering direction' do + context 'when ordering asc' do + it 'orders ascending by default, including secondary order column' do + positions = [] - subject.each_batch(of: 2) { |rel| positions.concat(rel.pluck(:relative_position, :id)) } + iterator.each_batch(of: 2) { |rel| positions.concat(rel.pluck(:relative_position, :id)) } - expect(positions).to eq(project.issues.order_relative_position_asc.order(id: :asc).pluck(:relative_position, :id)) + expect(positions).to eq(project.issues.order_relative_position_asc.order(id: :asc).pluck(:relative_position, :id)) + end end - end - context 'when reversing asc order' do - let(:scope) { project.issues.order(custom_reorder.reversed_order) } + context 'when reversing asc order' do + let(:scope) { project.issues.order(custom_reorder.reversed_order) } - it 'orders in reverse of ascending' do - positions = [] + it 'orders in reverse of ascending' do + positions = [] - subject.each_batch(of: 2) { |rel| positions.concat(rel.pluck(:relative_position, :id)) } + iterator.each_batch(of: 2) { |rel| positions.concat(rel.pluck(:relative_position, :id)) } - expect(positions).to eq(project.issues.order_relative_position_desc.order(id: :desc).pluck(:relative_position, :id)) + expect(positions).to eq(project.issues.order_relative_position_desc.order(id: :desc).pluck(:relative_position, :id)) + end end - end - context 'when asc order, with nulls first' do - let(:nulls_position) { :nulls_first } + context 'when asc order, with nulls first' do + let(:nulls_position) { :nulls_first } - it 'orders ascending with nulls first' do - positions = [] + it 'orders ascending with nulls first' do + positions = [] - subject.each_batch(of: 2) { |rel| positions.concat(rel.pluck(:relative_position, :id)) } + iterator.each_batch(of: 2) { |rel| positions.concat(rel.pluck(:relative_position, :id)) } - expect(positions).to eq(project.issues.reorder(::Gitlab::Database.nulls_first_order('relative_position', 'ASC')).order(id: :asc).pluck(:relative_position, :id)) + expect(positions).to eq(project.issues.reorder(::Gitlab::Database.nulls_first_order('relative_position', 'ASC')).order(id: :asc).pluck(:relative_position, :id)) + end end - end - context 'when ordering desc' do - let(:direction) { :desc } - let(:nulls_position) { :nulls_last } + context 'when ordering desc' do + let(:direction) { :desc } + let(:nulls_position) { :nulls_last } - it 'orders descending' do - positions = [] + it 'orders descending' do + positions = [] - subject.each_batch(of: 2) { |rel| positions.concat(rel.pluck(:relative_position, :id)) } + iterator.each_batch(of: 2) { |rel| positions.concat(rel.pluck(:relative_position, :id)) } - expect(positions).to eq(project.issues.reorder(::Gitlab::Database.nulls_last_order('relative_position', 'DESC')).order(id: :desc).pluck(:relative_position, :id)) + expect(positions).to eq(project.issues.reorder(::Gitlab::Database.nulls_last_order('relative_position', 'DESC')).order(id: :desc).pluck(:relative_position, :id)) + end end - end - context 'when ordering by columns are repeated twice' do - let(:direction) { :desc } - let(:column) { :id } + context 'when ordering by columns are repeated twice' do + let(:direction) { :desc } + let(:column) { :id } - it 'orders descending' do - positions = [] + it 'orders descending' do + positions = [] - subject.each_batch(of: 2) { |rel| positions.concat(rel.pluck(:id)) } + iterator.each_batch(of: 2) { |rel| positions.concat(rel.pluck(:id)) } - expect(positions).to eq(project.issues.reorder(id: :desc).pluck(:id)) + expect(positions).to eq(project.issues.reorder(id: :desc).pluck(:id)) + end end end end end + + context 'when use_union_optimization is used' do + subject(:iterator) { described_class.new(scope: scope, use_union_optimization: true) } + + include_examples 'iterator examples' + end + + context 'when use_union_optimization is not used' do + subject(:iterator) { described_class.new(scope: scope, use_union_optimization: false) } + + include_examples 'iterator examples' + end end diff --git a/spec/lib/gitlab/pagination/keyset/order_spec.rb b/spec/lib/gitlab/pagination/keyset/order_spec.rb index 26f52745b54..562a9bf4460 100644 --- a/spec/lib/gitlab/pagination/keyset/order_spec.rb +++ b/spec/lib/gitlab/pagination/keyset/order_spec.rb @@ -171,6 +171,12 @@ RSpec.describe Gitlab::Pagination::Keyset::Order do end it_behaves_like 'order examples' + + it 'uses the row comparison method' do + sql = order.where_values_with_or_query({ year: 2010, month: 5, id: 1 }).to_sql + + expect(sql).to eq('(("my_table"."year", "my_table"."month", "my_table"."id") > (2010, 5, 1))') + end end context 'when ordering by nullable columns and a distinct column' do diff --git a/spec/lib/gitlab/pagination/offset_pagination_spec.rb b/spec/lib/gitlab/pagination/offset_pagination_spec.rb index c9a23170137..f8d50fbc517 100644 --- a/spec/lib/gitlab/pagination/offset_pagination_spec.rb +++ b/spec/lib/gitlab/pagination/offset_pagination_spec.rb @@ -130,6 +130,80 @@ RSpec.describe Gitlab::Pagination::OffsetPagination do end end + context 'when resource already paginated' do + let(:resource) { Project.all.page(1).per(1) } + + context 'when per_page param is specified' do + let(:query) { base_query.merge(page: 1, per_page: 2) } + + it 'returns appropriate amount of resources based on per_page param' do + expect(subject.paginate(resource).count).to eq 2 + end + end + + context 'when page and per page params are strings' do + let(:query) { base_query.merge(page: '1', per_page: '1') } + + it 'returns appropriate amount of resources' do + expect(subject.paginate(resource).count).to eq 1 + end + end + + context 'when per_page param is blank' do + let(:query) { base_query.merge(page: 1) } + + it 'returns appropriate amount of resources' do + expect(subject.paginate(resource).count).to eq 1 + end + end + + context 'when page param is blank' do + let(:query) { base_query } + + it 'returns appropriate amount of resources based on resource per(N)' do + expect(subject.paginate(resource).count).to eq 1 + end + end + end + + context 'when resource does not respond to limit_value' do + let(:custom_collection) do + Class.new do + include Enumerable + + def initialize(items) + @collection = items + end + + def each + @collection.each { |item| yield item } + end + + def page(number) + Kaminari.paginate_array(@collection).page(number) + end + end + end + + let(:resource) { custom_collection.new(Project.all).page(query[:page]) } + + context 'when page param is blank' do + let(:query) { base_query } + + it 'returns appropriate amount of resources' do + expect(subject.paginate(resource).count).to eq 3 + end + end + + context 'when per_page param is blank' do + let(:query) { base_query.merge(page: 1) } + + it 'returns appropriate amount of resources with default per page value' do + expect(subject.paginate(resource).count).to eq 3 + end + end + end + context 'when resource is a paginatable array' do let(:resource) { Kaminari.paginate_array(Project.all.to_a) } |