feat(cli): allow skipping synth

packages/@cdktf/cli-core/src/lib/cdktf-project.ts

@@ -70,20 +70,29 @@ export type MultipleStackOptions = {
  stackNames?: string[];
 };
 
+export type SkipSynthOptions = {
+ skipSynth?: boolean;
+};
+
+export type FetchOutputOptions = SkipSynthOptions & MultipleStackOptions;
+
 export type AutoApproveOptions = {
  autoApprove?: boolean;
 };
 
-export type DiffOptions = SingleStackOptions & {
- refreshOnly?: boolean;
- terraformParallelism?: number;
- vars?: string[];
- varFiles?: string[];
- noColor?: boolean;
- migrateState?: boolean;
-};
+export type DiffOptions = SingleStackOptions &
+ SkipSynthOptions & {
+ refreshOnly?: boolean;
+ terraformParallelism?: number;
+ vars?: string[];
+ varFiles?: string[];
+ noColor?: boolean;
+ migrateState?: boolean;
+ skipSynth?: boolean;
+ };
 
 export type MutationOptions = MultipleStackOptions &
+ SkipSynthOptions &
  AutoApproveOptions & {
  refreshOnly?: boolean;
  ignoreMissingStackDependencies?: boolean;
@@ -362,8 +371,22 @@ export class CdktfProject {
  return stacks;
  }
 
+ public async readSynthesizedStacks() {
+ const stacks = await SynthStack.readSynthesizedStacks(this.outDir);
+
+ printAnnotations(stacks);
+
+ this.onUpdate({
+ type: "synthesized",
+ stacks,
+ });
+ return stacks;
+ }
+
  public async diff(opts: DiffOptions = {}) {
- const stacks = await this.synth();
+ const stacks = opts.skipSynth
+ ? await this.readSynthesizedStacks()
+ : await this.synth();
  const stack = this.getStackExecutor(
  getSingleStack(stacks, opts?.stackName, "diff")
  );
@@ -459,7 +482,9 @@ export class CdktfProject {
  }
 
  public async deploy(opts: MutationOptions = {}) {
- const stacks = await this.synth();
+ const stacks = opts.skipSynth
+ ? await this.readSynthesizedStacks()
+ : await this.synth();
  const stacksToRun = getMultipleStacks(stacks, opts.stackNames, "deploy");
  if (!opts.ignoreMissingStackDependencies) {
  checkIfAllDependenciesAreIncluded(stacksToRun);
@@ -515,7 +540,9 @@ export class CdktfProject {
  }
 
  public async destroy(opts: MutationOptions = {}) {
- const stacks = await this.synth();
+ const stacks = opts.skipSynth
+ ? await this.readSynthesizedStacks()
+ : await this.synth();
  const stacksToRun = getMultipleStacks(stacks, opts.stackNames, "destroy");
 
  if (!opts.ignoreMissingStackDependencies) {
@@ -597,8 +624,10 @@ export class CdktfProject {
  });
  }
 
- public async fetchOutputs(opts: MultipleStackOptions) {
- const stacks = await this.synth();
+ public async fetchOutputs(opts: FetchOutputOptions) {
+ const stacks = opts.skipSynth
+ ? await this.readSynthesizedStacks()
+ : await this.synth();
 
  const stacksToRun = getMultipleStacks(
  stacks,

packages/@cdktf/cli-core/src/lib/synth-stack.ts

@@ -153,21 +153,52 @@ Command output on stdout:
  process.exit(1);
  }
 
- if (!(await fs.pathExists(path.join(outdir, Manifest.fileName)))) {
- const errorMessage = `ERROR: synthesis failed, because app was expected to call 'synth()', but didn't. Thus "${outdir}/${Manifest.fileName}" was not created.`;
+ // end performance timer
+ const endTime = performance.now();
+
+ let stacks: SynthesizedStack[] = [];
+ try {
+ stacks = await SynthStack.readSynthesizedStacks(outdir);
+ } catch (e: any) {
+ const errorMessage = `ERROR: synthesis failed, because app was expected to call 'synth()', but didn't. Thus "${outdir}/${Manifest.fileName}" was not created: ${e}`;
  if (graceful) {
  throw new Error(errorMessage);
  }
  logger.error(errorMessage);
  process.exit(1);
  }
 
- // end performance timer
- const endTime = performance.now();
+ await this.synthTelemetry(endTime - startTime, stacks, synthOrigin);
+
+ if (stacks.length === 0) {
+ logger.error("ERROR: No Terraform code synthesized.");
+ }
+
+ const stackNames = stacks.map((s) => s.name);
+ const orphanedDirectories = existingDirectories.filter(
+ (e) => !stackNames.includes(path.basename(e))
+ );
+
+ for (const orphanedDirectory of orphanedDirectories) {
+ fs.rmSync(orphanedDirectory, { recursive: true });
+ }
+
+ return stacks;
+ }
+
+ public static async readSynthesizedStacks(
+ outdir: string
+ ): Promise<SynthesizedStack[]> {
+ const manifestPath = path.join(outdir, Manifest.fileName);
+ if (!(await fs.pathExists(manifestPath))) {
+ throw new Error(
+ `Could not find manifest file at ${manifestPath}. In case --skip-synth was passed, please try again without the flag.`
+ );
+ }
 
  const stacks: SynthesizedStack[] = [];
  const manifest = JSON.parse(
- fs.readFileSync(path.join(outdir, Manifest.fileName)).toString()
+ fs.readFileSync(manifestPath).toString()
  ) as ManifestJson;
 
  for (const stackName in manifest.stacks) {
@@ -183,21 +214,6 @@ Command output on stdout:
  });
  }
 
- await this.synthTelemetry(endTime - startTime, stacks, synthOrigin);
-
- if (stacks.length === 0) {
- logger.error("ERROR: No Terraform code synthesized.");
- }
-
- const stackNames = stacks.map((s) => s.name);
- const orphanedDirectories = existingDirectories.filter(
- (e) => !stackNames.includes(path.basename(e))
- );
-
- for (const orphanedDirectory of orphanedDirectories) {
- fs.rmSync(orphanedDirectory, { recursive: true });
- }
-
  return stacks;
  }
 

packages/cdktf-cli/src/bin/cmds/deploy.ts

@@ -102,6 +102,12 @@ class Command extends BaseCommand {
  required: false,
  desc: "Load variable values from the given file, in addition to the default files terraform.tfvars and *.auto.tfvars. Use this option more than once to include more than one variables file.",
  })
+ .option("skip-synth", {
+ type: "boolean",
+ default: false,
+ required: false,
+ desc: "Skip synthesis of the application, assume the synthesized Terraform code is already present and up to date",
+ })
  .showHelpOnFail(true);
 
  public async handleCommand(argv: any) {

packages/cdktf-cli/src/bin/cmds/destroy.ts

@@ -79,6 +79,12 @@ class Command extends BaseCommand {
  required: false,
  desc: "Pass this flag after switching state backends to approve a state migration for all targeted stacks",
  })
+ .option("skip-synth", {
+ type: "boolean",
+ default: false,
+ required: false,
+ desc: "Skip synthesis of the application, assume the synthesized Terraform code is already present and up to date",
+ })
  .showHelpOnFail(true);
 
  public async handleCommand(argv: any) {

packages/cdktf-cli/src/bin/cmds/diff.ts

@@ -71,6 +71,12 @@ class Command extends BaseCommand {
  required: false,
  desc: "Pass this flag after switching state backends to approve a state migration for the targeted stack",
  })
+ .option("skip-synth", {
+ type: "boolean",
+ default: false,
+ required: false,
+ desc: "Skip synthesis of the application, assume the synthesized Terraform code is already present and up to date",
+ })
  .showHelpOnFail(true);
 
  public async handleCommand(argv: any) {

packages/cdktf-cli/src/bin/cmds/handlers.ts

@@ -137,6 +137,7 @@ export async function deploy(argv: any) {
  const varFiles = sanitizeVarFiles(argv.varFile);
  const noColor = argv.noColor;
  const migrateState = argv.migrateState;
+ const skipSynth = argv.skipSynth;
 
  let outputsPath: string | undefined = undefined;
  // eslint-disable-next-line @typescript-eslint/no-empty-function
@@ -163,6 +164,7 @@ export async function deploy(argv: any) {
  varFiles,
  noColor,
  migrateState,
+ skipSynth,
  })
  );
 }
@@ -184,6 +186,7 @@ export async function destroy(argv: any) {
  const varFiles = sanitizeVarFiles(argv.varFile);
  const noColor = argv.noColor;
  const migrateState = argv.migrateState;
+ const skipSynth = argv.skipSynth;
 
  await renderInk(
  React.createElement(Destroy, {
@@ -198,6 +201,7 @@ export async function destroy(argv: any) {
  varFiles,
  noColor,
  migrateState,
+ skipSynth,
  })
  );
 }
@@ -216,6 +220,7 @@ export async function diff(argv: any) {
  const varFiles = sanitizeVarFiles(argv.varFile);
  const noColor = argv.noColor;
  const migrateState = argv.migrateState;
+ const skipSynth = argv.skipSynth;
 
  await renderInk(
  React.createElement(Diff, {
@@ -228,6 +233,7 @@ export async function diff(argv: any) {
  varFiles,
  noColor,
  migrateState,
+ skipSynth,
  })
  );
 }
@@ -437,6 +443,7 @@ export async function output(argv: any) {
  const outDir = argv.output;
  const stacks = argv.stacks;
  const includeSensitiveOutputs = argv.outputsFileIncludeSensitiveOutputs;
+ const skipSynth = argv.skipSynth;
  let outputsPath: string | undefined = undefined;
  // eslint-disable-next-line @typescript-eslint/no-empty-function
  let onOutputsRetrieved: (outputs: NestedTerraformOutputs) => void = () => {};
@@ -454,6 +461,7 @@ export async function output(argv: any) {
  synthCommand: command,
  onOutputsRetrieved,
  outputsPath,
+ skipSynth,
  })
  );
 }

packages/cdktf-cli/src/bin/cmds/output.ts

@@ -42,6 +42,12 @@ class Command extends BaseCommand {
  desc: "Whether to include sensitive outputs in the output file",
  default: false,
  })
+ .option("skip-synth", {
+ type: "boolean",
+ default: false,
+ required: false,
+ desc: "Skip synthesis of the application, assume the synthesized Terraform code is already present and up to date",
+ })
  .showHelpOnFail(true);
 
  public async handleCommand(argv: any) {

packages/cdktf-cli/src/bin/cmds/ui/deploy.tsx

@@ -66,6 +66,7 @@ interface DeployConfig {
  varFiles?: string[];
  noColor?: boolean;
  migrateState?: boolean;
+ skipSynth?: boolean;
 }
 
 export const Deploy = ({
@@ -83,6 +84,7 @@ export const Deploy = ({
  varFiles,
  noColor,
  migrateState,
+ skipSynth,
 }: DeployConfig): React.ReactElement => {
  const [outputs, setOutputs] = useState<NestedTerraformOutputs>();
  const { status, logEntries } = useCdktfProject(
@@ -99,6 +101,7 @@ export const Deploy = ({
  varFiles,
  noColor,
  migrateState,
+ skipSynth,
  });
 
  if (onOutputsRetrieved) {

packages/cdktf-cli/src/bin/cmds/ui/destroy.tsx

@@ -26,6 +26,7 @@ interface DestroyConfig {
  migrateState?: boolean;
  vars?: string[];
  varFiles?: string[];
+ skipSynth?: boolean;
 }
 
 export const Destroy = ({
@@ -40,6 +41,7 @@ export const Destroy = ({
  migrateState,
  vars,
  varFiles,
+ skipSynth,
 }: DestroyConfig): React.ReactElement => {
  const { status, logEntries } = useCdktfProject(
  { outDir, synthCommand },
@@ -54,6 +56,7 @@ export const Destroy = ({
  migrateState,
  vars,
  varFiles,
+ skipSynth,
  })
  );
 

packages/cdktf-cli/src/bin/cmds/ui/diff.tsx

@@ -18,6 +18,7 @@ interface DiffConfig {
  varFiles?: string[];
  noColor?: boolean;
  migrateState?: boolean;
+ skipSynth?: boolean;
 }
 
 export const Diff = ({
@@ -30,6 +31,7 @@ export const Diff = ({
  varFiles,
  noColor,
  migrateState,
+ skipSynth,
 }: DiffConfig): React.ReactElement => {
  const { status, logEntries } = useCdktfProject(
  { outDir, synthCommand },
@@ -42,6 +44,7 @@ export const Diff = ({
  varFiles,
  noColor,
  migrateState,
+ skipSynth,
  })
  );
 

packages/cdktf-cli/src/bin/cmds/ui/output.tsx

@@ -15,6 +15,7 @@ type OutputConfig = {
  synthCommand: string;
  onOutputsRetrieved: (outputs: NestedTerraformOutputs) => void;
  outputsPath?: string;
+ skipSynth?: boolean;
 };
 
 export const Output = ({
@@ -23,11 +24,15 @@ export const Output = ({
  synthCommand,
  onOutputsRetrieved,
  outputsPath,
+ skipSynth,
 }: OutputConfig): React.ReactElement => {
  const { status, logEntries, returnValue } = useCdktfProject(
  { outDir, synthCommand },
  async (project) => {
- const outputs = await project.fetchOutputs({ stackNames: targetStacks });
+ const outputs = await project.fetchOutputs({
+ stackNames: targetStacks,
+ skipSynth,
+ });
  onOutputsRetrieved(outputs);
  return outputs;
  }