codify-plugin-lib 1.0.181 → 1.0.182-beta2

package/src/plugin/plugin.test.ts

@@ -1,6 +1,6 @@
 import { describe, expect, it } from 'vitest';
 import { Plugin } from './plugin.js';
-import { ApplyRequestData, ParameterOperation, ResourceOperation, StringIndexedObject } from 'codify-schemas';
+import { ApplyRequestData, OS, ParameterOperation, ResourceOperation, StringIndexedObject } from 'codify-schemas';
 import { Resource } from '../resource/resource.js';
 import { Plan } from '../plan/plan.js';
 import { spy } from 'sinon';
@@ -17,7 +17,8 @@ interface TestConfig extends StringIndexedObject {
 class TestResource extends Resource<TestConfig> {
   getSettings(): ResourceSettings<TestConfig> {
     return {
-      id: 'testResource'
+      id: 'testResource',
+      operatingSystems: [OS.Darwin],
     };
   }
 
@@ -154,6 +155,7 @@ describe('Plugin tests', () => {
       getSettings(): ResourceSettings<TestConfig> {
         return {
           id: 'typeId',
+          operatingSystems: [OS.Darwin],
           schema,
         }
       }
@@ -192,6 +194,7 @@ describe('Plugin tests', () => {
       getSettings(): ResourceSettings<TestConfig> {
         return {
           id: 'typeId',
+          operatingSystems: [OS.Darwin],
           schema,
           importAndDestroy: {
             requiredParameters: []
@@ -285,6 +288,7 @@ describe('Plugin tests', () => {
       getSettings(): ResourceSettings<TestConfig> {
         return {
           id: 'type',
+          operatingSystems: [OS.Darwin],
           schema: {
             '$schema': 'http://json-schema.org/draft-07/schema',
             '$id': 'https://www.codifycli.com/ssh-config.json',
@@ -330,6 +334,7 @@ describe('Plugin tests', () => {
       getSettings(): ResourceSettings<TestConfig> {
         return {
           ...super.getSettings(),
+          operatingSystems: [OS.Darwin],
           allowMultiple: {
             identifyingParameters: ['path', 'paths']
           }
@@ -351,6 +356,7 @@ describe('Plugin tests', () => {
       getSettings(): ResourceSettings<TestConfig> {
         return {
           ...super.getSettings(),
+          operatingSystems: [OS.Darwin],
           parameterSettings: {
             path: { type: 'directory' },
             paths: { type: 'array', itemType: 'directory' }
@@ -407,6 +413,7 @@ describe('Plugin tests', () => {
       getSettings(): ResourceSettings<TestConfig> {
         return {
           id: 'ssh-config',
+          operatingSystems: [OS.Darwin],
           parameterSettings: {
             hosts: { type: 'stateful', definition: new TestStatefulParameter() }
           },
@@ -454,6 +461,7 @@ describe('Plugin tests', () => {
       getSettings(): ResourceSettings<TestConfig> {
         return {
           id: 'ssh-config',
+          operatingSystems: [OS.Darwin],
           allowMultiple: true
         }
       }
@@ -476,6 +484,7 @@ describe('Plugin tests', () => {
       getSettings(): ResourceSettings<TestConfig> {
         return {
           id: 'ssh-config',
+          operatingSystems: [OS.Darwin],
         }
       }
     })

package/src/plugin/plugin.ts

@@ -21,10 +21,11 @@ import { ApplyValidationError } from '../common/errors.js';
 import { Plan } from '../plan/plan.js';
 import { BackgroundPty } from '../pty/background-pty.js';
 import { getPty } from '../pty/index.js';
+import { SequentialPty } from '../pty/seqeuntial-pty.js';
 import { Resource } from '../resource/resource.js';
 import { ResourceController } from '../resource/resource-controller.js';
+import { VerbosityLevel } from '../utils/internal-utils.js';
 import { ptyLocalStorage } from '../utils/pty-local-storage.js';
-import { VerbosityLevel } from '../utils/utils.js';
 
 export class Plugin {
   planStorage: Map<string, Plan<any>>;
@@ -75,6 +76,7 @@ export class Plugin {
             dependencies: r.dependencies,
             type: r.typeId,
             sensitiveParameters,
+            operatingSystems: r.settings.operatingSystems,
           }
         })
     }
@@ -121,6 +123,7 @@ export class Plugin {
       import: {
         requiredParameters: requiredPropertyNames,
       },
+      operatingSystems: resource.settings.operatingSystems,
       sensitiveParameters,
       allowMultiple
     }
@@ -232,7 +235,7 @@ export class Plugin {
       throw new Error('Malformed plan with resource that cannot be found');
     }
 
-    await resource.apply(plan);
+    await ptyLocalStorage.run(new SequentialPty(), async () => resource.apply(plan))
 
     // Validate using desired/desired. If the apply was successful, no changes should be reported back.
     // Default back desired back to current if it is not defined (for destroys only)

package/src/pty/background-pty.ts

@@ -6,7 +6,8 @@ import * as fs from 'node:fs/promises';
 import stripAnsi from 'strip-ansi';
 
 import { debugLog } from '../utils/debug.js';
-import { VerbosityLevel } from '../utils/utils.js';
+import { Shell, Utils } from '../utils/index.js';
+import { VerbosityLevel } from '../utils/internal-utils.js';
 import { IPty, SpawnError, SpawnOptions, SpawnResult } from './index.js';
 import { PromiseQueue } from './promise-queue.js';
 
@@ -128,9 +129,18 @@ export class BackgroundPty implements IPty {
 
       return new Promise(resolve => {
         // zsh-specific commands
-        if (this.getDefaultShell() === 'zsh') {
-          this.basePty.write('setopt hist_ignore_space;\n');
+        switch (Utils.getShell()) {
+          case Shell.ZSH: {
+            this.basePty.write('setopt HIST_NO_STORE;\n');
+            break;
+          }
+
+          default: {
+            this.basePty.write('export HISTIGNORE=\'history*\';\n');
+            break;
+          }
         }
+
         this.basePty.write(' unset PS1;\n');
         this.basePty.write(' unset PS0;\n')
         this.basePty.write(' echo setup complete\\"\n')
@@ -147,6 +157,6 @@ export class BackgroundPty implements IPty {
   }
 
   private getDefaultShell(): string {
-    return process.platform === 'darwin' ? 'zsh' : 'bash';
+    return process.env.SHELL!;
   }
 }

package/src/pty/index.test.ts

@@ -3,8 +3,9 @@ import { TestConfig, TestResource } from '../utils/test-utils.test.js';
 import { getPty, IPty } from './index.js';
 import { Plugin } from '../plugin/plugin.js'
 import { CreatePlan } from '../plan/plan-types.js';
-import { ResourceOperation } from 'codify-schemas';
+import { OS, ResourceOperation } from 'codify-schemas';
 import { ResourceSettings } from '../resource/resource-settings.js';
+import { SequentialPty } from './seqeuntial-pty.js';
 
 describe('General tests for PTYs', () => {
   it('Can get pty within refresh', async () => {
@@ -45,7 +46,8 @@ describe('General tests for PTYs', () => {
     const testResource1 = new class extends TestResource {
       getSettings(): ResourceSettings<TestConfig> {
         return {
-          id: 'type1'
+          id: 'type1',
+          operatingSystems: [OS.Darwin],
         }
       }
 
@@ -64,6 +66,7 @@ describe('General tests for PTYs', () => {
       getSettings(): ResourceSettings<TestConfig> {
         return {
           id: 'type2',
+          operatingSystems: [OS.Darwin],
         }
       }
 
@@ -103,11 +106,11 @@ describe('General tests for PTYs', () => {
     expect(pty1).to.eq(pty2);
   })
 
-  it('Currently pty not available for apply', async () => {
+  it('Sequential pty should be available for applies', async () => {
     const testResource = new class extends TestResource {
       create(plan: CreatePlan<TestConfig>): Promise<void> {
         const $ = getPty();
-        expect($).to.be.undefined;
+        expect($).to.instanceof(SequentialPty)
       }
     }
 

package/src/pty/index.ts

@@ -1,7 +1,7 @@
 import { ptyLocalStorage } from '../utils/pty-local-storage.js';
 
 export interface SpawnResult {
-  status: 'success' | 'error';
+  status: 'error' | 'success';
   exitCode: number;
   data: string;
 }
@@ -11,9 +11,25 @@ export enum SpawnStatus {
   ERROR = 'error',
 }
 
+/**
+ * Represents the configuration options for spawning a child process.
+ *
+ * @interface SpawnOptions
+ *
+ * @property {string} [cwd] - Specifies the working directory of the child process.
+ * If not provided, the current working directory of the parent process is used.
+ *
+ * @property {Record<string, unknown>} [env] - Defines environment key-value pairs
+ * that will be available to the child process. If not specified, the child process
+ * will inherit the environment variables of the parent process.
+ *
+ * @property {boolean} [interactive] - Indicates whether the spawned process needs
+ * to be interactive. Only works within apply (not plan). Defaults to true.
+ */
 export interface SpawnOptions {
   cwd?: string;
   env?: Record<string, unknown>,
+  interactive?: boolean,
 }
 
 export class SpawnError extends Error {

package/src/pty/seqeuntial-pty.ts

@@ -0,0 +1,105 @@
+import pty from '@homebridge/node-pty-prebuilt-multiarch';
+import { EventEmitter } from 'node:events';
+import stripAnsi from 'strip-ansi';
+
+import { Shell, Utils } from '../utils/index.js';
+import { VerbosityLevel } from '../utils/internal-utils.js';
+import { IPty, SpawnError, SpawnOptions, SpawnResult, SpawnStatus } from './index.js';
+
+EventEmitter.defaultMaxListeners = 1000;
+
+/**
+ * The background pty is a specialized pty designed for speed. It can launch multiple tasks
+ * in parallel by moving them to the background. It attaches unix FIFO pipes to each process
+ * to listen to stdout and stderr. One limitation of the BackgroundPty is that the tasks run
+ * without a tty (or even a stdin) attached so interactive commands will not work.
+ */
+export class SequentialPty implements IPty {
+  async spawn(cmd: string, options?: SpawnOptions): Promise<SpawnResult> {
+    const spawnResult = await this.spawnSafe(cmd, options);
+
+    if (spawnResult.status !== 'success') {
+      throw new SpawnError(cmd, spawnResult.exitCode, spawnResult.data);
+    }
+
+    return spawnResult;
+  }
+
+  async spawnSafe(cmd: string, options?: SpawnOptions): Promise<SpawnResult> {
+    console.log(`Running command: ${cmd}` + (options?.cwd ? `(${options?.cwd})` : ''))
+
+    return new Promise((resolve) => {
+      const output: string[] = [];
+
+      const historyIgnore = Utils.getShell() === Shell.ZSH ? { HISTORY_IGNORE: '*' } : { HISTIGNORE: '*' };
+
+      // If TERM_PROGRAM=Apple_Terminal is set then ANSI escape characters may be included
+      // in the response.
+      const env = {
+        ...process.env, ...options?.env,
+        TERM_PROGRAM: 'codify',
+        COMMAND_MODE: 'unix2003',
+        COLORTERM: 'truecolor', ...historyIgnore
+      }
+
+      // Initial terminal dimensions
+      const initialCols = process.stdout.columns ?? 80;
+      const initialRows = process.stdout.rows ?? 24;
+
+      const args = (options?.interactive ?? false) ? ['-i', '-c', `"${cmd}"`] : ['-c', `"${cmd}"`]
+
+      // Run the command in a pty for interactivity
+      const mPty = pty.spawn(this.getDefaultShell(), args, {
+        ...options,
+        cols: initialCols,
+        rows: initialRows,
+        env
+      });
+
+      mPty.onData((data) => {
+        if (VerbosityLevel.get() > 0) {
+          process.stdout.write(data);
+        }
+
+        output.push(data.toString());
+      })
+
+      const stdinListener = (data: any) => {
+        mPty.write(data.toString());
+      };
+
+      const resizeListener = () => {
+        const { columns, rows } = process.stdout;
+        mPty.resize(columns, rows);
+      }
+
+      // Listen to resize events for the terminal window;
+      process.stdout.on('resize', resizeListener);
+      // Listen for user input
+      process.stdin.on('data', stdinListener);
+
+      mPty.onExit((result) => {
+        process.stdout.off('resize', resizeListener);
+        process.stdin.off('data', stdinListener);
+
+        resolve({
+          status: result.exitCode === 0 ? SpawnStatus.SUCCESS : SpawnStatus.ERROR,
+          exitCode: result.exitCode,
+          data: stripAnsi(output.join('\n').trim()),
+        })
+      })
+    })
+  }
+
+  async kill(): Promise<{ exitCode: number, signal?: number | undefined }> {
+    // No-op here. Each pty instance is stand alone and tied to the parent process. Everything should be killed as expected.
+    return {
+      exitCode: 0,
+      signal: 0,
+    }
+  }
+
+  private getDefaultShell(): string {
+    return process.env.SHELL!;
+  }
+}

package/src/pty/sequential-pty.test.ts

@@ -0,0 +1,61 @@
+import { describe, expect, it } from 'vitest';
+import { SequentialPty } from './seqeuntial-pty.js';
+import { VerbosityLevel } from '../utils/internal-utils.js';
+
+describe('SequentialPty tests', () => {
+  it('Can launch a simple command', async () => {
+    const pty = new SequentialPty();
+
+    VerbosityLevel.set(1);
+
+    const result = await pty.spawnSafe('ls');
+    expect(result).toMatchObject({
+      status: 'success',
+      exitCode: 0,
+      data: expect.any(String),
+    })
+
+    const exitCode = await pty.kill();
+    expect(exitCode).toMatchObject({
+      exitCode: 0,
+    });
+  })
+
+  it('Reports back the correct exit code and status', async () => {
+    const pty = new SequentialPty();
+
+    const resultSuccess = await pty.spawnSafe('ls');
+    expect(resultSuccess).toMatchObject({
+      status: 'success',
+      exitCode: 0,
+    })
+
+    const resultFailed = await pty.spawnSafe('which sjkdhsakjdhjkash');
+    expect(resultFailed).toMatchObject({
+      status: 'error',
+      exitCode: 127,
+      data: 'zsh:1: command not found: which sjkdhsakjdhjkash' // This might change on different os or shells. Keep for now.
+    })
+  });
+
+  it('Can use a different cwd', async () => {
+    const pty = new SequentialPty();
+
+    const resultSuccess = await pty.spawnSafe('pwd', { cwd: '/tmp' });
+    expect(resultSuccess).toMatchObject({
+      status: 'success',
+      exitCode: 0,
+      data: '/tmp'
+    })
+  });
+
+  it('It can launch a command in interactive mode', async () => {
+    const pty = new SequentialPty();
+
+    const resultSuccess = await pty.spawnSafe('ls', { interactive: false });
+    expect(resultSuccess).toMatchObject({
+      status: 'success',
+      exitCode: 0,
+    })
+  });
+})

package/src/resource/parsed-resource-settings.ts

@@ -1,5 +1,5 @@
 import { JSONSchemaType } from 'ajv';
-import { StringIndexedObject } from 'codify-schemas';
+import { OS, StringIndexedObject } from 'codify-schemas';
 
 import { StatefulParameterController } from '../stateful-parameter/stateful-parameter-controller.js';
 import {
@@ -46,16 +46,17 @@ export class ParsedResourceSettings<T extends StringIndexedObject> implements Re
   removeStatefulParametersBeforeDestroy?: boolean | undefined;
   dependencies?: string[] | undefined;
   transformation?: InputTransformation;
+
+  operatingSystems!: Array<OS>;
+  isSensitive?: boolean;
+
   private settings: ResourceSettings<T>;
 
   constructor(settings: ResourceSettings<T>) {
     this.settings = settings;
-    this.id = settings.id;
-    this.schema = settings.schema;
-    this.allowMultiple = settings.allowMultiple;
-    this.removeStatefulParametersBeforeDestroy = settings.removeStatefulParametersBeforeDestroy;
-    this.dependencies = settings.dependencies;
-    this.transformation = settings.transformation;
+
+    const { parameterSettings, ...rest } = settings;
+    Object.assign(this, rest);
 
     this.validateSettings();
   }

package/src/resource/resource-controller-stateful-mode.test.ts

@@ -1,5 +1,5 @@
 import { describe, expect, it } from 'vitest';
-import { ParameterOperation, ResourceOperation } from 'codify-schemas';
+import { OS, ParameterOperation, ResourceOperation } from 'codify-schemas';
 import { TestConfig, TestResource, TestStatefulParameter } from '../utils/test-utils.test.js';
 import { ResourceSettings } from './resource-settings.js';
 import { ResourceController } from './resource-controller.js';
@@ -179,6 +179,7 @@ describe('Resource tests for stateful plans', () => {
       getSettings(): ResourceSettings<TestConfig> {
         return {
           id: 'type',
+          operatingSystems: [OS.Darwin],
           parameterSettings: {
             propD: { type: 'stateful', definition: statefulParameter },
           }

package/src/resource/resource-controller.test.ts

@@ -1,5 +1,5 @@
 import { Resource } from './resource.js';
-import { ResourceOperation } from 'codify-schemas';
+import { OS, ResourceOperation } from 'codify-schemas';
 import { spy } from 'sinon';
 import { describe, expect, it } from 'vitest'
 import { ArrayParameterSetting, ParameterSetting, ResourceSettings } from './resource-settings.js';
@@ -7,7 +7,7 @@ import { CreatePlan, DestroyPlan, ModifyPlan } from '../plan/plan-types.js';
 import { ParameterChange } from '../plan/change-set.js';
 import { ResourceController } from './resource-controller.js';
 import { TestConfig, testPlan, TestResource, TestStatefulParameter } from '../utils/test-utils.test.js';
-import { tildify, untildify } from '../utils/utils.js';
+import { tildify, untildify } from '../utils/internal-utils.js';
 import { ArrayStatefulParameter, StatefulParameter } from '../stateful-parameter/stateful-parameter.js';
 import { Plan } from '../plan/plan.js';
 import os from 'node:os';
@@ -19,6 +19,7 @@ describe('Resource tests', () => {
       getSettings(): ResourceSettings<TestConfig> {
         return {
           id: 'type',
+          operatingSystems: [OS.Darwin],
           dependencies: ['homebrew', 'python'],
           parameterSettings: {
             propA: {
@@ -197,6 +198,7 @@ describe('Resource tests', () => {
       getSettings(): ResourceSettings<TestConfig> {
         return {
           id: 'resource',
+          operatingSystems: [OS.Darwin],
           parameterSettings: {
             propA: { canModify: true },
             propB: { canModify: true },
@@ -232,6 +234,7 @@ describe('Resource tests', () => {
       getSettings(): ResourceSettings<TestConfig> {
         return {
           id: 'type',
+          operatingSystems: [OS.Darwin],
           dependencies: ['homebrew', 'python'],
           parameterSettings: {
             propA: { canModify: true },
@@ -254,6 +257,7 @@ describe('Resource tests', () => {
       getSettings(): ResourceSettings<TestConfig> {
         return {
           id: 'type',
+          operatingSystems: [OS.Darwin],
           dependencies: ['homebrew', 'python'],
           parameterSettings: {
             propA: { canModify: true },
@@ -270,6 +274,7 @@ describe('Resource tests', () => {
       getSettings(): ResourceSettings<TestConfig> {
         return {
           id: 'type',
+          operatingSystems: [OS.Darwin],
           parameterSettings: {
             propA: { default: 'propADefault' }
           }
@@ -298,6 +303,7 @@ describe('Resource tests', () => {
       getSettings(): ResourceSettings<TestConfig> {
         return {
           id: 'type',
+          operatingSystems: [OS.Darwin],
           parameterSettings: {
             propE: { default: 'propEDefault' }
           }
@@ -325,6 +331,7 @@ describe('Resource tests', () => {
       getSettings(): ResourceSettings<TestConfig> {
         return {
           id: 'type',
+          operatingSystems: [OS.Darwin],
           parameterSettings: {
             propE: { default: 'propEDefault' }
           }
@@ -348,6 +355,7 @@ describe('Resource tests', () => {
       getSettings(): ResourceSettings<TestConfig> {
         return {
           id: 'type',
+          operatingSystems: [OS.Darwin],
           parameterSettings: {
             propA: { default: 'propADefault' }
           }
@@ -376,6 +384,7 @@ describe('Resource tests', () => {
       getSettings(): ResourceSettings<TestConfig> {
         return {
           id: 'type',
+          operatingSystems: [OS.Darwin],
           parameterSettings: {
             propA: { default: 'propADefault' }
           }
@@ -392,7 +401,7 @@ describe('Resource tests', () => {
   it('Has the correct typing for applys', () => {
     const resource = new class extends Resource<TestConfig> {
       getSettings(): ResourceSettings<TestConfig> {
-        return { id: 'type' }
+        return { id: 'type', operatingSystems: [OS.Darwin], }
       }
 
       async refresh(): Promise<Partial<TestConfig> | null> {
@@ -418,7 +427,8 @@ describe('Resource tests', () => {
     const parameter1 = new class extends StatefulParameter<any, any> {
       getSettings(): ParameterSetting {
         return {
-          type: 'version'
+          type: 'version',
+          operatingSystems: [OS.Darwin],
         }
       }
 
@@ -462,6 +472,7 @@ describe('Resource tests', () => {
       getSettings(): ResourceSettings<TestConfig> {
         return {
           id: 'nvm',
+          operatingSystems: [OS.Darwin],
           parameterSettings: {
             global: { type: 'stateful', definition: parameter1, order: 2 },
             nodeVersions: { type: 'stateful', definition: parameter2, order: 1 },
@@ -514,6 +525,7 @@ describe('Resource tests', () => {
       getSettings(): ResourceSettings<TestConfig> {
         return {
           id: 'nvm',
+          operatingSystems: [OS.Darwin],
           parameterSettings: {
             global: { type: 'stateful', definition: parameter1, order: 2 },
             nodeVersions: { type: 'stateful', definition: parameter2, order: 1 },
@@ -546,6 +558,7 @@ describe('Resource tests', () => {
       getSettings(): ResourceSettings<TestConfig> {
         return {
           id: 'resourceType',
+          operatingSystems: [OS.Darwin],
           parameterSettings: {
             propD: {
               type: 'array',
@@ -630,6 +643,7 @@ describe('Resource tests', () => {
       getSettings(): ResourceSettings<TestConfig> {
         return {
           id: 'resourceType',
+          operatingSystems: [OS.Darwin],
           parameterSettings: {
             propD: {
               type: 'array',
@@ -720,6 +734,7 @@ describe('Resource tests', () => {
       getSettings(): ResourceSettings<TestConfig> {
         return {
           id: 'resourceType',
+          operatingSystems: [OS.Darwin],
           parameterSettings: {
             propA: { type: 'string', default: 'defaultValue' },
             propB: { type: 'boolean', default: true }
@@ -755,6 +770,7 @@ describe('Resource tests', () => {
       getSettings(): ResourceSettings<any> {
         return {
           id: 'path',
+          operatingSystems: [OS.Darwin],
           parameterSettings: {
             path: { type: 'string', isEqual: 'directory' },
             paths: { canModify: true, type: 'array', isElementEqual: 'directory' },
@@ -797,6 +813,7 @@ describe('Resource tests', () => {
       getSettings(): ResourceSettings<any> {
         return {
           id: 'path',
+          operatingSystems: [OS.Darwin],
           parameterSettings: {
             path: { type: 'string', isEqual: 'directory' },
             paths: { canModify: true, type: 'array', isElementEqual: 'directory' },
@@ -840,6 +857,7 @@ describe('Resource tests', () => {
       getSettings(): ResourceSettings<any> {
         return {
           id: 'path',
+          operatingSystems: [OS.Darwin],
           parameterSettings: {
             path: { type: 'directory' },
             paths: { canModify: true, type: 'array', itemType: 'directory' },