Add support for filters query params in 'purge_history()'

Author: leplatrem

README.rst

@@ -421,7 +421,7 @@ The history of a bucket can also be purged with:
 
 .. code-block:: python
 
-    client.purge_history(bucket='default')
+    client.purge_history(bucket='default', _before='"1743671651423"', user_id="account:fulanito")
 
 
 Attachments

src/kinto_http/client.py

@@ -878,11 +878,11 @@ def get_history(self, *, bucket=None, **kwargs) -> List[Dict]:
         return self._paginated(endpoint, **kwargs)
 
     @retry_timeout
-    def purge_history(self, *, bucket=None, safe=True, if_match=None) -> List[Dict]:
+    def purge_history(self, *, bucket=None, safe=True, if_match=None, **kwargs) -> List[Dict]:
         endpoint = self._get_endpoint("history", bucket=bucket)
         headers = self._get_cache_headers(safe, if_match=if_match)
         logger.info("Purge History of bucket %r" % bucket or self.bucket_name)
-        resp, _ = self.session.request("delete", endpoint, headers=headers)
+        resp, _ = self.session.request("delete", endpoint, headers=headers, params=kwargs)
         return resp["data"]
 
     @retry_timeout

tests/test_async_client.py

@@ -1237,4 +1237,19 @@ async def test_purging_of_history(async_client_setup: Client):
     mock_response(client.session)
     await client.purge_history(bucket="mybucket")
     url = "/buckets/mybucket/history"
-    client.session.request.assert_called_with("delete", url, headers=None)
+    client.session.request.assert_called_with("delete", url, headers=None, params={})
+
+
+async def test_purging_of_history_with_params(async_client_setup: Client):
+    client = async_client_setup
+    mock_response(client.session)
+    await client.purge_history(
+        bucket="mybucket", user_id="plugin:remote-settings", _before='"1337"'
+    )
+    url = "/buckets/mybucket/history"
+    client.session.request.assert_called_with(
+        "delete",
+        url,
+        headers=None,
+        params={"user_id": "plugin:remote-settings", "_before": '"1337"'},
+    )

tests/test_client.py

@@ -1393,7 +1393,20 @@ def test_purging_of_history(client_setup: Client):
     mock_response(client.session)
     client.purge_history(bucket="mybucket")
     url = "/buckets/mybucket/history"
-    client.session.request.assert_called_with("delete", url, headers=None)
+    client.session.request.assert_called_with("delete", url, headers=None, params={})
+
+
+def test_purging_of_history_with_params(client_setup: Client):
+    client = client_setup
+    mock_response(client.session)
+    client.purge_history(bucket="mybucket", user_id="plugin:remote-settings", _before='"1337"')
+    url = "/buckets/mybucket/history"
+    client.session.request.assert_called_with(
+        "delete",
+        url,
+        headers=None,
+        params={"user_id": "plugin:remote-settings", "_before": '"1337"'},
+    )
 
 
 def test_download_attachment(client_setup: Client, mocker: MockerFixture):