Skip to content

[Service Bus] Better error message when session cannot be locked #2822

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.

Sign up for GitHub

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

Merged
ramya-rao-a merged 1 commit into from
May 11, 2019
Merged

[Service Bus] Better error message when session cannot be locked #2822

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 5 additions & 2 deletions sdk/servicebus/service-bus/src/queueClient.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,8 @@ export class QueueClient implements Client {
/**
* Creates a Receiver for receiving messages from a Queue which does not have sessions enabled.
* - Throws error if an open receiver already exists for this QueueClient.
* - Throws error if the Queue has sessions enabled.
* - Throws `InvalidOperationError` if the Queue has sessions enabled (in which case, use the
* overload of this method which takes `sessionOptions` argument)
*
* @param receiveMode An enum indicating the mode in which messages should be received. Possible
* values are:
Expand All @@ -129,7 +130,9 @@ export class QueueClient implements Client {
* Creates a Receiver for receiving messages from a session enabled Queue. When no sessionId is
* given, a random session among the available sessions is used.
* - Throws error if an open receiver already exists for given sessionId.
* - Throws error if the Queue does not have sessions enabled.
* - Throws `SessionCannotBeLockedError` if the Queue does not have sessions enabled (in which
* case do not pass the `sessionOptions` argument) or if Service Bus is not able to get a lock on
* the session (in which case try again after some time)
*
* @param receiveMode An enum indicating the mode in which messages should be received. Possible
* values are:
Expand Down
22 changes: 13 additions & 9 deletions sdk/servicebus/service-bus/src/session/messageSession.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1016,16 +1016,20 @@ export class MessageSession extends LinkEntity {
this._receiver.source.filter &&
this._receiver.source.filter[Constants.sessionFilterName];
let errorMessage: string = "";
// SB allows a sessionId with empty string value :)
// Service Bus creates receiver successfully with no sessionId if it fails to get a lock on
// the session instead of throwing the SessionCannotBeLockedError. So, we throw it instead.
if (receivedSessionId == undefined) {
errorMessage =
`Received an incorrect sessionId '${receivedSessionId}' while creating ` +
`the receiver '${this.name}'.`;
}
if (this.sessionId != undefined && receivedSessionId !== this.sessionId) {
errorMessage =
`Received sessionId '${receivedSessionId}' does not match the provided ` +
`sessionId '${this.sessionId}' while creating the receiver '${this.name}'.`;
if (this.sessionId == undefined) {
// User asked for a random session to be picked, but there are no sessions free to take
// a lock on or the Queue/Subscription doesnt have sessions enabled.
errorMessage = `There are no sessions available for receiving messages.`;
} else {
// User passed a sessionId, but cannot get a lock on it either because somebody else
// has a lock on it or the Queue/Subscription doesnt have sessions enabled.
errorMessage = `The session with id '${
this.sessionId
}' is not available for receiving messages.`;
}
}
if (errorMessage) {
const error = translate({
Expand Down
10 changes: 6 additions & 4 deletions sdk/servicebus/service-bus/src/subscriptionClient.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,9 +109,9 @@ export class SubscriptionClient implements Client {

/**
* Creates a Receiver for receiving messages from a Subscription which does not have sessions enabled.
* Throws error if an open receiver already exists for this SubscriptionClient.
*
* Throws error if the Subscription has sessions enabled.
* - Throws error if an open receiver already exists for this SubscriptionClient.
* - Throws `InvalidOperationError` if the Subscription has sessions enabled (in which case, use the
* overload of this method which takes `sessionOptions` argument)
*
* @param receiveMode An enum indicating the mode in which messages should be received. Possible
* values are:
Expand All @@ -129,7 +129,9 @@ export class SubscriptionClient implements Client {
* Creates a Receiver for receiving messages from a session enabled Subscription. When no sessionId is
* given, a random session among the available sessions is used.
* - Throws error if an open receiver already exists for given sessionId.
* - Throws error if the Queue does not have sessions enabled.
* - Throws `SessionCannotBeLockedError` if the Subscription does not have sessions enabled (in which
* case do not pass the `sessionOptions` argument) or if Service Bus is not able to get a lock on
* the session (in which case try again after some time)
*
* @param receiveMode An enum indicating the mode in which messages should be received. Possible
* values are:
Expand Down