Remove `MockClock()` #18992

MadLittleMods · 2025-09-29T22:27:52Z

Remove MockClock()

Spawning from adding some logcontext debug logs in #18966 and since we're not logging at the set_current_context(...) level (see reasoning there), this removes some usage of set_current_context(...).

Specifically, MockClock.call_later(...) doesn't handle logcontexts correctly. It uses the calling logcontext as the callback context (wrong, as the logcontext could finish before the callback finishes) and it didn't reset back to the sentinel context before handing back to the reactor. It was like this since it was introduced 10+ years ago. Instead of fixing the implementation which would just be a copy of our normal Clock, we can just remove MockClock

synapse/tests/utils.py

Lines 284 to 300 in 84e1d15

    
           def call_later( 
        
               self, 
        
               delay: float, 
        
               callback: Callable[P, object], 
        
               *args: P.args, 
        
               **kwargs: P.kwargs, 
        
           ) -> Timer: 
        
               ctx = current_context() 
        
               def wrapped_callback() -> None: 
        
                   set_current_context(ctx) 
        
                   callback(*args, **kwargs) 
        
               t = Timer(self.now + delay, wrapped_callback, False) 
        
               self.timers.append(t) 
        
               return t

Pull Request Checklist

Pull request is based on the develop branch
Pull request includes a changelog file. The entry should:
- Be a short description of your change which makes sense to users. "Fixed a bug that prevented receiving messages from other servers." instead of "Moved X method from EventStore to EventWorkerStore.".
- Use markdown where necessary, mostly for code blocks.
- End with either a period (.) or an exclamation mark (!).
- Start with a capital letter.
- Feel free to credit yourself, by adding a sentence "Contributed by @github_username." or "Contributed by [Your Name]." to the end of the entry.
Code style is correct (run the linters)

`Clock` is the wrapper utilities around the `reactor`

MadLittleMods · 2025-09-29T22:34:26Z

tests/handlers/test_e2e_room_keys.py


 class E2eRoomKeysHandlerTestCase(unittest.HomeserverTestCase):
    def make_homeserver(self, reactor: MemoryReactor, clock: Clock) -> HomeServer:
-        return self.setup_test_homeserver(replication_layer=mock.Mock())


Since I was dealing with setup_test_homeserver so much, I noticed this unused mock

MadLittleMods · 2025-09-29T22:37:20Z

tests/server.py

+        extra_homeserver_attributes["clock"] = Clock(reactor, server_name=server_name)

-    if "clock" not in kwargs:
-        kwargs["clock"] = MockClock()


Refactoring away MockClock

Making all of these arguments way more clear to follow.

MadLittleMods · 2025-09-29T22:38:34Z

