@azure/communication-common - PhoneNumberIdentifier serialization (Azure#23264)

* removed adding/stripping of "+" in phone numbers

Author: petrsvihlik

sdk/communication/communication-common/CHANGELOG.md

@@ -8,6 +8,8 @@
 
 ### Bugs Fixed
 
+- Fixed the logic of `getIdentifierRawId` and `createIdentifierFromRawId` for `PhoneNumberIdentifier` to always maintain the original phone number string whether it included the leading `+` sign or not.
+
 ### Other Changes
 
 - Updated to `@azure/core-tracing` 1.0.

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

@@ -209,8 +209,7 @@ export const getIdentifierRawId = (identifier: CommunicationIdentifier): string
     case "phoneNumber": {
       const { phoneNumber, rawId } = identifierKind;
       if (rawId) return rawId;
-      // strip the leading +. We just assume correct E.164 format here because validation should only happen server-side, not client-side.
-      return `4:${phoneNumber.replace(/^\+/, "")}`;
+      return `4:${phoneNumber}`;
     }
     case "unknown": {
       return identifierKind.id;
@@ -225,7 +224,7 @@ export const getIdentifierRawId = (identifier: CommunicationIdentifier): string
  */
 export const createIdentifierFromRawId = (rawId: string): CommunicationIdentifierKind => {
   if (rawId.startsWith("4:")) {
-    return { kind: "phoneNumber", phoneNumber: `+${rawId.substring("4:".length)}` };
+    return { kind: "phoneNumber", phoneNumber: `${rawId.substring("4:".length)}` };
   }
 
   const segments = rawId.split(":");

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

@@ -120,7 +120,7 @@ describe("Identifier model serializer", () => {
     assertSerialize(
       { phoneNumber: "+12345556789" },
       {
-        rawId: "4:12345556789",
+        rawId: "4:+12345556789",
         phoneNumber: {
           value: "+12345556789",
         },

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

@@ -108,14 +108,41 @@ describe("Identifier models", () => {
       {
         phoneNumber: "+112345556789",
       },
+      "4:+112345556789"
+    );
+    assertRawId(
+      {
+        phoneNumber: "112345556789",
+      },
       "4:112345556789"
     );
     assertRawId(
       {
         phoneNumber: "+112345556789",
-        rawId: "4:otherFormat",
+        rawId: "4:112345556789",
+      },
+      "4:112345556789"
+    );
+    assertRawId(
+      {
+        phoneNumber: "otherFormat",
+        rawId: "4:207ffef6-9444-41fb-92ab-20eacaae2768",
+      },
+      "4:207ffef6-9444-41fb-92ab-20eacaae2768"
+    );
+    assertRawId(
+      {
+        phoneNumber: "otherFormat",
+        rawId: "4:207ffef6-9444-41fb-92ab-20eacaae2768_207ffef6-9444-41fb-92ab-20eacaae2768",
       },
-      "4:otherFormat"
+      "4:207ffef6-9444-41fb-92ab-20eacaae2768_207ffef6-9444-41fb-92ab-20eacaae2768"
+    );
+    assertRawId(
+      {
+        phoneNumber: "otherFormat",
+        rawId: "4:+112345556789_207ffef6-9444-41fb-92ab-20eacaae2768",
+      },
+      "4:+112345556789_207ffef6-9444-41fb-92ab-20eacaae2768"
     );
     assertRawId(
       {
@@ -201,11 +228,26 @@ describe("Identifier models", () => {
       kind: "microsoftTeamsUser",
     });
     assertIdentifier("4:112345556789", {
+      phoneNumber: "112345556789",
+      kind: "phoneNumber",
+    });
+    assertIdentifier("4:+112345556789", {
       phoneNumber: "+112345556789",
       kind: "phoneNumber",
     });
-    assertIdentifier("4:otherFormat", {
-      phoneNumber: "+otherFormat",
+    assertIdentifier("4:207ffef6-9444-41fb-92ab-20eacaae2768", {
+      phoneNumber: "207ffef6-9444-41fb-92ab-20eacaae2768",
+      kind: "phoneNumber",
+    });
+    assertIdentifier(
+      "4:207ffef6-9444-41fb-92ab-20eacaae2768_207ffef6-9444-41fb-92ab-20eacaae2768",
+      {
+        phoneNumber: "207ffef6-9444-41fb-92ab-20eacaae2768_207ffef6-9444-41fb-92ab-20eacaae2768",
+        kind: "phoneNumber",
+      }
+    );
+    assertIdentifier("4:+112345556789_207ffef6-9444-41fb-92ab-20eacaae2768", {
+      phoneNumber: "+112345556789_207ffef6-9444-41fb-92ab-20eacaae2768",
       kind: "phoneNumber",
     });
     assertIdentifier("28:45ab2481-1c1c-4005-be24-0ffb879b1130", {
@@ -243,7 +285,10 @@ describe("Identifier models", () => {
     assertRoundtrip("8:teamsvisitor:45ab2481-1c1c-4005-be24-0ffb879b1130");
     assertRoundtrip("8:orgid:legacyFormat");
     assertRoundtrip("4:112345556789");
-    assertRoundtrip("4:otherFormat");
+    assertRoundtrip("4:+112345556789");
+    assertRoundtrip("4:207ffef6-9444-41fb-92ab-20eacaae2768");
+    assertRoundtrip("4:207ffef6-9444-41fb-92ab-20eacaae2768_207ffef6-9444-41fb-92ab-20eacaae2768");
+    assertRoundtrip("4:+112345556789_207ffef6-9444-41fb-92ab-20eacaae2768");
     assertRoundtrip("28:45ab2481-1c1c-4005-be24-0ffb879b1130");
     assertRoundtrip("");
   });