Adding UUIDs to MessageRequests and MessageResponses

change/@microsoft-teams-js-acd75970-b390-4cfe-b488-4bd6f51f723e.json

@@ -0,0 +1,7 @@
+{
+  "type": "minor",
+  "comment": "Added uuid parameter to MessageRequest interface and enabled MessageResponse ids to also be uuids",
+  "packageName": "@microsoft/teams-js",
+  "email": "jadahiya@microsoft.com",
+  "dependentChangeType": "patch"
+}

packages/teams-js/src/internal/communication.ts

@@ -10,15 +10,21 @@ import { version } from '../public/version';
 import { GlobalVars } from './globalVars';
 import { callHandler } from './handlers';
 import { DOMMessageEvent, ExtendedWindow } from './interfaces';
-import { MessageRequest, MessageRequestWithRequiredProperties, MessageResponse } from './messageObjects';
+import {
+  MessageID,
+  MessageRequest,
+  MessageRequestWithRequiredProperties,
+  MessageResponse,
+  MessageUUID,
+} from './messageObjects';
 import {
   NestedAppAuthMessageEventNames,
   NestedAppAuthRequest,
   ParsedNestedAppAuthMessageData,
   tryPolyfillWithNestedAppAuthBridge,
 } from './nestedAppAuthUtils';
 import { getLogger, isFollowingApiVersionTagFormat } from './telemetry';
-import { ssrSafeWindow } from './utils';
+import { generateGUID, ssrSafeWindow } from './utils';
 import { validateOrigin } from './validOrigins';
 
 const communicationLogger = getLogger('communication');
@@ -47,15 +53,18 @@ class CommunicationPrivate {
   public static topMessageQueue: MessageRequest[] = [];
   public static nextMessageId = 0;
   public static callbacks: {
-    [id: number]: Function; // (arg1, arg2, ...etc) => void
+    [id: MessageID]: Function; // (arg1, arg2, ...etc) => void
   } = {};
   public static promiseCallbacks: {
-    [id: number]: Function; // (args[]) => void
+    [id: MessageID]: Function; // (args[]) => void
   } = {};
   public static portCallbacks: {
-    [id: number]: (port?: MessagePort, args?: unknown[]) => void;
+    [id: MessageID]: (port?: MessagePort, args?: unknown[]) => void;
   } = {};
   public static messageListener: Function;
+  public static legacyMessageIdsToUuidMap: {
+    [legacyId: number]: MessageUUID;
+  } = {};
 }
 
 /**
@@ -147,6 +156,7 @@ export function uninitializeCommunication(): void {
   CommunicationPrivate.callbacks = {};
   CommunicationPrivate.promiseCallbacks = {};
   CommunicationPrivate.portCallbacks = {};
+  CommunicationPrivate.legacyMessageIdsToUuidMap = {};
 }
 
 /**
@@ -242,7 +252,7 @@ export function sendMessageToParentAsync<T>(
 
   return new Promise((resolve) => {
     const request = sendMessageToParentHelper(apiVersionTag, actionName, args);
-    resolve(waitForResponse<T>(request.id));
+    resolve(waitForResponse<T>(request.uuid));
   });
 }
 
@@ -263,14 +273,14 @@ export function requestPortFromParentWithVersion(
     );
   }
   const request = sendMessageToParentHelper(apiVersionTag, actionName, args);
-  return waitForPort(request.id);
+  return waitForPort(request.uuid);
 }
 
 /**
  * @internal
  * Limited to Microsoft-internal use
  */
