From 4bc357a0ad75f5282a9e43b8ffbf71f6b644784a Mon Sep 17 00:00:00 2001 From: Georg Lukas Date: Tue, 15 Jan 2019 16:48:33 +0100 Subject: [PATCH 1/8] XEP-0410: advertise self-ping optimization --- xep-0410.xml | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/xep-0410.xml b/xep-0410.xml index 2c875d03..b9d368bc 100644 --- a/xep-0410.xml +++ b/xep-0410.xml @@ -174,7 +174,19 @@ ping request might never be responded to.

Therefore, a MUC service supporting this protocol may directly respond to a participant's Ping request to the participant's own nickname, as - opposed to routing it to any of the participant's clients.

+ opposed to routing it to any of the participant's clients. A service + implementing this behavior needs to advertise the + self-ping-optimization feature in the &xep0030; response on + the individual MUC room JIDs.

+ + + + + + +]]> From 9adae7a321771843505867df1ae199b155f3ce54 Mon Sep 17 00:00:00 2001 From: Georg Lukas Date: Tue, 15 Jan 2019 16:53:50 +0100 Subject: [PATCH 2/8] XEP-0410: fill out formal requirement chapters --- xep-0410.xml | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/xep-0410.xml b/xep-0410.xml index b9d368bc..e1f87f4c 100644 --- a/xep-0410.xml +++ b/xep-0410.xml @@ -205,12 +205,13 @@ implementing this specification.

 -

REQUIRED.

+

This document requires no interaction with &IANA;.

 -

REQUIRED.

+

Include "http://jabber.org/protocol/muc#self-ping-optimization" + as a valid feature in the Registry of Features.

 -

REQUIRED for protocol specifications.

+

This document does not define any new XML structure requiring a schema.

 From e56fc624a19e3a34388d246b2c70c44ad11c45f3 Mon Sep 17 00:00:00 2001 From: Georg Lukas Date: Tue, 15 Jan 2019 17:26:10 +0100 Subject: [PATCH 3/8] XEP-0410: mention 0198 and explicit re-join --- xep-0410.xml | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/xep-0410.xml b/xep-0410.xml index e1f87f4c..11a7c9e7 100644 --- a/xep-0410.xml +++ b/xep-0410.xml @@ -61,7 +61,8 @@ protocol).

This specification aims to provide the most efficient, albeit not the most elegant, way for clients to periodically check whether they are still - joined to a chatroom.

+ joined to a chatroom. However, it can not ensure that a client remains + joined to a room without any interruptions.

