[ServiceBus] Add option to preserve Date type when receiving messages

sdk/servicebus/service-bus/CHANGELOG.md

@@ -1,9 +1,11 @@
 # Release History
 
-## 7.7.4 (Unreleased)
+## 7.8.0 (Unreleased)
 
 ### Features Added
 
+- Add an option to skip converting Date type into UNIX epoch number for properties in message annotations or application properties. (PR #24539)[https://github.com/Azure/azure-sdk-for-js/pull/24539]
+
 ### Breaking Changes
 
 ### Bugs Fixed

sdk/servicebus/service-bus/package.json

@@ -2,7 +2,7 @@
   "name": "@azure/service-bus",
   "sdk-type": "client",
   "author": "Microsoft Corporation",
-  "version": "7.7.4",
+  "version": "7.8.0",
   "license": "MIT",
   "description": "Azure Service Bus SDK for JavaScript",
   "homepage": "https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/servicebus/service-bus/",

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

@@ -503,6 +503,7 @@ export interface ServiceBusReceiverOptions {
     identifier?: string;
     maxAutoLockRenewalDurationInMs?: number;
     receiveMode?: "peekLock" | "receiveAndDelete";
+    skipConvertingDate?: boolean;
     skipParsingBodyAsJson?: boolean;
     subQueueType?: "deadLetter" | "transferDeadLetter";
 }
@@ -549,6 +550,7 @@ export interface ServiceBusSessionReceiverOptions extends OperationOptionsBase {
     identifier?: string;
     maxAutoLockRenewalDurationInMs?: number;
     receiveMode?: "peekLock" | "receiveAndDelete";
+    skipConvertingDate?: boolean;
     skipParsingBodyAsJson?: boolean;
 }
 

sdk/servicebus/service-bus/src/core/batchingReceiver.ts

@@ -77,7 +77,8 @@ export class BatchingReceiver extends MessageReceiver {
         return this.link;
       },
       this.receiveMode,
-      options.skipParsingBodyAsJson ?? false
+      options.skipParsingBodyAsJson ?? false,
+      options.skipConvertingDate ?? false
     );
   }
 
@@ -247,15 +248,17 @@ export class BatchingReceiverLite {
       abortSignal?: AbortSignalLike
     ) => Promise<MinimalReceiver | undefined>,
     private _receiveMode: ReceiveMode,
