scripts-orchestrator 2.7.0 → 2.7.1

package/README.md

@@ -31,6 +31,8 @@ npm install --save-dev scripts-orchestrator
 - **Retry Mechanism**: Configurable retry attempts for failed commands
 - **Process Management**: Proper cleanup of background processes
 - **Health Checks**: Verifies service availability before proceeding
+- **Environment Variables**: Pass custom environment variables to commands
+- **Optional Phases**: Mark phases as optional and run them selectively
 - **Comprehensive Logging**: Detailed logging of command execution and results
 
 ## Configuration
@@ -45,6 +47,10 @@ Create a configuration file (default: `scripts-orchestrator.config.js`) that def
   attempts: 1,                       // Number of retry attempts
   dependencies: [],                 // Array of dependent commands
   background: false,                // Whether to run in background
+  env: {                            // Optional environment variables
+    PORT: 3000,
+    NODE_ENV: 'production'
+  },
   kill_command: 'kill_storybook',   // Optional kill command to kill the process
   health_check: {                   // Health check configuration
     url: 'http://localhost:port',
@@ -155,6 +161,52 @@ export default {
 };
 ```
 
+### Using Environment Variables
+
+You can pass custom environment variables to commands using the `env` property. This is useful for configuring ports, API endpoints, or any environment-specific settings:
+
+```javascript
+export default {
+  phases: [
+    {
+      name: 'playwright',
+      parallel: [
+        {
+          command: 'playwright_ci',
+          description: 'Run Playwright tests',
+          env: {
+            PLAYWRIGHT_PORT: 5173,
+            API_URL: 'http://localhost:3000',
+            TEST_ENV: 'ci'
+          },
+          status: 'enabled',
+          attempts: 1,
+          dependencies: [
+            {
+              command: 'dev',
+              background: true,
+              env: {
+                PORT: 5173
+              },
+              health_check: {
+                url: 'http://localhost:5173',
+                max_attempts: 20,
+                interval: 2000
+              }
+            }
+          ]
+        }
+      ]
+    }
+  ]
+};
+```
+
+The command will run with the environment variables set, equivalent to:
+```bash
+PLAYWRIGHT_PORT=5173 API_URL=http://localhost:3000 TEST_ENV=ci npm run playwright_ci
+```
+
 See more examples [here](./docs/samples.md)
 
 ## Command Types

package/lib/orchestrator.js

@@ -62,6 +62,7 @@ export class Orchestrator {
       process_tracking = false,
       health_check,
       kill_command,
+      env,
     } = commandConfig;
 
     const startTime = Date.now();
@@ -162,6 +163,7 @@ export class Orchestrator {
         healthCheck: health_check,
         kill_command,
         isRetry: attempt > 1,
+        env,
       });
       commandOutput = output;
       result = success;

package/lib/process-manager.js

@@ -37,7 +37,7 @@ export class ProcessManager {
     });
   }
 
-  async runCommand({ cmd, logFile, background = false, healthCheck = null, kill_command = null, isRetry = false }) {
+  async runCommand({ cmd, logFile, background = false, healthCheck = null, kill_command = null, isRetry = false, env = null }) {
     const baseDir = this.logFolder ? path.resolve(this.logFolder) : process.cwd();
     const LOGS_DIR = path.join(baseDir, 'scripts-orchestrator-logs');
     // Use only the first word of the command for the log filename
@@ -62,10 +62,17 @@ export class ProcessManager {
     }
 
     return new Promise((resolve) => {
-      this.logger.info(`Running: npm run ${cmd}`);
+      // Build command with environment variables if provided
+      let fullCommand = `npm run ${cmd}`;
+      if (env && Object.keys(env).length > 0) {
+        const envStr = Object.entries(env).map(([key, value]) => `${key}=${value}`).join(' ');
+        fullCommand = `${envStr} npm run ${cmd}`;
+      }
+      
+      this.logger.info(`Running: ${fullCommand}`);
       
       // Create isolated environment for each process
-      const isolatedEnv = this.createIsolatedEnvironment({ command: cmd });
+      const isolatedEnv = this.createIsolatedEnvironment({ command: cmd, env });
       
       const options = {
         shell: true,
@@ -80,8 +87,8 @@ export class ProcessManager {
       //this.logger.verbose(`Process options: ${JSON.stringify(options, null, 2)}`);
 
       try {
-        this.logger.verbose(`Spawning process with command: npm run ${cmd}`);
-        const processInstance = spawn('npm', ['run', cmd], options);
+        this.logger.verbose(`Spawning process with command: ${fullCommand}`);
+        const processInstance = spawn(fullCommand, [], options);
 
         processInstance.on('error', (error) => {
           this.logger.error(`Failed to start process: ${error.message}`);
@@ -235,7 +242,7 @@ export class ProcessManager {
     });
   }
 
-  createIsolatedEnvironment({ command }) {
+  createIsolatedEnvironment({ command, env = null }) {
     // Create a deep copy to avoid any reference sharing
     const baseEnv = JSON.parse(JSON.stringify(process.env));
     
@@ -255,6 +262,13 @@ export class ProcessManager {
       npm_config_loglevel: 'error',
     };
 
+    // Merge custom environment variables if provided
+    if (env && typeof env === 'object') {
+      Object.entries(env).forEach(([key, value]) => {
+        isolatedEnv[key] = String(value);
+      });
+    }
+
     // Remove any potentially problematic environment variables
     delete isolatedEnv.npm_lifecycle_event;
     delete isolatedEnv.npm_lifecycle_script;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "scripts-orchestrator",
-  "version": "2.7.0",
+  "version": "2.7.1",
   "description": "A powerful script orchestrator for running parallel commands with dependency management, background processes, and health checks",
   "main": "lib/index.js",
   "type": "module",

package/scripts-orchestrator.config.js

@@ -99,6 +99,9 @@ export default {
         {
           command: 'playwright_ci',
           description: 'Run Playwright tests',
+          env: {
+            PLAYWRIGHT_PORT: 5173,
+          },
           status: 'enabled',
           attempts: 1, //Playwright internally retries in CI mode
           dependencies: [