Add AP ID to outbound Diaspora payloads

Add ActivityPub ID to outbound Diaspora payloads of types comment, post and profile,
      if an URL given as `id`.

CHANGELOG.md

@@ -27,6 +27,8 @@
     * Extract Diaspora guid from ActivityPub payloads implementing the Diaspora extension.
     * Add Diaspora extension and guid to outbound ActivityPub payloads, if available. For
       profiles, also add handle.
+    * Add ActivityPub ID to outbound Diaspora payloads of types comment, post and profile, 
+      if an URL given as `id`.
 
 ### Changed
 

federation/entities/diaspora/entities.py

@@ -13,7 +13,7 @@ class DiasporaComment(DiasporaRelayableMixin, Comment):
 
     def to_xml(self):
         element = etree.Element(self._tag_name)
-        struct_to_xml(element, [
+        properties = [
             {"guid": self.guid},
             {"parent_guid": self.root_target_guid or self.target_guid},
             {"thread_parent_guid": self.target_guid},
@@ -22,7 +22,12 @@ class DiasporaComment(DiasporaRelayableMixin, Comment):
             {"text": self.raw_content},
             {"author": self.handle},
             {"created_at": format_dt(self.created_at)},
-        ])
+        ]
+        if self.id and self.id.startswith("http"):
+            properties.append({
+                "activitypub_id": self.id,
+            })
+        struct_to_xml(element, properties)
         return element
 
 
@@ -37,14 +42,19 @@ class DiasporaPost(DiasporaEntityMixin, Post):
     def to_xml(self):
         """Convert to XML message."""
         element = etree.Element(self._tag_name)
-        struct_to_xml(element, [
+        properties = [
             {"text": self.raw_content},
             {"guid": self.guid},
             {"author": self.handle},
             {"public": "true" if self.public else "false"},
             {"created_at": format_dt(self.created_at)},
             {"provider_display_name": self.provider_display_name},
-        ])
+        ]
+        if self.id and self.id.startswith("http"):
+            properties.append({
+                "activitypub_id": self.id,
+            })
+        struct_to_xml(element, properties)
         return element
 
 
@@ -101,7 +111,7 @@ class DiasporaProfile(DiasporaEntityMixin, Profile):
     def to_xml(self):
         """Convert to XML message."""
         element = etree.Element(self._tag_name)
-        struct_to_xml(element, [
+        properties = [
             {"author": self.handle},
             {"first_name": self.name},
             {"last_name": ""},  # We only have one field - splitting it would be artificial
@@ -114,7 +124,12 @@ class DiasporaProfile(DiasporaEntityMixin, Profile):
             {"searchable": "true" if self.public else "false"},
             {"nsfw": "true" if self.nsfw else "false"},
             {"tag_string": " ".join(["#%s" % tag for tag in self.tag_list])},
-        ])
+        ]
+        if self.id and self.id.startswith("http"):
+            properties.append({
+                "activitypub_id": self.id,
+            })
+        struct_to_xml(element, properties)
         return element
 
 

federation/tests/entities/diaspora/test_entities.py

@@ -21,6 +21,17 @@ class TestEntitiesConvertToXML:
                     b"</created_at><provider_display_name>Socialhome</provider_display_name></status_message>"
         assert etree.tostring(result) == converted
 
+    def test_post_to_xml__with_activitypub_id(self, diasporapost_activitypub_id):
+        result = diasporapost_activitypub_id.to_xml()
+        assert result.tag == "status_message"
+        assert len(result.find("created_at").text) > 0
+        result.find("created_at").text = ""  # timestamp makes testing painful
+        converted = b"<status_message><text>raw_content</text><guid>guid</guid>" \
+                    b"<author>alice@example.com</author><public>true</public><created_at>" \
+                    b"</created_at><provider_display_name>Socialhome</provider_display_name>" \
+                    b"<activitypub_id>https://domain.tld/id</activitypub_id></status_message>"
+        assert etree.tostring(result) == converted
+
     def test_comment_to_xml(self, diasporacomment):
         result = diasporacomment.to_xml()
         assert result.tag == "comment"
