Cleaned up plugin structure + added temporary plugin logging + added Plugin plan call

kevinwang5658 · kevinwang5658 · commit 3c56fed8714d · 2023-11-11T16:58:06.000-05:00
diff --git a/codify-core/src/commands/plan/orchestrator.ts b/codify-core/src/commands/plan/orchestrator.ts
@@ -9,8 +9,9 @@ export const PlanOrchestrator = {
     const resourceDefinitions = await pluginCollection.getAllResourceDefinitions();
 
     await ConfigCompiler.analyzeProject(project, resourceDefinitions);
+    await pluginCollection.getPlan(project);
 
-    console.log(project.coreModule.configBlocks);
+    // console.log(project.coreModule.configBlocks);
 
     await pluginCollection.destroy();
   },
diff --git a/codify-core/src/config-compiler/parser/entities/resource.ts b/codify-core/src/config-compiler/parser/entities/resource.ts
@@ -23,6 +23,7 @@ export class ResourceConfig implements ConfigBlock {
 
   type: string;
   name?: string;
+  pluginName?: string;
   parameters: Record<string, unknown>;
   dependencies: { match: string; parameterName: string; parameterValue: string; resource: ResourceConfig }[] = [];
 
diff --git a/codify-core/src/config-compiler/semantic-analysis/config-semantic-analyzer.ts b/codify-core/src/config-compiler/semantic-analysis/config-semantic-analyzer.ts
@@ -25,7 +25,7 @@ export const ConfigSemanticAnalyzer = {
         throw new Error(`Invalid resource type specified ${type}. Type is not found in any plugins`);
       }
 
-      const { parameters: parameterDefinitions } = definition;
+      const { parameters: parameterDefinitions, pluginName } = definition;
       for (const [key, value] of Object.entries(parameters)) {
 
         if (!parameterDefinitions.has(key)) {
@@ -42,6 +42,8 @@ export const ConfigSemanticAnalyzer = {
           throw new Error(`Invalid resource config ${type}. Allowed values are ${parameter.allowedValues} but ${value} was provided`)
         }
       }
+
+      configBlock.pluginName = pluginName;
     }
   },
 
@@ -58,8 +60,8 @@ export const ConfigSemanticAnalyzer = {
         .map(([name, value]) => [name, String(value), String(value).matchAll(resourceReferenceRegex)] as const)
         .filter(([, _, match]) => match)
         .flatMap(([name, value, matches]) =>
-          [...matches].map(match => [name, value, match[1]] as const
-          ));
+          [...matches].map(match => [name, value, match[1]] as const)
+        );
 
       for (const [name, value, match] of referenceParameters) {
         const parts = match.split('.');
@@ -68,7 +70,7 @@ export const ConfigSemanticAnalyzer = {
         }
 
         if (!resourceMap.has(parts[0])) {
-          throw new Error(`Un-able to find resource being referenced. ${match}`);
+          throw new Error(`Unable to find resource being referenced. ${match}`);
         }
 
         // TODO: Check for circular dependencies
diff --git a/codify-core/src/entities/resource-definition.ts b/codify-core/src/entities/resource-definition.ts
@@ -22,6 +22,7 @@ export type ResourceDefinitions = Map<Name, ResourceDefinition>
 export class ResourceDefinition {
   name!: string;
   parameters!: Map<Name, ResourceParameterDefinition>;
+  pluginName!: string;
 
   constructor(props: RemoveMethods<ResourceDefinition>) {
     Object.assign(this, props);
@@ -36,7 +37,7 @@ export class ResourceDefinition {
       })
 
       const parametersMap = new Map(entries);
-      return new ResourceDefinition({ name: `${pluginName}_${json.name}`, parameters: parametersMap })
+      return new ResourceDefinition({ name: `${pluginName}_${json.name}`, parameters: parametersMap, pluginName })
     }
 
     throw new InternalError('Unable to parse resource definition');
diff --git a/codify-core/src/plugins/entities/plugin.ts b/codify-core/src/plugins/entities/plugin.ts
@@ -1,3 +1,4 @@
+import { ResourceConfig } from '../../config-compiler/parser/entities/resource';
 import { PluginIpcBridge } from '../ipc-bridge';
 import { PluginData } from './plugin-data';
 
@@ -20,6 +21,11 @@ export class Plugin {
     return new Plugin(PluginData.create(directory, name, resourceDefinitions), ipcBridge);
   }
 
+  async generateResourcePlan(resource: ResourceConfig): Promise<unknown> {
+    const plan = await this.ipcBridge.sendMessageForResult({ cmd: 'generateResourcePlan', data: resource });
+    return plan;
+  }
+
   destroy() {
     this.ipcBridge.killPlugin();
   }
diff --git a/codify-core/src/plugins/ipc-bridge.ts b/codify-core/src/plugins/ipc-bridge.ts
@@ -23,6 +23,10 @@ export class PluginIpcBridge {
       { execArgv: ['-r', 'ts-node/register'], silent: true },
     );
 
+    process.stdout!.on('data', (message) => console.log(message.toString()));
+    process.stderr!.on('data', (message) => console.log(message.toString()));
+
+
     return new PluginIpcBridge(process);
   }
 
