feat: Added apply notes system

Author: kevinwang5658

package-lock.json

@@ -5,7 +5,7 @@
   },
   "dependencies": {
     "@codifycli/ink-form": "0.0.12",
-    "@codifycli/schemas": "1.1.0-beta8",
+    "@codifycli/schemas": "1.1.0-beta.9",
     "@homebridge/node-pty-prebuilt-multiarch": "^0.13.1",
     "@mischnic/json-sourcemap": "^0.1.1",
     "@oclif/core": "^4.0.8",
@@ -43,7 +43,7 @@
   },
   "description": "Codify is a configuration-as-code tool that declaratively installs and manages developer tools and applications. Check out https://dashboard.codifycli.com for an editor.",
   "devDependencies": {
-    "@codifycli/plugin-core": "^1.1.0-beta19",
+    "@codifycli/plugin-core": "^1.1.0-beta.25",
     "@oclif/prettier-config": "^0.2.1",
     "@types/chalk": "^2.2.0",
     "@types/cors": "^2.8.19",

package.json

@@ -0,0 +1,4 @@
+export interface ApplyNote {
+  message: string;
+  resourceType: string;
+}

src/entities/apply-note.ts

@@ -1,6 +1,7 @@
 import { ResourceOperation } from '@codifycli/schemas';
 
 import { PluginError } from '../common/errors.js';
+import { ApplyNote } from './apply-note.js';
 import { ResourcePlan } from './plan.js';
 
 export interface ApplyResultEntry {
@@ -13,6 +14,7 @@ export interface ApplyResultEntry {
 export interface ApplyResult {
   entries: ApplyResultEntry[];
   errors: PluginError[];
+  notes: ApplyNote[];
 
   isPartialFailure(): boolean;
 }
@@ -21,9 +23,8 @@ export function createApplyResult(
   succeededPlans: ResourcePlan[],
   failedErrors: PluginError[],
   skippedIds: Set<string>,
+  notes: ApplyNote[] = [],
 ): ApplyResult {
-  const failedByType = new Map(failedErrors.map((e) => [e.resourceType, e]));
-
   const entries: ApplyResultEntry[] = [
     ...succeededPlans.map((p) => ({
       id: p.id,
@@ -46,6 +47,7 @@ export function createApplyResult(
   return {
     entries,
     errors: failedErrors,
+    notes,
     isPartialFailure() {
       return failedErrors.length > 0;
     },

src/entities/apply-result.ts

@@ -1,4 +1,4 @@
-import { CommandRequestData, CommandRequestResponseData } from '@codifycli/schemas';
+import { ApplyNoteRequestData, CommandRequestData, CommandRequestResponseData } from '@codifycli/schemas';
 import { EventEmitter } from 'node:events';
 
 export enum Event {
@@ -18,6 +18,7 @@ export enum Event {
   PRESS_KEY_TO_CONTINUE_COMPLETED = 'press_key_to_continue_completed',
   CODIFY_LOGIN_CREDENTIALS_REQUEST = 'codify_login_credentials_request',
   CODIFY_LOGIN_CREDENTIALS_COMPLETED = 'codify_login_credentials_completed',
+  APPLY_NOTE_REQUEST = 'apply_note_request',
 }
 
 export enum ProcessName {
@@ -141,6 +142,10 @@ export const ctx = new class {
     this.emitter.emit(Event.CODIFY_LOGIN_CREDENTIALS_COMPLETED, pluginName, credentials);
   }
 
+  applyNoteRequested(pluginName: string, data: ApplyNoteRequestData) {
+    this.emitter.emit(Event.APPLY_NOTE_REQUEST, pluginName, data);
+  }
+
   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,17 +1,19 @@
 import {
+  ApplyNoteRequestData,
   ImportResponseData, ResourceDefinition,
   ResourceJson,
   ValidateResponseData,
 } from '@codifycli/schemas';
 
 import { InternalError, PluginError } from '../common/errors.js';
 import { config } from '../config.js';
+import { ApplyNote } from '../entities/apply-note.js';
 import { ApplyResult, createApplyResult } from '../entities/apply-result.js';
 import { Plan, ResourcePlan } from '../entities/plan.js';
 import { Project } from '../entities/project.js';
 import { ResourceConfig } from '../entities/resource-config.js';
 import { ResourceInfo } from '../entities/resource-info.js';
-import { SubProcessName, SubprocessFinishStatus, ctx } from '../events/context.js';
+import { Event, SubProcessName, SubprocessFinishStatus, ctx } from '../events/context.js';
 import { groupBy } from '../utils/index.js';
 import { registerKillListeners } from '../utils/register-kill-listeners.js';
 import { Plugin } from './plugin.js';
@@ -142,6 +144,12 @@ export class PluginManager {
     const collectedErrors: PluginError[] = [];
     const skippedIds = new Set<string>();
     const succeededPlans: ResourcePlan[] = [];
+    const collectedNotes: ApplyNote[] = [];
+
+    const noteListener = (_pluginName: string, data: ApplyNoteRequestData) => {
+      collectedNotes.push({ message: data.message, resourceType: data.resourceType });
+    };
+    ctx.on(Event.APPLY_NOTE_REQUEST, noteListener);
 
     for (const id of project.evaluationOrder ?? []) {
       if (skippedIds.has(id)) {
@@ -179,7 +187,8 @@ export class PluginManager {
       }
     }
 
-    return createApplyResult(succeededPlans, collectedErrors, skippedIds);
+    ctx.emitter.removeListener(Event.APPLY_NOTE_REQUEST, noteListener);
+    return createApplyResult(succeededPlans, collectedErrors, skippedIds, collectedNotes);
   }
 
   async setVerbosityLevel(verbosityLevel: number): Promise<void> {

src/plugins/plugin-manager.ts

@@ -1,4 +1,6 @@
 import {
+  ApplyNoteRequestData,
+  ApplyNoteRequestDataSchema,
   CommandRequestData,
   CommandRequestDataSchema,
   CommandRequestResponseData,
@@ -19,6 +21,7 @@ import { PluginMessage } from './plugin-message.js';
 export const ipcMessageValidator = ajv.compile(IpcMessageV2Schema);
 export const commandRequestValidator = ajv.compile(CommandRequestDataSchema);
 export const pressKeyToContinueRequestValidator = ajv.compile(PressKeyToContinueRequestDataSchema);
+export const applyNoteRequestValidator = ajv.compile(ApplyNoteRequestDataSchema);
 
 const DEFAULT_NODE_MODULES_DIR = '/usr/local/lib/codify/node_modules/'
 
@@ -122,6 +125,21 @@ export class PluginProcess {
       }
 
 
+      if (message.cmd === MessageCmd.APPLY_NOTE_REQUEST) {
+        const { data, requestId } = message;
+        if (!applyNoteRequestValidator(data)) {
+          throw new Error(`Invalid apply note request from plugin ${pluginName}. ${JSON.stringify(applyNoteRequestValidator.errors, null, 2)}`);
+        }
+
+        process.send({
+          cmd: returnMessageCmd(MessageCmd.APPLY_NOTE_REQUEST),
+          requestId,
+          data: {},
+        });
+
+        return ctx.applyNoteRequested(pluginName, data as unknown as ApplyNoteRequestData);
+      }
+
       if (message.cmd === MessageCmd.CODIFY_CREDENTIALS_REQUEST) {
         if (pluginName !== 'default') {
           throw new Error(`Only the default Codify plugin is able to request Codify credentials. ${pluginName}`);

src/plugins/plugin-process.ts

@@ -93,6 +93,18 @@ export function ApplyComplete({ result }: { result: ApplyResult }) {
         </Box>
       )}
 
+      {result.notes.length > 0 && (
+        <Box flexDirection="column" marginTop={1}>
+          {groupNotesByMessage(result.notes).map(({ message, resourceTypes }) => (
+            <Box key={message}>
+              <Text color="yellow" bold>{'⚠ '}</Text>
+              <Text bold>{resourceTypes.join(', ')}: </Text>
+              <Text>{message}</Text>
+            </Box>
+          ))}
+        </Box>
+      )}
+
       {!isPartial && (
         <Box marginTop={1}>
           <Text dimColor>Open a new terminal or source &apos;{path.basename(ShellUtils.getPrimaryShellRc())}&apos; for the new changes to be reflected</Text>
@@ -102,3 +114,18 @@ export function ApplyComplete({ result }: { result: ApplyResult }) {
     </Box>
   );
 }
+
+function groupNotesByMessage(notes: ApplyResult['notes']): { message: string; resourceTypes: string[] }[] {
+  const map = new Map<string, string[]>();
+  for (const note of notes) {
+    const existing = map.get(note.message);
+    if (existing) {
+      if (!existing.includes(note.resourceType)) {
+        existing.push(note.resourceType);
+      }
+    } else {
+      map.set(note.message, [note.resourceType]);
+    }
+  }
+  return [...map.entries()].map(([message, resourceTypes]) => ({ message, resourceTypes }));
+}

src/ui/components/widgets/ApplyComplete.tsx

@@ -99,6 +99,7 @@ export class JsonReporter implements Reporter {
         resourceType: error.resourceType,
         data: error.errorData.data,
       })),
+      notes: result.notes,
     }, null, 2));
   }
 }

src/ui/reporters/json-reporter.ts

@@ -200,5 +200,28 @@ Use this init flow to get started quickly with Codify.
       ctx.log('');
       ctx.log('Open a new terminal or source \'.zshrc\' for the new changes to be reflected');
     }
+
+    if (result.notes.length > 0) {
+      ctx.log('');
+      const grouped = groupNotesByMessage(result.notes);
+      for (const { message, resourceTypes } of grouped) {
+        ctx.log(chalk.yellow(`⚠ ${resourceTypes.join(', ')}: ${message}`));
+      }
+    }
+  }
+}
+
+function groupNotesByMessage(notes: ApplyResult['notes']): { message: string; resourceTypes: string[] }[] {
+  const map = new Map<string, string[]>();
+  for (const note of notes) {
+    const existing = map.get(note.message);
+    if (existing) {
+      if (!existing.includes(note.resourceType)) {
+        existing.push(note.resourceType);
+      }
+    } else {
+      map.set(note.message, [note.resourceType]);
+    }
   }
+  return [...map.entries()].map(([message, resourceTypes]) => ({ message, resourceTypes }));
 }