@@ -33,6 +44,18 @@ class TestEntitiesConvertToXML:
                     b"<created_at></created_at></comment>"
         assert etree.tostring(result) == converted
 
+    def test_comment_to_xml__with_activitypub_id(self, diasporacomment_activitypub_id):
+        result = diasporacomment_activitypub_id.to_xml()
+        assert result.tag == "comment"
+        assert len(result.find("created_at").text) > 0
+        result.find("created_at").text = ""  # timestamp makes testing painful
+        converted = b"<comment><guid>guid</guid><parent_guid>target_guid</parent_guid>" \
+                    b"<thread_parent_guid>target_guid</thread_parent_guid>" \
+                    b"<author_signature>signature</author_signature><parent_author_signature>" \
+                    b"</parent_author_signature><text>raw_content</text><author>alice@example.com</author>" \
+                    b"<created_at></created_at><activitypub_id>https://domain.tld/id</activitypub_id></comment>"
+        assert etree.tostring(result) == converted
+
     def test_nested_comment_to_xml(self, diasporanestedcomment):
         result = diasporanestedcomment.to_xml()
         assert result.tag == "comment"
@@ -64,6 +87,17 @@ class TestEntitiesConvertToXML:
                     b"<nsfw>false</nsfw><tag_string>#socialfederation #federation</tag_string></profile>"
         assert etree.tostring(result) == converted
 
+    def test_profile_to_xml__with_activitypub_id(self, diasporaprofile_activitypub_id):
+        result = diasporaprofile_activitypub_id.to_xml()
+        assert result.tag == "profile"
+        converted = b"<profile><author>alice@example.com</author>" \
+                    b"<first_name>Bob Bobertson</first_name><last_name></last_name><image_url>urllarge</image_url>" \
+                    b"<image_url_small>urlsmall</image_url_small><image_url_medium>urlmedium</image_url_medium>" \
+                    b"<gender></gender><bio>foobar</bio><location></location><searchable>true</searchable>" \
+                    b"<nsfw>false</nsfw><tag_string>#socialfederation #federation</tag_string>" \
+                    b"<activitypub_id>http://example.com/alice</activitypub_id></profile>"
+        assert etree.tostring(result) == converted
+
     def test_retraction_to_xml(self, diasporaretraction):
         result = diasporaretraction.to_xml()
         assert result.tag == "retraction"

federation/tests/fixtures/entities.py

@@ -253,6 +253,20 @@ def diasporacomment():
     )
 
 
+@pytest.fixture
+def diasporacomment_activitypub_id():
+    return DiasporaComment(
+        raw_content="raw_content",
+        signature="signature",
+        id="https://domain.tld/id",
+        guid="guid",
+        actor_id="alice@example.com",
+        handle="alice@example.com",
+        target_id="target_guid",
+        target_guid="target_guid",
+    )
+
+
 @pytest.fixture
 def diasporanestedcomment():
     return DiasporaComment(
@@ -306,6 +320,19 @@ def diasporapost():
     )
 
 
+@pytest.fixture
+def diasporapost_activitypub_id():
+    return DiasporaPost(
+        raw_content="raw_content",
+        public=True,
+        provider_display_name="Socialhome",
+        id="https://domain.tld/id",
+        guid="guid",
+        actor_id="alice@example.com",
+        handle="alice@example.com",
+    )
+
+
 @pytest.fixture
 def diasporaprofile():
     return DiasporaProfile(
@@ -319,6 +346,19 @@ def diasporaprofile():
     )
 
 
+@pytest.fixture
+def diasporaprofile_activitypub_id():
+    return DiasporaProfile(
+        raw_content="foobar", name="Bob Bobertson", public=True,
+        tag_list=["socialfederation", "federation"], image_urls={
+            "large": "urllarge", "medium": "urlmedium", "small": "urlsmall"
+        },
+        id="http://example.com/alice",
+        handle="alice@example.com",
+        guid="guid",
+    )
+
+
 @pytest.fixture
 def diasporareshare():
     base_entity = ShareFactory()