fix: [#3890] createConnectorClient function is not getting the correc…

…t ConnectorFactory (#3891) * Fix createConnectorClient not getting the proper ConnectorFactory * Add Unit Tests to support the fix for the createConnectorClient function * Add missing await when assert.rejects is executed
microsoft · Aug 2, 2021 · 8ede831 · 8ede831
1 parent 3e2beae
commit 8ede831
Show file tree

Hide file tree

Showing 2 changed files with 130 additions and 2 deletions.
diff --git a/libraries/botbuilder-dialogs/src/prompts/userTokenAccess.ts b/libraries/botbuilder-dialogs/src/prompts/userTokenAccess.ts
@@ -157,7 +157,7 @@ export async function createConnectorClient(
     audience: string
 ): Promise<ConnectorClient> {
     const connectorFactory = context.turnState.get<ConnectorFactory>(
-        (context.adapter as CloudAdapterBase).UserTokenClientKey
+        (context.adapter as CloudAdapterBase).ConnectorFactoryKey
     );
     if (connectorFactory) {
         return connectorFactory.create(serviceUrl, audience);

diff --git a/libraries/botbuilder-dialogs/tests/oauthPrompt.test.js b/libraries/botbuilder-dialogs/tests/oauthPrompt.test.js
@@ -5,13 +5,20 @@ const assert = require('assert');
 const { spy } = require('sinon');
 const { ok, strictEqual } = require('assert');
 const { OAuthPrompt, DialogSet, DialogTurnStatus } = require('../');
-const { AuthenticationConstants } = require('botframework-connector');
+const {
+    AuthenticationConstants,
+    BotFrameworkAuthenticationFactory,
+    PasswordServiceClientCredentialFactory,
+    SkillValidation,
+    ConnectorClient,
+} = require('botframework-connector');
 
 const {
     ActionTypes,
     ActivityTypes,
     CardFactory,
     Channels,
+    CloudAdapterBase,
     ConversationState,
     InputHints,
     MemoryStorage,
@@ -642,6 +649,8 @@ describe('OAuthPrompt', function () {
         });
 
         describe('recognizeToken()', function () {
+            class TestCloudAdapter extends CloudAdapterBase {}
+
             it('should throw an error during a Token Response Event and adapter is missing "createConnectorClientWithIdentity"', async function () {
                 const oAuthPrompt = new OAuthPrompt('OAuthPrompt');
                 // Create spy for private instance method called during recognizeToken
@@ -684,6 +693,125 @@ describe('OAuthPrompt', function () {
 
                 ok(isTokenResponseEventSpy.calledOnce, 'isTokenResponseEventSpy called more than once');
             });
+
+            it('should return the correct ConnectorClient instance', async function () {
+                const credsFactory = new PasswordServiceClientCredentialFactory('', '');
+                const botFrameworkAuthentication = BotFrameworkAuthenticationFactory.create(
+                    '',
+                    undefined,
+                    undefined,
+                    undefined,
+                    undefined,
+                    undefined,
+                    undefined,
+                    undefined,
+                    undefined,
+                    credsFactory,
+                    { requiredEndorsements: [] }
+                );
+                const adapter = new TestCloudAdapter(botFrameworkAuthentication);
+                const oAuthPrompt = new OAuthPrompt('OAuthPrompt');
+
+                const context = new TurnContext(adapter, {
+                    type: ActivityTypes.Event,
+                    name: tokenResponseEventName,
+                    conversation: { id: 'conversationId' },
+                    channelId: Channels.Test,
+                });
+
+                // Assign ConnectorFactory to the context state.
+                const claimsIdentity = SkillValidation.createAnonymousSkillClaim();
+                const connectorFactory = botFrameworkAuthentication.createConnectorFactory(claimsIdentity);
+                context.turnState.set(adapter.ConnectorFactoryKey, connectorFactory);
+
+                // Create DialogContext
+                const conversationState = new ConversationState(new MemoryStorage());
+                const dialogState = conversationState.createProperty('DialogState');
+                const dialogSet = new DialogSet(dialogState);
+                const dc = await dialogSet.createContext(context);
+
+                function setActiveDialog(dc, dialog) {
+                    // Create stack if not already there.
+                    dc.stack = dc.stack || [];
+                    dc.stack.unshift({
+                        id: dialog.id,
+                        state: {
+                            state: {},
+                            [dialog.PersistedCaller]: {
+                                callerServiceUrl: 'https://test1',
+                                scope: 'parent-appId',
+                            },
+                            options: { prompt: 'Login time' },
+                            expires: new Date().getTime() + 900000,
+                        },
+                    });
+                }
+
+                setActiveDialog(dc, oAuthPrompt);
+                await oAuthPrompt.recognizeToken(dc);
+                const connectorClient = dc.context.turnState.get(adapter.ConnectorClientKey);
+
+                assert.ok(connectorClient instanceof ConnectorClient, 'ConnectorClient was not created properly');
+            });
+
+            it('should throw when UserTokenClient is found instead of ConnectorFactory in the context.turnState', async function () {
+                const credsFactory = new PasswordServiceClientCredentialFactory('', '');
+                const botFrameworkAuthentication = BotFrameworkAuthenticationFactory.create(
+                    '',
+                    undefined,
+                    undefined,
+                    undefined,
+                    undefined,
+                    undefined,
+                    undefined,
+                    undefined,
+                    undefined,
+                    credsFactory,
+                    { requiredEndorsements: [] }
+                );
+                const adapter = new TestCloudAdapter(botFrameworkAuthentication);
+                const oAuthPrompt = new OAuthPrompt('OAuthPrompt');
+
+                const context = new TurnContext(adapter, {
+                    type: ActivityTypes.Event,
+                    name: tokenResponseEventName,
+                    conversation: { id: 'conversationId' },
+                    channelId: Channels.Test,
+                });
+
+                // Assign UserTokenClient to the context state.
+                const claimsIdentity = SkillValidation.createAnonymousSkillClaim();
+                const userTokenClient = await botFrameworkAuthentication.createUserTokenClient(claimsIdentity);
+                context.turnState.set(adapter.UserTokenClientKey, userTokenClient);
+
+                // Create DialogContext
+                const conversationState = new ConversationState(new MemoryStorage());
+                const dialogState = conversationState.createProperty('DialogState');
+                const dialogSet = new DialogSet(dialogState);
+                const dc = await dialogSet.createContext(context);
+
+                function setActiveDialog(dc, dialog) {
+                    // Create stack if not already there.
+                    dc.stack = dc.stack || [];
+                    dc.stack.unshift({
+                        id: dialog.id,
+                        state: {
+                            state: {},
+                            [dialog.PersistedCaller]: {
+                                callerServiceUrl: 'https://test1',
+                                scope: 'parent-appId',
+                            },
+                            options: { prompt: 'Login time' },
+                            expires: new Date().getTime() + 900000,
+                        },
+                    });
+                }
+
+                setActiveDialog(dc, oAuthPrompt);
+                await assert.rejects(oAuthPrompt.recognizeToken(dc), {
+                    message: 'OAuth prompt is not supported by the current adapter',
+                });
+            });
         });
     });