autolockrenewer on_lock_renew_failure should take two parameters, the renwable and the optional error.

Author: KieranBrantnerMagee

sdk/servicebus/azure-servicebus/azure/servicebus/_common/auto_lock_renewer.py

@@ -98,7 +98,7 @@ def _auto_lock_renew(self, renewable, starttime, timeout, on_lock_renew_failure=
             renewable.auto_renew_error = error
         finally:
             if on_lock_renew_failure and not clean_shutdown:
-                on_lock_renew_failure(renewable)
+                on_lock_renew_failure(renewable, error)
 
     def register(self, renewable, timeout=300, on_lock_renew_failure=None):
         """Register a renewable entity for automatic lock renewal.
@@ -108,7 +108,7 @@ def register(self, renewable, timeout=300, on_lock_renew_failure=None):
          ~azure.servicebus.ServiceBusSession
         :param float timeout: A time in seconds that the lock should be maintained for.
          Default value is 300 (5 minutes).
-        :param Optional[Callable[[Union[~azure.servicebus.ServiceBusSession, ReceivedMessage]], Awaitable[None]]] on_lock_renew_failure: 
+        :param Optional[Callable[[Union[~azure.servicebus.ServiceBusSession, ReceivedMessage], Optional[Exception]], Awaitable[None]]] on_lock_renew_failure: 
          A callback may be specified to be called when the lock is lost on the renewable that is being registered.
          Default value is None (no callback).
         """

sdk/servicebus/azure-servicebus/azure/servicebus/aio/_async_auto_lock_renewer.py

@@ -76,7 +76,7 @@ async def _auto_lock_renew(self,
                                renewable: "Union[ReceivedMessage, ServiceBusSession]",
                                starttime: datetime.datetime,
                                timeout: int,
-                               on_lock_renew_failure: "Optional[Callable[[Union[ServiceBusSession, ReceivedMessage]], Awaitable[None]]]"=None) -> None:
+                               on_lock_renew_failure: "Optional[Callable[[Union[ServiceBusSession, ReceivedMessage], Optional[Exception]], Awaitable[None]]]"=None) -> None:
         _log.debug("Running async lock auto-renew for %r seconds", timeout)
         error = None
         clean_shutdown = False # Only trigger the on_lock_renew_failure if halting was not expected (shutdown, etc)
