[communication-common] Handle unknown additional properties when deserializing identifier REST model (Azure#22629)

* [communication-common] Handle unknown additional properties when deserializing identifier REST model

* fix let to const

* remove unnecessary escape character

Author: DominikMe

sdk/communication/communication-common/CHANGELOG.md

@@ -7,6 +7,10 @@
 - Added `getIdentifierRawId` and `createIdentifierFromRawId` to translate between a `CommunicationIdentifier` and its underlying canonical rawId representation. Developers can now use the rawId as an encoded format for identifiers to store in their databases or as stable keys in general.
 - Always include `rawId` when serializing identifiers to wire format.
 
+### Bugs Fixed
+
+- Made internal `CommunicationIdentifierSerializer` resilient to unknown additional response properties.
+
 ## 2.0.0 (2022-03-08)
 
 ### Features Added

sdk/communication/communication-common/src/identifierModelSerializer.ts

@@ -95,10 +95,20 @@ const assertNotNullOrUndefined = <
 };
 
 const assertMaximumOneNestedModel = (identifier: SerializedCommunicationIdentifier): void => {
-  const { rawId: _rawId, ...props } = identifier;
-  const keys = Object.keys(props);
-  if (keys.length > 1) {
-    throw new Error(`Only one of the properties in ${JSON.stringify(keys)} should be present.`);
+  const presentProperties: string[] = [];
+  if (identifier.communicationUser !== undefined) {
+    presentProperties.push("communicationUser");
+  }
+  if (identifier.microsoftTeamsUser !== undefined) {
+    presentProperties.push("microsoftTeamsUser");
+  }
+  if (identifier.phoneNumber !== undefined) {
+    presentProperties.push("phoneNumber");
+  }
+  if (presentProperties.length > 1) {
+    throw new Error(
+      `Only one of the properties in ${JSON.stringify(presentProperties)} should be present.`
+    );
   }
 };
 

sdk/communication/communication-common/test/identifierModelSerializer.spec.ts

@@ -40,10 +40,9 @@ const assertThrowsMissingProperty = <
 const assertThrowsTooManyProperties = (
   serializedIdentifier: SerializedCommunicationIdentifier
 ): void => {
-  const { rawId: _rawId, ...props } = serializedIdentifier;
   assert.throws(() => {
     deserializeCommunicationIdentifier(serializedIdentifier);
-  }, `Only one of the properties in ${JSON.stringify(Object.keys(props))} should be present.`);
+  }, /^Only one of the properties in \[[\w,"\s]+\] should be present.$/);
 };
 
 describe("Identifier model serializer", () => {
@@ -161,6 +160,32 @@ describe("Identifier model serializer", () => {
           "8:acs:37691ec4-57fb-4c0f-ae31-32791610cb14_37691ec4-57fb-4c0f-ae31-32791610cb14",
       }
     );
+    assertDeserialize(
+      {
+        kind: "communicationUser",
+        communicationUser: {
+          id: "8:acs:37691ec4-57fb-4c0f-ae31-32791610cb14_37691ec4-57fb-4c0f-ae31-32791610cb14",
+        },
+      } as any,
+      {
+        kind: "communicationUser",
+        communicationUserId:
+          "8:acs:37691ec4-57fb-4c0f-ae31-32791610cb14_37691ec4-57fb-4c0f-ae31-32791610cb14",
+      }
+    );
+    assertDeserialize(
+      {
+        someFutureProperty: "fooBar",
+        communicationUser: {
+          id: "8:acs:37691ec4-57fb-4c0f-ae31-32791610cb14_37691ec4-57fb-4c0f-ae31-32791610cb14",
+        },
+      } as any,
+      {
+        kind: "communicationUser",
+        communicationUserId:
+          "8:acs:37691ec4-57fb-4c0f-ae31-32791610cb14_37691ec4-57fb-4c0f-ae31-32791610cb14",
+      }
+    );
     assertDeserialize(
       { phoneNumber: { value: "+1234555000" }, rawId: "4:+1234555000" },
       { kind: "phoneNumber", phoneNumber: "+1234555000", rawId: "4:+1234555000" }