synapse/changelog.d
Eric Eastwood fef2e792be
Fix historical messages backfilling in random order on remote homeservers (MSC2716) (#11114)
Fix https://github.com/matrix-org/synapse/issues/11091
Fix https://github.com/matrix-org/synapse/issues/10764 (side-stepping the issue because we no longer have to deal with `fake_prev_event_id`)

 1. Made the `/backfill` response return messages in `(depth, stream_ordering)` order (previously only sorted by `depth`)
    - Technically, it shouldn't really matter how `/backfill` returns things but I'm just trying to make the `stream_ordering` a little more consistent from the origin to the remote homeservers in order to get the order of messages from `/messages` consistent ([sorted by `(topological_ordering, stream_ordering)`](https://github.com/matrix-org/synapse/blob/develop/docs/development/room-dag-concepts.md#depth-and-stream-ordering)).
    - Even now that we return backfilled messages in order, it still doesn't guarantee the same `stream_ordering` (and more importantly the [`/messages` order](https://github.com/matrix-org/synapse/blob/develop/docs/development/room-dag-concepts.md#depth-and-stream-ordering)) on the other server. For example, if a room has a bunch of history imported and someone visits a permalink to a historical message back in time, their homeserver will skip over the historical messages in between and insert the permalink as the next message in the `stream_order` and totally throw off the sort.
       - This will be even more the case when we add the [MSC3030 jump to date API endpoint](https://github.com/matrix-org/matrix-doc/pull/3030) so the static archives can navigate and jump to a certain date.
       - We're solving this in the future by switching to [online topological ordering](https://github.com/matrix-org/gomatrixserverlib/issues/187) and [chunking](https://github.com/matrix-org/synapse/issues/3785) which by its nature will apply retroactively to fix any inconsistencies introduced by people permalinking
 2. As we're navigating `prev_events` to return in `/backfill`, we order by `depth` first (newest -> oldest) and now also tie-break based on the `stream_ordering` (newest -> oldest). This is technically important because MSC2716 inserts a bunch of historical messages at the same `depth` so it's best to be prescriptive about which ones we should process first. In reality, I think the code already looped over the historical messages as expected because the database is already in order.
 3. Making the historical state chain and historical event chain float on their own by having no `prev_events` instead of a fake `prev_event` which caused backfill to get clogged with an unresolvable event. Fixes https://github.com/matrix-org/synapse/issues/11091 and https://github.com/matrix-org/synapse/issues/10764
 4. We no longer find connected insertion events by finding a potential `prev_event` connection to the current event we're iterating over. We now solely rely on marker events which when processed, add the insertion event as an extremity and the federating homeserver can ask about it when time calls.
    - Related discussion, https://github.com/matrix-org/synapse/pull/11114#discussion_r741514793


Before | After
--- | ---
![](https://user-images.githubusercontent.com/558581/139218681-b465c862-5c49-4702-a59e-466733b0cf45.png) | ![](https://user-images.githubusercontent.com/558581/146453159-a1609e0a-8324-439d-ae44-e4bce43ac6d1.png)



#### Why aren't we sorting topologically when receiving backfill events?

> The main reason we're going to opt to not sort topologically when receiving backfill events is because it's probably best to do whatever is easiest to make it just work. People will probably have opinions once they look at [MSC2716](https://github.com/matrix-org/matrix-doc/pull/2716) which could change whatever implementation anyway.
> 
> As mentioned, ideally we would do this but code necessary to make the fake edges but it gets confusing and gives an impression of “just whyyyy” (feels icky). This problem also dissolves with online topological ordering.
>
> -- https://github.com/matrix-org/synapse/pull/11114#discussion_r741517138

See https://github.com/matrix-org/synapse/pull/11114#discussion_r739610091 for the technical difficulties
2022-02-07 15:54:13 -06:00
..
.gitignore Correct attrs package name in requirements (#3492) 2018-07-07 10:46:59 +10:00
11114.bugfix Fix historical messages backfilling in random order on remote homeservers (MSC2716) (#11114) 2022-02-07 15:54:13 -06:00
11215.feature Send to-device messages to application services (#11215) 2022-02-01 14:13:38 +00:00
11615.misc Allow specifying the application service-specific user_id parameter in the join test helper. (#11616) 2022-02-03 13:09:22 +00:00
11616.misc Allow specifying the application service-specific user_id parameter in the join test helper. (#11616) 2022-02-03 13:09:22 +00:00
11655.feature Add a background database update to purge account data for deactivated users. (#11655) 2022-02-02 11:37:18 +00:00
11832.misc Fix type errors introduced by new annotations in the Prometheus Client library. (#11832) 2022-02-02 16:51:00 +00:00
11859.doc Fix typo: unpind -> unbind (#11859) 2022-02-03 17:20:44 +00:00
11862.doc Clarify that users' media are also preview images (#11862) 2022-02-04 14:39:14 +00:00
11867.feature Stabilise MSC3231 (Token Based Registration) (#11867) 2022-02-04 12:15:13 +00:00
11868.feature Allow modules to retrieve server and worker names (#11868) 2022-02-01 16:23:55 +01:00
11869.misc Fixes for opentracing scopes (#11869) 2022-02-02 22:41:57 +00:00
11870.misc Improve opentracing for federation requests (#11870) 2022-02-03 12:29:16 +00:00
11876.misc Describe prune_unread_entries in docstrings (#11876) 2022-02-02 15:11:23 +00:00
11878.misc Invalidate the get_users_in_room{_with_profile} caches only when necessary. (#11878) 2022-02-02 12:24:07 -05:00
11880.misc Convert ApplicationServiceTestCase to use simple_async_mock (#11880) 2022-02-01 17:45:13 +00:00
11884.misc Revert experimental push rules from #7997. (#11884) 2022-02-02 09:49:31 -05:00
11888.misc Disable coverage calculation for olddeps build. (#11888) 2022-02-02 15:59:33 +00:00
11890.bugfix Fix losing incoming EDUs if debug logging enabled (#11890) 2022-02-02 16:25:17 +00:00
11892.feature Add a ratelimiter for 3pid invite (#11892) 2022-02-03 14:28:15 +01:00
11895.removal Remove support for the webclient listener. (#11895) 2022-02-03 18:36:49 +00:00
11907.doc Delete MSC1711_certificates_FAQ.md (#11907) 2022-02-04 11:27:00 +00:00
11909.misc Add a unit test for users receiving their own device list updates (#11909) 2022-02-07 13:21:19 +00:00
11910.misc Run Complement tests sequentially (#11910) 2022-02-04 13:04:57 +00:00
11911.misc Remove optional state of ApplicationService.is_interested's store parameter (#11911) 2022-02-07 18:26:42 +00:00
11914.misc Clean up an indirect reference to the homeserver datastore (#11914) 2022-02-07 13:25:09 +00:00
11927.misc Pass the proper type when uploading files. (#11927) 2022-02-07 10:06:52 -05:00