feat: Add ability for plugins to display a <press key to continue> prompt

Author: kevinwang5658

codify.json

@@ -5,6 +5,9 @@
       "default": "../codify-homebrew-plugin/src/index.ts"
     }
   },
+  { "type": "virtualenv" },
+  { "type": "virtualenv-project", "dest": ".venv12", "cwd": "~/Projects/python-temp2", "automaticallyInstallRequirementsTxt": true },
+  { "type": "pnpm", "version": "9.15.5", "globalEnv": "20.15" },
   { "type": "path", "path":  "$HOME/.bun/bin"},
   {
     "type": "path",
@@ -56,7 +59,7 @@
       "zstd"
     ]
   },
-  {"version":"1.10.5","type":"terraform"},
+  { "version":"1.10.5","type":"terraform" },
   { "type": "alias", "alias": "gcdsdd", "value": "git clone" },
   {
     "type": "ssh-config",
@@ -130,6 +133,9 @@
     "directory": "~/Projects/codify",
     "repository": "git@github.com:kevinwang5658/codify.git"
   },
+  {
+    "type": "wait-github-ssh-key"
+  },
   {
     "type": "git-lfs"
   },
@@ -148,18 +154,6 @@
     "email": "kevinwang5658@gmail.com",
     "username": "kevinwang"
   },
-  {
-    "type": "nvm",
-    "global": "20.15.1",
-    "nodeVersions": [
-      "iojs-2.5.0",
-      "18.20.3",
-      "20.15.0",
-      "20.15.1",
-      "22.4.1",
-      "23.3.0"
-    ]
-  },
   {
     "type": "android-studio",
     "version": "2023.3.1.20"

package-lock.json

@@ -14,7 +14,7 @@
     "ajv": "^8.12.0",
     "ajv-formats": "^3.0.1",
     "chalk": "^5.3.0",
-    "codify-schemas": "^1.0.74",
+    "codify-schemas": "^1.0.76",
     "debug": "^4.3.4",
     "detect-indent": "^7.0.1",
     "diff": "^7.0.0",

package.json

@@ -1,7 +1,7 @@
 import { Command, Flags } from '@oclif/core';
 import { OutputFlags } from '@oclif/core/interfaces';
 import chalk from 'chalk';
-import { SudoRequestData } from 'codify-schemas';
+import { PressKeyToContinueRequestData, SudoRequestData } from 'codify-schemas';
 import createDebug from 'debug';
 
 import { Event, ctx } from '../events/context.js';
@@ -58,6 +58,11 @@ export abstract class BaseCommand extends Command {
         this.catch(error as Error);
       }
     });
+
+    ctx.on(Event.PRESS_KEY_TO_CONTINUE_REQUEST, async (pluginName: string, data: PressKeyToContinueRequestData) => {
+      await this.reporter.promptPressKeyToContinue(data.promptMessage)
+      ctx.pressKeyToContinueCompleted(pluginName)
+    })
   }
 
   protected async catch(err: Error): Promise<void> {

src/common/base-command.ts

@@ -6,7 +6,7 @@ interface ParameterInfo {
   name: string;
   type?: string;
   description?: string;
-  isRequired: boolean;
+  isRequiredForImport: boolean;
   value?: unknown;
 }
 
@@ -66,15 +66,20 @@ export class ResourceInfo implements GetResourceInfoResponseData {
 
       this.parametersCache = Object.entries(properties)
         .map(([propertyName, info]) => {
-          const isRequired = this.importAndDestroy?.requiredParameters?.some((name) => name === propertyName)
+          const isRequiredForImport = this.importAndDestroy?.requiredParameters?.some((name) => name === propertyName)
+            ?? (required as string[] | undefined)?.includes(propertyName)
+            ?? false;
+
+          const isRequiredForDestroy = this.importAndDestroy?.requiredParameters?.some((name) => name === propertyName)
             ?? (required as string[] | undefined)?.includes(propertyName)
             ?? false;
 
           return {
             name: propertyName,
             type: info.type ?? null,
             description: info.description,
-            isRequired
+            isRequiredForImport,
+            isRequiredForDestroy,
           }
         });
     }
@@ -84,6 +89,6 @@ export class ResourceInfo implements GetResourceInfoResponseData {
 
   getRequiredParameters(): ParameterInfo[] {
     return this.getParameterInfo()
-      .filter((info) => info.isRequired);
+      .filter((info) => info.isRequiredForImport);
   }
 }

src/entities/resource-info.ts

@@ -15,6 +15,8 @@ export enum Event {
   SUB_PROCESS_START = 'sub_process_start',
   SUDO_REQUEST = 'sudo_request',
   SUDO_REQUEST_GRANTED = 'sudo_request_granted',
+  PRESS_KEY_TO_CONTINUE_REQUEST = 'press_key_to_continue_request',
+  PRESS_KEY_TO_CONTINUE_COMPLETED = 'press_key_to_continue_completed',
 }
 
 export enum ProcessName {
@@ -105,6 +107,14 @@ export const ctx = new class {
     this.emitter.emit(Event.SUDO_REQUEST_GRANTED, pluginName, data);
   }
 
+  pressToContinueRequested(pluginName: string, data: any) {
+    this.emitter.emit(Event.PRESS_KEY_TO_CONTINUE_REQUEST, pluginName, data);
+  }
+
+  pressKeyToContinueCompleted(pluginName: string) {
+    this.emitter.emit(Event.PRESS_KEY_TO_CONTINUE_COMPLETED, pluginName);
+  }
+
   async subprocess<T>(name: string, run: () => Promise<T>): Promise<T> {
     this.emitter.emit(Event.SUB_PROCESS_START, name);
     const result = await run();

src/events/context.ts

@@ -1,4 +1,12 @@
-import { IpcMessageV2, IpcMessageV2Schema, MessageCmd, SudoRequestData, SudoRequestDataSchema } from 'codify-schemas';
+import { 
+  IpcMessageV2,
+  IpcMessageV2Schema,
+  MessageCmd,
+  PressKeyToContinueRequestData,
+  PressKeyToContinueRequestDataSchema,
+  SudoRequestData,
+  SudoRequestDataSchema
+} from 'codify-schemas';
 import { ChildProcess, fork } from 'node:child_process';
 import { createRequire } from 'node:module';
 
@@ -9,6 +17,7 @@ import { PluginMessage } from './plugin-message.js';
 
 export const ipcMessageValidator = ajv.compile(IpcMessageV2Schema);
 export const sudoRequestValidator = ajv.compile(SudoRequestDataSchema);
+export const pressKeyToContinueRequestValidator = ajv.compile(PressKeyToContinueRequestDataSchema);
 
 const DEFAULT_NODE_MODULES_DIR = '/usr/local/lib/codify/node_modules/'
 
@@ -88,7 +97,27 @@ export class PluginProcess {
           }
         })
 
-        ctx.sudoRequested(pluginName, data as unknown as SudoRequestData);
+        return ctx.sudoRequested(pluginName, data as unknown as SudoRequestData);
+      }
+
+      if (message.cmd === MessageCmd.PRESS_KEY_TO_CONTINUE_REQUEST) {
+        const { data, requestId } = message;
+        if (!pressKeyToContinueRequestValidator(data)) {
+          throw new Error(`Invalid press key to continue request from plugin ${pluginName}. ${JSON.stringify(pressKeyToContinueRequestValidator.errors, null, 2)}`);
+        }
+
+        // Send out sudo granted events
+        ctx.once(Event.PRESS_KEY_TO_CONTINUE_COMPLETED, (_pluginName) => {
+          if (_pluginName === pluginName) {
+            process.send({
+              cmd: returnMessageCmd(MessageCmd.PRESS_KEY_TO_CONTINUE_REQUEST),
+              requestId,
+              data: {},
+            })
+          }
+        })
+
+        return ctx.pressToContinueRequested(pluginName, data as unknown as PressKeyToContinueRequestData);
       }
     })
   }