This specification only makes sense in the context of &xep0045; @@ -158,7 +159,7 @@ joined, but the participant just changed their name (e.g. initiated by a different client).

  • Any other error: the client is probably not - joined.
    • + joined any more. It should perform a re-join.
  • Timeout (no response): the MUC service (or another client) is unreachable. The client may indicate the status to the user and re-attempt the self-ping after some timeout, until it receives @@ -198,6 +199,9 @@ change, and before receiving the response to the nickname change from the service, as it is not yet clear whether the new nickname will be accepted.

    +

    If a client session is in hibernation (&xep0198;), the client should defer + sending of self-ping requests until it is reconnected and re-authenticated. +

    A MUC service implementation should not allow a non-participant to obtain From c2405e08fd36634d9dfc231645942014d371a707 Mon Sep 17 00:00:00 2001 From: Georg Lukas Date: Tue, 15 Jan 2019 19:03:28 +0100 Subject: [PATCH 4/8] XEP-0410: add formal XMPP Registry Submission, thx jonas --- xep-0410.xml | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/xep-0410.xml b/xep-0410.xml index 11a7c9e7..3043712b 100644 --- a/xep-0410.xml +++ b/xep-0410.xml @@ -214,6 +214,14 @@

    Include "http://jabber.org/protocol/muc#self-ping-optimization" as a valid feature in the Registry of Features.

    + + http://jabber.org/protocol/muc#self-ping-optimization + Support for the MUC self-ping optimization + XEP-0410 + +]]> +

    This document does not define any new XML structure requiring a schema.

    From efb0c8cc80dd6945e95f536cf2c099933c60e538 Mon Sep 17 00:00:00 2001 From: Georg Lukas Date: Mon, 28 Jan 2019 11:35:32 +0100 Subject: [PATCH 5/8] XEP-0410: add footnote about expected service errors --- xep-0410.xml | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/xep-0410.xml b/xep-0410.xml index 3043712b..24f5c6d8 100644 --- a/xep-0410.xml +++ b/xep-0410.xml @@ -158,7 +158,11 @@
  • Error (<item-not-found>): the client is joined, but the participant just changed their name (e.g. initiated by a different client).
    • -
  • Any other error: the client is probably not +
  • Any other errorDifferent service + implementations will send different responses to a client that's not + joined. The recommended error code is <not-acceptable>, however + some servers will respond with <not-allowed> or + <bad-request> as well.: the client is probably not joined any more. It should perform a re-join.
  • Timeout (no response): the MUC service (or another client) is unreachable. The client may indicate the status to the user From 373f19a4755ec01c546e00fded5494f6117bb102 Mon Sep 17 00:00:00 2001 From: Georg Lukas Date: Mon, 28 Jan 2019 11:35:55 +0100 Subject: [PATCH 6/8] XEP-0410: add mandatory service response for self-optimization --- xep-0410.xml | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/xep-0410.xml b/xep-0410.xml index 24f5c6d8..71843f34 100644 --- a/xep-0410.xml +++ b/xep-0410.xml @@ -180,9 +180,14 @@

    Therefore, a MUC service supporting this protocol may directly respond to a participant's Ping request to the participant's own nickname, as opposed to routing it to any of the participant's clients. A service - implementing this behavior needs to advertise the + implementing this optimization needs to advertise the self-ping-optimization feature in the &xep0030; response on - the individual MUC room JIDs.

    + the individual MUC room JIDs, and it MUST respond to a self-ping request + as follows:

    +
      +
    • Successful IQ response: the client is joined to the MUC.
      • +
    • Error (<not-acceptable>): the client is not joined to the MUC.
      • +
    From d4dda9ec05aaa344381d039d1fc46c4fd6bf9777 Mon Sep 17 00:00:00 2001 From: Georg Lukas Date: Tue, 29 Jan 2019 17:14:23 +0100 Subject: [PATCH 7/8] XEP-0410: use correct term - s/participant/occupant/ --- xep-0410.xml | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/xep-0410.xml b/xep-0410.xml index 71843f34..ec9efcbd 100644 --- a/xep-0410.xml +++ b/xep-0410.xml @@ -53,9 +53,9 @@ not designed to handle s2s interruptions or message loss well. Rather often, the restart of a server or a component causes a client to believe that it is still joined to a given chatroom, while the chatroom service - does not know of this participant.

    + does not know of this occupant.

    Existing approaches for re-synchronization are either inefficient - (presence updates and "silent" messages are reflected to all participants, + (presence updates and "silent" messages are reflected to all occupants, totalling to O(N²) stanzas per time unit), or mask message / presence losses (the implicit join performed via the deprecated GC1.0 protocol).

    @@ -76,8 +76,8 @@ and a typically local server-to-component link. If one of the involved servers or the MUC component is restarted, or one of the links is disturbed for some time, this can lead to the removal of some or all - participants from the affected MUCs, without the clients being informed.

    -

    To a participant, this looks like the MUC is silent (there is no chat + occupants from the affected MUCs, without the clients being informed.

    +

    To an occupant, this looks like the MUC is silent (there is no chat activity and no presence changes), making it hard to realize that the connection was interrupted.

    To prevent the bad usability effect (message loss, lack of reaction from @@ -88,13 +88,13 @@ it is still joined to a MUC:

    1. Silent message (e.g. &xep0085;): this message will be reflected to - all MUC participants, causing unwanted traffic and potentially waking + all MUC occupants, causing unwanted traffic and potentially waking up mobile devices without reason. If implemented by all clients, this will result in O(N²) messages to the MUC.
    2. Presence update: if the MUC service implements the legacy GC1.0 protocol, this will be treated as a join attempt, and the MUC will return the - full list of participants and full room history. The user's client - will however miss partial history (other participants leaving, + full list of occupants and full room history. The user's client + will however miss partial history (other occupants leaving, potentially also messages), and this has the same drawbacks as the first solution.
    3. Private message to self: the client can send a MUC @@ -102,7 +102,7 @@ private messages, and there is no way to differentiate that from the error responses.
    4. Private IQ to self: the client can send an IQ to - its own participant JID. MUCs typically do not forbid those, and + its own occupant JID. MUCs typically do not forbid those, and reflect the IQ request to the client (or another client of the same user). Once that client responds to the reflected IQ, the response is delivered to the initiating client as a sign of still being joined. @@ -131,7 +131,7 @@

      If Juliet's client is not joined, the MUC service will respond with a <not-acceptable> error. Thus, her client can automatically attempt a rejoin.

      - @@ -156,7 +156,7 @@ <feature-not-implemented>): the client is joined, but the pinged client does not implement &xep0199;.
    5. Error (<item-not-found>): the client is - joined, but the participant just changed their name (e.g. initiated by + joined, but the occupant just changed their name (e.g. initiated by a different client).
    6. Any other errorDifferent service implementations will send different responses to a client that's not @@ -178,8 +178,8 @@ connectivity issues, which is often the case with mobile devices, the ping request might never be responded to.

      Therefore, a MUC service supporting this protocol may directly respond - to a participant's Ping request to the participant's own nickname, as - opposed to routing it to any of the participant's clients. A service + to a occupant's Ping request to the occupant's own nickname, as + opposed to routing it to any of the occupant's clients. A service implementing this optimization needs to advertise the self-ping-optimization feature in the &xep0030; response on the individual MUC room JIDs, and it MUST respond to a self-ping request @@ -201,7 +201,7 @@

      In Multi-Session-Nick scenarios, where multiple clients of the same user - are joined as the same participant, it is possible that another client + are joined as the same occupant, it is possible that another client initiates a nickname change while a ping request is pending. In that case, the ping might be responded to with <item-not-found>.

      A client should not perform a self-ping after initiating a nickname @@ -213,8 +213,8 @@

      -

      A MUC service implementation should not allow a non-participant to obtain - information about participants. This is however true irregardless of +

      A MUC service implementation should not allow a non-occupant to obtain + information about occupants. This is however true irregardless of implementing this specification.

       From b21b3504b5065fdc75014b60198e06f8c958b488 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jonas=20Sch=C3=A4fer?= Date: Mon, 4 Feb 2019 16:56:40 +0100 Subject: [PATCH 8/8] XEP-0410: add revision block --- xep-0410.xml | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/xep-0410.xml b/xep-0410.xml index ec9efcbd..f2e05a9b 100644 --- a/xep-0410.xml +++ b/xep-0410.xml @@ -29,6 +29,12 @@ georg@op-co.de georg@yax.im + + 0.2.0 + 2019-02-04 + gl + Incorporate feedback from Last Call. + 0.1.0 2018-08-31