port: enable LG syntax in OAuthInput (#3409)

chon219 · joshgummersall · web-flow · commit e09dc68224a0 · 2021-03-22T14:30:13.000-07:00
* fixed a bug in expression parse to trim beginning '=' * fixed a bug in templates to recognize multiline correctly * updated OAuthPrompt to make sendOAuthCard() public static * Updated OAuthInput to enable LG syntax * added tests * make channelSupportOAuthCard() private * added inline comments * minor fix * Revert "minor fix" This reverts commit 09e30f0. Co-authored-by: Josh Gummersall <1235378+joshgummersall@users.noreply.github.com>
diff --git a/libraries/adaptive-expressions/src/expression.ts b/libraries/adaptive-expressions/src/expression.ts
@@ -227,7 +227,7 @@ export class Expression {
      * @returns The expression object.
      */
     public static parse(expression: string, lookup?: EvaluatorLookup): Expression {
-        return new ExpressionParser(lookup || Expression.lookup).parse(expression);
+        return new ExpressionParser(lookup || Expression.lookup).parse(expression.replace(/^=/, ''));
     }
 
     /**
diff --git a/libraries/botbuilder-dialogs-adaptive-testing/tests/resources/TestScriptTests/TestScriptTests_OAuthInputLG.test.dialog b/libraries/botbuilder-dialogs-adaptive-testing/tests/resources/TestScriptTests/TestScriptTests_OAuthInputLG.test.dialog
@@ -0,0 +1,36 @@
+{
+    "$schema": "../../../tests.schema",
+    "$kind": "Microsoft.Test.Script",
+    "description": "Test UserTokenMock set Property",
+    "generator": "main.lg",
+    "dialog": {
+        "$kind": "Microsoft.AdaptiveDialog",
+        "triggers": [
+            {
+                "$kind": "Microsoft.OnBeginDialog",
+                "actions": [
+                    {
+                        "$kind": "Microsoft.OAuthInput",
+                        "connectionName": "magiccode x",
+                        "text": "${OAuthInputText()}",
+                        "title": "${OAuthInputTitle()}",
+                        "property": "dialog.token"
+                    }
+                ]
+            }
+        ]
+    },
+    "script": [
+        {
+            "$kind": "Microsoft.Test.UserSays",
+            "text": "hello"
+        },
+        {
+            "$kind": "Microsoft.Test.AssertReplyActivity",
+            "assertions": [
+              "attachments[0].content.text == 'OAuth text set!'",
+              "attachments[0].content.buttons[0].title == 'OAuth title set!'"
+            ]
+        }
+    ]
+}
diff --git a/libraries/botbuilder-dialogs-adaptive-testing/tests/resources/TestScriptTests/TestScriptTests_OAuthInputMockProperties.test.dialog b/libraries/botbuilder-dialogs-adaptive-testing/tests/resources/TestScriptTests/TestScriptTests_OAuthInputMockProperties.test.dialog
@@ -0,0 +1,45 @@
+{
+    "$schema": "../../../tests.schema",
+    "$kind": "Microsoft.Test.Script",
+    "description": "Test UserTokenMock set Property",
+    "dialog": {
+        "$kind": "Microsoft.AdaptiveDialog",
+        "triggers": [
+            {
+                "$kind": "Microsoft.OnBeginDialog",
+                "actions": [
+                    {
+                      "$kind": "Microsoft.SetProperty",
+                      "property": "dialog.textProperty",
+                      "value": "Set the text!"
+                    },
+                    {
+                      "$kind": "Microsoft.SetProperty",
+                      "property": "dialog.titleProperty",
+                      "value": "Set the title!"
+                    },
+                    {
+                        "$kind": "Microsoft.OAuthInput",
+                        "connectionName": "magiccode x",
+                        "text": "=dialog.textProperty",
+                        "title": "=dialog.titleProperty",
+                        "property": "dialog.token"
+                    }
+                ]
+            }
+        ]
+    },
+    "script": [
+        {
+            "$kind": "Microsoft.Test.UserSays",
+            "text": "hello"
+        },
+        {
+            "$kind": "Microsoft.Test.AssertReplyActivity",
+            "assertions": [
+              "attachments[0].content.text == 'Set the text!'",
+              "attachments[0].content.buttons[0].title == 'Set the title!'"
+            ]
+        }
+    ]
+}
diff --git a/libraries/botbuilder-dialogs-adaptive-testing/tests/resources/TestScriptTests/main.lg b/libraries/botbuilder-dialogs-adaptive-testing/tests/resources/TestScriptTests/main.lg
@@ -0,0 +1,5 @@
+# OAuthInputText()
+- OAuth text set!
+
+# OAuthInputTitle()
+- OAuth title set!
diff --git a/libraries/botbuilder-dialogs-adaptive-testing/tests/testScript.test.js b/libraries/botbuilder-dialogs-adaptive-testing/tests/testScript.test.js
@@ -104,6 +104,14 @@ describe('TestScriptTests', function () {
         await TestUtils.runTestScript(resourceExplorer, 'TestScriptTests_HttpRequestQnAMakerDialogMock');
     });
 
+    it('OAuthInputLG', async () => {
+        await TestUtils.runTestScript(resourceExplorer, 'TestScriptTests_OAuthInputLG');
+    });
+
+    it('OAuthInputMockProperties', async () => {
+        await TestUtils.runTestScript(resourceExplorer, 'TestScriptTests_OAuthInputMockProperties');
+    });
+
     it('OAuthInputRetries_WithNullMessageText', async () => {
         await TestUtils.runTestScript(resourceExplorer, 'TestScriptTests_OAuthInputRetries_WithNullMessageText');
     });
diff --git a/libraries/botbuilder-dialogs-adaptive/src/input/oauthInput.ts b/libraries/botbuilder-dialogs-adaptive/src/input/oauthInput.ts
@@ -13,19 +13,11 @@ import {
     StringExpressionConverter,
 } from 'adaptive-expressions';
 import {
-    ActionTypes,
     Activity,
     ActivityTypes,
-    Attachment,
-    BotAdapter,
-    CardFactory,
-    Channels,
     ExtendedUserTokenProvider,
     InputHints,
     IUserTokenProvider,
-    MessageFactory,
-    OAuthCard,
-    OAuthLoginTimeoutKey,
     StatusCodes,
     TokenExchangeInvokeRequest,
     TokenResponse,
@@ -36,15 +28,18 @@ import {
     ConverterFactory,
     Dialog,
     DialogContext,
+    DialogStateManager,
     DialogTurnResult,
+    OAuthPrompt,
+    OAuthPromptSettings,
     PromptOptions,
     PromptRecognizerResult,
     ThisPath,
     TurnPath,
 } from 'botbuilder-dialogs';
-import { SkillValidation } from 'botframework-connector';
-import { verifyStateOperationName, tokenExchangeOperationName, tokenResponseEventName } from 'botbuilder-core';
+import { verifyStateOperationName, tokenExchangeOperationName, tokenResponseEventName } from 'botbuilder';
 import { InputDialog, InputDialogConfiguration, InputState } from './inputDialog';
+import { TextTemplate } from '../templates';
 
 export const channels: any = {
     console: 'console',
@@ -186,7 +181,7 @@ export class OAuthInput extends InputDialog implements OAuthInputConfiguration {
             dc.state.setValue(InputDialog.TURN_COUNT_PROPERTY, 1);
 
             // Prompt user to login
-            await this.sendOAuthCardAsync(dc, state.options.prompt);
+            await this.sendOAuthCard(dc, state.options.prompt);
 
             return Dialog.EndOfTurn;
         }
@@ -257,7 +252,7 @@ export class OAuthInput extends InputDialog implements OAuthInputConfiguration {
                 }
 
                 if (isMessage) {
-                    await this.sendOAuthCardAsync(dc, promptOptions?.prompt);
+                    await this.sendOAuthCard(dc, promptOptions?.prompt);
                 }
 
                 return Dialog.EndOfTurn;
@@ -351,98 +346,25 @@ export class OAuthInput extends InputDialog implements OAuthInputConfiguration {
     /**
      * @private
      */
-    private async sendOAuthCardAsync(dc: DialogContext, prompt?: string | Partial<Activity>): Promise<void> {
-        const turnContext = dc.context;
-
-        // Validate adapter type
-        if (!('getUserToken' in turnContext.adapter)) {
-            throw new Error(`OAuthPrompt.sendOAuthCardAsync(): not supported for the current adapter.`);
-        }
-
-        // Initialize outgoing message
-        const msg: Partial<Activity> =
-            typeof prompt === 'object'
-                ? { ...prompt }
-                : MessageFactory.text(prompt, undefined, InputHints.AcceptingInput);
-        if (!Array.isArray(msg.attachments)) {
-            msg.attachments = [];
-        }
-
-        // Add login card as needed
-        if (this.channelSupportsOAuthCard(turnContext.activity.channelId)) {
-            const cards: Attachment[] = msg.attachments.filter(
-                (a: Attachment) => a.contentType === CardFactory.contentTypes.oauthCard
-            );
-            if (cards.length === 0) {
-                let cardActionType = ActionTypes.Signin;
-                const signInResource = await (turnContext.adapter as ExtendedUserTokenProvider).getSignInResource(
-                    turnContext,
-                    this.connectionName.getValue(dc.state),
-                    turnContext.activity.from.id
-                );
-                let link = signInResource.signInLink;
-                const identity = turnContext.turnState.get((turnContext.adapter as BotAdapter).BotIdentityKey);
-
-                // use the SignInLink when
-                //   in speech channel or
-                //   bot is a skill or
-                //   an extra OAuthAppCredentials is being passed in
-                if (
-                    (identity && SkillValidation.isSkillClaim(identity.claims)) ||
-                    this.isFromStreamingConnection(turnContext.activity)
-                ) {
-                    if (turnContext.activity.channelId === Channels.Emulator) {
-                        cardActionType = ActionTypes.OpenUrl;
-                    }
-                } else if (!this.channelRequiresSignInLink(turnContext.activity.channelId)) {
-                    link = undefined;
-                }
-
-                // Append oauth card
-                const card = CardFactory.oauthCard(
-                    this.connectionName.getValue(dc.state),
-                    this.title.getValue(dc.state),
-                    this.text.getValue(dc.state),
-                    link,
-                    signInResource.tokenExchangeResource
-                );
-
-                // Set the appropriate ActionType for the button.
-                (card.content as OAuthCard).buttons[0].type = cardActionType;
-                msg.attachments.push(card);
-            }
-        } else {
-            const cards: Attachment[] = msg.attachments.filter(
-                (a: Attachment) => a.contentType === CardFactory.contentTypes.signinCard
-            );
-            if (cards.length === 0) {
-                // Append signin card
-                const signInResource = await (turnContext.adapter as ExtendedUserTokenProvider).getSignInResource(
-                    turnContext,
-                    this.connectionName.getValue(dc.state),
-                    turnContext.activity.from.id
-                );
-                msg.attachments.push(
-                    CardFactory.signinCard(
-                        this.title.getValue(dc.state),
-                        signInResource.signInLink,
-                        this.text.getValue(dc.state)
-                    )
-                );
-            }
-        }
-
-        // Add the login timeout specified in OAuthPromptSettings to TurnState so it can be referenced if polling is needed
-        if (!turnContext.turnState.get(OAuthLoginTimeoutKey) && this.timeout) {
-            turnContext.turnState.set(OAuthLoginTimeoutKey, this.timeout.getValue(dc.state));
+    private async sendOAuthCard(dc: DialogContext, prompt?: string | Partial<Activity>): Promise<void> {
+        let title: string =
+            (await new TextTemplate<DialogStateManager>(this.title.expressionText).bind(dc, dc.state)) ??
+            this.title.getValue(dc.state);
+        if (title?.startsWith('=')) {
+            title = Expression.parse(title).tryEvaluate(dc.state)?.value;
         }
-
-        if (!msg.inputHint) {
-            msg.inputHint = InputHints.AcceptingInput;
+        let text: string =
+            (await new TextTemplate<DialogStateManager>(this.text.expressionText).bind(dc, dc.state)) ??
+            this.text.getValue(dc.state);
+        if (text?.startsWith('=')) {
+            text = Expression.parse(text).tryEvaluate(dc.state)?.value;
         }
-
-        // Send prompt
-        await turnContext.sendActivity(msg);
+        const settings: OAuthPromptSettings = {
+            connectionName: this.connectionName?.getValue(dc.state),
+            title,
+            text,
+        };
+        return OAuthPrompt.sendOAuthCard(settings, dc.context, prompt);
     }
 
     /**
@@ -540,13 +462,6 @@ export class OAuthInput extends InputDialog implements OAuthInputConfiguration {
         return token !== undefined ? { succeeded: true, value: token } : { succeeded: false };
     }
 
-    /**
-     * @private
-     */
-    private isFromStreamingConnection(activity: Activity): boolean {
-        return activity && activity.serviceUrl && !activity.serviceUrl.toLowerCase().startsWith('http');
-    }
-
     /**
      * @private
      */
@@ -584,22 +499,6 @@ export class OAuthInput extends InputDialog implements OAuthInputConfiguration {
         return false;
     }
 
-    /**
-     * @private
-     */
-    private channelSupportsOAuthCard(channelId: string): boolean {
-        switch (channelId) {
-            case channels.msteams:
-            case channels.cortana:
-            case channels.skype:
-            case channels.skypeforbusiness:
-                return false;
-            default:
-        }
-
-        return true;
-    }
-
     /**
      * @private
      */
@@ -612,19 +511,6 @@ export class OAuthInput extends InputDialog implements OAuthInputConfiguration {
             },
         });
     }
-
-    /**
-     * @private
-     */
-    private channelRequiresSignInLink(channelId: string): boolean {
-        switch (channelId) {
-            case Channels.Msteams:
-                return true;
-            default:
-        }
-
-        return false;
-    }
 }
 
 /**
diff --git a/libraries/botbuilder-dialogs/src/prompts/oauthPrompt.ts b/libraries/botbuilder-dialogs/src/prompts/oauthPrompt.ts
diff --git a/libraries/botbuilder-dialogs/tests/oauthPrompt.test.js b/libraries/botbuilder-dialogs/tests/oauthPrompt.test.js
diff --git a/libraries/botbuilder-lg/src/templates.ts b/libraries/botbuilder-lg/src/templates.ts

Original file line number	Diff line number	Diff line change
`@@ -227,7 +227,7 @@ export class Expression {`
`227`	`227`	`* @returns The expression object.`
`228`	`228`	`*/`
`229`	`229`	`public static parse(expression: string, lookup?: EvaluatorLookup): Expression {`
`230`		`- return new ExpressionParser(lookup \|\| Expression.lookup).parse(expression);`
	`230`	`+ return new ExpressionParser(lookup \|\| Expression.lookup).parse(expression.replace(/^=/, ''));`
`231`	`231`	`}`
`232`	`232`
`233`	`233`	`/**`