[CODE-100] Add dependsOn support. Add entities for plan and resource … (#28)

* [CODE-100] Add dependsOn support. Add entities for plan and resource plan. Make most operations depend on id instead of solely relying on type

* [CODE-100] Fixed bugs + removed debug logging

* [CODE-100] Style improvements. Reset codify.json back to original

* [CODE-100] Fixed imports

Author: kevinwang5658

README.md

@@ -18,7 +18,7 @@ $ npm install -g codify
 $ codify COMMAND
 running command...
 $ codify (--version)
-codify/0.0.0 darwin-arm64 node-v18.20.2
+codify/0.0.0 darwin-arm64 node-v18.20.3
 $ codify --help [COMMAND]
 USAGE
   $ codify COMMAND
@@ -69,8 +69,7 @@ EXAMPLES
   $ codify apply
 ```
 
-_See
-code: [src/commands/apply/index.ts](https://github.com/kevinwang5658/codify/blob/v0.0.0/src/commands/apply/index.ts)_
+_See code: [src/commands/apply/index.ts](https://github.com/kevinwang5658/codify/blob/v0.0.0/src/commands/apply/index.ts)_
 
 ## `codify help [COMMANDS]`
 
@@ -210,8 +209,7 @@ EXAMPLES
   $ codify plugins:inspect myplugin
 ```
 
-_See
-code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.10.1/src/commands/plugins/inspect.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.10.1/src/commands/plugins/inspect.ts)_
 
 ## `codify plugins:install PLUGIN...`
 
@@ -251,8 +249,7 @@ EXAMPLES
   $ codify plugins:install someuser/someplugin
 ```
 
-_See
-code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.10.1/src/commands/plugins/install.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.10.1/src/commands/plugins/install.ts)_
 
 ## `codify plugins:link PLUGIN`
 
@@ -330,8 +327,7 @@ ALIASES
   $ codify plugins remove
 ```
 
-_See
-code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.10.1/src/commands/plugins/uninstall.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.10.1/src/commands/plugins/uninstall.ts)_
 
 ## `codify plugins:uninstall PLUGIN...`
 

package.json

@@ -11,7 +11,7 @@
     "ajv": "^8.12.0",
     "ajv-formats": "^3.0.1",
     "chalk": "^5.3.0",
-    "codify-schemas": "1.0.38",
+    "codify-schemas": "1.0.39",
     "debug": "^4.3.4",
     "ink": "^4.4.1",
     "parse-json": "^8.1.0",

src/commands/apply/index.ts

