From c616c46f5359f12dccff215038ccbef3ebbc4d9d Mon Sep 17 00:00:00 2001 From: Johannes Marbach Date: Tue, 25 Jun 2024 14:59:08 +0200 Subject: [PATCH 1/5] Clarify that dont_notify and coalesce MUST be gracefully ignored Signed-off-by: Johannes Marbach --- content/client-server-api/modules/push.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/content/client-server-api/modules/push.md b/content/client-server-api/modules/push.md index 2d828a016..30858d052 100644 --- a/content/client-server-api/modules/push.md +++ b/content/client-server-api/modules/push.md @@ -184,11 +184,13 @@ they are represented as a dictionary with a key equal to their name and other keys as their parameters, e.g. `{ "set_tweak": "sound", "value": "default" }`. -{{% boxes/note %}} +###### Historical Actions + Older versions of the Matrix specification included the `dont_notify` and -`coalesce` actions. These should both be considered no-ops (ignored, not -rejected) if received from a client. -{{% /boxes/note %}} +`coalesce` actions. Homeservers MUST ignore these actions by stripping them +from any actions array they encounter. This means that setting the actions +on a rule to e.g. `["dont_notify"]` MUST be equivalent to setting an empty +actions array. ##### Conditions From 6c310ca087c96c6b23fe39e1e135186dd17233c3 Mon Sep 17 00:00:00 2001 From: Johannes Marbach Date: Tue, 25 Jun 2024 15:04:49 +0200 Subject: [PATCH 2/5] Add changelog --- changelogs/client_server/newsfragments/1890.clarification | 1 + 1 file changed, 1 insertion(+) create mode 100644 changelogs/client_server/newsfragments/1890.clarification diff --git a/changelogs/client_server/newsfragments/1890.clarification b/changelogs/client_server/newsfragments/1890.clarification new file mode 100644 index 000000000..cf5ad8afa --- /dev/null +++ b/changelogs/client_server/newsfragments/1890.clarification @@ -0,0 +1 @@ +Clarify that the deprecated dont_notify and coalesce push rule actions MUST be ignored, not rejected by homeservers. From c7b387c58931bbedb2a38581cae1e79d0a11626f Mon Sep 17 00:00:00 2001 From: Johannes Marbach Date: Tue, 25 Jun 2024 16:10:54 +0200 Subject: [PATCH 3/5] Extend the logic to clients --- content/client-server-api/modules/push.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/content/client-server-api/modules/push.md b/content/client-server-api/modules/push.md index 30858d052..0b8e132e5 100644 --- a/content/client-server-api/modules/push.md +++ b/content/client-server-api/modules/push.md @@ -187,10 +187,10 @@ other keys as their parameters, e.g. ###### Historical Actions Older versions of the Matrix specification included the `dont_notify` and -`coalesce` actions. Homeservers MUST ignore these actions by stripping them -from any actions array they encounter. This means that setting the actions -on a rule to e.g. `["dont_notify"]` MUST be equivalent to setting an empty -actions array. +`coalesce` actions. Clients and homeservers MUST ignore these actions, for +instance, by stripping them from actions arrays they encounter. This means, +for example, that a rule with `["dont_notify"]` actions MUST be equivalent +to a rule with an empty actions array. ##### Conditions From 39e19545e9e7ad4164b657a4de61186cf61d9be8 Mon Sep 17 00:00:00 2001 From: Johannes Marbach Date: Tue, 25 Jun 2024 16:15:22 +0200 Subject: [PATCH 4/5] Include clients in changelog entry --- changelogs/client_server/newsfragments/1890.clarification | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/changelogs/client_server/newsfragments/1890.clarification b/changelogs/client_server/newsfragments/1890.clarification index cf5ad8afa..84e578c13 100644 --- a/changelogs/client_server/newsfragments/1890.clarification +++ b/changelogs/client_server/newsfragments/1890.clarification @@ -1 +1 @@ -Clarify that the deprecated dont_notify and coalesce push rule actions MUST be ignored, not rejected by homeservers. +Clarify that the deprecated dont_notify and coalesce push rule actions MUST be ignored, not rejected. From 42e000b9d9c97c79a714c2c40dffb098b122079c Mon Sep 17 00:00:00 2001 From: Patrick Cloke Date: Tue, 9 Jul 2024 21:34:06 -0400 Subject: [PATCH 5/5] Update changelog. --- changelogs/client_server/newsfragments/1890.clarification | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/changelogs/client_server/newsfragments/1890.clarification b/changelogs/client_server/newsfragments/1890.clarification index 84e578c13..1e97a8e55 100644 --- a/changelogs/client_server/newsfragments/1890.clarification +++ b/changelogs/client_server/newsfragments/1890.clarification @@ -1 +1 @@ -Clarify that the deprecated dont_notify and coalesce push rule actions MUST be ignored, not rejected. +Clarify that the deprecated `dont_notify` and `coalesce` push rule actions MUST be ignored, not rejected.