Skip to content

MSC4140: Cancellable delayed events #4140

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
toger5 wants to merge 258 commits into
base: main
Choose a base branch
from
+609 −0
Open

MSC4140: Cancellable delayed events #4140

Changes from all commits
Commits
Show all changes
258 commits
Select commit Hold shift + click to select a range
087c74e
Add usecase specific section.
toger5 May 20, 2024
538b853
add GET futures endpoint
toger5 May 20, 2024
f7a1aad
shorten introduction
toger5 May 21, 2024
f5f4b38
add alternative section to not include the `m.send_now` field
toger5 May 22, 2024
c16afbc
Update proposals/4140-delayed-events-futures.md
toger5 May 31, 2024
c52c80d
batch sending considerations
toger5 May 31, 2024
bf22260
Update proposals/4140-delayed-events-futures.md
toger5 Jun 3, 2024
7f0d80f
Update proposals/4140-delayed-events-futures.md
toger5 Jun 3, 2024
7b192ac
Update proposals/4140-delayed-events-futures.md
toger5 Jun 3, 2024
f3bf66d
review
toger5 Jun 3, 2024
2d7b27d
add background to usecase specific considerations
toger5 Jun 4, 2024
1140ce9
Simplify main proposal for widget api usage
toger5 Jun 5, 2024
0a7896e
make `future_group_id` server generated and small adjustments
toger5 Jun 6, 2024
8fa33d6
review
toger5 Jun 6, 2024
49d5294
user scoping details
toger5 Jun 13, 2024
7550d9b
Update proposals/4140-delayed-events-futures.md
toger5 Jun 13, 2024
a663bb4
add rate limiting section
toger5 Jun 14, 2024
99b3a20
rename `/futures` to `/future`
toger5 Jun 19, 2024
eb50a19
Update everything to v1
toger5 Jun 20, 2024
9ff051e
Update proposals/4140-delayed-events-futures.md
toger5 Jun 22, 2024
425b9bf
review
toger5 Jun 24, 2024
2e7be46
Swap the alternative of reusing the send and state request with the m…
toger5 Jun 24, 2024
5653fe1
add reference to MSC4143 (MatrixRTC)
toger5 Jul 2, 2024
af060cf
Meeting feedback:
toger5 Jul 15, 2024
bff704c
remove parent concept.
toger5 Jul 22, 2024
fa461e2
Refactor + unstable prefixes
hughns Jul 23, 2024
d195218
Update to GET /futures
hughns Jul 23, 2024
b5ac9b2
Standardise endpoint for interacting with futures
hughns Jul 23, 2024
c07dd9b
Make it clear that events can be cancelled
hughns Jul 24, 2024
b79e4e2
Make wording more authoritative
hughns Jul 24, 2024
e125901
Remove erroneous old example
hughns Jul 24, 2024
0443cd9
Take view that clients don't act on behalf of a user
hughns Jul 24, 2024
7df0919
Use name delay_id and delayed_events
hughns Jul 24, 2024
ff95144
Clean up more references to future
hughns Jul 24, 2024
93c932a
event_type => type
hughns Jul 24, 2024
6cce3bd
Tidying
hughns Jul 24, 2024
ac2d2c5
Pagination on GET endpoint
hughns Jul 24, 2024
84e20fd
Add alternative of M_INVALID_PARAM
hughns Jul 24, 2024
ac3bd9d
change order of manage <-> get sections
toger5 Jul 25, 2024
de77a90
Obey lint rules and more renames
toger5 Jul 25, 2024
677d6f3
TOC update
hughns Jul 25, 2024
4caecd1
Additional notes on security considerations
hughns Jul 25, 2024
c482d58
Add rate limiting requirements
hughns Jul 25, 2024
9098fea
Describe MatrixRTC use case in terms of heartbeats
hughns Jul 25, 2024
7e06e85
"leave" => "hangup" for consistency
hughns Jul 25, 2024
a1b8121
Wording clarification
hughns Jul 25, 2024
3a3a5b5
Additional reference to heartbeat
hughns Jul 25, 2024
97d4141
TOC update (use monospace and dont list msc title
toger5 Jul 25, 2024
99c9467
be consistent with "restart" wording (we used reset, refresh and rest…
toger5 Jul 25, 2024
6f2aa5e
Add compatibility with Cryptographic Identities to potenail issues
hughns Jul 25, 2024
5e43db0
Add placeholder for MSC3277
hughns Jul 25, 2024
84b8dc0
Add note about MSC2716 batch sending
hughns Jul 25, 2024
e7d0986
Add alternative of not providing a send action
hughns Jul 25, 2024
850bf9e
Add alternative of using DELETE HTTP method
hughns Jul 25, 2024
e1b460a
Add clarification about regular/non-state events not getting cancelled
hughns Jul 25, 2024
114da1e
Clarify contents of content field on GET response
hughns Jul 25, 2024
772590f
Expose transaction ID in GET response
hughns Jul 25, 2024
4a2ca48
Add context on MSC3277 alternative
hughns Jul 25, 2024
37979cd
Add more context to MQTT style alternative
hughns Jul 25, 2024
195ab6a
Add alternative of typing notifications
hughns Jul 25, 2024
0f8a2d1
Update TOC
hughns Jul 26, 2024
886f378
Fix TOC
hughns Aug 2, 2024
8523ed4
Note on alternative names for `running_since`
hughns Aug 2, 2024
883e6b5
Revert "Expose transaction ID in GET response"
AndrewFerr Sep 11, 2024
caece4d
Scope GET to only the requesting user's events
AndrewFerr Sep 11, 2024
28970ec
remove all references to future (except where we actually talk about …
toger5 Oct 1, 2024
2f57b0b
add terminated events section to GET endpoint
toger5 Oct 1, 2024
9d5c93a
use case specific considerations details
toger5 Oct 1, 2024
da3d75e
remove batch sending endpoint since that does not make sense in the s…
toger5 Oct 2, 2024
f7e4e9b
Clean up iteration with two significant changes:
toger5 Oct 4, 2024
b8e317f
terminated -> finalised
toger5 Oct 4, 2024
b499995
andrews changes
toger5 Oct 4, 2024
8dc05a4
requried -> required
AndrewFerr Oct 7, 2024
0a777f4
Change example of "canceled" outcome to "cancel"
AndrewFerr Oct 8, 2024
a09a883
Minor formatting changes
AndrewFerr Oct 9, 2024
72a808e
Allow servers to discard returned finalised events
AndrewFerr Oct 22, 2024
d1a37f0
Define finalised events for /sync & /transactions
AndrewFerr Oct 22, 2024
3358138
use current MatrixRTC MSC types.
toger5 Jun 27, 2025
904e3d6
review trivial changes
toger5 Jul 9, 2025
c25e5a3
Add rate limit section to `GET` `finalized` and `scheduled` endpoint
toger5 Jul 10, 2025
96f9063
clarify why there is no rate limiting for the delayed event managemen…
toger5 Jul 10, 2025
99b79ba
remove `on push` delayed event finilization section
toger5 Jul 10, 2025
dc5fd93
formatting/cleanup
toger5 Jul 10, 2025
bf5df9b
fix synapse and MSC inconsistency
toger5 Jul 10, 2025
2f53661
Constrain delay value to >0ms
AndrewFerr Sep 24, 2025
fd94c18
Editorial fixes
tulir Sep 26, 2025
e532e93
Remove optional wording of limits
tulir Sep 26, 2025
0d7821a
Add syncing failed delayed events to alternatives
tulir Sep 26, 2025
64f6dfc
Define retrying and responses for managing delayed events
tulir Sep 26, 2025
ba78cde
Specify delay_id grammar
AndrewFerr Oct 1, 2025
c2587fe
Specify missing HTTP response codes
AndrewFerr Oct 1, 2025
1036165
Explain `outcome` and `reason` on finalised events
AndrewFerr Oct 1, 2025
2afcebb
Merge GET endpoints to avoid namespace clash
AndrewFerr Oct 1, 2025
8c5b612
Add send time as alternative to `running_since`
AndrewFerr Oct 1, 2025
6afd0f3
Use opaque identifier grammar for delay_id
AndrewFerr Oct 1, 2025
1359f2b
Merge /scheduled and /finalised as query params
AndrewFerr Oct 1, 2025
59392f2
Allow GET endpoint to filter on ID
AndrewFerr Oct 1, 2025
f167eb4
Tweak wording/spelling/format
AndrewFerr Oct 1, 2025
3efecea
Move delayed state event cancelling to alternative
AndrewFerr Oct 1, 2025
4bb8929
Move M_CANCELLED_BY_STATE_UPDATE out of main spec
AndrewFerr Oct 1, 2025
24d1c7d
Tweak spelling/format
AndrewFerr Oct 1, 2025
2f4a73a
Remove rendundant & stale table of contents
AndrewFerr Oct 1, 2025
33af637
Tweak formatting & wording of `status` section
AndrewFerr Oct 2, 2025
76d015a
Don't return 400 for multiple `status` parameters
AndrewFerr Oct 2, 2025
cdcddd2
Reduce emphasis on state events
AndrewFerr Oct 2, 2025
d6c065e
Fix swapped links to /send and /state
AndrewFerr Oct 3, 2025
0a18141
Update all spec links to v1.16
AndrewFerr Oct 3, 2025
a53f83f
Fix typo
AndrewFerr Oct 10, 2025
eb0a504
Always require origin_server_ts on finalised evts
AndrewFerr Oct 10, 2025
9db8058
Limit cached finalised events per user, not global
AndrewFerr Oct 10, 2025
c19a394
Apply batch size to not just finalised events
AndrewFerr Oct 10, 2025
e2af939
Note deviations in Synapse implementation
AndrewFerr Oct 20, 2025
061dd56
Reintroduce unauthed management for delegation
AndrewFerr Oct 27, 2025
79aeaf5
Mention single-URL management as an alternative
AndrewFerr Oct 27, 2025
3ee73ab
Use correct version for event sending endpoints
AndrewFerr Dec 15, 2025
1618990
Use dedicated endpoint for delayed event creation
AndrewFerr Jan 5, 2026
b045f1d
Update all spec links to v1.17
AndrewFerr Jan 5, 2026
8a98ec4
Specify unstable version of new endpoint path
AndrewFerr Jan 5, 2026
18e0e6b
Prefer M_RESOURCE_LIMIT_EXCEEDED over a new error
AndrewFerr Jan 6, 2026
673c2f3
Fix typo
AndrewFerr Jan 6, 2026
49b200d
Add "`delay_id` in `unsigned` sync field" section
toger5 Feb 17, 2026
3ef314f
Do not use M_RESOURCE_LIMIT_EXCEEDED
toger5 Feb 17, 2026
95045cf
update error code prefix
toger5 Feb 17, 2026
642b09e
M_LIMIT_EXCEEDED -> M_USER_LIMIT_EXCEEDED
toger5 Feb 17, 2026
1e527c3
Update proposals/4140-delayed-events-futures.md
toger5 Mar 3, 2026
a790e5a
Use unstable prefix for unsigned data key
AndrewFerr Mar 5, 2026
0864869
Tweak when to include `delay_id` in `unsigned`
AndrewFerr Mar 5, 2026
bad3419
Revert "M_LIMIT_EXCEEDED -> M_USER_LIMIT_EXCEEDED"
AndrewFerr Mar 6, 2026
9dfc5d9
Restore "in the proposal stage" -> "unstable"
AndrewFerr Mar 6, 2026
30426d6
Put delay_id in unsigned for all event renderings
AndrewFerr Mar 9, 2026
1cb8134
Mention security requirement for `delay_id`
AndrewFerr Mar 13, 2026
d4172b2
Use M_LIMIT_EXCEEDED with 429 and Retry-After
AndrewFerr Mar 13, 2026
6c40331
Update all spec links to v1.18
AndrewFerr May 14, 2026
04d5399
Wrap all lines to 120 characters maximum
AndrewFerr May 14, 2026
ba58da7
Move "`delay_id` in `unsigned` event data" section
AndrewFerr May 14, 2026
5bff28e
Capitalize Client-Server API; server -> homeserver
AndrewFerr May 14, 2026
25e4a86
Clarify authentication & scheduled delayed events
AndrewFerr May 14, 2026
7610074
Clarify error responses
AndrewFerr May 14, 2026
2b0fb6a
Support timestamp massaging
AndrewFerr May 14, 2026
1e18fa2
Tweak management endpoints
AndrewFerr May 14, 2026
cdc7a20
Add single-item lookup, tweak multi-item lookup
AndrewFerr May 15, 2026
45590a9
Suggest to not reschedule events on failure
AndrewFerr May 15, 2026
799a9e9
Some more rewording & clarification
AndrewFerr May 15, 2026
025ba39
Minor rewording & reformatting
AndrewFerr May 15, 2026
8decf69
Update proposals/4140-delayed-events-futures.md
toger5 May 19, 2026
dc5716d
Update proposals/4140-delayed-events-futures.md
toger5 May 19, 2026
e450d2c
Update proposals/4140-delayed-events-futures.md
toger5 May 19, 2026
3a3a395
Update proposals/4140-delayed-events-futures.md
toger5 May 19, 2026
5978fc8
Update proposals/4140-delayed-events-futures.md
toger5 May 19, 2026
00b82ee
Update proposals/4140-delayed-events-futures.md
toger5 May 19, 2026
c9ee45b
Update proposals/4140-delayed-events-futures.md
toger5 May 19, 2026
d0cf2e5
Update proposals/4140-delayed-events-futures.md
toger5 May 19, 2026
42eecc5
Shorten alternatives (#4479)
Johennes May 20, 2026
88ac1f3
*MSC4140: Convert cancelling delayed state events alternative into br…
Johennes May 20, 2026
50f1e16
latest to versioned spec link
AndrewFerr May 20, 2026
7c28d40
Remove implementation TODOs
AndrewFerr May 20, 2026
bf2af1c
Discuss `M_MAX_DELAYED_EVENTS_EXCEEDED`
AndrewFerr May 20, 2026
2b04053
Fix links to management section
AndrewFerr May 21, 2026
d155b43
Clarify that delegation is for scheduled events
AndrewFerr May 21, 2026
d4bb767
Update proposals/4140-delayed-events-futures.md
Johennes May 22, 2026
8f9f454
Trade `M_MAX_DELAY_EXCEEDED` for a capability
AndrewFerr May 29, 2026
e557016
Rename finalised time field to `finalised_ts`
AndrewFerr May 29, 2026
06ab77a
Add & explain alternatives to `running_since`
AndrewFerr May 29, 2026
3232ba9
Minor tweaks
AndrewFerr May 29, 2026
5977f94
Explain how to determine status from fields
AndrewFerr May 29, 2026
1a57812
Minor formatting
AndrewFerr May 29, 2026
d67fa21
Add missing brace
Johennes Jun 1, 2026
88859bd
Simplify the bulk retrieval endpoint
AndrewFerr Jun 1, 2026
15f2b54
Warn about heartbeat ratelimits
AndrewFerr Jun 1, 2026
f90b582
Remove (intentional) misspelling to pass CI
AndrewFerr Jun 1, 2026
06de601
*MSC4140: Blend use case specific considerations into the introductio…
Johennes Jun 2, 2026
ed1e3d8
Use consistent grammar for status types
AndrewFerr Jun 2, 2026
e2a3dc3
Elaborate on why `/sync` isn't supported yet
AndrewFerr Jun 2, 2026
f056d91
Move filtering & pagination to MSC4486
Johennes Jun 3, 2026
774d619
Add missing MSC link
Johennes Jun 3, 2026
151698d
Generalize event availability statement
Johennes Jun 3, 2026
0afc361
Shorten MSC4018 alternative
Johennes Jun 3, 2026
a082be4
Shorten summary of federation alternative
Johennes Jun 3, 2026
a369137
Fix typo
Johennes Jun 3, 2026
8dfbe7b
Use proper sentence case
Johennes Jun 3, 2026
a912a46
Shorten formulation
Johennes Jun 3, 2026
cbd7d59
Fix typo
Johennes Jun 3, 2026
41dfe2a
Emphasize reason for crypto-secure delay_id
AndrewFerr Jun 3, 2026
206c4ae
Use consistent style for introducing new endpoints
AndrewFerr Jun 3, 2026
be4152d
Clarify the endpoints for delegated management
AndrewFerr Jun 3, 2026
67a8cc9
Note properties now absent from bulk lookup items
AndrewFerr Jun 3, 2026
0a70ab6
Don't say bulk lookup may discard finalised events
AndrewFerr Jun 3, 2026
367aa87
Small wording & grammar adjustment
AndrewFerr Jun 3, 2026
946a8a9
Add special-case error for disabled delayed events
AndrewFerr Jun 8, 2026
0ae35c4
Remove batch size for now-removed bulk endpoint
AndrewFerr Jun 9, 2026
87ab48f
Wrap more lines to 120 characters
AndrewFerr Jun 16, 2026
fcffc2d
Add delayed event persistence & startup send
AndrewFerr Jun 16, 2026
8fee4cf
Rename `send_time` alternative to `send_ts`
AndrewFerr Jun 18, 2026
fd27ef0
Append "_ms" to delay-related field names
AndrewFerr Jun 24, 2026
f184579
Rename `running_since` to `scheduled_at`
AndrewFerr Jun 24, 2026
195cd46
Use /v1.18 rather than /latest
Johennes Jun 29, 2026
1faf2bf
User `/v1.18` rather than `/latest`
Johennes Jun 29, 2026
c4e11f9
Clarify maximum delay
Johennes Jun 29, 2026
5b60413
Use `/v1.18` rather than `/latest`
Johennes Jun 29, 2026
a8db096
Use `/v1.18` rather than `/latest`
Johennes Jun 29, 2026
2be95cb
Use `/v1.18` rather than `/latest`
Johennes Jun 29, 2026
e3656b9
Use `/v1.18` rather than `/latest`
Johennes Jun 29, 2026
019ab02
Use `/v1.18` rather than `/latest`
Johennes Jun 29, 2026
4cea2ce
Shorten consideration of compatibility with MSC4080
Johennes Jun 29, 2026
963c20d
Link to MQTT spec for will messages
Johennes Jun 29, 2026
37ed74d
Remove filtering claim for query parameter alternative
Johennes Jun 29, 2026
955ecf5
Elaborate & link to criticism of shared endpoint
AndrewFerr Jun 30, 2026
d91a932
Use M_FORBIDDEN/403 for disallowed delayed events
AndrewFerr Jun 30, 2026
9447ee0
Use M_FORBIDDEN/403 for exceeding the max delay
AndrewFerr Jun 30, 2026
21c8961
Add example for other required details for delegation
Johennes Jul 7, 2026
170e329
Fix leftover conversion from /refresh to /restart
Johennes Jul 7, 2026
4724aa4
Clarify uniqueness of delay IDs
Johennes Jul 7, 2026
5dac49c
Clarify security aspects of delayed event delegation
Johennes Jul 7, 2026
b75b9fc
Reword rules on access of GET /{delay_id}
AndrewFerr Jul 8, 2026
2f3b817
Clarify when to include `delay_id` in `unsigned`
AndrewFerr Jul 8, 2026
cd878d2
Drop delegation; require auth on management
AndrewFerr Jul 10, 2026
e5f656b
Remove tea timer usecase
AndrewFerr Jul 27, 2026
15770e6
Clarify that enforced limits must be in capability
AndrewFerr Jul 27, 2026
bcd8dbb
Rephrase sentence
AndrewFerr Aug 4, 2026
f0ad189
Remove section on conflicting delayed state events
AndrewFerr Aug 4, 2026
6c3911d
Remove special case for delayed event limit of 0
robintown Aug 6, 2026
fc9077a
Avoid describe homeserver implementation details
robintown Aug 6, 2026
0c7193a
Use a new M_DELAY_TOO_LARGE error code and HTTP 400
robintown Aug 6, 2026
2d42daf
Clarify that the endpoints are scoped to users
robintown Aug 6, 2026
b9efebe
Rename `scheduled_at` to `delayed_since_ts`
AndrewFerr Aug 17, 2026
0ffd673
Move finalised properties into its own sub-object
AndrewFerr Aug 17, 2026
ae66993
Enforce schedule-time event validation check
AndrewFerr Aug 17, 2026
1f7822f
Add other fields that prevent eventID calculation
AndrewFerr Aug 17, 2026
bee5de6
Pick up link to SFU definition
AndrewFerr Aug 17, 2026
5a81974
Clarify chronological ordering
AndrewFerr Aug 17, 2026
ca9f55a
Say that usual rate limits on event sending apply
AndrewFerr Aug 17, 2026
b40c841
Add unstable version of M_DELAY_TOO_LARGE
AndrewFerr Aug 17, 2026
e5bbe41
Collapse "querying finalised" events into "filtering"
Johennes Aug 18, 2026
83d9e10
Delegation also helps when the client is under adverse network condit…
Johennes Aug 18, 2026
062e649
Remove mention of adding lag for batch sending
AndrewFerr Aug 18, 2026
57a2403
Update `send` error to match non-delayed `/send`
AndrewFerr Aug 18, 2026
b1eb9b9
Move bulk lookup to MSC4486
AndrewFerr Aug 18, 2026
8de254b
Mention why servers shouldn't handle retries
AndrewFerr Aug 18, 2026
e2636d6
Don't enforce `M_UNKNOWN` for the 409 response
AndrewFerr Aug 18, 2026
fadd1f8
Explicitly omit `transaction_id` from `unsigned`
AndrewFerr Aug 18, 2026
7726f4c
Restrict value type of capability fields
AndrewFerr Aug 18, 2026
36800fc
Move capability-related limits next to each other
AndrewFerr Aug 18, 2026
442a51a
Mention delayed event limit being in a capability
AndrewFerr Aug 18, 2026
88d92a9
Update spec links to v1.19
AndrewFerr Aug 18, 2026
3784b6a
Fix egregious typo
AndrewFerr Aug 19, 2026
5d3a1ee
Explain purpose of retaining finalised events
AndrewFerr Aug 19, 2026
208b7b4
Always use term of "finalised delayed events"
AndrewFerr Aug 19, 2026
256957a
Replace "MUST NOT" with "SHOULD NOT" re: txnid
AndrewFerr Aug 19, 2026
530a45c
Add back special case of disabled delayed events
AndrewFerr Aug 18, 2026
ec7cbfd
Reword special case to be more general
AndrewFerr Aug 19, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Loading
Loading