Merge 438b2a8 into d9f826a

.travis.yml

@@ -1,8 +1,8 @@
 language: python
-python: 3.6
+python: 3.8
 sudo: false
 env:
-  - TOX_ENV=py36
+  - TOX_ENVi=py38
   - TOX_ENV=flake8
 install: pip install -U tox
 script: tox -e $TOX_ENV

CHANGELOG.rst

@@ -4,7 +4,9 @@ Changelog
 3.2.0 (unreleased)
 ------------------
 
-- Nothing changed yet.
+**New features**
+
+- Add filtering support in monitor/changes changeset endpoint
 
 
 3.1.2 (2020-09-30)

kinto_changes/views.py

@@ -221,6 +221,10 @@ def deserialize(self, cstruct=colander.null):
 class ChangeSetQuerystring(colander.MappingSchema):
     _since = QuotedTimestamp(missing=colander.drop)
     _expected = colander.SchemaNode(colander.String())
+    _limit = colander.SchemaNode(colander.Integer(), missing=colander.drop)
+    # Query parameters used on monitor/changes endpoint.
+    bucket = colander.SchemaNode(colander.String(), missing=colander.drop)
+    collection = colander.SchemaNode(colander.String(), missing=colander.drop)
 
 
 class ChangeSetSchema(colander.MappingSchema):
@@ -235,6 +239,7 @@ def get_changeset(request):
     storage = request.registry.storage
 
     queryparams = request.validated["querystring"]
+    limit = queryparams.get("_limit")
     filters = []
     include_deleted = False
     if "_since" in queryparams:
@@ -246,10 +251,16 @@ def get_changeset(request):
         # Redirect old since, on monitor/changes only.
         _handle_old_since_redirect(request)
 
+        if "bucket" in queryparams:
+            filters.append(Filter("bucket", queryparams["bucket"], COMPARISON.EQ))
+
+        if "collection" in queryparams:
+            filters.append(Filter("collection", queryparams["collection"], COMPARISON.EQ))
+
         model = ChangesModel(request)
         metadata = {}
         timestamp = model.timestamp()
-        changes = model.get_objects(filters=filters, include_deleted=include_deleted)
+        changes = model.get_objects(filters=filters, limit=limit, include_deleted=include_deleted)
 
     else:
         bucket_uri = instance_uri(request, "bucket", id=bid)
@@ -277,6 +288,7 @@ def get_changeset(request):
             resource_name="record",
             parent_id=collection_uri,
             filters=filters,
+            limit=limit,
             id_field='id',
             modified_field='last_modified',
             deleted_field='deleted',

tests/test_changeset.py

@@ -98,6 +98,12 @@ def test_timestamp_is_validated(self):
     def test_expected_param_is_mandatory(self):
         self.app.get(self.changeset_uri.split("?")[0], headers=self.headers, status=400)
 
+    def test_limit_is_supported(self):
+        self.app.post_json(self.records_uri, {}, headers=self.headers)
+
+        resp = self.app.get(self.changeset_uri + "&_limit=1", headers=self.headers)
+        assert len(resp.json["changes"]) == 1
+
     def test_extra_param_is_allowed(self):
         self.app.get(self.changeset_uri + "&_extra=abc", headers=self.headers)
 
@@ -129,12 +135,22 @@ def test_changeset_returns_404_if_collection_is_unknown(self):
 
 
 class MonitorChangesetViewTest(BaseWebTest, unittest.TestCase):
-    records_uri = '/buckets/blocklists/collections/certificates/records'
+    records_uri = '/buckets/blocklists/collections/{cid}/records'
     changeset_uri = '/buckets/monitor/collections/changes/changeset?_expected=42'
 
     def setUp(self):
         super().setUp()
-        self.app.post_json(self.records_uri, SAMPLE_RECORD, headers=self.headers)
+        self.create_collection("blocklists", "cfr")
+        self.app.post_json(
+            self.records_uri.format(cid="cfr"),
+            SAMPLE_RECORD,
+            headers=self.headers
+        )
+        self.app.post_json(
+            self.records_uri.format(cid="certificates"),
+            SAMPLE_RECORD,
+            headers=self.headers
+        )
 
     @classmethod
     def get_app_settings(cls, extras=None):
@@ -143,14 +159,17 @@ def get_app_settings(cls, extras=None):
         return settings
 
     def test_changeset_exists_for_monitor_changes(self):
-        resp = self.app.head(self.records_uri, headers=self.headers)
+        resp = self.app.head(
+            self.records_uri.format(cid="certificates"),
+            headers=self.headers
+        )
         records_timestamp = int(resp.headers["ETag"].strip('"'))
 
         resp = self.app.get(self.changeset_uri)
         data = resp.json
 
         assert data["timestamp"] == records_timestamp
-        assert len(data["changes"]) == 1
+        assert len(data["changes"]) == 2
         assert data["changes"][0]["collection"] == "certificates"
 
     def test_changeset_redirects_if_since_is_too_old(self):
@@ -161,3 +180,14 @@ def test_changeset_redirects_if_since_is_too_old(self):
             'https://www.kinto-storage.org/v1'
             '/buckets/monitor/collections/changes/records?_expected=42'
         )
+
+    def test_limit_is_supported(self):
+        resp = self.app.get(self.changeset_uri + "&_limit=1", headers=self.headers)
+        assert len(resp.json["changes"]) == 1
+
+    def test_filter_by_collection(self):
+        resp = self.app.get(
+            self.changeset_uri + "&bucket=blocklists&collection=cfr",
+            headers=self.headers
+        )
+        assert len(resp.json["changes"]) == 1