feat: Refactored the initialization process to return all info about a plugin. Simplifies the design of the CLI a bit especially for import

Author: kevinwang5658

package-lock.json

@@ -17,7 +17,7 @@
     "ajv": "^8.12.0",
     "ajv-formats": "^3.0.1",
     "chalk": "^5.3.0",
-    "codify-schemas": "^1.0.77",
+    "codify-schemas": "^1.0.80",
     "cors": "^2.8.5",
     "debug": "^4.3.4",
     "detect-indent": "^7.0.1",

package.json

@@ -70,7 +70,6 @@ For more information, visit: https://docs.codifycli.com/commands/import`
       verbosityLevel: flags.debug ? 3 : 0,
       typeIds: cleanedArgs,
       path: resolvedPath,
-      secureMode: flags.secure,
       updateExisting: flags.updateExisting,
     }, this.reporter)
 

src/commands/import.ts

@@ -1,16 +1,16 @@
 import * as fs from 'node:fs/promises'
 import * as os from 'node:os'
 import * as path from 'node:path'
+import { validate } from 'uuid';
 
+import { DashboardApiClient } from '../api/dashboard/index.js';
+import { LoginHelper } from '../connect/login-helper.js';
 import { Project } from '../entities/project.js';
 import { SubProcessName, ctx } from '../events/context.js';
 import { CODIFY_FILE_REGEX, CodifyParser } from '../parser/index.js';
-import { DependencyMap, PluginManager } from '../plugins/plugin-manager.js';
+import { PluginManager, ResourceInfoMap } from '../plugins/plugin-manager.js';
 import { Reporter } from '../ui/reporters/reporter.js';
-import { LoginHelper } from '../connect/login-helper.js';
 import { FileUtils } from '../utils/file.js';
-import { validate } from 'uuid';
-import { DashboardApiClient } from '../api/dashboard/index.js';
 
 export interface InitializeArgs {
   path?: string;
@@ -21,7 +21,7 @@ export interface InitializeArgs {
 }
 
 export interface InitializationResult {
-  typeIdsToDependenciesMap: DependencyMap
+  resourceInfoMap: ResourceInfoMap
   pluginManager: PluginManager,
   project: Project,
 }
@@ -42,10 +42,10 @@ export class PluginInitOrchestrator {
 
     ctx.subprocessStarted(SubProcessName.INITIALIZE_PLUGINS)
     const pluginManager = new PluginManager();
-    const typeIdsToDependenciesMap = await pluginManager.initialize(project, args.secure, args.verbosityLevel);
+    const resourceInfoMap = await pluginManager.initialize(project, args.secure, args.verbosityLevel);
     ctx.subprocessFinished(SubProcessName.INITIALIZE_PLUGINS)
 
-    return { typeIdsToDependenciesMap, pluginManager, project };
+    return { resourceInfoMap, pluginManager, project };
   }
 
   private static async parse(

src/common/initialize-plugins.ts

@@ -4,7 +4,7 @@ import { validate } from 'uuid'
 import { PluginValidationError, PluginValidationErrorParams, TypeNotFoundError } from '../common/errors.js';
 import { ctx } from '../events/context.js';
 import { SourceMapCache } from '../parser/source-maps.js';
-import { DependencyMap } from '../plugins/plugin-manager.js';
+import { ResourceInfoMap } from '../plugins/plugin-manager.js';
 import { DependencyGraphResolver } from '../utils/dependency-graph-resolver.js';
 import { groupBy } from '../utils/index.js';
 import { ConfigBlock, ConfigType } from './config.js';
@@ -155,16 +155,16 @@ ${JSON.stringify(projectConfigs, null, 2)}`);
     }
   }
 
-  validateTypeIds(resourceMap: Map<string, string[]>) {
-    const invalidConfigs = this.resourceConfigs.filter((c) => !resourceMap.get(c.type));
+  validateTypeIds(resourceInfoMap: ResourceInfoMap) {
+    const invalidConfigs = this.resourceConfigs.filter((c) => !resourceInfoMap.has(c.type));
 
     if (invalidConfigs.length > 0) {
       throw new TypeNotFoundError(invalidConfigs, this.sourceMaps);
     }
   }
 
-  resolveDependenciesAndCalculateEvalOrder(dependencyMap?: DependencyMap) {
-    this.resolveResourceDependencies(dependencyMap);
+  resolveDependenciesAndCalculateEvalOrder(resourceInfoMap?: ResourceInfoMap) {
+    this.resolveResourceDependencies(resourceInfoMap);
     this.calculateEvaluationOrder();
   }
 
@@ -189,7 +189,7 @@ ${JSON.stringify(projectConfigs, null, 2)}`);
     ) ?? null;
   }
 
