From aea9eb7996d7088a3675c434a718a9085aea6849 Mon Sep 17 00:00:00 2001
From: Steven Looman <steven.looman@gmail.com>
Date: Sun, 1 Sep 2024 16:53:25 +0200
Subject: [PATCH] Add proper XML preamble in server communication (#243)

---
 async_upnp_client/server.py                    | 10 ++++------
 changes/243.bugfix                             |  1 +
 tests/fixtures/server/action_response.xml      |  1 +
 tests/fixtures/server/device.xml               |  1 +
 tests/fixtures/server/subscribe_response_0.xml |  2 +-
 tests/fixtures/server/subscribe_response_1.xml |  2 +-
 6 files changed, 9 insertions(+), 8 deletions(-)
 create mode 100644 changes/243.bugfix

diff --git a/async_upnp_client/server.py b/async_upnp_client/server.py
index a0acbee2..c4edea34 100644
--- a/async_upnp_client/server.py
+++ b/async_upnp_client/server.py
@@ -394,9 +394,7 @@ async def async_send_events(
                 continue
             prop_el = ET.SubElement(event_el, "e:property")
             ET.SubElement(prop_el, state_var.name).text = str(state_var.value)
-        message = (
-            '<?xml version="1.0"?>\n' + ET.tostring(event_el, encoding="utf-8").decode()
-        )
+        message = ET.tostring(event_el, encoding="utf-8", xml_declaration=True).decode()
 
         headers = {
             "CONTENT-TYPE": 'text/xml; charset="utf-8"',
@@ -1128,7 +1126,7 @@ def _create_action_response(
     return Response(
         content_type="text/xml",
         charset="utf-8",
-        body=ET.tostring(envelope_el, encoding="utf-8"),
+        body=ET.tostring(envelope_el, encoding="utf-8", xml_declaration=True),
     )
 
 
@@ -1163,7 +1161,7 @@ def _create_error_action_response(
         status=500,
         content_type="text/xml",
         charset="utf-8",
-        body=ET.tostring(envelope_el, encoding="utf-8"),
+        body=ET.tostring(envelope_el, encoding="utf-8", xml_declaration=True),
     )
 
 
@@ -1243,7 +1241,7 @@ async def to_xml(
     serializer = UpnpXmlSerializer()
     thing_el = serializer.to_xml(thing)
     encoding = "utf-8"
-    thing_xml = ET.tostring(thing_el, encoding=encoding)
+    thing_xml = ET.tostring(thing_el, encoding=encoding, xml_declaration=True)
     return Response(content_type="text/xml", charset=encoding, body=thing_xml)
 
 
diff --git a/changes/243.bugfix b/changes/243.bugfix
new file mode 100644
index 00000000..8256a3d4
--- /dev/null
+++ b/changes/243.bugfix
@@ -0,0 +1 @@
+Add proper XML preamble in server communication.
diff --git a/tests/fixtures/server/action_response.xml b/tests/fixtures/server/action_response.xml
index f9a6ce6a..fe968b42 100644
--- a/tests/fixtures/server/action_response.xml
+++ b/tests/fixtures/server/action_response.xml
@@ -1 +1,2 @@
+<?xml version='1.0' encoding='utf-8'?>
 <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/" s:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"><s:Body><st:SetValuesResponse xmlns:st="urn:schemas-upnp-org:service:TestServerService:1"><TestVariable_str>foo</TestVariable_str><EventableTextVariable_ui4>0</EventableTextVariable_ui4></st:SetValuesResponse></s:Body></s:Envelope>
diff --git a/tests/fixtures/server/device.xml b/tests/fixtures/server/device.xml
index c058732b..6600fce1 100644
--- a/tests/fixtures/server/device.xml
+++ b/tests/fixtures/server/device.xml
@@ -1 +1,2 @@
+<?xml version='1.0' encoding='utf-8'?>
 <root xmlns="urn:schemas-upnp-org:device-1-0"><specVersion><major>1</major><minor>0</minor></specVersion><device xmlns="urn:schemas-upnp-org:device-1-0"><deviceType>:urn:schemas-upnp-org:device:TestServerDevice:1</deviceType><friendlyName>Test Server</friendlyName><manufacturer>Test</manufacturer><manufacturerURL /><modelDescription>Test Server</modelDescription><modelName>TestServer</modelName><modelNumber>v0.0.1</modelNumber><modelURL /><serialNumber>0000001</serialNumber><UDN>uuid:adca2e25-cbe4-427a-a5c3-9b5931e7b79b</UDN><UPC /><presentationURL /><iconList /><serviceList><service><serviceType>urn:schemas-upnp-org:service:TestServerService:1</serviceType><serviceId>urn:upnp-org:serviceId:TestServerService</serviceId><controlURL>/upnp/control/TestServerService</controlURL><eventSubURL>/upnp/event/TestServerService</eventSubURL><SCPDURL>/ContentDirectory.xml</SCPDURL></service></serviceList><deviceList /></device></root>
diff --git a/tests/fixtures/server/subscribe_response_0.xml b/tests/fixtures/server/subscribe_response_0.xml
index c4b52e7f..663d9850 100644
--- a/tests/fixtures/server/subscribe_response_0.xml
+++ b/tests/fixtures/server/subscribe_response_0.xml
@@ -1,2 +1,2 @@
-<?xml version="1.0"?>
+<?xml version='1.0' encoding='utf-8'?>
 <e:propertyset xmlns:e="urn:schemas-upnp-org:event-1-0"><e:property><EventableTextVariable_ui4>0</EventableTextVariable_ui4></e:property></e:propertyset>
diff --git a/tests/fixtures/server/subscribe_response_1.xml b/tests/fixtures/server/subscribe_response_1.xml
index 6cec63d3..4203394e 100644
--- a/tests/fixtures/server/subscribe_response_1.xml
+++ b/tests/fixtures/server/subscribe_response_1.xml
@@ -1,2 +1,2 @@
-<?xml version="1.0"?>
+<?xml version='1.0' encoding='utf-8'?>
 <e:propertyset xmlns:e="urn:schemas-upnp-org:event-1-0"><e:property><EventableTextVariable_ui4>1</EventableTextVariable_ui4></e:property></e:propertyset>