codify-plugin-lib 1.0.180 → 1.0.182-beta1

package/dist/utils/index.js

@@ -0,0 +1,108 @@
+import os from 'node:os';
+import path from 'node:path';
+export var Shell;
+(function (Shell) {
+    Shell["ZSH"] = "zsh";
+    Shell["BASH"] = "bash";
+    Shell["SH"] = "sh";
+    Shell["KSH"] = "ksh";
+    Shell["CSH"] = "csh";
+    Shell["FISH"] = "fish";
+})(Shell || (Shell = {}));
+export const Utils = {
+    getUser() {
+        return os.userInfo().username;
+    },
+    getSystemInfo() {
+        return {
+            os: os.type(),
+            shell: this.getShell(),
+        };
+    },
+    isMacOS() {
+        return os.platform() === 'darwin';
+    },
+    isLinux() {
+        return os.platform() === 'linux';
+    },
+    getShell() {
+        const shell = process.env.SHELL || '';
+        if (shell.endsWith('bash')) {
+            return Shell.BASH;
+        }
+        if (shell.endsWith('zsh')) {
+            return Shell.ZSH;
+        }
+        if (shell.endsWith('sh')) {
+            return Shell.SH;
+        }
+        if (shell.endsWith('csh')) {
+            return Shell.CSH;
+        }
+        if (shell.endsWith('ksh')) {
+            return Shell.KSH;
+        }
+        if (shell.endsWith('fish')) {
+            return Shell.FISH;
+        }
+        return undefined;
+    },
+    getPrimaryShellRc() {
+        return this.getShellRcFiles()[0];
+    },
+    getShellRcFiles() {
+        const shell = process.env.SHELL || '';
+        const homeDir = os.homedir();
+        if (shell.endsWith('bash')) {
+            // Linux typically uses .bashrc, macOS uses .bash_profile
+            if (Utils.isLinux()) {
+                return [
+                    path.join(homeDir, '.bashrc'),
+                    path.join(homeDir, '.bash_profile'),
+                    path.join(homeDir, '.profile'),
+                ];
+            }
+            return [
+                path.join(homeDir, '.bash_profile'),
+                path.join(homeDir, '.bashrc'),
+                path.join(homeDir, '.profile'),
+            ];
+        }
+        if (shell.endsWith('zsh')) {
+            return [
+                path.join(homeDir, '.zshrc'),
+                path.join(homeDir, '.zprofile'),
+                path.join(homeDir, '.zshenv'),
+            ];
+        }
+        if (shell.endsWith('sh')) {
+            return [
+                path.join(homeDir, '.profile'),
+            ];
+        }
+        if (shell.endsWith('ksh')) {
+            return [
+                path.join(homeDir, '.profile'),
+                path.join(homeDir, '.kshrc'),
+            ];
+        }
+        if (shell.endsWith('csh')) {
+            return [
+                path.join(homeDir, '.cshrc'),
+                path.join(homeDir, '.login'),
+                path.join(homeDir, '.logout'),
+            ];
+        }
+        if (shell.endsWith('fish')) {
+            return [
+                path.join(homeDir, '.config/fish/config.fish'),
+            ];
+        }
+        // Default to bash-style files
+        return [
+            path.join(homeDir, '.bashrc'),
+            path.join(homeDir, '.bash_profile'),
+            path.join(homeDir, '.profile'),
+        ];
+    },
+};

package/dist/utils/internal-utils.d.ts

@@ -0,0 +1,18 @@
+import { ResourceConfig, StringIndexedObject } from 'codify-schemas';
+export declare const VerbosityLevel: {
+    level: number;
+    get(): number;
+    set(level: number): void;
+};
+export declare function isDebug(): boolean;
+export declare function splitUserConfig<T extends StringIndexedObject>(config: ResourceConfig & T): {
+    parameters: T;
+    coreParameters: ResourceConfig;
+};
+export declare function setsEqual(set1: Set<unknown>, set2: Set<unknown>): boolean;
+export declare function untildify(pathWithTilde: string): string;
+export declare function tildify(pathWithTilde: string): string;
+export declare function resolvePathWithVariables(pathWithVariables: string): string;
+export declare function addVariablesToPath(pathWithoutVariables: string): string;
+export declare function unhome(pathWithHome: string): string;
+export declare function areArraysEqual(isElementEqual: ((desired: unknown, current: unknown) => boolean) | undefined, desired: unknown, current: unknown): boolean;

package/dist/utils/internal-utils.js