-    _skipParsingBodyAsJson: boolean
+    _skipParsingBodyAsJson: boolean,
+    _skipConvertingDate: boolean
   ) {
     this._createServiceBusMessage = (context: MessageAndDelivery) => {
       return new ServiceBusMessageImpl(
         context.message!,
         context.delivery!,
         true,
         this._receiveMode,
-        _skipParsingBodyAsJson
+        _skipParsingBodyAsJson,
+        _skipConvertingDate
       );
     };
 

sdk/servicebus/service-bus/src/core/managementClient.ts

@@ -75,6 +75,13 @@ export interface SendManagementRequestOptions extends SendRequestOptions {
    * prefer to work directly with the bytes present in the message body than have the client attempt to parse it.
    */
   skipParsingBodyAsJson?: boolean;
+  /**
+   * Whether to skip converting Date type on properties of message annotations
+   * or application properties into numbers when receiving the message. By
+   * default, properties of Date type is converted into UNIX epoch number for
+   * compatibility.
+   */
+  skipConvertingDate?: boolean;
 }
 
 /**
@@ -546,10 +553,10 @@ export class ManagementClient extends LinkEntity<RequestResponseLink> {
         const messages = result.body.messages as { message: Buffer }[];
         for (const msg of messages) {
           const decodedMessage = RheaMessageUtil.decode(msg.message);
-          const message = fromRheaMessage(
-            decodedMessage as any,
-            options?.skipParsingBodyAsJson ?? false
-          );
+          const message = fromRheaMessage(decodedMessage as any, {
+            skipParsingBodyAsJson: options?.skipParsingBodyAsJson ?? false,
+            skipConvertingDate: options?.skipConvertingDate ?? false,
+          });
           messageList.push(message);
           this._lastPeekedSequenceNumber = message.sequenceNumber!;
         }
@@ -866,7 +873,8 @@ export class ManagementClient extends LinkEntity<RequestResponseLink> {
           { tag: msg["lock-token"] } as any,
           false,
           receiveMode,
-          options?.skipParsingBodyAsJson ?? false
+          options?.skipParsingBodyAsJson ?? false,
+          false
         );
         messageList.push(message);
       }

sdk/servicebus/service-bus/src/core/messageReceiver.ts

@@ -57,6 +57,14 @@ export interface ReceiveOptions extends SubscribeOptions {
    * prefer to work directly with the bytes present in the message body than have the client attempt to parse it.
    */
   skipParsingBodyAsJson: boolean;
+
+  /**
+   * Whether to skip converting Date type on properties of message annotations
+   * or application properties into numbers when receiving the message. By
+   * default, properties of Date type is converted into UNIX epoch number for
+   * compatibility.
+   */
+  skipConvertingDate: boolean;
 }
 
 /**

sdk/servicebus/service-bus/src/core/streamingReceiver.ts

@@ -255,7 +255,8 @@ export class StreamingReceiver extends MessageReceiver {
         context.delivery!,
         true,
         this.receiveMode,
-        options.skipParsingBodyAsJson ?? false
+        options.skipParsingBodyAsJson ?? false,
+        options.skipConvertingDate ?? false
       );
 
       this._lockRenewer?.start(this, bMessage, (err) => {

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

@@ -165,6 +165,13 @@ export interface ServiceBusReceiverOptions {
    * prefer to work directly with the bytes present in the message body than have the client attempt to parse it.
    */
   skipParsingBodyAsJson?: boolean;
+  /**
+   * Whether to skip converting Date type on properties of message annotations
+   * or application properties into numbers when receiving the message. By
+   * default, properties of Date type is converted into UNIX epoch number for
+   * compatibility.
+   */
+  skipConvertingDate?: boolean;
   /**
    * Sets the name to identify the receiver. This can be used to correlate logs and exceptions.
    * If not specified or empty, a random unique one will be used.
@@ -291,6 +298,13 @@ export interface ServiceBusSessionReceiverOptions extends OperationOptionsBase {
    * prefer to work directly with the bytes present in the message body than have the client attempt to parse it.
    */
   skipParsingBodyAsJson?: boolean;
