fix: Fixed display functions to be async

kevinwang5658 · kevinwang5658 · commit f6563de9cc48 · 2026-04-26T23:26:27.000-04:00
diff --git a/src/common/base-command.ts b/src/common/base-command.ts
@@ -147,7 +147,7 @@ export abstract class BaseCommand extends Command {
   protected async catch(err: Error): Promise<void> {
     if (err instanceof PluginError && this.reporter) {
       await this.reporter.hide();
-      this.reporter.displayPluginError(err);
+      await this.reporter.displayPluginError(err);
       process.exit(1);
     }
 
diff --git a/src/orchestrators/destroy.ts b/src/orchestrators/destroy.ts
@@ -42,7 +42,7 @@ export class DestroyOrchestrator {
     plan.sortByEvalOrder(project.evaluationOrder);
     destroyProject.removeNoopFromEvaluationOrder(plan);
 
-    reporter.displayPlan(plan);
+    await reporter.displayPlan(plan);
 
     // Short circuit and exit if every change is NOOP
     if (plan.isEmpty()) {
diff --git a/src/orchestrators/import.ts b/src/orchestrators/import.ts
@@ -116,7 +116,7 @@ export class ImportOrchestrator {
 
     ctx.processFinished(ProcessName.IMPORT)
 
-    reporter.displayImportResult(importResult, false);
+    await reporter.displayImportResult(importResult, false);
 
     resourceInfoList.push(...(await pluginManager.getMultipleResourceInfo(
       project.resourceConfigs.map((r) => r.type)
@@ -194,7 +194,7 @@ export class ImportOrchestrator {
     }
 
     // No writes
-    reporter.displayImportResult(importResult, true);
+    await reporter.displayImportResult(importResult, true);
     await reporter.displayMessage('\n🎉 Imported completed 🎉')
 
     await sleep(100);
@@ -244,17 +244,17 @@ export class ImportOrchestrator {
 
     // No changes to be made
     if (diffs.every((d) => d.modification.diff === '')) {
-      reporter.displayMessage('\nNo changes are needed! Exiting...')
+      await reporter.displayMessage('\nNo changes are needed! Exiting...')
 
       // Wait for the message to display before we exit
       await sleep(100);
       return;
     }
 
-    reporter.displayFileModifications(diffs);
+    await reporter.displayFileModifications(diffs);
     const shouldSave = await reporter.promptConfirmation('Save the changes?');
     if (!shouldSave) {
-      reporter.displayMessage('\nSkipping save! Exiting...');
+      await reporter.displayMessage('\nSkipping save! Exiting...');
 
       // Wait for the message to display before we exit
       await sleep(100);
@@ -265,7 +265,7 @@ export class ImportOrchestrator {
       await FileUpdater.write(diff.file, diff.modification.newFile);
     }
 
-    reporter.displayMessage('\n🎉 Imported completed and saved to file 🎉');
+    await reporter.displayMessage('\n🎉 Imported completed and saved to file 🎉');
 
     // Wait for the message to display before we exit
     await sleep(100);
@@ -448,11 +448,11 @@ ${JSON.stringify(unsupportedTypeIds)}`);
     const newFile = JSON.stringify(importResult.result.map((r) => r.raw), null, 2);
     const diff = prettyFormatFileDiff('', newFile);
 
-    reporter.displayFileModifications([{ file: filePath, modification: { newFile, diff } }]);
+    await reporter.displayFileModifications([{ file: filePath, modification: { newFile, diff } }]);
 
     const shouldSave = await reporter.promptConfirmation(`Save the changes? (${filePath})`);
     if (!shouldSave) {
-      reporter.displayMessage('\nSkipping save! Exiting...');
+      await reporter.displayMessage('\nSkipping save! Exiting...');
 
       // Wait for the message to display before we exit
       await sleep(100);
@@ -461,7 +461,7 @@ ${JSON.stringify(unsupportedTypeIds)}`);
 
     await FileUpdater.write(filePath, newFile);
 
-    reporter.displayMessage('\n🎉 Imported completed and saved to file 🎉');
+    await reporter.displayMessage('\n🎉 Imported completed and saved to file 🎉');
 
     // Wait for the message to display before we exit
     await sleep(100);
diff --git a/src/orchestrators/plan.ts b/src/orchestrators/plan.ts
@@ -48,7 +48,7 @@ export class PlanOrchestrator {
     if (!args.noProgress) ctx.processFinished(ProcessName.PLAN)
 
     await reporter.hide();
-    reporter.displayPlan(plan);
+    await reporter.displayPlan(plan);
 
     return {
       plan,
diff --git a/src/orchestrators/refresh.ts b/src/orchestrators/refresh.ts
@@ -35,7 +35,7 @@ export class RefreshOrchestrator {
 
     ctx.processFinished(ProcessName.REFRESH);
 
-    reporter.displayImportResult(importResult, false);
+    await reporter.displayImportResult(importResult, false);
 
 
     // Special handling for remote-file resources. Offer to save them remotely if any changes are detected on import.
diff --git a/src/orchestrators/test.ts b/src/orchestrators/test.ts
@@ -130,7 +130,7 @@ export const TestOrchestrator = {
 
     // Short circuit and exit if every change is NOOP
     if (!planResult.plan.isEmpty()) {
-      reporter.displayPlan(planResult.plan);
+      await reporter.displayPlan(planResult.plan);
       const confirm = await reporter.promptConfirmation('The following resources will need to be installed (Tart VM - 25gb). Do you want to continue?')
       if (!confirm) {
         return process.exit(0);
diff --git a/src/ui/reporters/default-reporter.tsx b/src/ui/reporters/default-reporter.tsx
@@ -207,11 +207,11 @@ export class DefaultReporter implements Reporter {
     }
   }
 
-  displayImportResult(importResult: ImportResult, showConfigs: boolean): void {
+  async displayImportResult(importResult: ImportResult, showConfigs: boolean): Promise<void> {
     store.set(store.progressState, null);
     this.progressState = null;
 
-    void this.updateRenderState(RenderStatus.DISPLAY_IMPORT_RESULT, { importResult, showConfigs });
+    await this.updateRenderState(RenderStatus.DISPLAY_IMPORT_RESULT, { importResult, showConfigs });
   }
 
   async promptSudo(pluginName: string, data: CommandRequestData): Promise<string | undefined> {
@@ -223,8 +223,8 @@ export class DefaultReporter implements Reporter {
     return password;
   }
 
-  displayPlan(plan: Plan): void {
-    void this.updateRenderState(RenderStatus.DISPLAY_PLAN, plan)
+  async displayPlan(plan: Plan): Promise<void> {
+    await this.updateRenderState(RenderStatus.DISPLAY_PLAN, plan);
   }
 
   async displayMessage(message: string) {
@@ -264,17 +264,17 @@ export class DefaultReporter implements Reporter {
     return options.indexOf(result);
   }
 
-  displayFileModifications(diff: Array<{ file: string; modification: FileModificationResult}>) {
-    void this.updateRenderState(RenderStatus.DISPLAY_FILE_MODIFICATION, diff);
+  async displayFileModifications(diff: Array<{ file: string; modification: FileModificationResult}>): Promise<void> {
+    await this.updateRenderState(RenderStatus.DISPLAY_FILE_MODIFICATION, diff);
   }
 
-  displayPluginError(error: PluginError): void {
+  async displayPluginError(error: PluginError): Promise<void> {
     if (error.errorData.errorType === 'apply_validation') {
       const resourcePlan = new ResourcePlan((error.errorData.data as any).plan);
-      void this.updateRenderState(RenderStatus.APPLY_VALIDATION_ERROR, resourcePlan);
+      await this.updateRenderState(RenderStatus.APPLY_VALIDATION_ERROR, resourcePlan);
       return;
     }
-    void this.updateRenderState(RenderStatus.PLUGIN_ERROR, error.message);
+    await this.updateRenderState(RenderStatus.PLUGIN_ERROR, error.message);
   }
 
   private log(log: string): void {
@@ -388,6 +388,14 @@ export class DefaultReporter implements Reporter {
     return store.get(store.renderState) as { status: RenderStatus, data: any };
   }
 
+  /**
+   * Update the render state. We need to make this async because there is currently a weird bug where if we switch the
+   * layout too quickly then it can potentially crash with a memory error. We first switch to empty, wait 50ms and the
+   * render the next state
+   * @param status
+   * @param data
+   * @private
+   */
   private async updateRenderState(status: RenderStatus | null, data?: unknown): Promise<void> {
     const current = this.getRenderState();
     if (current?.status !== status) {
diff --git a/src/ui/reporters/json-reporter.ts b/src/ui/reporters/json-reporter.ts
@@ -9,7 +9,7 @@ import { Reporter } from './reporter.js';
 export class JsonReporter implements Reporter {
   silent = false;
 
-  displayPlan(plan: Plan): void {
+  async displayPlan(plan: Plan): Promise<void> {
     console.log(JSON.stringify(plan.resources.map((r) => r.raw), null, 2));
   }
 
@@ -59,7 +59,7 @@ export class JsonReporter implements Reporter {
   async displayFileModifications(): Promise<void> {
   }
 
-  displayMessage(): void {
+  async displayMessage(): Promise<void> {
   }
 
   async displayImportWarning(): Promise<void> {
@@ -73,7 +73,7 @@ export class JsonReporter implements Reporter {
     throw new Error('Json reporter error: disableRawMode is not supported. Raw stdin mode requires interactive terminal access.');
   }
 
-  displayPluginError(error: PluginError): void {
+  async displayPluginError(error: PluginError): Promise<void> {
     console.log(JSON.stringify({
       errorType: error.errorData.errorType,
       message: error.message,
diff --git a/src/ui/reporters/plain-reporter.ts b/src/ui/reporters/plain-reporter.ts
@@ -70,7 +70,7 @@ export class PlainReporter implements Reporter {
     return Number.parseInt(response as string, 10);
   }
 
-  displayFileModifications(diffs: { file: string; modification: FileModificationResult; }[]): void {
+  async displayFileModifications(diffs: { file: string; modification: FileModificationResult; }[]): Promise<void> {
     ctx.log(chalk.bold('File modifications\n'))
 
     for (const diff of diffs) {
@@ -81,7 +81,7 @@ export class PlainReporter implements Reporter {
     }
   }
 
-  displayMessage(message: string): void {
+  async displayMessage(message: string): Promise<void> {
     ctx.log(message);
   }
 
@@ -128,7 +128,7 @@ export class PlainReporter implements Reporter {
     return availableTypes;
   }
 
-  displayImportResult(importResult: ImportResult) {
+  async displayImportResult(importResult: ImportResult): Promise<void> {
     ctx.log();
     ctx.log(JSON.stringify(importResult.result.map((r) => r.raw), null, 2));
 
@@ -159,13 +159,13 @@ Use this init flow to get started quickly with Codify.
     return response === 'yes';
   }
 
-  displayPlan(plan: Plan): void {
+  async displayPlan(plan: Plan): Promise<void> {
     ctx.log(
       prettyFormatPlan(plan.filterNoopResources())
     );
   }
 
-  displayPluginError(error: PluginError): void {
+  async displayPluginError(error: PluginError): Promise<void> {
     if (error.errorData.errorType === 'apply_validation') {
       ctx.log(chalk.red(formatApplyValidationError(error)));
       return;
diff --git a/src/ui/reporters/reporter.ts b/src/ui/reporters/reporter.ts
@@ -51,7 +51,7 @@ export enum PromptType {
 export interface Reporter {
   silent: boolean;
 
-  displayPlan(plan: Plan): void
+  displayPlan(plan: Plan): Promise<void>
 
   displayInitBanner(): Promise<void>
 
@@ -73,19 +73,19 @@ export interface Reporter {
 
   promptPressKeyToContinue(message?: string): Promise<void>;
 
-  displayImportResult(importResult: ImportResult, showConfigs: boolean): void;
+  displayImportResult(importResult: ImportResult, showConfigs: boolean): Promise<void>;
 
-  displayFileModifications(diff: Array<{ file: string, modification: FileModificationResult }>): void
+  displayFileModifications(diff: Array<{ file: string, modification: FileModificationResult }>): Promise<void>
 
-  displayMessage(message: string): void
+  displayMessage(message: string): Promise<void>
 
   displayImportWarning(requiresParameters: string[], noParametersRequired: string[]): Promise<void>
 
   setRawMode(): Promise<void>
 
   disableRawMode(): Promise<void>
 
-  displayPluginError(error: PluginError): void;
+  displayPluginError(error: PluginError): Promise<void>;
 }
 
 export enum ReporterType {
diff --git a/src/ui/reporters/stub-reporter.ts b/src/ui/reporters/stub-reporter.ts
@@ -8,7 +8,7 @@ import { PromptType, Reporter } from './reporter.js';
 
 export class StubReporter implements Reporter {
     silent: boolean = true;
-    displayPlan(): void {}
+    async displayPlan(): Promise<void> {}
     async displayInitBanner(): Promise<void> {}
     async displayProgress(): Promise<void> {}
     async hide(): Promise<void> {}
@@ -25,5 +25,5 @@ export class StubReporter implements Reporter {
     async displayImportWarning(requiresParameters: string[], noParametersRequired: string[]): Promise<void> {}
     async setRawMode(): Promise<void> {}
     async disableRawMode(): Promise<void> {}
-    displayPluginError(): void {}
+    async displayPluginError(): Promise<void> {}
 }
diff --git a/test/orchestrator/import/import.test.ts b/test/orchestrator/import/import.test.ts
@@ -167,7 +167,7 @@ describe('Import orchestrator tests', () => {
         return 0;
       },
       displayFileModifications: (diff: Array<{ file: string, modification: FileModificationResult }>) => {
-        expect(diff[0].file).to.eq('/codify.json')
+        expect(diff[0].file).to.eq('/import.codify.jsonc')
         console.log(diff[0].file);
       },
     });
@@ -731,7 +731,7 @@ describe('Import orchestrator tests', () => {
         return 0;
       },
       displayFileModifications: (diff: Array<{ file: string, modification: FileModificationResult }>) => {
-        expect(diff[0].file).to.eq('/codify.json')
+        expect(diff[0].file).to.eq('/import.codify.jsonc')
         console.log(diff[0].file);
       },
     });
@@ -810,7 +810,7 @@ describe('Import orchestrator tests', () => {
         return 0;
       },
       displayFileModifications: (diff: Array<{ file: string, modification: FileModificationResult }>) => {
-        expect(diff[0].file).to.eq('/codify.json')
+        expect(diff[0].file).to.eq('/codify.jsonc')
         console.log(diff[0].file);
       },
     });

Original file line number	Diff line number	Diff line change
`@@ -147,7 +147,7 @@ export abstract class BaseCommand extends Command {`
`147`	`147`	`protected async catch(err: Error): Promise<void> {`
`148`	`148`	`if (err instanceof PluginError && this.reporter) {`
`149`	`149`	`await this.reporter.hide();`
`150`		`- this.reporter.displayPluginError(err);`
	`150`	`+ await this.reporter.displayPluginError(err);`
`151`	`151`	`process.exit(1);`
`152`	`152`	`}`
`153`	`153`
Original file line number	Diff line number	Diff line change
`@@ -207,11 +207,11 @@ export class DefaultReporter implements Reporter {`
`207`	`207`	`}`
`208`	`208`	`}`
`209`	`209`
`210`		`- displayImportResult(importResult: ImportResult, showConfigs: boolean): void {`
	`210`	`+ async displayImportResult(importResult: ImportResult, showConfigs: boolean): Promise<void> {`
`211`	`211`	`store.set(store.progressState, null);`
`212`	`212`	`this.progressState = null;`
`213`	`213`
`214`		`- void this.updateRenderState(RenderStatus.DISPLAY_IMPORT_RESULT, { importResult, showConfigs });`
	`214`	`+ await this.updateRenderState(RenderStatus.DISPLAY_IMPORT_RESULT, { importResult, showConfigs });`
`215`	`215`	`}`
`216`	`216`
`217`	`217`	`async promptSudo(pluginName: string, data: CommandRequestData): Promise<string \| undefined> {`
`@@ -223,8 +223,8 @@ export class DefaultReporter implements Reporter {`
`223`	`223`	`return password;`
`224`	`224`	`}`
`225`	`225`
`226`		`- displayPlan(plan: Plan): void {`
`227`		`- void this.updateRenderState(RenderStatus.DISPLAY_PLAN, plan)`
	`226`	`+ async displayPlan(plan: Plan): Promise<void> {`
	`227`	`+ await this.updateRenderState(RenderStatus.DISPLAY_PLAN, plan);`
`228`	`228`	`}`
`229`	`229`
`230`	`230`	`async displayMessage(message: string) {`
`@@ -264,17 +264,17 @@ export class DefaultReporter implements Reporter {`
`264`	`264`	`return options.indexOf(result);`
`265`	`265`	`}`
`266`	`266`
`267`		`- displayFileModifications(diff: Array<{ file: string; modification: FileModificationResult}>) {`
`268`		`- void this.updateRenderState(RenderStatus.DISPLAY_FILE_MODIFICATION, diff);`
	`267`	`+ async displayFileModifications(diff: Array<{ file: string; modification: FileModificationResult}>): Promise<void> {`
	`268`	`+ await this.updateRenderState(RenderStatus.DISPLAY_FILE_MODIFICATION, diff);`
`269`	`269`	`}`
`270`	`270`
`271`		`- displayPluginError(error: PluginError): void {`
	`271`	`+ async displayPluginError(error: PluginError): Promise<void> {`
`272`	`272`	`if (error.errorData.errorType === 'apply_validation') {`
`273`	`273`	`const resourcePlan = new ResourcePlan((error.errorData.data as any).plan);`
`274`		`- void this.updateRenderState(RenderStatus.APPLY_VALIDATION_ERROR, resourcePlan);`
	`274`	`+ await this.updateRenderState(RenderStatus.APPLY_VALIDATION_ERROR, resourcePlan);`
`275`	`275`	`return;`
`276`	`276`	`}`
`277`		`- void this.updateRenderState(RenderStatus.PLUGIN_ERROR, error.message);`
	`277`	`+ await this.updateRenderState(RenderStatus.PLUGIN_ERROR, error.message);`
`278`	`278`	`}`
`279`	`279`
`280`	`280`	`private log(log: string): void {`
`@@ -388,6 +388,14 @@ export class DefaultReporter implements Reporter {`
`388`	`388`	`return store.get(store.renderState) as { status: RenderStatus, data: any };`
`389`	`389`	`}`
`390`	`390`
	`391`	`+ /**`
	`392`	`+ * Update the render state. We need to make this async because there is currently a weird bug where if we switch the`
	`393`	`+ * layout too quickly then it can potentially crash with a memory error. We first switch to empty, wait 50ms and the`
	`394`	`+ * render the next state`
	`395`	`+ * @param status`
	`396`	`+ * @param data`
	`397`	`+ * @private`
	`398`	`+ */`
`391`	`399`	`private async updateRenderState(status: RenderStatus \| null, data?: unknown): Promise<void> {`
`392`	`400`	`const current = this.getRenderState();`
`393`	`401`	`if (current?.status !== status) {`
Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@ import { Reporter } from './reporter.js';`
`9`	`9`	`export class JsonReporter implements Reporter {`
`10`	`10`	`silent = false;`
`11`	`11`
`12`		`- displayPlan(plan: Plan): void {`
	`12`	`+ async displayPlan(plan: Plan): Promise<void> {`
`13`	`13`	`console.log(JSON.stringify(plan.resources.map((r) => r.raw), null, 2));`
`14`	`14`	`}`
`15`	`15`
`@@ -59,7 +59,7 @@ export class JsonReporter implements Reporter {`
`59`	`59`	`async displayFileModifications(): Promise<void> {`
`60`	`60`	`}`
`61`	`61`
`62`		`- displayMessage(): void {`
	`62`	`+ async displayMessage(): Promise<void> {`
`63`	`63`	`}`
`64`	`64`
`65`	`65`	`async displayImportWarning(): Promise<void> {`
`@@ -73,7 +73,7 @@ export class JsonReporter implements Reporter {`
`73`	`73`	`throw new Error('Json reporter error: disableRawMode is not supported. Raw stdin mode requires interactive terminal access.');`
`74`	`74`	`}`
`75`	`75`
`76`		`- displayPluginError(error: PluginError): void {`
	`76`	`+ async displayPluginError(error: PluginError): Promise<void> {`
`77`	`77`	`console.log(JSON.stringify({`
`78`	`78`	`errorType: error.errorData.errorType,`
`79`	`79`	`message: error.message,`
Original file line number	Diff line number	Diff line change
`@@ -70,7 +70,7 @@ export class PlainReporter implements Reporter {`
`70`	`70`	`return Number.parseInt(response as string, 10);`
`71`	`71`	`}`
`72`	`72`
`73`		`- displayFileModifications(diffs: { file: string; modification: FileModificationResult; }[]): void {`
	`73`	`+ async displayFileModifications(diffs: { file: string; modification: FileModificationResult; }[]): Promise<void> {`
`74`	`74`	`ctx.log(chalk.bold('File modifications\n'))`
`75`	`75`
`76`	`76`	`for (const diff of diffs) {`
`@@ -81,7 +81,7 @@ export class PlainReporter implements Reporter {`
`81`	`81`	`}`
`82`	`82`	`}`
`83`	`83`
`84`		`- displayMessage(message: string): void {`
	`84`	`+ async displayMessage(message: string): Promise<void> {`
`85`	`85`	`ctx.log(message);`
`86`	`86`	`}`
`87`	`87`
`@@ -128,7 +128,7 @@ export class PlainReporter implements Reporter {`
`128`	`128`	`return availableTypes;`
`129`	`129`	`}`
`130`	`130`
`131`		`- displayImportResult(importResult: ImportResult) {`
	`131`	`+ async displayImportResult(importResult: ImportResult): Promise<void> {`
`132`	`132`	`ctx.log();`
`133`	`133`	`ctx.log(JSON.stringify(importResult.result.map((r) => r.raw), null, 2));`
`134`	`134`
`@@ -159,13 +159,13 @@ Use this init flow to get started quickly with Codify.`
`159`	`159`	`return response === 'yes';`
`160`	`160`	`}`
`161`	`161`
`162`		`- displayPlan(plan: Plan): void {`
	`162`	`+ async displayPlan(plan: Plan): Promise<void> {`
`163`	`163`	`ctx.log(`
`164`	`164`	`prettyFormatPlan(plan.filterNoopResources())`
`165`	`165`	`);`
`166`	`166`	`}`
`167`	`167`
`168`		`- displayPluginError(error: PluginError): void {`
	`168`	`+ async displayPluginError(error: PluginError): Promise<void> {`
`169`	`169`	`if (error.errorData.errorType === 'apply_validation') {`
`170`	`170`	`ctx.log(chalk.red(formatApplyValidationError(error)));`
`171`	`171`	`return;`