Updated to latest codify-schema version and fixed API changes. Added start-vm and init scripts to bin. Added ability to resolve local .ts and .js files for easier testing

Author: kevinwang5658

bin/init.sh

@@ -0,0 +1 @@
+tart clone ghcr.io/cirruslabs/macos-sonoma-base:latest codify-cli-vm

bin/start-vm.sh

@@ -0,0 +1,26 @@
+#!/bin/bash
+
+tart run codify-sonoma --dir ./dist/macos --no-graphics &
+
+sleep 5
+
+echo "Started tart vm"
+tart ip codify-sonoma
+
+sleep 10
+
+if [ -d .Trashes ]; then
+  echo "Found .Trashes folder generated by Tart. Deleting... Not deleting this will lead to run time issues."
+  sudo rm -rf .Trashes
+fi
+
+if [ -d .fseventsd ]; then
+  echo "Found .fseventsd folder generated by Tart. Deleting... Not deleting this will lead to run time issues."
+  sudo rm -rf .fseventsd
+fi
+
+# keep this script running indefinitely
+tail -f /dev/null
+
+# Kill the vm (child process) when this script ends
+trap "tart stop codify-sonoma" EXIT

package.json

@@ -8,9 +8,10 @@
     "@oclif/plugin-help": "^5",
     "@oclif/plugin-plugins": "^3.8.4",
     "semver": "^7.5.4",
-    "codify-schemas": "1.0.28",
+    "codify-schemas": "1.0.32",
     "ajv": "^8.12.0",
-    "ajv-formats": "^3.0.1"
+    "ajv-formats": "^3.0.1",
+    "tsx": "^4.7.3"
   },
   "description": "Codify is a set up as code tool for developers",
   "devDependencies": {
@@ -76,12 +77,13 @@
     "build": "shx rm -rf dist && tsc -b",
     "lint": "eslint . --ext .ts",
     "postpack": "shx rm -f oclif.manifest.json",
-    "pack": "oclif pack macos -r .",
+    "build:release:macos": "oclif pack macos -r .",
     "posttest": "npm run lint",
     "prepack": "npm run build && oclif manifest && oclif readme",
     "test": "mocha --forbid-only \"test/**/*.test.ts\"",
     "version": "oclif readme && git add README.md",
-    "start:dev": "tsc && node ./bin/run.js"
+    "start:dev": "tsc && node ./bin/run.js",
+    "start:vm": "npm run build && npm run pack:macos && npm run start:vm"
   },
   "version": "0.0.0",
   "bugs": "https://github.com/kevinwang5658/codify/issues",

src/entities/project.ts

