[core-amqp][event-hubs][service-bus] Fixes _process of undefined TypeError (Azure#15597)

This PR fixes Azure#13500.

`rhea` 2.0.1 contains the fix to this specific error. We currently use `rhea` 1.x, so there's additional work in this PR to workaround the single breaking change in `rhea`, and the breaking changes in `rhea-promise`.

### rhea breaking change

`rhea` contains 1 breaking change between versions 1.x and 2.x: timestamp types are now deserialized as Date objects instead of numbers. Unfortunately since this changes the way users' data might be deserialized in their service bus messages or event hubs events, we have to convert Date objects back to numbers in our client libraries until we do a major version bump. (Shorter term we can look at using rhea's default behavior behind a flag.)

### rhea-promise breaking changes

Some of the `rhea-promise` APIs that accepted multiple optional positional arguments have been updated to take a single options bag parameter at the end of their method parameter list.

AwaitableSender was also updated so that a timeout is no provided at instantiation. Instead, it must be provided per each `send()` call.

### core-amqp v3
Since core-amqp is being updated to depend on rhea 2.x, core-amqp dependencies will also pull in rhea 2.x transitively.
To ensure that existing versions of event hubs and service bus don't break by deserializing timestamps as Date objects, core-amqp is updated to a new major version: v3. 

Once Azure#15349 is merged, we can also remove `AsyncLock` completely, so I'd like to merge that PR in before releasing the changes in this PR.

Author: chradek

common/config/rush/pnpm-lock.yaml

@@ -1,7 +1,10 @@
 # Release History
 
-## 2.3.1 (Unreleased)
+## 3.0.0 (Unreleased)
 
+### Breaking changes
+
+- Updates the `rhea-promise` and `rhea` dependencies to version 2.x. `rhea` contains a breaking change that changes deserialization of timestamps from numbers to Date objects.
 
 ## 2.3.0 (2021-04-29)
 

sdk/core/core-amqp/CHANGELOG.md

