Merge remote branch 'cloudant:add-filter-changes-test'

This closes #213

Signed-off-by: Eric Avdey <eiri@eiri.ca>
diff --git a/test/couch_changes_tests.erl b/test/couch_changes_tests.erl
index e7a42ce..3c0e5f6 100644
--- a/test/couch_changes_tests.erl
+++ b/test/couch_changes_tests.erl
@@ -66,6 +66,7 @@
                 filter_by_design(),
                 continuous_feed(),
                 %%filter_by_custom_function()
+                filter_by_filter_function(),
                 filter_by_view()
             ]
         }
@@ -131,6 +132,19 @@
         }
     }.
 
+filter_by_filter_function() ->
+    {
+        "Filter by filters",
+        {
+            foreach,
+            fun setup/0, fun teardown/1,
+            [
+                fun should_filter_by_doc_attribute/1,
+                fun should_filter_by_user_ctx/1
+            ]
+        }
+    }.
+
 filter_by_view() ->
     {
         "Filter _view",
@@ -161,18 +175,12 @@
 should_filter_by_specific_doc_ids({DbName, _}) ->
     ?_test(
         begin
-            ChangesArgs = #changes_args{
+            ChArgs = #changes_args{
                 filter = "_doc_ids"
             },
             DocIds = [<<"doc3">>, <<"doc4">>, <<"doc9999">>],
             Req = {json_req, {[{<<"doc_ids">>, DocIds}]}},
-            Consumer = spawn_consumer(DbName, ChangesArgs, Req),
-
-            {Rows, LastSeq} = wait_finished(Consumer),
-            {ok, Db} = couch_db:open_int(DbName, []),
-            UpSeq = couch_db:get_update_seq(Db),
-            couch_db:close(Db),
-            stop_consumer(Consumer),
+            {Rows, LastSeq, UpSeq} = run_changes_query(DbName, ChArgs, Req),
 
             ?assertEqual(2, length(Rows)),
             [#row{seq = Seq1, id = Id1}, #row{seq = Seq2, id = Id2}] = Rows,
@@ -186,18 +194,13 @@
 should_filter_by_specific_doc_ids_descending({DbName, _}) ->
     ?_test(
         begin
-            ChangesArgs = #changes_args{
+            ChArgs = #changes_args{
                 filter = "_doc_ids",
                 dir = rev
             },
             DocIds = [<<"doc3">>, <<"doc4">>, <<"doc9999">>],
             Req = {json_req, {[{<<"doc_ids">>, DocIds}]}},
-            Consumer = spawn_consumer(DbName, ChangesArgs, Req),
-
-            {Rows, LastSeq} = wait_finished(Consumer),
-            {ok, Db} = couch_db:open_int(DbName, []),
-            couch_db:close(Db),
-            stop_consumer(Consumer),
+            {Rows, LastSeq, _} = run_changes_query(DbName, ChArgs, Req),
 
             ?assertEqual(2, length(Rows)),
             [#row{seq = Seq1, id = Id1}, #row{seq = Seq2, id = Id2}] = Rows,
@@ -211,19 +214,13 @@
 should_filter_by_specific_doc_ids_with_since({DbName, _}) ->
     ?_test(
         begin
-            ChangesArgs = #changes_args{
+            ChArgs = #changes_args{
                 filter = "_doc_ids",
                 since = 5
             },
             DocIds = [<<"doc3">>, <<"doc4">>, <<"doc9999">>],
             Req = {json_req, {[{<<"doc_ids">>, DocIds}]}},
-            Consumer = spawn_consumer(DbName, ChangesArgs, Req),
-
-            {Rows, LastSeq} = wait_finished(Consumer),
-            {ok, Db} = couch_db:open_int(DbName, []),
-            UpSeq = couch_db:get_update_seq(Db),
-            couch_db:close(Db),
-            stop_consumer(Consumer),
+            {Rows, LastSeq, UpSeq} = run_changes_query(DbName, ChArgs, Req),
 
             ?assertEqual(1, length(Rows)),
             [#row{seq = Seq1, id = Id1}] = Rows,
@@ -235,19 +232,13 @@
 should_filter_by_specific_doc_ids_no_result({DbName, _}) ->
     ?_test(
         begin
-            ChangesArgs = #changes_args{
+            ChArgs = #changes_args{
                 filter = "_doc_ids",
                 since = 6
             },
             DocIds = [<<"doc3">>, <<"doc4">>, <<"doc9999">>],
             Req = {json_req, {[{<<"doc_ids">>, DocIds}]}},
-            Consumer = spawn_consumer(DbName, ChangesArgs, Req),
-
-            {Rows, LastSeq} = wait_finished(Consumer),
-            {ok, Db} = couch_db:open_int(DbName, []),
-            UpSeq = couch_db:get_update_seq(Db),
-            couch_db:close(Db),
-            stop_consumer(Consumer),
+            {Rows, LastSeq, UpSeq} = run_changes_query(DbName, ChArgs, Req),
 
             ?assertEqual(0, length(Rows)),
             ?assertEqual(UpSeq, LastSeq)
@@ -264,17 +255,13 @@
                   {<<"_deleted">>, true},
                   {<<"_rev">>, Rev3_2}]}),
 
-            ChangesArgs = #changes_args{
+            ChArgs = #changes_args{
                 filter = "_doc_ids",
                 since = 9
             },
             DocIds = [<<"doc3">>, <<"doc4">>, <<"doc9999">>],
             Req = {json_req, {[{<<"doc_ids">>, DocIds}]}},
