fix: [#4470] Migrate off @azure/ms-rest-js bf-connector

libraries/botbuilder/tests/teamsInfo.test.js

@@ -1081,7 +1081,7 @@ describe('TeamsInfo', function () {
             try {
                 await TeamsInfo.sendMeetingNotification(context, notification, meetingId);
             } catch (e) {
-                assert.deepEqual(errorResponse, e.body);
+                assert.deepEqual(errorResponse, e.details);
                 isErrorThrown = true;
             }
 
@@ -1214,7 +1214,7 @@ describe('TeamsInfo', function () {
             try {
                 await TeamsInfo.sendMessageToListOfUsers(context, activity, tenantId, members);
             } catch (e) {
-                assert.deepEqual(errorResponse, e.errors[0].body);
+                assert.deepEqual(errorResponse, e.errors[0].details);
                 isErrorThrown = true;
             }
 
@@ -1307,7 +1307,7 @@ describe('TeamsInfo', function () {
             try {
                 await TeamsInfo.sendMessageToAllUsersInTenant(context, activity, tenantId);
             } catch (e) {
-                assert.deepEqual(errorResponse, e.errors[0].body);
+                assert.deepEqual(errorResponse, e.errors[0].details);
                 isErrorThrown = true;
             }
 
@@ -1395,7 +1395,7 @@ describe('TeamsInfo', function () {
             try {
                 await TeamsInfo.sendMessageToAllUsersInTeam(context, activity, tenantId, teamId);
             } catch (e) {
-                assert.deepEqual(errorResponse, e.errors[0].body);
+                assert.deepEqual(errorResponse, e.errors[0].details);
                 isErrorThrown = true;
             }
 
@@ -1502,7 +1502,7 @@ describe('TeamsInfo', function () {
             try {
                 await TeamsInfo.sendMessageToListOfChannels(context, activity, tenantId, members);
             } catch (e) {
-                assert.deepEqual(errorResponse, e.errors[0].body);
+                assert.deepEqual(errorResponse, e.errors[0].details);
                 isErrorThrown = true;
             }
 
@@ -1579,7 +1579,7 @@ describe('TeamsInfo', function () {
             try {
                 await TeamsInfo.getOperationState(context, operationId);
             } catch (e) {
-                assert.deepEqual(errorResponse, e.errors[0].body);
+                assert.deepEqual(errorResponse, e.errors[0].details);
                 isErrorThrown = true;
             }
 
@@ -1648,7 +1648,7 @@ describe('TeamsInfo', function () {
             try {
                 await TeamsInfo.getFailedEntries(context, operationId);
             } catch (e) {
-                assert.deepEqual(errorResponse, e.errors[0].body);
+                assert.deepEqual(errorResponse, e.errors[0].details);
                 isErrorThrown = true;
             }
 
@@ -1697,7 +1697,7 @@ describe('TeamsInfo', function () {
             try {
                 await TeamsInfo.cancelOperation(context, operationId);
             } catch (e) {
-                assert.deepEqual(errorResponse, e.errors[0].body);
+                assert.deepEqual(errorResponse, e.errors[0].details);
                 isErrorThrown = true;
             }
 

libraries/botframework-connector/package.json

@@ -27,8 +27,8 @@
     }
   },
   "dependencies": {
+    "@azure/core-http": "^3.0.2",
     "@azure/identity": "^2.0.4",
-    "@azure/ms-rest-js": "^2.7.0",
     "@azure/msal-node": "^1.2.0",
     "axios": "^0.25.0",
     "base64url": "^3.0.0",

libraries/botframework-connector/src/auth/appCredentials.ts

@@ -6,16 +6,17 @@
  * Licensed under the MIT License.
  */
 
-import * as msrest from '@azure/ms-rest-js';
 import { ConfidentialClientApplication } from '@azure/msal-node';
+import { ServiceClientCredentials, WebResource } from '@azure/core-http';
+import { TokenCredentials } from './tokenCredentials';
 import { AuthenticationConstants } from './authenticationConstants';
 import { AuthenticatorResult } from './authenticatorResult';
 
 /**
  * General AppCredentials auth implementation and cache.
  * Subclasses can implement refreshToken to acquire the token.
  */
-export abstract class AppCredentials implements msrest.ServiceClientCredentials {
+export abstract class AppCredentials implements ServiceClientCredentials {
     private static readonly cache: Map<string, AuthenticatorResult> = new Map<string, AuthenticatorResult>();
 
     appId: string;
@@ -148,9 +149,9 @@ export abstract class AppCredentials implements msrest.ServiceClientCredentials
      * @param webResource The WebResource HTTP request.
      * @returns A Promise representing the asynchronous operation.
      */
-    async signRequest(webResource: msrest.WebResource): Promise<msrest.WebResource> {
+    async signRequest(webResource: WebResource): Promise<WebResource> {
         if (this.shouldSetToken()) {
-            return new msrest.TokenCredentials(await this.getToken()).signRequest(webResource);
+            return new TokenCredentials(await this.getToken()).signRequest(webResource);
         }
 
         return webResource;

libraries/botframework-connector/src/auth/botFrameworkClientImpl.ts

@@ -8,7 +8,7 @@ import { BotFrameworkClient } from '../skills';
 import { ConversationIdHttpHeaderName } from '../conversationConstants';
 import { ServiceClientCredentialsFactory } from './serviceClientCredentialsFactory';
 import { USER_AGENT } from './connectorFactoryImpl';
-import { WebResource } from '@azure/ms-rest-js';
+import { WebResource } from '@azure/core-http';
 import { ok } from 'assert';
 
 const botFrameworkClientFetchImpl: typeof fetch = async (input, init) => {

libraries/botframework-connector/src/auth/certificateServiceClientCredentialsFactory.ts

@@ -6,7 +6,7 @@
  * Licensed under the MIT License.
  */
 
-import type { ServiceClientCredentials } from '@azure/ms-rest-js';
+import type { ServiceClientCredentials } from '@azure/core-http';
 import { ServiceClientCredentialsFactory } from './serviceClientCredentialsFactory';
 import { ok } from 'assert';
 import { CertificateAppCredentials } from './certificateAppCredentials';

libraries/botframework-connector/src/auth/connectorFactoryImpl.ts

@@ -1,7 +1,7 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
-import { getDefaultUserAgentValue, RequestPolicyFactory, userAgentPolicy } from '@azure/ms-rest-js';
+import { getDefaultUserAgentValue, RequestPolicyFactory, userAgentPolicy } from '@azure/core-http';
 import { ConnectorClient } from '../connectorApi/connectorClient';
 import { ConnectorClientOptions } from '../connectorApi/models';
 import { ConnectorFactory } from './connectorFactory';

libraries/botframework-connector/src/auth/index.ts

@@ -39,3 +39,4 @@ export * from './userTokenClient';
 
 export { MsalAppCredentials } from './msalAppCredentials';
 export { MsalServiceClientCredentialsFactory } from './msalServiceClientCredentialsFactory';
+export { TokenCredentials } from './tokenCredentials';

libraries/botframework-connector/src/auth/managedIdentityServiceClientCredentialsFactory.ts

@@ -7,7 +7,7 @@
  */
 
 import type { IJwtTokenProviderFactory } from './jwtTokenProviderFactory';
-import type { ServiceClientCredentials } from '@azure/ms-rest-js';
+import type { ServiceClientCredentials } from '@azure/core-http';
 import { ManagedIdentityAppCredentials } from './managedIdentityAppCredentials';
 import { ServiceClientCredentialsFactory } from './serviceClientCredentialsFactory';
 import { ok } from 'assert';

libraries/botframework-connector/src/auth/msalServiceClientCredentialsFactory.ts

@@ -6,7 +6,7 @@
 
 import { ConfidentialClientApplication } from '@azure/msal-node';
 import { MsalAppCredentials } from './msalAppCredentials';
-import { ServiceClientCredentials } from '@azure/ms-rest-js';
+import { ServiceClientCredentials } from '@azure/core-http';
 import { ServiceClientCredentialsFactory } from './serviceClientCredentialsFactory';
 import { AuthenticationConstants } from './authenticationConstants';
 import { GovernmentConstants } from './governmentConstants';

libraries/botframework-connector/src/auth/passwordServiceClientCredentialFactory.ts

@@ -4,7 +4,7 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
-import type { ServiceClientCredentials } from '@azure/ms-rest-js';
+import type { ServiceClientCredentials } from '@azure/core-http';
 import { AuthenticationConstants } from './authenticationConstants';
 import { GovernmentConstants } from './governmentConstants';
 import { MicrosoftAppCredentials } from './microsoftAppCredentials';

libraries/botframework-connector/src/auth/serviceClientCredentialsFactory.ts

@@ -1,7 +1,7 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
-import { ServiceClientCredentials } from '@azure/ms-rest-js';
+import { ServiceClientCredentials } from '@azure/core-http';
 
 // Export underlying type for convenience
 export { ServiceClientCredentials };

libraries/botframework-connector/src/auth/tokenCredentials.ts

@@ -0,0 +1,42 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License. See License.txt in the project root for license information.
+
+import { HttpHeaders, Constants, WebResourceLike, ServiceClientCredentials } from '@azure/core-http';
+
+const HeaderConstants = Constants.HeaderConstants;
+const DEFAULT_AUTHORIZATION_SCHEME = 'Bearer';
+
+/**
+ * A credentials object that uses a token string and a authorzation scheme to authenticate.
+ */
+export class TokenCredentials implements ServiceClientCredentials {
+    token: string;
+    authorizationScheme: string = DEFAULT_AUTHORIZATION_SCHEME;
+
+    /**
+     * Creates a new TokenCredentials object.
+     *
+     * @class
+     * @param {string} token The token.
+     * @param {string} [authorizationScheme] The authorization scheme.
+     */
+    constructor(token: string, authorizationScheme: string = DEFAULT_AUTHORIZATION_SCHEME) {
+        if (!token) {
+            throw new Error('token cannot be null or undefined.');
+        }
+        this.token = token;
+        this.authorizationScheme = authorizationScheme;
+    }
+
+    /**
+     * Signs a request with the Authentication header.
+     *
+     * @param {WebResourceLike} webResource The WebResourceLike to be signed.
+     * @returns {Promise<WebResourceLike>} The signed request object.
+     */
+    signRequest(webResource: WebResourceLike) {
+        if (!webResource.headers) webResource.headers = new HttpHeaders();
+        webResource.headers.set(HeaderConstants.AUTHORIZATION, `${this.authorizationScheme} ${this.token}`);
+        return Promise.resolve(webResource);
+    }
+}

libraries/botframework-connector/src/auth/userTokenClientImpl.ts

@@ -2,7 +2,7 @@
 // Licensed under the MIT License.
 
 import * as z from 'zod';
-import type { ServiceClientCredentials } from '@azure/ms-rest-js';
+import type { ServiceClientCredentials } from '@azure/core-http';
 import { Activity, SignInUrlResponse, TokenExchangeRequest, TokenResponse, TokenStatus } from 'botframework-schema';
 import { ConnectorClientOptions } from '../connectorApi/models';
 import { TokenApiClient } from '../tokenApi/tokenApiClient';

libraries/botframework-connector/src/connectorApi/connectorClient.ts

@@ -5,7 +5,7 @@
 
 import * as Mappers from './models/mappers';
 import * as Models from './models';
-import * as msRest from '@azure/ms-rest-js';
+import { ServiceClientCredentials } from "@azure/core-http"
 import * as operations from './operations';
 import { ConnectorClientContext } from './connectorClientContext';
 
@@ -20,7 +20,7 @@ class ConnectorClient extends ConnectorClientContext {
      * @param credentials Subscription credentials which uniquely identify client subscription.
      * @param [options] The parameter options
      */
-    constructor(credentials: msRest.ServiceClientCredentials, options?: Models.ConnectorClientOptions) {
+    constructor(credentials: ServiceClientCredentials, options?: Models.ConnectorClientOptions) {
         super(credentials, options);
         this.attachments = new operations.Attachments(this);
         this.conversations = new operations.Conversations(this);

libraries/botframework-connector/src/connectorApi/connectorClientContext.ts

@@ -3,21 +3,21 @@
  * Licensed under the MIT License.
  */
 
-import * as msRest from "@azure/ms-rest-js";
+import { ServiceClient, ServiceClientCredentials, getDefaultUserAgentValue } from "@azure/core-http";
 import * as Models from "./models";
 
 const packageName = "botframework-connector";
 const packageVersion = "4.0.0";
 
-export class ConnectorClientContext extends msRest.ServiceClient {
-  credentials: msRest.ServiceClientCredentials;
+export class ConnectorClientContext extends ServiceClient {
+  credentials: ServiceClientCredentials;
 
   /**
    * Initializes a new instance of the ConnectorClientContext class.
    * @param credentials Subscription credentials which uniquely identify client subscription.
    * @param [options] The parameter options
    */
-  constructor(credentials: msRest.ServiceClientCredentials, options?: Models.ConnectorClientOptions) {
+  constructor(credentials: ServiceClientCredentials, options?: Models.ConnectorClientOptions) {
     if (credentials === null || credentials === undefined) {
       throw new Error('\'credentials\' cannot be null.');
     }
@@ -27,7 +27,7 @@ export class ConnectorClientContext extends msRest.ServiceClient {
       options = {} as Models.ConnectorClientOptions;
     }
     // TODO  This is to workaround fact that AddUserAgent() was removed.  
-    const defaultUserAgent = msRest.getDefaultUserAgentValue();
+    const defaultUserAgent = getDefaultUserAgentValue();
     options.userAgent = `${packageName}/${packageVersion} ${defaultUserAgent} ${options.userAgent || ''}`;
 
     super(credentials, options);