-  private resolveResourceDependencies(dependencyMap?: DependencyMap) {
+  private resolveResourceDependencies(resourceInfoMap?: ResourceInfoMap) {
     const resourceMap = new Map(this.resourceConfigs.map((r) => [r.id, r] as const));
 
     for (const r of this.resourceConfigs) {
@@ -198,7 +198,7 @@ ${JSON.stringify(projectConfigs, null, 2)}`);
       r.addDependenciesBasedOnParameters((id) => resourceMap.has(id));
 
       // Plugin dependencies are soft dependencies. They only activate if the dependent resource is present.
-      r.addDependencies(dependencyMap?.get(r.type)
+      r.addDependencies(resourceInfoMap?.get(r.type)?.dependencies
         ?.filter((type) => [...resourceMap.values()].some((r) => r.type === type))
         ?.flatMap((type) => [...resourceMap.values()].filter((r) => r.type === type).map((r) => r.id)) ?? []
       );

src/entities/project.ts

@@ -4,7 +4,7 @@ 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 { DependencyMap, PluginManager } from '../plugins/plugin-manager.js';
+import { PluginManager, ResourceInfoMap } from '../plugins/plugin-manager.js';
 import { PromptType, Reporter } from '../ui/reporters/reporter.js';
 import { wildCardMatch } from '../utils/wild-card-match.js';
 
@@ -68,13 +68,15 @@ Open a new terminal or source '.zshrc' for the new changes to be reflected`);
     reporter: Reporter,
     initializeResult: InitializationResult
   ): Promise<{ plan: Plan, destroyProject: Project }> {
-    const { project, pluginManager, typeIdsToDependenciesMap } = initializeResult;
+    const { project, pluginManager, resourceInfoMap } = initializeResult;
 
     // TODO: In the future if a user supplies resourceId.name (naming a specific resource) destroy that resource instead of stripping the name out.
-    const matchedTypes = this.matchTypeIds(typeIds.map((id) => id.split('.').at(0) ?? ''), [...typeIdsToDependenciesMap.keys()])
-    await DestroyOrchestrator.validateTypeIds(matchedTypes, project, pluginManager, typeIdsToDependenciesMap);
+    const matchedTypes = this.matchTypeIds(typeIds.map((id) => id.split('.').at(0) ?? ''), [...resourceInfoMap.keys()])
+    await DestroyOrchestrator.validateTypeIds(matchedTypes, project, resourceInfoMap);
+
+    const resourceInfoList = [...resourceInfoMap.values()]
+      .filter((info) => matchedTypes.includes(info.type))
 
-    const resourceInfoList = (await pluginManager.getMultipleResourceInfo(matchedTypes));
     const resourcesToDestroy = await DestroyOrchestrator.getDestroyParameters(reporter, project, resourceInfoList);
 
     const destroyProject = new Project(
@@ -83,7 +85,7 @@ Open a new terminal or source '.zshrc' for the new changes to be reflected`);
       project.codifyFiles
     ).toDestroyProject();
 
-    destroyProject.resolveDependenciesAndCalculateEvalOrder(typeIdsToDependenciesMap);
+    destroyProject.resolveDependenciesAndCalculateEvalOrder(resourceInfoMap);
     const plan = await ctx.subprocess(ProcessName.PLAN, () =>
       pluginManager.plan(destroyProject)
     )
@@ -96,16 +98,16 @@ Open a new terminal or source '.zshrc' for the new changes to be reflected`);
     reporter: Reporter,
     initializeResult: InitializationResult
   ): Promise<{ plan: Plan, destroyProject: Project }> {
-    const { pluginManager, project, typeIdsToDependenciesMap } = initializeResult;
+    const { pluginManager, project, resourceInfoMap } = initializeResult;
 
     await ctx.subprocess(SubProcessName.VALIDATE, async () => {
-      project.validateTypeIds(typeIdsToDependenciesMap);
+      project.validateTypeIds(resourceInfoMap);
       const validationResults = await pluginManager.validate(project);
       project.handlePluginResourceValidationResults(validationResults);
     })
 
     const destroyProject = project.toDestroyProject();
-    destroyProject.resolveDependenciesAndCalculateEvalOrder(typeIdsToDependenciesMap);
+    destroyProject.resolveDependenciesAndCalculateEvalOrder(resourceInfoMap);
 
     const plan = await ctx.subprocess(ProcessName.PLAN, () =>
       pluginManager.plan(destroyProject)
@@ -147,10 +149,10 @@ ${JSON.stringify(unsupportedTypeIds)}`);
     return result;
   }
 
-  private static async validateTypeIds(typeIds: string[], project: Project, pluginManager: PluginManager, dependencyMap: DependencyMap): Promise<void> {
-    project.validateTypeIds(dependencyMap);
+  private static async validateTypeIds(typeIds: string[], project: Project, resourceInfoMap: ResourceInfoMap): Promise<void> {
+    project.validateTypeIds(resourceInfoMap);
 
-    const unsupportedTypeIds = typeIds.filter((type) => !dependencyMap.has(type));
+    const unsupportedTypeIds = typeIds.filter((type) => !resourceInfoMap.has(type));
     if (unsupportedTypeIds.length > 0) {
       throw new Error(`The following resources cannot be destroyed. No plugins found that support the following types:
 ${JSON.stringify(unsupportedTypeIds)}`);
@@ -160,6 +162,7 @@ ${JSON.stringify(unsupportedTypeIds)}`);
   private static async getDestroyParameters(reporter: Reporter, project: Project, resourceInfoList: ResourceInfo[]): Promise<Array<ResourceConfig>> {
     // Figure out which resources we need to prompt the user for additional info (based on the resource info)
     const [noPrompt, askPrompt] = resourceInfoList.reduce((result, info) => {
+      // eslint-disable-next-line @typescript-eslint/no-unused-expressions
       info.getRequiredParameters().length === 0 ? result[0].push(info) : result[1].push(info);
       return result;
     }, [<ResourceInfo[]>[], <ResourceInfo[]>[]])

src/orchestrators/destroy.ts

@@ -13,7 +13,7 @@ import { FileModificationCalculator } from '../generators/file-modification-calc
 import { ModificationType } from '../generators/index.js';
 import { FileUpdater } from '../generators/writer.js';
 import { CodifyParser } from '../parser/index.js';
-import { DependencyMap, PluginManager } from '../plugins/plugin-manager.js';
+import { PluginManager, ResourceInfoMap } from '../plugins/plugin-manager.js';
 import { prettyFormatFileDiff } from '../ui/file-diff-pretty-printer.js';
 import { PromptType, Reporter } from '../ui/reporters/reporter.js';
 import { FileUtils } from '../utils/file.js';
@@ -27,7 +27,6 @@ export interface ImportArgs {
   typeIds?: string[];
   path: string;
   updateExisting?: boolean;
-  secureMode?: boolean;
   verbosityLevel?: number;
 }
 
@@ -56,10 +55,10 @@ export class ImportOrchestrator {
   }
 
   static async autoImportAll(reporter: Reporter, initializeResult: InitializationResult, args: ImportArgs) {
-    const { project, pluginManager, typeIdsToDependenciesMap } = initializeResult;
+    const { project, pluginManager, resourceInfoMap } = initializeResult;
 
     ctx.subprocessStarted(SubProcessName.IMPORT_RESOURCE)
-    const importResults = await Promise.all([...typeIdsToDependenciesMap.keys()].map(async (typeId) => {
+    const importResults = await Promise.all([...resourceInfoMap.keys()].map(async (typeId) => {
       try {
         return await pluginManager.importResource({
           core: { type: typeId },
@@ -82,28 +81,25 @@ export class ImportOrchestrator {
     const importedResources = flattenedResults.filter((r) => r && userSelectedTypes.includes(r.core.type))
       .map((r) => ResourceConfig.fromJson(r!));
 
-    const resourceInfoList = await pluginManager.getMultipleResourceInfo(
-      [...project.resourceConfigs, ...importedResources].map((r) => r.type),
-    );
-
     await ImportOrchestrator.saveResults(
       reporter,
       { result: importedResources, errors: [] },
       project,
-      resourceInfoList,
+      resourceInfoMap,
       pluginManager,
       args
     )
   }
 
   /** Import new resources. Type ids supplied. This will ask for any required parameters */
   static async runNewImport(typeIds: string[], reporter: Reporter, initializeResult: InitializationResult, args: ImportArgs): Promise<void> {
-    const { project, pluginManager, typeIdsToDependenciesMap } = initializeResult;
+    const { project, pluginManager, resourceInfoMap } = initializeResult;
 
-    const matchedTypes = this.matchTypeIds(typeIds, [...typeIdsToDependenciesMap.keys()])
-    await ImportOrchestrator.validate(matchedTypes, project, pluginManager, typeIdsToDependenciesMap);
+    const matchedTypes = this.matchTypeIds(typeIds, [...resourceInfoMap.keys()])
+    await ImportOrchestrator.validate(matchedTypes, project, pluginManager, resourceInfoMap);
 
-    const resourceInfoList = (await pluginManager.getMultipleResourceInfo(matchedTypes))
+    const resourceInfoList = [...resourceInfoMap.values()]
+      .filter((info) => matchedTypes.includes(info.type))
       .filter((info) => info.canImport)
 
     const resourcesToImport = await ImportOrchestrator.getImportParameters(reporter, project, resourceInfoList);
@@ -113,10 +109,7 @@ export class ImportOrchestrator {
 
     reporter.displayImportResult(importResult, false);
 
-    resourceInfoList.push(...(await pluginManager.getMultipleResourceInfo(
-      project.resourceConfigs.map((r) => r.type)
-    )));
-    await ImportOrchestrator.saveResults(reporter, importResult, project, resourceInfoList, pluginManager, args)
+    await ImportOrchestrator.saveResults(reporter, importResult, project, resourceInfoMap, pluginManager, args)
   }
 
   static async import(
@@ -162,7 +155,7 @@ export class ImportOrchestrator {
     reporter: Reporter,
     importResult: ImportResult,
     project: Project,
-    resourceInfoList: ResourceInfo[],
+    resourceInfoMap: ResourceInfoMap,
     pluginManager: PluginManager,
     args: ImportArgs,
   ): Promise<void> {
@@ -177,7 +170,7 @@ export class ImportOrchestrator {
       const file = multipleCodifyFiles
         ? project.codifyFiles[await reporter.promptOptions('\nIf new resources are added, where to write them?', project.codifyFiles)]
         : project.codifyFiles[0];
-      await ImportOrchestrator.updateExistingFiles(reporter, project, importResult, resourceInfoList, file, pluginManager);
+      await ImportOrchestrator.updateExistingFiles(reporter, project, importResult, resourceInfoMap, file, pluginManager);
       return;
     }
 
@@ -199,7 +192,7 @@ export class ImportOrchestrator {
     reporter: Reporter,
     existingProject: Project,
     importResult: ImportResult,
-    resourceInfoList: ResourceInfo[],
+    resourceInfoMap: ResourceInfoMap,
     preferredFile: string, // File to write any new resources (unknown file path)
     pluginManager: PluginManager,
   ): Promise<void> {
@@ -218,8 +211,8 @@ export class ImportOrchestrator {
 
     const diffs = await Promise.all(Object.entries(groupedResults).map(async ([filePath, imported]) => {
       const existing = await CodifyParser.parse(filePath!);
-      ImportOrchestrator.attachResourceInfo(imported, resourceInfoList);
-      ImportOrchestrator.attachResourceInfo(existing.resourceConfigs, resourceInfoList);
+      ImportOrchestrator.attachResourceInfo(imported, resourceInfoMap);
+      ImportOrchestrator.attachResourceInfo(existing.resourceConfigs, resourceInfoMap);
 
       const modificationCalculator = new FileModificationCalculator(existing);
       const modification = await modificationCalculator.calculate(
@@ -364,10 +357,10 @@ ${JSON.stringify(unsupportedTypeIds)}`);
     return result;
   }
 
-  private static async validate(typeIds: string[], project: Project, pluginManager: PluginManager, dependencyMap: DependencyMap): Promise<void> {
-    project.validateTypeIds(dependencyMap);
+  private static async validate(typeIds: string[], project: Project, pluginManager: PluginManager, resourceInfoMap: ResourceInfoMap): Promise<void> {
+    project.validateTypeIds(resourceInfoMap);
 
-    const unsupportedTypeIds = typeIds.filter((type) => !dependencyMap.has(type));
+    const unsupportedTypeIds = typeIds.filter((type) => !resourceInfoMap.has(type));
     if (unsupportedTypeIds.length > 0) {
       throw new Error(`The following resources cannot be imported. No plugins found that support the following types:
 ${JSON.stringify(unsupportedTypeIds)}`);
@@ -377,6 +370,7 @@ ${JSON.stringify(unsupportedTypeIds)}`);
   private static async getImportParameters(reporter: Reporter, project: Project, resourceInfoList: ResourceInfo[]): Promise<Array<ResourceConfig>> {
     // Figure out which resources we need to prompt the user for additional info (based on the resource info)
     const [noPrompt, askPrompt] = resourceInfoList.reduce((result, info) => {
+      // eslint-disable-next-line @typescript-eslint/no-unused-expressions
       info.getRequiredParameters().length === 0 ? result[0].push(info) : result[1].push(info);
       return result;
     }, [<ResourceInfo[]>[], <ResourceInfo[]>[]])
@@ -472,6 +466,7 @@ ${JSON.stringify(unsupportedTypeIds)}`);
     let fileName = path.join(folderPath, 'import.codify.jsonc')
     let counter = 1;
 
+    // eslint-disable-next-line no-constant-condition
     while (true) {
       if (!(await FileUtils.fileExists(fileName))) {
         return fileName;
@@ -483,9 +478,9 @@ ${JSON.stringify(unsupportedTypeIds)}`);
   }
 
   // We have to attach additional info to the imported configs to make saving easier
-  private static attachResourceInfo(resources: ResourceConfig[], resourceInfoList: ResourceInfo[]): void {
+  private static attachResourceInfo(resources: ResourceConfig[], resourceInfoMap: ResourceInfoMap): void {
     resources.forEach((resource) => {
-      const matchedInfo = resourceInfoList.find((info) => info.type === resource.type)!;
+      const matchedInfo = resourceInfoMap.get(resource.type);
       if (!matchedInfo) {
         throw new Error(`Could not find type ${resource.type} in the resource info`);
       }

src/orchestrators/import.ts

@@ -13,6 +13,10 @@ export interface InitArgs {
   verbosityLevel?: number;
 }
 
+/**
+ * Orchestrator for the init command. This command is used by new users to quickly get started with Codify.
+ * Not to be confused with the plugin init command which is used by every command to initialize plugins.
+ */
 export const InitializeOrchestrator = {
 
   async run(args: InitArgs, reporter: Reporter) {
@@ -22,10 +26,10 @@ export const InitializeOrchestrator = {
     await reporter.displayProgress();
 
 
-    const { pluginManager, typeIdsToDependenciesMap } = await PluginInitOrchestrator.run(args, reporter);
+    const { pluginManager, resourceInfoMap } = await PluginInitOrchestrator.run(args, reporter);
 
     ctx.subprocessStarted(SubProcessName.IMPORT_RESOURCE)
-    const importResults = await Promise.all([...typeIdsToDependenciesMap.keys()].map(async (typeId) => {
+    const importResults = await Promise.all([...resourceInfoMap.keys()].map(async (typeId) => {
       try {
         return await pluginManager.importResource({
           core: { type: typeId },