added getSignInLink overload (#1803)

* migrate .net change in for adding oauth app credentials as a parameter

* rename variable

* change turn state key name

* fix use ternary operator

* use CredentialTokenProvider interface that extends UserTokenProvider interface

* remove unused comments

* correct the credentialTokenProvider interface path

* fix import

* fix the dependency chain

* fix parameter name

* fix comments

* fix tests

* fix token resolve test

* fix test

* added getSignInLink overload

* - Merge branch 'master' into oauthOverloads
- dropped unnecessary overloads
- added param docstrings

* remove accidental merge file

Co-authored-by: Ted <tedlee@microsoft.com>

Author: mdrichardson

libraries/botbuilder/src/botFrameworkAdapter.ts

@@ -581,10 +581,14 @@ export class BotFrameworkAdapter extends BotAdapter implements CredentialTokenPr
      * @param context The context object for the turn.
      * @param connectionName The name of the auth connection to use.
      * @param oAuthAppCredentials AppCredentials for OAuth.
+     * @param userId The user id that will be associated with the token.
+     * @param finalRedirect The final URL that the OAuth flow will redirect to.
      */
-    public async getSignInLink(context: TurnContext, connectionName: string): Promise<string>;
-    public async getSignInLink(context: TurnContext, connectionName: string, oAuthAppCredentials?: AppCredentials): Promise<string>;
-    public async getSignInLink(context: TurnContext, connectionName: string, oAuthAppCredentials?: AppCredentials): Promise<string> {
+    public async getSignInLink(context: TurnContext, connectionName: string, oAuthAppCredentials?: AppCredentials, userId?: string, finalRedirect?: string): Promise<string> {
+        if (userId && userId != context.activity.from.id) {
+            throw new ReferenceError(`cannot retrieve OAuth signin link for a user that's different from the conversation`);
+        }
+
         this.checkEmulatingOAuthCards(context);
         const conversation: Partial<ConversationReference> = TurnContext.getConversationReference(context.activity);
         const url: string = this.oauthApiUrl(context);
@@ -597,7 +601,7 @@ export class BotFrameworkAdapter extends BotAdapter implements CredentialTokenPr
         };
 
         const finalState: string = Buffer.from(JSON.stringify(state)).toString('base64');
-        return (await client.botSignIn.getSignInUrl(finalState, { channelId: context.activity.channelId }))._response.bodyAsText;
+        return (await client.botSignIn.getSignInUrl(finalState, { channelId: context.activity.channelId, finalRedirect }))._response.bodyAsText;
     }
 
     /** 

libraries/botbuilder/tests/botFrameworkAdapter.test.js

@@ -1024,6 +1024,98 @@ describe(`BotFrameworkAdapter`, function () {
         assert(false, `should have thrown an error message`);
     });
 
+    describe('getSignInLink()', () => {
+        it(`should throw if userName != from.id`, async () => {
+            const adapter = new BotFrameworkAdapter();
+            const context = new TurnContext(adapter, incomingMessage);
+            try {
+                const response = await adapter.getSignInLink(context, 'aConnectionName', new MicrosoftAppCredentials('abc', 'abc'), 'invalidId');
+            } catch (err) {
+                assert(err.message === `cannot retrieve OAuth signin link for a user that's different from the conversation`);
+                return;
+            }
+            assert(false, `should have thrown an error message`);
+        });
+        it(`should return return a sign-in URL with context and connectionName`, async () => {
+            const argsPassedToMockClient = [];
+            class MockTokenApiClient {
+                constructor() {
+                    this.botSignIn = {
+                        getSignInUrl: async (...args) => {
+                            argsPassedToMockClient.push({getSignInUrl: args});
+                            return {
+                                _response: {status: 200, bodyAsText: 'http://mockedurl.com' }
+                            }
+                        }
+                    };
+                    this.credentials = new MicrosoftAppCredentials('abc', 'abc');
+                }
+    
+            }
+            const {TokenApiClient} = connector;
+            connector.TokenApiClient = MockTokenApiClient;
+
+            const adapter = new BotFrameworkAdapter();
+            const context = new TurnContext(adapter, incomingMessage);
+            const response = await adapter.getSignInLink(context, 'aConnectionName');
+            assert(response, 'http://mockedurl.com');
+
+            connector.TokenApiClient = TokenApiClient; // restore
+        });
+        it(`should return return a sign-in URL with context connectionName, oauthAppCredentials`, async () => {
+            const argsPassedToMockClient = [];
+            class MockTokenApiClient {
+                constructor() {
+                    this.botSignIn = {
+                        getSignInUrl: async (...args) => {
+                            argsPassedToMockClient.push({getSignInUrl: args});
+                            return {
+                                _response: {status: 200, bodyAsText: 'http://mockedurl.com' }
+                            }
+                        }
+                    };
+                    this.credentials = new MicrosoftAppCredentials('abc', 'abc');
+                }
+    
+            }
+            const {TokenApiClient} = connector;
+            connector.TokenApiClient = MockTokenApiClient;
+
+            const adapter = new BotFrameworkAdapter();
+            const context = new TurnContext(adapter, incomingMessage);
+            const response = await adapter.getSignInLink(context, 'aConnectionName', new MicrosoftAppCredentials('abc', 'abc'));
+            assert(response, 'http://mockedurl.com');
+
+            connector.TokenApiClient = TokenApiClient; // restore
+        });
+        it(`should return return a sign-in URL with context connectionName, oauthAppCredentials, userId, finalRedirect`, async () => {
+            const argsPassedToMockClient = [];
+            class MockTokenApiClient {
+                constructor() {
+                    this.botSignIn = {
+                        getSignInUrl: async (...args) => {
+                            argsPassedToMockClient.push({getSignInUrl: args});
+                            return {
+                                _response: {status: 200, bodyAsText: 'http://mockedurl.com' }
+                            }
+                        }
+                    };
+                    this.credentials = new MicrosoftAppCredentials('abc', 'abc');
+                }
+    
+            }
+            const {TokenApiClient} = connector;
+            connector.TokenApiClient = MockTokenApiClient;
+
+            const adapter = new BotFrameworkAdapter();
+            const context = new TurnContext(adapter, incomingMessage);
+            const response = await adapter.getSignInLink(context, 'aConnectionName', new MicrosoftAppCredentials('abc', 'abc'), incomingMessage.from.id, 'http://finalredirect.com');
+            assert(response, 'http://mockedurl.com');
+
+            connector.TokenApiClient = TokenApiClient; // restore
+        });
+    });
+
     describe('getTokenStatus()', () => {
         xit(`should return the status of every connection the user has`, async () => {
             const adapter = new AdapterUnderTest();