Ngrok Startup Options (#2111)

* Make sure ngrok running loop not hit everytime

Author: srinaath

CHANGELOG.md

@@ -4,12 +4,14 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## v4.8.1 - 2019 - 03 - 16
+## v4.8.1 - 2019 - 03 - 18
 ## Fixed
 - [build] Replaced a missing .icns file that was deleted by mistake in a previous PR. Fixes the app icon on Linux & Mac in PR [2104](https://github.com/microsoft/BotFramework-Emulator/pull/2104)
 - [client] Fixed an issue where Restart activity wont appear on selected activity after restarting once in PR [2105](https://github.com/microsoft/BotFramework-Emulator/pull/2105)
 - [client] Disable "Restart conversation from here" bubble on DL Speech bots [2107](https://github.com/microsoft/BotFramework-Emulator/pull/2107)
 - [client] Fixed an issue where starting a conversation with an unset custom user ID was causing the User member of the conversation to have a blank `id` field in PR [2108](https://github.com/microsoft/BotFramework-Emulator/pull/2108)
+- [main] Fixed an issue where the setting `Bypass Ngrok for local addresses` was continuing to use the ngrok tunnel even for local bots in PR [2111](https://github.com/microsoft/BotFramework-Emulator/pull/2111)
+
 
 ## v4.8.0 - 2019 - 03 - 12
 ## Added

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

@@ -44,24 +44,26 @@ import { combineReducers, createStore } from 'redux';
 import { NgrokService } from './ngrokService';
 import { store } from './state/store';
 
-const mockEmulator = {
-  server: {
-    serverUrl: 'http://localhost:3000',
-    serverPort: 8080,
-    state: {
-      conversations: {
-        getConversationIds: () => ['12', '123'],
-      },
-      endpoints: {
-        reset: () => null,
-        push: () => null,
+const mockEmulator = jest.fn(() => {
+  return {
+    server: {
+      serverUrl: 'http://localhost:3000',
+      serverPort: 8080,
+      state: {
+        conversations: {
+          getConversationIds: () => ['12', '123'],
+        },
+        endpoints: {
+          reset: () => null,
+          push: () => null,
+        },
       },
     },
-  },
-};
+  };
+});
 jest.mock('./emulator', () => ({
   Emulator: {
-    getInstance: () => mockEmulator,
+    getInstance: () => mockEmulator(),
   },
 }));
 
@@ -209,4 +211,80 @@ describe('The ngrokService', () => {
 
     (ngrokService as any).oauthNgrokInstance = undefined;
   });
+
+  describe('Conditions where service url returned is an ngrok url', () => {
+    it('should always return ngrok url if runNgrokAtStartup is selected', async () => {
+      const settings = {
+        locale: 'en-us',
+        bypassNgrokLocalhost: true,
+        runNgrokAtStartup: true,
+        ngrokPath: '/usr/bin/ngrok',
+      };
+      store.dispatch(setFrameworkSettings(settings as any));
+      const serviceUrl = await ngrokService.getServiceUrl('http://my-azure.com/speech-bot/');
+      expect(serviceUrl).toBe('http://fdsfds.ngrok.io');
+    });
+
+    it('should always return ngrok url if remote bot irrespective of options selected', async () => {
+      const settings = {
+        locale: 'en-us',
+        bypassNgrokLocalhost: false,
+        runNgrokAtStartup: false,
+        ngrokPath: '/usr/bin/ngrok',
+      };
+      store.dispatch(setFrameworkSettings(settings as any));
+      const serviceUrl = await ngrokService.getServiceUrl('http://my-azure/api/messages');
+      expect(serviceUrl).toBe('http://fdsfds.ngrok.io');
+    });
+
+    it('should always return ngrok url if bypassNgrokLocalhost is not selected and ngrok is configured', async () => {
+      const settings = {
+        locale: 'en-us',
+        bypassNgrokLocalhost: false,
+        runNgrokAtStartup: false,
+        ngrokPath: '/usr/bin/ngrok',
+      };
+      store.dispatch(setFrameworkSettings(settings as any));
+      const serviceUrl = await ngrokService.getServiceUrl('http://localhost:3978');
+      expect(serviceUrl).toBe('http://fdsfds.ngrok.io');
+    });
+  });
+
+  describe('Conditions where service url returned is a localhost url', () => {
+    it('should always return localhost url if local bot and bypassNgrokLocalhost is selected', async () => {
+      const settings = {
+        locale: 'en-us',
+        bypassNgrokLocalhost: true,
+        runNgrokAtStartup: false,
+        ngrokPath: '/usr/bin/ngrok',
+      };
+      store.dispatch(setFrameworkSettings(settings as any));
+      const serviceUrl = await ngrokService.getServiceUrl('http://localhost:3978');
+      expect(serviceUrl).toBe('http://localhost:8080');
+    });
+
+    it('should always return localhost url if bypassNgrokLocalhost is not selected and ngrok is not configured and its a local bot', async () => {
+      const settings = {
+        locale: 'en-us',
+        bypassNgrokLocalhost: false,
+        runNgrokAtStartup: false,
+        ngrokPath: '',
+      };
+      store.dispatch(setFrameworkSettings(settings as any));
+      const serviceUrl = await ngrokService.getServiceUrl('http://localhost:3978');
+      expect(serviceUrl).toBe('http://localhost:8080');
+    });
+
+    it('should always return localhost url if ngrok is not configured', async () => {
+      const settings = {
+        locale: 'en-us',
+        bypassNgrokLocalhost: false,
+        runNgrokAtStartup: false,
+        ngrokPath: '',
+      };
+      store.dispatch(setFrameworkSettings(settings as any));
+      const serviceUrl = await ngrokService.getServiceUrl('http://my-azure/api/messages');
+      expect(serviceUrl).toBe('http://localhost:8080');
+    });
+  });
 });

packages/app/main/src/ngrokService.ts

@@ -74,13 +74,13 @@ export class NgrokService {
     if (this.pendingRecycle) {
       await this.pendingRecycle;
     }
-    if (this.ngrok.running()) {
-      return this.serviceUrl;
-    }
+
     const { bypassNgrokLocalhost, runNgrokAtStartup } = getSettings().framework;
     // Use ngrok
     const local = !botUrl || isLocalHostUrl(botUrl);
-    if (runNgrokAtStartup || !local || (local && !bypassNgrokLocalhost)) {
+
+    const useNgrok = runNgrokAtStartup || !local || (local && !bypassNgrokLocalhost);
+    if (useNgrok) {
       if (!this.ngrok.running()) {
         await this.startup();
       }