feat(api): implement the client notifications endpoint #1786

Closed
RainerZufall187 wants to merge 4 commits from RainerZufall187/continuwuity:main into main
First-time contributor

This pull request implements GET /_matrix/client/v3/notifications.

Cinny currently shows M_UNRECOGNIZED on the notifications page because this endpoint is not implemented yet. With this change, notification history can be loaded normally.

Besides adding the endpoint itself, I also adjusted the surrounding notification logic so it behaves more like the Matrix spec expects:

  • notifications are rebuilt from stored PDUs instead of duplicating full events
  • m.read, m.read.private, and m.fully_read now affect notification read state
  • sync responses now include per-thread unread notification counts
  • pusher handling now keys off app_id + pushkey, with stricter HTTP pusher validation

Pull request checklist:

  • This pull request targets the main branch, and the branch is named something other than
    main.
  • I have written an appropriate pull request title and my description is clear.
  • I understand I am responsible for the contents of this pull request.
  • I have followed the contributing guidelines:
This pull request implements `GET /_matrix/client/v3/notifications`. Cinny currently shows `M_UNRECOGNIZED` on the notifications page because this endpoint is not implemented yet. With this change, notification history can be loaded normally. Besides adding the endpoint itself, I also adjusted the surrounding notification logic so it behaves more like the Matrix spec expects: - notifications are rebuilt from stored PDUs instead of duplicating full events - `m.read`, `m.read.private`, and `m.fully_read` now affect notification read state - sync responses now include per-thread unread notification counts - pusher handling now keys off `app_id` + `pushkey`, with stricter HTTP pusher validation <!-- In order to help reviewers know what your pull request does at a glance, you should ensure that 1. Your PR title is a short, single sentence describing what you changed 2. You have described in more detail what you have changed, why you have changed it, what the intended effect is, and why you think this will be beneficial to the project. If you have made any potentially strange/questionable design choices, but didn't feel they'd benefit from code comments, please don't mention them here - after opening your pull request, go to "files changed", and click on the "+" symbol in the line number gutter, and attach comments to the lines that you think would benefit from some clarification. --> <!-- Example: This pull request allows us to warp through time and space ten times faster than before by double-inverting the warp drive with hyperheated jump fluid, both making the drive faster and more efficient. This resolves the common issue where we have to wait more than 10 milliseconds to engage, use, and disengage the warp drive when travelling between galaxies. --> <!-- Closes: #... --> <!-- Fixes: #... --> <!-- Uncomment the above line(s) if your pull request fixes an issue or closes another pull request by superseding it. Replace `#...` with the issue/pr number, such as `#123`. --> **Pull request checklist:** <!-- You need to complete these before your PR can be considered. If you aren't sure about some, feel free to ask for clarification in #dev:continuwuity.org. --> - [ ] This pull request targets the `main` branch, and the branch is named something other than `main`. - [x] I have written an appropriate pull request title and my description is clear. - [x] I understand I am responsible for the contents of this pull request. - I have followed the [contributing guidelines][c1]: - [x] My contribution follows the [code style][c2], if applicable. - [x] I ran [pre-commit checks][c1pc] before opening/drafting this pull request. - [x] I have [tested my contribution][c1t] (or proof-read it for documentation-only changes) myself, if applicable. This includes ensuring code compiles. - [x] My commit messages follow the [commit message format][c1cm] and are descriptive. <!-- Notes on these requirements: - While not required, we encourage you to sign your commits with GPG or SSH to attest the authenticity of your changes. - While we allow LLM-assisted contributions, we do not appreciate contributions that are low quality, which is typical of machine-generated contributions that have not had a lot of love and care from a human. Please do not open a PR if all you have done is asked ChatGPT to tidy up the codebase with a +-100,000 diff. - In the case of code style violations, reviewers may leave review comments/change requests indicating what the ideal change would look like. For example, a reviewer may suggest you lower a log level, or use `match` instead of `if/else` etc. - In the case of code style violations, pre-commit check failures, minor things like typos/spelling errors, and in some cases commit format violations, reviewers may modify your branch directly, typically by making changes and adding a commit. Particularly in the latter case, a reviewer may rebase your commits to squash "spammy" ones (like "fix", "fix", "actually fix"), and reword commit messages that don't satisfy the format. - Pull requests MUST pass the `Checks` CI workflows to be capable of being merged. This can only be bypassed in exceptional circumstances. If your CI flakes, let us know in matrix:r/dev:continuwuity.org. - Pull requests have to be based on the latest `main` commit before being merged. If the main branch changes while you're making your changes, you should make sure you rebase on main before opening a PR. Your branch will be rebased on main before it is merged if it has fallen behind. - We typically only do fast-forward merges, so your entire commit log will be included. Once in main, it's difficult to get out cleanly, so put on your best dress, smile for the cameras! --> [c1]: https://forgejo.ellis.link/continuwuation/continuwuity/src/branch/main/CONTRIBUTING.md [c2]: https://forgejo.ellis.link/continuwuation/continuwuity/src/branch/main/docs/development/code_style.mdx [c1pc]: https://forgejo.ellis.link/continuwuation/continuwuity/src/branch/main/CONTRIBUTING.md#pre-commit-checks [c1t]: https://forgejo.ellis.link/continuwuation/continuwuity/src/branch/main/CONTRIBUTING.md#running-tests-locally [c1cm]: https://forgejo.ellis.link/continuwuation/continuwuity/src/branch/main/CONTRIBUTING.md#commit-messages
fix(api): implement the client notifications endpoint
Some checks failed
Auto Labeler / Apply labels based on changed files (pull_request_target) Successful in 4s
Checks / Changelog / Check changelog is added (pull_request_target) Failing after 8s
Documentation / Build and Deploy Documentation (pull_request) Has been cancelled
Checks / Prek / Pre-commit & Formatting (pull_request) Has been cancelled
Checks / Prek / Check changed files (pull_request) Has been cancelled
Checks / Prek / Clippy and Cargo Tests (pull_request) Has been cancelled
ae7ddf230d
Add support for `GET /_matrix/client/v3/notifications` so clients like Cinny
can load notification history instead of receiving M_UNRECOGNIZED.

