Flatten QnaMaker config settings (#264)

* Flatten config file

* Refactor to key storing in config

Author: munozemilio

packages/config/src/commands/config/set/qnamaker.ts

@@ -54,12 +54,7 @@ export default class ConfigSetQnamaker extends Command {
   }
 
   setValue(key: string, value: string, userConfig: Config) {
-    let qnamaker = userConfig.qnamaker
-    if (!qnamaker) {
-      userConfig.qnamaker = {}
-    }
-
-    userConfig.qnamaker[key] = value
+    userConfig['qnamaker__' + key] = value
     this.log(`${key} set to ${value}`)
   }
 }

packages/config/src/commands/config/show/qnamaker.ts

@@ -15,6 +15,12 @@ export default class ConfigShowQnamaker extends Command {
 
   async run() {
     const userConfig: Config = await getConfigFile(this.config.configDir)
-    this.log(JSON.stringify(userConfig.qnamaker, null, 2))
+    let qnaMaker: any = {}
+    Object.keys(userConfig).forEach((key: string) => {
+      if (key.startsWith('qnamaker__')) {
+        qnaMaker[key] = userConfig[key]
+      }
+    })
+    this.log(JSON.stringify(qnaMaker, null, 2))
   }
 }

packages/config/test/commands/config/set/qnamaker.test.ts