+  /**
+   * Whether to skip converting Date type on properties of message annotations
+   * or application properties into numbers when receiving the message. By
+   * default, properties of Date type is converted into UNIX epoch number for
+   * compatibility.
+   */
+  skipConvertingDate?: boolean;
   /**
    * Sets the name to identify the session receiver. This can be used to correlate logs and exceptions.
    * If not specified or empty, a random unique one will be used.

sdk/servicebus/service-bus/src/receivers/receiver.ts

@@ -307,6 +307,7 @@ export class ServiceBusReceiverImpl implements ServiceBusReceiver {
     public receiveMode: "peekLock" | "receiveAndDelete",
     maxAutoRenewLockDurationInMs: number,
     private skipParsingBodyAsJson: boolean,
+    private skipConvertingDate: boolean = false,
     retryOptions: RetryOptions = {},
     identifier?: string
   ) {
@@ -372,6 +373,7 @@ export class ServiceBusReceiverImpl implements ServiceBusReceiver {
           receiveMode: this.receiveMode,
           lockRenewer: this._lockRenewer,
           skipParsingBodyAsJson: this.skipParsingBodyAsJson,
+          skipConvertingDate: this.skipConvertingDate,
         };
         this._batchingReceiver = this._createBatchingReceiver(
           this._context,
@@ -526,6 +528,7 @@ export class ServiceBusReceiverImpl implements ServiceBusReceiver {
         retryOptions: this._retryOptions,
         lockRenewer: this._lockRenewer,
         skipParsingBodyAsJson: this.skipParsingBodyAsJson,
+        skipConvertingDate: this.skipConvertingDate,
       });
 
     // this ensures that if the outer service bus client is closed that  this receiver is cleaned up.

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

@@ -229,6 +229,7 @@ export class ServiceBusClient {
       receiveMode,
       maxLockAutoRenewDurationInMs,
       options?.skipParsingBodyAsJson ?? false,
+      options?.skipConvertingDate ?? false,
       this._clientOptions.retryOptions,
       options?.identifier
     );
@@ -362,6 +363,7 @@ export class ServiceBusClient {
         abortSignal: options?.abortSignal,
         retryOptions: this._clientOptions.retryOptions,
         skipParsingBodyAsJson: options?.skipParsingBodyAsJson ?? false,
+        skipConvertingDate: options?.skipConvertingDate ?? false,
       }
     );
 
@@ -449,6 +451,7 @@ export class ServiceBusClient {
         abortSignal: options?.abortSignal,
         retryOptions: this._clientOptions.retryOptions,
         skipParsingBodyAsJson: options?.skipParsingBodyAsJson ?? false,
+        skipConvertingDate: options?.skipConvertingDate ?? false,
       }
     );
 

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

@@ -516,16 +516,24 @@ export interface ServiceBusReceivedMessage extends ServiceBusMessage {
  */
 export function fromRheaMessage(
   rheaMessage: RheaMessage,
-  skipParsingBodyAsJson: boolean,
-  delivery?: Delivery,
-  shouldReorderLockToken?: boolean
+  options: {
+    skipParsingBodyAsJson: boolean;
+    skipConvertingDate?: boolean;
+    delivery?: Delivery;
+    shouldReorderLockToken?: boolean;
+  }
 ): ServiceBusReceivedMessage {
   if (!rheaMessage) {
     rheaMessage = {
       body: undefined,
     };
   }
-
+  const {
+    skipParsingBodyAsJson,
+    delivery,
+    shouldReorderLockToken,
+    skipConvertingDate = false,
+  } = options;
   const { body, bodyType } = defaultDataTransformer.decodeWithType(
     rheaMessage.body,
     skipParsingBodyAsJson
@@ -536,7 +544,9 @@ export function fromRheaMessage(
   };
 
   if (rheaMessage.application_properties != null) {
-    sbmsg.applicationProperties = convertDatesToNumbers(rheaMessage.application_properties);
+    sbmsg.applicationProperties = skipConvertingDate
+      ? rheaMessage.application_properties
+      : convertDatesToNumbers(rheaMessage.application_properties);
   }
   if (rheaMessage.content_type != null) {
     sbmsg.contentType = rheaMessage.content_type;
@@ -635,13 +645,19 @@ export function fromRheaMessage(
   rawMessage.bodyType = bodyType;
 
   if (rawMessage.applicationProperties) {
-    rawMessage.applicationProperties = convertDatesToNumbers(rawMessage.applicationProperties);
+    rawMessage.applicationProperties = skipConvertingDate
+      ? rawMessage.applicationProperties
+      : convertDatesToNumbers(rawMessage.applicationProperties);
   }
   if (rawMessage.deliveryAnnotations) {
-    rawMessage.deliveryAnnotations = convertDatesToNumbers(rawMessage.deliveryAnnotations);
+    rawMessage.deliveryAnnotations = skipConvertingDate
+      ? rawMessage.deliveryAnnotations
+      : convertDatesToNumbers(rawMessage.deliveryAnnotations);
   }
   if (rawMessage.messageAnnotations) {
-    rawMessage.messageAnnotations = convertDatesToNumbers(rawMessage.messageAnnotations);
+    rawMessage.messageAnnotations = skipConvertingDate
+      ? rawMessage.messageAnnotations
+      : convertDatesToNumbers(rawMessage.messageAnnotations);
   }
 
   const rcvdsbmsg: ServiceBusReceivedMessage = {
@@ -899,13 +915,13 @@ export class ServiceBusMessageImpl implements ServiceBusReceivedMessage {
     delivery: Delivery,
     shouldReorderLockToken: boolean,
     receiveMode: ReceiveMode,
-    skipParsingBodyAsJson: boolean
+    skipParsingBodyAsJson: boolean,
+    skipConvertingDate: boolean
   ) {
     const { _rawAmqpMessage, ...restOfMessageProps } = fromRheaMessage(
       msg,
-      skipParsingBodyAsJson,
-      delivery,
-      shouldReorderLockToken
+
+      { skipParsingBodyAsJson, delivery, shouldReorderLockToken, skipConvertingDate }
     );
     this._rawAmqpMessage = _rawAmqpMessage; // need to initialize _rawAmqpMessage property to make compiler happy
     Object.assign(this, restOfMessageProps);
@@ -970,7 +986,11 @@ function convertDatesToNumbers<T = unknown>(thing: T): T {
     [0, 'foo', new Date(), { nested: new Date()}]
   */
   if (Array.isArray(thing)) {
-    return thing.map(convertDatesToNumbers) as unknown as T;
+    const result = [];
+    for (const element of thing) {
+      result.push(convertDatesToNumbers(element));
+    }
+    return result as unknown as T;
   }
 
   /*

sdk/servicebus/service-bus/src/session/messageSession.ts

@@ -63,6 +63,7 @@ export type MessageSessionOptions = Pick<
   receiveMode?: ReceiveMode;
   retryOptions: RetryOptions | undefined;
   skipParsingBodyAsJson: boolean;
+  skipConvertingDate: boolean;
 };
 
 /**
@@ -186,6 +187,14 @@ export class MessageSession extends LinkEntity<Receiver> {
    */
   private skipParsingBodyAsJson: boolean;
 
+  /**
+   * Whether to skip converting Date type on properties of message annotations
+   * or application properties into numbers when receiving the message. By
+   * default, properties of Date type is converted into UNIX epoch number for
+   * compatibility.
+   */
+  private skipConvertingDate: boolean;
+
   public get receiverHelper(): ReceiverHelper {
     return this._receiverHelper;
   }
@@ -391,6 +400,7 @@ export class MessageSession extends LinkEntity<Receiver> {
     if (isDefined(this._providedSessionId)) this.sessionId = this._providedSessionId;
     this.receiveMode = options.receiveMode || "peekLock";
     this.skipParsingBodyAsJson = options.skipParsingBodyAsJson;
+    this.skipConvertingDate = options.skipConvertingDate;
     this.maxAutoRenewDurationInMs =
       options.maxAutoLockRenewalDurationInMs != null
         ? options.maxAutoLockRenewalDurationInMs
@@ -406,7 +416,8 @@ export class MessageSession extends LinkEntity<Receiver> {
         return this.link!;
       },
       this.receiveMode,
-      this.skipParsingBodyAsJson
+      this.skipParsingBodyAsJson,
+      this.skipConvertingDate
     );
 
     // setting all the handlers
@@ -648,7 +659,8 @@ export class MessageSession extends LinkEntity<Receiver> {
           context.delivery!,
           true,
           this.receiveMode,
-          this.skipParsingBodyAsJson
+          this.skipParsingBodyAsJson,
+          this.skipConvertingDate
         );
 
         try {

sdk/servicebus/service-bus/src/util/constants.ts

@@ -6,7 +6,7 @@
  */
 export const packageJsonInfo = {
   name: "@azure/service-bus",
-  version: "7.7.4",
+  version: "7.8.0",
 };
 
 /**

sdk/servicebus/service-bus/test/internal/retries.spec.ts

@@ -354,6 +354,7 @@ describe("Retries - Receive methods", () => {
           lockRenewer: undefined,
           receiveMode: "peekLock",
           skipParsingBodyAsJson: false,
+          skipConvertingDate: false,
         }
       );
       batchingReceiver.isOpen = () => true;