Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add key range check for _all_docs #4518

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add key range check for _all_docs #4518

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
73 changes: 37 additions & 36 deletions src/chttpd/test/eunit/chttpd_view_test.erl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,12 @@
<<"error">> := <<"query_parse_error">>,
<<"reason">> := <<"`keys` is incompatible with `key`, `start_key` and `end_key`">>
}).
-define(ERROR_KEY_RANGE, #{
<<"error">> := <<"query_parse_error">>,
<<"reason">> :=
<<"No rows can match your key range, reverse your ",
"start_key and end_key or set descending=true">>
}).

% seconds
-define(TIMEOUT, 60).
Expand Down Expand Up @@ -163,26 +169,17 @@ t_view_with_multiple_queries(Db) ->
?assertEqual(200, Code).

t_view_with_key_and_start_key(Db) ->
{Code1, Res1} = req(get, url(Db, "_design/ddoc/_view/map", "key=\"a\"&startkey=\"b\"")),
{Code2, Res2} = req(get, url(Db, "_design/ddoc/_view/map", "startkey=\"b\"&key=\"a\"")),
?assertMatch(
#{
<<"error">> := <<"query_parse_error">>,
<<"reason">> :=
<<"No rows can match your key range, reverse your start_key and end_key or set descending=true">>
},
Res1
),
?assertMatch(#{<<"rows">> := [#{<<"id">> := <<"a">>}]}, Res2),
?assertEqual(400, Code1),
?assertEqual(200, Code2).
test_helper_key_and_start_key(Db, "_design/ddoc/_view/map").

t_all_docs_with_key_and_start_key(Db) ->
{Code1, Res1} = req(get, url(Db, "_all_docs", "key=\"a\"&startkey=\"b\"")),
{Code2, Res2} = req(get, url(Db, "_all_docs", "startkey=\"b\"&key=\"a\"")),
?assertMatch(#{<<"rows">> := []}, Res1),
test_helper_key_and_start_key(Db, "_all_docs").

test_helper_key_and_start_key(Db, Path) ->
{Code1, Res1} = req(get, url(Db, Path, "key=\"a\"&startkey=\"b\"")),
{Code2, Res2} = req(get, url(Db, Path, "startkey=\"b\"&key=\"a\"")),
?assertMatch(?ERROR_KEY_RANGE, Res1),
?assertMatch(#{<<"rows">> := [#{<<"id">> := <<"a">>}]}, Res2),
?assertEqual(200, Code1),
?assertEqual(400, Code1),
?assertEqual(200, Code2).

t_view_with_key_and_end_key(Db) ->
Expand All @@ -200,31 +197,35 @@ test_helper_key_and_end_key(Db, Path) ->
?assertEqual(200, Code2).

t_view_with_single_keys_and_start_key(Db) ->
{Code, Res} = req(get, url(Db, "_design/ddoc/_view/map?keys=[\"a\"]&startkey=\"b\"")),
?assertMatch(
#{
<<"error">> := <<"query_parse_error">>,
<<"reason">> :=
<<"No rows can match your key range, reverse your start_key and end_key or set descending=true">>
},
Res
),
?assertEqual(400, Code).
test_helper_single_keys_and_start_key(Db, "_design/ddoc/_view/map").

t_all_docs_with_single_keys_and_start_key(Db) ->
{Code, Res} = req(get, url(Db, "_all_docs?keys=[\"a\"]&startkey=\"b\"")),
?assertMatch(?ERROR_KEYS_INCOMPATIBLE, Res),
?assertEqual(400, Code).
test_helper_single_keys_and_start_key(Db, "_all_docs").

test_helper_single_keys_and_start_key(Db, Path) ->
{Code1, Res1} = req(get, url(Db, Path, "keys=[\"a\"]&startkey=\"b\"")),
{Code2, Res2} = req(get, url(Db, Path, "startkey=\"b\"&keys=[\"a\"]")),
case Path of
"_all_docs" -> ?assertMatch(?ERROR_KEYS_INCOMPATIBLE, Res1);
_ -> ?assertMatch(?ERROR_KEY_RANGE, Res1)
end,
?assertMatch(#{<<"rows">> := [#{<<"id">> := <<"a">>}]}, Res2),
?assertEqual(400, Code1),
?assertEqual(200, Code2).

t_view_with_keys_and_start_key(Db) ->
{Code, Res} = req(get, url(Db, "_design/ddoc/_view/map", "keys=[\"a\",\"b\"]&start_key=\"b\"")),
?assertMatch(?ERROR_KEYS_INCOMPATIBLE, Res),
?assertEqual(400, Code).
test_helper_keys_and_start_key(Db, "_design/ddoc/_view/map").

t_all_docs_with_keys_and_start_key(Db) ->
{Code, Res} = req(get, url(Db, "_all_docs", "keys=[\"a\",\"b\"]&start_key=\"b\"")),
?assertMatch(?ERROR_KEYS_INCOMPATIBLE, Res),
?assertEqual(400, Code).
test_helper_keys_and_start_key(Db, "_all_docs").

test_helper_keys_and_start_key(Db, Path) ->
{Code1, Res1} = req(get, url(Db, Path, "keys=[\"a\",\"b\"]&start_key=\"b\"")),
{Code2, Res2} = req(get, url(Db, Path, "startkey=\"b\"&keys=[\"a\",\"b\"]")),
?assertMatch(?ERROR_KEYS_INCOMPATIBLE, Res1),
?assertMatch(?ERROR_KEYS_INCOMPATIBLE, Res2),
?assertEqual(400, Code1),
?assertEqual(400, Code2).

t_view_with_key_non_existent_docs(Db) ->
{Code, Res} = req(get, url(Db, "_design/ddoc/_view/map", "key=\"not_exist\"")),
Expand Down
21 changes: 21 additions & 0 deletions src/couch_mrview/src/couch_mrview_util.erl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -533,6 +533,7 @@ apply_limit(ViewPartitioned, Args) ->

validate_all_docs_args(Db, Args0) ->
Args = validate_args(Args0),
check_range_all_docs(Args),
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why not put this inside validate_args?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tried that before but it fails in mango tests related to _find endpoint.
https://ci-couchdb.apache.org/blue/organizations/jenkins/jenkins-cm1%2FPullRequests/detail/PR-4518/9/pipeline/

ERROR: test_gte_respsects_unicode_collation (03-operator-test.OperatorJSONTests)
----------------------------------------------------------------------
Traceback (most recent call last):
 File "/home/jenkins/workspace/jenkins-cm1_PullRequests_PR-4518/25.3/build/apache-couchdb-3.3.2-04ead65/src/mango/test/03-operator-test.py", line 187, in test_gte_respsects_unicode_collation
   docs = self.db.find({"ordered": {"$gte": "a"}})
 File "/home/jenkins/workspace/jenkins-cm1_PullRequests_PR-4518/25.3/build/apache-couchdb-3.3.2-04ead65/src/mango/test/mango.py", line 280, in find
   r.raise_for_status()
 File "/home/jenkins/workspace/jenkins-cm1_PullRequests_PR-4518/25.3/build/apache-couchdb-3.3.2-04ead65/src/mango/.venv/lib/python3.9/site-packages/requests/models.py", line 960, in raise_for_status
   raise HTTPError(http_error_msg, response=self)
requests.exceptions.HTTPError: 400 Client Error: Bad Request for url: http://127.0.0.1:15984/mango_test_cad95f52e95341e097ce2c1d861c1457/_find
======================================================================
ERROR: test_old_selector_with_no_selector_still_supported (16-index-selectors-test.IndexSelectorJson)
... ...


DbPartitioned = couch_db:is_partitioned(Db),
Partition = get_extra(Args, partition),
Expand Down Expand Up @@ -782,6 +783,26 @@ apply_all_docs_partition(#mrargs{} = Args, Partition) ->
end_key = EK1
}.

check_range_all_docs(#mrargs{direction = Dir, start_key = SK, end_key = EK}) ->
case {Dir, SK, EK} of
{_, undefined, _} ->
ok;
{_, _, undefined} ->
ok;
{fwd, SK, EK} when SK > EK ->
mrverror(
<<"No rows can match your key range, reverse your ",
"start_key and end_key or set descending=true">>
);
{rev, SK, EK} when SK < EK ->
mrverror(
<<"No rows can match your key range, reverse your ",
"start_key and end_key or set descending=false">>
);
_ ->
ok
end.

check_range(#mrargs{start_key = undefined}, _Cmp) ->
ok;
check_range(#mrargs{end_key = undefined}, _Cmp) ->
Expand Down
2 changes: 1 addition & 1 deletion src/docs/src/api/ddoc/views.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -651,7 +651,7 @@ multi-element ``keys``. For single-element ``keys``, treat it as a ``key``.
$ curl http://adm:pass@127.0.0.1:5984/db/_design/ddoc/_view/reduce'?key="a"'
{"rows":[{"key":null,"value":1}]}

$ curl http://adm:pass@127.0.0.1:5984/db/_design/ddoc/_view/reduce'?keys="[\"a\"]"'
$ curl http://adm:pass@127.0.0.1:5984/db/_design/ddoc/_view/reduce'?keys=\["a"\]'
{"rows":[{"key":null,"value":1}]}

$ curl http://adm:pass@127.0.0.1:5984/db/_design/ddoc/_view/reduce'?keys=\["a","b"\]'
Expand Down