Merge lp:~pconnell/endroid/pinger into lp:endroid

[Phil Connell]

Improve reliability of periodic pinger

- Handle failures in wokkel/twisted (endroid bug 1380972)
- Log unexpected async errors for triageability
- Use addCallbacks so that errback is actually called!

Also tweak debian service file to log messages from twisted using the logging infra (rather than stderr).

Edit:
  - Tweak debian service config file, so that messages from twisted (e.g. unhandled deferred failure) are logged.
  - Fix bug in ping error handling.
  - Log StanzaErrors as debug rather than errors.

Improve reliability of periodic pinger

- Handle failures in wokkel/twisted (endroid bug 1380972)
- Log async errors for triageability
- Use addCallbacks so that errback is actually called!

[Phil Connell (pconnell)]

Ping to webex conference server *always* fails, so unconditional move to error logging in errback is no good.

root DEBUG Failed to ping conference.isj3.webex.com: StanzaError with condition u'bad-request'"

review: Needs Fixing

[Phil Connell (pconnell)]

review: Approve

=== modified file 'debian/changelog'
--- debian/changelog	2014-10-10 11:19:50 +0000
+++ debian/changelog	2014-10-14 12:34:13 +0000
@@ -1,3 +1,11 @@
+endroid (1.4.6) trusty; urgency=medium
+
+  * Bugfixes and robustness improvements for periodic pinger.
+  * When started as a debian service, log twisted messages to the endroid
+    logfile.
+
+ -- Phil Connell <[e-mail]>  Tue, 14 Oct 2014 13:33:00 +0100
+
 endroid (1.4.5) trusty; urgency=medium
 
   * Fix endroid_remote watch.

=== modified file 'etc/init/endroid.conf'
--- etc/init/endroid.conf	2014-09-15 16:45:29 +0000
+++ etc/init/endroid.conf	2014-10-14 12:34:13 +0000
@@ -1,7 +1,7 @@
 description "EnDroid XMPP bot"
 author "Ensoft Limited"
 
-exec /usr/bin/endroid -L /var/log/endroid.log --config /etc/endroid/endroid.conf
+exec /usr/bin/endroid --logtwisted -L /var/log/endroid.log --config /etc/endroid/endroid.conf
 start on net-device-up
 stop on stopping network
 stop on starting shutdown

=== modified file 'setup.py'
--- setup.py	2014-10-10 11:19:50 +0000
+++ setup.py	2014-10-14 12:34:13 +0000
@@ -24,7 +24,7 @@
 
 
 setup(name='endroid',
-      version="1.4.5",
+      version="1.4.6",
       description='EnDroid: a modular XMPP bot',
       url='http://open.ensoft.co.uk/EnDroid',
       packages=[

=== modified file 'src/endroid/plugins/periodicpinger.py'
--- src/endroid/plugins/periodicpinger.py	2014-10-02 12:51:59 +0000
+++ src/endroid/plugins/periodicpinger.py	2014-10-14 12:34:13 +0000
@@ -12,9 +12,11 @@
 
 
 import logging
+import functools
 import itertools
 
 import twisted.internet.task
+from twisted.words.protocols.jabber.error import StanzaError
 
 from endroid.pluginmanager import Plugin
 
@@ -64,16 +66,23 @@
 
         for server in self.servers:
             def _fail(fail, server):
-                # If the server returns an error then we don't really care, 
-                # since all we want to do is ensure server-to-server 
-                # connections are kept open by sending ping traffic and we have 
-                # achieved this. So just log for debugging purposes.
-                logging.debug("Failed to ping {}: {}"
-                              .format(server, str(fail.value)))
+                if fail.check(StanzaError):
+                    # Some servers that don't support c2s pings return 'bad
+                    # request' rather than 'not supported'. This still serves
+                    # the keep-the-connection alive purpose, so don't log as an
+                    # error.
+                    logger = self.log.debug
+                else:
+                    logger = self.log.error
+                logger("Failed to ping {}: {}".format(server, fail.value))
             def _success(response):
                 pass
-            d = self.usermanagement.ping(server)
-            d.addCallback(_success)
-            d.addErrback(_fail, server)
+            try:
+                d = self.usermanagement.ping(server)
+            except Exception:
+                self.log.exception("Failed to send ping to {}:".format(server))
+            else:
+                d.addCallbacks(_success,
+                               functools.partial(_fail, server=server))