@@ -0,0 +1,86 @@
+import os from 'node:os';
+import path from 'node:path';
+export const VerbosityLevel = new class {
+    level = 0;
+    get() {
+        return this.level;
+    }
+    set(level) {
+        this.level = level;
+    }
+};
+export function isDebug() {
+    return process.env.DEBUG != null && process.env.DEBUG.includes('codify'); // TODO: replace with debug library
+}
+export function splitUserConfig(config) {
+    const coreParameters = {
+        type: config.type,
+        ...(config.name ? { name: config.name } : {}),
+        ...(config.dependsOn ? { dependsOn: config.dependsOn } : {}),
+    };
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    const { type, name, dependsOn, ...parameters } = config;
+    return {
+        parameters: parameters,
+        coreParameters,
+    };
+}
+export function setsEqual(set1, set2) {
+    return set1.size === set2.size && [...set1].every((v) => set2.has(v));
+}
+const homeDirectory = os.homedir();
+export function untildify(pathWithTilde) {
+    return homeDirectory ? pathWithTilde.replace(/^~(?=$|\/|\\)/, homeDirectory) : pathWithTilde;
+}
+export function tildify(pathWithTilde) {
+    return homeDirectory ? pathWithTilde.replace(homeDirectory, '~') : pathWithTilde;
+}
+export function resolvePathWithVariables(pathWithVariables) {
+    // @ts-expect-error Ignore this for now
+    return pathWithVariables.replace(/\$([A-Z_]+[A-Z0-9_]*)|\${([A-Z0-9_]*)}/ig, (_, a, b) => process.env[a || b]);
+}
+export function addVariablesToPath(pathWithoutVariables) {
+    let result = pathWithoutVariables;
+    for (const [key, value] of Object.entries(process.env)) {
+        if (!value || !path.isAbsolute(value) || value === '/' || key === 'HOME' || key === 'PATH' || key === 'SHELL' || key === 'PWD') {
+            continue;
+        }
+        result = result.replaceAll(value, `$${key}`);
+    }
+    return result;
+}
+export function unhome(pathWithHome) {
+    return pathWithHome.includes('$HOME') ? pathWithHome.replaceAll('$HOME', os.homedir()) : pathWithHome;
+}
+export function areArraysEqual(isElementEqual, desired, current) {
+    if (!desired || !current) {
+        return false;
+    }
+    if (!Array.isArray(desired) || !Array.isArray(current)) {
+        throw new Error(`A non-array value:
+          
+Desired: ${JSON.stringify(desired, null, 2)}
+
+Current: ${JSON.stringify(desired, null, 2)}
+
+Was provided even though type array was specified.
+`);
+    }
+    if (desired.length !== current.length) {
+        return false;
+    }
+    const desiredCopy = [...desired];
+    const currentCopy = [...current];
+    // Algorithm for to check equality between two un-ordered; un-hashable arrays using
+    // an isElementEqual method. Time: O(n^2)
+    for (let counter = desiredCopy.length - 1; counter >= 0; counter--) {
+        const idx = currentCopy.findIndex((e2) => (isElementEqual
+            ?? ((a, b) => a === b))(desiredCopy[counter], e2));
+        if (idx === -1) {
+            return false;
+        }
+        desiredCopy.splice(counter, 1);
+        currentCopy.splice(idx, 1);
+    }
+    return currentCopy.length === 0;
+}

package/dist/utils/pty-local-storage.d.ts

@@ -1,3 +1,2 @@
-/// <reference types="node" resolution-mode="require"/>
 import { AsyncLocalStorage } from 'node:async_hooks';
 export declare const ptyLocalStorage: AsyncLocalStorage<unknown>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "codify-plugin-lib",
-  "version": "1.0.180",
+  "version": "1.0.182-beta1",
   "description": "Library plugin library",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -10,42 +10,47 @@
     "posttest": "tsc",
     "prepublishOnly": "tsc"
   },
