Merge pull request #1129 from Microsoft/jwilaby/#1057-proxy-support

Fixes #1057 - Proxy support

packages/app/client/package.json

@@ -66,7 +66,7 @@
     "jsdom-global": "^3.0.2",
     "mini-css-extract-plugin": "^0.4.0",
     "node-sass": "4.9.0",
-    "npm-run-all": "^4.1.3",
+    "npm-run-all": "^4.1.5",
     "react-app-rewired": "^1.4.1",
     "react-dev-utils": "^5.0.0",
     "react-hot-loader": "^4.1.3",

packages/app/main/package.json

@@ -88,7 +88,7 @@
     "jest": "^23.0.0",
     "license-list": "^0.1.3",
     "ncp": "2.0.0",
-    "npm-run-all": "^4.1.3",
+    "npm-run-all": "^4.1.5",
     "through2": "^2.0.3",
     "tslint": "^5.10.0",
     "typescript": "3.1.1",

packages/app/main/src/commands/electronCommands.spec.ts

@@ -1,3 +1,4 @@
+import '../fetchProxy';
 import { SharedConstants } from '@bfemulator/app-shared';
 import { CommandRegistryImpl } from '@bfemulator/sdk-shared';
 import * as Electron from 'electron';

packages/app/main/src/commands/emulatorCommands.spec.ts

@@ -1,3 +1,4 @@
+import '../fetchProxy';
 import { combineReducers, createStore } from 'redux';
 import * as BotActions from '../botData/actions/botActions';
 import { bot } from '../botData/reducers/bot';

packages/app/main/src/fetchProxy.spec.ts

@@ -0,0 +1,35 @@
+let mockFetchArgs: {input: RequestInfo, init?: any};
+jest.mock('node-fetch', () => {
+ return async(input, init) => {
+    mockFetchArgs = { input, init };
+    return {
+      ok: true,
+      json: async () => ({}),
+      text: async () => '{}',
+    };
+  };
+});
+
+import './fetchProxy';
+
+describe('fetch proxy support', () => {
+  it('should add the https-proxy-agent when the HTTPS_PROXY env var exists', async () => {
+    process.env.HTTPS_PROXY = 'https://proxy';
+    await fetch('https://some.api.com');
+    expect(mockFetchArgs.init.agent).not.toBeNull();
+  });
+
+  it('should not add the https-proxy-agent when the HTTPS_PROXY env var exists but the NO_PROXY omits the url', () => {
+    process.env.HTTPS_PROXY = 'https://proxy';
+    process.env.NO_PROXY = 'localhost';
+    fetch('https://localhost').catch();
+    expect(mockFetchArgs.init).toBeUndefined();
+  });
+
+  it('should not add the http-proxy-agent when the HTTPS_PROXY is omitted', () => {
+    delete process.env.HTTPS_PROXY;
+    delete process.env.NO_PROXY;
+    fetch('https://localhost').catch();
+    expect(mockFetchArgs.init).toBeUndefined();
+  });
+});

packages/app/main/src/fetchProxy.ts

@@ -0,0 +1,24 @@
+// ------------------------------------------------------------------
+// Proxy support
+const nodeFetch = require('node-fetch');
+
+declare function fetch(input: RequestInfo, init?: RequestInit): Promise<Response>;
+
+(global as any).fetch = function (...args: any[]) {
+  const [urlOrRequest, requestInit = {}] = args;
+  // No Proxy
+  const url: string = typeof urlOrRequest === 'string' ? urlOrRequest : urlOrRequest.url;
+  if (!process.env.HTTPS_PROXY || (process.env.NO_PROXY && url.includes(process.env.NO_PROXY))) {
+    return nodeFetch(...args);
+  }
+  // URL is first param attach the proxy
+  // to the RequestInit
+  const HttpsProxyAgent = require('https-proxy-agent');
+  const agent = new HttpsProxyAgent(process.env.HTTPS_PROXY);
+  if (typeof urlOrRequest === 'string') {
+    requestInit.agent = agent;
+  } else {
+    urlOrRequest.agent = agent;
+  }
+  return nodeFetch(urlOrRequest, requestInit);
+};

