@travetto/cli 7.0.7 → 7.1.0

package/README.md

@@ -472,14 +472,14 @@ import type { WebHttpServer } from '../src/types.ts';
 /**
  * Run a web server
  */
-@CliCommand({ runTarget: true, with: { debugIpc: 'optional', restartOnChange: true, module: true, env: true } })
+@CliCommand({ runTarget: true, with: { debugIpc: 'optional', restartOnChange: true, module: true, profiles: true } })
 export class WebHttpCommand implements CliCommandShape {
 
   /** Port to run on */
   port?: number;
 
   /** Kill conflicting port owner */
-  killConflict?: boolean = Runtime.envType === 'development';
+  killConflict?: boolean = Runtime.localDevelopment;
 
   preMain(): void {
     if (this.port) {
@@ -506,7 +506,7 @@ export class WebHttpCommand implements CliCommandShape {
 }
 ```
 
-As noted in the example above, `fields` is specified in this execution, with support for `module`, and `env`. These env flag is directly tied to the [Runtime](https://github.com/travetto/travetto/tree/main/module/runtime/src/context.ts#L12) `name` defined in the [Runtime](https://github.com/travetto/travetto/tree/main/module/runtime#readme "Runtime for travetto applications.") module. 
+As noted in the example above, `fields` is specified in this execution, with support for `module`, and `env`. These env flag is directly tied to the [Runtime](https://github.com/travetto/travetto/tree/main/module/runtime/src/context.ts#L13) `name` defined in the [Runtime](https://github.com/travetto/travetto/tree/main/module/runtime#readme "Runtime for travetto applications.") module. 
 
 The `module` field is slightly more complex, but is geared towards supporting commands within a monorepo context.  This flag ensures that a module is specified if running from the root of the monorepo, and that the module provided is real, and can run the desired command.  When running from an explicit module folder in the monorepo, the module flag is ignored.
 

package/bin/trv.js

@@ -2,4 +2,4 @@
 // @ts-check
 import '@travetto/compiler/bin/hook.js';
 const { invoke } = await import('@travetto/compiler/support/invoke.ts');
-invoke('exec', ['@travetto/cli/support/entry.trv.js', ...process.argv.slice(2)]);
+await invoke('exec', ['@travetto/cli/support/entry.trv.js', ...process.argv.slice(2)]);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/cli",
-  "version": "7.0.7",
+  "version": "7.1.0",
   "type": "module",
   "description": "CLI infrastructure for Travetto framework",
   "keywords": [
@@ -29,8 +29,8 @@
     "directory": "module/cli"
   },
   "dependencies": {
-    "@travetto/schema": "^7.0.6",
-    "@travetto/terminal": "^7.0.5"
+    "@travetto/schema": "^7.1.0",
+    "@travetto/terminal": "^7.1.0"
   },
   "travetto": {
     "displayName": "Command Line Interface",

package/src/error.ts

@@ -23,8 +23,8 @@ export class CliUnknownCommandError extends Error {
   #getMissingCommandHelp(cmd: string): string | undefined {
     const matchedConfig = COMMAND_PACKAGE.find(([regex]) => regex.test(cmd));
     if (matchedConfig) {
-      const [, pkg, prod] = matchedConfig;
-      const install = PackageUtil.getInstallCommand(Runtime, `@travetto/${pkg}`, prod);
+      const [, pkg, production] = matchedConfig;
+      const install = PackageUtil.getInstallCommand(Runtime, `@travetto/${pkg}`, production);
       return cliTpl`
 ${{ title: 'Missing Package' }}\n${'-'.repeat(20)}\nTo use ${{ input: cmd }} please run:\n
 ${{ identifier: install }}

package/src/execute.ts

@@ -75,7 +75,7 @@ export class ExecutionManager {
     } catch (error) {
       await this.#onError(error);
     } finally {
-      await ShutdownManager.gracefulShutdown('@travetto/cli:execute');
+      await ShutdownManager.shutdown();
     }
   }
 }

package/src/registry/decorator.ts

@@ -7,14 +7,14 @@ import { CliModuleUtil } from '../module.ts';
 import { CliParseUtil } from '../parse.ts';
 import { CliUtil } from '../util.ts';
 
-type Cmd = CliCommandShape & { env?: string };
+type Cmd = CliCommandShape & { profiles?: string[] };
 
 type CliCommandConfigOptions = {
   runTarget?: boolean;
   runtimeModule?: 'current' | 'command';
   with?: {
     /** Application environment */
-    env?: boolean;
+    profiles?: boolean;
     /** Module to run for */
     module?: boolean;
     /** Should debug invocation trigger via ipc */
@@ -32,15 +32,15 @@ type WithHandler<K extends keyof WithConfig> = (config?: WithConfig[K]) => ({
 } | undefined);
 
 const FIELD_CONFIG: { [K in keyof WithConfig]: WithHandler<K> } = {
-  env: (config) => {
+  profiles: (config) => {
     if (!config) { return; }
     return {
-      name: 'env',
-      run: cmd => Env.TRV_ENV.set(cmd.env || Runtime.env),
+      name: 'profiles',
+      run: cmd => cmd.profiles && Env.TRV_PROFILES.set([...cmd.profiles, ...(Env.TRV_PROFILES.list ?? [])]),
       field: {
         type: String,
-        aliases: ['-e', CliParseUtil.toEnvField(Env.TRV_ENV.key)],
-        description: 'Application environment',
+        aliases: ['--profile', '--profiles', CliParseUtil.toEnvField(Env.TRV_PROFILES.key)],
+        description: 'Application profiles',
         required: { active: false },
       },
     };
@@ -62,7 +62,7 @@ const FIELD_CONFIG: { [K in keyof WithConfig]: WithHandler<K> } = {
     if (!config) { return; }
     return {
       name: 'debugIpc',
-      run: cmd => CliUtil.runWithDebugIpc(cmd).then((executed) => executed && process.exit(0)),
+      run: cmd => CliUtil.runWithDebugIpc(cmd),
       field: {
         type: Boolean,
         aliases: ['-di', CliParseUtil.toEnvField(Env.TRV_DEBUG_IPC.key)],
@@ -79,9 +79,9 @@ const FIELD_CONFIG: { [K in keyof WithConfig]: WithHandler<K> } = {
       run: cmd => CliUtil.runWithRestartOnChange(cmd),
       field: {
         type: Boolean,
-        aliases: ['-rc', CliParseUtil.toEnvField(Env.TRV_RESTART_ON_CHANGE.key)],
+        aliases: ['-rc'],
         description: 'Should the invocation automatically restart on source changes',
-        default: config !== 'optional' && Runtime.envType === 'development',
+        default: config !== 'optional' && Runtime.localDevelopment,
         required: { active: false },
       },
     };

package/src/registry/registry-index.ts

@@ -41,7 +41,7 @@ export class CliCommandRegistryIndex implements RegistryIndex {
     if (!this.#fileMapping) {
       const all = new Map<string, string>();
       for (const entry of RuntimeIndex.find({
-        module: module => !Runtime.production || module.prod,
+        module: module => !Runtime.production || module.production,
         folder: folder => folder === 'support',
         file: file => file.role === 'std' && CLI_FILE_REGEX.test(file.sourceFile)
       })) {

package/src/trv.d.ts

@@ -8,9 +8,9 @@ declare module '@travetto/runtime' {
      */
     TRV_CLI_IPC: string;
     /** 
-     * Overrides behavior for allowing restart on changes 
+     * Signals to the child they are the restart target
      */
-    TRV_RESTART_ON_CHANGE: boolean;
+    TRV_RESTART_TARGET: boolean;
     /** 
      * Overrides behavior for triggering debug session via IPC
      */

package/src/types.ts

@@ -80,9 +80,9 @@ export interface CliCommandShape<T extends unknown[] = unknown[]> {
  */
 export type CliCommandShapeFields = {
   /**
-   * Environment to run in
+   * Profiles to run the application under
    */
-  env?: string;
+  profiles?: string[];
   /**
    * Should the cli invocation trigger a debug session, via IPC
    */

package/src/util.ts

@@ -1,6 +1,6 @@
 import { spawn, type ChildProcess } from 'node:child_process';
 
-import { Env, ExecUtil, Runtime, ShutdownManager, Util, WatchUtil } from '@travetto/runtime';
+import { AppError, Env, ExecUtil, Runtime, ShutdownManager, Util, WatchUtil } from '@travetto/runtime';
 
 import type { CliCommandShape, CliCommandShapeFields } from './types.ts';
 
@@ -28,53 +28,57 @@ export class CliUtil {
   /**
    * Run a command as restartable, linking into self
    */
-  static async runWithRestartOnChange<T extends CliCommandShapeFields>(cmd: T): Promise<boolean> {
-    if (cmd.restartOnChange !== true) {
-      WatchUtil.listenForRestartSignal();
-      return false;
+  static async runWithRestartOnChange<T extends CliCommandShapeFields>(cmd: T): Promise<void> {
+    if (Env.TRV_RESTART_TARGET.isTrue) {
+      Env.TRV_RESTART_TARGET.clear();
+      WatchUtil.listenForSignals();
+      return;
+    } else if (cmd.restartOnChange !== true) {
+      return; // Not restarting, run normal
     }
 
-    let subProcess: ChildProcess | undefined;
-    void WatchUtil.watchCompilerEvents('file', () => WatchUtil.triggerRestartSignal(subProcess));
+    ShutdownManager.disableInterrupt();
 
-    const env = { ...process.env, ...Env.TRV_RESTART_ON_CHANGE.export(false) };
+    let child: ChildProcess | undefined;
+    void WatchUtil.watchCompilerEvents('file', () => child && WatchUtil.triggerSignal(child, 'WATCH_RESTART'));
+    process.on('SIGINT', () => child && WatchUtil.triggerSignal(child, 'WATCH_SHUTDOWN'));
 
-    const log = (msg: string, extra?: Record<string, unknown>): void => {
-      console.error(`[cli-restart] ${msg}`, { pid: process.pid, ...extra });
-    };
+    const env = { ...process.env, ...Env.TRV_RESTART_TARGET.export(true) };
 
     await WatchUtil.runWithRetry(
       async () => {
-        const { code } = await ExecUtil.deferToSubprocess(
-          subProcess = spawn(process.argv0, process.argv.slice(1), { env, stdio: [0, 1, 2, 'ipc'] }),
-        );
+        child = spawn(process.argv0, process.argv.slice(1), { env, stdio: ['pipe', 1, 2, 'ipc'] });
+        const { code } = await ExecUtil.deferToSubprocess(child);
         return WatchUtil.exitCodeToResult(code);
       },
       {
         maxRetries: 5,
         onRetry: async (state, config) => {
           const duration = WatchUtil.computeRestartDelay(state, config);
-          log('Restarting subprocess due to change...', { waiting: duration, iteration: state.iteration, errorIterations: state.errorIterations || undefined });
+          console.error(
+            '[cli-restart] Restarting subprocess due to change...',
+            { waiting: duration, iteration: state.iteration, errorIterations: state.errorIterations || undefined }
+          );
           await Util.nonBlockingTimeout(duration);
         },
-      });
+      }
+    );
 
-    await ShutdownManager.gracefulShutdown('cli-restart');
-    process.exit();
+    await ShutdownManager.shutdown();
   }
 
   /**
    * Dispatch IPC payload
    */
-  static async runWithDebugIpc<T extends CliCommandShapeFields & CliCommandShape>(cmd: T): Promise<boolean> {
+  static async runWithDebugIpc<T extends CliCommandShapeFields & CliCommandShape>(cmd: T): Promise<void> {
     if (cmd.debugIpc !== true || !Env.TRV_CLI_IPC.isSet) {
-      return false;
+      return; // Not debugging, run normal
     }
 
     const info = await fetch(Env.TRV_CLI_IPC.value!).catch(() => ({ ok: false }));
 
-    if (!info.ok) { // Server not running
-      return false;
+    if (!info.ok) {
+      return; // Server not running, run normal
     }
 
     const env: Record<string, string> = {};
@@ -91,7 +95,10 @@ export class CliUtil {
 
     Object.entries(process.env).forEach(([key, value]) => validEnv(key) && (env[key] = value!));
     const sent = await fetch(Env.TRV_CLI_IPC.value!, { method: 'POST', body: JSON.stringify(request) });
-    return sent.ok;
+
+    if (!sent.ok) {
+      throw new AppError(`IPC Request failed: ${sent.status} ${await sent.text()}`);
+    }
   }
 
   /**