diff --git a/codify-core/src/plugins/plugin-collection.ts b/codify-core/src/plugins/plugin-collection.ts
@@ -2,6 +2,8 @@ import { ParsedProject } from '../config-compiler/parser/entities';
 import { ResourceDefinition } from '../entities/resource-definition';
 import { Plugin } from './entities/plugin';
 import { PluginResolver } from './resolver';
+import { ConfigBlockType } from '../config-compiler/language-definition';
+import { ResourceConfig } from '../config-compiler/parser/entities/resource';
 
 type PluginName = string;
 
@@ -54,6 +56,28 @@ export class PluginCollection {
     return result;
   }
 
+  async getPlan(project: ParsedProject): Promise<void> {
+    for (const config of project.coreModule.configBlocks) {
+      if (config.configType !== ConfigBlockType.RESOURCE) {
+        continue;
+      }
+
+      const { pluginName } = (config as ResourceConfig);
+      if (!pluginName) {
+        continue;
+      }
+
+      const plugin = this.plugins.get(pluginName);
+      if (!plugin) {
+        continue;
+      }
+
+      // eslint-disable-next-line no-await-in-loop
+      const result = await plugin.generateResourcePlan(config as ResourceConfig);
+      console.log(result);
+    }
+  }
+
   async destroy(): Promise<void> {
     for (const plugin of this.plugins.values()) {
       plugin.destroy();
diff --git a/plugins/homebrew/package.json b/plugins/homebrew/package.json
@@ -2,9 +2,10 @@
   "name": "homebrew",
   "version": "1.0.0",
   "description": "",
-  "main": "index.js",
+  "main": "src/index.ts",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
+    "start": "ts-node .",
     "build": "tsc"
   },
   "devDependencies": {
diff --git a/plugins/homebrew/resource-definitions/main.json b/plugins/homebrew/resource-definitions/main.json
@@ -1,5 +1,5 @@
 {
-  "name": "installation",
+  "name": "main",
   "parameters": {
     "directory": "string"
   }
diff --git a/plugins/homebrew/src/implementation/plugin.ts b/plugins/homebrew/src/implementation/plugin.ts
@@ -0,0 +1,11 @@
+import { Plugin } from "../library/entities/plugin";
+import {HomebrewMainResource} from "./resources";
+import {HomebrewOptionsResource} from "./resources/options";
+
+export class HomebrewPlugin extends Plugin {
+  name = 'homebrew'
+  resources = [
+    new HomebrewMainResource(),
+    new HomebrewOptionsResource(),
+  ]
+}
diff --git a/plugins/homebrew/src/implementation/resources/index.ts b/plugins/homebrew/src/implementation/resources/index.ts
@@ -0,0 +1,29 @@
+import {Resource} from "../../library/entities/resource";
+import {ResourceDefinition, ResourceParameterType} from "../../library/entities/resource-definition";
+import {PlanOperation, ResourceParameterPlan} from "../../library/entities/plan";
+
+const HomebrewMainResourceDef = <ResourceDefinition> {
+  name: 'homebrew',
+  parameters: {
+    a: {
+      name: 'a',
+      type: ResourceParameterType.STRING,
+    }
+  }
+}
+
+export class HomebrewMainResource extends Resource<typeof HomebrewMainResourceDef> {
+  definitionFileName = 'main.json'
+
+  async generatePlanForResource(resourceConfig: Record<string, unknown>): Promise<Record<keyof typeof HomebrewMainResourceDef["parameters"], ResourceParameterPlan>> {
+    return {
+      a: {
+        parameterName: 'a',
+        previousValue: 'a',
+        operation: PlanOperation.MODIFY
+      }
+    }
+  }
+
+
+}
diff --git a/plugins/homebrew/src/implementation/resources/options.ts b/plugins/homebrew/src/implementation/resources/options.ts
@@ -0,0 +1,11 @@
+import { Resource } from "../../library/entities/resource";
+import {ResourceParameterPlan} from "../../library/entities/plan";
+
+export class HomebrewOptionsResource extends Resource<any> {
+  definitionFileName = 'options.json';
+
+  async generatePlanForResource(resourceConfig: Record<string, unknown>): Promise<Record<keyof any, ResourceParameterPlan>> {
+    return {}; //Promise.resolve(undefined);
+  }
+
+}
diff --git a/plugins/homebrew/src/index.ts b/plugins/homebrew/src/index.ts
@@ -1,50 +1,4 @@
-import * as fs from "fs/promises";
-import * as path from "path";
+import { runPlugin } from "./library";
+import { HomebrewPlugin } from "./implementation/plugin";
 
-interface Message {
-  cmd: string;
-  data?: unknown;
-}
-
-if (!process.send) {
-  throw new Error('Unable to find process.send. The child process was not started with fork()');
-}
-
-process.on('message', async (message) => {
-  console.log(message);
-
-  if (!validateMessage(message)) {
-    return;
-  }
-
-  if (message.cmd === 'getResourceDefinitions') {
-    const dir = path.join(__dirname, '../resource-definitions');
-
-    const files = await fs.readdir(dir);
-    const json = await Promise.all(files.map(async (fileName) => {
-      const contents = await fs.readFile(path.join(dir, fileName), 'utf8');
-      return JSON.parse(contents);
-    }))
-
-    process.send!({ cmd: message.cmd + 'Result', data: json });
-  }
-})
-
-process.send!({ cmd: 'something', data: 'somthing' })
-
-function validateMessage(message: unknown): message is Message {
-  if (!message) {
-    return false;
-  }
-
-  if (typeof message !== 'object') {
-    return false;
-  }
-
-  // @ts-ignore
-  if (!message.cmd) {
-    return false;
-  }
-
-  return true;
-}
+runPlugin(new HomebrewPlugin());
diff --git a/plugins/homebrew/src/library/entities/plan.ts b/plugins/homebrew/src/library/entities/plan.ts
@@ -0,0 +1,13 @@
+export enum PlanOperation {
+  NO_CHANGE = 'no_change',
+  ADD = 'add',
+  DELETE = 'delete',
+  MODIFY = 'modify'
+}
+
+export interface ResourceParameterPlan {
+  parameterName: string;
+  previousValue: any;
+  newValue?: any;
+  operation: PlanOperation
+}
diff --git a/plugins/homebrew/src/library/entities/plugin.ts b/plugins/homebrew/src/library/entities/plugin.ts
@@ -0,0 +1,20 @@
+import { Resource } from "./resource";
+import { Message } from "../ipc/entities";
+
+export abstract class Plugin {
+
+  abstract resources: Array<Resource<any>>
+  abstract name: string;
+
+  async onInitialize(): Promise<void> {
+    await Promise.all(this.resources.map((resource) => resource.initialize()));
+  }
+
+  async getResourceDefinitions(message: Message): Promise<Array<Record<string, unknown>>> {
+    const definitions = await Promise.all(this.resources.map((resources) => resources.getResourceDefinitions()));
+    return definitions.flat(1);
+  }
+
+  async onDestroy(): Promise<void> {}
+
+}
diff --git a/plugins/homebrew/src/library/entities/resource-definition.ts b/plugins/homebrew/src/library/entities/resource-definition.ts
@@ -0,0 +1,24 @@
+export interface ResourceDefinition {
+  name: string;
+  parameters: Record<string, ResourceParameterDefinition>;
+}
+
+type ResourceParameter = [] | boolean | null | number | object | string
+
+
+export interface ResourceParameterDefinition {
+  name: string;
+  type: ResourceParameterType
+  allowedValues?: ResourceParameter | ResourceParameter[];
+  minNumberValue?: number;
+  maxNumberValue?: number;
+}
+
+export enum ResourceParameterType {
+  ARRAY = 'array',
+  BOOLEAN = 'boolean',
+  NULL = 'null',
+  NUMBER = 'number',
+  OBJECT = 'object',
+  STRING = 'string',
+}
diff --git a/plugins/homebrew/src/library/entities/resource.ts b/plugins/homebrew/src/library/entities/resource.ts
@@ -0,0 +1,45 @@
+import * as path from "path";
+import * as fs from "fs/promises";
+import { validateResourceConfig } from "../utils/validators";
+import { ResourceDefinition } from "./resource-definition";
+import { ResourceParameterPlan } from "./plan";
+
+export abstract class Resource<T extends ResourceDefinition> {
+
+  abstract definitionFileName: string;
+  private definition?: ResourceDefinition;
+
+  async initialize(): Promise<void> {}
+
+  async getResourceDefinitions(): Promise<Record<string, unknown>> {
+    const dir = path.join(__dirname, '../../../resource-definitions');
+
+    const files = await fs.readdir(dir);
+    if (!files.find((name) => name === this.definitionFileName)) {
+      throw new Error(`Definition file ${this.definitionFileName} cannot be found. Please define a resource in resource-definitions`)
+    }
+
+    const contents = await fs.readFile(path.join(dir, this.definitionFileName), 'utf8');
+    const json = JSON.parse(contents);
+    this.definition = json as ResourceDefinition;
+
+    // TODO: Add validation for the file
+
+    return json;
+  }
+
+  async runGeneratePlanForResource(resourceConfig: unknown): Promise<Record<string, unknown>> {
+    if (!this.definition) {
+      throw new Error('Internal Error :: getResourceDefinitions must be run before runGeneratePlanForResource')
+    }
+
+    if (!validateResourceConfig(resourceConfig, this.definition)) {
+      throw new Error();
+    }
+
+    return await this.generatePlanForResource(resourceConfig);
+  }
+
+  abstract generatePlanForResource(resourceConfig: Record<string, unknown>): Promise<Record<keyof T['parameters'], ResourceParameterPlan>>;
+
+}
diff --git a/plugins/homebrew/src/library/index.ts b/plugins/homebrew/src/library/index.ts
@@ -0,0 +1,8 @@
+import { Plugin} from "./entities/plugin";
+import { onMessage } from "./ipc/message-handlers";
+
+export async function runPlugin(plugin: Plugin) {
+  await plugin.onInitialize();
+
+  process.on('message', (message) => onMessage(plugin, message))
+}
diff --git a/plugins/homebrew/src/library/ipc/entities.ts b/plugins/homebrew/src/library/ipc/entities.ts
@@ -0,0 +1,4 @@
+export interface Message {
+  cmd: string;
+  data?: unknown;
+}
diff --git a/plugins/homebrew/src/library/ipc/message-handlers.ts b/plugins/homebrew/src/library/ipc/message-handlers.ts
diff --git a/plugins/homebrew/src/library/utils/validators.ts b/plugins/homebrew/src/library/utils/validators.ts

Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@ export const ConfigSemanticAnalyzer = {`
`25`	`25`	throw new Error(`Invalid resource type specified ${type}. Type is not found in any plugins`);
`26`	`26`	`}`
`27`	`27`
`28`		`- const { parameters: parameterDefinitions } = definition;`
	`28`	`+ const { parameters: parameterDefinitions, pluginName } = definition;`
`29`	`29`	`for (const [key, value] of Object.entries(parameters)) {`
`30`	`30`
`31`	`31`	`if (!parameterDefinitions.has(key)) {`
`@@ -42,6 +42,8 @@ export const ConfigSemanticAnalyzer = {`
`42`	`42`	throw new Error(`Invalid resource config ${type}. Allowed values are ${parameter.allowedValues} but ${value} was provided`)
`43`	`43`	`}`
`44`	`44`	`}`
	`45`	`+`
	`46`	`+ configBlock.pluginName = pluginName;`
`45`	`47`	`}`
`46`	`48`	`},`
`47`	`49`
`@@ -58,8 +60,8 @@ export const ConfigSemanticAnalyzer = {`
`58`	`60`	`.map(([name, value]) => [name, String(value), String(value).matchAll(resourceReferenceRegex)] as const)`
`59`	`61`	`.filter(([, _, match]) => match)`
`60`	`62`	`.flatMap(([name, value, matches]) =>`
`61`		`- [...matches].map(match => [name, value, match[1]] as const`
`62`		`- ));`
	`63`	`+ [...matches].map(match => [name, value, match[1]] as const)`
	`64`	`+ );`
`63`	`65`
`64`	`66`	`for (const [name, value, match] of referenceParameters) {`
`65`	`67`	`const parts = match.split('.');`
`@@ -68,7 +70,7 @@ export const ConfigSemanticAnalyzer = {`
`68`	`70`	`}`
`69`	`71`
`70`	`72`	`if (!resourceMap.has(parts[0])) {`
`71`		- throw new Error(`Un-able to find resource being referenced. ${match}`);
	`73`	+ throw new Error(`Unable to find resource being referenced. ${match}`);
`72`	`74`	`}`
`73`	`75`
`74`	`76`	`// TODO: Check for circular dependencies`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+import { ResourceConfig } from '../../config-compiler/parser/entities/resource';`
`1`	`2`	`import { PluginIpcBridge } from '../ipc-bridge';`
`2`	`3`	`import { PluginData } from './plugin-data';`
`3`	`4`
`@@ -20,6 +21,11 @@ export class Plugin {`
`20`	`21`	`return new Plugin(PluginData.create(directory, name, resourceDefinitions), ipcBridge);`
`21`	`22`	`}`
`22`	`23`
	`24`	`+ async generateResourcePlan(resource: ResourceConfig): Promise<unknown> {`
	`25`	`+ const plan = await this.ipcBridge.sendMessageForResult({ cmd: 'generateResourcePlan', data: resource });`
	`26`	`+ return plan;`
	`27`	`+ }`
	`28`	`+`
`23`	`29`	`destroy() {`
`24`	`30`	`this.ipcBridge.killPlugin();`
`25`	`31`	`}`
Original file line number	Diff line number	Diff line change
`@@ -23,6 +23,10 @@ export class PluginIpcBridge {`
`23`	`23`	`{ execArgv: ['-r', 'ts-node/register'], silent: true },`
`24`	`24`	`);`
`25`	`25`
	`26`	`+ process.stdout!.on('data', (message) => console.log(message.toString()));`
	`27`	`+ process.stderr!.on('data', (message) => console.log(message.toString()));`
	`28`	`+`
	`29`	`+`
`26`	`30`	`return new PluginIpcBridge(process);`
`27`	`31`	`}`
`28`	`32`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`{`
`2`		`- "name": "installation",`
	`2`	`+ "name": "main",`
`3`	`3`	`"parameters": {`
`4`	`4`	`"directory": "string"`
`5`	`5`	`}`