Unblock apps to call dialog.url.submit in mobile

change/@microsoft-teams-js-06b44e75-5613-4594-a024-dfb68a5d7a05.json

@@ -0,0 +1,7 @@
+{
+  "type": "patch",
+  "comment": "Unblocked apps on Mobile to call `dialog.url.submit` from dialog by allowing this API from `FrameContext.content`.\nThere is a bug in Teams mobile that returns `frameContext.content in dialog instead of `frameContext.task`. Once the bug is fixed, this change will be reverted.",
+  "packageName": "@microsoft/teams-js",
+  "email": "[email protected]",
+  "dependentChangeType": "patch"
+}

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

@@ -18,6 +18,12 @@ import { ApiName, ApiVersionNumber, getApiVersionTag } from './telemetry';
  */
 export const dialogTelemetryVersionNumber: ApiVersionNumber = ApiVersionNumber.V_2;
 
+const dialogSubmitWarning =
+  'dialog.submit should not be called from FrameContext.content.' +
+  '\nIf dialog.submit was called from inside the dialog, please disregard this message.' +
+  '\nThis issue occurs due to a bug in Teams mobile where the dialog is incorrectly identified as being in the content FrameContext.' +
+  '\nWe are working to resolve this.';
+
 export function updateResizeHelper(apiVersionTag: string, dimensions: DialogSize): void {
   ensureInitialized(
     runtime,
@@ -83,11 +89,19 @@ export function botUrlOpenHelper(
 }
 
 export function urlSubmitHelper(apiVersionTag: string, result?: string | object, appIds?: string | string[]): void {
-  ensureInitialized(runtime, FrameContexts.task);
+  // FrameContext content should not be here because dialog.submit can be called only from inside of a dialog (FrameContext task)
+  // but it's here because Teams mobile incorrectly returns FrameContext.content when calling app.getFrameContext().
+  // FrameContexts.content will be removed once the bug is fixed.
+  ensureInitialized(runtime, FrameContexts.content, FrameContexts.task);
   if (!dialog.url.isSupported()) {
     throw errorNotSupportedOnPlatform;
   }
 
+  // If dialog.submit is called from frameContext.content, warn the user, so they don't take dependency on this behavior
+  if (GlobalVars.frameContext === FrameContexts.content) {
+    console.warn(dialogSubmitWarning);
+  }
+
   // Send tasks.completeTask instead of tasks.submitTask message for backward compatibility with Mobile clients
   sendMessageToParent(apiVersionTag, 'tasks.completeTask', [
     result,

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

@@ -272,7 +272,7 @@ describe('Dialog', () => {
       it('should not allow calls before initialization', () => {
         expect(() => dialog.url.submit()).toThrowError(errorLibraryNotInitialized);
       });
-      const allowedContexts = [FrameContexts.task];
+      const allowedContexts = [FrameContexts.content, FrameContexts.task];
       Object.values(FrameContexts).forEach((context) => {
         if (allowedContexts.some((allowedContexts) => allowedContexts === context)) {
           it(`FRAMELESS: should throw error when dialog is not supported in ${context} context`, async () => {
@@ -1314,7 +1314,7 @@ describe('Dialog', () => {
       it('should not allow calls before initialization', () => {
         expect(() => dialog.url.submit()).toThrowError(errorLibraryNotInitialized);
       });
-      const allowedContexts = [FrameContexts.task];
+      const allowedContexts = [FrameContexts.content, FrameContexts.task];
       Object.values(FrameContexts).forEach((context) => {
         if (allowedContexts.some((allowedContexts) => allowedContexts === context)) {
           it(`FRAMED: should throw error when dialog is not supported in ${context} context`, async () => {

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

@@ -268,7 +268,7 @@ describe('tasks', () => {
   });
 
   describe('submitTask', () => {
-    const allowedContexts = [FrameContexts.task];
+    const allowedContexts = [FrameContexts.content, FrameContexts.task];
     it('should not allow calls before initialization', () => {
       expect(() => tasks.submitTask()).toThrowError(new Error(errorLibraryNotInitialized));
     });