File 0001-Do-not-access-the-connection-s-socket-duri... of Package python-oslo.messaging

Overview Repositories Revisions Requests Users Attributes Meta

File 0001-Do-not-access-the-connection-s-socket-during-error-c.patch of Package python-oslo.messaging (Revision e73e8f0cae82e1a898145ee3a76fab8c)

Currently displaying revision e73e8f0cae82e1a898145ee3a76fab8c , Show latest

From 13759e1254ce33a4c252ae4a548be4a0e4a3b4a7 Mon Sep 17 00:00:00 2001
From: Kenneth Giusti <kgiusti@gmail.com>
Date: Fri, 6 Jul 2018 11:24:40 -0400
Subject: [PATCH] Do not access the connection's socket during error callback

The _get_connection_info() method attempts to gather debug information
from the connection, and will reach into the amqp channel to get the
local (client's) TCP port number via the 'sock' property.

If _get_connection_info() is called from autoretry's on_error handler
the 'sock' property notices that the transport is not set and attempts
to re-connect.  amqp has deprecated this reconnect behavior, and in
any case the client's socket is irrelevant since the connection may
not be valid at this point.

Closes-Bug: #1745166
Change-Id: I3c42f8463605927f6f94d6c3a7f05e584476abc1
(cherry picked from commit 361669764fd28b4f6d5f1c6896624f2da4ff5151)
---
 oslo_messaging/_drivers/impl_rabbit.py | 14 +++++++++-----
 1 file changed, 9 insertions(+), 5 deletions(-)

diff --git a/oslo_messaging/_drivers/impl_rabbit.py b/oslo_messaging/_drivers/impl_rabbit.py
index d3c85fb2..06be3c3d 100644
--- a/oslo_messaging/_drivers/impl_rabbit.py
+++ b/oslo_messaging/_drivers/impl_rabbit.py
@@ -750,7 +750,7 @@ class Connection(object):
                         else interval)
 
             info = {'err_str': exc, 'sleep_time': interval}
-            info.update(self._get_connection_info())
+            info.update(self._get_connection_info(conn_error=True))
 
             if 'Socket closed' in six.text_type(exc):
                 LOG.error(_LE('[%(connection_id)s] AMQP server'
@@ -761,8 +761,7 @@ class Connection(object):
                 LOG.error(_LE('[%(connection_id)s] AMQP server on '
                               '%(hostname)s:%(port)s is unreachable: '
                               '%(err_str)s. Trying again in '
-                              '%(sleep_time)d seconds. Client port: '
-                              '%(client_port)s'), info)
+                              '%(sleep_time)d seconds.'), info)
 
             # XXX(nic): when reconnecting to a RabbitMQ cluster
             # with mirrored queues in use, the attempt to release the
@@ -1159,12 +1158,17 @@ class Connection(object):
         with self._connection_lock:
             self.ensure(method, retry=retry, error_callback=_error_callback)
 
-    def _get_connection_info(self):
+    def _get_connection_info(self, conn_error=False):
+        # Bug #1745166: set 'conn_error' true if this is being called when the
+        # connection is in a known error state.  Otherwise attempting to access
+        # the connection's socket while it is in an error state will cause
+        # py-amqp to attempt reconnecting.
         ci = self.connection.info()
         info = dict([(k, ci.get(k)) for k in
                      ['hostname', 'port', 'transport']])
         client_port = None
-        if (self.channel and hasattr(self.channel.connection, 'sock')
+        if (not conn_error and self.channel
+                and hasattr(self.channel.connection, 'sock')
                 and self.channel.connection.sock):
             client_port = self.channel.connection.sock.getsockname()[1]
         info.update({'client_port': client_port,
-- 
2.19.2

Places

File 0001-Do-not-access-the-connection-s-socket-during-error-c.patch of Package python-oslo.messaging (Revision e73e8f0cae82e1a898145ee3a76fab8c)

Places