[ServiceBus] add `state` property to `ServiceBusReceivedMessage` #18938

jeremymeng · 2021-12-02T23:43:14Z

It can be one of the three ServiceBusMessageState values: "active", "deferred", or "scheduled".

Several tests are updated to verify the message state property.

azure-sdk · 2021-12-02T23:52:23Z

API changes have been detected in @azure/core-amqp. You can review API changes here

API changes

+     readonly messageState: "x-opt-message-state";

azure-sdk · 2021-12-02T23:53:11Z

API changes have been detected in @azure/service-bus. You can review API changes here

API changes

+ export declare enum ServiceBusMessageState 
+     readonly state?: ServiceBusMessageState;

sdk/core/core-amqp/CHANGELOG.md

sdk/servicebus/service-bus/test/public/sendAndSchedule.spec.ts

sdk/servicebus/service-bus/review/service-bus.api.md

jeremymeng · 2021-12-03T00:25:46Z

sdk/servicebus/service-bus/package.json

@@ -2,7 +2,7 @@
  "name": "@azure/service-bus",
  "sdk-type": "client",
  "author": "Microsoft Corporation",
-  "version": "7.4.1",
+  "version": "7.5.0",


do we normally release a beta first?

Since we havent discussed this with other languages yet, I would be ok with a beta. Otherwise, it is a straight forward feature that we could have gone GA directly with

Changed to 7.5.0-beta.1 for now.

… enum A message's state is active if it is neither deferred nor scheduled.

check-enforcer · 2021-12-03T20:17:00Z

This pull request is protected by Check Enforcer.

What is Check Enforcer?

Check Enforcer helps ensure all pull requests are covered by at least one check-run (typically an Azure Pipeline). When all check-runs associated with this pull request pass then Check Enforcer itself will pass.

Why am I getting this message?

You are getting this message because Check Enforcer did not detect any check-runs being associated with this pull request within five minutes. This may indicate that your pull request is not covered by any pipelines and so Check Enforcer is correctly blocking the pull request being merged.

What should I do now?

If the check-enforcer check-run is not passing and all other check-runs associated with this PR are passing (excluding license-cla) then you could try telling Check Enforcer to evaluate your pull request again. You can do this by adding a comment to this pull request as follows:
/check-enforcer evaluate
Typically evaulation only takes a few seconds. If you know that your pull request is not covered by a pipeline and this is expected you can override Check Enforcer using the following command:
/check-enforcer override
Note that using the override command triggers alerts so that follow-up investigations can occur (PRs still need to be approved as normal).

What if I am onboarding a new service?

Often, new services do not have validation pipelines associated with them, in order to bootstrap pipelines for a new service, you can issue the following command as a pull request comment:
/azp run prepare-pipelines
This will run a pipeline that analyzes the source tree and creates the pipelines necessary to build and validate your pull request. Once the pipeline has been created you can trigger the pipeline using the following comment:
/azp run js - [service] - ci

azure-sdk · 2021-12-03T20:27:54Z

API changes have been detected in @azure/service-bus. You can review API changes here

API changes

+     readonly state: "active" | "deferred" | "scheduled";

ramya-rao-a · 2021-12-03T21:43:17Z

sdk/core/core-amqp/CHANGELOG.md