packages/app/main/src/main.ts

@@ -30,7 +30,7 @@
 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 //
-
+import './fetchProxy';
 import * as Electron from 'electron';
 import { app, Menu, systemPreferences } from 'electron';
 
@@ -64,7 +64,6 @@ export let mainWindow: Window;
 export let windowManager: WindowManager;
 
 const store = getStore();
-
 // -----------------------------------------------------------------------------
 
 (process as NodeJS.EventEmitter).on('uncaughtException', (error: Error) => {

packages/app/main/src/protocolHandler.spec.ts

@@ -12,7 +12,7 @@ jest.mock('./globals', () => ({
   getGlobal: () => ({}),
   setGlobal: () => null
 }));
-
+import './fetchProxy';
 import {
   Protocol,
   ProtocolHandler,

packages/app/main/src/restServer.ts

@@ -34,7 +34,6 @@
 import { BotEmulator, Conversation } from '@bfemulator/emulator-core';
 import CORS from 'restify-cors-middleware';
 import * as Restify from 'restify';
-import fetch from 'node-fetch';
 
 import { mainWindow } from './main';
 import { emulator } from './emulator';

packages/app/main/src/services/azureAuthWorkflowService.spec.ts

@@ -1,3 +1,4 @@
+import '../fetchProxy';
 import { AzureAuthWorkflowService } from './azureAuthWorkflowService';
 import { BrowserWindow } from 'electron';
 

packages/app/main/src/services/azureAuthWorkflowService.ts

@@ -32,7 +32,6 @@
 //
 
 import { BrowserWindow } from 'electron';
-import fetch from 'node-fetch';
 import uuidv4 from 'uuid/v4';
 import * as jwt from 'jsonwebtoken';
 

packages/app/main/src/services/conversationService.spec.ts

@@ -1,5 +1,5 @@
+import '../fetchProxy';
 let mockFetchArgs: MockFetch;
-import * as nodeFetch from 'node-fetch';
 
 jest.mock('node-fetch', () => {
   const fetch = (url, opts) => {
@@ -37,7 +37,6 @@ describe('The ConversationService should call "fetch" with the expected paramete
     expect(url).toBe('http://localhost/emulator/abcdef/users');
 
     const { body, headers, method } = opts;
-    expect(headers instanceof nodeFetch.Headers).toBeTruthy();
     expect(headers === headers).toBeTruthy();
     expect(method).toBe('POST');
     const members = JSON.parse(body);
@@ -52,7 +51,6 @@ describe('The ConversationService should call "fetch" with the expected paramete
     expect(url).toBe('http://localhost/emulator/abcdef/users');
 
     const { body, headers, method } = opts;
-    expect(headers instanceof nodeFetch.Headers).toBeTruthy();
     expect(headers === headers).toBeTruthy();
     expect(method).toBe('DELETE');
     const users = JSON.parse(body);
@@ -66,7 +64,6 @@ describe('The ConversationService should call "fetch" with the expected paramete
     expect(url).toBe('http://localhost/emulator/abcdef/users');
 
     const { body, headers, method } = opts;
-    expect(headers instanceof nodeFetch.Headers).toBeTruthy();
     expect(headers === headers).toBeTruthy();
     expect(method).toBe('DELETE');
     expect(body).toBeFalsy();
@@ -79,7 +76,6 @@ describe('The ConversationService should call "fetch" with the expected paramete
     expect(url).toBe('http://localhost/emulator/abcdef/contacts');
 
     const { body, headers, method } = opts;
-    expect(headers instanceof nodeFetch.Headers).toBeTruthy();
     expect(headers === headers).toBeTruthy();
     expect(method).toBe('POST');
     expect(body).toBeFalsy();
@@ -92,7 +88,6 @@ describe('The ConversationService should call "fetch" with the expected paramete
     expect(url).toBe('http://localhost/emulator/abcdef/contacts');
 
     const { body, headers, method } = opts;
-    expect(headers instanceof nodeFetch.Headers).toBeTruthy();
     expect(headers === headers).toBeTruthy();
     expect(method).toBe('DELETE');
     expect(body).toBeFalsy();
@@ -105,7 +100,6 @@ describe('The ConversationService should call "fetch" with the expected paramete
     expect(url).toBe('http://localhost/emulator/abcdef/typing');
 
     const { body, headers, method } = opts;
-    expect(headers instanceof nodeFetch.Headers).toBeTruthy();
     expect(headers === headers).toBeTruthy();
     expect(method).toBe('POST');
     expect(body).toBeFalsy();
@@ -118,7 +112,6 @@ describe('The ConversationService should call "fetch" with the expected paramete
     expect(url).toBe('http://localhost/emulator/abcdef/ping');
 
     const { body, headers, method } = opts;
-    expect(headers instanceof nodeFetch.Headers).toBeTruthy();
     expect(headers === headers).toBeTruthy();
     expect(method).toBe('POST');
     expect(body).toBeFalsy();
@@ -131,7 +124,6 @@ describe('The ConversationService should call "fetch" with the expected paramete
     expect(url).toBe('http://localhost/emulator/abcdef/userdata');
 
     const { body, headers, method } = opts;
-    expect(headers instanceof nodeFetch.Headers).toBeTruthy();
     expect(headers === headers).toBeTruthy();
     expect(method).toBe('DELETE');
     expect(body).toBeFalsy();

packages/app/main/src/services/conversationService.ts

@@ -1,8 +1,6 @@
-import fetch, { Headers } from 'node-fetch';
-
-export const headers = new Headers({
+export const headers = {
   'Content-Accept': 'application/json'
-});
+};
 
 export class ConversationService {
 

packages/app/main/src/services/luisApiService.spec.ts

@@ -1,5 +1,7 @@
+import '../fetchProxy';
+
 const mockArmToken = 'bm90aGluZw.eyJ1cG4iOiJnbGFzZ293QHNjb3RsYW5kLmNvbSJ9.7gjdshgfdsk98458205jfds9843fjds';
-const mockReq: RequestInit = { headers: { Authorization: `Bearer ${mockArmToken}` } };
+const mockReq: RequestInit = { headers: { Authorization: `Bearer ${ mockArmToken }` } };
 const mockResponses = [
   'hfdjg459846gjfdhgfdshjg',
   { 'error': { 'statusCode': 401, 'message': 'Oh Noes!' } },
@@ -95,26 +97,17 @@ describe('The LuisApiService class', () => {
 
     expect(mockArgsPassedToFetch[1]).toEqual({
       'url': 'https://australiaeast.api.cognitive.microsoft.com/luis/api/v2.0/apps/',
-      'headers': {
-        'headers': {},
-        'method': 'get'
-      }
+      headers: jasmine.any(Object)
     });
 
     expect(mockArgsPassedToFetch[2]).toEqual({
       'url': 'https://westeurope.api.cognitive.microsoft.com/luis/api/v2.0/apps/',
-      'headers': {
-        'headers': {},
-        'method': 'get'
-      }
+      headers: jasmine.any(Object)
     });
 
     expect(mockArgsPassedToFetch[3]).toEqual({
       'url': 'https://westus.api.cognitive.microsoft.com/luis/api/v2.0/apps/',
-      'headers': {
-        'headers': {},
-        'method': 'get'
-      }
+      headers: jasmine.any(Object)
     });
   });
 });

packages/app/main/src/services/luisApiService.ts

@@ -33,7 +33,6 @@
 
 import { LuisModel, LuisRegion, ServiceCodes } from '@bfemulator/app-shared';
 import { ILuisService, ServiceTypes } from 'botframework-config/lib/schema';
-import fetch, { Headers, Response } from 'node-fetch';
 
 export class LuisApi {
   public static* getServices(armToken: string): IterableIterator<any> {
@@ -87,10 +86,10 @@ export class LuisApi {
 
   public static async getApplicationsForRegion(region: LuisRegion, key: string): Promise<LuisModel[] | { error: any }> {
     const url = `https://${region}.api.cognitive.microsoft.com/luis/api/v2.0/apps/`;
-    const headers = new Headers({
+    const headers = {
       'Content-Accept': 'application/json',
       'Ocp-Apim-Subscription-Key': key
-    });
+    };
 
     const response: Response = await fetch(url, { headers, method: 'get' } as any);
     if (!response.ok) {

packages/app/main/src/services/qnaApiService.spec.ts

@@ -1,3 +1,4 @@
+import '../fetchProxy';
 const mockArmToken = 'bm90aGluZw.eyJ1cG4iOiJnbGFzZ293QHNjb3RsYW5kLmNvbSJ9.7gjdshgfdsk98458205jfds9843fjds';
 const mockReq: RequestInit = { headers: { Authorization: `Bearer ${mockArmToken}` } };
 const mockResponses = [

packages/app/main/src/services/qnaApiService.ts

@@ -1,5 +1,4 @@
 import { QnaMakerService } from 'botframework-config/lib/models';
-import fetch, { Headers, Response } from 'node-fetch';
 import { ServiceCodes } from '@bfemulator/app-shared';
 
 export interface Subscription {

packages/emulator/core/package.json

@@ -57,7 +57,6 @@
     "http-status-codes": "^1.3.0",
     "jsonwebtoken": "^8.3.0",
     "moment": "^2.22.1",
-    "node-fetch": "2.2.0",
     "npmlog": "^4.1.2",
     "on-error-resume-next": "^1.0.0",
     "rsa-pem-from-mod-exp": "^0.8.4",

packages/emulator/core/src/botEmulator.ts

@@ -32,7 +32,6 @@
 //
 
 import * as Restify from 'restify';
-import fetch from 'node-fetch';
 import Attachments from './facility/attachments';
 import BotState from './facility/botState';
 import ConsoleLogService from './facility/consoleLogService';
@@ -64,13 +63,13 @@ export interface ServiceUrlProvider {
 }
 
 export interface Facilities {
-  attachments: Attachments,
-  botState: BotState,
-  conversations: ConversationSet,
-  endpoints: EndpointSet,
-  logger: Logger,
-  users: Users,
-  locale?: string
+  attachments: Attachments;
+  botState: BotState;
+  conversations: ConversationSet;
+  endpoints: EndpointSet;
+  logger: Logger;
+  users: Users;
+  locale?: string;
 }
 
 export default class BotEmulator {

packages/emulator/core/src/utils/oauthLinkEncoder.ts

@@ -36,7 +36,6 @@ import GenericActivity from '../types/activity/generic';
 import AttachmentContentTypes from '../types/attachment/contentTypes';
 import OAuthCard from '../types/card/oAuth';
 import uniqueId from '../utils/uniqueId';
-import fetch, { Headers, Response } from 'node-fetch';
 import Attachment from '../types/attachment';
 import BotEmulator from '../botEmulator';
 import { StringProvider } from './stringProvider';
@@ -112,9 +111,9 @@ export default class OAuthLinkEncoder {
 
     let serializedState = JSON.stringify(tokenExchangeState);
     let state = Buffer.from(serializedState).toString('base64');
-    const headers = new Headers({
+    const headers = {
       'Authorization': this.authorizationHeader
-    });
+    };
 
     const url = 'https://api.botframework.com/api/botsignin/GetSignInUrl?state=' +
       state + '&emulatorUrl=' + this.emulatorUrl + '&code_challenge=' + codeChallenge;

packages/emulator/core/tsconfig.json

@@ -5,7 +5,8 @@
     // Emit declaration only when we are building with Babel
     // "emitDeclarationOnly": true,
     "lib": [
-      "es2016"
+      "es2016",
+      "dom"
     ],
     "module": "commonjs",
     "moduleResolution": "node",