Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enable a way to Unregister Message Handler and Session Handler #14021

Merged
merged 23 commits into from
Sep 10, 2020
Merged
Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
8c46a41
add UnregisterMessageHandler method
DorothySun216 Aug 6, 2020
db9b322
Update sdk/servicebus/Microsoft.Azure.ServiceBus/src/Core/IReceiverCl…
DorothySun216 Aug 10, 2020
da77a24
Update sdk/servicebus/Microsoft.Azure.ServiceBus/src/Core/MessageRece…
DorothySun216 Aug 10, 2020
5e1576a
Update the unregister method to be async and await for inflight opera…
DorothySun216 Aug 13, 2020
61f0998
Update sdk/servicebus/Microsoft.Azure.ServiceBus/src/SubscriptionClie…
DorothySun216 Aug 13, 2020
2988d02
Update sdk/servicebus/Microsoft.Azure.ServiceBus/src/Core/MessageRece…
DorothySun216 Aug 13, 2020
d3faba2
Update sdk/servicebus/Microsoft.Azure.ServiceBus/src/QueueClient.cs
DorothySun216 Aug 13, 2020
4b921a6
Change name to have async suffix and add to existing onMessageQueueTests
DorothySun216 Aug 13, 2020
78aff54
Add UnregisterSessionHandlerAsync and corresponding tests
DorothySun216 Aug 13, 2020
25f6b8d
nit
DorothySun216 Aug 13, 2020
d4a5589
nit
DorothySun216 Aug 13, 2020
ecd820b
Merge branch 'master' of https://github.com/Azure/azure-sdk-for-net i…
DorothySun216 Aug 20, 2020
cd8f044
Add a new cancellation type to not cancel inflight message handling o…
DorothySun216 Aug 23, 2020
fff0016
Add another type of cancellation token to session handler path
DorothySun216 Aug 24, 2020
fae7bf1
nit
DorothySun216 Aug 24, 2020
642dc36
Add a timeout parameter to unregister functions and add according uni…
DorothySun216 Sep 4, 2020
ffc4249
nit
DorothySun216 Sep 4, 2020
fbd31d0
cancel runningTaskCancellationTokenSource after unregister is done
DorothySun216 Sep 4, 2020
f4dac4b
change public API
DorothySun216 Sep 9, 2020
9692122
update the API header
DorothySun216 Sep 9, 2020
7741ad9
update the API definition
DorothySun216 Sep 10, 2020
2bb96a5
fix spacing
DorothySun216 Sep 10, 2020
c0ec74a
fix ApproveAzureServiceBus CIT test
DorothySun216 Sep 10, 2020
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,11 @@ public interface IReceiverClient : IClientEntity
/// <remarks>Enable prefetch to speed up the receive rate.</remarks>
void RegisterMessageHandler(Func<Message, CancellationToken, Task> handler, MessageHandlerOptions messageHandlerOptions);

/// <summary>
/// Unregister message handler from the receiver if there is an active message handler registered.
/// </summary>
Task UnregisterMessageHandler();
DorothySun216 marked this conversation as resolved.
Show resolved Hide resolved

/// <summary>
/// Completes a <see cref="Message"/> using its lock token. This will delete the message from the queue.
/// </summary>
Expand Down Expand Up @@ -115,4 +120,4 @@ public interface IReceiverClient : IClientEntity
/// </remarks>
Task DeadLetterAsync(string lockToken, string deadLetterReason, string deadLetterErrorDescription = null);
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -899,6 +899,38 @@ public void RegisterMessageHandler(Func<Message, CancellationToken, Task> handle
this.OnMessageHandler(messageHandlerOptions, handler);
}

/// <summary>
/// Unregister message hander from the receiver if there is an active message handler registered.
/// </summary>
public async Task UnregisterMessageHandler()
{
this.ThrowIfClosed();

MessagingEventSource.Log.UnregisterMessageHandlerStart(this.ClientId);
lock (this.messageReceivePumpSyncLock)
{
if (this.receivePump == null || this.receivePumpCancellationTokenSource.IsCancellationRequested)
{
return;
}

this.receivePumpCancellationTokenSource.Cancel();
this.receivePumpCancellationTokenSource.Dispose();
}

while (this.receivePump != null
&& this.receivePump.maxConcurrentCallsSemaphoreSlim.CurrentCount < this.receivePump.registerHandlerOptions.MaxConcurrentCalls)
{
await Task.Delay(10).ConfigureAwait(false);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not very comfortable with this potential infinite loop. Imagine OnMessage delegate never completes.then UnregisterMessageHandler never completes. This Unregister doesn't guarantee a clean close, but only a timed unregister. I mean it will wait for some time for all OnMessage delegates to finish, but there is no guarantee. We should ideally take some max timeout or some default timeout for the Unregister.

Copy link
Member

@sidkri sidkri Sep 1, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It will be important to make this timeout configurable (and a default used if not specified). In Azure Functions, we provide a large amount of time for function execution to complete and need to provide the same amount of time while shutting down (this API will be invoked during shutdown)

}

lock (this.messageReceivePumpSyncLock)
{
this.receivePump = null;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggest cancelling and disposing the runningTaskCancellationTokenSource here.

}
MessagingEventSource.Log.UnregisterMessageHandlerStop(this.ClientId);
}