-function waitForPort(requestId: number): Promise<MessagePort> {
+function waitForPort(requestId: MessageUUID): Promise<MessagePort> {
   return new Promise<MessagePort>((resolve, reject) => {
     CommunicationPrivate.portCallbacks[requestId] = (port: MessagePort | undefined, args?: unknown[]) => {
       if (port instanceof MessagePort) {
@@ -287,7 +297,7 @@ function waitForPort(requestId: number): Promise<MessagePort> {
  * @internal
  * Limited to Microsoft-internal use
  */
-function waitForResponse<T>(requestId: number): Promise<T> {
+function waitForResponse<T>(requestId: MessageUUID): Promise<T> {
   return new Promise<T>((resolve) => {
     CommunicationPrivate.promiseCallbacks[requestId] = resolve;
   });
@@ -343,7 +353,7 @@ export function sendMessageToParent(
   if (callback) {
     // eslint-disable-next-line @typescript-eslint/ban-ts-comment
     // @ts-ignore
-    CommunicationPrivate.callbacks[request.id] = callback;
+    CommunicationPrivate.callbacks[request.uuid] = callback;
   }
 }
 
@@ -359,7 +369,7 @@ export function sendNestedAuthRequestToTopWindow(message: string): NestedAppAuth
   const targetWindow = Communication.topWindow;
   const request = createNestedAppAuthRequest(message);
 
-  logger('Message %i information: %o', request.id, { actionName: request.func });
+  logger('Message %i information: %o', request.uuid, { actionName: request.func });
 
   return sendRequestToTargetWindowHelper(targetWindow, request) as NestedAppAuthRequest;
 }
@@ -379,7 +389,7 @@ function sendRequestToTargetWindowHelper(
 
   if (GlobalVars.isFramelessWindow) {
     if (Communication.currentWindow && Communication.currentWindow.nativeInterface) {
-      logger(`Sending message %i to ${targetWindowName} via framelessPostMessage interface`, request.id);
+      logger(`Sending message %i to ${targetWindowName} via framelessPostMessage interface`, request.uuid);
       (Communication.currentWindow as ExtendedWindow).nativeInterface.framelessPostMessage(JSON.stringify(request));
     }
   } else {
@@ -388,10 +398,10 @@ function sendRequestToTargetWindowHelper(
     // If the target window isn't closed and we already know its origin, send the message right away; otherwise,
     // queue the message and send it after the origin is established
     if (targetWindow && targetOrigin) {
-      logger(`Sending message %i to ${targetWindowName} via postMessage`, request.id);
+      logger(`Sending message %i to ${targetWindowName} via postMessage`, request.uuid);
       targetWindow.postMessage(request, targetOrigin);
     } else {
-      logger(`Adding message %i to ${targetWindowName} message queue`, request.id);
+      logger(`Adding message %i to ${targetWindowName} message queue`, request.uuid);
       getTargetMessageQueue(targetWindow).push(request);
     }
   }
@@ -415,7 +425,7 @@ function sendMessageToParentHelper(
   const request = createMessageRequest(apiVersionTag, actionName, args);
 
   /* eslint-disable-next-line strict-null-checks/all */ /* Fix tracked by 5730662 */
-  logger('Message %i information: %o', request.id, { actionName, args });
+  logger('Message %i information: %o', request.uuid, { actionName, args });
 
   return sendRequestToTargetWindowHelper(targetWindow, request);
 }
@@ -611,42 +621,49 @@ const handleParentMessageLogger = communicationLogger.extend('handleParentMessag
 function handleParentMessage(evt: DOMMessageEvent): void {
   const logger = handleParentMessageLogger;
 
-  if ('id' in evt.data && typeof evt.data.id === 'number') {
+  if ('id' in evt.data && (typeof evt.data.id === 'number' || typeof evt.data.id === 'string')) {
     // Call any associated Communication.callbacks
     const message = evt.data as MessageResponse;
-    const callback = CommunicationPrivate.callbacks[message.id];
-    logger('Received a response from parent for message %i', message.id);
+    const callbackId =
+      typeof message.id === 'string' ? message.id : CommunicationPrivate.legacyMessageIdsToUuidMap[message.id];
+    const callback = CommunicationPrivate.callbacks[callbackId];
+    logger('Received a response from parent for message %i', callbackId);
     if (callback) {
-      logger('Invoking the registered callback for message %i with arguments %o', message.id, message.args);
+      logger('Invoking the registered callback for message %i with arguments %o', callbackId, message.args);
       // eslint-disable-next-line @typescript-eslint/ban-ts-comment
       // @ts-ignore
       callback.apply(null, [...message.args, message.isPartialResponse]);
 
       // Remove the callback to ensure that the callback is called only once and to free up memory if response is a complete response
       if (!isPartialResponse(evt)) {
-        logger('Removing registered callback for message %i', message.id);
-        delete CommunicationPrivate.callbacks[message.id];
+        logger('Removing registered callback for message %i', callbackId);
+        if (typeof message.id === 'number') {
+          delete CommunicationPrivate.legacyMessageIdsToUuidMap[message.id];
+        } else {
+          CommunicationPrivate.legacyMessageIdsToUuidMap = {};
+        }
+        delete CommunicationPrivate.callbacks[callbackId];
       }
     }
-    const promiseCallback = CommunicationPrivate.promiseCallbacks[message.id];
+    const promiseCallback = CommunicationPrivate.promiseCallbacks[callbackId];
     if (promiseCallback) {
-      logger('Invoking the registered promise callback for message %i with arguments %o', message.id, message.args);
+      logger('Invoking the registered promise callback for message %i with arguments %o', callbackId, message.args);
       promiseCallback(message.args);
 
-      logger('Removing registered promise callback for message %i', message.id);
-      delete CommunicationPrivate.promiseCallbacks[message.id];
+      logger('Removing registered promise callback for message %i', callbackId);
+      delete CommunicationPrivate.promiseCallbacks[callbackId];
     }
-    const portCallback = CommunicationPrivate.portCallbacks[message.id];
+    const portCallback = CommunicationPrivate.portCallbacks[callbackId];
     if (portCallback) {
-      logger('Invoking the registered port callback for message %i with arguments %o', message.id, message.args);
+      logger('Invoking the registered port callback for message %i with arguments %o', callbackId, message.args);
       let port: MessagePort | undefined;
       if (evt.ports && evt.ports[0] instanceof MessagePort) {
         port = evt.ports[0];
       }
       portCallback(port, message.args);
 
-      logger('Removing registered port callback for message %i', message.id);
-      delete CommunicationPrivate.portCallbacks[message.id];
+      logger('Removing registered port callback for message %i', callbackId);
+      delete CommunicationPrivate.portCallbacks[callbackId];
     }
   } else if ('func' in evt.data && typeof evt.data.func === 'string') {
     // Delegate the request to the proper handler
@@ -800,7 +817,7 @@ export function waitForMessageQueue(targetWindow: Window, callback: () => void):
  * @internal
  * Limited to Microsoft-internal use
  */
-function sendMessageResponseToChild(id: number, args?: any[], isPartialResponse?: boolean): void {
+function sendMessageResponseToChild(id: MessageID, args?: any[], isPartialResponse?: boolean): void {
   const targetWindow = Communication.childWindow;
   const response = createMessageResponse(id, args, isPartialResponse);
   const targetOrigin = getTargetOrigin(targetWindow);
@@ -841,8 +858,12 @@ function createMessageRequest(
   func: string,
   args: any[] | undefined,
 ): MessageRequestWithRequiredProperties {
+  const messageId: MessageID = CommunicationPrivate.nextMessageId++;
+  const messageUuid: MessageUUID = generateGUID();
+  CommunicationPrivate.legacyMessageIdsToUuidMap[messageId] = messageUuid;
   return {
-    id: CommunicationPrivate.nextMessageId++,
+    id: messageId,
+    uuid: messageUuid,
     func: func,
     timestamp: Date.now(),
     args: args || [],
@@ -862,8 +883,12 @@ function createMessageRequest(
  * @returns {NestedAppAuthRequest} Returns a NestedAppAuthRequest object with a unique id, the function name set to 'nestedAppAuthRequest', the current timestamp, an empty args array, and the provided message as data.
  */
 function createNestedAppAuthRequest(message: string): NestedAppAuthRequest {
+  const messageId: MessageID = CommunicationPrivate.nextMessageId++;
+  const messageUuid: MessageUUID = generateGUID();
+  CommunicationPrivate.legacyMessageIdsToUuidMap[messageId] = messageUuid;
   return {
-    id: CommunicationPrivate.nextMessageId++,
+    id: messageId,
+    uuid: messageUuid,
     func: 'nestedAppAuth.execute',
     timestamp: Date.now(),
     // Since this is a nested app auth request, we don't need to send any args.
@@ -877,7 +902,7 @@ function createNestedAppAuthRequest(message: string): NestedAppAuthRequest {
  * @internal
  * Limited to Microsoft-internal use
  */
-function createMessageResponse(id: number, args: any[] | undefined, isPartialResponse?: boolean): MessageResponse {
+function createMessageResponse(id: MessageID, args: any[] | undefined, isPartialResponse?: boolean): MessageResponse {
   return {
     id: id,
     args: args || [],

packages/teams-js/src/internal/messageObjects.ts

@@ -1,9 +1,28 @@
+/**
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export type BaseUUID = string;
+
+/**
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export type MessageUUID = BaseUUID;
+
+/**
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export type MessageID = number | MessageUUID;
+
 /**
  * @internal
  * Limited to Microsoft-internal use
  */
 export interface MessageRequest {
-  id?: number;
+  id?: MessageID;
+  uuid?: MessageUUID;
   func: string;
   timestamp?: number;
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -16,7 +35,7 @@ export interface MessageRequest {
  * Limited to Microsoft-internal use
  */
 export interface MessageResponse {
-  id: number;
+  id: MessageID;
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   args?: any[];
   isPartialResponse?: boolean; // If the message is partial, then there will be more future responses for the given message ID.
@@ -34,6 +53,7 @@ export interface MessageResponse {
  * merged. However, it's a journey.
  */
 export interface MessageRequestWithRequiredProperties extends MessageRequest {
-  id: number;
+  id: MessageID;
+  uuid: MessageUUID;
   timestamp: number;
 }

packages/teams-js/test/private/teams.spec.ts

@@ -250,7 +250,6 @@ describe('Testing teams capabillity', () => {
     });
 
     describe('joinedTeams.isSupported function', () => {
-      const utils = new Utils();
       it('joinedTeams.isSupported should return false if the runtime says joinedTeams is not supported', async () => {
         await utils.initializeWithContext(FrameContexts.content);
         utils.setRuntimeConfig({ apiVersion: 1, supports: {} });
@@ -281,7 +280,6 @@ describe('Testing teams capabillity', () => {
     });
 
     describe('teams.fullTrust.isSupported function', () => {
-      const utils = new Utils();
       it('teams.fullTrust.isSupported should return false if the runtime says fullTrust is not supported', async () => {
         await utils.initializeWithContext(FrameContexts.content);
         utils.setRuntimeConfig({ apiVersion: 1, supports: {} });

packages/teams-js/test/public/people.spec.ts

@@ -155,7 +155,9 @@ describe('people', () => {
   });
 
   describe('Testing people.isSupported function', () => {
+    let utils: Utils = new Utils();
     afterEach(() => {
+      utils = new Utils();
       app._uninitialize();
     });
     it('people.isSupported should return false if the runtime says people is not supported', async () => {

packages/teams-js/test/public/sharing.spec.ts

@@ -366,7 +366,6 @@ describe('sharing_v2', () => {
   });
 
   describe('Testing sharing.isSupported function', () => {
-    const utils = new Utils();
     it('sharing.isSupported should return false if the runtime says sharing is not supported', async () => {
       await utils.initializeWithContext(FrameContexts.content);
       utils.setRuntimeConfig({ apiVersion: 1, supports: {} });
@@ -817,7 +816,13 @@ describe('sharing_v2', () => {
     });
 
     describe('Testing sharing.history.isSupported function', () => {
-      const utils = new Utils();
+      let utils: Utils = new Utils();
+      beforeEach(() => {
+        utils = new Utils();
+      });
+      afterEach(() => {
+        app._uninitialize();
+      });      
       it('sharing.history.isSupported should return false if the runtime says sharing.history is not supported', async () => {
         await utils.initializeWithContext(FrameContexts.content);
         utils.setRuntimeConfig({ apiVersion: 1, supports: { sharing: {} } });