tests/unittest.py

            synapse.server.HomeServer
        """
-        kwargs = dict(kwargs)
-        kwargs.update(self._hs_args)


Made this more straight-forward by removing the self._hs_args and generic kwargs concept in favor of direct keyword-args.

anoadragon453 · 2025-09-30T11:37:18Z

tests/unittest.py

+logger = logging.getLogger(__name__)
+


Left-over from debugging?

Suggested change

logger = logging.getLogger(__name__)

Do we really care about getting rid of these? I always leave them around because it's annoying to re-add them later and our linting doesn't complain about them being unused.

Merging but happy to remove in a follow-up when you reply

MadLittleMods · 2025-09-30T16:27:50Z

Thanks for the review @anoadragon453 🐣

@frastefanini

Deployments that make use of the [synapse-s3-storage-provider](https://github.com/matrix-org/synapse-s3-storage-provider) module must upgrade to [v1.6.0](https://github.com/matrix-org/synapse-s3-storage-provider/releases/tag/v1.6.0). Using older versions of the module with this release of Synapse will prevent users from being able to upload or download media. No significant changes since 1.140.0rc1. - Add [a new Media Query by ID Admin API](https://element-hq.github.io/synapse/v1.140/admin_api/media_admin_api.html#query-a-piece-of-media-by-id) that allows server admins to query and investigate the metadata of local or cached remote media via the `origin/media_id` identifier found in a [Matrix Content URI](https://spec.matrix.org/v1.14/client-server-api/#matrix-content-mxc-uris). ([\element-hq#18911](element-hq#18911)) - Add [a new Fetch Event Admin API](https://element-hq.github.io/synapse/v1.140/admin_api/fetch_event.html) to fetch an event by ID. ([\element-hq#18963](element-hq#18963)) - Update [MSC4284: Policy Servers](matrix-org/matrix-spec-proposals#4284) implementation to support signatures when available. ([\element-hq#18934](element-hq#18934)) - Add experimental implementation of the `GET /_matrix/client/v1/rtc/transports` endpoint for the latest draft of [MSC4143: MatrixRTC](matrix-org/matrix-spec-proposals#4143). ([\element-hq#18967](element-hq#18967)) - Expose a `defer_to_threadpool` function in the Synapse Module API that allows modules to run a function on a separate thread in a custom threadpool. ([\element-hq#19032](element-hq#19032)) - Fix room upgrade `room_config` argument and documentation for `user_may_create_room` spam-checker callback. ([\element-hq#18721](element-hq#18721)) - Compute a user's last seen timestamp from their devices' last seen timestamps instead of IPs, because the latter are automatically cleared according to `user_ips_max_age`. ([\element-hq#18948](element-hq#18948)) - Fix bug where ephemeral events were not filtered by room ID. Contributed by @frastefanini. ([\element-hq#19002](element-hq#19002)) - Update Synapse main process version string to include git info. ([\element-hq#19011](element-hq#19011)) - Explain how `Deferred` callbacks interact with logcontexts. ([\element-hq#18914](element-hq#18914)) - Fix documentation for `rc_room_creation` and `rc_reports` to clarify that a `per_user` rate limit is not supported. ([\element-hq#18998](element-hq#18998)) - Remove deprecated `LoggingContext.set_current_context`/`LoggingContext.current_context` methods which already have equivalent bare methods in `synapse.logging.context`. ([\element-hq#18989](element-hq#18989)) - Drop support for unstable field names from the long-accepted [MSC2732](matrix-org/matrix-spec-proposals#2732) (Olm fallback keys) proposal. ([\element-hq#18996](element-hq#18996)) - Cleanly shutdown `SynapseHomeServer` object, allowing artifacts of embedded small hosts to be properly garbage collected. ([\element-hq#18828](element-hq#18828)) - Update OEmbed providers to use 'X' instead of 'Twitter' in URL previews, following a rebrand. Contributed by @HammyHavoc. ([\element-hq#18767](element-hq#18767)) - Fix `server_name` in logging context for multiple Synapse instances in one process. ([\element-hq#18868](element-hq#18868)) - Wrap the Rust HTTP client with `make_deferred_yieldable` so it follows Synapse logcontext rules. ([\element-hq#18903](element-hq#18903)) - Fix the GitHub Actions workflow that moves issues labeled "X-Needs-Info" to the "Needs info" column on the team's internal triage board. ([\element-hq#18913](element-hq#18913)) - Disconnect background process work from request trace. ([\element-hq#18932](element-hq#18932)) - Reduce overall number of calls to `_get_e2e_cross_signing_signatures_for_devices` by increasing the batch size of devices the query is called with, reducing DB load. ([\element-hq#18939](element-hq#18939)) - Update error code used when an appservice tries to masquerade as an unknown device using [MSC4326](matrix-org/matrix-spec-proposals#4326). Contributed by @tulir @ Beeper. ([\element-hq#18947](element-hq#18947)) - Fix `no active span when trying to log` tracing error on startup (when OpenTracing is enabled). ([\element-hq#18959](element-hq#18959)) - Fix `run_coroutine_in_background(...)` incorrectly handling logcontext. ([\element-hq#18964](element-hq#18964)) - Add debug logs wherever we change current logcontext. ([\element-hq#18966](element-hq#18966)) - Update dockerfile metadata to fix broken link; point to documentation website. ([\element-hq#18971](element-hq#18971)) - Note that the code is additionally licensed under the [Element Commercial license](https://github.com/element-hq/synapse/blob/develop/LICENSE-COMMERCIAL) in SPDX expression field configs. ([\element-hq#18973](element-hq#18973)) - Fix logcontext handling in `timeout_deferred` tests. ([\element-hq#18974](element-hq#18974)) - Remove internal `ReplicationUploadKeysForUserRestServlet` as a follow-up to the work in element-hq#18581 that moved device changes off the main process. ([\element-hq#18988](element-hq#18988)) - Switch task scheduler from raw logcontext manipulation to using the dedicated logcontext utils. ([\element-hq#18990](element-hq#18990)) - Remove `MockClock()` in tests. ([\element-hq#18992](element-hq#18992)) - Switch back to our own custom `LogContextScopeManager` instead of OpenTracing's `ContextVarsScopeManager` which was causing problems when using the experimental `SYNAPSE_ASYNC_IO_REACTOR` option with tracing enabled. ([\element-hq#19007](element-hq#19007)) - Remove `version_string` argument from `HomeServer` since it's always the same. ([\element-hq#19012](element-hq#19012)) - Remove duplicate call to `hs.start_background_tasks()` introduced from a bad merge. ([\element-hq#19013](element-hq#19013)) - Split homeserver creation (`create_homeserver`) and setup (`setup`). ([\element-hq#19015](element-hq#19015)) - Swap near-end-of-life `macos-13` GitHub Actions runner for the `macos-15-intel` variant. ([\element-hq#19025](element-hq#19025)) - Introduce `RootConfig.validate_config()` which can be subclassed in `HomeServerConfig` to do cross-config class validation. ([\element-hq#19027](element-hq#19027)) - Allow any command of the `release.py` script to accept a `--gh-token` argument. ([\element-hq#19035](element-hq#19035)) * Bump Swatinem/rust-cache from 2.8.0 to 2.8.1. ([\element-hq#18949](element-hq#18949)) * Bump actions/cache from 4.2.4 to 4.3.0. ([\element-hq#18983](element-hq#18983)) * Bump anyhow from 1.0.99 to 1.0.100. ([\element-hq#18950](element-hq#18950)) * Bump authlib from 1.6.3 to 1.6.4. ([\element-hq#18957](element-hq#18957)) * Bump authlib from 1.6.4 to 1.6.5. ([\element-hq#19019](element-hq#19019)) * Bump bcrypt from 4.3.0 to 5.0.0. ([\element-hq#18984](element-hq#18984)) * Bump docker/login-action from 3.5.0 to 3.6.0. ([\element-hq#18978](element-hq#18978)) * Bump lxml from 6.0.0 to 6.0.2. ([\element-hq#18979](element-hq#18979)) * Bump phonenumbers from 9.0.13 to 9.0.14. ([\element-hq#18954](element-hq#18954)) * Bump phonenumbers from 9.0.14 to 9.0.15. ([\element-hq#18991](element-hq#18991)) * Bump prometheus-client from 0.22.1 to 0.23.1. ([\element-hq#19016](element-hq#19016)) * Bump pydantic from 2.11.9 to 2.11.10. ([\element-hq#19017](element-hq#19017)) * Bump pygithub from 2.7.0 to 2.8.1. ([\element-hq#18952](element-hq#18952)) * Bump regex from 1.11.2 to 1.11.3. ([\element-hq#18981](element-hq#18981)) * Bump serde from 1.0.224 to 1.0.226. ([\element-hq#18953](element-hq#18953)) * Bump serde from 1.0.226 to 1.0.228. ([\element-hq#18982](element-hq#18982)) * Bump setuptools-rust from 1.11.1 to 1.12.0. ([\element-hq#18980](element-hq#18980)) * Bump twine from 6.1.0 to 6.2.0. ([\element-hq#18985](element-hq#18985)) * Bump types-pyyaml from 6.0.12.20250809 to 6.0.12.20250915. ([\element-hq#19018](element-hq#19018)) * Bump types-requests from 2.32.4.20250809 to 2.32.4.20250913. ([\element-hq#18951](element-hq#18951)) * Bump typing-extensions from 4.14.1 to 4.15.0. ([\element-hq#18956](element-hq#18956))

MadLittleMods added 13 commits September 29, 2025 15:25

Better clarify what name is used for

66d3ec7

Improve docstring

13d64b6

Keyword only setup_test_homeserver args

f1c2b80

This is what we call the reactor

127d89c

`Clock` is the wrapper utilities around the `reactor`

Clean up reactor/clock creation in test homeservers

6e7bde6

Use same reactor/clock as test utilities

859864c

Better keywords pattern

de40ac3

Fix lints with homeserver creation

38d266f

Fix config lints

ed224df

Remove unused mock

af6dbad

Remove MockClock() usage

f51f54b

Remove MockClock

c224fdf

Add changelog

e80d0d9

MadLittleMods commented Sep 29, 2025

View reviewed changes

Align kwargs name

e400b69

MadLittleMods force-pushed the madlittlemods/remove-mock-clock branch from cdc20d1 to e400b69 Compare September 29, 2025 22:39

MadLittleMods added A-Logging A-Testing labels Sep 29, 2025

Fix lookup pattern

d247544

MadLittleMods marked this pull request as ready for review September 29, 2025 23:25

MadLittleMods requested a review from a team as a code owner September 29, 2025 23:25

anoadragon453 approved these changes Sep 30, 2025

View reviewed changes

MadLittleMods merged commit 5adb08f into develop Sep 30, 2025
107 of 112 checks passed

MadLittleMods deleted the madlittlemods/remove-mock-clock branch September 30, 2025 16:27

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Remove `MockClock()` #18992

Remove `MockClock()` #18992

Uh oh!

MadLittleMods commented Sep 29, 2025 •

edited by anoadragon453

Loading

Uh oh!

MadLittleMods Sep 29, 2025

Uh oh!

MadLittleMods Sep 29, 2025

Uh oh!

MadLittleMods Sep 29, 2025

Uh oh!

anoadragon453 Sep 30, 2025

Uh oh!

MadLittleMods Sep 30, 2025

Uh oh!

MadLittleMods Sep 30, 2025

Uh oh!

Uh oh!

MadLittleMods commented Sep 30, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

	def call_later(
	self,
	delay: float,
	callback: Callable[P, object],
	*args: P.args,
	**kwargs: P.kwargs,
	) -> Timer:
	ctx = current_context()

	def wrapped_callback() -> None:
	set_current_context(ctx)
	callback(args, *kwargs)

	t = Timer(self.now + delay, wrapped_callback, False)
	self.timers.append(t)

	return t

Remove MockClock() #18992

Remove MockClock() #18992

Uh oh!

Conversation

MadLittleMods commented Sep 29, 2025 • edited by anoadragon453 Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pull Request Checklist

Uh oh!

MadLittleMods Sep 29, 2025

Choose a reason for hiding this comment

Uh oh!

MadLittleMods Sep 29, 2025

Choose a reason for hiding this comment

Uh oh!

MadLittleMods Sep 29, 2025

Choose a reason for hiding this comment

Uh oh!

anoadragon453 Sep 30, 2025

Choose a reason for hiding this comment

Uh oh!

MadLittleMods Sep 30, 2025

Choose a reason for hiding this comment

Uh oh!

MadLittleMods Sep 30, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

MadLittleMods commented Sep 30, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Remove `MockClock()` #18992

Remove `MockClock()` #18992

MadLittleMods commented Sep 29, 2025 •

edited by anoadragon453

Loading