feat: added superseded types and separated out find resource into a dedicated call

Author: kevinwang5658

CLAUDE.md

@@ -25,6 +25,8 @@ npm run posttest           # Runs lint after tests
 ```bash
 ./bin/dev.js <command>     # Run CLI in development mode
 ./bin/dev.js apply         # Example: run apply command
+CODIFY_BETA=1 ./bin/dev.js destroy alias   # Use the latest beta plugins instead of the latest stable
+npm run start:dev:beta -- destroy alias   # Same as above
 ```
 
 ### Test Command (VM Testing)

package-lock.json

@@ -5,7 +5,7 @@
   },
   "dependencies": {
     "@codifycli/ink-form": "0.0.12",
-    "@codifycli/schemas": "1.2.0",
+    "@codifycli/schemas": "1.4.0",
     "@homebridge/node-pty-prebuilt-multiarch": "npm:node-pty@1.2.0-beta.15",
     "@mischnic/json-sourcemap": "^0.1.1",
     "@oclif/core": "^4.0.8",
@@ -45,7 +45,7 @@
   },
   "description": "Codify is a configuration-as-code tool that declaratively installs and manages developer tools and applications. Check out https://dashboard.codifycli.com for an editor.",
   "devDependencies": {
-    "@codifycli/plugin-core": "^1.2.11",
+    "@codifycli/plugin-core": "^1.3.0",
     "@oclif/prettier-config": "^0.2.1",
     "@types/chalk": "^2.2.0",
     "@types/cors": "^2.8.19",
@@ -143,6 +143,7 @@
     "test": "vitest",
     "version": "oclif readme && git add README.md",
     "start:dev": "./bin/dev.js",
+    "start:dev:beta": "CODIFY_BETA=1 ./bin/dev.js",
     "start:vm": "npm run build && npm run pack:macos && npm run start:vm",
     "deploy": "npm run pkg && npm run notarize && npm run upload",
     "build:npm": "tsx ./scripts/build-npm.ts",

package.json

@@ -14,5 +14,6 @@ export const config = {
   apiUrl: 'https://api.codifycli.com',
   supabaseUrl: 'https://kdctbvqvqjfquplxhqrm.supabase.co',
 
-  isBeta: VERSION.includes('beta'),
+  // Beta CLI versions use beta plugins. Set CODIFY_BETA=1 to use beta plugins from a non-beta CLI (ex: local development)
+  isBeta: VERSION.includes('beta') || ['1', 'true'].includes(process.env.CODIFY_BETA?.toLowerCase() ?? ''),
 }

src/config.ts

@@ -253,8 +253,9 @@ ${JSON.stringify(unsupportedTypeIds)}`);
   }
 
   /**
-   * Find the instances of a resource that exist on the system using the plugin's import (the same call as import all).
-   * Each instance is labelled by the values required to identify it. Returns an empty list if no instances are found.
+   * Find the instances of a resource that exist on the system using the plugin's findInstances (discovery only, separate
+   * from import so resources that can't be imported can still be discovered). Each instance is labelled by the values
+   * required to identify it. Returns an empty list if no instances are found or the plugin doesn't support discovery.
    */
   private static async findExistingInstances(
     pluginManager: PluginManager,
@@ -268,7 +269,7 @@ ${JSON.stringify(unsupportedTypeIds)}`);
 
     let imported: ResourceConfig[];
     try {
-      const response = await pluginManager.importResource({ core: { type: info.type }, parameters: {} }, true);
+      const response = await pluginManager.findInstances(info.type);
       imported = (response.result ?? []).map((r) => ResourceConfig.fromJson(r));
     } catch (error) {
       ctx.debug(`Unable to find existing instances of ${info.type}: ${error}`);

src/orchestrators/destroy.ts

@@ -18,6 +18,7 @@ import { prettyFormatFileDiff } from '../ui/file-diff-pretty-printer.js';
 import { PromptType, Reporter } from '../ui/reporters/reporter.js';
 import { FileUtils } from '../utils/file.js';
 import { groupBy, sleep } from '../utils/index.js';
+import { removeSupersededTypes } from '../utils/superseded-types.js';
 import { wildCardMatch } from '../utils/wild-card-match.js';
 import { LoginOrchestrator } from './login.js';
 
@@ -60,9 +61,12 @@ export class ImportOrchestrator {
 
     ctx.subprocessStarted(SubProcessName.IMPORT_RESOURCE)
 
-    // Omit sensitive resources if not included
-    const typeIdsToImport = [...resourceDefinitions.keys()]
-      .filter((typeId) => args.includeSensitive || (!args.includeSensitive && (resourceDefinitions.get(typeId)?.sensitiveParameters ?? []).length === 0))
+    // Omit sensitive resources if not included, and resources whose state is already imported by another resource
+    const typeIdsToImport = removeSupersededTypes(
+      [...resourceDefinitions.keys()]
+        .filter((typeId) => args.includeSensitive || (!args.includeSensitive && (resourceDefinitions.get(typeId)?.sensitiveParameters ?? []).length === 0)),
+      resourceDefinitions,
+    );
 
     const importResults = await Promise.all(typeIdsToImport.map(async (typeId) => {
       try {

src/orchestrators/import.ts

@@ -11,6 +11,7 @@ import { Reporter } from '../ui/reporters/reporter.js';
 import { FileUtils } from '../utils/file.js';
 import { resolvePathWithVariables, tildify, untildify } from '../utils/index.js';
 import { ShellUtils } from '../utils/shell.js';
+import { removeSupersededTypes } from '../utils/superseded-types.js';
 
 export interface InitArgs {
   path?: string;
@@ -38,9 +39,12 @@ export const InitializeOrchestrator = {
     const currentDistro = os.type() === OS.Linux ? await ShellUtils.getLinuxDistro() : undefined;
 
     // Omit sensitive resources and resources not supported on the current OS
-    const typeIdsToImport = [...resourceDefinitions.keys()]
-      .filter((typeId) => args.includeSensitive || (!args.includeSensitive && (resourceDefinitions.get(typeId)?.sensitiveParameters ?? []).length === 0))
-      .filter((typeId) => this.filterByOperatingSystemAndDistro(typeId, resourceDefinitions, currentDistro))
+    const typeIdsToImport = removeSupersededTypes(
+      [...resourceDefinitions.keys()]
+        .filter((typeId) => args.includeSensitive || (!args.includeSensitive && (resourceDefinitions.get(typeId)?.sensitiveParameters ?? []).length === 0))
+        .filter((typeId) => this.filterByOperatingSystemAndDistro(typeId, resourceDefinitions, currentDistro)),
+      resourceDefinitions,
+    );
 
     const importResults = await Promise.all(typeIdsToImport.map(async (typeId) => {
       try {

src/orchestrators/init.ts

@@ -1,5 +1,6 @@
 import {
   ApplyNoteRequestData,
+  FindInstancesResponseData,
   ImportResponseData, ResourceDefinition,
   ResourceJson,
   ValidateResponseData,
@@ -120,6 +121,24 @@ export class PluginManager {
     return plugin.import(config, autoImportAll);
   }
 
+  /**
+   * Find every instance of a resource that currently exists on the system. This is discovery only (ex: used by destroy
+   * to let the user pick which instance to remove) and is separate from import.
+   */
+  async findInstances(type: string): Promise<FindInstancesResponseData> {
+    const pluginName = this.resourceToPluginMapping.get(type);
+    if (!pluginName) {
+      throw new Error(`Unable to find plugin for resource: ${type}`);
+    }
+
+    const plugin = this.plugins.get(pluginName)
+    if (!plugin) {
+      throw new Error(`Unable to find plugin for resource ${type}`);
+    }
+
+    return plugin.findInstances(type);
+  }
+
   async plan(project: Project): Promise<Plan> {
     const result = new Array<ResourcePlan>();
     await Promise.all(

src/plugins/plugin-manager.ts

@@ -1,5 +1,8 @@
 import {
   ErrorResponseDataSchema,
+  FindInstancesRequestData,
+  FindInstancesResponseData,
+  FindInstancesResponseDataSchema,
   GetResourceInfoResponseData,
   GetResourceInfoResponseDataSchema,
   ImportRequestData,
@@ -30,6 +33,7 @@ const validateResponseValidator = ajv.compile(ValidateResponseDataSchema);
 const getResourceInfoResponseValidator = ajv.compile(GetResourceInfoResponseDataSchema);
 const matchResponseValidator = ajv.compile(MatchResponseDataSchema);
 const importResponseValidator = ajv.compile(ImportResponseDataSchema);
+const findInstancesResponseValidator = ajv.compile(FindInstancesResponseDataSchema);
 const planResponseValidator = ajv.compile(PlanResponseDataSchema);
 
 export interface IPlugin {
@@ -38,6 +42,7 @@ export interface IPlugin {
   getResourceInfo(type: string): Promise<GetResourceInfoResponseData>;
   match(resource: ResourceConfig, array: ResourceConfig[]): Promise<MatchResponseData>;
   import(config: ResourceJson): Promise<ImportResponseData>;
+  findInstances(type: string): Promise<FindInstancesResponseData>;
   plan(request: PlanRequestData): Promise<ResourcePlan>;
   apply(plan: ResourcePlan): Promise<void>;
   kill(): void;
@@ -128,6 +133,20 @@ export class Plugin implements IPlugin {
     return result.data;
   }
 
+  async findInstances(type: string): Promise<FindInstancesResponseData> {
+    const result = await this.process!.sendMessageForResult('findInstances', <FindInstancesRequestData>{ core: { type } });
+
+    if (!result.isSuccessful()) {
+      throw new PluginError(this.name, type, this.toErrorData(result.data));
+    }
+
+    if (!this.validateFindInstancesResponse(result.data)) {
+      throw new Error(`Plugin error: Invalid find instances response from plugin: ${this.name}`);
+    }
+
+    return result.data;
+  }
+
   async plan(request: PlanRequestData): Promise<ResourcePlan> {
     const result = await this.process!.sendMessageForResult('plan', request);
 
@@ -189,6 +208,10 @@ export class Plugin implements IPlugin {
     return importResponseValidator(response)
   }
 
+  private validateFindInstancesResponse(response: unknown): response is FindInstancesResponseData {
+    return findInstancesResponseValidator(response)
+  }
+
   private validatePlanResponse(response: unknown): response is PlanResponseData {
     return planResponseValidator(response);
   }

src/plugins/plugin.ts

@@ -0,0 +1,15 @@
+import { ResourceDefinitionMap } from '../plugins/plugin-manager.js';
+
+/**
+ * Remove the types that are superseded by another type in the same list (ex: `alias` is superseded by `aliases`).
+ * Both resources manage the same system state, so importing both automatically (init / import all) would import the
+ * same state twice. A superseded type is kept if the type that supersedes it isn't in the list.
+ */
+export function removeSupersededTypes(typeIds: string[], resourceDefinitions: ResourceDefinitionMap): string[] {
+  const typeIdSet = new Set(typeIds);
+
+  return typeIds.filter((typeId) => {
+    const supersededBy = resourceDefinitions.get(typeId)?.supersededBy;
+    return !supersededBy || !typeIdSet.has(supersededBy);
+  });
+}