/// <summary>
/// Registers a <see cref="ServiceBusPlugin"/> to be used with this receiver.
/// </summary>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,15 @@ namespace Microsoft.Azure.ServiceBus

sealed class MessageReceivePump
{
public readonly SemaphoreSlim maxConcurrentCallsSemaphoreSlim;
public readonly MessageHandlerOptions registerHandlerOptions;
readonly Func<Message, CancellationToken, Task> onMessageCallback;
readonly string endpoint;
readonly MessageHandlerOptions registerHandlerOptions;
readonly IMessageReceiver messageReceiver;
readonly CancellationToken pumpCancellationToken;
readonly SemaphoreSlim maxConcurrentCallsSemaphoreSlim;
readonly ServiceBusDiagnosticSource diagnosticSource;


public MessageReceivePump(IMessageReceiver messageReceiver,
MessageHandlerOptions registerHandlerOptions,
Func<Message, CancellationToken, Task> callback,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1380,6 +1380,24 @@ public void ManagementSerializationException(string objectName, string details =
this.WriteEvent(117, objectName, details);
}
}

[Event(118, Level = EventLevel.Informational, Message = "{0}: Unregister MessageHandler start.")]
public void UnregisterMessageHandlerStart(string clientId)
{
if (this.IsEnabled())
{
this.WriteEvent(118, clientId);
}
}

[Event(119, Level = EventLevel.Informational, Message = "{0}: Unregister MessageHandler done.")]
public void UnregisterMessageHandlerStop(string clientId)
{
if (this.IsEnabled())
{
this.WriteEvent(119, clientId);
}
}
}

internal static class TraceHelper
Expand Down
9 changes: 9 additions & 0 deletions sdk/servicebus/Microsoft.Azure.ServiceBus/src/QueueClient.cs
Original file line number Diff line number Diff line change
Expand Up @@ -445,6 +445,15 @@ public void RegisterMessageHandler(Func<Message, CancellationToken, Task> handle
this.InnerReceiver.RegisterMessageHandler(handler, messageHandlerOptions);
}

/// <summary>
/// Unregister messgae hander from the receiver if there is active message handler registered.
/// </summary>
public async Task UnregisterMessageHandler()
{
this.ThrowIfClosed();
await this.InnerReceiver.UnregisterMessageHandler().ConfigureAwait(false);
}

/// <summary>
/// Receive session messages continuously from the queue. Registers a message handler and begins a new thread to receive session-messages.
/// This handler(<see cref="Func{IMessageSession, Message, CancellationToken, Task}"/>) is awaited on every time a new message is received by the queue client.
Expand Down
3 changes: 3 additions & 0 deletions sdk/servicebus/Microsoft.Azure.ServiceBus/src/Resources.resx
Original file line number Diff line number Diff line change
Expand Up @@ -192,6 +192,9 @@
<data name="MessageHandlerAlreadyRegistered" xml:space="preserve">
<value>A message handler has already been registered.</value>
</data>
<data name="MessageHandlerNotRegisteredYet" xml:space="preserve">
<value>A message handler has not been registered yet.</value>
</data>
<data name="SessionHandlerAlreadyRegistered" xml:space="preserve">
<value>A session handler has already been registered.</value>
</data>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -419,6 +419,15 @@ public void RegisterMessageHandler(Func<Message, CancellationToken, Task> handle
this.InnerSubscriptionClient.InnerReceiver.RegisterMessageHandler(handler, messageHandlerOptions);
}

/// <summary>
/// Unregister messgae hander from the receiver if there is active message handler registered.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
/// Unregister messgae hander from the receiver if there is active message handler registered.
/// Unregister message hander from the receiver if there is an active message handler registered.

/// </summary>
public async Task UnregisterMessageHandler()
{
this.ThrowIfClosed();
await this.InnerSubscriptionClient.InnerReceiver.UnregisterMessageHandler().ConfigureAwait(false);
}

/// <summary>
/// Receive session messages continuously from the queue. Registers a message handler and begins a new thread to receive session-messages.
/// This handler(<see cref="Func{IMessageSession, Message, CancellationToken, Task}"/>) is awaited on every time a new message is received by the subscription client.
Expand Down Expand Up @@ -639,4 +648,4 @@ protected override async Task OnClosingAsync()
}
}
}
}
}