@@ -38,15 +38,18 @@ export class Project {
   }
 
   handlePluginResourceValidationResults(results: ValidateResponseData[]) {
-    const isValid = results.reduce((prev, curr) => prev && curr.isValid, true);
-    if (!isValid) {
-      const errors = results
-        .filter((r) => (r.errors?.length ?? 0) > 0)
-        .flat(1)
-        .map((e) => JSON.stringify(e, null, 2))
-        .join('\n\n');
+    const resultsFlattened = results.flatMap((r) => r.validationResults);
 
-      throw new Error(`Config definition errors: \n ${errors}`);
+    const isValid = resultsFlattened.every((r) => r.isValid);
+    if (!isValid) {
+      throw new Error(`Config definition errors: 
+${JSON.stringify(
+        resultsFlattened
+          .filter((r) => !r.isValid),
+        null,
+        2
+      )}
+      `);
     }
   }
 

src/plugins/entities/plugin.ts

@@ -9,29 +9,31 @@ import {
 
 import { ResourceConfig } from '../../entities/resource-config.js';
 import { ajv } from '../../utils/ajv.js';
-import { PluginIpcBridge } from '../ipc-bridge.js';
+import { PluginProcess } from '../plugin-process.js';
 
 const initializeResponseValidator = ajv.compile(InitializeResponseDataSchema);
 const validateResponseValidator = ajv.compile(ValidateResponseDataSchema);
 const planResponseValidator = ajv.compile(PlanResponseDataSchema);
 
 export class Plugin {
 
-  ipcBridge?: PluginIpcBridge;
+  process?: PluginProcess;
 
   name: string;
+  version: string;
   path: string;
   resourceDependenciesMap = new Map<string, string[]>()
 
-  constructor(name: string, path: string) {
+  constructor(name: string, version: string, path: string) {
     this.name = name;
+    this.version = version;
     this.path = path;
   }
 
   async initialize(): Promise<InitializeResponseData> {
-    this.ipcBridge = await PluginIpcBridge.create(this.path);
+    this.process = await PluginProcess.start(this.path);
 
-    const initializeResponse = await this.ipcBridge.sendMessageForResult({ cmd: 'initialize', data: {} });
+    const initializeResponse = await this.process.sendMessageForResult({ cmd: 'initialize', data: {} });
 
     if (!this.validateInitializeResponse(initializeResponse)) {
       throw new Error(`Invalid initialize response from plugin: ${this.name}`);
@@ -46,7 +48,7 @@ export class Plugin {
 
   async validate(configs: ResourceConfig[]): Promise<ValidateResponseData> {
     const rawConfigs = configs.map((c) => c.raw);
-    const response = await this.ipcBridge!.sendMessageForResult({ cmd: 'validate', data: { configs: rawConfigs } });
+    const response = await this.process!.sendMessageForResult({ cmd: 'validate', data: { configs: rawConfigs } });
 
     if (!this.validateValidateResponse(response)) {
       throw new Error(`Invalid validate response from plugin: ${this.name}`);
@@ -56,7 +58,7 @@ export class Plugin {
   }
 
   async plan(resource: ResourceConfig): Promise<PlanResponseData> {
-    const response = await this.ipcBridge!.sendMessageForResult({ cmd: 'plan', data: resource.raw });
+    const response = await this.process!.sendMessageForResult({ cmd: 'plan', data: resource.raw });
 
     if (!this.validatePlanResponse(response)) {
       throw new Error(`Plugin error: plugin ${this.name} returned invalid plan response`)
@@ -66,11 +68,11 @@ export class Plugin {
   }
 
   async apply(planId: string): Promise<void> {
-    await this.ipcBridge!.sendMessageForResult({ cmd: 'apply', data: { planId } });
+    await this.process!.sendMessageForResult({ cmd: 'apply', data: { planId } });
   }
 
   destroy() {
-    this.ipcBridge!.killPlugin();
+    this.process!.killPlugin();
   }
 
   private validateInitializeResponse(response: unknown): response is InitializeResponseData {

src/plugins/ipc-bridge.test.ts src/plugins/plugin-process.test.tssrc/plugins/ipc-bridge.test.ts renamed to src/plugins/plugin-process.test.ts

@@ -3,7 +3,7 @@ import { EventEmitter } from 'node:events';
 import { ChildProcess } from 'node:child_process';
 
 import { Readable } from 'stream';
-import { PluginIpcBridge } from './ipc-bridge.js';
+import { PluginProcess } from './plugin-process.js';
 import { mock } from 'node:test';
 import { expect } from '@oclif/test';
 import * as chai from 'chai';
@@ -30,7 +30,7 @@ describe('Plugin IPC Bridge tests', async () => {
     const process = mockChildProcess();
     const sendMock = mock.method(process, 'send');
 
-    const ipcBridge = new PluginIpcBridge(process);
+    const ipcBridge = new PluginProcess(process);
     ipcBridge.sendMessage({ cmd: 'message', data: 'data' })
 
     expect(sendMock.mock.calls.length).to.eq(1);
@@ -39,7 +39,7 @@ describe('Plugin IPC Bridge tests', async () => {
 
   it('send a message and receives the response', async () => {
     const process = mockChildProcess();
-    const ipcBridge = new PluginIpcBridge(process);
+    const ipcBridge = new PluginProcess(process);
 
     try {
       await Promise.all([
@@ -53,7 +53,7 @@ describe('Plugin IPC Bridge tests', async () => {
 
   it('validates bad responses', async () => {
     const process = mockChildProcess();
-    const ipcBridge = new PluginIpcBridge(process);
+    const ipcBridge = new PluginProcess(process);
 
     try {
       await Promise.all([
@@ -67,7 +67,7 @@ describe('Plugin IPC Bridge tests', async () => {
 
   it('does not leave additional listeners', async () => {
     const process = mockChildProcess();
-    const ipcBridge = new PluginIpcBridge(process);
+    const ipcBridge = new PluginProcess(process);
 
     // NodeJS promise.all is executed in order
     await Promise.all([
@@ -82,7 +82,7 @@ describe('Plugin IPC Bridge tests', async () => {
 
   it('does not interfere with existing listeners', async () => {
     const process = mockChildProcess();
-    const ipcBridge = new PluginIpcBridge(process);
+    const ipcBridge = new PluginProcess(process);
     process.on('message', () => {
     })
 
@@ -96,7 +96,7 @@ describe('Plugin IPC Bridge tests', async () => {
 
   it('allows new listeners to be added while waiting for the result', async () => {
     const process = mockChildProcess();
-    const ipcBridge = new PluginIpcBridge(process);
+    const ipcBridge = new PluginProcess(process);
 
     await Promise.all([
       ipcBridge.sendMessageForResult({ cmd: 'message', data: 'data' }),

src/plugins/ipc-bridge.ts src/plugins/plugin-process.tssrc/plugins/ipc-bridge.ts renamed to src/plugins/plugin-process.ts

@@ -11,25 +11,25 @@ type Reject = (reason?: Error) => void;
 
 const resultFunctionName = (cmd: string) => `${cmd}_Response`;
 
-export class PluginIpcBridge {
+export class PluginProcess {
   process: ChildProcess;
 
   constructor(process: ChildProcess) {
     this.process = process;
   }
 
-  static async create(jsFileDir: string): Promise<PluginIpcBridge> {
+  static async start(jsFileDir: string): Promise<PluginProcess> {
     const process = fork(
       jsFileDir,
       [],
-      { execArgv: ['-r', 'ts-node/register'], silent: true },
+      { execArgv: ['--import', 'tsx'], silent: true },
     );
 
     process.stdout!.on('data', (message) => console.log(message.toString()));
     process.stderr!.on('data', (message) => console.log(message.toString()));
 
 
-    return new PluginIpcBridge(process);
+    return new PluginProcess(process);
   }
 
   killPlugin(): void {

src/plugins/resolver.ts

@@ -11,14 +11,37 @@ const PLUGIN_CACHE_DIR = '/Library/Caches/codify/plugins'
 
 export class PluginResolver {
 
-  static async resolve(name: string, version?: string): Promise<Plugin> {
+  static async resolve(name: string, version: string): Promise<Plugin> {
     await PluginResolver.checkAndCreateCacheDirIfNotExists()
 
-    // TODO: Add plugin versioning in the future
-    return this.resolvePlugin(name)
+    let directoryStat;
+    try {
+      directoryStat = await fs.stat(version);
+    } catch {
+    }
+
+    // For easier development. A direct js file can be specified for the plugin.
+    if (directoryStat && directoryStat.isFile()) {
+      return PluginResolver.resolvePluginFs(name, version)
+    }
+
+    return PluginResolver.resolvePluginWeb(name, version)
   }
 
-  private static async resolvePlugin(name: string): Promise<Plugin> {
+  private static async resolvePluginFs(name: string, filePath: string): Promise<Plugin> {
+    const fileExtension = filePath.slice(filePath.lastIndexOf('.'))
+    if (fileExtension !== '.js' && fileExtension !== '.ts') {
+      throw new Error(`Only .js and .ts plugins are support currently. Can't resolve ${filePath}`);
+    }
+
+    return new Plugin(
+      name,
+      '0.0.0',
+      filePath,
+    )
+  }
+
+  private static async resolvePluginWeb(name: string, version: string): Promise<Plugin> {
     const { body } = await fetch(DEFAULT_PLUGIN_URL)
     if (!body) {
       throw new Error(`Un-able to fetch plugin ${name}. Body was null`);
@@ -32,13 +55,26 @@ export class PluginResolver {
 
     return new Plugin(
         name,
+      version,
         fileUrl,
     )
   }
 
   private static async checkAndCreateCacheDirIfNotExists() {
-    if (!(await fs.stat(PLUGIN_CACHE_DIR))) {
-      await fs.mkdir(PLUGIN_CACHE_DIR);
+    let pluginDirStat = null;
+    try {
+      pluginDirStat = await fs.stat(PLUGIN_CACHE_DIR)
+    } catch {
+    }
+
+    if (pluginDirStat && pluginDirStat.isDirectory()) {
+      return;
     }
+
+    if (pluginDirStat && !pluginDirStat.isDirectory()) {
+      throw new Error(`An object already exists at ${PLUGIN_CACHE_DIR} and is not a directory. Please delete and try again`);
+    }
+
+    await fs.mkdir(PLUGIN_CACHE_DIR, { recursive: true });
   }
 }