mirror of
https://github.com/matrix-org/dendrite
synced 2024-11-03 14:39:00 +01:00
f05ce478f0
* Add Pushserver component with Pushers API Co-authored-by: Tommie Gannert <tommie@gannert.se> Co-authored-by: Dan Peleg <dan@globekeeper.com> * Wire Pushserver component Co-authored-by: Neil Alexander <neilalexander@users.noreply.github.com> * Add PushGatewayClient. The full event format is required for Sytest. * Add a pushrules module. * Change user API account creation to use the new pushrules module's defaults. Introduces "scope" as required by client API, and some small field tweaks to make some 61push Sytests pass. * Add push rules query/put API in Pushserver. This manipulates account data over User API, and fires sync messages for changes. Those sync messages should, according to an existing TODO in clientapi, be moved to userapi. Forks clientapi/producers/syncapi.go to pushserver/ for later extension. * Add clientapi routes for push rules to Pushserver. A cleanup would be to move more of the name-splitting logic into pushrules.go, to depollute routing.go. * Output rooms.join.unread_notifications in /sync. This is the read-side. Pushserver will be the write-side. * Implement pushserver/storage for notifications. * Use PushGatewayClient and the pushrules module in Pushserver's room consumer. * Use one goroutine per user to avoid locking up the entire server for one bad push gateway. * Split pushing by format. * Send one device per push. Sytest does not support coalescing multiple devices into one push. Matches Synapse. Either we change Sytest, or remove the group-by-url-and-format logic. * Write OutputNotificationData from push server. Sync API is already the consumer. * Implement read receipt consumers in Pushserver. Supports m.read and m.fully_read receipts. * Add clientapi route for /unstable/notifications. * Rename to UpsertPusher for clarity and handle pusher update * Fix linter errors * Ignore body.Close() error check * Fix push server internal http wiring * Add 40 newly passing 61push tests to whitelist * Add next 12 newly passing 61push tests to whitelist * Send notification data before notifying users in EDU server consumer * NATS JetStream * Goodbye sarama * Fix `NewStreamTokenFromString` * Consume on the correct topic for the roomserver * Don't panic, NAK instead * Move push notifications into the User API * Don't set null values since that apparently causes Element upsetti * Also set omitempty on conditions * Fix bug so that we don't override the push rules unnecessarily * Tweak defaults * Update defaults * More tweaks * Move `/notifications` onto `r0`/`v3` mux * User API will consume events and read/fully read markers from the sync API with stream positions, instead of consuming directly Co-authored-by: Piotr Kozimor <p1996k@gmail.com> Co-authored-by: Tommie Gannert <tommie@gannert.se> Co-authored-by: Neil Alexander <neilalexander@users.noreply.github.com>
71 lines
2 KiB
Go
71 lines
2 KiB
Go
package pushrules
|
|
|
|
// An AccountRuleSets carries the rule sets associated with an
|
|
// account.
|
|
type AccountRuleSets struct {
|
|
Global RuleSet `json:"global"` // Required
|
|
}
|
|
|
|
// A RuleSet contains all the various push rules for an
|
|
// account. Listed in decreasing order of priority.
|
|
type RuleSet struct {
|
|
Override []*Rule `json:"override,omitempty"`
|
|
Content []*Rule `json:"content,omitempty"`
|
|
Room []*Rule `json:"room,omitempty"`
|
|
Sender []*Rule `json:"sender,omitempty"`
|
|
Underride []*Rule `json:"underride,omitempty"`
|
|
}
|
|
|
|
// A Rule contains matchers, conditions and final actions. While
|
|
// evaluating, at most one rule is considered matching.
|
|
//
|
|
// Kind and scope are part of the push rules request/responses, but
|
|
// not of the core data model.
|
|
type Rule struct {
|
|
// RuleID is either a free identifier, or the sender's MXID for
|
|
// SenderKind. Required.
|
|
RuleID string `json:"rule_id"`
|
|
|
|
// Default indicates whether this is a server-defined default, or
|
|
// a user-provided rule. Required.
|
|
//
|
|
// The server-default rules have the lowest priority.
|
|
Default bool `json:"default"`
|
|
|
|
// Enabled allows the user to disable rules while keeping them
|
|
// around. Required.
|
|
Enabled bool `json:"enabled"`
|
|
|
|
// Actions describe the desired outcome, should the rule
|
|
// match. Required.
|
|
Actions []*Action `json:"actions"`
|
|
|
|
// Conditions provide the rule's conditions for OverrideKind and
|
|
// UnderrideKind. Not allowed for other kinds.
|
|
Conditions []*Condition `json:"conditions"`
|
|
|
|
// Pattern is the body pattern to match for ContentKind. Required
|
|
// for that kind. The interpretation is the same as that of
|
|
// Condition.Pattern.
|
|
Pattern string `json:"pattern"`
|
|
}
|
|
|
|
// Scope only has one valid value. See also AccountRuleSets.
|
|
type Scope string
|
|
|
|
const (
|
|
UnknownScope Scope = ""
|
|
GlobalScope Scope = "global"
|
|
)
|
|
|
|
// Kind is the type of push rule. See also RuleSet.
|
|
type Kind string
|
|
|
|
const (
|
|
UnknownKind Kind = ""
|
|
OverrideKind Kind = "override"
|
|
ContentKind Kind = "content"
|
|
RoomKind Kind = "room"
|
|
SenderKind Kind = "sender"
|
|
UnderrideKind Kind = "underride"
|
|
)
|