+  "bin": {
+    "codify-deploy": "./dist/bin/deploy-plugin.js"
+  },
   "keywords": [],
   "author": "",
   "license": "ISC",
   "dependencies": {
+    "@homebridge/node-pty-prebuilt-multiarch": "^0.13.1",
+    "@npmcli/promise-spawn": "^7.0.1",
     "ajv": "^8.12.0",
     "ajv-formats": "^2.1.1",
-    "codify-schemas": "1.0.83",
-    "@npmcli/promise-spawn": "^7.0.1",
-    "@homebridge/node-pty-prebuilt-multiarch": "^0.12.0-beta.5",
-    "uuid": "^10.0.0",
+    "clean-deep": "^3.4.0",
+    "codify-schemas": "1.0.86",
     "lodash.isequal": "^4.5.0",
     "nanoid": "^5.0.9",
     "strip-ansi": "^7.1.0",
-    "clean-deep": "^3.4.0"
+    "uuid": "^10.0.0"
   },
   "devDependencies": {
+    "@apidevtools/json-schema-ref-parser": "^11.7.2",
     "@oclif/prettier-config": "^0.2.1",
     "@oclif/test": "^3",
-    "@types/npmcli__promise-spawn": "^6.0.3",
+    "@types/lodash.isequal": "^4.5.8",
     "@types/node": "^20",
+    "@types/npmcli__promise-spawn": "^6.0.3",
     "@types/semver": "^7.5.4",
     "@types/sinon": "^17.0.3",
     "@types/uuid": "^10.0.0",
-    "@types/lodash.isequal": "^4.5.8",
     "chai-as-promised": "^7.1.1",
-    "vitest": "^3.0.5",
-    "vitest-mock-extended": "^1.3.1",
-    "sinon": "^17.0.1",
     "eslint": "^8.51.0",
     "eslint-config-oclif": "^5",
     "eslint-config-oclif-typescript": "^3",
+    "eslint-config-prettier": "^9.0.0",
+    "merge-json-schemas": "^1.0.0",
     "shx": "^0.3.3",
+    "sinon": "^17.0.1",
     "ts-node": "^10.9.1",
     "tsc-watch": "^6.0.4",
     "typescript": "^5",
-    "eslint-config-prettier": "^9.0.0"
+    "vitest": "^3.0.5",
+    "vitest-mock-extended": "^1.3.1"
   },
   "engines": {
     "node": ">=18.0.0"

package/src/index.ts

@@ -12,7 +12,7 @@ export * from './resource/parsed-resource-settings.js';
 export * from './resource/resource.js'
 export * from './resource/resource-settings.js'
 export * from './stateful-parameter/stateful-parameter.js'
-export * from './utils/utils.js'
+export * from './utils/index.js'
 
 export async function runPlugin(plugin: Plugin) {
   const messageHandler = new MessageHandler(plugin);

package/src/plan/plan.test.ts

@@ -1,6 +1,6 @@
 import { describe, expect, it } from 'vitest';
 import { Plan } from './plan.js';
-import { ParameterOperation, ResourceOperation } from 'codify-schemas';
+import { OS, ParameterOperation, ResourceOperation } from 'codify-schemas';
 import { TestConfig, TestResource } from '../utils/test-utils.test.js';
 import { ResourceController } from '../resource/resource-controller.js';
 import { ParsedResourceSettings } from '../resource/parsed-resource-settings.js';
@@ -152,6 +152,7 @@ describe('Plan entity tests', () => {
       getSettings(): ResourceSettings<any> {
         return {
           id: 'type',
+          operatingSystems: [OS.Darwin],
           parameterSettings: {
             propZ: { type: 'array', isElementEqual: (a, b) => b.includes(a) }
           }
@@ -184,6 +185,7 @@ describe('Plan entity tests', () => {
       getSettings(): ResourceSettings<any> {
         return {
           id: 'type',
+          operatingSystems: [OS.Darwin],
           parameterSettings: {
             propZ: {
               type: 'array',
@@ -236,6 +238,7 @@ describe('Plan entity tests', () => {
       getSettings(): ResourceSettings<TestConfig> {
         return {
           id: 'type',
+          operatingSystems: [OS.Darwin],
           parameterSettings: {
             propA: { type: 'string' },
             propB: { type: 'string', canModify: true },
@@ -289,6 +292,7 @@ describe('Plan entity tests', () => {
       getSettings(): ResourceSettings<TestConfig> {
         return {
           id: 'type',
+          operatingSystems: [OS.Darwin],
           parameterSettings: {
             propA: { type: 'string' },
             propB: { type: 'string', canModify: true },
@@ -351,6 +355,7 @@ function createTestResource() {
     getSettings(): ResourceSettings<TestConfig> {
       return {
         id: 'type',
+        operatingSystems: [OS.Darwin],
         parameterSettings: {
           propA: {
             default: 'defaultA'

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';
 
@@ -19,7 +20,7 @@ EventEmitter.defaultMaxListeners = 1000;
  * without a tty (or even a stdin) attached so interactive commands will not work.
  */
 export class BackgroundPty implements IPty {
-  private basePty = pty.spawn('zsh', ['-i'], {
+  private basePty = pty.spawn(this.getDefaultShell(), ['-i'], {
     env: process.env, name: nanoid(6),
     handleFlowControl: true
   });
@@ -127,7 +128,19 @@ export class BackgroundPty implements IPty {
       let outputBuffer = '';
 
       return new Promise(resolve => {
-        this.basePty.write('setopt hist_ignore_space;\n');
+        // zsh-specific commands
+        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')
@@ -142,4 +155,8 @@ export class BackgroundPty implements IPty {
       })
     })
   }
+
+  private getDefaultShell(): string {
+    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 {