@@ -101,7 +101,7 @@ async def _auto_lock_renew(self,
             renewable.auto_renew_error = error
         finally:
             if on_lock_renew_failure and not clean_shutdown:
-                await on_lock_renew_failure(renewable)
+                await on_lock_renew_failure(renewable, error)
 
     def register(self,
                  renewable: "Union[ReceivedMessage, ServiceBusSession]",

sdk/servicebus/azure-servicebus/tests/async_tests/test_queues_async.py

@@ -1108,8 +1108,11 @@ async def test_queue_message_settle_through_mgmt_link_due_to_broken_receiver_lin
     @pytest.mark.asyncio
     async def test_async_queue_mock_auto_lock_renew_callback(self):
         results = []
-        async def callback_mock(renewable):
+        errors = []
+        async def callback_mock(renewable, error):
             results.append(renewable)
+            if error:
+                errors.append(error)
 
         auto_lock_renew = AutoLockRenew()
         auto_lock_renew.renew_period = 1 # So we can run the test fast.
@@ -1118,13 +1121,15 @@ async def callback_mock(renewable):
             auto_lock_renew.register(renewable=message, on_lock_renew_failure=callback_mock)
             await asyncio.sleep(3)
             assert len(results) and results[-1].expired == True
+            assert not errors
 
         auto_lock_renew = AutoLockRenew()
         auto_lock_renew.renew_period = 1
         async with auto_lock_renew: # Check that in normal operation it does not get called
             auto_lock_renew.register(renewable=MockReceivedMessage(), on_lock_renew_failure=callback_mock)
             await asyncio.sleep(3)
             assert len(results) == 1
+            assert not errors
 
         auto_lock_renew = AutoLockRenew()
         auto_lock_renew.renew_period = 1
@@ -1134,6 +1139,7 @@ async def callback_mock(renewable):
             message.settled = True
             await asyncio.sleep(3)
             assert len(results) == 1
+            assert not errors
 
         auto_lock_renew = AutoLockRenew()
         auto_lock_renew.renew_period = 1
@@ -1142,6 +1148,7 @@ async def callback_mock(renewable):
             auto_lock_renew.register(renewable=message, on_lock_renew_failure=callback_mock)
             await asyncio.sleep(3)
             assert len(results) == 2 and results[-1].expired == True
+            assert errors[-1]
 
         auto_lock_renew = AutoLockRenew()
         auto_lock_renew.renew_period = 1
@@ -1151,6 +1158,7 @@ async def callback_mock(renewable):
             await auto_lock_renew.close()
             await asyncio.sleep(3)
             assert len(results) == 2
+            assert len(errors) == 1
 
         auto_lock_renew = AutoLockRenew()
         auto_lock_renew.renew_period = 1
@@ -1160,6 +1168,7 @@ async def callback_mock(renewable):
             message._receiver._running = False
             await asyncio.sleep(3)
             assert len(results) == 2
+            assert len(errors) == 1
 
 
     @pytest.mark.asyncio

sdk/servicebus/azure-servicebus/tests/async_tests/test_sessions_async.py

@@ -478,7 +478,7 @@ async def test_async_session_by_conn_str_receive_handler_with_autolockrenew(self
                     await sender.send_messages(message)
 
             results = []
-            async def lock_lost_callback(renewable):
+            async def lock_lost_callback(renewable, error):
                 results.append(renewable)
 
             renewer = AutoLockRenew()

sdk/servicebus/azure-servicebus/tests/test_queues.py

@@ -1219,8 +1219,11 @@ def test_queue_message_settle_through_mgmt_link_due_to_broken_receiver_link(self
 
     def test_queue_mock_auto_lock_renew_callback(self):
         results = []
-        def callback_mock(renewable):
+        errors = []
+        def callback_mock(renewable, error):
             results.append(renewable)
+            if error:
+                errors.append(error)
 
         auto_lock_renew = AutoLockRenew()
         auto_lock_renew.renew_period = 1 # So we can run the test fast.
@@ -1229,13 +1232,15 @@ def callback_mock(renewable):
             auto_lock_renew.register(renewable=message, on_lock_renew_failure=callback_mock)
             time.sleep(3)
             assert len(results) and results[-1].expired == True
+            assert not errors
 
         auto_lock_renew = AutoLockRenew()
         auto_lock_renew.renew_period = 1
         with auto_lock_renew: # Check that in normal operation it does not get called
             auto_lock_renew.register(renewable=MockReceivedMessage(), on_lock_renew_failure=callback_mock)
             time.sleep(3)
             assert len(results) == 1
+            assert not errors
 
         auto_lock_renew = AutoLockRenew()
         auto_lock_renew.renew_period = 1
@@ -1245,6 +1250,7 @@ def callback_mock(renewable):
             message.settled = True
             time.sleep(3)
             assert len(results) == 1
+            assert not errors
 
         auto_lock_renew = AutoLockRenew()
         auto_lock_renew.renew_period = 1
@@ -1253,6 +1259,7 @@ def callback_mock(renewable):
             auto_lock_renew.register(renewable=message, on_lock_renew_failure=callback_mock)
             time.sleep(3)
             assert len(results) == 2 and results[-1].expired == True
+            assert errors[-1]
 
         auto_lock_renew = AutoLockRenew()
         auto_lock_renew.renew_period = 1
@@ -1262,6 +1269,7 @@ def callback_mock(renewable):
             auto_lock_renew.close()
             time.sleep(3)
             assert len(results) == 2
+            assert len(errors) == 1
 
         auto_lock_renew = AutoLockRenew()
         auto_lock_renew.renew_period = 1
@@ -1271,6 +1279,7 @@ def callback_mock(renewable):
             message._receiver._running = False
             time.sleep(3)
             assert len(results) == 2
+            assert len(errors) == 1
 
 
     def test_queue_mock_no_reusing_auto_lock_renew(self):

sdk/servicebus/azure-servicebus/tests/test_sessions.py

@@ -547,7 +547,7 @@ def test_session_by_conn_str_receive_handler_with_autolockrenew(self, servicebus
                     sender.send_messages(message)
 
             results = []
-            def lock_lost_callback(renewable):
+            def lock_lost_callback(renewable, error):
                 results.append(renewable)
 
             renewer = AutoLockRenew()