From bde8d78b8a19c941cef926d3e480c81555dbe993 Mon Sep 17 00:00:00 2001
From: Mark Haines <mark.haines@matrix.org>
Date: Mon, 30 Nov 2015 17:46:35 +0000
Subject: [PATCH 1/2] Copy rather than move the fields to shuffle between a v1
 and a v2 event.

This should make all v1 APIs compatible with v2 clients. While still
allowing v1 clients to access the fields.

This makes the documentation easier since we can just document the v2
format and explain that some of the fields, in some of the APIs are
duplicated for backwards compatibility, rather than having to document
two separate event formats.
---
 synapse/events/utils.py | 14 +++++---------
 1 file changed, 5 insertions(+), 9 deletions(-)

diff --git a/synapse/events/utils.py b/synapse/events/utils.py
index 44cc1ef13..666df5411 100644
--- a/synapse/events/utils.py
+++ b/synapse/events/utils.py
@@ -100,22 +100,18 @@ def format_event_raw(d):
 
 
 def format_event_for_client_v1(d):
-    d["user_id"] = d.pop("sender", None)
+    d = format_event_for_client_v2(d)
 
-    move_keys = (
+    d["user_id"] = d.get("sender", None)
+
+    copy_keys = (
         "age", "redacted_because", "replaces_state", "prev_content",
         "invite_room_state",
     )
-    for key in move_keys:
+    for key in copy_keys:
         if key in d["unsigned"]:
             d[key] = d["unsigned"][key]
 
-    drop_keys = (
-        "auth_events", "prev_events", "hashes", "signatures", "depth",
-        "unsigned", "origin", "prev_state"
-    )
-    for key in drop_keys:
-        d.pop(key, None)
     return d
 
 

From 306415391dfe1a304738f307440d7bd79fe93972 Mon Sep 17 00:00:00 2001
From: Mark Haines <mark.haines@matrix.org>
Date: Tue, 1 Dec 2015 11:14:48 +0000
Subject: [PATCH 2/2] Only add the user_id if the sender is present

---
 synapse/events/utils.py | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/synapse/events/utils.py b/synapse/events/utils.py
index 666df5411..e634b149b 100644
--- a/synapse/events/utils.py
+++ b/synapse/events/utils.py
@@ -102,7 +102,9 @@ def format_event_raw(d):
 def format_event_for_client_v1(d):
     d = format_event_for_client_v2(d)
 
-    d["user_id"] = d.get("sender", None)
+    sender = d.get("sender")
+    if sender is not None:
+        d["user_id"] = sender
 
     copy_keys = (
         "age", "redacted_because", "replaces_state", "prev_content",