Persist notification entries per user, expose paginated results, support
highlight-only filtering, and derive read state from public/private receipts.
Create 1786.bugfix
Some checks failed
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
Checks / Prek / Check changed files (pull_request) Successful in 6s
Checks / Changelog / Check changelog is added (pull_request_target) Successful in 36s
Checks / Prek / Pre-commit & Formatting (pull_request) Failing after 1m42s
Checks / Prek / Clippy and Cargo Tests (pull_request) Successful in 8m51s
9ba111f4be
Member

Please follow Conventional Commits for your changelog commit also :)

Please follow [Conventional Commits](https://continuwuity.org/development/contributing.html#commit-messages) for your changelog commit also :)
Jade left a comment

This current design isn't a suitable implementation of the endpoint. Please talk to us in dev before implementing a large/hard feature!

This current design isn't a suitable implementation of the endpoint. Please talk to us in dev before implementing a large/hard feature!
@ -466,0 +486,4 @@
let mut notifications = Vec::with_capacity(limit);
let mut next_token = None;
let items = services.rooms.user.notifications_rev(sender_user, from);
let mut read_up_to = std::collections::BTreeMap::new();
Owner

What is going on with the read recipts stuff?

  • this doesn't actually delete the notifications from the database, and is somewhat pointless from that perspective
  • Read receipts are not the only thing that matters here, see m.fully_read / mark as read
  • What spec behaviour is this actually meant to implement?
What is going on with the read recipts stuff? - this doesn't actually delete the notifications from the database, and is somewhat pointless from that perspective - Read receipts are not the only thing that matters here, see m.fully_read / mark as read - What spec behaviour is this actually meant to implement?
@ -466,0 +507,4 @@
*read
} else {
let public = services
.rooms
Owner

If you're doing this it should be in a separate function anyway

If you're doing this it should be in a separate function anyway
@ -466,0 +540,4 @@
event,
read,
room_id,
MilliSecondsSinceUnixEpoch(
Owner

You aren't handling:

  • Redactions
  • Edits, threads
  • Other unsigned data

(Most of this is handled either by database modification code or by a function called before returning the PDU to the client, both of which is skipped by this design)

You aren't handling: - Redactions - Edits, threads - Other unsigned data (Most of this is handled either by database modification code or by a function called before returning the PDU to the client, both of which is skipped by this design)
@ -48,0 +60,4 @@
pub room_id: OwnedRoomId,
pub ts: u64,
#[serde(skip_serializing_if = "Option::is_none")]
pub event: Option<Raw<AnySyncTimelineEvent>>,
Owner

This duplicates the contents of events, which are already stored in the statabase (storing a short PDU I'd would be appropriate here). This uses more storage than needed, and contributes to other issues.

This duplicates the contents of events, which are already stored in the statabase (storing a short PDU I'd would be appropriate here). This uses more storage than needed, and contributes to other issues.
RainerZufall187 changed title from fix(api): implement the client notifications endpoint to feat(api): implement the client notifications endpoint 2026-05-18 23:28:24 +00:00
RainerZufall187 changed title from feat(api): implement the client notifications endpoint to WIP: feat(api): implement the client notifications endpoint 2026-05-18 23:33:03 +00:00
fix(notifications): track notification read state by PDU
Some checks failed
Checks / Changelog / Check changelog is added (pull_request_target) Successful in 30s
Documentation / Build and Deploy Documentation (pull_request) Has been cancelled
Checks / Prek / Pre-commit & Formatting (pull_request) Has been cancelled
Checks / Prek / Check changed files (pull_request) Has been cancelled
Checks / Prek / Clippy and Cargo Tests (pull_request) Has been cancelled
Update flake hashes / update-flake-hashes (pull_request) Has been cancelled
1f99e5f017
Store notification records with the PDU id and rebuild notification events
when reading them back. This makes the notifications endpoint respect event
visibility, ignored events, and bundled aggregations again.

Also update the last notification read marker for fully-read, public read,
and private read receipts, and remove the old public receipt count lookup.
RainerZufall187 force-pushed main from 1f99e5f017
Some checks failed
Checks / Changelog / Check changelog is added (pull_request_target) Successful in 30s
Documentation / Build and Deploy Documentation (pull_request) Has been cancelled
Checks / Prek / Pre-commit & Formatting (pull_request) Has been cancelled
Checks / Prek / Check changed files (pull_request) Has been cancelled
Checks / Prek / Clippy and Cargo Tests (pull_request) Has been cancelled
Update flake hashes / update-flake-hashes (pull_request) Has been cancelled
to ec2abcd401
Some checks failed
Checks / Changelog / Check changelog is added (pull_request_target) Successful in 30s
Documentation / Build and Deploy Documentation (pull_request) Has been cancelled
Checks / Prek / Pre-commit & Formatting (pull_request) Has been cancelled
Checks / Prek / Check changed files (pull_request) Has been cancelled
Checks / Prek / Clippy and Cargo Tests (pull_request) Has been cancelled
2026-05-19 16:10:08 +00:00
Compare
fix(api): align notifications and pushers with the Matrix spec
Some checks failed
Checks / Changelog / Check changelog is added (pull_request_target) Successful in 9s
Documentation / Build and Deploy Documentation (pull_request) Has been cancelled
Checks / Prek / Pre-commit & Formatting (pull_request) Has been cancelled
Checks / Prek / Check changed files (pull_request) Has been cancelled
Checks / Prek / Clippy and Cargo Tests (pull_request) Has been cancelled
ae5a768e48
Track notification read state from event receipts instead of resetting counts
blindly, including support for m.fully_read and threaded receipt handling.

Also return per-thread unread notification counts in sync responses and treat
pushers by app_id plus pushkey with stricter HTTP pusher validation.
RainerZufall187 changed title from WIP: feat(api): implement the client notifications endpoint to feat(api): implement the client notifications endpoint 2026-05-19 17:37:02 +00:00
Owner

I asked you to talk to us in dev, not to triple your line count and make potentially breaking changes to the database while implementing changes outside of the scope of the pull request. Please discuss large changes before starting to work on them!

I'm closing this until a discussion has been had about the design, and whether we even want to implement this given MSC4451: Deprecate notifications endpoint.

I asked you to talk to us in dev, not to triple your line count and make potentially breaking changes to the database while implementing changes outside of the scope of the pull request. Please discuss large changes before starting to work on them! I'm closing this until a discussion has been had about the design, and whether we even want to implement this given [MSC4451: Deprecate notifications endpoint](https://github.com/matrix-org/matrix-spec-proposals/pull/4451).
Jade closed this pull request 2026-05-19 17:48:14 +00:00
Some checks failed
Checks / Changelog / Check changelog is added (pull_request_target) Successful in 9s
Required
Details
Documentation / Build and Deploy Documentation (pull_request) Has been cancelled
Checks / Prek / Pre-commit & Formatting (pull_request) Has been cancelled
Required
Details
Checks / Prek / Check changed files (pull_request) Has been cancelled
Required
Details
Checks / Prek / Clippy and Cargo Tests (pull_request) Has been cancelled
Required
Details

Pull request closed

Sign in to join this conversation.
No reviewers
No milestone
No project
No assignees
3 participants
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
continuwuation/continuwuity!1786
No description provided.