dendrite/roomserver
Till d58daf9665
Update sentry reporting (#3305)
This hopefully reduces the garbage we currently produce.
(Using [GlitchTip](https://glitchtip.com/) on my personal instance, this
seems to look better)
2024-01-24 19:24:04 +01:00
..
acls Update ACLs when received as outliers (#3008) 2023-11-22 15:38:04 +01:00
api Optimize PrevEventIDs when getting thousands of backwards extremeties (#3308) 2024-01-20 22:26:57 +01:00
auth Update gmsl to use new validated RoomID on PDUs (#3200) 2023-09-15 14:39:06 +00:00
internal Update sentry reporting (#3305) 2024-01-24 19:24:04 +01:00
producers Update ACLs when received as outliers (#3008) 2023-11-22 15:38:04 +01:00
state Check event is not rejected (#3243) 2023-10-25 09:47:21 +02:00
storage Fix panic if unable to assign a state key NID (#3294) 2023-12-30 18:34:36 +01:00
types de-MSC-ifying space summaries (MSC2946) (#3134) 2023-07-20 15:06:05 +01:00
version Add config key for default room version (#3171) 2023-08-08 14:20:05 +01:00
README.md use go module for dependencies (#594) 2019-05-21 21:56:55 +01:00
roomserver_test.go Use AckExplicitPolicy instead of AckAllPolicy (#3288) 2023-12-19 08:25:47 +01:00
roomserver.go de-MSC-ifying space summaries (MSC2946) (#3134) 2023-07-20 15:06:05 +01:00

RoomServer

RoomServer Internals

Numeric IDs

To save space matrix string identifiers are mapped to local numeric IDs. The numeric IDs are more efficient to manipulate and use less space to store. The numeric IDs are never exposed in the API the room server exposes. The numeric IDs are converted to string IDs before they leave the room server. The numeric ID for a string ID is never 0 to avoid being confused with go's default zero value. Zero is used to indicate that there was no corresponding string ID. Well-known event types and event state keys are preassigned numeric IDs.

State Snapshot Storage

The room server stores the state of the matrix room at each event. For efficiency the state is stored as blocks of 3-tuples of numeric IDs for the event type, event state key and event ID. For further efficiency the state snapshots are stored as the combination of up to 64 these blocks. This allows blocks of the room state to be reused in multiple snapshots.

The resulting database tables look something like this:

+-------------------------------------------------------------------+
| Events                                                            |
+---------+-------------------+------------------+------------------+
| EventNID| EventTypeNID      | EventStateKeyNID | StateSnapshotNID |
+---------+-------------------+------------------+------------------+
|       1 | m.room.create   1 | ""             1 | <nil>          0 |
|       2 | m.room.member   2 | "@user:foo"    2 | <nil>          0 |
|       3 | m.room.member   2 | "@user:bar"    3 | {1,2}          1 |
|       4 | m.room.message  3 | <nil>          0 | {1,2,3}        2 |
|       5 | m.room.member   2 | "@user:foo"    2 | {1,2,3}        2 |
|       6 | m.room.message  3 | <nil>          0 | {1,3,6}        3 |
+---------+-------------------+------------------+------------------+

+----------------------------------------+
| State Snapshots                        |
+-----------------------+----------------+
| EventStateSnapshotNID | StateBlockNIDs |
+-----------------------+----------------|
|                     1 |           {1}  |
|                     2 |         {1,2}  |
|                     3 |       {1,2,3}  |
+-----------------------+----------------+

+-----------------------------------------------------------------+
| State Blocks                                                    |
+---------------+-------------------+------------------+----------+
| StateBlockNID | EventTypeNID      | EventStateKeyNID | EventNID |
+---------------+-------------------+------------------+----------+
|             1 | m.room.create   1 | ""             1 |        1 |
|             1 | m.room.member   2 | "@user:foo"    2 |        2 |
|             2 | m.room.member   2 | "@user:bar"    3 |        3 |
|             3 | m.room.member   2 | "@user:foo"    2 |        6 |
+---------------+-------------------+------------------+----------+