Add CI job to act as a canary for testing against latest dependencies #12472

DMRobertson · 2022-04-14T10:25:23Z

Our old CI used to be this canary on every job. Now we are using poetry, we'll be using locked versions everywhere and so won't see problems coming from fresh pip install matrix-synapse[all] installations. Introduce this new job to try and cover that gap.

Based on the twisted trunk job. Runs an hour before the Twisted trunk job does.

Not fully sure if mypy is appropriate here, see comments in the diff.

Useful for matrix-org/synapse#12472.

DMRobertson · 2022-04-14T13:02:33Z

See https://github.com/matrix-org/synapse/actions/runs/2167191795 for the new CI jobs running against 5b2ddcc. These succeeded.

The sytest failures failed in actions/checkout@v2 with what I can only assume is a flake.

.github/workflows/latest_deps.yml

clokep · 2022-04-14T19:03:18Z

I'm a little confused -- what does this have to do with wheels? As far as I can tell it is just trying to test against the latest releases of other packages, which may or may not be wheels?

DMRobertson · 2022-04-14T23:52:07Z

I'm a little confused -- what does this have to do with wheels? As far as I can tell it is just trying to test against the latest releases of other packages, which may or may not be wheels?

Maybe wheels is a poor choice of phrasing on my part. I have in mind completely fresh installations: people running pip install matrix-synapse for the very first time. They'll end up grabbing broad dependencies based on the metadata in whatever version of Synapse they download (be it a wheel or sdist). When they do so, pip will install the latest version of each dependency (subject to the constraints we specify). In contrast, people running our debian image, docker container or using our poetry lockfile will use the pinned/locked version.

My anxiety here is that without a CI job like this which pulls in the latest dependencies, we'll miss incompatibilities that affect fresh installations.

