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
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
|
#
# This file is licensed under the Affero General Public License (AGPL) version 3.
#
# Copyright 2021 The Matrix.org Foundation C.I.C.
# Copyright (C) 2023 New Vector, Ltd
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as
# published by the Free Software Foundation, either version 3 of the
# License, or (at your option) any later version.
#
# See the GNU Affero General Public License for more details:
# <https://www.gnu.org/licenses/agpl-3.0.html>.
#
# Originally licensed under the Apache License, Version 2.0:
# <http://www.apache.org/licenses/LICENSE-2.0>.
#
# [This file includes modifications made by New Vector Limited]
#
#
from unittest.mock import patch
from twisted.internet import defer
from twisted.internet.testing import MemoryReactor
from synapse.rest import admin
from synapse.rest.client import devices
from synapse.server import HomeServer
from synapse.storage.databases.main.deviceinbox import (
DEVICE_FEDERATION_INBOX_CLEANUP_DELAY,
)
from synapse.util.clock import Clock
from tests.unittest import HomeserverTestCase
class DeviceInboxBackgroundUpdateStoreTestCase(HomeserverTestCase):
servlets = [
admin.register_servlets,
devices.register_servlets,
]
def prepare(self, reactor: MemoryReactor, clock: Clock, hs: HomeServer) -> None:
self.store = hs.get_datastores().main
self.user_id = self.register_user("foo", "pass")
def test_background_remove_deleted_devices_from_device_inbox(self) -> None:
"""Test that the background task to delete old device_inboxes works properly."""
# create a valid device
self.get_success(
self.store.store_device(self.user_id, "cur_device", "display_name")
)
# Add device_inbox to devices
self.get_success(
self.store.db_pool.simple_insert(
"device_inbox",
{
"user_id": self.user_id,
"device_id": "cur_device",
"stream_id": 1,
"message_json": "{}",
},
)
)
self.get_success(
self.store.db_pool.simple_insert(
"device_inbox",
{
"user_id": self.user_id,
"device_id": "old_device",
"stream_id": 2,
"message_json": "{}",
},
)
)
# Insert and run the background update.
self.get_success(
self.store.db_pool.simple_insert(
"background_updates",
{
"update_name": "remove_dead_devices_from_device_inbox",
"progress_json": "{}",
},
)
)
# ... and tell the DataStore that it hasn't finished all updates yet
self.store.db_pool.updates._all_done = False
self.wait_for_background_updates()
# Make sure the background task deleted old device_inbox
res = self.get_success(
self.store.db_pool.simple_select_onecol(
table="device_inbox",
keyvalues={},
retcol="device_id",
desc="get_device_id_from_device_inbox",
)
)
self.assertEqual(1, len(res))
self.assertEqual(res[0], "cur_device")
def test_background_remove_hidden_devices_from_device_inbox(self) -> None:
"""Test that the background task to delete hidden devices
from device_inboxes works properly."""
# create a valid device
self.get_success(
self.store.store_device(self.user_id, "cur_device", "display_name")
)
# create a hidden device
self.get_success(
self.store.db_pool.simple_insert(
"devices",
values={
"user_id": self.user_id,
"device_id": "hidden_device",
"display_name": "hidden_display_name",
"hidden": True,
},
)
)
# Add device_inbox to devices
self.get_success(
self.store.db_pool.simple_insert(
"device_inbox",
{
"user_id": self.user_id,
"device_id": "cur_device",
"stream_id": 1,
"message_json": "{}",
},
)
)
self.get_success(
self.store.db_pool.simple_insert(
"device_inbox",
{
"user_id": self.user_id,
"device_id": "hidden_device",
"stream_id": 2,
"message_json": "{}",
},
)
)
# Insert and run the background update.
self.get_success(
self.store.db_pool.simple_insert(
"background_updates",
{
"update_name": "remove_dead_devices_from_device_inbox",
"progress_json": "{}",
},
)
)
# ... and tell the DataStore that it hasn't finished all updates yet
self.store.db_pool.updates._all_done = False
self.wait_for_background_updates()
# Make sure the background task deleted hidden devices from device_inbox
res = self.get_success(
self.store.db_pool.simple_select_onecol(
table="device_inbox",
keyvalues={},
retcol="device_id",
desc="get_device_id_from_device_inbox",
)
)
self.assertEqual(1, len(res))
self.assertEqual(res[0], "cur_device")
class DeviceInboxFederationInboxCleanupTestCase(HomeserverTestCase):
servlets = [
admin.register_servlets,
devices.register_servlets,
]
def prepare(self, reactor: MemoryReactor, clock: Clock, hs: HomeServer) -> None:
self.store = hs.get_datastores().main
self.db_pool = self.store.db_pool
# Advance time to ensure we are past the cleanup delay
self.reactor.advance(DEVICE_FEDERATION_INBOX_CLEANUP_DELAY.as_secs() * 2)
def test_delete_old_federation_inbox_rows_skips_if_no_index(self) -> None:
"""Test that we don't delete rows if the index hasn't been created yet."""
# Insert some test data into device_federation_inbox
for i in range(5):
self.get_success(
self.db_pool.simple_insert(
"device_federation_inbox",
{
"origin": "example.com",
"message_id": f"msg_{i}",
"received_ts": 0,
},
)
)
# Mock to report the update as not completed
with patch(
"synapse.storage.background_updates.BackgroundUpdater.has_completed_background_update"
) as mock:
mock.return_value = False
self.get_success(self.store._delete_old_federation_inbox_rows())
# Check that no rows were deleted
rows = self.get_success(
self.db_pool.simple_select_list(
"device_federation_inbox",
keyvalues={},
retcols=["origin", "message_id", "received_ts"],
)
)
self.assertEqual(
len(rows), 5, "Expected no rows to be deleted when index is missing"
)
def test_delete_old_federation_inbox_rows(self) -> None:
"""Test that old rows are deleted from device_federation_inbox."""
# Insert old messages
for i in range(5):
self.get_success(
self.db_pool.simple_insert(
"device_federation_inbox",
{
"origin": "old.example.com",
"message_id": f"old_msg_{i}",
"received_ts": self.clock.time_msec(),
},
)
)
self.reactor.advance(2 * DEVICE_FEDERATION_INBOX_CLEANUP_DELAY.as_secs())
# Insert new messages
for i in range(5):
self.get_success(
self.db_pool.simple_insert(
"device_federation_inbox",
{
"origin": "new.example.com",
"message_id": f"new_msg_{i}",
"received_ts": self.clock.time_msec(),
},
)
)
# Run the cleanup
self.get_success(self.store._delete_old_federation_inbox_rows())
# Check that only old messages were deleted
rows = self.get_success(
self.db_pool.simple_select_onecol(
"device_federation_inbox",
keyvalues={},
retcol="origin",
)
)
self.assertEqual(len(rows), 5, "Expected only 5 new messages to remain")
for origin in rows:
self.assertEqual(origin, "new.example.com")
def test_delete_old_federation_inbox_rows_batch_limit(self) -> None:
"""Test that the deletion happens in batches."""
# Insert 10 old messages (more than the 5 batch limit)
for i in range(10):
self.get_success(
self.db_pool.simple_insert(
"device_federation_inbox",
{
"origin": "old.example.com",
"message_id": f"old_msg_{i}",
"received_ts": self.clock.time_msec(),
},
)
)
# Advance time to ensure we are past the cleanup delay
self.reactor.advance(2 * DEVICE_FEDERATION_INBOX_CLEANUP_DELAY.as_millis())
# Run the cleanup - it should delete in batches and sleep between them
deferred = defer.ensureDeferred(
self.store._delete_old_federation_inbox_rows(batch_size=5)
)
# Check that the deferred doesn't resolve immediately
self.assertFalse(deferred.called)
# Advance the reactor to allow the cleanup to continue and complete
self.reactor.advance(2)
self.get_success(deferred)
# Check that all messages were deleted after multiple batches
rows = self.get_success(
self.db_pool.simple_select_list(
"device_federation_inbox",
keyvalues={},
retcols=["origin", "message_id"],
)
)
self.assertEqual(
len(rows),
0,
"Expected all messages to be deleted after multiple batches",
)
|
