[ServiceBus] ServiceBusMessage.clone() is not a pure immutable clone

• Package Name: service-bus
• Package Version: 1.1.7 (but preview as well)
• Operating system:
• nodejs
  • version:
• browser
  • name/version:
• typescript
  • version:

Describe the bug When cloning a message the userProperties object is copied, not cloned.

Expected behavior Object should be cloned, or at least express that it is a shallow clone

https://github.com/Azure/azure-sdk-for-js/blob/e51a1d464e74be914f2e40bfd5c36d1fc2a4240c/sdk/servicebus/service-bus/src/serviceBusMessage.ts#L1025

Because ServiceBusMessage is built out of transported date (JSON) it is safe to assume it does not contain circular references, if you are willing to freeze it when creating it…

[richardpark-msft]

This logic shouldnt be out for guess, it should be managed by the library.

Oh, definitely!

I wasn’t clear above but this is built-in and done internally in the Sender - if it was anything but that it’d be completely incorrect for us to claim clone() is obsolete/unneeded.

So you can just pass the message you received to all the send APIs and it will work.

Some example code:

// method of receiving doesn't matter
for await (const message of receiver.getMessageIterator()) {
  await message.complete();

  await sender.send(message);
  await sender.scheduleMessage(new Date(), message);
}

[richardpark-msft]

Going to close this issue, please let me know if you have more questions.