fix: fix bot-sso race condition issue

bot-sso/commands/index.ts

@@ -1,4 +1,4 @@
-import { BotCommand } from "../helpers/botCommand";
+import { BotCommand, MatchTerm, SSOCommand } from "../helpers/botCommand";
 import { LearnCommand } from "./learn";
 import { ShowUserProfile } from "./showUserProfile";
 import { WelcomeCommand } from "./welcome";
@@ -8,3 +8,12 @@ export const commands: BotCommand[] = [
   new ShowUserProfile(),
   new WelcomeCommand(),
 ];
+
+export const SSOCommands: SSOCommand[] = [
+  new ShowUserProfile(),
+];
+
+export const SSOCommandMap: Map<MatchTerm[], any> = new Map();
+SSOCommands.forEach((command) => {
+  SSOCommandMap.set(command.matchPatterns, command.operationWithSSOToken);
+});

bot-sso/helpers/botCommand.ts

@@ -50,7 +50,6 @@ export class SSOCommand extends BotCommand {
   async run(parameters: any): Promise<any> {
     this.validateParameters(parameters);
     const ssoDialog = parameters.ssoDialog;
-    ssoDialog.setSSOOperation(this.operationWithSSOToken);
     await ssoDialog.run(parameters.context, parameters.dialogState);
   }
 }

bot-sso/helpers/ssoDialog.ts

@@ -6,6 +6,7 @@ import {
   ComponentDialog,
 } from "botbuilder-dialogs";
 import {
+  Activity,
   ActivityTypes,
   Storage,
   tokenExchangeOperationName,
@@ -15,6 +16,8 @@ import { TeamsBotSsoPrompt } from "@microsoft/teamsfx";
 import "isomorphic-fetch";
 import oboAuthConfig from "../authConfig";
 import config from "../config";
+import { SSOCommandMap } from "../commands";
+import { MatchTerm } from "./botCommand";
 
 const DIALOG_NAME = "SSODialog";
 const MAIN_WATERFALL_DIALOG = "MainWaterfallDialog";
@@ -24,17 +27,13 @@ export class SSODialog extends ComponentDialog {
   private requiredScopes: string[] = ["User.Read"]; // hard code the scopes for demo purpose only
   private dedupStorage: Storage;
   private dedupStorageKeys: string[];
-  private operationWithSSO: (
-    arg0: any,
-    ssoToken: string
-  ) => Promise<any> | undefined;
 
   // Developer controlls the lifecycle of credential provider, as well as the cache in it.
   // In this sample the provider is shared in all conversations
   constructor(dedupStorage: Storage) {
     super(DIALOG_NAME);
 
-    const initialLoginEndpoint =`https://${config.botDomain}/auth-start.html` ;
+    const initialLoginEndpoint = `https://${config.botDomain}/auth-start.html`;
 
     const dialog = new TeamsBotSsoPrompt(
       oboAuthConfig,
@@ -60,16 +59,6 @@ export class SSODialog extends ComponentDialog {
     this.dedupStorageKeys = [];
   }
 
-  setSSOOperation(
-    handler: (arg0: any, arg1: string) => Promise<any> | undefined
-  ) {
-    this.operationWithSSO = handler;
-  }
-
-  resetSSOOperation() {
-    this.operationWithSSO = undefined;
-  }
-
   /**
    * The run method handles the incoming activity (in the form of a DialogContext) and passes it through the dialog system.
    * If no dialog is active, it will start the default dialog.
@@ -87,6 +76,9 @@ export class SSODialog extends ComponentDialog {
   }
 
   async ssoStep(stepContext: any) {
+    const turnContext = stepContext.context as TurnContext;
+    const text = this.getActivityText(turnContext.activity);
+    stepContext.options.commandMessage = text;
     return await stepContext.beginDialog(TEAMS_SSO_PROMPT_ID);
   }
 
@@ -101,14 +93,21 @@ export class SSODialog extends ComponentDialog {
 
   async executeOperationWithSSO(stepContext: any) {
     const tokenResponse = stepContext.result;
+    const commandMessage = stepContext.options.commandMessage;
     if (!tokenResponse || !tokenResponse.ssoToken) {
       await stepContext.context.sendActivity(
         "There is an issue while trying to sign you in and retrieve your profile photo, please type \"show\" command to login and consent permissions again."
       );
     } else {
       // Once got ssoToken, run operation that depends on ssoToken
-      if (this.operationWithSSO) {
-        await this.operationWithSSO(stepContext.context, tokenResponse.ssoToken);
+      if (commandMessage) {
+        for (const key of SSOCommandMap.keys()) {
+          if (this.expressionMatchesText(key, commandMessage)) {
+            const operationWithSSO = SSOCommandMap.get(key);
+            await operationWithSSO(stepContext.context, tokenResponse.ssoToken);
+            return await stepContext.endDialog();
+          }
+        }
       }
     }
     return await stepContext.endDialog();
@@ -123,7 +122,6 @@ export class SSODialog extends ComponentDialog {
     this.dedupStorageKeys = this.dedupStorageKeys.filter(
       (key) => key.indexOf(conversationId) < 0
     );
-    this.resetSSOOperation();
   }
 
   // If a user is signed into multiple Teams clients, the Bot might receive a "signin/tokenExchange" from each client.
@@ -173,4 +171,33 @@ export class SSODialog extends ComponentDialog {
     }
     return `${channelId}/${conversationId}/${value.id}`;
   }
+
+  private getActivityText(activity: Activity): string {
+    let text = activity.text;
+    const removedMentionText = TurnContext.removeRecipientMention(activity);
+    if (removedMentionText) {
+      text = removedMentionText
+        .toLowerCase()
+        .replace(/\n|\r\n/g, "")
+        .trim();
+    }
+    return text;
+  }
+
+  private expressionMatchesText(matchPatterns: MatchTerm[], userInput: string): RegExpExecArray | boolean {
+    let matchResult: RegExpExecArray | boolean;
+    for (const pattern of matchPatterns) {
+      if (typeof pattern == "string") {
+        matchResult = new RegExp(pattern).exec(userInput);
+      } else if (pattern instanceof RegExp) {
+        matchResult = pattern.exec(userInput);
+      } else {
+        matchResult = pattern(userInput);
+      }
+      if (matchResult) {
+        return matchResult;
+      }
+    }
+    return false;
+  }
 }

bot-sso/package.json

@@ -41,4 +41,4 @@
     "nodemon": "^2.0.7",
     "shx": "^0.3.3"
   }
-}
+}