[ServiceBus][Test] fix unstable tests that verify message state (Azure#19357)

* [ServiceBus][Test] fix unstable tests that verify message state

The test messages we create have `scheduledEnqueueTimeUtc` set. Most of the time
messages received from the service have "active" state, but occasionally have
"scheduled" state due to the set property, thus failing the assertion.

This PR updates the check to check for either "active" or "schedule". In
addition, a test is added for "active" state where the `scheduledEnqueueTimeUtc`
property is removed before sending the message.

Also shown in the failing pipeline that when the test failed, the message wasn't
removed because `receiver.completeMessage()` is not called. The lingering
message caused the next test to fail. While updating the tests I also moved the
cleanup step before assertions so the message should always be removed.

* Undo changes to pipeline

* Address CR feedback

* Disable linting rule

* Remove an unstable assertion on message state.

Author: jeremymeng

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

@@ -61,21 +61,21 @@ describe("Sender Tests", () => {
       : TestMessage.getSample();
     await sender.sendMessages(testMessage);
     const msgs = await receiver.receiveMessages(1);
-
+    const receivedMessage = msgs[0];
+    // remove message first in case any assertion fails to ensure we don't have lingering message
+    await receiver.completeMessage(receivedMessage);
     should.equal(Array.isArray(msgs), true, "`ReceivedMessages` is not an array");
     should.equal(msgs.length, 1, "Unexpected number of messages");
-    should.equal(msgs[0].deliveryCount, 0, "DeliveryCount is different than expected");
-    should.equal(msgs[0].state, "active");
+    should.equal(receivedMessage.deliveryCount, 0, "DeliveryCount is different than expected");
+    should.equal(receivedMessage.messageId, testMessage.messageId);
 
     TestMessage.checkMessageContents(
       testMessage,
-      msgs[0],
+      receivedMessage,
       entityName.usesSessions,
       entityName.isPartitioned
     );
 
-    await receiver.completeMessage(msgs[0]);
-
     await testPeekMsgsLength(receiver, 0);
   }
 
@@ -89,6 +89,22 @@ describe("Sender Tests", () => {
     await testSimpleSend();
   });
 
+  it(withSessionTestClientType + ": Received message has active state", async function(): Promise<
+    void
+  > {
+    await beforeEachTest(withSessionTestClientType);
+    const testMessage = entityName.usesSessions
+      ? TestMessage.getSessionSample()
+      : TestMessage.getSample();
+    // Ensure the message is not scheduled.
+    delete testMessage.scheduledEnqueueTimeUtc;
+    await sender.sendMessages(testMessage);
+    const msgs = await receiver.receiveMessages(1);
+    // remove message first in case any assertion fails to ensure we don't have lingering message
+    await receiver.completeMessage(msgs[0]);
+    msgs[0].state.should.equal("active");
+  });
+
   async function testSimpleSendArray(): Promise<void> {
     const testMessages = [];
     testMessages.push(
@@ -101,9 +117,26 @@ describe("Sender Tests", () => {
     await sender.sendMessages(testMessages);
     const msgs = await receiver.receiveMessages(2);
 
+    // remove messages first in case any assertion fails to ensure we don't have lingering messages
+    await receiver.completeMessage(msgs[0]);
+    await receiver.completeMessage(msgs[1]);
+
     should.equal(Array.isArray(msgs), true, "`ReceivedMessages` is not an array");
     should.equal(msgs.length, 2, "Unexpected number of messages");
 
+    should.equal(
+      msgs[0].messageId === testMessages[0].messageId ||
+        msgs[0].messageId === testMessages[1].messageId,
+      true,
+      `Unexpected message with id ${msgs[0].messageId}`
+    );
+    should.equal(
+      msgs[1].messageId === testMessages[0].messageId ||
+        msgs[1].messageId === testMessages[1].messageId,
+      true,
+      `Unexpected message with id ${msgs[1].messageId}`
+    );
+
     if (testMessages[0].messageId === msgs[0].messageId) {
       TestMessage.checkMessageContents(
         testMessages[0],
@@ -132,9 +165,6 @@ describe("Sender Tests", () => {
       );
     }
 
-    await receiver.completeMessage(msgs[0]);
-    await receiver.completeMessage(msgs[1]);
-
     await testPeekMsgsLength(receiver, 0);
   }