@@ -7,6 +7,7 @@
 - Changed TS compilation target to ES2017 in order to produce smaller bundles and use more native platform features
 - With the dropping of support for Node.js versions that are no longer in LTS, the dependency on `@types/node` has been updated to version 12. Read our [support policy](https://github.com/Azure/azure-sdk-for-js/blob/main/SUPPORT.md) for more details.
 - Updated to use the latest version of the `rhea` package.
+- Add a constant `messageState` with value of `"x-opt-message-state"`. [PR 18938](https://github.com/Azure/azure-sdk-for-js/pull/18938)


Suggested change

- Add a constant `messageState` with value of `"x-opt-message-state"`. [PR 18938](https://github.com/Azure/azure-sdk-for-js/pull/18938)

- Add a constant `messageState` with value of `"x-opt-message-state"` to be used as property name for the new state property on the message. [PR 18938](https://github.com/Azure/azure-sdk-for-js/pull/18938)

ramya-rao-a · 2021-12-03T21:44:08Z

sdk/servicebus/service-bus/CHANGELOG.md


 ### Features Added

+- Add `state` property `ServiceBusReceivedMessage`. Its value is one of `"active"`, `"deferred"`, or `"scheduled"`. [PR 18938](https://github.com/Azure/azure-sdk-for-js/pull/18938)


Suggested change

- Add `state` property `ServiceBusReceivedMessage`. Its value is one of `"active"`, `"deferred"`, or `"scheduled"`. [PR 18938](https://github.com/Azure/azure-sdk-for-js/pull/18938)

- Add `state` property to `ServiceBusReceivedMessage`. Its value is one of `"active"`, `"deferred"`, or `"scheduled"`. [PR 18938](https://github.com/Azure/azure-sdk-for-js/pull/18938)

ramya-rao-a · 2021-12-03T21:48:01Z

sdk/servicebus/service-bus/src/serviceBusMessage.ts

  if (rheaMessage.message_annotations != null) {
    if (rheaMessage.message_annotations[Constants.deadLetterSource] != null) {
      props.deadLetterSource = rheaMessage.message_annotations[Constants.deadLetterSource];
    }
+    const messageState = rheaMessage.message_annotations[Constants.messageState];
+    if (isDefined(messageState) && (messageState === 1 || messageState === 2)) {


Do we need the isDefined check here? Won't the below just work without the defined check?

if (messageState === 1) { props.state = "deferred"; } else if (messageState === 2) { props.state = "scheduled"; }

Yeah this is enough. IsDefined() is from previous iteration that no longer needed.

ramya-rao-a · 2021-12-03T21:58:53Z

sdk/servicebus/service-bus/src/serviceBusMessage.ts

@@ -905,6 +923,7 @@ export class ServiceBusMessageImpl implements ServiceBusReceivedMessage {
    this._rawAmqpMessage = _rawAmqpMessage;
    this._rawAmqpMessage.bodyType = actualBodyType;
    this.delivery = delivery;
+    this.state = restOfMessageProps.state;


Doesnt the Object.assign(this, restOfMessageProps); at line 902 take care of assigning the state?

TypeScript compiler is not smart enough to detect that. I added some comments.

sdk/core/core-amqp/review/core-amqp.api.md

ramya-rao-a · 2021-12-03T23:41:17Z

Looks like the build is failing due to a missing rush update

deyaaeldeen · 2021-12-04T00:28:18Z

common/config/rush/pnpm-lock.yaml

@@ -1132,6 +1132,29 @@ packages:
      - supports-color
    dev: false

+  /@azure/service-bus/7.4.0:


which part of our repo depend on this version?

eventgrid and perf-service-bus depends on ^7.0.0.

I see. It may not be worth it to make perf-service-bus depend on this beta but perhaps something to consider.

I looked at history and we haven't done that for older versions. Though we probably want perf tests to always use source version @HarshaNalluru?

jeremymeng added 2 commits December 1, 2021 23:57

[core-amqp] add a constant for message property

5c052b2

[service-bus] add state property to received message

53009d9

jeremymeng requested review from bterlson, deyaaeldeen, HarshaNalluru, ramya-rao-a, richardpark-msft and xirzec as code owners December 2, 2021 23:43

ghost added Azure.Core Service Bus labels Dec 2, 2021

HarshaNalluru reviewed Dec 3, 2021

View reviewed changes

sdk/core/core-amqp/CHANGELOG.md Outdated Show resolved Hide resolved

jeremymeng commented Dec 3, 2021

View reviewed changes

sdk/servicebus/service-bus/test/public/sendAndSchedule.spec.ts Outdated Show resolved Hide resolved

HarshaNalluru reviewed Dec 3, 2021

View reviewed changes

sdk/servicebus/service-bus/review/service-bus.api.md Outdated Show resolved Hide resolved

Update version and changelog

8445995

jeremymeng commented Dec 3, 2021

View reviewed changes

Use literal union of "active" | "deferred" | "scheduled" instead of…

34884cd

… enum A message's state is active if it is neither deferred nor scheduled.

Update CHANGELOG

2777123

ramya-rao-a reviewed Dec 3, 2021

View reviewed changes

sdk/core/core-amqp/review/core-amqp.api.md Show resolved Hide resolved

Address CR feedback

1adf901

ramya-rao-a approved these changes Dec 3, 2021

View reviewed changes

rush update

9e590ba

jeremymeng requested review from mikeharder, praveenkuttappan and witemple-msft as code owners December 4, 2021 00:21

deyaaeldeen reviewed Dec 4, 2021

View reviewed changes

deyaaeldeen approved these changes Dec 4, 2021

View reviewed changes

jeremymeng added 2 commits December 6, 2021 18:36

Fix format

3658463

Merge remote-tracking branch 'up/main' into sb/message-state

89fc255

jeremymeng merged commit b7638dc into Azure:main Dec 7, 2021

jeremymeng deleted the sb/message-state branch December 7, 2021 00:28

ramya-rao-a mentioned this pull request Dec 21, 2021

Support Message State property #18563

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[ServiceBus] add `state` property to `ServiceBusReceivedMessage` #18938

[ServiceBus] add `state` property to `ServiceBusReceivedMessage` #18938

jeremymeng commented Dec 2, 2021 •

edited

Loading

azure-sdk commented Dec 2, 2021

azure-sdk commented Dec 2, 2021

jeremymeng Dec 3, 2021

ramya-rao-a Dec 3, 2021

jeremymeng Dec 3, 2021

check-enforcer bot commented Dec 3, 2021

azure-sdk commented Dec 3, 2021

ramya-rao-a Dec 3, 2021

ramya-rao-a Dec 3, 2021

ramya-rao-a Dec 3, 2021

jeremymeng Dec 3, 2021

ramya-rao-a Dec 3, 2021

jeremymeng Dec 3, 2021

ramya-rao-a commented Dec 3, 2021

deyaaeldeen Dec 4, 2021

jeremymeng Dec 4, 2021

deyaaeldeen Dec 4, 2021

jeremymeng Dec 7, 2021

	- Add a constant `messageState` with value of `"x-opt-message-state"`. [PR 18938](https://github.com/Azure/azure-sdk-for-js/pull/18938)
	- Add a constant `messageState` with value of `"x-opt-message-state"` to be used as property name for the new state property on the message. [PR 18938](https://github.com/Azure/azure-sdk-for-js/pull/18938)


		### Features Added

		- Add `state` property `ServiceBusReceivedMessage`. Its value is one of `"active"`, `"deferred"`, or `"scheduled"`. [PR 18938](https://github.com/Azure/azure-sdk-for-js/pull/18938)

	- Add `state` property `ServiceBusReceivedMessage`. Its value is one of `"active"`, `"deferred"`, or `"scheduled"`. [PR 18938](https://github.com/Azure/azure-sdk-for-js/pull/18938)
	- Add `state` property to `ServiceBusReceivedMessage`. Its value is one of `"active"`, `"deferred"`, or `"scheduled"`. [PR 18938](https://github.com/Azure/azure-sdk-for-js/pull/18938)

[ServiceBus] add state property to ServiceBusReceivedMessage #18938

[ServiceBus] add state property to ServiceBusReceivedMessage #18938

Conversation

jeremymeng commented Dec 2, 2021 • edited Loading

azure-sdk commented Dec 2, 2021

azure-sdk commented Dec 2, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

check-enforcer bot commented Dec 3, 2021

What is Check Enforcer?

Why am I getting this message?

What should I do now?

What if I am onboarding a new service?

azure-sdk commented Dec 3, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ramya-rao-a commented Dec 3, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

[ServiceBus] add `state` property to `ServiceBusReceivedMessage` #18938

[ServiceBus] add `state` property to `ServiceBusReceivedMessage` #18938

jeremymeng commented Dec 2, 2021 •

edited

Loading