matrix-org/dendrite

The transaction_id within events is not serialised in many endpoints

Open

#3,000 opened on Mar 6, 2023

View on GitHubContributor guide
 (3 comments) (0 reactions) (0 assignees)Go (658 forks)auto 404
O-FrequentT-Defectgood first issuespec-compliance

Repository metrics

Stars
 (5,632 stars)
PR merge metrics
 (PR metrics pending)

Description

Similar to https://github.com/matrix-org/synapse/issues/15173 in Synapse

There are many endpoints that return events, and in those representations they should include the transaction_id in the unsigned part of the event.

I wrote a Complement test to highlight that Synapse had this issue by testing using the /rooms/{roomId}/event/{eventId} endpoint, and Dendrite also fails on this test. I haven't tested the other endpoints, nor covered them in the Complement test. https://github.com/matrix-org/complement/pull/621

Contributor guide

Research direction
Study the existing Complement test at https://github.com/matrix org/complement/pull/621 to understand the expected behavior. Trace the event serialization code in Dendrite, focusing on the /rooms/{roomId}/event/{eventId} endpoint and other endpoints that return events. Identify where transaction id should be added to the unsigned field and implement the fix across all relevant endpoints.
Tech stack
go
Domain
backend
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GoMatrix event model
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75