add to device tracing id

[BillCarsonFr]

Type of change

• Technical

Content

Fixes #7708

Adding a tracing id to to-device messages that can be tracked synapse side in order to debug to-device delivery problems.

EA logs on reception updated to match web

received to-device m.room_key from:@sample:localhost:8480 id:b62c9f76-880d-4fbe-b9d7-f9b13c957d8d

EA logs on sending updated to match web

I  Sent to device  type=m.room.encrypted txnid=d99afdf1-b244-478b-bd72-eba892419893 [@eve:localhost:8480/YJQWVBZUWC (msgid 21ba49f2-8be0-440f-9c22-ba6e41a0d83c),@eve:localhost:8480/PMFTXZAUTL (msgid 58cd9624-137a-4c05-b5da-1a9e587364ef),@web:localhost:8481/FJQUOWZCIX (msgid f854cc8e-603f-48d5-953c-1ed1864b91cd)]
I  shareUserDevicesKey() : sendToDevice succeeds after 158 ms

Decorated content from sync:

{
  "content": {
    "algorithm": "m.olm.v1.curve25519-aes-sha2",
    "ciphertext": {
      "gMObR+/4dqL5T4DisRRRYBJpn+OjzFnkyCFOktP6Eyw": {
        "body": "AwogrdbTbG8VCW....slqU",
        "type": 0
      }
    },
    "org.matrix.msgid": "6390a372-fd3c-4f56-b0d5-2f2ce39f2d56",
    "sender_key": "EWnYTm/yIQ1lStSIqO6fdVYvS69OfU2DzrX+q+1d+w8"
  },
  "type": "m.room.encrypted",
  "sender": "@sample:localhost:8480"
}

Exception

Verification to-device events will not be decorated, as they might use content signature that could break other clients (the hash in key.verification.start)

Motivation and context

See element-hq/element-meta#558 (comment)

Screenshots / GIFs

Tests

• Step 1
• Step 2
• Step ...

Tested devices

• Physical
• Emulator

Checklist

• Changes has been tested on an Android device or Android emulator with API 21
• Pull request is based on the develop branch
• Pull request includes a new file under ./changelog.d. See https://github.com/vector-im/element-android/blob/develop/CONTRIBUTING.md#changelog
• You've made a self review of your PR

[sonarcloud]

SonarCloud Quality Gate failed.   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

79.4% Coverage
0.0% Duplication