fix: lg files auto add placeholder for missing templates

Composer/packages/client/src/recoilModel/dispatchers/__tests__/lg.test.tsx

@@ -24,17 +24,19 @@ jest.mock('../../parsers/lgWorker', () => {
   return {
     parse: (projectId, id, content) => ({ id, content }),
     addTemplate: (projectId, lgFile, template) =>
-      filterParseResult(require('../../../utils/lgUtil').addTemplate(lgFile, template)),
+      filterParseResult(require('@bfc/indexers/lib/utils/lgUtil').addTemplate(lgFile, template)),
     addTemplates: (projectId, lgFile, templates) =>
-      filterParseResult(require('../../../utils/lgUtil').addTemplates(lgFile, templates)),
+      filterParseResult(require('@bfc/indexers/lib/utils/lgUtil').addTemplates(lgFile, templates)),
     updateTemplate: (projectId, lgFile, templateName, template) =>
-      filterParseResult(require('../../../utils/lgUtil').updateTemplate(lgFile, templateName, template)),
+      filterParseResult(require('@bfc/indexers/lib/utils/lgUtil').updateTemplate(lgFile, templateName, template)),
     removeTemplate: (projectId, lgFile, templateName) =>
-      filterParseResult(require('../../../utils/lgUtil').removeTemplate(lgFile, templateName)),
+      filterParseResult(require('@bfc/indexers/lib/utils/lgUtil').removeTemplate(lgFile, templateName)),
     removeTemplates: (projectId, lgFile, templateNames) =>
-      filterParseResult(require('../../../utils/lgUtil').removeTemplates(lgFile, templateNames)),
+      filterParseResult(require('@bfc/indexers/lib/utils/lgUtil').removeTemplates(lgFile, templateNames)),
     copyTemplate: (projectId, lgFile, fromTemplateName, toTemplateName) =>
-      filterParseResult(require('../../../utils/lgUtil').copyTemplate(lgFile, fromTemplateName, toTemplateName)),
+      filterParseResult(
+        require('@bfc/indexers/lib/utils/lgUtil').copyTemplate(lgFile, fromTemplateName, toTemplateName)
+      ),
   };
 });
 const lgFiles = [

Composer/packages/client/src/recoilModel/dispatchers/lg.ts

@@ -15,8 +15,8 @@ import LgWorker from './../parsers/lgWorker';
 import LgDiagnosticWorker from './../parsers/lgDiagnosticWorker';
 import { lgFileIdsState, lgFileState, localeState, settingsState } from './../atoms/botState';
 
-const templateIsNotEmpty = ({ name, body }) => {
-  return !!name && !!body;
+const templateIsNotEmpty = ({ name }) => {
+  return !!name;
 };
 
 // fill other locale lgFile new added template with '- '
@@ -230,7 +230,7 @@ export const lgDispatcher = () => {
 
         updateLgFiles(callbackHelpers, projectId, { updates: updatedFiles }, (current, changed) => {
           // compare to drop expired content already setted above.
-          return current?.content === changed?.content;
+          return current.id === id ? current?.content === changed?.content : true;
         });
 
         // if changes happen on common.lg, async re-parse all.

Composer/packages/client/src/recoilModel/dispatchers/utils/project.ts

@@ -20,6 +20,7 @@ import {
   SensitiveProperties,
   RootBotManagedProperties,
   defaultPublishConfig,
+  LgFile,
 } from '@bfc/shared';
 import formatMessage from 'format-message';
 import camelCase from 'lodash/camelCase';
@@ -83,10 +84,23 @@ import UndoHistory from '../../undo/undoHistory';
 import { logMessage, setError } from '../shared';
 import { setRootBotSettingState } from '../setting';
 import { lgFilesSelectorFamily } from '../../selectors/lg';
+import { createMissingLgTemplatesForDialogs } from '../../../utils/lgUtil';
 
 import { crossTrainConfigState } from './../../atoms/botState';
 import { recognizersSelectorFamily } from './../../selectors/recognizers';
 
+const repairBotProject = async (
+  callbackHelpers: CallbackInterface,
+  { projectId, botFiles }: { projectId: string; botFiles: any }
+) => {
+  const { set } = callbackHelpers;
+  const lgFiles: LgFile[] = botFiles.lgFiles;
+  const dialogs: DialogInfo[] = botFiles.dialogs;
+
+  const updatedLgFiles = await createMissingLgTemplatesForDialogs(projectId, dialogs, lgFiles);
+  set(lgFilesSelectorFamily(projectId), updatedLgFiles);
+};
+
 export const resetBotStates = async ({ reset }: CallbackInterface, projectId: string) => {
   const botStates = Object.keys(botstates);
   botStates.forEach((state) => {
@@ -401,6 +415,10 @@ export const initBotState = async (callbackHelpers: CallbackInterface, data: any
 
   set(filePersistenceState(projectId), new FilePersistence(projectId));
   set(undoHistoryState(projectId), new UndoHistory(projectId));
+
+  // async repair bot assets, add missing lg templates
+  repairBotProject(callbackHelpers, { projectId, botFiles });
+
   return mainDialog;
 };
 

Composer/packages/client/src/utils/lgUtil.ts

@@ -1,10 +1,45 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
+import { DialogInfo, LgFile, LgTemplate } from '@bfc/shared';
+import difference from 'lodash/difference';
+
+import lgWorker from '../recoilModel/parsers/lgWorker';
+
+import { getBaseName } from './fileUtil';
+
 /**
- * lgUtil.ts is a single place use lg-parser handle lg file operation.
- * it's designed have no state, input text file, output text file.
- *
+ * Auto create placeholder template used in dialog but did not exist in <dialog>.<*locale>.lg
  */
 
-export * from '@bfc/indexers/lib/utils/lgUtil';
+export const createMissingLgTemplatesForDialogs = async (
+  projectId: string,
+  dialogs: DialogInfo[],
+  lgFiles: LgFile[]
+): Promise<LgFile[]> => {
+  const updatedLgFiles: LgFile[] = [];
+
+  const templateNamesInDialog: Record<string, string[]> = dialogs.reduce((result, dialog: DialogInfo) => {
+    const { id, lgTemplates } = dialog;
+    result[id] = lgTemplates.map(({ name }) => name);
+    return result;
+  }, {});
+
+  for (const lgFile of lgFiles) {
+    const dialogId = getBaseName(lgFile.id);
+    const templatesShouldExist = templateNamesInDialog[dialogId];
+    const templatesInLgFile = lgFile.templates.map(({ name }) => name);
+    const templatesNotExist = difference(templatesShouldExist, templatesInLgFile);
+    if (templatesNotExist?.length) {
+      const templatesToAdd = templatesNotExist.map((name) => {
+        return { name, body: '-', parameters: [] } as LgTemplate;
+      });
+      const updatedFile = (await lgWorker.addTemplates(projectId, lgFile, templatesToAdd, lgFiles)) as LgFile;
+      updatedLgFiles.push(updatedFile);
+    } else {
+      updatedLgFiles.push(lgFile);
+    }
+  }
+
+  return updatedLgFiles;
+};