From 49054070922958141808c48e9204cd5cdf6ca164 Mon Sep 17 00:00:00 2001
From: mathieui <mathieui@mathieui.net>
Date: Sat, 28 May 2016 14:46:39 +0200
Subject: Fix the ordering of stream features
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

since iq.send is non-blocking, some features handlers could end up
being executed before others were set, leading to issues. Adding yield
from where it’s necessary fixes that.
---
 slixmpp/clientxmpp.py                       | 16 +++++++++++-----
 slixmpp/features/feature_bind/bind.py       |  4 +++-
 slixmpp/features/feature_session/session.py |  4 +++-
 3 files changed, 17 insertions(+), 7 deletions(-)

diff --git a/slixmpp/clientxmpp.py b/slixmpp/clientxmpp.py
index 40d20333..0971e304 100644
--- a/slixmpp/clientxmpp.py
+++ b/slixmpp/clientxmpp.py
@@ -12,6 +12,7 @@
     :license: MIT, see LICENSE for more details
 """
 
+import asyncio
 import logging
 
 from slixmpp.stanza import StreamFeatures
@@ -19,7 +20,7 @@ from slixmpp.basexmpp import BaseXMPP
 from slixmpp.exceptions import XMPPError
 from slixmpp.xmlstream import XMLStream
 from slixmpp.xmlstream.matcher import StanzaPath, MatchXPath
-from slixmpp.xmlstream.handler import Callback
+from slixmpp.xmlstream.handler import Callback, CoroutineCallback
 
 # Flag indicating if DNS SRV records are available for use.
 try:
@@ -104,9 +105,9 @@ class ClientXMPP(BaseXMPP):
         self.register_stanza(StreamFeatures)
 
         self.register_handler(
-                Callback('Stream Features',
-                         MatchXPath('{%s}features' % self.stream_ns),
-                         self._handle_stream_features))
+                CoroutineCallback('Stream Features',
+                     MatchXPath('{%s}features' % self.stream_ns),
+                     self._handle_stream_features))
         self.register_handler(
                 Callback('Roster Update',
                          StanzaPath('iq@type=set/roster'),
@@ -249,6 +250,7 @@ class ClientXMPP(BaseXMPP):
         self.bindfail = False
         self.features = set()
 
+    @asyncio.coroutine
     def _handle_stream_features(self, features):
         """Process the received stream features.
 
@@ -257,7 +259,11 @@ class ClientXMPP(BaseXMPP):
         for order, name in self._stream_feature_order:
             if name in features['features']:
                 handler, restart = self._stream_feature_handlers[name]
-                if handler(features) and restart:
+                if asyncio.iscoroutinefunction(handler):
+                    result = yield from handler(features)
+                else:
+                    result = handler(features)
+                if result and restart:
                     # Don't continue if the feature requires
                     # restarting the XML stream.
                     return True
diff --git a/slixmpp/features/feature_bind/bind.py b/slixmpp/features/feature_bind/bind.py
index c031ab72..e837ee0a 100644
--- a/slixmpp/features/feature_bind/bind.py
+++ b/slixmpp/features/feature_bind/bind.py
@@ -6,6 +6,7 @@
     See the file LICENSE for copying permission.
 """
 
+import asyncio
 import logging
 
 from slixmpp.jid import JID
@@ -34,6 +35,7 @@ class FeatureBind(BasePlugin):
         register_stanza_plugin(Iq, stanza.Bind)
         register_stanza_plugin(StreamFeatures, stanza.Bind)
 
+    @asyncio.coroutine
     def _handle_bind_resource(self, features):
         """
         Handle requesting a specific resource.
@@ -49,7 +51,7 @@ class FeatureBind(BasePlugin):
         if self.xmpp.requested_jid.resource:
             iq['bind']['resource'] = self.xmpp.requested_jid.resource
 
-        iq.send(callback=self._on_bind_response)
+        yield from iq.send(callback=self._on_bind_response)
 
     def _on_bind_response(self, response):
         self.xmpp.boundjid = JID(response['bind']['jid'])
diff --git a/slixmpp/features/feature_session/session.py b/slixmpp/features/feature_session/session.py
index 0635455a..2f9548eb 100644
--- a/slixmpp/features/feature_session/session.py
+++ b/slixmpp/features/feature_session/session.py
@@ -6,6 +6,7 @@
     See the file LICENSE for copying permission.
 """
 
+import asyncio
 import logging
 
 from slixmpp.stanza import Iq, StreamFeatures
@@ -34,6 +35,7 @@ class FeatureSession(BasePlugin):
         register_stanza_plugin(Iq, stanza.Session)
         register_stanza_plugin(StreamFeatures, stanza.Session)
 
+    @asyncio.coroutine
     def _handle_start_session(self, features):
         """
         Handle the start of the session.
@@ -44,7 +46,7 @@ class FeatureSession(BasePlugin):
         iq = self.xmpp.Iq()
         iq['type'] = 'set'
         iq.enable('session')
-        iq.send(callback=self._on_start_session_response)
+        yield from iq.send(callback=self._on_start_session_response)
 
     def _on_start_session_response(self, response):
         self.xmpp.features.add('session')
-- 
cgit v1.2.3