Does that make sense? (You're right that the "wheel" is irrelevant: pip installing from sdist or from source would also pull in the latest version of all deps.

clokep · 2022-04-15T11:23:53Z

My anxiety here is that without a CI job like this which pulls in the latest dependencies, we'll miss incompatibilities that affect fresh installations.

Yes, that makes perfect sense! 👍 I renamed the PR, hopefully it still makes sense!

.github/workflows/latest_deps.yml

Co-authored-by: Patrick Cloke <[email protected]>

We want to modify the package versions in poetry's venv

because otherwise we're not going to get upper bounds and exclusions from pyproject.toml

DMRobertson · 2022-04-19T18:35:31Z

@clokep I ended up giving this one a rethink, after I realised that the initial approach we talked about here would ignore any upper bounds we placed on our broad dependencies. There was a lot of trial-and-error so the commit history is a mess. I'm happy to tidy up and submit a new PR if things have become too unwieldy.

.github/workflows/latest_deps.yml

Co-authored-by: Patrick Cloke <[email protected]>

.github/workflows/latest_deps.yml

clokep · 2022-04-19T18:49:36Z

.github/workflows/latest_deps.yml

+      - uses: actions/setup-python@v2
+        with:
+          python-version: "3.x"
+      - run: pip install -e .[all,test]


I see a bunch of:

Using legacy 'setup.py install' for jaeger-client, since package 'wheel' is not installed.

Should we be installing wheel first in the environment? (Is this just copied from somewhere else?)

I didn't copy this, but I also can't see anywhere that we manually installed wheel before.

It'd be nice to have for (hopefully) quicker CI, but I don't think I want to get stuck into that right now.

Co-authored-by: Patrick Cloke <[email protected]>

@Bubu

Synapse 1.58.0rc1 (2022-04-26) ============================== As of this release, the groups/communities feature in Synapse is now disabled by default. See [\#11584](matrix-org/synapse#11584) for details. As mentioned in [the upgrade notes](https://github.com/matrix-org/synapse/blob/develop/docs/upgrade.md#upgrading-to-v1580), this feature will be removed in Synapse 1.61. Features -------- - Implement [MSC3383](matrix-org/matrix-spec-proposals#3383) for including the destination in server-to-server authentication headers. Contributed by @Bubu and @jcgruenhage for Famedly. ([\#11398](matrix-org/synapse#11398)) - Docker images and Debian packages from matrix.org now contain a locked set of Python dependencies, greatly improving build reproducibility. ([Board](https://github.com/orgs/matrix-org/projects/54), [\#11537](matrix-org/synapse#11537)) - Enable processing of device list updates asynchronously. ([\#12365](matrix-org/synapse#12365), [\#12465](matrix-org/synapse#12465)) - Implement [MSC2815](matrix-org/matrix-spec-proposals#2815) to allow room moderators to view redacted event content. Contributed by @tulir. ([\#12427](matrix-org/synapse#12427)) - Build Debian packages for Ubuntu 22.04 "Jammy Jellyfish". ([\#12543](matrix-org/synapse#12543)) Bugfixes -------- - Prevent a sync request from removing a user's busy presence status. ([\#12213](matrix-org/synapse#12213)) - Fix bug with incremental sync missing events when rejoining/backfilling. Contributed by Nick @ Beeper. ([\#12319](matrix-org/synapse#12319)) - Fix a long-standing bug which incorrectly caused `GET /_matrix/client/v3/rooms/{roomId}/event/{eventId}` to return edited events rather than the original. ([\#12476](matrix-org/synapse#12476)) - Fix a bug introduced in Synapse 1.27.0 where the admin API for [deleting forward extremities](https://github.com/matrix-org/synapse/blob/erikj/fix_delete_event_response_count/docs/admin_api/rooms.md#deleting-forward-extremities) would always return a count of 1, no matter how many extremities were deleted. ([\#12496](matrix-org/synapse#12496)) - Fix a long-standing bug where the image thumbnails embedded into email notifications were broken. ([\#12510](matrix-org/synapse#12510)) - Fix a bug in the implementation of [MSC3202](matrix-org/matrix-spec-proposals#3202) where Synapse would use the field name `device_unused_fallback_keys`, rather than `device_unused_fallback_key_types`. ([\#12520](matrix-org/synapse#12520)) - Fix a bug introduced in Synapse 0.99.3 which could cause Synapse to consume large amounts of RAM when back-paginating in a large room. ([\#12522](matrix-org/synapse#12522)) Improved Documentation ---------------------- - Fix rendering of the documentation site when using the 'print' feature. ([\#12340](matrix-org/synapse#12340)) - Add a manual documenting config file options. ([\#12368](matrix-org/synapse#12368), [\#12527](matrix-org/synapse#12527)) - Update documentation to reflect that both the `run_background_tasks_on` option and the options for moving stream writers off of the main process are no longer experimental. ([\#12451](matrix-org/synapse#12451)) - Update worker documentation and replace old `federation_reader` with `generic_worker`. ([\#12457](matrix-org/synapse#12457)) - Strongly recommend [Poetry](https://python-poetry.org/) for development. ([\#12475](matrix-org/synapse#12475)) - Add some example configurations for workers and update architectural diagram. ([\#12492](matrix-org/synapse#12492)) - Fix a broken link in `README.rst`. ([\#12495](matrix-org/synapse#12495)) - Add HAProxy delegation example with CORS headers to docs. ([\#12501](matrix-org/synapse#12501)) - Remove extraneous comma in User Admin API's device deletion section so that the example JSON is actually valid and works. Contributed by @olmari. ([\#12533](matrix-org/synapse#12533)) Deprecations and Removals ------------------------- - The groups/communities feature in Synapse is now disabled by default. ([\#12344](matrix-org/synapse#12344)) - Remove unstable identifiers from [MSC3440](matrix-org/matrix-spec-proposals#3440). ([\#12382](matrix-org/synapse#12382)) Internal Changes ---------------- - Preparation for faster-room-join work: start a background process to resynchronise the room state after a room join. ([\#12394](matrix-org/synapse#12394)) - Preparation for faster-room-join work: Implement a tracking mechanism to allow functions to wait for full room state to arrive. ([\#12399](matrix-org/synapse#12399)) - Remove an unstable identifier from [MSC3083](matrix-org/matrix-spec-proposals#3083). ([\#12395](matrix-org/synapse#12395)) - Run CI in the locked [Poetry](https://python-poetry.org/) environment, and remove corresponding `tox` jobs. ([\#12425](matrix-org/synapse#12425), [\#12434](matrix-org/synapse#12434), [\#12438](matrix-org/synapse#12438), [\#12441](matrix-org/synapse#12441), [\#12449](matrix-org/synapse#12449), [\#12478](matrix-org/synapse#12478), [\#12514](matrix-org/synapse#12514), [\#12472](matrix-org/synapse#12472)) - Change Mutual Rooms' `unstable_features` flag to `uk.half-shot.msc2666.mutual_rooms` which matches the current iteration of [MSC2666](matrix-org/matrix-spec-proposals#2666). ([\#12445](matrix-org/synapse#12445)) - Fix typo in the release script help string. ([\#12450](matrix-org/synapse#12450)) - Fix a minor typo in the Debian changelogs generated by the release script. ([\#12497](matrix-org/synapse#12497)) - Reintroduce the list of targets to the linter script, to avoid linting unwanted local-only directories during development. ([\#12455](matrix-org/synapse#12455)) - Limit length of `device_id` to less than 512 characters. ([\#12454](matrix-org/synapse#12454)) - Dockerfile-workers: reduce the amount we install in the image. ([\#12464](matrix-org/synapse#12464)) - Dockerfile-workers: give the master its own log config. ([\#12466](matrix-org/synapse#12466)) - complement-synapse-workers: factor out separate entry point script. ([\#12467](matrix-org/synapse#12467)) - Back out experimental implementation of [MSC2314](matrix-org/matrix-spec-proposals#2314). ([\#12474](matrix-org/synapse#12474)) - Fix grammatical error in federation error response when the room version of a room is unknown. ([\#12483](matrix-org/synapse#12483)) - Remove unnecessary configuration overrides in tests. ([\#12511](matrix-org/synapse#12511)) - Refactor the relations code for clarity. ([\#12519](matrix-org/synapse#12519)) - Add type hints so `docker` and `stubs` directories pass `mypy --disallow-untyped-defs`. ([\#12528](matrix-org/synapse#12528)) - Update `delay_cancellation` to accept any awaitable, rather than just `Deferred`s. ([\#12468](matrix-org/synapse#12468)) - Handle cancellation in `EventsWorkerStore._get_events_from_cache_or_db`. ([\#12529](matrix-org/synapse#12529))

@Bubu

Synapse 1.58.0 (2022-05-03) =========================== As of this release, the groups/communities feature in Synapse is now disabled by default. See [\#11584](matrix-org/synapse#11584) for details. As mentioned in [the upgrade notes](https://github.com/matrix-org/synapse/blob/develop/docs/upgrade.md#upgrading-to-v1580), this feature will be removed in Synapse 1.61. No significant changes since 1.58.0rc2. Synapse 1.58.0rc2 (2022-04-26) ============================== This release candidate fixes bugs related to Synapse 1.58.0rc1's logic for handling device list updates. Bugfixes -------- - Fix a bug introduced in Synapse 1.58.0rc1 where the main process could consume excessive amounts of CPU and memory while handling sentry logging failures. ([\#12554](matrix-org/synapse#12554)) - Fix a bug introduced in Synapse 1.58.0rc1 where opentracing contexts were not correctly sent to whitelisted remote servers with device lists updates. ([\#12555](matrix-org/synapse#12555)) Internal Changes ---------------- - Reduce unnecessary work when handling remote device list updates. ([\#12557](matrix-org/synapse#12557)) Synapse 1.58.0rc1 (2022-04-26) ============================== Features -------- - Implement [MSC3383](matrix-org/matrix-spec-proposals#3383) for including the destination in server-to-server authentication headers. Contributed by @Bubu and @jcgruenhage for Famedly. ([\#11398](matrix-org/synapse#11398)) - Docker images and Debian packages from matrix.org now contain a locked set of Python dependencies, greatly improving build reproducibility. ([Board](https://github.com/orgs/matrix-org/projects/54), [\#11537](matrix-org/synapse#11537)) - Enable processing of device list updates asynchronously. ([\#12365](matrix-org/synapse#12365), [\#12465](matrix-org/synapse#12465)) - Implement [MSC2815](matrix-org/matrix-spec-proposals#2815) to allow room moderators to view redacted event content. Contributed by @tulir @ Beeper. ([\#12427](matrix-org/synapse#12427)) - Build Debian packages for Ubuntu 22.04 "Jammy Jellyfish". ([\#12543](matrix-org/synapse#12543)) Bugfixes -------- - Prevent a sync request from removing a user's busy presence status. ([\#12213](matrix-org/synapse#12213)) - Fix bug with incremental sync missing events when rejoining/backfilling. Contributed by Nick @ Beeper. ([\#12319](matrix-org/synapse#12319)) - Fix a long-standing bug which incorrectly caused `GET /_matrix/client/v3/rooms/{roomId}/event/{eventId}` to return edited events rather than the original. ([\#12476](matrix-org/synapse#12476)) - Fix a bug introduced in Synapse 1.27.0 where the admin API for [deleting forward extremities](https://github.com/matrix-org/synapse/blob/erikj/fix_delete_event_response_count/docs/admin_api/rooms.md#deleting-forward-extremities) would always return a count of 1, no matter how many extremities were deleted. ([\#12496](matrix-org/synapse#12496)) - Fix a long-standing bug where the image thumbnails embedded into email notifications were broken. ([\#12510](matrix-org/synapse#12510)) - Fix a bug in the implementation of [MSC3202](matrix-org/matrix-spec-proposals#3202) where Synapse would use the field name `device_unused_fallback_keys`, rather than `device_unused_fallback_key_types`. ([\#12520](matrix-org/synapse#12520)) - Fix a bug introduced in Synapse 0.99.3 which could cause Synapse to consume large amounts of RAM when back-paginating in a large room. ([\#12522](matrix-org/synapse#12522)) Improved Documentation ---------------------- - Fix rendering of the documentation site when using the 'print' feature. ([\#12340](matrix-org/synapse#12340)) - Add a manual documenting config file options. ([\#12368](matrix-org/synapse#12368), [\#12527](matrix-org/synapse#12527)) - Update documentation to reflect that both the `run_background_tasks_on` option and the options for moving stream writers off of the main process are no longer experimental. ([\#12451](matrix-org/synapse#12451)) - Update worker documentation and replace old `federation_reader` with `generic_worker`. ([\#12457](matrix-org/synapse#12457)) - Strongly recommend [Poetry](https://python-poetry.org/) for development. ([\#12475](matrix-org/synapse#12475)) - Add some example configurations for workers and update architectural diagram. ([\#12492](matrix-org/synapse#12492)) - Fix a broken link in `README.rst`. ([\#12495](matrix-org/synapse#12495)) - Add HAProxy delegation example with CORS headers to docs. ([\#12501](matrix-org/synapse#12501)) - Remove extraneous comma in User Admin API's device deletion section so that the example JSON is actually valid and works. Contributed by @olmari. ([\#12533](matrix-org/synapse#12533)) Deprecations and Removals ------------------------- - The groups/communities feature in Synapse is now disabled by default. ([\#12344](matrix-org/synapse#12344)) - Remove unstable identifiers from [MSC3440](matrix-org/matrix-spec-proposals#3440). ([\#12382](matrix-org/synapse#12382)) Internal Changes ---------------- - Preparation for faster-room-join work: start a background process to resynchronise the room state after a room join. ([\#12394](matrix-org/synapse#12394)) - Preparation for faster-room-join work: Implement a tracking mechanism to allow functions to wait for full room state to arrive. ([\#12399](matrix-org/synapse#12399)) - Remove an unstable identifier from [MSC3083](matrix-org/matrix-spec-proposals#3083). ([\#12395](matrix-org/synapse#12395)) - Run CI in the locked [Poetry](https://python-poetry.org/) environment, and remove corresponding `tox` jobs. ([\#12425](matrix-org/synapse#12425), [\#12434](matrix-org/synapse#12434), [\#12438](matrix-org/synapse#12438), [\#12441](matrix-org/synapse#12441), [\#12449](matrix-org/synapse#12449), [\#12478](matrix-org/synapse#12478), [\#12514](matrix-org/synapse#12514), [\#12472](matrix-org/synapse#12472)) - Change Mutual Rooms' `unstable_features` flag to `uk.half-shot.msc2666.mutual_rooms` which matches the current iteration of [MSC2666](matrix-org/matrix-spec-proposals#2666). ([\#12445](matrix-org/synapse#12445)) - Fix typo in the release script help string. ([\#12450](matrix-org/synapse#12450)) - Fix a minor typo in the Debian changelogs generated by the release script. ([\#12497](matrix-org/synapse#12497)) - Reintroduce the list of targets to the linter script, to avoid linting unwanted local-only directories during development. ([\#12455](matrix-org/synapse#12455)) - Limit length of `device_id` to less than 512 characters. ([\#12454](matrix-org/synapse#12454)) - Dockerfile-workers: reduce the amount we install in the image. ([\#12464](matrix-org/synapse#12464)) - Dockerfile-workers: give the master its own log config. ([\#12466](matrix-org/synapse#12466)) - complement-synapse-workers: factor out separate entry point script. ([\#12467](matrix-org/synapse#12467)) - Back out experimental implementation of [MSC2314](matrix-org/matrix-spec-proposals#2314). ([\#12474](matrix-org/synapse#12474)) - Fix grammatical error in federation error response when the room version of a room is unknown. ([\#12483](matrix-org/synapse#12483)) - Remove unnecessary configuration overrides in tests. ([\#12511](matrix-org/synapse#12511)) - Refactor the relations code for clarity. ([\#12519](matrix-org/synapse#12519)) - Add type hints so `docker` and `stubs` directories pass `mypy --disallow-untyped-defs`. ([\#12528](matrix-org/synapse#12528)) - Update `delay_cancellation` to accept any awaitable, rather than just `Deferred`s. ([\#12468](matrix-org/synapse#12468)) - Handle cancellation in `EventsWorkerStore._get_events_from_cache_or_db`. ([\#12529](matrix-org/synapse#12529))

WIP pip install from wheel job

7667444

David Robertson added 4 commits April 14, 2022 11:30

Try to run action?

b28c551

Try to run postgres tests too

0a591a1

Install package whoopsie

6715324

sytest?

96e228d

DMRobertson pushed a commit to matrix-org/sytest that referenced this pull request Apr 14, 2022

Synapse: Upgrade all deps when pip installing

8215107

Useful for matrix-org/synapse#12472.

DMRobertson mentioned this pull request Apr 14, 2022

Synapse: Upgrade all deps when pip installing matrix-org/sytest#1242

Merged

David Robertson added 4 commits April 14, 2022 12:54

Changelog

ea9cf7f

sytest on postgres too

da400f1

Trypy mypy

094f310

Notes and fixes

5b2ddcc

DMRobertson changed the title ~~WIP pip install from wheel job~~ Add CI job to act as a canary for fresh wheel installations Apr 14, 2022

Actually upgrade packages

3fbcf54

DMRobertson marked this pull request as ready for review April 14, 2022 13:02

DMRobertson requested a review from a team as a code owner April 14, 2022 13:02

DMRobertson commented Apr 14, 2022

View reviewed changes

.github/workflows/latest_deps.yml Outdated Show resolved Hide resolved

clokep changed the title ~~Add CI job to act as a canary for fresh wheel installations~~ Add CI job to act as a canary for testing against latest dependencies Apr 15, 2022

clokep reviewed Apr 15, 2022

View reviewed changes

.github/workflows/latest_deps.yml Outdated Show resolved Hide resolved

clokep reviewed Apr 15, 2022

View reviewed changes

.github/workflows/latest_deps.yml Outdated Show resolved Hide resolved

clokep reviewed Apr 15, 2022

View reviewed changes

.github/workflows/latest_deps.yml Outdated Show resolved Hide resolved

clokep reviewed Apr 15, 2022

View reviewed changes

.github/workflows/latest_deps.yml Outdated Show resolved Hide resolved

David Robertson and others added 2 commits April 19, 2022 13:45

Clarify comment

52cce2c

Co-authored-by: Patrick Cloke <[email protected]>

Commit to running mypy in this job

293c1ee

Co-authored-by: Patrick Cloke <[email protected]>

DMRobertson marked this pull request as draft April 19, 2022 13:35

Make sure we poetry run pip

efda082

We want to modify the package versions in poetry's venv

David Robertson added 6 commits April 19, 2022 16:46

Debug: why is mypy not reading config?

643444d

Back to export

71ab574

Another attempt

54e9dd6

No, we really should use pip

522906c

because otherwise we're not going to get upper bounds and exclusions from pyproject.toml

Confirm uninstall

0c22165

Try just using poetry

9d1ead3

DMRobertson mentioned this pull request Apr 19, 2022

poetry update --no-dev removes dev dependencies python-poetry/poetry#5468

Closed

3 tasks

David Robertson added 2 commits April 19, 2022 19:17

try beta poetry

c841847

Update comment

715fb1b

DMRobertson requested a review from clokep April 19, 2022 18:35

clokep reviewed Apr 19, 2022

View reviewed changes

.github/workflows/latest_deps.yml Outdated Show resolved Hide resolved

clokep reviewed Apr 19, 2022

View reviewed changes

.github/workflows/latest_deps.yml Outdated Show resolved Hide resolved

clokep reviewed Apr 19, 2022

View reviewed changes

.github/workflows/latest_deps.yml Show resolved Hide resolved

Typo fix

d0819a9

Co-authored-by: Patrick Cloke <[email protected]>

clokep reviewed Apr 19, 2022

View reviewed changes

.github/workflows/latest_deps.yml Show resolved Hide resolved

clokep reviewed Apr 19, 2022

View reviewed changes

David Robertson added 3 commits April 19, 2022 20:08

Try trial without installing in editable mode

54d368c

Another attempt at trial

0b57eb9

Third attempt at trial

81b98b3

DMRobertson marked this pull request as ready for review April 19, 2022 19:29

David Robertson and others added 2 commits April 20, 2022 11:53

Update job description comment

36ef3c2

Co-authored-by: Patrick Cloke <[email protected]>

Enable the issue-raiser; remove debug

b2f6da2

Co-authored-by: Patrick Cloke <[email protected]>

DMRobertson requested a review from clokep April 20, 2022 10:54

clokep approved these changes Apr 20, 2022

View reviewed changes

DMRobertson merged commit eed38c5 into develop Apr 20, 2022

DMRobertson deleted the dmr/poetry-wheel-ci branch April 20, 2022 11:48

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add CI job to act as a canary for testing against latest dependencies #12472

Add CI job to act as a canary for testing against latest dependencies #12472

DMRobertson commented Apr 14, 2022 •

edited

Loading

DMRobertson commented Apr 14, 2022

clokep commented Apr 14, 2022

DMRobertson commented Apr 14, 2022

clokep commented Apr 15, 2022

DMRobertson commented Apr 19, 2022

clokep Apr 19, 2022

DMRobertson Apr 19, 2022

Add CI job to act as a canary for testing against latest dependencies #12472

Add CI job to act as a canary for testing against latest dependencies #12472

Conversation

DMRobertson commented Apr 14, 2022 • edited Loading

DMRobertson commented Apr 14, 2022

clokep commented Apr 14, 2022

DMRobertson commented Apr 14, 2022

clokep commented Apr 15, 2022

DMRobertson commented Apr 19, 2022

clokep Apr 19, 2022

Choose a reason for hiding this comment

DMRobertson Apr 19, 2022

Choose a reason for hiding this comment

DMRobertson commented Apr 14, 2022 •

edited

Loading