Skip to content

Remove receiver overloads meant to hide settlement methods when using ReceiveAndDelete mode #12014

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 8 commits into from
Oct 23, 2020
Merged

Remove receiver overloads meant to hide settlement methods when using ReceiveAndDelete mode #12014

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
58f1de6
Remove overloads
ramya-rao-a Oct 22, 2020
53f0754
Changelog entry
ramya-rao-a Oct 23, 2020
5b55881
Remove unnecessary js tags
ramya-rao-a Oct 23, 2020
dfe0767
Merge remote-tracking branch 'origin' into pr/ramya-rao-a/12014-1
ramya-rao-a Oct 23, 2020
3410962
Undo unintentional formatiing changes
ramya-rao-a Oct 23, 2020
5d6e0be
Clarify receive modes
ramya-rao-a Oct 23, 2020
02ee5a1
max delivery count on subscription
ramya-rao-a Oct 23, 2020
b8c4ad7
Update jsdocs for createReceiver overload for subscriptions
ramya-rao-a Oct 23, 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
1 change: 1 addition & 0 deletions sdk/servicebus/service-bus/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@

### Breaking changes

- The methods to complete, abandon, defer and deadletter a message along with the method to renew message lock have been moved from the message to the receiver.
- The `createBatch` method on the sender is renamed to `createMessageBatch`.
- The interface `CreateBatchOptions` followed by the options that are passed to the `createBatch` method is renamed to `CreateMessageBatchOptions`.
- The `tryAdd` method on the message batch object is renamed to `tryAddMessage`.
Expand Down
26 changes: 10 additions & 16 deletions sdk/servicebus/service-bus/review/service-bus.api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -312,19 +312,13 @@ export class ServiceBusAdministrationClient extends ServiceClient {
export class ServiceBusClient {
constructor(connectionString: string, options?: ServiceBusClientOptions);
constructor(fullyQualifiedNamespace: string, credential: TokenCredential, options?: ServiceBusClientOptions);
acceptNextSession(queueName: string, options?: ServiceBusSessionReceiverOptions<"peekLock">): Promise<ServiceBusSessionReceiver>;
acceptNextSession(queueName: string, options: ServiceBusSessionReceiverOptions<"receiveAndDelete">): Promise<ServiceBusSessionReceiver>;
acceptNextSession(topicName: string, subscriptionName: string, options?: ServiceBusSessionReceiverOptions<"peekLock">): Promise<ServiceBusSessionReceiver>;
acceptNextSession(topicName: string, subscriptionName: string, options: ServiceBusSessionReceiverOptions<"receiveAndDelete">): Promise<ServiceBusSessionReceiver>;
acceptSession(queueName: string, sessionId: string, options?: ServiceBusSessionReceiverOptions<"peekLock">): Promise<ServiceBusSessionReceiver>;
acceptSession(queueName: string, sessionId: string, options: ServiceBusSessionReceiverOptions<"receiveAndDelete">): Promise<ServiceBusSessionReceiver>;
acceptSession(topicName: string, subscriptionName: string, sessionId: string, options?: ServiceBusSessionReceiverOptions<"peekLock">): Promise<ServiceBusSessionReceiver>;
acceptSession(topicName: string, subscriptionName: string, sessionId: string, options: ServiceBusSessionReceiverOptions<"receiveAndDelete">): Promise<ServiceBusSessionReceiver>;
acceptNextSession(queueName: string, options?: ServiceBusSessionReceiverOptions): Promise<ServiceBusSessionReceiver>;
acceptNextSession(topicName: string, subscriptionName: string, options?: ServiceBusSessionReceiverOptions): Promise<ServiceBusSessionReceiver>;
acceptSession(queueName: string, sessionId: string, options?: ServiceBusSessionReceiverOptions): Promise<ServiceBusSessionReceiver>;
acceptSession(topicName: string, subscriptionName: string, sessionId: string, options?: ServiceBusSessionReceiverOptions): Promise<ServiceBusSessionReceiver>;
close(): Promise<void>;
createReceiver(queueName: string, options?: ServiceBusReceiverOptions<"peekLock">): ServiceBusReceiver;
createReceiver(queueName: string, options: ServiceBusReceiverOptions<"receiveAndDelete">): ServiceBusReceiver;
createReceiver(topicName: string, subscriptionName: string, options?: ServiceBusReceiverOptions<"peekLock">): ServiceBusReceiver;
createReceiver(topicName: string, subscriptionName: string, options: ServiceBusReceiverOptions<"receiveAndDelete">): ServiceBusReceiver;
createReceiver(queueName: string, options?: ServiceBusReceiverOptions): ServiceBusReceiver;
createReceiver(topicName: string, subscriptionName: string, options?: ServiceBusReceiverOptions): ServiceBusReceiver;
createSender(queueOrTopicName: string): ServiceBusSender;
fullyQualifiedNamespace: string;
}
Expand Down Expand Up @@ -421,9 +415,9 @@ export interface ServiceBusReceiver {
}

// @public
export interface ServiceBusReceiverOptions<ReceiveModeT extends ReceiveMode> {
export interface ServiceBusReceiverOptions {
maxAutoLockRenewalDurationInMs?: number;
receiveMode?: ReceiveModeT;
receiveMode?: ReceiveMode;
subQueue?: SubQueue;
}

Expand Down Expand Up @@ -452,9 +446,9 @@ export interface ServiceBusSessionReceiver extends ServiceBusReceiver {
}

// @public
export interface ServiceBusSessionReceiverOptions<ReceiveModeT extends ReceiveMode> extends OperationOptionsBase {
export interface ServiceBusSessionReceiverOptions extends OperationOptionsBase {
maxAutoLockRenewalDurationInMs?: number;
receiveMode?: ReceiveModeT;
receiveMode?: ReceiveMode;
}

// @public
Expand Down
15 changes: 5 additions & 10 deletions sdk/servicebus/service-bus/src/models.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,9 +78,9 @@ export type ReceiveMode = "peekLock" | "receiveAndDelete";
export type SubQueue = "deadLetter" | "transferDeadLetter";

/**
* @template ReceiveModeT
* Options to use when creating a receiver.
*/
export interface ServiceBusReceiverOptions<ReceiveModeT extends ReceiveMode> {
export interface ServiceBusReceiverOptions {
/**
* Represents the receive mode for the receiver.
*
Expand All @@ -100,7 +100,7 @@ export interface ServiceBusReceiverOptions<ReceiveModeT extends ReceiveMode> {
* https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
*
*/
receiveMode?: ReceiveModeT;
receiveMode?: ReceiveMode;
/**
* Represents the sub queue that is applicable for any queue or subscription.
* Valid values are "deadLetter" and "transferDeadLetter". To learn more about dead letter queues,
Expand Down Expand Up @@ -177,13 +177,8 @@ export interface SubscribeOptions extends OperationOptionsBase {
/**
* Describes the options passed to the `acceptSession` and `acceptNextSession` methods
* when using a Queue/Subscription that has sessions enabled.
*
* @export
* @extends {OperationOptionsBase}
* @template ReceiveModeT
*/
export interface ServiceBusSessionReceiverOptions<ReceiveModeT extends ReceiveMode>
extends OperationOptionsBase {
export interface ServiceBusSessionReceiverOptions extends OperationOptionsBase {
/**
* Represents the receive mode for the receiver.
*
Expand All @@ -203,7 +198,7 @@ export interface ServiceBusSessionReceiverOptions<ReceiveModeT extends ReceiveMo
* https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
*
*/
receiveMode?: ReceiveModeT;
receiveMode?: ReceiveMode;
/**
* @property The maximum duration in milliseconds
* until which, the lock on the session will be renewed automatically by the sdk.
Expand Down
Loading