Fix use of enabling/disabling specific filters (#260)

Author: frenck

src/adguardhome/filtering.py

@@ -162,14 +162,28 @@ async def enable_url(self, *, allowlist: bool, url: str) -> None:
         Raises:
             AdGuardHomeError: Failed enabling filter subscription.
         """
+        response = await self._adguard.request("filtering/status")
+        filter_type = "whitelist_filters" if allowlist else "filters"
+
+        # Excluded from coverage:
+        # https://github.com/nedbat/coveragepy/issues/515
+        name = next(  # pragma: no cover
+            (
+                fil["name"]
+                for fil in response[filter_type]
+                if fil["url"].lower() == url.lower()
+            ),
+            "Unknown",
+        )
+
         try:
             await self._adguard.request(
                 "filtering/set_url",
                 method="POST",
                 json_data={
                     "url": url,
                     "whitelist": allowlist,
-                    "data": {"enabled": True},
+                    "data": {"enabled": True, "name": name, "url": url},
                 },
             )
         except AdGuardHomeError as exception:
@@ -187,14 +201,28 @@ async def disable_url(self, *, allowlist: bool, url: str) -> None:
         Raises:
             AdGuardHomeError: Failed disabling filter subscription.
         """
+        response = await self._adguard.request("filtering/status")
+        filter_type = "whitelist_filters" if allowlist else "filters"
+
+        # Excluded from coverage:
+        # https://github.com/nedbat/coveragepy/issues/515
+        name = next(  # pragma: no cover
+            (
+                fil["name"]
+                for fil in response[filter_type]
+                if fil["url"].lower() == url.lower()
+            ),
+            "Unknown",
+        )
+
         try:
             await self._adguard.request(
                 "filtering/set_url",
                 method="POST",
                 json_data={
                     "url": url,
                     "whitelist": allowlist,
-                    "data": {"enabled": False},
+                    "data": {"enabled": False, "name": name, "url": url},
                 },
             )
         except AdGuardHomeError as exception:

tests/test_filtering.py

@@ -323,13 +323,37 @@ async def response_handler(request):
         assert data == {
             "url": "https://example.com/1.txt",
             "whitelist": False,
-            "data": {"enabled": True},
+            "data": {
+                "enabled": True,
+                "url": "https://example.com/1.txt",
+                "name": "test",
+            },
         }
         return aresponses.Response(status=200, text="OK")
 
+    aresponses.add(
+        "example.com:3000",
+        "/control/filtering/status",
+        "GET",
+        aresponses.Response(
+            status=200,
+            headers={"Content-Type": "application/json"},
+            text='{"filters": [{"url": "https://EXAMPLE.com/1.txt", "name": "test"}]}',
+        ),
+    )
     aresponses.add(
         "example.com:3000", "/control/filtering/set_url", "POST", response_handler
     )
+    aresponses.add(
+        "example.com:3000",
+        "/control/filtering/status",
+        "GET",
+        aresponses.Response(
+            status=200,
+            headers={"Content-Type": "application/json"},
+            text='{"filters": [{"url": "https://EXAMPLE.com/1.txt", "name": "test"}]}',
+        ),
+    )
     aresponses.add(
         "example.com:3000",
         "/control/filtering/set_url",
@@ -358,13 +382,37 @@ async def response_handler(request):
         assert data == {
             "url": "https://example.com/1.txt",
             "whitelist": False,
-            "data": {"enabled": False},
+            "data": {
+                "enabled": False,
+                "name": "test",
+                "url": "https://example.com/1.txt",
+            },
         }
         return aresponses.Response(status=200)
 
+    aresponses.add(
+        "example.com:3000",
+        "/control/filtering/status",
+        "GET",
+        aresponses.Response(
+            status=200,
+            headers={"Content-Type": "application/json"},
+            text='{"filters": [{"url": "https://EXAMPLE.com/1.txt", "name": "test"}]}',
+        ),
+    )
     aresponses.add(
         "example.com:3000", "/control/filtering/set_url", "POST", response_handler
     )
+    aresponses.add(
+        "example.com:3000",
+        "/control/filtering/status",
+        "GET",
+        aresponses.Response(
+            status=200,
+            headers={"Content-Type": "application/json"},
+            text='{"filters": [{"url": "https://example.com/1.txt", "name": "test"}]}',
+        ),
+    )
     aresponses.add(
         "example.com:3000",
         "/control/filtering/set_url",