Skip to content

Commit fe48cb1

Browse files
kevinwang5658kevinwang5658
committed
feat: Added partial applys. If a resource fails to apply, skip it and all transitive dependent resources. Apply un-related resources.
1 parent 6d34213 commit fe48cb1

11 files changed

Lines changed: 118 additions & 32 deletions

File tree

‎src/common/base-command.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,7 @@ export abstract class BaseCommand extends Command {
147147
protected async catch(err: Error): Promise<void> {
148148
if (err instanceof PluginError && this.reporter) {
149149
await this.reporter.hide();
150-
await this.reporter.displayPluginError(err);
150+
await this.reporter.displayPluginError([err]);
151151
process.exit(1);
152152
}
153153

‎src/common/errors.ts‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -250,6 +250,20 @@ export class PluginError extends CodifyError {
250250
}
251251
}
252252

253+
export class ApplyPartialFailureError extends CodifyError {
254+
name = 'ApplyPartialFailureError';
255+
errors: PluginError[];
256+
257+
constructor(errors: PluginError[]) {
258+
super(`Apply failed with ${errors.length} error(s)`);
259+
this.errors = errors;
260+
}
261+
262+
formattedMessage(): string {
263+
return this.message;
264+
}
265+
}
266+
253267
export function prettyPrintError(error: unknown): void {
254268
if (error instanceof CodifyError) {
255269
return console.error(chalk.red(error.formattedMessage()));

‎src/entities/plan.ts‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,30 @@ export class Plan {
5454
return this.raw.every((r) => r.operation === ResourceOperation.NOOP);
5555
}
5656

57+
computeTransitiveDependents(failedId: string): Set<string> {
58+
const reverseDeps = new Map<string, Set<string>>();
59+
for (const r of this.project.resourceConfigs) {
60+
for (const depId of r.dependencyIds) {
61+
if (!reverseDeps.has(depId)) reverseDeps.set(depId, new Set());
62+
reverseDeps.get(depId)!.add(r.id);
63+
}
64+
}
65+
66+
const toSkip = new Set<string>();
67+
const queue = [failedId];
68+
while (queue.length > 0) {
69+
const current = queue.shift()!;
70+
const dependents = reverseDeps.get(current) ?? new Set();
71+
for (const dep of dependents) {
72+
if (!toSkip.has(dep)) {
73+
toSkip.add(dep);
74+
queue.push(dep);
75+
}
76+
}
77+
}
78+
return toSkip;
79+
}
80+
5781
*[Symbol.iterator](): Iterator<ResourcePlan> {
5882
for (const resource of this.resources) {
5983
yield resource;

‎src/orchestrators/apply.ts‎

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
import { ApplyPartialFailureError } from '../common/errors.js';
12
import { ProcessName, ctx } from '../events/context.js';
23
import { DefaultReporter } from '../ui/reporters/default-reporter.js';
34
import { Reporter } from '../ui/reporters/reporter.js';
@@ -44,7 +45,19 @@ export const ApplyOrchestrator = {
4445
if (!args.noProgress) ctx.processStarted(ProcessName.APPLY);
4546
if (!args.noProgress) await reporter.displayProgress();
4647

47-
await pluginManager.apply(project, filteredPlan);
48+
try {
49+
await pluginManager.apply(project, filteredPlan);
50+
} catch (err) {
51+
if (err instanceof ApplyPartialFailureError) {
52+
if (!args.noProgress) ctx.processFinished(ProcessName.APPLY);
53+
await sleep(100);
54+
await reporter.hide();
55+
await reporter.displayPluginError(err.errors);
56+
return process.exit(1);
57+
}
58+
throw err;
59+
}
60+
4861
if (!args.noProgress) ctx.processFinished(ProcessName.APPLY);
4962

5063
// Need to sleep to wait for the message to display before we exit

‎src/plugins/plugin-manager.ts‎

Lines changed: 25 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ import {
44
ValidateResponseData,
55
} from '@codifycli/schemas';
66

7-
import { InternalError } from '../common/errors.js';
7+
import { ApplyPartialFailureError, InternalError, PluginError } from '../common/errors.js';
88
import { config } from '../config.js';
99
import { Plan, ResourcePlan } from '../entities/plan.js';
1010
import { Project } from '../entities/project.js';
@@ -138,7 +138,16 @@ export class PluginManager {
138138
}
139139

140140
async apply(project: Project, plan: Plan): Promise<void> {
141+
const collectedErrors: PluginError[] = [];
142+
const skippedIds = new Set<string>();
143+
141144
for (const id of project.evaluationOrder ?? []) {
145+
if (skippedIds.has(id)) {
146+
ctx.subprocessStarted(SubProcessName.APPLYING_RESOURCE, id);
147+
ctx.subprocessFinished(SubProcessName.APPLYING_RESOURCE, id);
148+
continue;
149+
}
150+
142151
ctx.subprocessStarted(SubProcessName.APPLYING_RESOURCE, id);
143152

144153
const resourcePlan = plan.getResourcePlan(id);
@@ -152,10 +161,24 @@ export class PluginManager {
152161
throw new InternalError(`Unable to determine plugin for apply: ${resourceType}`);
153162
}
154163

155-
await this.plugins.get(pluginName)!.apply(resourcePlan);
164+
try {
165+
await this.plugins.get(pluginName)!.apply(resourcePlan);
166+
} catch (err) {
167+
if (err instanceof PluginError) {
168+
collectedErrors.push(err);
169+
const dependents = plan.computeTransitiveDependents(id);
170+
for (const depId of dependents) skippedIds.add(depId);
171+
} else {
172+
throw err;
173+
}
174+
}
156175

157176
ctx.subprocessFinished(SubProcessName.APPLYING_RESOURCE, resourcePlan.id);
158177
}
178+
179+
if (collectedErrors.length > 0) {
180+
throw new ApplyPartialFailureError(collectedErrors);
181+
}
159182
}
160183

161184
async setVerbosityLevel(verbosityLevel: number): Promise<void> {

‎src/ui/components/default-component.tsx‎

Lines changed: 17 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -52,32 +52,37 @@ export function DefaultComponent(props: {
5252
}
5353
{
5454
renderStatus === RenderStatus.APPLY_VALIDATION_ERROR && (
55-
<Static items={[renderData as ResourcePlan]}>{
56-
(resourcePlan, idx) => (
55+
<Static items={[renderData as ResourcePlan[]]}>{
56+
(resourcePlans, idx) => (
5757
<Box key={idx} flexDirection="column" marginTop={1}>
58-
<Text color="red" bold>
59-
{`Apply failed: resource "${resourcePlan.id}" did not reach its desired state. \nExiting...`}
60-
</Text>
61-
<Text> </Text>
62-
<Text bold backgroundColor={'red'}>Changes still needed:</Text>
63-
<Text>{prettyFormatResourcePlan(resourcePlan)}</Text>
58+
{resourcePlans.map((resourcePlan) => (
59+
<Box key={resourcePlan.id} flexDirection="column">
60+
<Text color="red" bold>
61+
{`Apply failed: resource "${resourcePlan.id}" did not reach its desired state.`}
62+
</Text>
63+
<Text> </Text>
64+
<Text bold backgroundColor={'red'}>Changes still needed:</Text>
65+
<Text>{prettyFormatResourcePlan(resourcePlan)}</Text>
66+
<Text> </Text>
67+
</Box>
68+
))}
69+
<Text color="red" bold>Exiting...</Text>
6470
<Text> </Text>
6571
<Text color="red" bold>Potential fixes:</Text>
6672
<Text color="red" bold>{' 1. Re-run the command again'}</Text>
6773
<Text color="red" bold>{' 2. Manually install the resource and retry'}</Text>
6874
<Text color="red" bold>{' 3. Reach out to support at https://github.com/codifycli/default-plugin/issues'}</Text>
69-
7075
</Box>
7176
)
7277
}</Static>
7378
)
7479
}
7580
{
7681
renderStatus === RenderStatus.PLUGIN_ERROR && (
77-
<Static items={[renderData as string]}>{
78-
(message, idx) => (
82+
<Static items={[renderData as string[]]}>{
83+
(messages, idx) => (
7984
<Box key={idx} flexDirection="column" marginTop={1}>
80-
<Text color="red">{message}</Text>
85+
{messages.map((msg, i) => <Text key={i} color="red">{msg}</Text>)}
8186
</Box>
8287
)
8388
}</Static>

‎src/ui/reporters/default-reporter.tsx‎

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -268,13 +268,17 @@ export class DefaultReporter implements Reporter {
268268
await this.updateRenderState(RenderStatus.DISPLAY_FILE_MODIFICATION, diff);
269269
}
270270

271-
async displayPluginError(error: PluginError): Promise<void> {
272-
if (error.errorData.errorType === 'apply_validation') {
273-
const resourcePlan = new ResourcePlan((error.errorData.data as any).plan);
274-
await this.updateRenderState(RenderStatus.APPLY_VALIDATION_ERROR, resourcePlan);
275-
return;
271+
async displayPluginError(errors: PluginError[]): Promise<void> {
272+
const validationErrors = errors.filter((e) => e.errorData.errorType === 'apply_validation');
273+
const genericErrors = errors.filter((e) => e.errorData.errorType !== 'apply_validation');
274+
275+
if (validationErrors.length > 0) {
276+
const resourcePlans = validationErrors.map((e) => new ResourcePlan((e.errorData.data as any).plan));
277+
await this.updateRenderState(RenderStatus.APPLY_VALIDATION_ERROR, resourcePlans);
278+
}
279+
if (genericErrors.length > 0) {
280+
await this.updateRenderState(RenderStatus.PLUGIN_ERROR, genericErrors.map((e) => e.message));
276281
}
277-
await this.updateRenderState(RenderStatus.PLUGIN_ERROR, error.message);
278282
}
279283

280284
private log(log: string): void {

‎src/ui/reporters/json-reporter.ts‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -73,13 +73,13 @@ export class JsonReporter implements Reporter {
7373
throw new Error('Json reporter error: disableRawMode is not supported. Raw stdin mode requires interactive terminal access.');
7474
}
7575

76-
async displayPluginError(error: PluginError): Promise<void> {
77-
console.log(JSON.stringify({
76+
async displayPluginError(errors: PluginError[]): Promise<void> {
77+
console.log(JSON.stringify(errors.map((error) => ({
7878
errorType: error.errorData.errorType,
7979
message: error.message,
8080
pluginName: error.pluginName,
8181
resourceType: error.resourceType,
8282
data: error.errorData.data,
83-
}, null, 2));
83+
})), null, 2));
8484
}
8585
}

‎src/ui/reporters/plain-reporter.ts‎

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -165,12 +165,14 @@ Use this init flow to get started quickly with Codify.
165165
);
166166
}
167167

168-
async displayPluginError(error: PluginError): Promise<void> {
169-
if (error.errorData.errorType === 'apply_validation') {
170-
ctx.log(chalk.red(formatApplyValidationError(error)));
171-
return;
168+
async displayPluginError(errors: PluginError[]): Promise<void> {
169+
for (const error of errors) {
170+
if (error.errorData.errorType === 'apply_validation') {
171+
ctx.log(chalk.red(formatApplyValidationError(error)));
172+
} else {
173+
ctx.log(chalk.red(error.message));
174+
}
172175
}
173-
ctx.log(chalk.red(error.message));
174176
}
175177

176178
displayApplyComplete(message: string[]): void {

‎src/ui/reporters/reporter.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ export interface Reporter {
8585

8686
disableRawMode(): Promise<void>
8787

88-
displayPluginError(error: PluginError): Promise<void>;
88+
displayPluginError(errors: PluginError[]): Promise<void>;
8989
}
9090

9191
export enum ReporterType {

0 commit comments

Comments
 (0)