Fix AppCredentials compilation error in BotFrameworkAdapter (#1902)

* implement different fixes for #1901

* loosen credentials reqs in BFHttpClient

* rev on BotFrameworkAdapter AppCredentials fix

* fix breaking change in createTokenApiClient

* rename CoreAppCredentials

* make appCredentials optional in oAuthPromptSettings

* test: add typescript consumer test (#1904)

Co-authored-by: stevengum <14935595+stevengum@users.noreply.github.com>

Co-authored-by: Christopher Anderson <chrande@microsoft.com>

.gitignore

@@ -313,3 +313,6 @@ package-lock.json
 
 *.tsbuildinfo
 *.js.map
+
+consumer-test/**.js
+consumer-test/**.json

consumer-test/test.ts

@@ -0,0 +1,27 @@
+import * as l1 from '../libraries/adaptive-expressions';
+import * as l2 from '../libraries/botbuilder';
+import * as l3 from '../libraries/botbuilder-ai';
+import * as l4 from '../libraries/botbuilder-applicationinsights';
+import * as l5 from '../libraries/botbuilder-azure';
+import * as l6 from '../libraries/botbuilder-core';
+import * as l7 from '../libraries/botbuilder-dialogs';
+import * as l8 from '../libraries/botbuilder-lg';
+import * as l9 from '../libraries/botbuilder-testing';
+import * as l10 from '../libraries/botframework-config';
+import * as l11 from '../libraries/botframework-connector';
+import * as l13 from '../libraries/botframework-schema';
+import * as l14 from '../libraries/botframework-streaming';
+
+console.log(Object.keys(l1));
+console.log(Object.keys(l2));
+console.log(Object.keys(l3));
+console.log(Object.keys(l4));
+console.log(Object.keys(l5));
+console.log(Object.keys(l6));
+console.log(Object.keys(l7));
+console.log(Object.keys(l8));
+console.log(Object.keys(l9));
+console.log(Object.keys(l10));
+console.log(Object.keys(l11));
+console.log(Object.keys(l13));
+console.log(Object.keys(l14));

libraries/botbuilder-core/src/appCredentials.ts → libraries/botbuilder-core/src/coreAppCredentials.ts

@@ -6,22 +6,28 @@
  * Licensed under the MIT License.
  */
 
- /**
-  * Internal interface representing the "WebResource" from @azure/ms-rest-js@1.2.6
-  */
-interface WebResource {}
+/**
+ * Internal interface representing the "WebResource" from @azure/ms-rest-js@1.2.6
+ */
+interface CoreWebResource {
+    url?: string;
+    method?: any;
+    body?: any;
+    headers?: any;
+}
+
 
 /**
- * AppCredentials
+ * CoreAppCredentials
  * @remarks
  * Runtime-agnostic interface representing "ServiceClientCredentials" from @azure/ms-rest-js@1.2.6
  */
-export interface AppCredentials {
+export interface CoreAppCredentials {
     /**
      * Signs a request with the Authentication header.
      *
      * @param {WebResource} webResource The WebResource/request to be signed.
      * @returns {Promise<WebResource>} The signed request object;
     */
-    signRequest(webResource: WebResource): Promise<WebResource>;
+    signRequest(webResource: CoreWebResource): Promise<CoreWebResource>;
 }

libraries/botbuilder-core/src/extendedUserTokenProvider.ts

@@ -6,7 +6,7 @@
  * Licensed under the MIT License.
  */
 
-import { AppCredentials } from './appCredentials';
+import { CoreAppCredentials } from './coreAppCredentials';
 import { IUserTokenProvider } from './userTokenProvider';
 import { TurnContext } from './turnContext';
 import { SignInUrlResponse ,TokenResponse, TokenExchangeRequest } from 'botframework-schema';
@@ -21,7 +21,7 @@ export interface ExtendedUserTokenProvider extends IUserTokenProvider {
      * @param connectionName Name of the auth connection to use.
      * @param magicCode (Optional) Optional user entered code to validate.
      */
-    getUserToken(context: TurnContext, connectionName: string, magicCode?: string, appCredentials?: AppCredentials): Promise<TokenResponse>;
+    getUserToken(context: TurnContext, connectionName: string, magicCode?: string, appCredentials?: CoreAppCredentials): Promise<TokenResponse>;
 
     /**
      * Signs the user out with the token server.
@@ -30,23 +30,23 @@ export interface ExtendedUserTokenProvider extends IUserTokenProvider {
      * @param userId User id of user to sign out.
      * @param oAuthAppCredentials AppCredentials for OAuth.
      */
-    signOutUser(context: TurnContext, connectionName: string, userId?: string, appCredentials?: AppCredentials): Promise<void>;
+    signOutUser(context: TurnContext, connectionName: string, userId?: string, appCredentials?: CoreAppCredentials): Promise<void>;
 
     /**
      * Gets a signin link from the token server that can be sent as part of a SigninCard.
      * @param context Context for the current turn of conversation with the user.
      * @param connectionName Name of the auth connection to use.
      * @param oAuthAppCredentials AppCredentials for OAuth.
      */
-    getSignInLink(context: TurnContext, connectionName: string, appCredentials?: AppCredentials): Promise<string>;
+    getSignInLink(context: TurnContext, connectionName: string, appCredentials?: CoreAppCredentials): Promise<string>;
 
     /**
      * Signs the user out with the token server.
      * @param context Context for the current turn of conversation with the user.
      * @param connectionName Name of the auth connection to use.
      * @param oAuthAppCredentials AppCredentials for OAuth.
      */
-    getAadTokens(context: TurnContext, connectionName: string, resourceUrls: string[], appCredentials?: AppCredentials): Promise<{
+    getAadTokens(context: TurnContext, connectionName: string, resourceUrls: string[], appCredentials?: CoreAppCredentials): Promise<{
         [propertyName: string]: TokenResponse;
     }>;
 
@@ -73,7 +73,7 @@ export interface ExtendedUserTokenProvider extends IUserTokenProvider {
      * @param userId The user id that will be associated with the token.
      * @param finalRedirect The final URL that the OAuth flow will redirect to.
      */   
-    getSignInResource(context: TurnContext, connectionName: string, userId: string, finalRedirect?: string, appCredentials?: AppCredentials): Promise<SignInUrlResponse>;
+    getSignInResource(context: TurnContext, connectionName: string, userId: string, finalRedirect?: string, appCredentials?: CoreAppCredentials): Promise<SignInUrlResponse>;
 
     /**
      * Performs a token exchange operation such as for single sign-on.
@@ -91,5 +91,5 @@ export interface ExtendedUserTokenProvider extends IUserTokenProvider {
      * @param userId The user id that will be associated with the token.
      * @param tokenExchangeRequest The exchange request details, either a token to exchange or a uri to exchange.
      */  
-    exchangeToken(context: TurnContext, connectionName: string, userId: string, tokenExchangeRequest: TokenExchangeRequest, appCredentials: AppCredentials): Promise<TokenResponse>;
+    exchangeToken(context: TurnContext, connectionName: string, userId: string, tokenExchangeRequest: TokenExchangeRequest, appCredentials: CoreAppCredentials): Promise<TokenResponse>;
 }

libraries/botbuilder-core/src/index.ts

@@ -8,7 +8,7 @@
 
 export * from 'botframework-schema';
 export * from './activityFactory';
-export * from './appCredentials';
+export * from './coreAppCredentials';
 export * from './activityHandler';
 export * from './activityHandlerBase';
 export * from './autoSaveStateMiddleware';

libraries/botbuilder-dialogs/src/prompts/oauthPrompt.ts

@@ -5,7 +5,7 @@
  * Copyright (c) Microsoft Corporation. All rights reserved.
  * Licensed under the MIT License.
  */
-import { Activity, ActivityTypes, Attachment, AppCredentials, BotAdapter, CardFactory, Channels, InputHints, MessageFactory, OAuthLoginTimeoutKey, TokenResponse, TurnContext, OAuthCard, ActionTypes, ExtendedUserTokenProvider, verifyStateOperationName, StatusCodes, tokenExchangeOperationName, tokenResponseEventName } from 'botbuilder-core';
+import { Activity, ActivityTypes, Attachment, CoreAppCredentials, BotAdapter, CardFactory, Channels, InputHints, MessageFactory, OAuthLoginTimeoutKey, TokenResponse, TurnContext, OAuthCard, ActionTypes, ExtendedUserTokenProvider, verifyStateOperationName, StatusCodes, tokenExchangeOperationName, tokenResponseEventName } from 'botbuilder-core';
 import { Dialog, DialogTurnResult } from '../dialog';
 import { DialogContext } from '../dialogContext';
 import { PromptOptions, PromptRecognizerResult,  PromptValidator } from './prompt';
@@ -42,7 +42,7 @@ export interface OAuthPromptSettings {
     /**
      * AppCredentials for OAuth.
      */
-    oAuthAppCredentials: AppCredentials;
+    oAuthAppCredentials?: CoreAppCredentials;
 
     /**
      * Name of the OAuth connection being used.

libraries/botbuilder/src/botFrameworkAdapter.ts

@@ -9,7 +9,7 @@
 import { STATUS_CODES } from 'http';
 import * as os from 'os';
 
-import { Activity, ActivityTypes, BotAdapter, BotCallbackHandlerKey, ChannelAccount, ConversationAccount, ConversationParameters, ConversationReference, ConversationsResult, DeliveryModes, ExpectedReplies, InvokeResponse, ExtendedUserTokenProvider, ResourceResponse, StatusCodes, TokenResponse, TurnContext, INVOKE_RESPONSE_KEY } from 'botbuilder-core';
+import { Activity, ActivityTypes, CoreAppCredentials, BotAdapter, BotCallbackHandlerKey, ChannelAccount, ConversationAccount, ConversationParameters, ConversationReference, ConversationsResult, DeliveryModes, ExpectedReplies, InvokeResponse, ExtendedUserTokenProvider, ResourceResponse, StatusCodes, TokenResponse, TurnContext, INVOKE_RESPONSE_KEY } from 'botbuilder-core';
 import { AuthenticationConfiguration, AuthenticationConstants, ChannelValidation, Claim, ClaimsIdentity, ConnectorClient, EmulatorApiClient, GovernmentConstants, GovernmentChannelValidation, JwtTokenValidation, MicrosoftAppCredentials, AppCredentials, CertificateAppCredentials, SimpleCredentialProvider, TokenApiClient, TokenStatus, TokenApiModels, SignInUrlResponse, SkillValidation, TokenExchangeRequest } from 'botframework-connector';
 
 import { INodeBuffer, INodeSocket, IReceiveRequest, ISocket, IStreamingTransportServer, NamedPipeServer, NodeWebSocketFactory, NodeWebSocketFactoryBase, RequestHandler, StreamingResponse, WebSocketServer } from 'botframework-streaming';
@@ -537,7 +537,7 @@ export class BotFrameworkAdapter extends BotAdapter implements ExtendedUserToken
      * @returns A [TokenResponse](xref:botframework-schema.TokenResponse) object that contains the user token.
      */
     public async getUserToken(context: TurnContext, connectionName: string, magicCode?: string): Promise<TokenResponse>;
-    public async getUserToken(context: TurnContext, connectionName: string, magicCode?: string, oAuthAppCredentials?: AppCredentials): Promise<TokenResponse>;
+    public async getUserToken(context: TurnContext, connectionName: string, magicCode?: string, oAuthAppCredentials?: CoreAppCredentials): Promise<TokenResponse>;
     public async getUserToken(context: TurnContext, connectionName: string, magicCode?: string, oAuthAppCredentials?: AppCredentials): Promise<TokenResponse> {
         if (!context.activity.from || !context.activity.from.id) {
             throw new Error(`BotFrameworkAdapter.getUserToken(): missing from or from.id`);
@@ -568,7 +568,7 @@ export class BotFrameworkAdapter extends BotAdapter implements ExtendedUserToken
      * @param oAuthAppCredentials AppCredentials for OAuth.
      */
     public async signOutUser(context: TurnContext, connectionName?: string, userId?: string): Promise<void>;
-    public async signOutUser(context: TurnContext, connectionName?: string, userId?: string, oAuthAppCredentials?: AppCredentials): Promise<void>;
+    public async signOutUser(context: TurnContext, connectionName?: string, userId?: string, oAuthAppCredentials?: CoreAppCredentials): Promise<void>;
     public async signOutUser(context: TurnContext, connectionName?: string, userId?: string, oAuthAppCredentials?: AppCredentials): Promise<void> {
         if (!context.activity.from || !context.activity.from.id) {
             throw new Error(`BotFrameworkAdapter.signOutUser(): missing from or from.id`);
@@ -595,6 +595,8 @@ export class BotFrameworkAdapter extends BotAdapter implements ExtendedUserToken
      * @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, oAuthAppCredentials?: AppCredentials, userId?: string, finalRedirect?: string): Promise<string>
+    public async getSignInLink(context: TurnContext, connectionName: string, oAuthAppCredentials?: CoreAppCredentials, userId?: string, finalRedirect?: string): 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`);
@@ -629,7 +631,7 @@ export class BotFrameworkAdapter extends BotAdapter implements ExtendedUserToken
      * @returns The [TokenStatus](xref:botframework-connector.TokenStatus) objects retrieved.
      */
     public async getTokenStatus(context: TurnContext, userId?: string, includeFilter?: string): Promise<TokenStatus[]>;
-    public async getTokenStatus(context: TurnContext, userId?: string, includeFilter?: string, oAuthAppCredentials?: AppCredentials): Promise<TokenStatus[]>;
+    public async getTokenStatus(context: TurnContext, userId?: string, includeFilter?: string, oAuthAppCredentials?: CoreAppCredentials): Promise<TokenStatus[]>;
     public async getTokenStatus(context: TurnContext, userId?: string, includeFilter?: string, oAuthAppCredentials?: AppCredentials): Promise<TokenStatus[]> {
         if (!userId && (!context.activity.from || !context.activity.from.id)) {
             throw new Error(`BotFrameworkAdapter.getTokenStatus(): missing from or from.id`);
@@ -654,7 +656,7 @@ export class BotFrameworkAdapter extends BotAdapter implements ExtendedUserToken
      * @returns A map of the [TokenResponse](xref:botframework-schema.TokenResponse) objects by resource URL.
      */
     public async getAadTokens(context: TurnContext, connectionName: string, resourceUrls: string[]): Promise<{[propertyName: string]: TokenResponse}>;
-    public async getAadTokens(context: TurnContext, connectionName: string, resourceUrls: string[], oAuthAppCredentials?: AppCredentials): Promise<{[propertyName: string]: TokenResponse}>;
+    public async getAadTokens(context: TurnContext, connectionName: string, resourceUrls: string[], oAuthAppCredentials?: CoreAppCredentials): Promise<{[propertyName: string]: TokenResponse}>;
     public async getAadTokens(context: TurnContext, connectionName: string, resourceUrls: string[], oAuthAppCredentials?: AppCredentials): Promise<{[propertyName: string]: TokenResponse}> {
         if (!context.activity.from || !context.activity.from.id) {
             throw new Error(`BotFrameworkAdapter.getAadTokens(): missing from or from.id`);
@@ -678,8 +680,7 @@ export class BotFrameworkAdapter extends BotAdapter implements ExtendedUserToken
      * 
      * @returns The [BotSignInGetSignInResourceResponse](xref:botframework-connector.BotSignInGetSignInResourceResponse) object.
      */
-    public async getSignInResource(context: TurnContext, connectionName: string, userId?: string, finalRedirect?: string, appCredentials?: AppCredentials): Promise<SignInUrlResponse>
-    {
+    public async getSignInResource(context: TurnContext, connectionName: string, userId?: string, finalRedirect?: string, appCredentials?: CoreAppCredentials): Promise<SignInUrlResponse> {
         if (!connectionName) {
             throw new Error('getUserToken() requires a connectionName but none was provided.');
         }
@@ -688,13 +689,14 @@ export class BotFrameworkAdapter extends BotAdapter implements ExtendedUserToken
             throw new Error(`BotFrameworkAdapter.getSignInResource(): missing from or from.id`);
         }
 
-        // what to do when userId is null (same for finalRedirect)
-        if(userId && context.activity.from.id != userId) {
+        // The provided userId doesn't match the from.id on the activity. (same for finalRedirect)
+        if (userId && context.activity.from.id !== userId) {
             throw new Error('BotFrameworkAdapter.getSiginInResource(): cannot get signin resource for a user that is different from the conversation');
         }
 
         const url: string = this.oauthApiUrl(context);
-        const client: TokenApiClient = this.createTokenApiClient(url, appCredentials);
+        const credentials = appCredentials as AppCredentials;
+        const client: TokenApiClient = this.createTokenApiClient(url, credentials);
         const conversation: Partial<ConversationReference> = TurnContext.getConversationReference(context.activity);
 
         const state: any = {
@@ -716,6 +718,7 @@ export class BotFrameworkAdapter extends BotAdapter implements ExtendedUserToken
      * @param userId The user id that will be associated with the token.
      * @param tokenExchangeRequest The exchange request details, either a token to exchange or a uri to exchange.
      */ 
+    public async exchangeToken(context: TurnContext, connectionName: string, userId: string, tokenExchangeRequest: TokenExchangeRequest, appCredentials?: CoreAppCredentials): Promise<TokenResponse>
     public async exchangeToken(context: TurnContext, connectionName: string, userId: string, tokenExchangeRequest: TokenExchangeRequest, appCredentials?: AppCredentials): Promise<TokenResponse> {
         if (!connectionName) {
             throw new Error('exchangeToken() requires a connectionName but none was provided.');
@@ -749,7 +752,7 @@ export class BotFrameworkAdapter extends BotAdapter implements ExtendedUserToken
     public async emulateOAuthCards(contextOrServiceUrl: TurnContext | string, emulate: boolean): Promise<void> {
         this.isEmulatingOAuthCards = emulate;
         const url: string = this.oauthApiUrl(contextOrServiceUrl);
-        await EmulatorApiClient.emulateOAuthCards(this.credentials as AppCredentials,  url, emulate);
+        await EmulatorApiClient.emulateOAuthCards(this.credentials,  url, emulate);
     }
 
     /**
@@ -1126,7 +1129,8 @@ export class BotFrameworkAdapter extends BotAdapter implements ExtendedUserToken
      * @remarks
      * Override this in a derived class to create a mock OAuth API client for unit testing.
      */
-    protected createTokenApiClient(serviceUrl: string, oAuthAppCredentials: AppCredentials): TokenApiClient {
+    protected createTokenApiClient(serviceUrl: string, oAuthAppCredentials?: CoreAppCredentials): TokenApiClient;
+    protected createTokenApiClient(serviceUrl: string, oAuthAppCredentials?: AppCredentials): TokenApiClient {
         const tokenApiClientCredentials = oAuthAppCredentials ? oAuthAppCredentials : this.credentials;
         const client = new TokenApiClient(tokenApiClientCredentials, { baseUri: serviceUrl, userAgent: USER_AGENT });
 

libraries/botbuilder/src/botFrameworkHttpClient.ts

@@ -30,7 +30,7 @@ export class BotFrameworkHttpClient implements BotFrameworkClient {
      * Cache for appCredentials to speed up token acquisition (a token is not requested unless is expired)
      * AppCredentials are cached using appId + scope (this last parameter is only used if the app credentials are used to call a skill)
      */
-    private static readonly appCredentialMapCache: Map<string, MicrosoftAppCredentials> = new Map<string, MicrosoftAppCredentials>();
+    private static readonly appCredentialMapCache: Map<string, AppCredentials> = new Map<string, AppCredentials>();
     private readonly credentialProvider: ICredentialProvider;
 
     public constructor(credentialProvider: ICredentialProvider, channelService?: string) {
@@ -71,7 +71,7 @@ export class BotFrameworkHttpClient implements BotFrameworkClient {
         }
 
         // Get token for the skill call
-        const token = appCredentials.appId === '' && appCredentials.appPassword === '' ? null : await appCredentials.getToken();
+        const token = appCredentials.appId ? await appCredentials.getToken() : null;
 
         // Capture current activity settings before changing them.
         // TODO: DO we need to set the activity ID? (events that are created manually don't have it).
@@ -142,7 +142,7 @@ export class BotFrameworkHttpClient implements BotFrameworkClient {
      * @param appId The application identifier (AAD Id for the bot).
      * @param oAuthScope The scope for the token, skills will use the Skill App Id.
      */
-    private async getAppCredentials(appId: string, oAuthScope?: string): Promise<MicrosoftAppCredentials> {
+    private async getAppCredentials(appId: string, oAuthScope?: string): Promise<AppCredentials> {
         if (!appId) {
             return new MicrosoftAppCredentials('', '');
         }