feat: Updated to importAndDestroy and added filtering for preventImport

Author: kevinwang5658

package-lock.json

@@ -13,11 +13,11 @@
     "ajv": "^8.12.0",
     "ajv-formats": "^3.0.1",
     "chalk": "^5.3.0",
-    "codify-schemas": "^1.0.63",
+    "codify-schemas": "^1.0.69",
     "debug": "^4.3.4",
     "detect-indent": "^7.0.1",
     "diff": "^7.0.0",
-    "ink": "^5",
+    "ink": "^5.1.0",
     "jotai": "^2.11.1",
     "js-yaml": "^4.1.0",
     "js-yaml-source-map": "^0.2.2",
@@ -42,7 +42,7 @@
     "@types/semver": "^7.5.4",
     "@types/strip-ansi": "^5.2.1",
     "@typescript-eslint/eslint-plugin": "^8.16.0",
-    "codify-plugin-lib": "^1.0.132",
+    "codify-plugin-lib": "^1.0.140",
     "esbuild": "^0.24.0",
     "esbuild-plugin-copy": "^2.1.1",
     "eslint": "^8.51.0",

package.json

@@ -15,7 +15,10 @@ export class ResourceInfo implements GetResourceInfoResponseData {
   type!: string;
   schema?: Record<string, unknown> | undefined;
   dependencies?: string[] | undefined;
-  import?: { requiredParameters: null | string[]; } | undefined;
+  importAndDestroy?: {
+    preventImport?: boolean;
+    requiredParameters: null | string[];
+  } | undefined;
 
   private parametersCache?: ParameterInfo[];
 
@@ -24,6 +27,10 @@ export class ResourceInfo implements GetResourceInfoResponseData {
   get description(): string | undefined {
     return this.schema?.description as string | undefined;
   }
+
+  get canImport(): boolean {
+    return this.importAndDestroy?.preventImport !== true;
+  }
 
   static fromResponseData(data: GetResourceInfoResponseData): ResourceInfo {
     const resourceInfo = new ResourceInfo()
@@ -57,7 +64,7 @@ export class ResourceInfo implements GetResourceInfoResponseData {
 
       this.parametersCache = Object.entries(properties)
         .map(([propertyName, info]) => {
-          const isRequired = this.import?.requiredParameters?.some((name) => name === propertyName)
+          const isRequired = this.importAndDestroy?.requiredParameters?.some((name) => name === propertyName)
             ?? (required as string[] | undefined)?.includes(propertyName)
             ?? false;
 

src/entities/resource-info.ts

@@ -67,7 +67,9 @@ export class ImportOrchestrator {
     const matchedTypes = this.matchTypeIds(typeIds, [...typeIdsToDependenciesMap.keys()])
     await ImportOrchestrator.validate(matchedTypes, project, pluginManager, typeIdsToDependenciesMap);
 
-    const resourceInfoList = await pluginManager.getMultipleResourceInfo(matchedTypes);
+    const resourceInfoList = (await pluginManager.getMultipleResourceInfo(matchedTypes))
+      .filter((info) => info.canImport)
+
     const resourcesToImport = await ImportOrchestrator.getImportParameters(reporter, project, resourceInfoList);
     const importResult = await ImportOrchestrator.import(pluginManager, resourcesToImport);
 
@@ -318,7 +320,7 @@ ${JSON.stringify(unsupportedTypeIds)}`);
 
     reporter.displayFileModifications([{ file: filePath, modification: { newFile, diff } }]);
 
-    const shouldSave = await reporter.promptConfirmation('Save the changes?');
+    const shouldSave = await reporter.promptConfirmation(`Save the changes? (${filePath})`);
     if (!shouldSave) {
       reporter.displayMessage('\nSkipping save! Exiting...');
 
@@ -338,15 +340,19 @@ ${JSON.stringify(unsupportedTypeIds)}`);
   private static async generateNewImportFileName(): Promise<string> {
     const cwd = process.cwd();
 
-    let fileName = path.join(cwd, 'import.codify.json')
+    // Save codify to a new folder so it doesn't interfere with the current project
+    const folderPath = path.join(cwd, 'codify-imports')
+    await FileUtils.createFolder(folderPath)
+
+    let fileName = path.join(folderPath, 'import.codify.json')
     let counter = 1;
 
     while(true) {
       if (!(await FileUtils.fileExists(fileName))) {
         return fileName;
       }
 
-      fileName = path.join(cwd, `import-${counter}.codify.json`);
+      fileName = path.join(folderPath, `import-${counter}.codify.json`);
       counter++;
     }
   }

src/orchestrators/import.ts

@@ -62,8 +62,8 @@ export function SubProgressDisplay(
     subProgresses && subProgresses
       // Sort the subprocesses so that in progress ones are always at the bottom
       .sort((a, b) => a.status === ProgressStatus.IN_PROGRESS ? 1 : -1)
-      // Limit the max number of subprocesses to 7. Too many doesn't look good and causes a wasm memory access error (yoga)
-      .slice(Math.max(0, subProgresses.length - 7), subProgresses.length)
+      // Limit the max number of subprocesses to 5. Too many doesn't look good and causes a wasm memory access error (yoga)
+      .slice(Math.max(0, subProgresses.length - 5), subProgresses.length)
       .map((s, idx) =>
         s.status === ProgressStatus.IN_PROGRESS
           ? <Spinner eventEmitter={emitter} eventType={eventType} key={idx} label={s.label} type="circleHalves"/>

src/ui/components/progress/progress-display.tsx

@@ -526,7 +526,7 @@ function generateResourceInfo(type: string, requiredParameters?: string[]): Reso
   return ResourceInfo.fromResponseData({
     plugin: 'plugin',
     type,
-    import: { requiredParameters }
+    importAndDestroy: { requiredParameters }
   })
 }
 

src/utils/file-modification-calculator.test.ts

@@ -36,4 +36,9 @@ export class FileUtils {
     const resolvedPath = path.resolve(filePath);
     await fs.writeFile(resolvedPath, contents, 'utf8')
   }
+
+  static async createFolder(dirPath: string): Promise<void> {
+    const resolvedPath = path.resolve(dirPath);
+    await fs.mkdir(resolvedPath, { recursive: true });
+  }
 }

src/utils/file.ts

@@ -18,7 +18,7 @@ vi.mock('../mocks/get-mock-resources.js', async () => {
           const orgSettings = super.getSettings();
           return {
             ...orgSettings,
-            import: {
+            importAndDestroy: {
               requiredParameters: ['propA', 'propB'],
               refreshKeys: ['propA', 'propB', 'directory'],
             }
@@ -59,7 +59,7 @@ vi.mock('../mocks/get-mock-resources.js', async () => {
             parameterSettings: {
               add: { type: 'array' },
             },
-            import: {
+            importAndDestroy: {
               requiredParameters: ['requiredProp'],
               refreshKeys: ['add', 'global', 'requiredProp'],
             }
@@ -87,7 +87,7 @@ vi.mock('../mocks/get-mock-resources.js', async () => {
             parameterSettings: {
               add: { type: 'array' },
             },
-            import: {
+            importAndDestroy: {
               requiredParameters: ['alias'],
               refreshKeys: ['alias', 'value'],
             }

test/orchestrator/import/import.test.ts

@@ -5,7 +5,7 @@ import { GetResourceInfoResponseData, ImportResponseData, InitializeResponseData
 import { ResourcePlan } from '../../../src/entities/plan.js';
 import { ResourceConfig } from '../../../src/entities/resource-config.js';
 import { IPlugin } from '../../../src/plugins/plugin.js';
-import { getMockResources } from './get-mock-resources';
+import { getMockResources } from './get-mock-resources.js';
 
 export class MockPlugin implements IPlugin {
   name = 'default';

test/orchestrator/mocks/plugin.ts

@@ -22,7 +22,7 @@ export class MockResource extends Resource<MockResourceConfig> {
         directory: { type: 'directory' },
         array: { type: 'array', canModify: true }
       },
-      import: {
+      importAndDestroy: {
         requiredParameters: ['propB'],
         refreshKeys: ['propB', 'directory'],
       }