environment variable management

BotProject/CSharp/BotManager.cs

@@ -1,18 +1,19 @@
-using Microsoft.Bot.Builder.Dialogs;
+using Microsoft.Bot.Builder.BotFramework;
+using Microsoft.Bot.Builder.Dialogs;
 using Microsoft.Bot.Builder.Dialogs.Debugging;
 using Microsoft.Bot.Builder.Dialogs.Declarative;
 using Microsoft.Bot.Builder.Dialogs.Declarative.Resources;
 using Microsoft.Bot.Builder.Integration.AspNet.Core;
+using Microsoft.Bot.Connector.Authentication;
 using Microsoft.Extensions.Configuration;
+using Newtonsoft.Json;
 using System;
+using System.Collections.Generic;
 using System.IO;
 using System.IO.Compression;
 using System.Linq;
 using System.Reflection;
 using System.Threading.Tasks;
-using Newtonsoft.Json;
-using Microsoft.Bot.Builder.BotFramework;
-using Microsoft.Bot.Connector.Authentication;
 
 namespace Microsoft.Bot.Builder.TestBot.Json
 {
@@ -21,7 +22,7 @@ public interface IBotManager
         IBotFrameworkHttpAdapter CurrentAdapter { get; }
         IBot CurrentBot { get; }
 
-        void SetCurrent(Stream fileStream, LuConfigFile luConfig = null, string appId = null, string appPwd = null);
+        void SetCurrent(Stream fileStream, string endpointKey = null, string appPwd = null);
     }
 
     public class BotManager : IBotManager
@@ -84,7 +85,7 @@ public void SetCurrent(string botDir)
             CurrentBot = new TestBot("Main.dialog", conversationState, userState, resourceExplorer, DebugSupport.SourceRegistry);
         }
 
