feat: detect "old" bots and migrate them to new runtime

Composer/packages/client/src/components/CreationFlow/v2/CreationFlow.tsx

@@ -18,6 +18,7 @@ import {
   userSettingsState,
   templateProjectsState,
 } from '../../../recoilModel';
+import { localBotsDataSelector } from '../../../recoilModel/selectors/project';
 import Home from '../../../pages/home/Home';
 import { useProjectIdCache } from '../../../utils/hooks';
 import { ImportModal } from '../../ImportModal/ImportModal';
@@ -42,6 +43,7 @@ const CreationFlowV2: React.FC<CreationFlowProps> = () => {
     fetchRecentProjects,
     openProject,
     saveProjectAs,
+    migrateProjectTo,
     fetchProjectById,
     createNewBotV2,
     fetchReadMe,
@@ -51,6 +53,8 @@ const CreationFlowV2: React.FC<CreationFlowProps> = () => {
   const creationFlowStatus = useRecoilValue(creationFlowStatusState);
   const projectId = useRecoilValue(currentProjectIdState);
   const storages = useRecoilValue(storagesState);
+  const botProjects = useRecoilValue(localBotsDataSelector);
+  const botProject = botProjects.find((b) => b.projectId === projectId);
   const focusedStorageFolder = useRecoilValue(focusedStorageFolderState);
   const { appLocale } = useRecoilValue(userSettingsState);
   const cachedProjectId = useProjectIdCache();
@@ -146,13 +150,21 @@ const CreationFlowV2: React.FC<CreationFlowProps> = () => {
     saveProjectAs(projectId, formData.name, formData.description, formData.location);
   };
 
+  const handleMigrate = (formData) => {
+    handleDismiss();
+    setCreationFlowStatus(CreationFlowStatus.MIGRATE);
+    migrateProjectTo(projectId, formData.name, formData.description, formData.location);
+  };
+
   const handleSubmit = async (formData, templateId: string) => {
     handleDismiss();
     switch (creationFlowStatus) {
       case CreationFlowStatus.SAVEAS:
         handleSaveAs(formData);
         break;
-
+      case CreationFlowStatus.MIGRATE:
+        handleMigrate(formData);
+        break;
       default:
         saveTemplateId(templateId);
         await handleCreateNew(formData, templateId);
@@ -205,6 +217,16 @@ const CreationFlowV2: React.FC<CreationFlowProps> = () => {
           onDismiss={handleDismiss}
           onOpen={openBot}
         />
+        <DefineConversationV2
+          createFolder={createFolder}
+          focusedStorageFolder={focusedStorageFolder}
+          path="migrate/:projectId"
+          templateId={botProject?.name || 'migrated_project'} // templateId is used for default project name
+          updateFolder={updateFolder}
+          onCurrentPathUpdate={updateCurrentPath}
+          onDismiss={handleDismiss}
+          onSubmit={handleMigrate}
+        />
         <ImportModal path="import" />
       </Router>
     </Fragment>

Composer/packages/client/src/components/CreationFlow/v2/DefineConversation.tsx

@@ -96,6 +96,7 @@ type DefineConversationProps = {
   focusedStorageFolder: StorageFolder;
 } & RouteComponentProps<{
   templateId: string;
+  defaultName: string;
   location: string;
 }>;
 

Composer/packages/client/src/constants.ts

@@ -133,6 +133,7 @@ export enum CreationFlowStatus {
   NEW_FROM_SCRATCH = 'Scratch',
   NEW_FROM_TEMPLATE = 'Template',
   SAVEAS = 'Save as',
+  MIGRATE = 'Migrate',
   OPEN = 'Open',
   CLOSE = 'Close',
 }

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

@@ -5,6 +5,7 @@
 import formatMessage from 'format-message';
 import findIndex from 'lodash/findIndex';
 import { QnABotTemplateId, RootBotManagedProperties } from '@bfc/shared';
+import { OpenConfirmModal } from '@bfc/ui-shared';
 import get from 'lodash/get';
 import { CallbackInterface, useRecoilCallback } from 'recoil';
 
@@ -59,6 +60,7 @@ import {
   removeRecentProject,
   resetBotStates,
   saveProject,
+  migrateToV2,
 } from './utils/project';
 
 export const projectDispatcher = () => {
@@ -225,7 +227,28 @@ export const projectDispatcher = () => {
         set(botOpeningState, true);
 
         await flushExistingTasks(callbackHelpers);
-        const { projectId, mainDialog } = await openRootBotAndSkillsByPath(callbackHelpers, path, storageId);
+        const { projectId, mainDialog, requiresMigrate } = await openRootBotAndSkillsByPath(
+          callbackHelpers,
+          path,
+          storageId
+        );
+
+        if (requiresMigrate) {
+          if (
+            await OpenConfirmModal(
+              formatMessage('Convert your project to the latest format'),
+              formatMessage(
+                'This project was created in an older version of Composer. To open this project in Composer 2.0, we must copy your project and convert it to the latest format. Your original project will not be changed.'
+              ),
+              { confirmText: formatMessage('Convert') }
+            )
+          ) {
+            navigateTo(`/v2/projects/migrate/${projectId}`);
+          } else {
+            navigateTo(`/home`);
+          }
+          return;
+        }
 
         // ABS open Flow, update publishProfile & set alias for project after open project
         if (absData) {
@@ -281,8 +304,23 @@ export const projectDispatcher = () => {
     try {
       await flushExistingTasks(callbackHelpers);
       set(botOpeningState, true);
-      await openRootBotAndSkillsByProjectId(callbackHelpers, projectId);
-
+      const { requiresMigrate } = await openRootBotAndSkillsByProjectId(callbackHelpers, projectId);
+      if (requiresMigrate) {
+        if (
+          await OpenConfirmModal(
+            formatMessage('Convert your project to the latest format'),
+            formatMessage(
+              'This project was created in an older version of Composer. To open this project in Composer 2.0, we must copy your project and convert it to the latest format. Your original project will not be changed.'
+            ),
+            { confirmText: formatMessage('Convert') }
+          )
+        ) {
+          navigateTo(`/v2/projects/migrate/${projectId}`);
+        } else {
+          navigateTo(`/home`);
+        }
+        return;
+      }
       // Post project creation
       set(projectMetaDataState(projectId), {
         isRootBot: true,
@@ -444,6 +482,27 @@ export const projectDispatcher = () => {
     }
   );
 
+  const migrateProjectTo = useRecoilCallback(
+    (callbackHelpers: CallbackInterface) => async (oldProjectId, name, description, location) => {
+      const { set, snapshot } = callbackHelpers;
+      try {
+        const dispatcher = await snapshot.getPromise(dispatcherState);
+        set(botOpeningState, true);
+
+        // starts the creation process and stores the jobID in state for tracking
+        const response = await migrateToV2(callbackHelpers, oldProjectId, name, description, location);
+
+        if (response.data.jobId) {
+          dispatcher.updateCreationMessage(response.data.jobId, '', '', '', '');
+        }
+      } catch (ex) {
+        set(botProjectIdsState, []);
+        handleProjectFailure(callbackHelpers, ex);
+        navigateTo('/home');
+      }
+    }
+  );
+
   const deleteBot = useRecoilCallback((callbackHelpers: CallbackInterface) => async (projectId: string) => {
     try {
       const { reset } = callbackHelpers;
@@ -611,6 +670,7 @@ export const projectDispatcher = () => {
     createNewBotV2,
     deleteBot,
     saveProjectAs,
+    migrateProjectTo,
     fetchProjectById,
     fetchRecentProjects,
     setBotStatus,

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

@@ -434,6 +434,10 @@ export const initQnaFilesStatus = (projectId: string, qnaFiles: QnAFile[], dialo
   return updateQnaFilesStatus(projectId, qnaFiles);
 };
 
+export const isAdaptiveRuntime = (settings): boolean => {
+  return settings?.runtime?.key?.match(/^adaptive-runtime/) ? true : false;
+};
+
 export const initBotState = async (callbackHelpers: CallbackInterface, data: any, botFiles: any) => {
   const { set } = callbackHelpers;
   const { botName, botEnvironment, location, schemas, settings, id: projectId, diagnostics } = data;
@@ -450,7 +454,6 @@ export const initBotState = async (callbackHelpers: CallbackInterface, data: any
     recognizers,
     crossTrainConfig,
   } = botFiles;
-
   const storedLocale = languageStorage.get(botName)?.locale;
   const locale = settings.languages.includes(storedLocale) ? storedLocale : settings.defaultLanguage;
   languageStorage.setLocale(botName, locale);
@@ -573,6 +576,7 @@ export const openLocalSkill = async (callbackHelpers, pathToBot: string, storage
   if (error) {
     throw error;
   }
+
   const mainDialog = await initBotState(callbackHelpers, projectData, botFiles);
   set(projectMetaDataState(projectData.id), {
     isRootBot: false,
@@ -622,7 +626,6 @@ export const createNewBotFromTemplate = async (
   }
   const currentBotProjectFileIndexed: BotProjectFile = botFiles.botProjectSpaceFiles[0];
   set(botProjectFileState(projectId), currentBotProjectFileIndexed);
-
   const mainDialog = await initBotState(callbackHelpers, projectData, botFiles);
   // if create from QnATemplate, continue creation flow.
   if (templateId === QnABotTemplateId) {
@@ -664,6 +667,23 @@ export const createNewBotFromTemplateV2 = async (
   return jobId;
 };
 
+export const migrateToV2 = async (
+  callbackHelpers,
+  oldProjectId: string,
+  name: string,
+  description: string,
+  location: string
+) => {
+  const jobId = await httpClient.post(`/v2/projects/migrate`, {
+    storageId: 'default',
+    oldProjectId,
+    name,
+    description,
+    location,
+  });
+  return jobId;
+};
+
 const addProjectToBotProjectSpace = (set, projectId: string, skillCt: number) => {
   let isBotProjectLoaded = false;
   set(botProjectIdsState, (current: string[]) => {
@@ -777,6 +797,7 @@ export const openRootBotAndSkills = async (callbackHelpers: CallbackInterface, d
   return {
     mainDialog,
     projectId: rootBotProjectId,
+    requiresMigrate: !isAdaptiveRuntime(botFiles.mergedSettings),
   };
 };
 
@@ -832,6 +853,7 @@ export const openRootBotAndSkillsByProjectId = async (callbackHelpers: CallbackI
   if (data.error) {
     throw data.error;
   }
+
   return await openRootBotAndSkills(callbackHelpers, data);
 };
 

Composer/packages/server/src/controllers/project.ts

@@ -554,6 +554,14 @@ function createProjectV2(req: Request, res: Response) {
   });
 }
 
+function migrateProject(req: Request, res: Response) {
+  const jobId = BackgroundProcessManager.startProcess(202, 'create', 'Migrating Bot Project');
+  BotProjectService.migrateProjectAsync(req, jobId);
+  res.status(202).json({
+    jobId: jobId,
+  });
+}
+
 async function getVariablesByProjectId(req: Request, res: Response) {
   const projectId = req.params.projectId;
   const user = await ExtensionContext.getUserFromRequest(req);
@@ -588,6 +596,7 @@ export const ProjectController = {
   saveProjectAs,
   createProject,
   createProjectV2,
+  migrateProject,
   getAllProjects,
   getRecentProjects,
   updateBoilerplate,

Composer/packages/server/src/models/bot/botProject.ts

@@ -464,6 +464,27 @@ export class BotProject implements IBotProject {
     return await this._createFile(relativePath, content);
   };
 
+  public migrateFile = async (name: string, content = '', rootDialogId) => {
+    const filename = name.trim();
+    this.validateFileName(filename);
+    this._validateFileContent(name, content);
+    const botName = this.name;
+    const defaultLocale = this.settings?.defaultLanguage || defaultLanguage;
+
+    // find created file belong to which dialog, all resources should be writed to <dialog>/
+    const dialogId = name.split('.')[0];
+    const dialogFile = this.files.get(`${dialogId}.dialog`);
+    const endpoint = dialogFile ? Path.dirname(dialogFile.relativePath) : '';
+
+    const relativePath = defaultFilePath(botName, defaultLocale, filename, { endpoint, rootDialogId });
+    const file = this.files.get(filename);
+    if (file) {
+      throw new Error(`${filename} dialog already exist`);
+    }
+
+    return await this._createFile(relativePath, content);
+  };
+
   public createFiles = async (files) => {
     const createdFiles: FileInfo[] = [];
     for (const { name, content } of files) {

Composer/packages/server/src/models/bot/botStructure.ts

@@ -54,7 +54,6 @@ const parseSourceFileName = (name: string) => {
   } else {
     fileId = id;
   }
-
   return { fileId, dialogId, fileType, locale };
 };
 
@@ -159,6 +158,12 @@ export const defaultFilePath = (
     });
   }
 
+  if (fileType === FileExtensions.BotProject) {
+    return templateInterpolate(BotStructureTemplate.botProject, {
+      BOTNAME: rootDialogId,
+    });
+  }
+
   if (fileType === FileExtensions.FormDialogSchema) {
     return templateInterpolate(BotStructureTemplate.formDialogs, {
       FORMDIALOGNAME: filename,
@@ -173,7 +178,7 @@ export const defaultFilePath = (
   }
 
   const DIALOGNAME = dialogId;
-  const isRootFile = BOTNAME === DIALOGNAME.toLowerCase();
+  const isRootFile = BOTNAME === DIALOGNAME.toLowerCase() || rootDialogId.toLowerCase() === DIALOGNAME.toLowerCase();
 
   if (fileType === `.source.${locale}.qna`) {
     if (endpoint) {

Composer/packages/server/src/router/api.ts

@@ -27,6 +27,7 @@ import { UtilitiesController } from './../controllers/utilities';
 const router: Router = express.Router({});
 
 router.post('/projects', ProjectController.createProject);
+router.post('/v2/projects/migrate', ProjectController.migrateProject);
 router.post('/v2/projects', ProjectController.createProjectV2);
 router.get('/projects', ProjectController.getAllProjects);
 router.get('/projects/recent', ProjectController.getRecentProjects);