codify-plugin-lib 1.0.107 → 1.0.108

package/dist/messages/handlers.d.ts

@@ -2,11 +2,13 @@ import { Plugin } from '../plugin/plugin.js';
 export declare class MessageHandler {
     private ajv;
     private readonly plugin;
-    private messageSchemaValidator;
+    private messageSchemaValidatorV1;
+    private messageSchemaValidatorV2;
     private requestValidators;
     private responseValidators;
     constructor(plugin: Plugin);
     onMessage(message: unknown): Promise<void>;
     private validateMessage;
+    private validateMessageV2;
     private handleErrors;
 }

package/dist/messages/handlers.js

@@ -1,6 +1,6 @@
 import { Ajv } from 'ajv';
 import addFormats from 'ajv-formats';
-import { ApplyRequestDataSchema, ApplyResponseDataSchema, GetResourceInfoRequestDataSchema, GetResourceInfoResponseDataSchema, ImportRequestDataSchema, ImportResponseDataSchema, InitializeRequestDataSchema, InitializeResponseDataSchema, IpcMessageSchema, MessageStatus, PlanRequestDataSchema, PlanResponseDataSchema, ResourceSchema, ValidateRequestDataSchema, ValidateResponseDataSchema } from 'codify-schemas';
+import { ApplyRequestDataSchema, ApplyResponseDataSchema, GetResourceInfoRequestDataSchema, GetResourceInfoResponseDataSchema, ImportRequestDataSchema, ImportResponseDataSchema, InitializeRequestDataSchema, InitializeResponseDataSchema, IpcMessageSchema, IpcMessageV2Schema, MessageStatus, PlanRequestDataSchema, PlanResponseDataSchema, ResourceSchema, ValidateRequestDataSchema, ValidateResponseDataSchema } from 'codify-schemas';
 import { SudoError } from '../errors.js';
 const SupportedRequests = {
     'initialize': {
@@ -40,7 +40,8 @@ const SupportedRequests = {
 export class MessageHandler {
     ajv;
     plugin;
-    messageSchemaValidator;
+    messageSchemaValidatorV1;
+    messageSchemaValidatorV2;
     requestValidators;
     responseValidators;
     constructor(plugin) {
@@ -48,7 +49,8 @@ export class MessageHandler {
         addFormats.default(this.ajv);
         this.ajv.addSchema(ResourceSchema);
         this.plugin = plugin;
-        this.messageSchemaValidator = this.ajv.compile(IpcMessageSchema);
+        this.messageSchemaValidatorV1 = this.ajv.compile(IpcMessageSchema);
+        this.messageSchemaValidatorV2 = this.ajv.compile(IpcMessageV2Schema);
         this.requestValidators = new Map(Object.entries(SupportedRequests)
             .map(([k, v]) => [k, this.ajv.compile(v.requestValidator)]));
         this.responseValidators = new Map(Object.entries(SupportedRequests)
@@ -56,8 +58,8 @@ export class MessageHandler {
     }
     async onMessage(message) {
         try {
-            if (!this.validateMessage(message)) {
-                throw new Error(`Plugin: ${this.plugin}. Message is malformed: ${JSON.stringify(this.messageSchemaValidator.errors, null, 2)}`);
+            if (!this.validateMessageV2(message) && !this.validateMessage(message)) {
+                throw new Error(`Plugin: ${this.plugin}. Message is malformed: ${JSON.stringify(this.messageSchemaValidatorV1.errors, null, 2)}`);
             }
             if (!this.requestValidators.has(message.cmd)) {
                 throw new Error(`Plugin: ${this.plugin}. Unsupported message: ${message.cmd}`);
@@ -74,6 +76,8 @@ export class MessageHandler {
             process.send({
                 cmd: message.cmd + '_Response',
                 data: result,
+                // @ts-expect-error TS2239
+                requestId: message.requestId || undefined,
                 status: MessageStatus.SUCCESS,
             });
         }
@@ -82,7 +86,10 @@ export class MessageHandler {
         }
     }
     validateMessage(message) {
-        return this.messageSchemaValidator(message);
+        return this.messageSchemaValidatorV1(message);
+    }
+    validateMessageV2(message) {
+        return this.messageSchemaValidatorV2(message);
     }
     handleErrors(message, e) {
         if (!message) {
@@ -91,11 +98,13 @@ export class MessageHandler {
         if (!message.hasOwnProperty('cmd')) {
             return;
         }
-        // @ts-ignore
+        // @ts-expect-error TS2239
         const cmd = message.cmd + '_Response';
         if (e instanceof SudoError) {
             return process.send?.({
                 cmd,
+                // @ts-expect-error TS2239
+                requestId: message.requestId || undefined,
                 data: `Plugin: '${this.plugin.name}'. Forbidden usage of sudo for command '${e.command}'. Please contact the plugin developer to fix this.`,
                 status: MessageStatus.ERROR,
             });
@@ -103,6 +112,8 @@ export class MessageHandler {
         const isDebug = process.env.DEBUG?.includes('*') ?? false;
         process.send?.({
             cmd,
+            // @ts-expect-error TS2239
+            requestId: message.requestId || undefined,
             data: isDebug ? e.stack : e.message,
             status: MessageStatus.ERROR,
         });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "codify-plugin-lib",
-  "version": "1.0.107",
+  "version": "1.0.108",
   "description": "Library plugin library",
   "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.52",
+    "codify-schemas": "1.0.53",
     "@npmcli/promise-spawn": "^7.0.1",
     "uuid": "^10.0.0",
     "lodash.isequal": "^4.5.0"

package/src/messages/handlers.test.ts

@@ -207,7 +207,6 @@ describe('Message handler tests', () => {
   it('handles errors for apply (destroy)', async () => {
     const resource = new TestResource()
     const plugin = testPlugin(resource);
-
     const handler = new MessageHandler(plugin);
 
     process.send = (message) => {
@@ -228,6 +227,71 @@ describe('Message handler tests', () => {
         }
       }
     })).rejects.to.not.throw;
+
+    process.send = undefined;
+  })
+
+  it('Supports ipc message v2 (success)', async () => {
+    const resource = new TestResource()
+    const plugin = testPlugin(resource);
+    const handler = new MessageHandler(plugin);
+
+    process.send = (message) => {
+      console.log(message)
+      expect(message).toMatchObject({
+        cmd: 'plan_Response',
+        requestId: 'abcdef',
+        status: MessageStatus.SUCCESS,
+      })
+      return true;
+    }
+
+    await expect(handler.onMessage({
+      cmd: 'plan',
+      requestId: 'abcdef',
+      data: {
+        desired: {
+          type: 'type',
+          name: 'name',
+          prop1: 'A',
+          prop2: 'B',
+        },
+        isStateful: false,
+      }
+    })).resolves.to.eq(undefined);
+
+    process.send = undefined;
+  })
+
+  it('Supports ipc message v2 (error)', async () => {
+    const resource = new TestResource()
+    const plugin = testPlugin(resource);
+    const handler = new MessageHandler(plugin);
+
+    process.send = (message) => {
+      expect(message).toMatchObject({
+        cmd: 'apply_Response',
+        requestId: 'abcdef',
+        status: MessageStatus.ERROR,
+      })
+      return true;
+    }
+
+    await expect(handler.onMessage({
+      cmd: 'apply', // Supposed to be a plan so that's why it throws
+      requestId: 'abcdef',
+      data: {
+        desired: {
+          type: 'type',
+          name: 'name',
+          prop1: 'A',
+          prop2: 'B',
+        },
+        isStateful: false,
+      }
+    })).resolves.to.eq(undefined);
+
+    process.send = undefined;
   })
 });
 

package/src/messages/handlers.ts

@@ -11,6 +11,8 @@ import {
   InitializeResponseDataSchema,
   IpcMessage,
   IpcMessageSchema,
+  IpcMessageV2,
+  IpcMessageV2Schema,
   MessageStatus,
   PlanRequestDataSchema,
   PlanResponseDataSchema,
@@ -61,7 +63,8 @@ const SupportedRequests: Record<string, { handler: (plugin: Plugin, data: any) =
 export class MessageHandler {
   private ajv: Ajv;
   private readonly plugin: Plugin;
-  private messageSchemaValidator: ValidateFunction;
+  private messageSchemaValidatorV1: ValidateFunction;
+  private messageSchemaValidatorV2: ValidateFunction;
   private requestValidators: Map<string, ValidateFunction>;
   private responseValidators: Map<string, ValidateFunction>;
 
@@ -71,7 +74,9 @@ export class MessageHandler {
     this.ajv.addSchema(ResourceSchema);
     this.plugin = plugin;
 
-    this.messageSchemaValidator = this.ajv.compile(IpcMessageSchema);
+    this.messageSchemaValidatorV1 = this.ajv.compile(IpcMessageSchema);
+    this.messageSchemaValidatorV2 = this.ajv.compile(IpcMessageV2Schema);
+
     this.requestValidators = new Map(
       Object.entries(SupportedRequests)
         .map(([k, v]) => [k, this.ajv.compile(v.requestValidator)])
@@ -84,8 +89,8 @@ export class MessageHandler {
 
   async onMessage(message: unknown): Promise<void> {
     try {
-      if (!this.validateMessage(message)) {
-        throw new Error(`Plugin: ${this.plugin}. Message is malformed: ${JSON.stringify(this.messageSchemaValidator.errors, null, 2)}`);
+      if (!this.validateMessageV2(message) && !this.validateMessage(message)) {
+        throw new Error(`Plugin: ${this.plugin}. Message is malformed: ${JSON.stringify(this.messageSchemaValidatorV1.errors, null, 2)}`);
       }
 
       if (!this.requestValidators.has(message.cmd)) {
@@ -107,6 +112,8 @@ export class MessageHandler {
       process.send!({
         cmd: message.cmd + '_Response',
         data: result,
+        // @ts-expect-error TS2239
+        requestId: message.requestId || undefined,
         status: MessageStatus.SUCCESS,
       })
 
@@ -116,7 +123,11 @@ export class MessageHandler {
   }
 
   private validateMessage(message: unknown): message is IpcMessage {
-    return this.messageSchemaValidator(message);
+    return this.messageSchemaValidatorV1(message);
+  }
+
+  private validateMessageV2(message: unknown): message is IpcMessageV2 {
+    return this.messageSchemaValidatorV2(message);
   }
 
   private handleErrors(message: unknown, e: Error) {
@@ -128,12 +139,14 @@ export class MessageHandler {
       return;
     }
 
-    // @ts-ignore
+    // @ts-expect-error TS2239
     const cmd = message.cmd + '_Response';
 
     if (e instanceof SudoError) {
       return process.send?.({
         cmd,
+        // @ts-expect-error TS2239
+        requestId: message.requestId || undefined,
         data: `Plugin: '${this.plugin.name}'. Forbidden usage of sudo for command '${e.command}'. Please contact the plugin developer to fix this.`,
         status: MessageStatus.ERROR,
       })
@@ -143,6 +156,8 @@ export class MessageHandler {
 
     process.send?.({
       cmd,
+      // @ts-expect-error TS2239
+      requestId: message.requestId || undefined,
       data: isDebug ? e.stack : e.message,
       status: MessageStatus.ERROR,
     })