fix: unexpected file changes when editing (#2786)

* use cached projects

* don't need to call init after project loaded

* use a real-time refreshed files list, fix concurrency deletes

* update test

* create/saveAs/open project should call init

* clean up

* update

Co-authored-by: Chris Whitten <christopher.whitten@microsoft.com>
Co-authored-by: Ben Yackley <61990921+beyackle@users.noreply.github.com>
Co-authored-by: Andy Brown <asbrown002@gmail.com>

Composer/packages/server/__tests__/controllers/project.test.ts

@@ -159,15 +159,15 @@ describe('dialog operation', () => {
     const mockReq = {
       params: { projectId },
       query: {},
-      body: { name: 'test.dialog', content: '' },
+      body: { name: 'test2.dialog', content: '' },
     } as Request;
     await ProjectController.createFile(mockReq, mockRes);
     expect(mockRes.status).toHaveBeenCalledWith(200);
   });
 
   it('should remove dialog', async () => {
     const mockReq = {
-      params: { name: 'test.dialog', projectId },
+      params: { name: 'test2.dialog', projectId },
       query: {},
       body: {},
     } as Request;

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

@@ -80,7 +80,6 @@ async function getProjectById(req: Request, res: Response) {
     const currentProject = await BotProjectService.getProjectById(projectId, user);
 
     if (currentProject !== undefined && (await currentProject.exists())) {
-      await currentProject.init();
       const project = currentProject.getProject();
       res.status(200).json({
         id: projectId,

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

@@ -251,7 +251,7 @@ export class BotProject {
   };
 
   public deleteFile = async (name: string) => {
-    if (Path.resolve(name) === 'Main') {
+    if (Path.basename(name, '.dialog') === this.name) {
       throw new Error(`Main dialog can't be removed`);
     }
 
@@ -334,7 +334,7 @@ export class BotProject {
       try {
         await this.fileStorage.rmDir(folderPath);
       } catch (e) {
-        console.log(e);
+        // pass
       }
     }
   };
@@ -411,19 +411,19 @@ export class BotProject {
     if (index === -1) {
       throw new Error(`no such file at ${relativePath}`);
     }
+
     const absolutePath = `${this.dir}/${relativePath}`;
 
     // only write if the file has actually changed
     if (this.files[index].content !== content) {
+      this.files[index].content = content;
       await this.fileStorage.writeFile(absolutePath, content);
     }
 
     // TODO: we should get the lastModified from the writeFile operation
     // instead of calling stat again which could be expensive
     const stats = await this.fileStorage.stat(absolutePath);
 
-    this.files[index].content = content;
-
     return stats.lastModified;
   };
 
@@ -434,10 +434,10 @@ export class BotProject {
     if (index === -1) {
       throw new Error(`no such file at ${relativePath}`);
     }
+    this.files.splice(index, 1);
 
     const absolutePath = `${this.dir}/${relativePath}`;
     await this.fileStorage.removeFile(absolutePath);
-    this.files.splice(index, 1);
   };
 
   // ensure dir exist, dir is a absolute dir path

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

@@ -4,6 +4,7 @@
 import merge from 'lodash/merge';
 import find from 'lodash/find';
 import { importResolverGenerator, ResolverResource } from '@bfc/shared';
+import extractMemoryPaths from '@bfc/indexers/lib/dialogUtils/extractMemoryPaths';
 import { UserIdentity } from '@bfc/plugin-loader';
 
 import { BotProject } from '../models/bot/botProject';
@@ -35,7 +36,7 @@ export class BotProjectService {
 
   public static lgImportResolver(source: string, id: string, projectId: string): ResolverResource {
     BotProjectService.initialize();
-    const project = BotProjectService.currentBotProjects.find(({ id }) => id === projectId);
+    const project = BotProjectService.getIndexedProjectById(projectId);
     if (!project) throw new Error('project not found');
     const resource = project.files.reduce((result: ResolverResource[], file) => {
       const { name, content } = file;
@@ -50,7 +51,7 @@ export class BotProjectService {
 
   public static luImportResolver(source: string, id: string, projectId: string): ResolverResource {
     BotProjectService.initialize();
-    const project = BotProjectService.currentBotProjects.find(({ id }) => id === projectId);
+    const project = BotProjectService.getIndexedProjectById(projectId);
     if (!project) throw new Error('project not found');
     const resource = project.files.reduce((result: ResolverResource[], file) => {
       const { name, content } = file;
@@ -88,9 +89,13 @@ export class BotProjectService {
       'turn.repeatedIds',
       'turn.activityProcessed',
     ];
+    const projectVariables = BotProjectService.getIndexedProjectById(projectId)
+      ?.files.filter(file => file.name.endsWith('.dialog'))
+      .map(({ content }) => extractMemoryPaths(content));
+
     const userDefined: string[] =
-      BotProjectService.currentBotProjects[projectId]?.dialogs.reduce((result: string[], dialog) => {
-        result = [...dialog.userDefinedVariables, ...result];
+      projectVariables?.reduce((result: string[], variables) => {
+        result = [...variables, ...result];
         return result;
       }, []) || [];
     return [...defaultProperties, ...userDefined];
@@ -180,9 +185,18 @@ export class BotProjectService {
     Store.set('projectLocationMap', BotProjectService.projectLocationMap);
   };
 
-  public static getProjectById = async (projectId: string, user?: UserIdentity) => {
+  public static getIndexedProjectById(projectId): BotProject | undefined {
+    // use indexed project
+    const indexedCurrentProject = BotProjectService.currentBotProjects.find(({ id }) => id === projectId);
+    if (indexedCurrentProject) return indexedCurrentProject;
+  }
+
+  public static getProjectById = async (projectId: string, user?: UserIdentity): Promise<BotProject> => {
     BotProjectService.initialize();
 
+    const cachedProject = BotProjectService.getIndexedProjectById(projectId);
+    if (cachedProject) return cachedProject;
+
     if (!BotProjectService.projectLocationMap?.[projectId]) {
       throw new Error('project not found in cache');
     } else {