codify-plugin-lib 1.0.31 → 1.0.33

package/dist/entities/plugin.d.ts

@@ -1,11 +1,11 @@
 import { Resource } from './resource.js';
-import { ApplyRequestData, PlanRequestData, PlanResponseData, ResourceConfig, ValidateRequestData, ValidateResponseData } from 'codify-schemas';
+import { ApplyRequestData, InitializeResponseData, PlanRequestData, PlanResponseData, ResourceConfig, ValidateRequestData, ValidateResponseData } from 'codify-schemas';
 import { Plan } from './plan.js';
 export declare class Plugin {
     resources: Map<string, Resource<ResourceConfig>>;
     planStorage: Map<string, Plan<ResourceConfig>>;
     constructor(resources: Map<string, Resource<ResourceConfig>>);
-    onInitialize(): Promise<void>;
+    initialize(): Promise<InitializeResponseData>;
     validate(data: ValidateRequestData): Promise<ValidateResponseData>;
     plan(data: PlanRequestData): Promise<PlanResponseData>;
     apply(data: ApplyRequestData): Promise<void>;

package/dist/entities/plugin.js

@@ -5,17 +5,34 @@ export class Plugin {
         this.resources = resources;
         this.planStorage = new Map();
     }
-    async onInitialize() {
+    async initialize() {
+        for (const resource of this.resources.values()) {
+            await resource.onInitialize();
+        }
+        return {
+            resourceDefinitions: [...this.resources.values()]
+                .map((r) => ({
+                type: r.getTypeId(),
+                dependencies: r.getDependencyTypeIds(),
+            }))
+        };
     }
     async validate(data) {
+        const totalErrors = [];
         for (const config of data.configs) {
             if (!this.resources.has(config.type)) {
                 throw new Error(`Resource type not found: ${config.type}`);
             }
-            await this.resources.get(config.type).validate(config);
+            const error = await this.resources.get(config.type).validate(config);
+            if (error) {
+                totalErrors.push(error);
+            }
         }
         await this.crossValidateResources(data.configs);
-        return null;
+        return {
+            isValid: true,
+            errors: totalErrors.length !== 0 ? totalErrors : null,
+        };
     }
     async plan(data) {
         if (!this.resources.has(data.type)) {

package/dist/entities/resource.d.ts

@@ -7,11 +7,12 @@ export declare abstract class Resource<T extends ResourceConfig> {
     private statefulParameters;
     constructor(dependencies?: Resource<any>[]);
     abstract getTypeId(): string;
+    getDependencyTypeIds(): string[];
     onInitialize(): Promise<void>;
     plan(desiredConfig: T): Promise<Plan<T>>;
     apply(plan: Plan<T>): Promise<void>;
     protected registerStatefulParameter(parameter: StatefulParameter<T, keyof T>): void;
-    abstract validate(config: unknown): Promise<boolean>;
+    abstract validate(config: unknown): Promise<string | undefined>;
     abstract getCurrentConfig(desiredConfig: T): Promise<T | null>;
     abstract calculateOperation(change: ParameterChange): ResourceOperation.MODIFY | ResourceOperation.RECREATE;
     abstract applyCreate(plan: Plan<T>): Promise<void>;

package/dist/entities/resource.js

@@ -7,9 +7,11 @@ export class Resource {
     constructor(dependencies = []) {
         this.dependencies = dependencies;
     }
+    getDependencyTypeIds() {
+        return this.dependencies.map((d) => d.getTypeId());
+    }
     async onInitialize() { }
     async plan(desiredConfig) {
-        await this.validate(desiredConfig);
         const currentConfig = await this.getCurrentConfig(desiredConfig);
         if (!currentConfig) {
             return Plan.create(ChangeSet.createForNullCurrentConfig(desiredConfig), desiredConfig);

package/dist/index.js

@@ -7,7 +7,6 @@ export * from './entities/stateful-parameter.js';
 export * from './utils/test-utils.js';
 export * from './utils/utils.js';
 export async function runPlugin(plugin) {
-    await plugin.onInitialize();
     const messageHandler = new MessageHandler(plugin);
     process.on('message', (message) => messageHandler.onMessage(message));
 }

package/dist/messages/handlers.js

@@ -1,7 +1,12 @@
 import addFormats from 'ajv-formats';
-import { IpcMessageSchema, ResourceSchema, ValidateRequestDataSchema, ValidateResponseDataSchema, MessageStatus, PlanRequestDataSchema, PlanResponseDataSchema, ApplyRequestDataSchema, ApplyResponseDataSchema } from 'codify-schemas';
+import { ApplyRequestDataSchema, ApplyResponseDataSchema, InitializeRequestDataSchema, InitializeResponseDataSchema, IpcMessageSchema, MessageStatus, PlanRequestDataSchema, PlanResponseDataSchema, ResourceSchema, ValidateRequestDataSchema, ValidateResponseDataSchema } from 'codify-schemas';
 import Ajv2020 from 'ajv/dist/2020.js';
 const SupportedRequests = {
+    'initialize': {
+        requestValidator: InitializeRequestDataSchema,
+        responseValidator: InitializeResponseDataSchema,
+        handler: async (plugin) => plugin.initialize()
+    },
     'validate': {
         requestValidator: ValidateRequestDataSchema,
         responseValidator: ValidateResponseDataSchema,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "codify-plugin-lib",
-  "version": "1.0.31",
+  "version": "1.0.33",
   "description": "",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -14,7 +14,7 @@
   "dependencies": {
     "ajv": "^8.12.0",
     "ajv-formats": "^2.1.1",
-    "codify-schemas": "1.0.21",
+    "codify-schemas": "1.0.28",
     "@npmcli/promise-spawn": "^7.0.1"
   },
   "devDependencies": {

package/src/entities/plugin.ts

@@ -1,6 +1,7 @@
 import { Resource } from './resource.js';
 import {
   ApplyRequestData,
+  InitializeResponseData,
   PlanRequestData,
   PlanResponseData,
   ResourceConfig,
@@ -18,21 +19,38 @@ export class Plugin {
     this.planStorage = new Map();
   }
 
-  async onInitialize(): Promise<void> {
+  async initialize(): Promise<InitializeResponseData> {
+    for (const resource of this.resources.values()) {
+      await resource.onInitialize();
+    }
 
+    return {
+      resourceDefinitions: [...this.resources.values()]
+        .map((r) => ({
+          type: r.getTypeId(),
+          dependencies: r.getDependencyTypeIds(),
+        }))
+    }
   }
 
   async validate(data: ValidateRequestData): Promise<ValidateResponseData> {
+    const totalErrors = [];
     for (const config of data.configs) {
       if (!this.resources.has(config.type)) {
         throw new Error(`Resource type not found: ${config.type}`);
       }
 
-      await this.resources.get(config.type)!.validate(config);
+      const error = await this.resources.get(config.type)!.validate(config);
+      if (error) {
+        totalErrors.push(error);
+      }
     }
 
     await this.crossValidateResources(data.configs);
-    return null;
+    return {
+      isValid: true,
+      errors: totalErrors.length !== 0 ? totalErrors : null,
+    }
   }
 
   async plan(data: PlanRequestData): Promise<PlanResponseData> {

package/src/entities/resource.test.ts

@@ -1,10 +1,10 @@
-import { Resource } from './resource';
+import { Resource } from './resource.js';
 import { ParameterOperation, ResourceConfig, ResourceOperation } from 'codify-schemas';
-import { ChangeSet, ParameterChange } from './change-set';
+import { ChangeSet, ParameterChange } from './change-set.js';
 import { spy } from 'sinon';
-import { Plan } from './plan';
-import { StatefulParameter } from './stateful-parameter';
-import { describe, it, expect } from 'vitest'
+import { Plan } from './plan.js';
+import { StatefulParameter } from './stateful-parameter.js';
+import { describe, expect, it } from 'vitest'
 
 class TestResource extends Resource<TestConfig> {
   applyCreate(plan: Plan<TestConfig>): Promise<void> {
@@ -27,12 +27,12 @@ class TestResource extends Resource<TestConfig> {
     return ResourceOperation.MODIFY;
   }
 
-  async getCurrentConfig(): Promise<TestConfig> {
-    return Promise.resolve(undefined);
+  async getCurrentConfig(): Promise<TestConfig | null> {
+    return null;
   }
 
-  validate(config: ResourceConfig): Promise<boolean> {
-    return Promise.resolve(false);
+  async validate(config: ResourceConfig): Promise<string | undefined> {
+    return undefined;
   }
 
   getTypeId(): string {
@@ -127,7 +127,7 @@ describe('Resource tests', () => {
         return ResourceOperation.MODIFY;
       }
 
-      async getCurrentConfig(): Promise<TestConfig> {
+      async getCurrentConfig(): Promise<TestConfig | null> {
         return null;
       }
     }
@@ -230,8 +230,8 @@ describe('Resource tests', () => {
         return Promise.resolve(undefined);
       }
 
-      getCurrent(): Promise<TestConfig["propA"]> {
-        return Promise.resolve(undefined);
+      async getCurrent(): Promise<TestConfig["propA"]> {
+        return '';
       }
     }
 
@@ -298,8 +298,8 @@ describe('Resource tests', () => {
         return Promise.resolve(undefined);
       }
 
-      getCurrent(): Promise<TestConfig["propA"]> {
-        return Promise.resolve(undefined);
+      async getCurrent(): Promise<TestConfig["propA"]> {
+        return '';
       }
     }
 

package/src/entities/resource.ts

@@ -13,13 +13,15 @@ export abstract class Resource<T extends ResourceConfig> {
 
   abstract getTypeId(): string;
 
+  getDependencyTypeIds(): string[] {
+    return this.dependencies.map((d) => d.getTypeId())
+  }
+
   async onInitialize(): Promise<void> {}
 
   // TODO: Add state in later.
   //  Calculate change set from current config -> state -> desired in the future
   async plan(desiredConfig: T): Promise<Plan<T>> {
-    await this.validate(desiredConfig);
-
     const currentConfig = await this.getCurrentConfig(desiredConfig);
     if (!currentConfig) {
       return Plan.create(ChangeSet.createForNullCurrentConfig(desiredConfig), desiredConfig);
@@ -114,7 +116,7 @@ export abstract class Resource<T extends ResourceConfig> {
     this.statefulParameters.set(parameter.name as string, parameter);
   }
 
-  abstract validate(config: unknown): Promise<boolean>;
+  abstract validate(config: unknown): Promise<string | undefined>;
 
   abstract getCurrentConfig(desiredConfig: T): Promise<T | null>;
 

package/src/index.ts

@@ -11,8 +11,6 @@ export * from './utils/test-utils.js'
 export * from './utils/utils.js'
 
 export async function runPlugin(plugin: Plugin) {
-  await plugin.onInitialize();
-
   const messageHandler = new MessageHandler(plugin);
   process.on('message', (message) => messageHandler.onMessage(message))
 }

package/src/messages/handlers.ts

@@ -1,20 +1,27 @@
 import { Plugin } from '../entities/plugin.js';
 import addFormats from 'ajv-formats';
 import {
+  ApplyRequestDataSchema,
+  ApplyResponseDataSchema,
+  InitializeRequestDataSchema,
+  InitializeResponseDataSchema,
   IpcMessage,
   IpcMessageSchema,
-  ResourceSchema,
-  ValidateRequestDataSchema,
-  ValidateResponseDataSchema,
   MessageStatus,
   PlanRequestDataSchema,
   PlanResponseDataSchema,
-  ApplyRequestDataSchema,
-  ApplyResponseDataSchema
+  ResourceSchema,
+  ValidateRequestDataSchema,
+  ValidateResponseDataSchema
 } from 'codify-schemas';
 import Ajv2020, { SchemaObject, ValidateFunction } from 'ajv/dist/2020.js';
 
 const SupportedRequests: Record<string, { requestValidator: SchemaObject; responseValidator: SchemaObject; handler: (plugin: Plugin, data: any) => Promise<unknown> }> = {
+  'initialize': {
+    requestValidator: InitializeRequestDataSchema,
+    responseValidator: InitializeResponseDataSchema,
+    handler: async (plugin: Plugin) => plugin.initialize()
+  },
   'validate': {
     requestValidator: ValidateRequestDataSchema,
     responseValidator: ValidateResponseDataSchema,