Add limit parameter to api changesets query

This commit is contained in:
Anton Khorev 2023-02-14 20:54:40 +03:00
parent 8597449085
commit e286ce515c
2 changed files with 43 additions and 1 deletions

View file

@ -19,6 +19,9 @@ module Api
# Helper methods for checking consistency # Helper methods for checking consistency
include ConsistencyValidations include ConsistencyValidations
DEFAULT_QUERY_LIMIT = 100
MAX_QUERY_LIMIT = 100
## ##
# Return XML giving the basic info about the changeset. Does not # Return XML giving the basic info about the changeset. Does not
# return anything about the nodes, ways and relations in the changeset. # return anything about the nodes, ways and relations in the changeset.
@ -171,7 +174,7 @@ module Api
changesets = conditions_ids(changesets, params["changesets"]) changesets = conditions_ids(changesets, params["changesets"])
# sort and limit the changesets # sort and limit the changesets
changesets = changesets.order("created_at DESC").limit(100) changesets = changesets.order("created_at DESC").limit(result_limit)
# preload users, tags and comments, and render result # preload users, tags and comments, and render result
@changesets = changesets.preload(:user, :changeset_tags, :comments) @changesets = changesets.preload(:user, :changeset_tags, :comments)
@ -383,5 +386,19 @@ module Api
changesets.where(:id => ids) changesets.where(:id => ids)
end end
end end
##
# Get the maximum number of results to return
def result_limit
if params[:limit]
if params[:limit].to_i.positive? && params[:limit].to_i <= MAX_QUERY_LIMIT
params[:limit].to_i
else
raise OSM::APIBadUserInput, "Changeset limit must be between 1 and #{MAX_QUERY_LIMIT}"
end
else
DEFAULT_QUERY_LIMIT
end
end
end end
end end

View file

@ -1938,6 +1938,31 @@ module Api
assert_response :bad_request, "should be a bad request since changesets is empty" assert_response :bad_request, "should be a bad request since changesets is empty"
end end
##
# test the query functionality of changesets with the limit parameter
def test_query_limit
user = create(:user)
changeset1 = create(:changeset, :closed, :user => user, :created_at => Time.utc(2008, 1, 1, 0, 0, 0), :closed_at => Time.utc(2008, 1, 2, 0, 0, 0))
changeset2 = create(:changeset, :closed, :user => user, :created_at => Time.utc(2008, 2, 1, 0, 0, 0), :closed_at => Time.utc(2008, 2, 2, 0, 0, 0))
changeset3 = create(:changeset, :closed, :user => user, :created_at => Time.utc(2008, 3, 1, 0, 0, 0), :closed_at => Time.utc(2008, 3, 2, 0, 0, 0))
changeset4 = create(:changeset, :closed, :user => user, :created_at => Time.utc(2008, 4, 1, 0, 0, 0), :closed_at => Time.utc(2008, 4, 2, 0, 0, 0))
changeset5 = create(:changeset, :closed, :user => user, :created_at => Time.utc(2008, 5, 1, 0, 0, 0), :closed_at => Time.utc(2008, 5, 2, 0, 0, 0))
get changesets_path
assert_response :success
assert_changesets [changeset5, changeset4, changeset3, changeset2, changeset1]
get changesets_path(:limit => "3")
assert_response :success
assert_changesets [changeset5, changeset4, changeset3]
get changesets_path(:limit => "0")
assert_response :bad_request
get changesets_path(:limit => "101")
assert_response :bad_request
end
## ##
# check that errors are returned if garbage is inserted # check that errors are returned if garbage is inserted
# into query strings # into query strings