@@ -16,31 +16,31 @@ describe('config:set:qnamaker', () => {
       .command(['config:set:qnamaker', '--kbId', 'aaaaaaaa'])
       .it('Sets kbid in config file', async ctx => {
         let config = await fs.readJSON(getConfigFile())
-        expect(config.qnamaker.kbId).to.contain('aaaaaaaa')
+        expect(config.qnamaker__kbId).to.contain('aaaaaaaa')
     })
 
     test
       .stdout()
       .command(['config:set:qnamaker', '--subscriptionKey', 'aaaaaaaa'])
       .it('Sets subscriptionkey in config file', async ctx => {
         let config = await fs.readJSON(getConfigFile())
-        expect(config.qnamaker.subscriptionKey).to.contain('aaaaaaaa')
+        expect(config.qnamaker__subscriptionKey).to.contain('aaaaaaaa')
     })
 
     test
     .stdout()
     .command(['config:set:qnamaker', '--endpointKey', 'aaaaaaaa'])
     .it('Sets endpointKey in config file', async ctx => {
       let config = await fs.readJSON(getConfigFile())
-      expect(config.qnamaker.subscriptionKey).to.contain('aaaaaaaa')
+      expect(config.qnamaker__endpointKey).to.contain('aaaaaaaa')
     })
 
     test
     .stdout()
     .command(['config:set:qnamaker', '--hostname', 'aaaaaaaa'])
     .it('Sets hostname in config file', async ctx => {
       let config = await fs.readJSON(getConfigFile())
-      expect(config.qnamaker.subscriptionKey).to.contain('aaaaaaaa')
+      expect(config.qnamaker__hostname).to.contain('aaaaaaaa')
     })
 
     test
@@ -62,7 +62,7 @@ describe('config:set:qnamaker empty config file', () => {
     .command(['config:set:qnamaker', '--kbId', 'aaaaaaaa'])
     .it('Sets kbid in config file', async ctx => {
       let config = await fs.readJSON(getConfigFile())
-      expect(config.qnamaker.kbId).to.contain('aaaaaaaa')
+      expect(config.qnamaker__kbId).to.contain('aaaaaaaa')
   })
 })
 

packages/config/test/commands/config/show.test.ts

@@ -14,7 +14,7 @@ describe('config:show', () => {
       .stdout()
       .command(['config:show'])
       .it('Displays config file data', ctx => {
-        expect(ctx.stdout).to.contain('"subscriptionKey": "222222cccccctttttth223kk3k33"')
+        expect(ctx.stdout).to.contain('"qnamaker__subscriptionKey": "222222cccccctttttth223kk3k33"')
     })
 })
 

packages/config/test/commands/config/show/qnamaker.test.ts

@@ -14,6 +14,6 @@ describe('config:show:qnamaker', () => {
       .stdout()
       .command(['config:show:qnamaker'])
       .it('Displays config file qnamaker data', ctx => {
-        expect(ctx.stdout).to.contain('"subscriptionKey": "222222cccccctttttth223kk3k33",\n  "hostname": "https://somehost.net",\n ')
+        expect(ctx.stdout).to.contain('"qnamaker__subscriptionKey": "222222cccccctttttth223kk3k33",\n  "qnamaker__hostname": "https://somehost.net",\n ')
     })
 })

packages/config/test/configfilehelper.ts

@@ -24,12 +24,10 @@ const configFile = path.join(pathToConfigJson, 'config.json')
 export async function initTestConfigFile() {
   const config = {
     telemetry:true,
-    qnamaker: {
-      subscriptionKey: "222222cccccctttttth223kk3k33",
-      hostname: "https://somehost.net",
-      endpointKey: "xxxxxxxxxxxxxxxxxxx",
-      kbId: "xxxxxxxxxxxxxxxxxxxxxxx"
-    }
+    qnamaker__subscriptionKey: "222222cccccctttttth223kk3k33",
+    qnamaker__hostname: "https://somehost.net",
+    qnamaker__endpointKey: "xxxxxxxxxxxxxxxxxxx",
+    qnamaker__kbId: "xxxxxxxxxxxxxxxxxxxxxxx"
   }
 
   await fs.mkdirp(pathToConfigJson)

packages/qnamaker/src/commands/qnamaker/init.ts

@@ -4,13 +4,12 @@
  */
 
 import {Command, flags} from '@microsoft/bf-cli-command'
+import {updateQnAMakerConfig} from '../../utils/qnamakerbase'
 import cli from 'cli-ux'
 
 const Knowledgebase = require('./../../../utils/api/knowledgebase')
 const Endpointkeys = require('./../../../utils/api/endpointkeys')
 const chalk = require('chalk')
-const fs = require('fs-extra')
-const path = require('path')
 
 export default class QnamakerInit extends Command {
   static description = 'Initializes the config file with settings.'
@@ -45,7 +44,7 @@ export default class QnamakerInit extends Command {
 
     let [subscriptionKey, kbId] = answers
     /* tslint:disable: prefer-object-spread */
-    const config = Object.assign({}, {subscriptionKey, kbId, endpoint})
+    const config = Object.assign({}, {subscriptionKey, kbId, endpoint, endpointKey: '', hostname: ''})
 
     if (subscriptionKey && kbId) {
       cli.action.start('Updating config file hostname and endpoint key')
@@ -63,15 +62,7 @@ export default class QnamakerInit extends Command {
     }
 
     if (confirmation) {
-      let userConfig: any = {}
-      if (fs.existsSync(path.join(this.config.configDir, 'config.json'))) {
-        userConfig = await fs.readJSON(path.join(this.config.configDir, 'config.json'))
-      } else {
-        await fs.mkdirp(this.config.configDir)
-      }
-
-      userConfig.qnamaker = config
-      await fs.writeJson(path.join(this.config.configDir, 'config.json'), userConfig, {spaces: 2})
+      await updateQnAMakerConfig(config, this.config.configDir)
     }
     return confirmation
   }

packages/qnamaker/src/commands/qnamaker/kb/create.ts

@@ -11,11 +11,9 @@ const Knowledgebase = require('./../../../../utils/api/knowledgebase')
 const Endpointkeys = require('./../../../../utils/api/endpointkeys')
 const createKbJSON = require('./../../../../utils/payloads/createKb')
 
-const fs = require('fs-extra')
-const path = require('path')
 const readlineSync = require('readline-sync')
 
-import {Inputs, processInputs} from '../../../utils/qnamakerbase'
+import {Inputs, processInputs, updateQnAMakerConfig} from '../../../utils/qnamakerbase'
 
 export default class QnamakerKbCreate extends Command {
   static description = 'Creates a new knowledgebase'
@@ -66,18 +64,7 @@ export default class QnamakerKbCreate extends Command {
     if (flags.save) {
       input.config.kbId = kbId
       await this.updateKbId(input.config)
-      let userConfig: any = {}
-
-      if (fs.existsSync(path.join(this.config.configDir, 'config.json'))) {
-        userConfig = await fs.readJSON(path.join(this.config.configDir, 'config.json'))
-      } else {
-        await fs.mkdirp(this.config.configDir)
-      }
-
-      delete input.config.endpoint
-
-      userConfig.qnamaker = input.config
-      await fs.writeJson(path.join(this.config.configDir, 'config.json'), userConfig, {spaces: 2})
+      await updateQnAMakerConfig(input.config, this.config.configDir)
     } else {
       this.log(JSON.stringify({kbId}, null, 2))
     }

packages/qnamaker/src/utils/qnamakerbase.ts

@@ -40,6 +40,20 @@ export async function getFileInput(file: string) {
   return body
 }
 
+export async function updateQnAMakerConfig(config: any , configfile: string) {
+  let userConfig: any = {}
+  if (fs.existsSync(path.join(configfile, 'config.json'))) {
+    userConfig = await fs.readJSON(path.join(configfile, 'config.json'))
+  } else {
+    await fs.mkdirp(configfile)
+  }
+  userConfig.qnamaker__subscriptionKey = config.subscriptionKey ? config.subscriptionKey : userConfig.qnamaker__subscriptionKey
+  userConfig.qnamaker__kbId = config.kbId ? config.kbId : userConfig.qnamaker__kbId
+  userConfig.qnamaker__endpointKey = config.endpointKey ? config.endpointKey : userConfig.qnamaker__endpointKey
+  userConfig.qnamaker__hostname = config.hostname ? config.hostname : userConfig.qnamaker__hostname
+  await fs.writeJson(path.join(configfile, 'config.json'), userConfig, {spaces: 2})
+}
+
 export interface Inputs {
   [key: string]: any
 }

packages/qnamaker/test/commands/qnamaker/init.test.ts

@@ -48,7 +48,7 @@ describe('qnamaker:init', () => {
     .command(['qnamaker:init'])
     .do(async output => {
       let config = await fs.readJSON(getConfigFile())
-      expect(config.qnamaker.subscriptionKey).to.contain('abcdefg')
+      expect(config.qnamaker__subscriptionKey).to.contain('abcdefg')
     })
     .it('Creates .qna.rc file')
 })