Adding '--wait' flag to luis:train:run' to print completion status (#511)

JSpru · web-flow · commit 2de55d9108da · 2020-01-31T10:17:47.000-08:00
* Adding '--wait' flag to luis:train:run' to print completion status

* Use string template instead of operator
diff --git a/packages/luis/src/commands/luis/train/run.ts b/packages/luis/src/commands/luis/train/run.ts
@@ -20,14 +20,15 @@ export default class LuisTrainRun extends Command {
     subscriptionKey: flags.string({description: '(required) LUIS cognitive services subscription key (default: config:LUIS:subscriptionKey)'}),
     appId: flags.string({description: '(required) LUIS application Id (defaults to config:LUIS:appId)'}),
     versionId: flags.string({description: '(required) Version to show training status (defaults to config:LUIS:versionId)'}),
+    wait: flags.boolean({description: 'Wait until training complete and then display status'}),
   }
 
   async run() {
     const {flags} = this.parse(LuisTrainRun)
     const flagLabels = Object.keys(LuisTrainRun.flags)
     const configDir = this.config.configDir
 
-    let {endpoint, subscriptionKey, appId, versionId} = await utils.processInputs(flags, flagLabels, configDir)
+    let {endpoint, subscriptionKey, appId, versionId, wait} = await utils.processInputs(flags, flagLabels, configDir)
 
     const requiredProps = {endpoint, subscriptionKey, appId, versionId}
     utils.validateRequiredProps(requiredProps)
@@ -40,9 +41,43 @@ export default class LuisTrainRun extends Command {
         await utils.writeToConsole(trainingRequestStatus)
         this.log('\nTraining request successfully issued')
       }
+      if (wait) {
+        this.log('checking training status...')
+        return this.checkTrainingStatus(client, appId, versionId)
+      }
     } catch (err) {
       throw new CLIError(`Failed to issue training request: ${err}`)
     }
   }
 
+  timeout(ms: number) {
+    // tslint:disable-next-line no-string-based-set-timeout
+    return new Promise((resolve: any) => setTimeout(resolve, ms))
+  }
+
+  async checkTrainingStatus(client: any, appId: string, versionId: string) {
+    try {
+      const trainingStatusData = await client.train.getStatus(appId, versionId)
+      const inProgress = trainingStatusData.filter((model: any) => {
+        if (model.details && model.details.status) {
+          return model.details.status === 'InProgress' || model.details.status === 'Queued'
+        }
+      })
+      if (inProgress.length > 0) {
+        await this.timeout(1000)
+        await this.checkTrainingStatus(client, appId, versionId)
+      } else {
+        let completionMssg = ''
+        trainingStatusData.map((model: any) => {
+          if (model.details && model.details.status && model.details.status === 'Fail') {
+            completionMssg += `Training failed for model id ${model.modelId}. Failure reason: ${model.details.failureReason}\n`
+          }
+        })
+        this.log(`${completionMssg} Training is complete`)
+      }
+    } catch (err) {
+      throw new CLIError(err)
+    }
+  }
+
 }
diff --git a/packages/luis/test/commands/luis/train/run.test.ts b/packages/luis/test/commands/luis/train/run.test.ts
@@ -23,24 +23,34 @@ describe('luis:train:run', () => {
   })
 
   test
+  .nock('https://westus.api.cognitive.microsoft.com', api => api
+  .post(uri => uri.includes('train'))
+  .reply(202, {"statusId": 2,"status": "UpToDate"})
+  )
   .stdout()
-  .stderr()
-  .command(['luis:train:run', '--appId', uuidv1(), '--endpoint', 'https://westus.api.cognitive.microsoft.com',  '--versionId', '0.1'])
-  .it('displays an error if any required input parameters are missing', ctx => {
-    expect(ctx.stderr).to.contain(`Required input property 'subscriptionKey' missing.`)
+  .command(['luis:train:run', '--appId', uuidv1(), '--versionId', '0.1', '--subscriptionKey', uuidv1(), '--endpoint', 'https://westus.api.cognitive.microsoft.com'])
+  .it('issues an asynchronous training request and reports when complete', ctx => {
+    expect(ctx.stdout).to.contain('Training request successfully issued')
   })
 
   test
   .nock('https://westus.api.cognitive.microsoft.com', api => api
+  .get(uri => uri.includes('train'))
+  .reply(202, [{
+    "modelId": "99999",
+    "details": {
+      "statusId": 0,
+      "status": "Success"
+    }
+  }])
   .post(uri => uri.includes('train'))
   .reply(202, {"statusId": 2,"status": "UpToDate"})
   )
   .stdout()
-  .command(['luis:train:run', '--appId', uuidv1(), '--versionId', '0.1', '--subscriptionKey', uuidv1(), '--endpoint', 'https://westus.api.cognitive.microsoft.com'])
-  .it('issues an asynchronous training request', ctx => {
+  .command(['luis:train:run', '--appId', uuidv1(), '--versionId', '0.1', '--subscriptionKey', uuidv1(), '--endpoint', 'https://westus.api.cognitive.microsoft.com', '--wait'])
+  .it('issues an asynchronous training request and reports when complete', ctx => {
     expect(ctx.stdout).to.contain('Training request successfully issued')
-    expect(ctx.stdout).to.contain('statusId')
-    expect(ctx.stdout).to.contain('status')
+    expect(ctx.stdout).to.contain('checking training status...')
   })
 
 })
