Skip to content

CHANGELOG.md

Latest commit

 

History

History
616 lines (367 loc) · 26.2 KB

CHANGELOG.md

File metadata and controls

616 lines (367 loc) · 26.2 KB

Sygnal 0.17.0 (2025-11-05)

Features

  • Add send_badge_counts option for FCM/GCM pushkin. (#421)
  • Add send_badge_counts option for APN pushkins. (#423)

Improved Documentation

  • Link to Sygnal's Matrix room in the README. (#425)

Internal Changes

  • Make sure no empty badge-only notifications are sent if there are no badge counts in FCM. (#424)

Sygnal 0.16.0 (2025-07-18)

This is the first Sygnal release under an AGPLv3.0 licence (with CLA, for proprietary dual licensing). You can read more about this here:

Bugfixes

  • Fix issue where GCM pushkins behind proxy fail to start. (#408)
  • Pin aioapns to be older than v4.0 to avoid a breaking change in key handling. Contributed by Michael DiStefano. (#417)

Updates to the Docker image

  • Use Python 3.12 as a base for the Docker image instead of Python 3.11. (#400)
  • Speed up the building of the Docker image. (#409)
  • Add HEALTHCHECK directive to the container image, using existing /health endpoint. (#418)

Improved Documentation

  • Add basic instructions for running within a container. (#410)

Internal Changes

  • Bump twisted from 24.3.0 to 24.7.0. (#397)
  • Bump aiohttp from 3.9.5 to 3.10.2. (#398)
  • Fix unit tests by adding setTcpNoDelay to FakeTransport. (#402)
  • Bump virtualenv from 20.26.2 to 20.26.6. (#405)
  • Bump jinja2 from 3.1.4 to 3.1.5. (#406)
  • Bump docker/build-push-action and docker/metadata-action to the latest versions. (#412)
  • Add a CI test for Sygnal's HTTP proxy functionality. (#413)

Sygnal 0.15.1 (2024-10-04)

Bugfixes

  • Fix incompatibility with aiohttp>=3.10.0 when using GCM with an HTTP proxy. (#395)

Improved Documentation

  • The Matrix.org Foundation no longer requires "real" or "legally identifiable" names in order to contribute to projects. (#391)

Internal Changes

  • Pin aiohttp dependency to <= 4.0.0. (#396)

Sygnal 0.15.0 (2024-06-26)

NOTE: Exercise caution when installing over an existing sygnal installation via pip. The sygnal package name was inadvertently changed to sygnal during the change to use poetry in v0.14.2. Release v0.15.0 changes the package name back to matrix-sygnal, which is what it was prior to v0.14.2.

Bugfixes

  • Change package name back to matrix-sygnal. (#385)

Sygnal 0.14.4 (2024-06-26)

Bugfixes

  • Truncate large values inside of Firebase notification content fields. (#386)
  • Fixes an issue where retry attempts using the Firebase v1 API would fail due to nested messages. (#387)

Internal Changes

  • Bump tornado from 6.4 to 6.4.1. (#382)

Sygnal 0.14.3 (2024-05-31)

Bugfixes

  • Don't delete android notification options specified in config when using Firebase v1 API. (#380)

Internal Changes

  • Fix tests to allow Twisted versions >=23.10. (#381)

Sygnal 0.14.2 (2024-05-21)

Bugfixes

  • FCM v1: use async version of google-auth and add HTTP proxy support. (#372)

Improved Documentation

  • Update docs & tests to reflect APNs usage in FCM v1 API. (#370)

Internal Changes

  • Update docker build and CI workflows to Python 3.11. (#373)
  • Switch over to use poetry & add lock file to version control. (#374)
  • Add manual proxy testing scripts & docs. (#375)
  • Bump black from 23.9.1 to 24.3.0. (#376)
  • Bump requests from 2.31.0 to 2.32.2. (#377)

Sygnal 0.14.1 (2024-04-09)

Bugfixes

  • Fix a bug causing Sygnal to fail when processing notifications without a content dict, when those notifications were destined for GCM. Contributed by @c-cal. (#362)

Sygnal 0.14.0 (2024-03-21)

Features

  • Add a new convert_device_token_to_hex configuration option for APNs apps, to allow disabling the conversion of device tokens from base64 to hex. (#344)
  • Adds the ability to use the new FCM v1 API. (#361)

Bugfixes

  • Fixed an issue which resulted in proxy configuration being ignored for APNs notifications. (#360)

Sygnal 0.13.0 (2023-11-21)

Sygnal will soon be forked by Element under an AGPLv3.0 licence (with CLA, for proprietary dual licensing). You can read more about this here:

The Matrix.org Foundation copy of the project will be archived. Any changes needed by server administrators will be communicated via our usual announcements channels, but we are striving to make this as seamless as possible.

Features

  • Set log level for /health endpoint to DEBUG. (#352)

Bugfixes

  • Fix a bug introduced in Sygnal 0.5.0 where sygnal.__version__ would not be correctly populated. (#355)

Improved Documentation

  • Update outdated links in README.md. (#316)
  • Change master to main branch in CONTRIBUTING.md. (#317)

Deprecations and Removals

  • Remove support for Python 3.7. (#343)

Internal Changes

  • Don't attempt delivery of notification if we have rejected pushkey. (#315)
  • Improve static type checking. (#333, #336)
  • Extend logging for outgoing pushes. (#334)
  • Move from setup.py to pyproject.toml. (#335)
  • Add entrypoint to allow running Sygnal by running the sygnal script. (#341)
  • Bump aioapns dependency to 3.0 in order to support Python 3.10+. (#347)
  • Bump matrix-common dependency to 1.3.0. (#348)
  • Bump development dependencies. (#349)

Sygnal 0.12.0 (2022-07-04)

Features

  • Add a new push_type configuration option for APNs apps, to control the value of the apns-push-type header when sending requests. (#309)

Bugfixes

  • Fix a bug introduced in Sygnal 0.7.0 where a malformed default_payload could cause an internal server error. (#292)

Improved Documentation

  • Document the use of an iOS Notification Service Extension and the Push Gateway API as a workaround to trigger VoIP notifications on iOS. (#285)
  • Add a link to the docker image in the README. (#297)

Internal Changes

  • Avoid a breaking change in aioapns 2.1 by requiring an earlier version of that package. (#294)
  • Fix test failures by using the latest versions of TLS in the TLS proxy tests. (#306)
  • Update the black code formatter to 22.3.0. (#307)

Sygnal 0.11.0 (2021-12-15)

Bugfixes

  • Fix a bug introduced in Sygnal 0.5.0 where pushkin names would match substrings of app IDs and treat dots as wildcards. (#269)
  • Fix a bug introduced in Sygnal 0.5.0 where GCM pushes would always fail when configured to handle an app ID glob. (#270)
  • Treat more APNs errors as permanent rejections. (#280)
  • Fix a bug introduced in Sygnal 0.9.1 where web pushkeys with missing endpoints would cause an error. (#288)

Improved Documentation

  • Document that the topic is most commonly the Bundle Identifier for the iOS application. (#284)
  • Add troubleshooting documentation for when you receive 'Could not deserialize key data' when using APNs with key files. (#286)

Internal Changes

  • Fix the changelog CI check when running on a fork of the Sygnal repository, rather than a branch. (#254)
  • Configure @matrix-org/synapse-core to be the code owner for the repository. (#259)
  • Improve static type checking. (#264)
  • Use absolute imports for consistency. (#265)
  • Remove explicit inheritance from object that was left over from Python 2. (#266)
  • Use Python 3-style super calls. (#267)
  • Add type hints to most of the code. (#271, #273, #274, #275, #276)
  • Convert the README to use markdown rather than reStructuredText for consistency and familiarity. (#278)
  • Move glob_to_regex to matrix-python-common. (#281)
  • Add opentracing-types to the dev dependencies. (#287)
  • Add missing dependencies to setup.py. (#290)

Sygnal 0.10.1 (2021-08-16)

This release only makes changes to the way Docker images are built and released; it is otherwise identical to 0.10.0. Administrators who do not use Docker as their installation method have no need to upgrade from 0.10.0.

Updates to the Docker image

  • Fix the docker image build from failing due to git not being installed. This issue was introduced in v0.10.0. (#246)
  • CI now checks that the Docker image still builds after the Dockerfile is modified. (#248)
  • Automatically build the Docker image for each release and push it to Docker Hub using GitHub Actions. (#249)

Internal Changes

  • Add a lint script (scripts-dev/lint.sh) for developers. (#243)
  • Add more comprehensive Newsfile (changelog fragment) checks in CI. (#250)

Sygnal 0.10.0 (2021-08-09)

Database Removal

Sygnal is now stateless, and does not rely on a database of any kind. You may remove your existing SQLite or PostgreSQL databases once you are satisfied that this release is working as intended. Configuration changes are not necessary, as the database section will be ignored if present.

  • Remove legacy database to ease horizontal scaling. Contributed by H. Shay. (#236)

Improved Documentation

  • Update CONTRIBUTING.md to recommend installing libpq-dev. Contributed by Tawanda Moyo. (#197)

Internal Changes

  • Improve static type checking. Contributed by Omar Mohamed. (#221, #223, #225, #227)
  • Update towncrier CI check to run against the new default branch name. (#226)
  • Update black to 21.6b0. (#233)
  • Fix type hint errors from new upstream Twisted release. (#239)
  • Fixup GitHub Actions pipeline to always run tests on PRs. (#240)
  • Add CI testing for old dependencies. (#242)

Sygnal 0.9.3 (2021-04-22)

Features

  • Prevent the push key from being rejected for temporary errors and oversized payloads, add TTL logging, and support events_only push data flag. (#212)
  • WebPush: add support for Urgency and Topic header (#213)

Bugfixes

  • Fix a long-standing bug where invalid JSON would be accepted over the HTTP interfaces. (#216)
  • Limit the size of requests received from HTTP clients. (#220)

Updates to the Docker image

  • Remove manually added GeoTrust Root CA certificate from docker image as Apple is no longer using it. (#208)

Improved Documentation

  • Make CONTIBUTING.md more explicit about how to get tests passing. (#188)
  • Update CONTRIBUTING.md to specify how to run code style and type checks with Tox, and add formatting to code block samples. (#193)
  • Document how to work around pip installation timeout errors. Contributed by Omar Mohamed. (#215)

Internal Changes

  • Update Tox to run in the installed version of Python (instead of specifying Python 3.7) and to consider specific paths and folders while running checks, instead of the whole repository (potentially including unwanted files and folders, e.g. the virtual environment). (#193)
  • Make development dependencies available as extras. Contributed by Hillery Shay. (#194)
  • Update setup.py to specify that a minimum version of Python greater or equal to 3.7 is required. Contributed by Tawanda Moyo. (#207)
  • Port CI checks to Github Actions. (#210, #219)
  • Upgrade development dependencies. Contributed by Omar Mohamed (#214)
  • Set up coverage.py to run in tox environment, and add html reports (#217)

Sygnal v0.9.2 (2021-03-29)

Features

  • Add allowed_endpoints option as an understood config option for WebPush pushkins. (#184)
  • Add ttl option as an understood config option for WebPush pushkins to make delivery more reliable (#185)

Sygnal 0.9.1 (2021-03-23)

Features

  • Add allowed_endpoints configuration option for limiting the endpoints that WebPush pushkins will contact. (#182)

Bugfixes

  • Fix bug where the requests from different WebPush devices could bleed into each other. (#180)
  • Fix bug when using a HTTP proxy where connections would sometimes fail to establish. (#181)

Sygnal 0.9.0 (2021-03-19)

Features

  • Add experimental support for WebPush pushkins. (#177)

Bugfixes

  • Fix erroneous warning log line when setting the max_connections option in a GCM app config. (#157)
  • Fix bug where the sygnal_inflight_request_limit_drop metric would not appear in prometheus until requests were actually dropped. (#172)
  • Fix bug where Sygnal would not recover after losing connection to the database. (#179)

Improved Documentation

Internal Changes

  • Remove a source of noisy (but otherwise harmless) exceptions in tests. (#149)
  • Add tests for HTTP Proxy support. (#151, #152)
  • Remove extraneous log line. (#174)
  • Fix type hints due to Twisted upgrade. (#178)

Sygnal 0.8.2 (2020-08-06)

Features

  • Add the ability to configure custom FCM options, which is necessary for using iOS with Firebase. (#145)
  • Add a Prometheus metric (sygnal_inflight_request_limit_drop) that shows the number of notifications dropped due to exceeding the in-flight concurrent request limit. (#146)

Sygnal 0.8.1 (2020-07-28)

Updates to the Docker image

  • Include GeoTrust Global CA's certificate in the Docker image as it is needed for APNs (and was removed by Debian). (#141)

Sygnal 0.7.2 (2020-07-28)

Updates to the Docker image

  • Include GeoTrust Global CA's certificate in the Docker image as it is needed for APNs (and was removed by Debian). (#141)

Sygnal 0.8.0 (2020-07-27)

Features

  • Add support for HTTP CONNECT proxies on outbound FCM and APNs traffic, with optional support for HTTP Proxy Basic Authentication. (#130)
  • Add support for per-pushkin in-flight request limiting. (#132)

Internal Changes

  • Fixed MyPy errors so it can be enabled in CI and gradually be increased in coverage. (#131)
  • Attempt the same number of retries for both GCM and APNS. (#133)
  • Use tox for tests and linting. (#134)
  • Include libpq5 in the docker image. (#135)

Sygnal 0.7.1 (2020-07-27)

Security advisory

This version of Sygnal updates the minimum version of the aioapns dependency to version 1.10 which addresses a TLS hostname validation bug in aioapns.

Sygnal was vulnerable to a man-in-the-middle attack on APNs data if someone could spoof your DNS or otherwise redirect your APNs traffic.

This issue affects any Sygnal deployments that make use of APNs certificate authentication (i.e. those with certfile: something.pem in the configuration).

Administrators are encouraged to upgrade.

Bugfixes

  • Update minimum version of aioapns dependency to 1.10, which has security fixes. (#139)

Sygnal 0.7.0 (2020-06-24)

Features

  • Use default_payload from the device data for both APNS and GCM payloads. (#127)

Improved Documentation

  • Note information about Docker files in release instructions. (#126)

Internal Changes

  • Improve logging if a pushkin cannot be created. (#125)

Sygnal 0.6.0 (2020-05-12)

Features

  • Report the APNS certificate expiry as a prometheus metric. (#106, #112)
  • Change APNS payload to be mutable and include the event_id in payload. (#114)

Bugfixes

  • Sygnal will no longer warn about the database config field being not understood. (#100)
  • Log errors during start-up and fix the sample logging config. (#122)

Improved Documentation

  • Document platform value for APNS apps (#110)

Internal Changes

  • Add Dockerfile. (#63)

Sygnal 0.5.0 (2020-04-24)

Features

  • Reuse Configurations With asterisk App IDs and Token Based APNS Auth (#108)

Sygnal 0.4.1 (2020-04-02)

Bugfixes

  • Fix an issue where using PostgreSQL would cause Sygnal to crash (#95)

Sygnal 0.4.0 (2020-03-31)

NOTE: The config schema has changed. The db config section has been replaced by database. Example configuration can be found in sygnal.yaml.sample. db will continue to work, but the section is deprecated and may be removed in a future release.

Features

  • Add support for PostgreSQL (#91)

Internal Changes

  • Replace occurances of 'assertEquals' with 'assertEqual' to reduce deprecation noise while running tests. (#93)

Sygnal 0.3.0 (2020-03-24)

Features

  • Add prometheus metric for the number of requests in flight. (#87)
  • Add prometheus metrics to track pushkin things. (#88)

Bugfixes

  • Fix warnings about finish() after disconnect. (#84)
  • Fix a bug which meant that requests were logged with an invalid timestamp. (#86)

Internal Changes

  • Change how we stub out HTTP requests in the tests. (#85)

Sygnal 0.2.4 (2019-08-29)

  • Fix typo leading to poor handling of 5xx GCM response codes.
  • Handle 404 GCM response codes.

Sygnal 0.2.3 (2019-08-14)

  • Actually fix GCM connection limiting, and exception handling of exceptions that occur whilst reading the response body.
  • Reduce logging for successful requests.
  • Improve TLS performance to reduce CPU usage.
  • Add a Prometheus metric that tracks the time taken to handle a /notify request.
  • Add a /health endpoint for checking whether Sygnal is up.

Sygnal 0.2.2 (2019-08-12)

  • Fix GCM connection limiting.
  • Clean up exception handling code.

Sygnal 0.2.1 (2019-08-08)

  • Declare sentry-sdk as a dependency.
  • Obey GCM maximum connections count.
  • Document max_connections config option in GCM.
  • Separate Twisted's logging and the access logging.

Sygnal 0.2.0 (2019-08-02)

This is a rewrite of Sygnal 0.0.1. Before upgrading, please note that Python 3.7 or higher is required.

  • Use new version of Apple Push Notification service (HTTP/2 protocol)
  • Depend on Python 3.7+
  • Depend on Twisted for async
  • Add support for OpenTracing with Jaeger Tracing