feat: Added new flow for saving import to file

Author: kevinwang5658

new.codify.json

@@ -0,0 +1 @@
+[]

src/entities/plan.test.ts

@@ -14,7 +14,7 @@ describe('Unit tests for Plan entity', () => {
         new ResourceConfig({ type: 'type2', dependsOn: ['type1'] }),
         new ResourceConfig({ type: 'type3', dependsOn: ['type1', 'type2']}),
       ],
-      './somewhere',
+      ['codify.json']
     );
 
     project.resolveDependenciesAndCalculateEvalOrder()

src/orchestrators/import.ts

@@ -1,10 +1,13 @@
+import path from 'node:path';
+
 import { Project } from '../entities/project.js';
 import { ResourceConfig } from '../entities/resource-config.js';
 import { ResourceInfo } from '../entities/resource-info.js';
 import { ProcessName, SubProcessName, ctx } from '../events/context.js';
 import { CodifyParser } from '../parser/index.js';
 import { DependencyMap, PluginManager } from '../plugins/plugin-manager.js';
 import { PromptType, Reporter } from '../ui/reporters/reporter.js';
+import { FileUtils } from '../utils/file.js';
 import { InitializeOrchestrator } from './initialize.js';
 
 export type RequiredParameters = Map<string, RequiredParameter[]>;
@@ -70,6 +73,7 @@ export class ImportOrchestrator {
     ctx.processFinished(ProcessName.IMPORT)
     reporter.displayImportResult(importResult);
 
+    ImportOrchestrator.attachResourceInfo(importResult, resourceInfoList);
     await ImportOrchestrator.saveResults(reporter, importResult, project)
   }
 
@@ -131,16 +135,60 @@ ${JSON.stringify(unsupportedTypeIds)}`);
 
   private static async saveResults(reporter: Reporter, importResult: ImportResult, project: Project): Promise<void> {
     const projectExists = !project.isEmpty();
+    const multipleCodifyFiles = project.codifyFiles.length > 1;
 
-    const continueSaving = await reporter.promptOptions(
+    const promptResult = await reporter.promptOptions(
       '\nDo you want to save the results?',
-      [projectExists ? `Update ${project.path}` : undefined, 'Save in a new file', 'No'].filter(Boolean) as string[]
+      [projectExists ? multipleCodifyFiles ? 'Update existing file (multiple found)' : `Update existing file (${project.codifyFiles})` : undefined, 'In a new file', 'No'].filter(Boolean) as string[]
     )
-    if (!continueSaving) {
-      process.exit(0)
+
+    if (promptResult === 'Update existing file (multiple found)') {
+      const file = await reporter.promptOptions(
+        '\nWhich file would you like to update?',
+        project.codifyFiles,
+      )
+      await ImportOrchestrator.saveToFile(file, importResult);
+
+    } else if (promptResult.startsWith('Update existing file')) {
+      await ImportOrchestrator.saveToFile(project.codifyFiles[0], importResult);
+
+    } else if (promptResult === 'In a new file') {
+      const newFileName = await ImportOrchestrator.generateNewImportFileName();
+      await ImportOrchestrator.saveToFile(newFileName, importResult);
     }
+  }
+
+  private static async saveToFile(filePath: string, importResult: ImportResult): Promise<void> {
+    const existing = await CodifyParser.parse(filePath);
 
+    for (const resource of importResult.result) {
+      existing.addOrReplace(resource);
+    }
 
+    console.log(JSON.stringify(existing.resourceConfigs.map((r) => r.raw), null, 2))
+  }
+
+  private static async generateNewImportFileName(): Promise<string> {
+    const cwd = process.cwd();
+
+    let fileName = path.join(cwd, 'import.codify.json')
+    let counter = 1;
+
+    while(true) {
+      if (!(await FileUtils.fileExists(fileName))) {
+        return fileName;
+      }
+
+      fileName = path.join(cwd, `import-${counter}.codify.json`);
+      counter++;
+    }
+  }
 
+  // We have to attach additional info to the imported configs to make saving easier
+  private static attachResourceInfo(importResult: ImportResult, resourceInfoList: ResourceInfo[]): void {
+    importResult.result.forEach((resource) => {
+      const matchedInfo = resourceInfoList.find((info) => info.type === resource.type)!;
+      resource.attachResourceInfo(matchedInfo);
+    })
   }
 }

src/parser/index.ts

@@ -22,13 +22,13 @@ class Parser {
   async parse(dirOrFile: string): Promise<Project> {
     const absolutePath = path.resolve(dirOrFile);
     const sourceMaps = new SourceMapCache()
+    const codifyFiles = await this.getFilePaths(absolutePath)
 
-    const configs = await this.getFilePaths(absolutePath)
-      .then((paths) => this.readFiles(paths))
+    const configs = await this.readFiles(codifyFiles)
       .then((files) => this.parseContents(files, sourceMaps))
       .then((config) => this.createConfigBlocks(config, sourceMaps))
 
-    return Project.create(configs, dirOrFile, sourceMaps);
+    return Project.create(configs, codifyFiles, sourceMaps);
   }
 
   private async getFilePaths(dirOrFile: string): Promise<string[]> {

src/ui/components/plan/plan.tsx

@@ -14,7 +14,7 @@ export function PlanComponent(props: {
     <Box borderColor="green" borderStyle="round">
       <Text>Codify Plan</Text>
     </Box>
-    <Text>Path: {props.plan.project.path}</Text>
+    <Text>Path: {props.plan.project.codifyFiles}</Text>
     <Text>The following actions will be performed: </Text>
     <Text> </Text>
     <Box flexDirection="column" marginLeft={1}>{

src/ui/plan-pretty-printer.ts

@@ -8,7 +8,7 @@ export function prettyFormatPlan(plan: Plan) {
     '',
     '',
     chalk.bold('Codify Plan'),
-    `Path: ${plan.project.path}`,
+    `Path: ${plan.project.codifyFiles}`,
     'The following actions will be performed',
     '',
   ];

src/ui/reporters/default-reporter.tsx

@@ -137,8 +137,8 @@ export class DefaultReporter implements Reporter {
     return result;
   }
 
-  async promptOptions(message:string, options:string[]): Promise<number> {
-    const result = await this.updateStateAndAwaitEvent<number>(
+  async promptOptions(message:string, options:string[]): Promise<string> {
+    const result = await this.updateStateAndAwaitEvent<string>(
       () => this.updateRenderState(RenderStatus.PROMPT_OPTIONS, { message, options }),
       RenderEvent.PROMPT_RESULT
     )

src/ui/reporters/reporter.ts

@@ -47,7 +47,7 @@ export interface Reporter {
 
   promptConfirmation(message: string): Promise<boolean>
 
-  promptOptions(message: string, options: string[]): Promise<number>;
+  promptOptions(message: string, options: string[]): Promise<string>;
 
   promptSudo(pluginName: string, data: SudoRequestData, secureMode: boolean): Promise<SudoRequestResponseData>;
 

src/utils/file.ts

@@ -26,4 +26,9 @@ export class FileUtils {
     const lstat = await fs.lstat(path.resolve(fileOrDir))
     return lstat.isDirectory()
   }
+
+  static async readFile(filePath: string): Promise<string | undefined> {
+    const resolvedPath = path.resolve(filePath);
+    return fs.readFile(resolvedPath, 'utf8')
+  }
 }