Add support for encoded URLs to RESTful Command (home-assistant#154957)

Co-authored-by: Jan-Philipp Benecke <[email protected]>
Co-authored-by: Martin Hjelmare <[email protected]>

Author: 3 people

homeassistant/components/rest_command/__init__.py

@@ -10,6 +10,7 @@
 import aiohttp
 from aiohttp import hdrs
 import voluptuous as vol
+from yarl import URL
 
 from homeassistant.const import (
     CONF_AUTHENTICATION,
@@ -51,6 +52,7 @@
 
 CONF_CONTENT_TYPE = "content_type"
 CONF_INSECURE_CIPHER = "insecure_cipher"
+CONF_SKIP_URL_ENCODING = "skip_url_encoding"
 
 COMMAND_SCHEMA = vol.Schema(
     {
@@ -69,6 +71,7 @@
         vol.Optional(CONF_CONTENT_TYPE): cv.string,
         vol.Optional(CONF_VERIFY_SSL, default=DEFAULT_VERIFY_SSL): cv.boolean,
         vol.Optional(CONF_INSECURE_CIPHER, default=False): cv.boolean,
+        vol.Optional(CONF_SKIP_URL_ENCODING, default=False): cv.boolean,
     }
 )
 
@@ -113,6 +116,7 @@ def async_register_rest_command(name: str, command_config: dict[str, Any]) -> No
         method = command_config[CONF_METHOD]
 
         template_url = command_config[CONF_URL]
+        skip_url_encoding = command_config[CONF_SKIP_URL_ENCODING]
 
         auth = None
         digest_middleware = None
@@ -179,7 +183,7 @@ async def async_service_handler(service: ServiceCall) -> ServiceResponse:
                     request_kwargs["middlewares"] = (digest_middleware,)
 
                 async with getattr(websession, method)(
-                    request_url,
+                    URL(request_url, encoded=skip_url_encoding),
                     **request_kwargs,
                 ) as response:
                     if response.status < HTTPStatus.BAD_REQUEST:

tests/components/rest_command/test_init.py

@@ -6,6 +6,7 @@
 
 import aiohttp
 import pytest
+from yarl import URL
 
 from homeassistant.components.rest_command import DOMAIN
 from homeassistant.const import (
@@ -455,3 +456,34 @@ async def test_rest_command_response_iter_chunked(
 
         # Verify iter_chunked was called with a chunk size
         assert mock_iter_chunked.called
+
+
+async def test_rest_command_skip_url_encoding(
+    hass: HomeAssistant,
+    setup_component: ComponentSetup,
+    aioclient_mock: AiohttpClientMocker,
+) -> None:
+    """Check URL encoding."""
+    config = {
+        "skip_url_encoding_test": {
+            "url": "0%2C",
+            "method": "get",
+            "skip_url_encoding": True,
+        },
+        "with_url_encoding_test": {
+            "url": "1,",
+            "method": "get",
+        },
+    }
+
+    await setup_component(config)
+
+    aioclient_mock.get(URL("0%2C", encoded=True), content=b"success")
+    aioclient_mock.get(URL("1,"), content=b"success")
+
+    await hass.services.async_call(DOMAIN, "skip_url_encoding_test", {}, blocking=True)
+    await hass.services.async_call(DOMAIN, "with_url_encoding_test", {}, blocking=True)
+
+    assert len(aioclient_mock.mock_calls) == 2
+    assert str(aioclient_mock.mock_calls[0][1]) == "0%2C"
+    assert str(aioclient_mock.mock_calls[1][1]) == "1,"

tests/test_util/aiohttp.py

@@ -221,8 +221,8 @@ def match_request(self, method, url, params=None):
 
         if (
             self._url.scheme != url.scheme
-            or self._url.host != url.host
-            or self._url.path != url.path
+            or self._url.raw_host != url.raw_host
+            or self._url.raw_path != url.raw_path
         ):
             return False