@@ -1,7 +1,7 @@
 {
   "name": "@azure/core-amqp",
   "sdk-type": "client",
-  "version": "2.3.1",
+  "version": "3.0.0",
   "description": "Common library for amqp based azure sdks like @azure/event-hubs.",
   "author": "Microsoft Corporation",
   "license": "MIT",
@@ -78,8 +78,8 @@
     "events": "^3.0.0",
     "jssha": "^3.1.0",
     "process": "^0.11.10",
-    "rhea": "^1.0.24",
-    "rhea-promise": "^1.2.1",
+    "rhea": "^2.0.2",
+    "rhea-promise": "^2.0.0",
     "tslib": "^2.0.0",
     "url": "^0.11.0",
     "util": "^0.12.1"

sdk/core/core-amqp/package.json

@@ -79,7 +79,7 @@ export const AmqpMessageProperties = {
   toRheaMessageProperties(props: AmqpMessageProperties): RheaMessageProperties {
     const amqpProperties: RheaMessageProperties = {};
     if (props.absoluteExpiryTime != undefined) {
-      amqpProperties.absolute_expiry_time = props.absoluteExpiryTime;
+      amqpProperties.absolute_expiry_time = new Date(props.absoluteExpiryTime);
     }
     if (props.contentEncoding != undefined) {
       amqpProperties.content_encoding = props.contentEncoding;
@@ -91,7 +91,7 @@ export const AmqpMessageProperties = {
       amqpProperties.correlation_id = props.correlationId;
     }
     if (props.creationTime != undefined) {
-      amqpProperties.creation_time = props.creationTime;
+      amqpProperties.creation_time = new Date(props.creationTime);
     }
     if (props.groupId != undefined) {
       amqpProperties.group_id = props.groupId;
@@ -130,7 +130,7 @@ export const AmqpMessageProperties = {
   fromRheaMessageProperties(props: RheaMessageProperties): AmqpMessageProperties {
     const msgProperties: AmqpMessageProperties = {};
     if (props.absolute_expiry_time != undefined) {
-      msgProperties.absoluteExpiryTime = props.absolute_expiry_time;
+      msgProperties.absoluteExpiryTime = props.absolute_expiry_time.getTime();
     }
     if (props.content_encoding != undefined) {
       msgProperties.contentEncoding = props.content_encoding;
@@ -142,7 +142,7 @@ export const AmqpMessageProperties = {
       msgProperties.correlationId = props.correlation_id;
     }
     if (props.creation_time != undefined) {
-      msgProperties.creationTime = props.creation_time;
+      msgProperties.creationTime = props.creation_time.getTime();
     }
     if (props.group_id != undefined) {
       msgProperties.groupId = props.group_id;

sdk/core/core-amqp/src/messageProperties.ts

@@ -93,11 +93,11 @@ describe("message", function() {
         // userId: ""
       };
       const amqpMsgPropertiesExpected: RheaMessageProperties = {
-        absolute_expiry_time: 0,
+        absolute_expiry_time: new Date(0),
         content_encoding: "",
         content_type: "",
         correlation_id: 0,
-        creation_time: 0,
+        creation_time: new Date(0),
         group_id: "",
         group_sequence: 0,
         message_id: "",
@@ -140,11 +140,11 @@ describe("message", function() {
         // userId: ""
       };
       const amqpMsgProperties: RheaMessageProperties = {
-        absolute_expiry_time: 0,
+        absolute_expiry_time: new Date(0),
         content_encoding: "",
         content_type: "",
         correlation_id: 0,
-        creation_time: 0,
+        creation_time: new Date(0),
         group_id: "",
         group_sequence: 0,
         message_id: "",

sdk/core/core-amqp/test/message.spec.ts

@@ -2,6 +2,9 @@
 
 ## 5.5.2 (Unreleased)
 
+### Bug fixes
+
+- Fixes issue [#13500](https://github.com/Azure/azure-sdk-for-js/issues/13500) where a `TypeError: Cannot read property '_process' of undefined` could be thrown in rare cases.
 
 ## 5.5.1 (2021-04-29)
 

sdk/eventhub/event-hubs/CHANGELOG.md

@@ -90,7 +90,7 @@
   },
   "dependencies": {
     "@azure/abort-controller": "^1.0.0",
-    "@azure/core-amqp": "^2.3.0",
+    "@azure/core-amqp": "^3.0.0",
     "@azure/core-asynciterator-polyfill": "^1.0.0",
     "@azure/core-auth": "^1.3.0",
     "@azure/core-tracing": "1.0.0-preview.11",
@@ -99,7 +99,7 @@
     "is-buffer": "^2.0.3",
     "jssha": "^3.1.0",
     "process": "^0.11.10",
-    "rhea-promise": "^1.2.1",
+    "rhea-promise": "^2.0.0",
     "tslib": "^2.0.0",
     "uuid": "^8.3.0"
   },

sdk/eventhub/event-hubs/package.json

@@ -3,7 +3,7 @@
 
 import { DeliveryAnnotations, Message as RheaMessage, MessageAnnotations } from "rhea-promise";
 import { Constants } from "@azure/core-amqp";
-import { isDefined } from "./util/typeGuards";
+import { isDefined, objectHasProperty } from "./util/typeGuards";
 
 /**
  * Describes the delivery annotations.
@@ -156,13 +156,15 @@ export function fromRheaMessage(msg: RheaMessage): EventDataInternal {
           if (!data.systemProperties) {
             data.systemProperties = {};
           }
-          data.systemProperties[annotationKey] = msg.message_annotations[annotationKey];
+          data.systemProperties[annotationKey] = convertDatesToNumbers(
+            msg.message_annotations[annotationKey]
+          );
           break;
       }
     }
   }
   if (msg.application_properties) {
-    data.properties = msg.application_properties;
+    data.properties = convertDatesToNumbers(msg.application_properties);
   }
   if (msg.delivery_annotations) {
     data.lastEnqueuedOffset = msg.delivery_annotations.last_enqueued_offset;
@@ -181,7 +183,9 @@ export function fromRheaMessage(msg: RheaMessage): EventDataInternal {
       data.systemProperties = {};
     }
     if (msg[messageProperty] != null) {
-      data.systemProperties[messagePropertiesMap[messageProperty]] = msg[messageProperty];
+      data.systemProperties[messagePropertiesMap[messageProperty]] = convertDatesToNumbers(
+        msg[messageProperty]
+      );
     }
   }
 
@@ -284,3 +288,43 @@ export interface ReceivedEventData {
     [key: string]: any;
   };
 }
+
+/**
+ * Converts any Date objects into a number representing date.getTime().
+ * Recursively checks for any Date objects in arrays and objects.
+ * @internal
+ */
+function convertDatesToNumbers<T = unknown>(thing: T): T {
+  // fast exit
+  if (!isDefined(thing)) return thing;
+
+  // When 'thing' is a Date, return the number representation
+  if (
+    typeof thing === "object" &&
+    objectHasProperty(thing, "getTime") &&
+    typeof thing.getTime === "function"
+  ) {
+    return thing.getTime();
+  }
+
+  /*
+    Examples:
+    [0, 'foo', new Date(), { nested: new Date()}]
+  */
+  if (Array.isArray(thing)) {
+    return (thing.map(convertDatesToNumbers) as unknown) as T;
+  }
+
+  /*
+    Examples:
+    { foo: new Date(), children: { nested: new Date() }}
+  */
+  if (typeof thing === "object" && isDefined(thing)) {
+    thing = { ...thing };
+    for (const key of Object.keys(thing)) {
+      (thing as any)[key] = convertDatesToNumbers((thing as any)[key]);
+    }
+  }
+
+  return thing;
+}

sdk/eventhub/event-hubs/src/eventData.ts

@@ -303,7 +303,7 @@ export class EventHubSender extends LinkEntity {
     );
   }
 
-  private _createSenderOptions(timeoutInMs: number, newName?: boolean): AwaitableSenderOptions {
+  private _createSenderOptions(newName?: boolean): AwaitableSenderOptions {
     if (newName) this.name = `${uuid()}`;
     const srOptions: AwaitableSenderOptions = {
       name: this.name,
@@ -313,8 +313,7 @@ export class EventHubSender extends LinkEntity {
       onError: this._onAmqpError,
       onClose: this._onAmqpClose,
       onSessionError: this._onSessionError,
-      onSessionClose: this._onSessionClose,
-      sendTimeoutInSeconds: timeoutInMs / 1000
+      onSessionClose: this._onSessionClose
     };
     logger.verbose("Creating sender with options: %O", srOptions);
     return srOptions;
@@ -403,9 +402,10 @@ export class EventHubSender extends LinkEntity {
         throw translate(e);
       }
 
-      sender.sendTimeoutInSeconds = (timeoutInMs - timeTakenByInit - waitTimeForSendable) / 1000;
       try {
-        const delivery = await sender.send(rheaMessage, undefined, 0x80013700, {
+        const delivery = await sender.send(rheaMessage, {
+          format: 0x80013700,
+          timeoutInSeconds: (timeoutInMs - timeTakenByInit - waitTimeForSendable) / 1000,
           abortSignal
         });
         logger.info(
@@ -454,7 +454,7 @@ export class EventHubSender extends LinkEntity {
     const retryOptions = options.retryOptions || {};
     const timeoutInMs = getRetryAttemptTimeoutInMs(retryOptions);
     retryOptions.timeoutInMs = timeoutInMs;
-    const senderOptions = this._createSenderOptions(timeoutInMs);
+    const senderOptions = this._createSenderOptions();
 
     const startTime = Date.now();
     const createLinkPromise = async (): Promise<AwaitableSender> => {

sdk/eventhub/event-hubs/src/eventHubSender.ts

@@ -86,8 +86,12 @@ describe("EventData", function(): void {
         testEventData.offset!.should.equal(testAnnotations["x-opt-offset"]);
         testEventData.sequenceNumber!.should.equal(testAnnotations["x-opt-sequence-number"]);
         testEventData.partitionKey!.should.equal(testAnnotations["x-opt-partition-key"]);
-        testEventData.systemProperties!["x-iot-foo-prop"] = extraAnnotations["x-iot-foo-prop"];
-        testEventData.systemProperties!["x-iot-bar-prop"] = extraAnnotations["x-iot-bar-prop"];
+        testEventData.systemProperties!["x-iot-foo-prop"].should.eql(
+          extraAnnotations["x-iot-foo-prop"]
+        );
+        testEventData.systemProperties!["x-iot-bar-prop"].should.eql(
+          extraAnnotations["x-iot-bar-prop"]
+        );
       });
 
       it("returns systemProperties for special known properties", function(): void {
@@ -104,8 +108,8 @@ describe("EventData", function(): void {
           content_encoding: "utf-8",
           content_type: "application/json",
           correlation_id: "id2",
-          absolute_expiry_time: 0,
-          creation_time: 0,
+          absolute_expiry_time: new Date(0),
+          creation_time: new Date(0),
           group_id: "groupId",
           group_sequence: 1
         });
@@ -131,6 +135,41 @@ describe("EventData", function(): void {
         testEventData.systemProperties!["groupSequence"].should.equal(1);
       });
     });
+
+    it("deserializes Dates to numbers in properties and annotations", () => {
+      const timestamp = new Date();
+      const extraAnnotations = {
+        "x-date": timestamp,
+        "x-number": timestamp.getTime()
+      };
+      const testEventData = fromRheaMessage({
+        body: testBody,
+        application_properties: {
+          topLevelDate: timestamp,
+          child: {
+            nestedDate: timestamp,
+            children: [timestamp, { deepDate: timestamp }]
+          }
+        },
+        message_annotations: {
+          ...testAnnotations,
+          ...extraAnnotations
+        }
+      });
+      testEventData.enqueuedTimeUtc!.getTime().should.equal(testAnnotations["x-opt-enqueued-time"]);
+      testEventData.offset!.should.equal(testAnnotations["x-opt-offset"]);
+      testEventData.sequenceNumber!.should.equal(testAnnotations["x-opt-sequence-number"]);
+      testEventData.partitionKey!.should.equal(testAnnotations["x-opt-partition-key"]);
+      testEventData.systemProperties!["x-date"].should.eql(extraAnnotations["x-date"].getTime());
+      testEventData.systemProperties!["x-number"].should.eql(extraAnnotations["x-number"]);
+      testEventData.properties!.should.eql({
+        topLevelDate: timestamp.getTime(),
+        child: {
+          nestedDate: timestamp.getTime(),
+          children: [timestamp.getTime(), { deepDate: timestamp.getTime() }]
+        }
+      });
+    });
   });
 
   describe("toAmqpMessage", function(): void {