-        public void SetCurrent(Stream fileStream, LuConfigFile luConfig = null, string appId = null, string appPwd = null)
+        public void SetCurrent(Stream fileStream, string endpointKey = null, string appPwd = null)
         {
             lock (locker)
             {
@@ -94,20 +95,41 @@ public void SetCurrent(Stream fileStream, LuConfigFile luConfig = null, string a
                 // extract to bot folder
                 var extractPath = ExtractFile(downloadPath, GenNewBotDir());
 
-                if (luConfig != null)
-                {
-                    AddLuisConfig(extractPath, luConfig);
-                }
+                RetrieveSettingsFile(extractPath, endpointKey, appPwd);
+                SetCurrent(extractPath);
+            }
+        }
+
+        public void RetrieveSettingsFile(string extractPath, string endpointKey, string appPwd)
+        {
+            var settingsPaths = Directory.GetFiles(extractPath, "appsettings.json", SearchOption.AllDirectories);
+            if (settingsPaths.Length == 0)
+            {
+                return;
+            }
 
-
-                AddOAuthConfig(appId, appPwd);
-
+            var settingsPath = settingsPaths.FirstOrDefault();
 
-                SetCurrent(extractPath);
+            var settings = JsonConvert.DeserializeObject<Dictionary<object, object>>(File.ReadAllText(settingsPath));
+
+            foreach (var pair in settings)
+            {
+                this.Config[pair.Key.ToString()] = pair.Value.ToString();
+            }
+
+            if (!String.IsNullOrEmpty(endpointKey))
+            {
+                var luconfigFile = JsonConvert.DeserializeObject<LuConfigFile>(settings["luis"].ToString());
+                AddLuisConfig(extractPath, luconfigFile, endpointKey);
+            }
+
+            if (!String.IsNullOrEmpty(appPwd))
+            {
+                AddOAuthConfig(appPwd);
             }
         }
 
-        public void AddLuisConfig(string extractPath, LuConfigFile luconfigFile)
+        public void AddLuisConfig(string extractPath, LuConfigFile luconfigFile, string endpointKey)
         {
             var settingsName = $"luis.settings.{luconfigFile.Environment}.{ luconfigFile.AuthoringRegion}.json";
             var luisEndpoint = $"https://{luconfigFile.AuthoringRegion}.api.cognitive.microsoft.com";
@@ -124,25 +146,16 @@ public void AddLuisConfig(string extractPath, LuConfigFile luconfigFile)
 
             var luisConfig = JsonConvert.DeserializeObject<LuisCustomConfig>(File.ReadAllText(luisPath));
 
-            luisConfig.Luis.Add("endpointKey", luconfigFile.AuthoringKey);
+            luisConfig.Luis.Add("endpointKey", endpointKey);
 
             foreach (var item in luisConfig.Luis)
             {
                 this.Config[$"luis:{item.Key}"] = item.Value;
             }
         }
 
-        private void AddOAuthConfig(string appId, string appPwd)
+        private void AddOAuthConfig(string appPwd)
         {
-            if (string.IsNullOrEmpty(appId))
-            {
-                this.Config["MicrosoftAppId"] = string.Empty;
-            }
-            else
-            {
-                this.Config["MicrosoftAppId"] = appId;
-            }
-
             if (string.IsNullOrEmpty(appPwd))
             {
                 this.Config["MicrosoftAppPassword"] = string.Empty;
@@ -151,7 +164,6 @@ private void AddOAuthConfig(string appId, string appPwd)
             {
                 this.Config["MicrosoftAppPassword"] = appPwd;
             }
-
         }
 
         private string GenNewBotDir()

BotProject/CSharp/Controllers/BotAdminController.cs

@@ -3,15 +3,8 @@
 //
 // Generated with Bot Builder V4 SDK Template for Visual Studio EchoBot v4.3.0
 
-using System;
-using System.Linq;
-using System.IO;
-using System.IO.Compression;
-using System.Reflection;
-using System.Threading.Tasks;
 using Microsoft.AspNetCore.Http;
 using Microsoft.AspNetCore.Mvc;
-using Newtonsoft.Json;
 
 namespace Microsoft.Bot.Builder.TestBot.Json
 {
@@ -31,27 +24,18 @@ public IActionResult GetAsync()
         {
             return Ok();
         }
-           
+
 
         [HttpPost]
-        public IActionResult PostAsync(IFormFile file, [FromForm]string config, [FromForm]string microsoftAppId, [FromForm]string microsoftAppPassword)
+        public IActionResult PostAsync(IFormFile file, [FromForm]string endpointKey = null, [FromForm]string microsoftAppPassword = null)
         {
             if (file == null)
             {
                 return BadRequest();
             }
 
-            if (!string.IsNullOrEmpty(config))
-            {
-                var luisConfigObj = JsonConvert.DeserializeObject<LuConfigFile>(config);
-                BotManager.SetCurrent(file.OpenReadStream(), luisConfigObj,microsoftAppId, microsoftAppPassword);
+            BotManager.SetCurrent(file.OpenReadStream(), endpointKey, microsoftAppPassword);
 
-            }
-            else
-            {
-                BotManager.SetCurrent(file.OpenReadStream(), null, microsoftAppId, microsoftAppPassword);
-            }
-
             return Ok();
         }
     }

Composer/cypress/integration/LuisDeploy.spec.js

@@ -5,23 +5,44 @@ context('Luis Deploy', () => {
     cy.server();
     cy.route('GET', '/api/launcher/connect', 'OK');
     cy.route('POST', '/api/launcher/sync', 'OK');
-
+    cy.route('POST', 'api/projects/opened/settings', 'OK');
     cy.visit(Cypress.env('COMPOSER_URL'));
     cy.openBot('ToDoLuisBot');
+
+    // save as a new test bot to prevent changing original luisBot's publish settings and remove it after test
+    cy.get('[data-testid="LeftNav-CommandBarButtonHome"]').click();
+    cy.getByText('Save as').click();
+
+    cy.get('input[data-testid="NewDialogName"]').type('__TestBot');
+    cy.get('input[data-testid="NewDialogName"]').type('{enter}');
+
+    cy.get('[data-testid="ProjectTree"]').within(() => {
+      cy.getByText('__TestBot.Main').should('exist');
+    });
   });
 
   it('can deploy luis success', () => {
     cy.get('[data-testid="LeftNav-CommandBarButtonUser Says"]').click();
-    cy.get('[data-testid="LUEditor"]').within(() => {
-      cy.getAllByText('ToDoLuisBot.Main').should('exist');
-    });
-
-    cy.route('POST', '/api/projects/opened/luFiles/publish', 'fixture:luPublish/success').as('publish');
 
+    cy.route({
+      method: 'POST',
+      url: '/api/projects/opened/luFiles/publish',
+      status: 200,
+      response: 'fixture:luPublish/success',
+    });
     cy.getByText('Start Bot').click();
-    cy.get('[data-testid="ProjectNameInput"]').type('MyProject');
-    cy.get('[data-testid="EnvironmentInput"]').type('composer');
-    cy.get('[data-testid="AuthoringKeyInput"]').type('0d4991873f334685a9686d1b48e0ff48');
+    // clear its settings before
+    cy.get('[data-testid="ProjectNameInput"]')
+      .clear()
+      .type('MyProject');
+    cy.get('[data-testid="EnvironmentInput"]')
+      .clear()
+      .type('composer');
+    cy.get('[data-testid="AuthoringKeyInput"]')
+      .clear()
+      .type('0d4991873f334685a9686d1b48e0ff48');
+    // wait for the debounce interval of sync settings
+    cy.wait(1000);
     cy.getByText('Publish').click();
     cy.getByText('Restart Bot').should('exist');
     cy.getByText('Test in Emulator').should('exist');

Composer/packages/client/src/App.tsx

@@ -94,19 +94,13 @@ export const App: React.FC = () => {
   const { state, actions } = useContext(StoreContext);
   const [sideBarExpand, setSideBarExpand] = useState(false);
   const { botName, creationFlowStatus } = state;
-  const { fetchProject, setCreationFlowStatus, setLuisConfig } = actions;
+  const { fetchProject, setCreationFlowStatus } = actions;
   const mapNavItemTo = x => resolveToBasePath(BASEPATH, x);
 
   useEffect(() => {
     init();
   }, []);
 
-  useEffect(() => {
-    if (botName) {
-      setLuisConfig(botName);
-    }
-  }, [botName]);
-
   async function init() {
     await fetchProject();
   }

Composer/packages/client/src/CreationFlow/index.js

@@ -18,15 +18,7 @@ export function CreationFlow(props) {
   const [step, setStep] = useState();
   // eslint-disable-next-line react/prop-types
   const { creationFlowStatus, setCreationFlowStatus } = props;
-  const {
-    fetchTemplates,
-    getAllProjects,
-    openBotProject,
-    createProject,
-    saveProjectAs,
-    saveTemplateId,
-    setLuisConfig,
-  } = actions;
+  const { fetchTemplates, getAllProjects, openBotProject, createProject, saveProjectAs, saveTemplateId } = actions;
   const { botName, templateId } = state;
 
   useEffect(() => {
@@ -68,8 +60,7 @@ export function CreationFlow(props) {
   };
 
   const openBot = async botFolder => {
-    const { botName } = await openBotProject(botFolder);
-    await setLuisConfig(botName);
+    await openBotProject(botFolder);
     navigateTo('/dialogs/Main');
     handleDismiss();
   };
@@ -83,8 +74,7 @@ export function CreationFlow(props) {
   };
 
   const handleSaveAs = async formData => {
-    const { botName } = await saveProjectAs(formData.name, formData.description);
-    setLuisConfig(botName);
+    await saveProjectAs(formData.name, formData.description);
   };
 
   const handleSubmit = formData => {

Composer/packages/client/src/TestController.tsx

@@ -10,7 +10,6 @@ import {
 } from 'office-ui-fabric-react';
 import formatMessage from 'format-message';
 
-import LuisStorage from './utils/luisStorage';
 import { StoreContext } from './store';
 import { bot, botButton, calloutLabel, calloutDescription, calloutContainer } from './styles';
 import { LuisConfig, Text, BotStatus } from './constants';
@@ -19,7 +18,7 @@ import { OpenAlertModal, DialogStyle } from './components/Modal';
 import { getReferredFiles } from './utils/luUtil';
 import { DialogInfo } from './store/types';
 
-const openInEmulator = (url, authSettings) => {
+const openInEmulator = (url, authSettings: { MicrosoftAppId: string; MicrosoftAppPassword: string }) => {
   // this creates a temporary hidden iframe to fire off the bfemulator protocol
   // and start up the emulator
   const i = document.createElement('iframe');
@@ -45,8 +44,8 @@ export const TestController: React.FC = () => {
   const [error, setError] = useState({ title: '', message: '' });
   const [luisPublishSucceed, setLuisPublishSucceed] = useState(true);
   const botActionRef = useRef(null);
-  const { botName, botStatus, dialogs, oAuth, toStartBot, luFiles } = state;
-  const { connectBot, reloadBot, publishLuis, startBot, setLuisConfig } = actions;
+  const { botName, botStatus, dialogs, toStartBot, luFiles, settings } = state;
+  const { connectBot, reloadBot, publishLuis, startBot } = actions;
   const connected = botStatus === BotStatus.connected;
 
   useEffect(() => {
@@ -73,10 +72,10 @@ export const TestController: React.FC = () => {
       });
       return;
     }
-    const config = LuisStorage.get(botName);
+    const config = settings.luis;
 
     if (getReferredFiles(luFiles, dialogs).length > 0) {
-      if (!luisPublishSucceed || config[LuisConfig.AUTHORING_KEY] === '') {
+      if (!luisPublishSucceed || (config && config[LuisConfig.AUTHORING_KEY] === '')) {
         setModalOpen(true);
       } else {
         await publishAndReload();
@@ -98,9 +97,12 @@ export const TestController: React.FC = () => {
   async function handlePublish() {
     setFetchState(STATE.PUBLISHING);
     try {
-      await setLuisConfig(botName);
-      await publishLuis();
-      return true;
+      if (settings.luis) {
+        await publishLuis(settings.luis.authoringKey);
+        return true;
+      } else {
+        throw new Error('Please Set Luis Config');
+      }
     } catch (err) {
       setError({ title: Text.LUISDEPLOYFAILURE, message: err.message });
       setCalloutVisible(true);
@@ -113,7 +115,7 @@ export const TestController: React.FC = () => {
   async function handleLoadBot() {
     setFetchState(STATE.RELOADING);
     try {
-      await (connected ? reloadBot(botName) : connectBot(botName));
+      await (connected ? reloadBot(settings) : connectBot(settings));
     } catch (err) {
       setError({ title: Text.CONNECTBOTFAILURE, message: err.message });
       setCalloutVisible(true);
@@ -130,7 +132,14 @@ export const TestController: React.FC = () => {
             iconProps={{
               iconName: 'OpenInNewTab',
             }}
-            onClick={() => openInEmulator('http://localhost:3979/api/messages', oAuth)}
+            onClick={() =>
+              openInEmulator(
+                'http://localhost:3979/api/messages',
+                settings.MicrosoftAppId && settings.MicrosoftAppPassword
+                  ? { MicrosoftAppId: settings.MicrosoftAppId, MicrosoftAppPassword: settings.MicrosoftAppPassword }
+                  : { MicrosoftAppPassword: '', MicrosoftAppId: '' }
+              )
+            }
           >
             {formatMessage('Test in Emulator')}
           </ActionButton>

Composer/packages/client/src/constants/index.ts

@@ -75,7 +75,8 @@ export enum ActionTypes {
   CONNECT_BOT_FAILURE = 'CONNECT_BOT_FAILURE',
   RELOAD_BOT_SUCCESS = 'RELOAD_BOT_SUCCESS',
   RELOAD_BOT_FAILURE = 'RELOAD_BOT_FAILURE',
-  UPDATE_OAUTH = 'UPDATE_OAUTH',
+  UPDATE_ENV_SETTING = 'UPDATE_ENV_SETTING',
+  SYNC_ENV_SETTING = 'SYNC_ENV_SETTING',
   SET_ERROR = 'SET_ERROR',
   TO_START_BOT = 'TO_START_BOT',
   EDITOR_RESET_VISUAL = 'EDITOR_RESET_VISUAL',
@@ -190,3 +191,5 @@ export const SupportedFileTypes = [
   'xlsx',
   'xsn',
 ];
+
+export const SensitiveProperties = ['MicrosoftAppPassword', 'luis.authoringKey', 'luis.endpointKey'];