matrix-org / matrix-org/matrix-spec
Appservice API /_matrix/app/v1/transactions/ should specify maximum transaction sizes
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 330
- Forks
- 150
- Avg merge
- 2h 21m
- Merged PRs (30d)
- 3
Description
This means we should specify a maximum limit on the number of events sent. Unstable MSCs for Appservices such as:
- https://github.com/matrix-org/matrix-spec-proposals/pull/3682
- https://github.com/matrix-org/matrix-spec-proposals/pull/3395
- https://github.com/matrix-org/matrix-spec-proposals/pull/2409
- https://github.com/matrix-org/matrix-spec-proposals/pull/3202
Will need to also specify their maximum sizes. This is needed because most HTTP listeners will specify a maximum body size for incoming requests, and in practice this is often exceeded when the AS receives a lot of traffic at once. For example, Nginx defaults to 1MB and while we shouldn't arbitrarily restrict the spec to what nginx supports, it's clear that an unlimited number of events will cause great pain.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the /_matrix/app/v1/transactions/ endpoint definition and review the linked unstable MSCs for payloads that also need limits. Determine a defensible maximum for events and related transaction sizes, then update the specification so those limits are explicit for the base endpoint and applicable MSCs.
Written by the indexing model from the issue text.
Assessment
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 30/100