-            Consumer = spawn_consumer(DbName, ChangesArgs, Req),
-
-            {Rows, LastSeq} = wait_finished(Consumer),
-            couch_db:close(Db),
-            stop_consumer(Consumer),
+            {Rows, LastSeq, _} = run_changes_query(DbName, ChArgs, Req),
 
             ?assertEqual(1, length(Rows)),
             ?assertMatch(
@@ -376,12 +363,7 @@
             ChArgs = #changes_args{filter = "_selector"},
             Selector = {[{<<"_id">>, <<"doc3">>}]},
             Req = {json_req, {[{<<"selector">>, Selector}]}},
-            Consumer = spawn_consumer(DbName, ChArgs, Req),
-            {Rows, LastSeq} = wait_finished(Consumer),
-            {ok, Db} = couch_db:open_int(DbName, []),
-            UpSeq = couch_db:get_update_seq(Db),
-            couch_db:close(Db),
-            stop_consumer(Consumer),
+            {Rows, LastSeq, UpSeq} = run_changes_query(DbName, ChArgs, Req),
             ?assertEqual(1, length(Rows)),
             [#row{seq = Seq, id = Id}] = Rows,
             ?assertEqual(<<"doc3">>, Id),
@@ -396,12 +378,7 @@
             GteDoc2 = {[{<<"$gte">>, <<"doc1">>}]},
             Selector = {[{<<"_id">>, GteDoc2}]},
             Req = {json_req, {[{<<"selector">>, Selector}]}},
-            Consumer = spawn_consumer(DbName, ChArgs, Req),
-            {Rows, LastSeq} = wait_finished(Consumer),
-            {ok, Db} = couch_db:open_int(DbName, []),
-            UpSeq = couch_db:get_update_seq(Db),
-            couch_db:close(Db),
-            stop_consumer(Consumer),
+            {Rows, LastSeq, UpSeq} = run_changes_query(DbName, ChArgs, Req),
             ?assertEqual(1, length(Rows)),
             [#row{seq = Seq, id = Id}] = Rows,
             ?assertEqual(<<"doc8">>, Id),
@@ -415,12 +392,7 @@
             ChArgs = #changes_args{filter = "_selector"},
             Selector = {[{<<"_id">>, <<"nopers">>}]},
             Req = {json_req, {[{<<"selector">>, Selector}]}},
-            Consumer = spawn_consumer(DbName, ChArgs, Req),
-            {Rows, LastSeq} = wait_finished(Consumer),
-            {ok, Db} = couch_db:open_int(DbName, []),
-            UpSeq = couch_db:get_update_seq(Db),
-            couch_db:close(Db),
-            stop_consumer(Consumer),
+            {Rows, LastSeq, UpSeq} = run_changes_query(DbName, ChArgs, Req),
             ?assertEqual(0, length(Rows)),
             ?assertEqual(UpSeq, LastSeq)
         end).
@@ -438,10 +410,7 @@
             ChArgs = #changes_args{filter = "_selector"},
             Selector = {[{<<"_id">>, <<"doc3">>}]},
             Req = {json_req, {[{<<"selector">>, Selector}]}},
-            Consumer = spawn_consumer(DbName, ChArgs, Req),
-            {Rows, LastSeq} = wait_finished(Consumer),
-            couch_db:close(Db),
-            stop_consumer(Consumer),
+            {Rows, LastSeq, _} = run_changes_query(DbName, ChArgs, Req),
             ?assertMatch(
                 [#row{seq = LastSeq, id = <<"doc3">>, deleted = true}],
                 Rows
@@ -510,12 +479,7 @@
             Selector = {[{<<"_id">>, <<"doc3">>}]},
             Req = {json_req, {[{<<"selector">>, Selector},
                                {<<"fields">>, []}]}},
-            Consumer = spawn_consumer(DbName, ChArgs, Req),
-            {Rows, LastSeq} = wait_finished(Consumer),
-            {ok, Db} = couch_db:open_int(DbName, []),
-            UpSeq = couch_db:get_update_seq(Db),
-            couch_db:close(Db),
-            stop_consumer(Consumer),
+            {Rows, LastSeq, UpSeq} = run_changes_query(DbName, ChArgs, Req),
             ?assertEqual(1, length(Rows)),
             [#row{seq = Seq, id = Id, doc = Doc}] = Rows,
             ?assertEqual(<<"doc3">>, Id),
@@ -531,12 +495,7 @@
             Selector = {[{<<"_id">>, <<"doc3">>}]},
             Req = {json_req, {[{<<"selector">>, Selector},
                                {<<"fields">>, [<<"_id">>, <<"nope">>]}]}},
-            Consumer = spawn_consumer(DbName, ChArgs, Req),
-            {Rows, LastSeq} = wait_finished(Consumer),
-            {ok, Db} = couch_db:open_int(DbName, []),
-            UpSeq = couch_db:get_update_seq(Db),
-            couch_db:close(Db),
-            stop_consumer(Consumer),
+            {Rows, LastSeq, UpSeq} = run_changes_query(DbName, ChArgs, Req),
             ?assertEqual(1, length(Rows)),
             [#row{seq = Seq, id = Id, doc = Doc}] = Rows,
             ?assertEqual(<<"doc3">>, Id),
@@ -549,32 +508,26 @@
 should_emit_only_design_documents({DbName, Revs}) ->
     ?_test(
         begin
-            ChangesArgs = #changes_args{
+            ChArgs = #changes_args{
                 filter = "_design"
             },
-            Consumer = spawn_consumer(DbName, ChangesArgs, {json_req, null}),
-
-            {Rows, LastSeq} = wait_finished(Consumer),
-            {ok, Db} = couch_db:open_int(DbName, []),
-            UpSeq = couch_db:get_update_seq(Db),
-            couch_db:close(Db),
+            Req = {json_req, null},
+            {Rows, LastSeq, UpSeq} = run_changes_query(DbName, ChArgs, Req),
 
             ?assertEqual(1, length(Rows)),
             ?assertEqual(UpSeq, LastSeq),
             ?assertEqual([#row{seq = 8, id = <<"_design/foo">>}], Rows),
 
-            stop_consumer(Consumer),
 
-            {ok, Db2} = couch_db:open_int(DbName, [?ADMIN_CTX]),
-            {ok, _} = save_doc(Db2, {[{<<"_id">>, <<"_design/foo">>},
+            {ok, Db} = couch_db:open_int(DbName, [?ADMIN_CTX]),
+            {ok, _} = save_doc(Db, {[{<<"_id">>, <<"_design/foo">>},
                                       {<<"_rev">>, element(8, Revs)},
                                       {<<"_deleted">>, true}]}),
 
-            Consumer2 = spawn_consumer(DbName, ChangesArgs, {json_req, null}),
+            couch_db:close(Db),
+            {Rows2, LastSeq2, _} = run_changes_query(DbName, ChArgs, Req),
 
-            {Rows2, LastSeq2} = wait_finished(Consumer2),
             UpSeq2 = UpSeq + 1,
-            couch_db:close(Db2),
 
             ?assertEqual(1, length(Rows2)),
             ?assertEqual(UpSeq2, LastSeq2),
@@ -651,10 +604,63 @@
              ?assert(Heartbeats3 > Heartbeats2)
         end)}.
 
+should_filter_by_doc_attribute({DbName, _}) ->
+    ?_test(
+        begin
+            DDocId = <<"_design/app">>,
+            DDoc = couch_doc:from_json_obj({[
+                {<<"_id">>, DDocId},
+                {<<"language">>, <<"javascript">>},
+                {<<"filters">>, {[
+                    {<<"valid">>, <<"function(doc, req) {"
+                    " if (doc._id == 'doc3') {"
+                        " return true; "
+                    "} }">>}
+                ]}}
+            ]}),
+            ChArgs = #changes_args{filter = "app/valid"},
+            Req = {json_req, null},
+            ok = update_ddoc(DbName, DDoc),
+            {Rows, LastSeq, UpSeq} = run_changes_query(DbName, ChArgs, Req),
+            ?assertEqual(1, length(Rows)),
+            [#row{seq = Seq, id = Id}] = Rows,
+            ?assertEqual(<<"doc3">>, Id),
+            ?assertEqual(6, Seq),
+            ?assertEqual(UpSeq, LastSeq)
+        end).
+
+should_filter_by_user_ctx({DbName, _}) ->
+    ?_test(
+        begin
+            DDocId = <<"_design/app">>,
+            DDoc = couch_doc:from_json_obj({[
+                {<<"_id">>, DDocId},
+                {<<"language">>, <<"javascript">>},
+                {<<"filters">>, {[
+                    {<<"valid">>, <<"function(doc, req) {"
+                    " if (req.userCtx.name == doc._id) {"
+                        " return true; "
+                    "} }">>}
+                ]}}
+            ]}),
+            ChArgs = #changes_args{filter = "app/valid"},
+            UserCtx = #user_ctx{name = <<"doc3">>, roles = []},
+            DbRec = #db{name = DbName, user_ctx = UserCtx},
+            Req = {json_req, {[{
+                <<"userCtx">>, couch_util:json_user_ctx(DbRec)
+            }]}},
+            ok = update_ddoc(DbName, DDoc),
+            {Rows, LastSeq, UpSeq} = run_changes_query(DbName, ChArgs, Req),
+            ?assertEqual(1, length(Rows)),
+            [#row{seq = Seq, id = Id}] = Rows,
+            ?assertEqual(<<"doc3">>, Id),
+            ?assertEqual(6, Seq),
+            ?assertEqual(UpSeq, LastSeq)
+        end).
+
 should_filter_by_view({DbName, _}) ->
     ?_test(
         begin
-            {ok, Db0} = couch_db:open_int(DbName, [?ADMIN_CTX]),
             DDocId = <<"_design/app">>,
             DDoc = couch_doc:from_json_obj({[
                 {<<"_id">>, DDocId},
@@ -668,21 +674,14 @@
                     ]}}
                 ]}}
             ]}),
-            {ok, _} = couch_db:update_doc(Db0, DDoc, []),
-            couch_db:close(Db0),
-            %%
-            ChangesArgs = #changes_args{filter = "_view"},
-            Opts = {json_req, {[{
+            ChArgs = #changes_args{filter = "_view"},
+            Req = {json_req, {[{
                 <<"query">>, {[
                     {<<"view">>, <<"app/valid">>}
                 ]}
             }]}},
-            Consumer = spawn_consumer(DbName, ChangesArgs, Opts),
-            {Rows, LastSeq} = wait_finished(Consumer),
-            {ok, Db} = couch_db:open_int(DbName, []),
-            UpSeq = couch_db:get_update_seq(Db),
-            couch_db:close(Db),
-            stop_consumer(Consumer),
+            ok = update_ddoc(DbName, DDoc),
+            {Rows, LastSeq, UpSeq} = run_changes_query(DbName, ChArgs, Req),
             ?assertEqual(1, length(Rows)),
             [#row{seq = Seq, id = Id}] = Rows,
             ?assertEqual(<<"doc3">>, Id),
@@ -693,7 +692,6 @@
 should_filter_by_fast_view({DbName, _}) ->
     ?_test(
         begin
-            {ok, Db0} = couch_db:open_int(DbName, [?ADMIN_CTX]),
             DDocId = <<"_design/app">>,
             DDoc = couch_doc:from_json_obj({[
                 {<<"_id">>, DDocId},
@@ -708,31 +706,40 @@
                     ]}}
                 ]}}
             ]}),
-            {ok, _} = couch_db:update_doc(Db0, DDoc, []),
-            couch_db:close(Db0),
-            %%
-            ChangesArgs = #changes_args{filter = "_view"},
-            Opts = {json_req, {[{
+            ChArgs = #changes_args{filter = "_view"},
+            Req = {json_req, {[{
                 <<"query">>, {[
                     {<<"view">>, <<"app/valid">>}
                 ]}
             }]}},
-            Consumer = spawn_consumer(DbName, ChangesArgs, Opts),
-            {Rows, LastSeq} = wait_finished(Consumer),
+            ok = update_ddoc(DbName, DDoc),
+            {Rows, LastSeq, UpSeq} = run_changes_query(DbName, ChArgs, Req),
             {ok, Db} = couch_db:open_int(DbName, []),
-            DbUpSeq = couch_db:get_update_seq(Db),
             {ok, ViewInfo} = couch_mrview:get_view_info(Db, DDoc, <<"valid">>),
             {update_seq, ViewUpSeq} = lists:keyfind(update_seq, 1, ViewInfo),
             couch_db:close(Db),
-            stop_consumer(Consumer),
             ?assertEqual(1, length(Rows)),
             [#row{seq = Seq, id = Id}] = Rows,
             ?assertEqual(<<"doc3">>, Id),
             ?assertEqual(6, Seq),
             ?assertEqual(LastSeq, Seq),
-            ?assertEqual(DbUpSeq, ViewUpSeq)
+            ?assertEqual(UpSeq, ViewUpSeq)
         end).
 
+update_ddoc(DbName, DDoc) ->
+    {ok, Db} = couch_db:open_int(DbName, [?ADMIN_CTX]),
+    {ok, _} = couch_db:update_doc(Db, DDoc, []),
+    couch_db:close(Db).
+
+run_changes_query(DbName, ChangesArgs, Opts) ->
+    Consumer = spawn_consumer(DbName, ChangesArgs, Opts),
+    {Rows, LastSeq} = wait_finished(Consumer),
+    {ok, Db} = couch_db:open_int(DbName, []),
+    UpSeq = couch_db:get_update_seq(Db),
+    couch_db:close(Db),
+    stop_consumer(Consumer),
+    {Rows, LastSeq, UpSeq}.
+
 save_doc(Db, Json) ->
     Doc = couch_doc:from_json_obj(Json),
     {ok, Rev} = couch_db:update_doc(Db, Doc, []),
@@ -863,7 +870,7 @@
             FeedFun({Callback, []})
         catch
             throw:{stop, _} -> ok;
-            _:Error -> Error
+            _:Error -> exit(Error)
         after
             couch_db:close(Db)
         end