fix: localize qna maker dialog IDs

Fixes #3496
microsoft · Jan 8, 2021 · 60ebaa2 · 60ebaa2
1 parent 56ad92d
commit 60ebaa2
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 56 deletions.
diff --git a/...-bot-virtualassistant/generators/app/templates/sample-assistant/src/dialogs/mainDialog.ts b/...-bot-virtualassistant/generators/app/templates/sample-assistant/src/dialogs/mainDialog.ts
@@ -380,10 +380,20 @@ export class MainDialog extends ComponentDialog {
                 return await stepContext.beginDialog('faq');
             } else if (this.shouldBeginChitChatDialog(stepContext, dispatchIntent, dispatchScore)) {
                 DialogContextEx.suppressCompletionMessage(stepContext, true);
+
                 const knowledgebaseId = 'chitchat';
-                this.registerQnADialog(knowledgebaseId, localizedServices, stepContext.context.activity.locale as string);
+                const dialogId = [knowledgebaseId, stepContext.context.activity.locale].filter(a => a).join('.');
+
+                let qnaDialog: Dialog = this.dialogs.find(dialogId);
+                if (!qnaDialog) {
+                    qnaDialog = this.tryCreateQnADialog(knowledgebaseId, localizedServices);
+                    if (qnaDialog) {
+                        qnaDialog.id = dialogId;
+                        this.dialogs.add(qnaDialog);
+                    }
+                }
 
-                return await stepContext.beginDialog(knowledgebaseId);
+                return await stepContext.beginDialog(dialogId);
             } else {
                 DialogContextEx.suppressCompletionMessage(stepContext, true);
                 await stepContext.context.sendActivity(this.templateManager.generateActivityForLocale('UnsupportedMessage', userProfile));
@@ -404,32 +414,6 @@ export class MainDialog extends ComponentDialog {
         return await stepContext.replaceDialog(this.initialDialogId, this.templateManager.generateActivityForLocale('CompletedMessage'));
     }
 
-    private registerQnADialog(knowledgebaseId: string, cognitiveModels: ICognitiveModelSet, locale: string): void {
-        const qnaEndpoint: QnAMakerEndpoint | undefined = cognitiveModels.qnaConfiguration.get(knowledgebaseId);
-        if (qnaEndpoint == undefined){
-            throw new Error(`Could not find QnA Maker knowledge base configuration with id: ${ knowledgebaseId }.`);
-        }
-
-        if (this.dialogs.find(knowledgebaseId) == undefined) {
-            const qnaDialog: QnAMakerDialog = new QnAMakerDialog(
-                qnaEndpoint.knowledgeBaseId,
-                qnaEndpoint.endpointKey,
-                // The following line is a workaround until the method getQnAClient of QnAMakerDialog is fixed
-                // as per issue https://github.com/microsoft/botbuilder-js/issues/1885
-                new URL(qnaEndpoint.host).hostname.split('.')[0],
-                this.templateManager.generateActivityForLocale('UnsupportedMessage') as Activity,
-                // Before, instead of 'undefined' a '0.3' value was used in the following line
-                undefined,
-                this.templateManager.generateActivityForLocale('QnaMakerAdaptiveLearningCardTitle').text,
-                this.templateManager.generateActivityForLocale('QnaMakerNoMatchText').text
-            );
-
-            qnaDialog.id = knowledgebaseId;
-
-            this.addDialog(qnaDialog);
-        }
-    }
-
     private async logUserOut(dc: DialogContext): Promise<void> {
         const tokenProvider: BotFrameworkAdapter = dc.context.adapter as BotFrameworkAdapter;
         if (tokenProvider !== undefined) {

diff --git a/templates/typescript/samples/sample-assistant/src/dialogs/mainDialog.ts b/templates/typescript/samples/sample-assistant/src/dialogs/mainDialog.ts
@@ -40,6 +40,7 @@ import { BotServices } from '../services/botServices';
 import { IBotSettings } from '../services/botSettings';
 import { StateProperties } from '../models/stateProperties';
 import { OnboardingDialog } from './onboardingDialog';
+import { QnaMakerService } from 'botframework-config';
 
 /**
  * Dialog providing activity routing and message/event processing.
@@ -380,10 +381,20 @@ export class MainDialog extends ComponentDialog {
                 return await stepContext.beginDialog('faq');
             } else if (this.shouldBeginChitChatDialog(stepContext, dispatchIntent, dispatchScore)) {
                 DialogContextEx.suppressCompletionMessage(stepContext, true);
+
                 const knowledgebaseId = 'chitchat';
-                this.registerQnADialog(knowledgebaseId, localizedServices, stepContext.context.activity.locale as string);
+                const dialogId = [knowledgebaseId, stepContext.context.activity.locale].filter(a => a).join('.');
+
+                let qnaDialog: Dialog = this.dialogs.find(dialogId);
+                if (!qnaDialog) {
+                    qnaDialog = this.tryCreateQnADialog(knowledgebaseId, localizedServices);
+                    if (qnaDialog) {
+                        qnaDialog.id = dialogId;
+                        this.dialogs.add(qnaDialog);
+                    }
+                }
 
-                return await stepContext.beginDialog(knowledgebaseId);
+                return await stepContext.beginDialog(dialogId);
             } else {
                 DialogContextEx.suppressCompletionMessage(stepContext, true);
                 await stepContext.context.sendActivity(this.templateManager.generateActivityForLocale('UnsupportedMessage', userProfile));
@@ -404,32 +415,6 @@ export class MainDialog extends ComponentDialog {
         return await stepContext.replaceDialog(this.initialDialogId, this.templateManager.generateActivityForLocale('CompletedMessage'));
     }
 
-    private registerQnADialog(knowledgebaseId: string, cognitiveModels: ICognitiveModelSet, locale: string): void {
-        const qnaEndpoint: QnAMakerEndpoint | undefined = cognitiveModels.qnaConfiguration.get(knowledgebaseId);
-        if (qnaEndpoint == undefined){
-            throw new Error(`Could not find QnA Maker knowledge base configuration with id: ${ knowledgebaseId }.`);
-        }
-
-        if (this.dialogs.find(knowledgebaseId) == undefined) {
-            const qnaDialog: QnAMakerDialog = new QnAMakerDialog(
-                qnaEndpoint.knowledgeBaseId,
-                qnaEndpoint.endpointKey,
-                // The following line is a workaround until the method getQnAClient of QnAMakerDialog is fixed
-                // as per issue https://github.com/microsoft/botbuilder-js/issues/1885
-                new URL(qnaEndpoint.host).hostname.split('.')[0],
-                this.templateManager.generateActivityForLocale('UnsupportedMessage') as Activity,
-                // Before, instead of 'undefined' a '0.3' value was used in the following line
-                undefined,
-                this.templateManager.generateActivityForLocale('QnaMakerAdaptiveLearningCardTitle').text,
-                this.templateManager.generateActivityForLocale('QnaMakerNoMatchText').text
-            );
-
-            qnaDialog.id = knowledgebaseId;
-
-            this.addDialog(qnaDialog);
-        }
-    }
-
     private async logUserOut(dc: DialogContext): Promise<void> {
         const tokenProvider: BotFrameworkAdapter = dc.context.adapter as BotFrameworkAdapter;
         if (tokenProvider !== undefined) {