debian-mirror-gitlab/lib/api/helpers/pagination_strategies.rb

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

85 lines
2.8 KiB
Ruby
Raw Normal View History

2020-03-13 15:44:24 +05:30
# frozen_string_literal: true
module API
module Helpers
module PaginationStrategies
2021-11-11 11:23:49 +05:30
def paginate_with_strategies(relation, request_scope = nil)
2020-05-24 23:13:21 +05:30
paginator = paginator(relation, request_scope)
2020-03-13 15:44:24 +05:30
2021-11-11 11:23:49 +05:30
result = if block_given?
yield(paginator.paginate(relation))
else
paginator.paginate(relation)
end
result.tap do |records, _|
2020-03-13 15:44:24 +05:30
paginator.finalize(records)
end
end
2020-05-24 23:13:21 +05:30
def paginator(relation, request_scope = nil)
return keyset_paginator(relation) if keyset_pagination_enabled?
2020-03-13 15:44:24 +05:30
2020-05-24 23:13:21 +05:30
offset_paginator(relation, request_scope)
end
private
2020-03-13 15:44:24 +05:30
2020-05-24 23:13:21 +05:30
def keyset_paginator(relation)
2021-11-11 11:23:49 +05:30
if cursor_based_keyset_pagination_supported?(relation)
request_context_class = Gitlab::Pagination::Keyset::CursorBasedRequestContext
paginator_class = Gitlab::Pagination::Keyset::CursorPager
availability_checker = Gitlab::Pagination::CursorBasedKeyset
else
request_context_class = Gitlab::Pagination::Keyset::RequestContext
paginator_class = Gitlab::Pagination::Keyset::Pager
availability_checker = Gitlab::Pagination::Keyset
end
request_context = request_context_class.new(self)
unless availability_checker.available?(request_context, relation)
2020-03-13 15:44:24 +05:30
return error!('Keyset pagination is not yet available for this type of request', 405)
end
2021-11-11 11:23:49 +05:30
paginator_class.new(request_context)
2020-03-13 15:44:24 +05:30
end
2020-05-24 23:13:21 +05:30
def offset_paginator(relation, request_scope)
offset_limit = limit_for_scope(request_scope)
2021-11-11 11:23:49 +05:30
if (Gitlab::Pagination::Keyset.available_for_type?(relation) ||
cursor_based_keyset_pagination_supported?(relation)) &&
2022-08-13 15:12:31 +05:30
cursor_based_keyset_pagination_enforced?(relation) &&
2021-11-11 11:23:49 +05:30
offset_limit_exceeded?(offset_limit)
2020-05-24 23:13:21 +05:30
return error!("Offset pagination has a maximum allowed offset of #{offset_limit} " \
"for requests that return objects of type #{relation.klass}. " \
"Remaining records can be retrieved using keyset pagination.", 405)
end
Gitlab::Pagination::OffsetPagination.new(self)
end
2020-03-13 15:44:24 +05:30
2021-11-11 11:23:49 +05:30
def cursor_based_keyset_pagination_supported?(relation)
Gitlab::Pagination::CursorBasedKeyset.available_for_type?(relation)
end
2022-08-13 15:12:31 +05:30
def cursor_based_keyset_pagination_enforced?(relation)
Gitlab::Pagination::CursorBasedKeyset.enforced_for_type?(relation)
end
2020-03-13 15:44:24 +05:30
def keyset_pagination_enabled?
params[:pagination] == 'keyset'
end
2020-05-24 23:13:21 +05:30
def limit_for_scope(scope)
(scope || Plan.default).actual_limits.offset_pagination_limit
end
def offset_limit_exceeded?(offset_limit)
2020-10-24 23:57:45 +05:30
offset_limit > 0 && params[:page] * params[:per_page] > offset_limit
2020-05-24 23:13:21 +05:30
end
2020-03-13 15:44:24 +05:30
end
end
end