-
Notifications
You must be signed in to change notification settings - Fork 412
MSC3958: Suppress notifications from message edits #3958
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.
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
Merged
Merged
Changes from 1 commit
Commits
Show all changes
15 commits
Select commit
Hold shift + click to select a range
acf68ea
Suppress message edits.
clokep 344c18f
Fix typo.
clokep 09bb6ac
Add @room.
clokep 2ab860a
Match MSC title to PR.
clokep 216a54c
Add a potential issue.
clokep 69bd78b
Clarify rule placement.
clokep 950ad36
Change link text.
clokep 59d9172
Fix typo.
clokep 02fd5c7
Add a note about mobile clients.
clokep c0f11a1
Update from anoa's feedback.
clokep 876e19f
Updates for Matrix 1.7
clokep f93d03d
Update more spec links.
clokep 5c603f0
Minor clarifications.
clokep 1128719
Add downside about "all messages"
clokep 33083c0
Clarify again that this *does* work with all messages.
clokep File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,80 @@ | ||
# MSC3958: Suppress notifications of message edits | ||
|
||
[Event replacement](https://spec.matrix.org/v1.5/client-server-api/#event-replacements) | ||
(more commonly known as message edits) signals that a message is intended to | ||
be replaced with new content. | ||
|
||
This works well for fixing typos or correcting information, but tends to cause | ||
spurious notifications if the event mentions a user. This contributes to notification | ||
fatigue as the additional notifications contain no new information. | ||
|
||
|
||
## Proposal | ||
|
||
A new default push rule is added to suppress notifications [due to edits](https://spec.matrix.org/v1.5/client-server-api/#event-replacements). | ||
clokep marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
```json | ||
{ | ||
"rule_id": ".m.rule.suppress_edits", | ||
"default": true, | ||
"enabled": true, | ||
"conditions": [ | ||
{ | ||
"kind": "event_match", | ||
"key": "content.m.relates_to.rel_type", | ||
clokep marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
"pattern": "m.replace" | ||
} | ||
], | ||
"actions": [] | ||
} | ||
``` | ||
|
||
This rule should be placed as the [first override rule](https://spec.matrix.org/v1.5/client-server-api/#default-override-rules). | ||
clokep marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
It would match events such as those given in [event replacements](https://spec.matrix.org/v1.5/client-server-api/#event-replacements) | ||
portion of the spec: | ||
|
||
```json5 | ||
{ | ||
"type": "m.room.message", | ||
"content": { | ||
"body": "* Hello! My name is bar", | ||
"msgtype": "m.text", | ||
"m.new_content": { | ||
"body": "Hello! My name is bar", | ||
"msgtype": "m.text" | ||
}, | ||
"m.relates_to": { | ||
"rel_type": "m.replace", | ||
"event_id": "$some_event_id" | ||
} | ||
}, | ||
// ... other fields required by events | ||
} | ||
``` | ||
|
||
## Potential issues | ||
clokep marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
clokep marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
Some users may be depending on notifications of edits. If a user would like to | ||
revert to the old behavior they can disable the `.m.rule.suppress_edits` push rule. | ||
|
||
If the message edits were alloewd by other senders than it would be useful to | ||
clokep marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
know that your own message was edited, but this | ||
[is not currently allowed](https://spec.matrix.org/v1.5/client-server-api/#validity-of-replacement-events). | ||
|
||
## Alternatives | ||
clokep marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
None explored. | ||
|
||
## Security considerations | ||
|
||
None forseen. | ||
|
||
## Unstable prefix | ||
|
||
The unstable prefix of `.com.beeper.suppress_edits` should be used in place of | ||
`.m.rule.suppress_edits`. | ||
|
||
## Dependencies | ||
|
||
N/A |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.