[62077] Fix adding a tracking object to an existing draft (nylas#153)

mrashed-dev · web-flow · commit 41b27d0832f6 · 2021-06-11T15:05:15.000-04:00
The Python SDK creates a special payload specifically for sending an already-existing `draft` object that extracts the draft ID and the draft's version and sends that as a payload. However, it does not check if a tracking object exists, and thus if a user were to save a draft, and come add a tracking object to it (or if the user saves the draft with the tracking object first) and tries to send it after the save, the SDK never sends the tracking object in the payload. This PR adds a check to add a tracking object if present in the `draft`.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,7 @@ Unreleased (dev)
 ----------------
 * Add `metadata` field in the Event model to support new event metadata feature
 * Add filtering support for `metadata_pair`
+* Fix adding a tracking object to an existing `draft`
 
 v4.12.1
 -------
diff --git a/nylas/client/restful_models.py b/nylas/client/restful_models.py
@@ -460,6 +460,8 @@ def send(self):
             data = {"draft_id": self.id}
             if hasattr(self, "version"):
                 data["version"] = self.version
+            if hasattr(self, "tracking") and self.tracking is not None:
+                data["tracking"] = self.tracking
 
         msg = self.api._create_resource(Send, data)
         if msg:
diff --git a/tests/conftest.py b/tests/conftest.py
@@ -703,6 +703,21 @@ def callback(request):
     )
 
 
+@pytest.fixture
+def mock_draft_send_unsaved_response(mocked_responses, api_url):
+    def callback(request):
+        payload = json.loads(request.body)
+        payload["draft_id"] = "2h111aefv8pzwzfykrn7hercj"
+        return 200, {}, json.dumps(payload)
+
+    mocked_responses.add_callback(
+        responses.POST,
+        api_url + "/send/",
+        callback=callback,
+        content_type="application/json",
+    )
+
+
 @pytest.fixture
 def mock_files(mocked_responses, api_url, account_id):
     files_content = {"3qfe4k3siosfjtjpfdnon8zbn": b"Hello, World!"}
diff --git a/tests/test_drafts.py b/tests/test_drafts.py
@@ -1,3 +1,4 @@
+import json
 from datetime import datetime
 
 import pytest
@@ -35,6 +36,43 @@ def test_save_send_draft(api_client):
         draft.send()
 
 
+@pytest.mark.usefixtures("mock_draft_saved_response", "mock_draft_sent_response")
+def test_save_send_draft_with_tracking(mocked_responses, api_client):
+    tracking = {
+        "links": "true",
+        "opens": "true",
+        "thread_replies": "true",
+        "payload": "new-payload",
+    }
+    draft = api_client.drafts.create()
+    draft.to = [{"name": "My Friend", "email": "my.friend@example.com"}]
+    draft.subject = "Here's an attachment"
+    draft.body = "Cheers mate!"
+    draft.save()
+
+    draft.tracking = tracking
+    draft.save()
+    assert draft.tracking == tracking
+
+    draft.send()
+    send_payload = json.loads(mocked_responses.calls[-1].request.body)
+    assert send_payload["tracking"] == tracking
+
+
+@pytest.mark.usefixtures("mock_draft_send_unsaved_response")
+def test_send_draft_with_tracking(mocked_responses, api_client):
+    tracking = {"opens": "true", "payload": "payload"}
+    draft = api_client.drafts.create()
+    draft.to = [{"name": "My Friend", "email": "my.friend@example.com"}]
+    draft.subject = "Newsletter"
+    draft.body = "Our latest sale!"
+    draft.tracking = tracking
+    draft.send()
+
+    send_payload = json.loads(mocked_responses.calls[-1].request.body)
+    assert send_payload["tracking"] == tracking
+
+
 @pytest.mark.usefixtures("mock_files")
 def test_draft_attachment(api_client):
     draft = api_client.drafts.create()