@@ -35,7 +35,7 @@ export default class Apply extends BaseCommand {
     this.reporter.displayPlan(planResult.plan);
 
     // Short circuit and exit if every change is NOOP
-    if (planResult.plan.every((p) => p.operation === ResourceOperation.NOOP)) {
+    if (planResult.plan.isEmpty()) {
       console.log('No changes necessary. Exiting');
       return process.exit(0);
     }

src/entities/plan.ts

@@ -0,0 +1,71 @@
+import { ParameterOperation, PlanResponseData, ResourceConfig, ResourceOperation } from 'codify-schemas';
+
+export class Plan {
+  raw: PlanResponseData[];
+  resources: ResourcePlan[];
+  
+  constructor(resourcePlans: ResourcePlan[]) {
+    this.raw = resourcePlans.map((r) => r.raw);
+    this.resources = resourcePlans
+  }
+  
+  getResourcePlan(id: string): ResourcePlan | null {
+    return this.resources.find((r) => r.id === id) ?? null;
+  }
+
+  filterNoopResources(): Plan {
+    return new Plan(this.resources.filter((r) => r.operation !== ResourceOperation.NOOP))
+  }
+
+  // If every operation is no-op then a plan is considered empty
+  isEmpty() {
+    return this.raw.every((r) => r.operation === ResourceOperation.NOOP);
+  }
+
+  *[Symbol.iterator](): Iterator<ResourcePlan> {
+    for (const resource of this.resources) {
+      yield resource;
+    }
+  }
+}
+
+export class ResourcePlan {
+  raw: PlanResponseData;
+  planId: string;
+  operation: ResourceOperation;
+  resourceName?: string;
+  resourceType: string;
+  parameters: Array<{
+    name: string;
+    newValue: null | unknown;
+    operation: ParameterOperation;
+    previousValue: null | unknown;
+  }>
+  
+  constructor(json: PlanResponseData) {
+    this.raw = json;
+    this.planId = json.planId;
+    this.operation = json.operation;
+    this.resourceName = json.resourceName;
+    this.resourceType = json.resourceType;
+    this.parameters = json.parameters;
+  }
+  
+  get id(): string {
+    return (this.resourceName) ? `${this.resourceType}.${this.resourceName}` : this.resourceType;
+  }
+  
+  get desiredConfig(): ResourceConfig {
+    return this.raw.parameters.reduce((obj, parameter) => {
+      obj[parameter.name] = parameter.newValue;
+      return obj;
+    }, {} as ResourceConfig);
+  }
+
+  get currentConfig(): ResourceConfig {
+    return this.raw.parameters.reduce((obj, parameter) => {
+      obj[parameter.name] = parameter.previousValue;
+      return obj;
+    }, {} as ResourceConfig);
+  }
+}

src/entities/project.ts

@@ -32,6 +32,7 @@ export class Project {
 
       for (const [idx, r] of resourceConfigs.entries()) {
         r.name = String(idx)
+        r.raw.name = String(idx)
       }
     }
   }
@@ -56,6 +57,7 @@ export class Project {
 
     for (const r of this.resourceConfigs) {
       // User specified dependencies are hard dependencies. They must be present.
+      r.addDependenciesFromDependsOn((id) => resourceMap.has(id));
       r.addDependenciesBasedOnParameters((id) => resourceMap.has(id));
 
       // Plugin dependencies are soft dependencies. They only activate if the dependent resource is present.

src/entities/resource-config.ts

@@ -1,8 +1,8 @@
 import { ResourceSchema } from 'codify-schemas';
 
+import { RemoveMethods } from '../common/types.js';
 import { ConfigClass } from '../parser/language-definition.js';
 import { ajv } from '../utils/ajv.js';
-import { RemoveMethods } from '../common/types.js';
 import { ConfigBlock } from './config.js';
 
 /** Resource JSON supported format
@@ -30,17 +30,21 @@ export class ResourceConfig implements ConfigBlock {
   raw: Record<string, unknown>;
   type: string;
   name?: string;
-  parameters: Record<string, unknown>;
+  dependsOn: string[];
+
+  // Calculated
   dependencyIds: string[] = []; // id of other nodes
+  parameters: Record<string, unknown>;
 
   constructor(config: unknown) {
     if (this.validateConfig(config)) {
-      const { name, type, ...parameters } = config;
+      const { dependsOn, name, type, ...parameters } = config;
 
       this.raw = config;
       this.type = type;
       this.name = name;
       this.parameters = parameters ?? {};
+      this.dependsOn = dependsOn ?? []
 
       return;
     }
@@ -57,7 +61,17 @@ export class ResourceConfig implements ConfigBlock {
   }
 
   get id() {
-    return this.name === null || this.name === undefined ? this.type : `${this.type}.${this.name}`;
+    return this.name ? `${this.type}.${this.name}` : this.type;
+  }
+
+  addDependenciesFromDependsOn(resourceExists: (id: string) => boolean) {
+    for (const id of this.dependsOn) {
+      if (!resourceExists(id)) {
+        throw new Error(`Reference ${id} is not a valid resource`);
+      }
+
+      this.dependencyIds.push(id);
+    }
   }
 
   addDependenciesBasedOnParameters(resourceExists: (id: string) => boolean) {
@@ -66,26 +80,24 @@ export class ResourceConfig implements ConfigBlock {
       .filter(([, v]) => typeof v === 'string')
       .filter(([, v]) => REFERENCE_REGEX.test(v as string));
 
-    parametersWithDependencies.forEach(([, value]) => {
+    for (const [, value] of parametersWithDependencies) {
       const matchResult = [...(value as string).matchAll(REFERENCE_REGEX)];
 
       if (!matchResult) {
         throw new Error('Internal Error: expect dependency match result to not be null');
       }
 
-      const ids = matchResult.map(([, capturedStr]) => {
-        return capturedStr;
-      })
+      const ids = matchResult.map(([, capturedStr]) => capturedStr)
 
       // Validate that each id exists
-      ids.forEach((id) => {
+      for (const id of ids) {
         if (!resourceExists(id)) {
           throw new Error(`Reference ${id} is not a valid resource`)
         }
-      });
+      }
 
       this.dependencyIds.push(...ids);
-    })
+    }
   }
 
   addDependencies(dependencies: string[]) {

src/orchestrators/apply.ts

@@ -1,13 +1,10 @@
-import { ResourceOperation } from 'codify-schemas';
-
-import { ctx, ProcessName } from '../events/context.js';
+import { ProcessName, ctx } from '../events/context.js';
 import { PlanOrchestratorResponse } from './plan.js';
 
 export const ApplyOrchestrator = {
   async run(planResult: PlanOrchestratorResponse): Promise<void> {
     const { plan, pluginManager, project } = planResult;
-    const filteredPlan = plan
-      .filter((p) => p.operation !== ResourceOperation.NOOP)
+    const filteredPlan = plan.filterNoopResources()
 
     ctx.processStarted(ProcessName.APPLY);
     await pluginManager.apply(project, filteredPlan);

src/orchestrators/plan.ts

@@ -1,14 +1,13 @@
-import { PlanResponseData } from 'codify-schemas';
-
 import { CommonOrchestrator } from '../common/orchestrator.js';
+import { Plan } from '../entities/plan.js';
 import { Project } from '../entities/project.js';
-import { ctx, ProcessName, SubProcessName } from '../events/context.js';
+import { ProcessName, SubProcessName, ctx } from '../events/context.js';
 import { Parser } from '../parser/index.js';
 import { PluginManager } from '../plugins/plugin-manager.js';
 import { createStartupShellScriptsIfNotExists } from '../utils/file.js';
 
 export interface PlanOrchestratorResponse {
-  plan: PlanResponseData[],
+  plan: Plan,
   pluginManager: PluginManager;
   project: Project;
 }

src/plugins/plugin-manager.ts

@@ -1,12 +1,13 @@
-import { PlanResponseData, ResourceOperation, ValidateResponseData } from 'codify-schemas';
+import { ResourceOperation, ValidateResponseData } from 'codify-schemas';
 
+import { Plan, ResourcePlan } from '../entities/plan.js';
 import { Project } from '../entities/project.js';
 import { ResourceConfig } from '../entities/resource-config.js';
-import { ctx, SubProcessName } from '../events/context.js';
+import { SubProcessName, ctx } from '../events/context.js';
+import { prettyFormatResourcePlan } from '../ui/plan-pretty-printer.js';
 import { groupBy } from '../utils/index.js';
 import { Plugin } from './plugin.js';
 import { PluginResolver } from './resolver.js';
-import { prettyFormatPlan } from '../ui/plan-pretty-printer.js';
 
 type PluginName = string;
 type ResourceTypeId = string;
@@ -47,8 +48,8 @@ export class PluginManager {
     );
   }
 
-  async getPlan(project: Project): Promise<PlanResponseData[]> {
-    const result = new Array<PlanResponseData>();
+  async getPlan(project: Project): Promise<Plan> {
+    const result = new Array<ResourcePlan>();
     for (const config of project.evaluationOrder) {
       const pluginName = this.resourceToPluginMapping.get(config.type);
       if (!pluginName) {
@@ -60,29 +61,27 @@ export class PluginManager {
       result.push(planResult);
     }
 
-    return result;
+    return new Plan(result);
   }
 
-  async apply(project: Project, planResponseData: PlanResponseData[]): Promise<void> {
-    for (const plan of planResponseData) {
-      const { resourceType } = plan;
+  async apply(project: Project, plan: Plan): Promise<void> {
+    for (const resourcePlan of plan) {
+      ctx.subprocessStarted(SubProcessName.APPLYING_RESOURCE, resourcePlan.id);
 
-      ctx.subprocessStarted(SubProcessName.APPLYING_RESOURCE, resourceType);
-
-      const config = project.evaluationOrder.find((r) => r.type === resourceType);
+      const config = project.evaluationOrder.find((r) => r.id === resourcePlan.id);
       if (!config) {
-        throw new Error(`Could not find plan ${resourceType}`)
+        throw new Error(`Could not find plan ${resourcePlan.id}`)
       }
 
-      const pluginName = this.resourceToPluginMapping.get(resourceType);
+      const pluginName = this.resourceToPluginMapping.get(resourcePlan.resourceType);
       if (!pluginName) {
-        throw new Error(`Internal error: unable to determine plugin for apply: ${resourceType}`);
+        throw new Error(`Internal error: unable to determine plugin for apply: ${resourcePlan.resourceType}`);
       }
 
-      await this.plugins.get(pluginName)!.apply(plan);
+      await this.plugins.get(pluginName)!.apply(resourcePlan);
       await this.validateApply(pluginName, config);
 
-      ctx.subprocessFinished(SubProcessName.APPLYING_RESOURCE, resourceType);
+      ctx.subprocessFinished(SubProcessName.APPLYING_RESOURCE, resourcePlan.id);
     }
   }
 
@@ -145,7 +144,7 @@ export class PluginManager {
       throw new Error(`Plugin: '${pluginName}'. Resource: '${desired.type}'. Additional changes are needed to match the desired plan.
         
 Validation returned: "${validationPlan.operation}" instead of "${ResourceOperation.NOOP}". These changes are remaining.
-${prettyFormatPlan(validationPlan)}
+${prettyFormatResourcePlan(validationPlan)}
       `)
     }
   }

src/plugins/plugin.ts

@@ -8,6 +8,7 @@ import {
   ValidateResponseDataSchema
 } from 'codify-schemas';
 
+import { ResourcePlan } from '../entities/plan.js';
 import { ResourceConfig } from '../entities/resource-config.js';
 import { ajv } from '../utils/ajv.js';
 import { PluginProcess } from './plugin-process.js';
@@ -62,7 +63,7 @@ export class Plugin {
     return data;
   }
 
-  async plan(resource: ResourceConfig): Promise<PlanResponseData> {
+  async plan(resource: ResourceConfig): Promise<ResourcePlan> {
     const { data, status } = await this.process!.sendMessageForResult({ cmd: 'plan', data: resource.raw });
 
     if (status === MessageStatus.ERROR) {
@@ -73,7 +74,7 @@ export class Plugin {
       throw new Error(`Plugin error: plugin ${this.name} returned invalid plan response: ${JSON.stringify(planResponseValidator.errors, null, 2)}`)
     }
 
-    return data;
+    return new ResourcePlan(data);
   }
 
   async apply(plan: PlanResponseData): Promise<void> {