src/plugins/plugin-process.ts

@@ -17,9 +17,10 @@ import { FileModificationDisplay } from './file-modification/FileModification.js
 import { ImportResultComponent } from './import/import-result.js';
 import { ImportWarning } from './import/import-warning.js';
 import { InitBanner } from './init/InitBanner.js';
+import { MultiSelect } from './multi-select/MultiSelect.js';
 import { PlanComponent } from './plan/plan.js';
 import { ProgressDisplay } from './progress/progress-display.js';
-import { MultiSelect } from './multi-select/MultiSelect.js';
+import { PromptPressKeyToContinue } from './widgets/PromptPressKeyToContinue.js';
 
 const spinnerEmitter = new EventEmitter();
 
@@ -157,9 +158,14 @@ export function DefaultComponent(props: {
         <Box flexDirection='column'>
           <Text bold>{renderData.prompt}</Text>
           { renderData.error && (<Text color='red'>{renderData.error}</Text>) }
-          <TextInput placeholder='~/codify.json' onSubmit={(result) => emitter.emit(RenderEvent.PROMPT_RESULT, result)} />
+          <TextInput onSubmit={(result) => emitter.emit(RenderEvent.PROMPT_RESULT, result)} placeholder='~/codify.json' />
         </Box>
       )
     }
+    {
+      renderStatus === RenderStatus.PROMPT_PRESS_KEY_TO_CONTINUE && (
+        <PromptPressKeyToContinue message={renderData as string | undefined} onInput={() => emitter.emit(RenderEvent.PROMPT_RESULT)} />
+      )
+    }
   </Box>
 }

src/ui/components/default-component.tsx

@@ -0,0 +1,17 @@
+import { Box, Text, useInput } from 'ink';
+import React from 'react';
+
+export function PromptPressKeyToContinue(props: {
+  message?: string;
+  onInput: () => void
+}) {
+  useInput(() => {
+    props.onInput();
+  });
+
+  return <Box flexDirection='column' marginTop={1}>
+    { props.message && (<Text>{props.message}</Text>) }
+    <Text> </Text>
+    <Text color='gray' dimColor>{'<Press any key to continue>'}</Text>
+  </Box>
+}

src/ui/components/widgets/PromptPressKeyToContinue.tsx

@@ -49,6 +49,15 @@ export class DefaultReporter implements Reporter {
     ctx.on(Event.SUB_PROCESS_FINISH, (name, additionalName) => this.onSubprocessFinishEvent(name, additionalName));
   }
 
+  async promptPressKeyToContinue(message?: string): Promise<void> {
+    await this.updateStateAndAwaitEvent<boolean>(
+      () => this.updateRenderState(RenderStatus.PROMPT_PRESS_KEY_TO_CONTINUE, message),
+      RenderEvent.PROMPT_RESULT,
+    )
+
+    this.updateRenderState(RenderStatus.NOTHING);
+  }
+
   async displayInitBanner(): Promise<void> {
     await this.updateStateAndAwaitEvent<boolean>(
       () => this.updateRenderState(RenderStatus.DISPLAY_INIT_BANNER),