1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
|
#! /usr/bin/env python
import argparse
import logging
import sys
from collections import defaultdict
from graphlib import TopologicalSorter
from pprint import pformat
from typing import (
Awaitable,
Callable,
Collection,
Dict,
Optional,
Sequence,
Tuple,
cast,
)
from unittest.mock import MagicMock, patch
import dictdiffer
import pydot
import yaml
from twisted.internet import task
from synapse.config._base import RootConfig
from synapse.config.cache import CacheConfig
from synapse.config.database import DatabaseConfig
from synapse.config.workers import WorkerConfig
from synapse.events import EventBase
from synapse.server import HomeServer
from synapse.state import StateResolutionStore
from synapse.storage.databases.main.event_federation import EventFederationWorkerStore
from synapse.storage.databases.main.events_worker import EventsWorkerStore
from synapse.storage.databases.main.room import RoomWorkerStore
from synapse.storage.databases.main.state import StateGroupWorkerStore
from synapse.storage.state import StateFilter
from synapse.types import ISynapseReactor, StateMap
logger = logging.getLogger(sys.argv[0])
class Config(RootConfig):
config_classes = [DatabaseConfig, WorkerConfig, CacheConfig]
def load_config(source: str) -> Config:
data = yaml.safe_load(source)
data["worker_name"] = "stateres-debug"
config = Config()
config.parse_config_dict(data, "DUMMYPATH", "DUMMYPATH")
config.key = MagicMock() # Don't bother creating signing keys
return config
class DataStore(
StateGroupWorkerStore,
EventFederationWorkerStore,
EventsWorkerStore,
RoomWorkerStore,
):
pass
class MockHomeserver(HomeServer):
DATASTORE_CLASS = DataStore # type: ignore [assignment]
def __init__(self, config: Config):
super(MockHomeserver, self).__init__(
hostname="stateres-debug",
config=config, # type: ignore[arg-type]
)
def node(
event: EventBase, suffix: Optional[str] = None, **kwargs: object
) -> pydot.Node:
label = f"{event.event_id}\n{event.type}"
if suffix:
label += f"\n{suffix}"
kwargs.setdefault("label", label)
type_to_shape = {"m.room.member": "oval"}
if event.type in type_to_shape:
kwargs.setdefault("shape", type_to_shape[event.type])
q = pydot.quote_if_necessary
return pydot.Node(q(event.event_id), **kwargs)
def edge(source: EventBase, target: EventBase, **kwargs: object) -> pydot.Edge:
return pydot.Edge(
pydot.quote_if_necessary(source.event_id),
pydot.quote_if_necessary(target.event_id),
**kwargs,
)
async def dump_mainlines(
hs: MockHomeserver,
starting_event: EventBase,
watch_func: Optional[Callable[[EventBase], Awaitable[str]]] = None,
extras: Collection[EventBase] = (),
) -> None:
graph = pydot.Dot(rankdir="BT")
graph.set_node_defaults(shape="box", style="filled")
async def new_node(event: EventBase, **kwargs: object) -> pydot.Node:
suffix = await watch_func(event) if watch_func else None
return node(event, suffix, **kwargs)
graph.add_node(await new_node(starting_event, fillcolor="#6699cc"))
seen = {starting_event.event_id}
todo = []
for extra in extras:
graph.add_node(await new_node(extra, fillcolor="#cc9966"))
seen.add(extra.event_id)
todo.append(extra)
for pid in starting_event.prev_event_ids():
parent = await hs.get_datastores().main.get_event(pid)
graph.add_node(await new_node(parent, fillcolor="#6699cc"))
seen.add(pid)
graph.add_edge(edge(starting_event, parent, style="dashed"))
todo.append(parent)
while todo:
event = todo.pop()
auth_events = {
(e.type, e.state_key): e
for e in (
await hs.get_datastores().main.get_events(event.auth_event_ids())
).values()
}
for key, style in [
(("m.room.power_levels", ""), "dashed"),
(("m.room.join_rules", ""), "dashed"),
(("m.room.member", event.sender), "dotted"),
]:
auth_event = auth_events.get(key)
if auth_event:
if auth_event.event_id not in seen:
if key[0] == "m.room.power_levels":
graph.add_node(await new_node(auth_event, fillcolor="#ffcccc"))
else:
graph.add_node(await new_node(auth_event))
seen.add(auth_event.event_id)
todo.append(auth_event)
graph.add_edge(edge(event, auth_event), style=style)
graph.write_raw("mainlines.dot")
graph.write_svg("mainlines.svg")
parser = argparse.ArgumentParser(
description="Debug the stateres calculation of a specific event."
)
parser.add_argument(
"config_file", help="Synapse config file", type=argparse.FileType("r")
)
parser.add_argument("--verbose", "-v", help="Log verbosely", action="store_true")
parser.add_argument(
"--debug", "-d", help="Enter debugger after state is resolved", action="store_true"
)
parser.add_argument("event_id", help="The event ID to be resolved")
parser.add_argument(
"--watch",
help="Track a piece of state in the auth DAG",
default=None,
nargs=2,
metavar=("TYPE", "STATE_KEY"),
)
async def debug_specific_stateres(
reactor: ISynapseReactor, hs: MockHomeserver, args: argparse.Namespace
) -> None:
# Fetch the event in question.
event = await hs.get_datastores().main.get_event(args.event_id)
assert event is not None
logger.info(
"event %s has %d parents, %s",
event.event_id,
len(event.prev_event_ids()),
event.prev_event_ids(),
)
state_after_parents = [
await hs.get_storage_controllers().state.get_state_ids_for_event(prev_event_id)
for prev_event_id in event.prev_event_ids()
]
if args.watch is not None:
key_pair = cast(Tuple[str, str], tuple(args.watch))
filter = StateFilter.from_types([key_pair])
watch_func: Optional[Callable[[EventBase], Awaitable[str]]]
async def watch_func(event: EventBase) -> str:
result = await hs.get_storage_controllers().state.get_state_ids_for_event(
event.event_id, filter
)
return f"{key_pair}: {result.get(key_pair, '<Missing>')}"
else:
watch_func = None
await dump_mainlines(hs, event, watch_func)
result = await hs.get_state_resolution_handler().resolve_events_with_store(
event.room_id,
event.room_version.identifier,
state_after_parents,
event_map=None,
state_res_store=StateResolutionStore(hs.get_datastores().main),
)
logger.info("State resolved at %s:", event.event_id)
logger.info(pformat(result))
logger.info("Stored state at %s:", event.event_id)
stored_state = await hs.get_storage_controllers().state.get_state_ids_for_event(
event.event_id
)
logger.info(pformat(stored_state))
logger.info("Diff from stored to resolved:")
for change in dictdiffer.diff(stored_state, result):
logger.info(pformat(change))
if args.debug:
print(
f"see state_after_parents[i] for i in range({len(state_after_parents)})"
" and result",
file=sys.stderr,
)
breakpoint()
if __name__ == "__main__":
args = parser.parse_args()
logging.basicConfig(
format="%(asctime)s %(name)s:%(lineno)d %(levelname)s %(message)s",
level=logging.DEBUG if args.verbose else logging.INFO,
stream=sys.stdout,
)
logging.getLogger("synapse.util").setLevel(logging.ERROR)
logging.getLogger("synapse.storage").setLevel(logging.ERROR)
config = load_config(args.config_file)
hs = MockHomeserver(config)
with patch("synapse.storage.databases.prepare_database"), patch(
"synapse.storage.database.BackgroundUpdater"
), patch("synapse.storage.databases.main.events_worker.MultiWriterIdGenerator"):
hs.setup()
task.react(debug_specific_stateres, [hs, parser.parse_args()])
|
