feat: report feature flags into Cloud Assembly (#34884)

rix0rrr · web-flow · commit f70e46cf87f2 · 2025-07-02T18:03:35.000Z
This is a re-roll of #34798 which had to be reverted. It includes a new version of the Cloud Assembly Schema to make sure users don't get the "failed to validate Assembly Manifest" error, but instead get the "you need to update your CLI" error. ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
diff --git a/packages/@aws-cdk-testing/framework-integ/package.json b/packages/@aws-cdk-testing/framework-integ/package.json
@@ -30,7 +30,7 @@
   "license": "Apache-2.0",
   "devDependencies": {
     "@aws-cdk/cdk-build-tools": "0.0.0",
-    "@aws-cdk/integ-runner": "^2.188.0",
+    "@aws-cdk/integ-runner": "^2.188.2",
     "@aws-cdk/pkglint": "0.0.0",
     "@aws-sdk/client-acm": "3.632.0",
     "@aws-sdk/client-rds": "3.632.0",
diff --git a/packages/@aws-cdk/app-staging-synthesizer-alpha/package.json b/packages/@aws-cdk/app-staging-synthesizer-alpha/package.json
@@ -89,7 +89,7 @@
   },
   "devDependencies": {
     "aws-cdk-lib": "0.0.0",
-    "@aws-cdk/integ-runner": "^2.188.0",
+    "@aws-cdk/integ-runner": "^2.188.2",
     "@aws-cdk/integ-tests-alpha": "0.0.0",
     "constructs": "^10.0.0",
     "@aws-cdk/cdk-build-tools": "0.0.0",
diff --git a/packages/@aws-cdk/aws-amplify-alpha/package.json b/packages/@aws-cdk/aws-amplify-alpha/package.json
@@ -87,7 +87,7 @@
   "license": "Apache-2.0",
   "devDependencies": {
     "@aws-cdk/cdk-build-tools": "0.0.0",
-    "@aws-cdk/integ-runner": "^2.188.0",
+    "@aws-cdk/integ-runner": "^2.188.2",
     "@aws-cdk/pkglint": "0.0.0",
     "@aws-cdk/custom-resource-handlers": "0.0.0",
     "@aws-sdk/client-amplify": "3.632.0",
diff --git a/packages/@aws-cdk/aws-applicationsignals-alpha/package.json b/packages/@aws-cdk/aws-applicationsignals-alpha/package.json
@@ -84,7 +84,7 @@
   "license": "Apache-2.0",
   "devDependencies": {
     "@aws-cdk/cdk-build-tools": "0.0.0",
-    "@aws-cdk/integ-runner": "^2.188.0",
+    "@aws-cdk/integ-runner": "^2.188.2",
     "@aws-cdk/integ-tests-alpha": "0.0.0",
     "@aws-cdk/pkglint": "0.0.0",
     "@types/jest": "^29.5.14",
diff --git a/packages/@aws-cdk/aws-apprunner-alpha/package.json b/packages/@aws-cdk/aws-apprunner-alpha/package.json
@@ -86,7 +86,7 @@
   "devDependencies": {
     "@aws-cdk/cdk-build-tools": "0.0.0",
     "aws-cdk-lib": "0.0.0",
-    "@aws-cdk/integ-runner": "^2.188.0",
+    "@aws-cdk/integ-runner": "^2.188.2",
     "@aws-cdk/pkglint": "0.0.0",
     "@types/jest": "^29.5.14",
     "constructs": "^10.0.0",
diff --git a/packages/@aws-cdk/aws-bedrock-alpha/package.json b/packages/@aws-cdk/aws-bedrock-alpha/package.json
@@ -78,7 +78,7 @@
   "devDependencies": {
     "aws-cdk-lib": "0.0.0",
     "@aws-cdk/cdk-build-tools": "0.0.0",
-    "@aws-cdk/integ-runner": "^2.188.0",
+    "@aws-cdk/integ-runner": "^2.188.2",
     "@aws-cdk/pkglint": "0.0.0",
     "@aws-cdk/integ-tests-alpha": "0.0.0",
     "@types/jest": "^29.5.14",
diff --git a/packages/@aws-cdk/aws-cloud9-alpha/package.json b/packages/@aws-cdk/aws-cloud9-alpha/package.json
@@ -82,7 +82,7 @@
   "license": "Apache-2.0",
   "devDependencies": {
     "@aws-cdk/cdk-build-tools": "0.0.0",
-    "@aws-cdk/integ-runner": "^2.188.0",
+    "@aws-cdk/integ-runner": "^2.188.2",
     "@aws-cdk/pkglint": "0.0.0",
     "@types/jest": "^29.5.14",
     "aws-cdk-lib": "0.0.0",
diff --git a/packages/@aws-cdk/aws-codestar-alpha/package.json b/packages/@aws-cdk/aws-codestar-alpha/package.json
@@ -84,7 +84,7 @@
   "license": "Apache-2.0",
   "devDependencies": {
     "@aws-cdk/cdk-build-tools": "0.0.0",
-    "@aws-cdk/integ-runner": "^2.188.0",
+    "@aws-cdk/integ-runner": "^2.188.2",
     "@aws-cdk/pkglint": "0.0.0",
     "@types/jest": "^29.5.14",
     "aws-cdk-lib": "0.0.0",
diff --git a/packages/@aws-cdk/aws-ec2-alpha/package.json b/packages/@aws-cdk/aws-ec2-alpha/package.json
@@ -78,7 +78,7 @@
   "license": "Apache-2.0",
   "devDependencies": {
     "@aws-cdk/cdk-build-tools": "0.0.0",
-    "@aws-cdk/integ-runner": "^2.188.0",
+    "@aws-cdk/integ-runner": "^2.188.2",
     "@aws-cdk/integ-tests-alpha": "^0.0.0",
     "@aws-cdk/pkglint": "0.0.0",
     "@types/jest": "^29.5.14",
diff --git a/packages/@aws-cdk/aws-eks-v2-alpha/package.json b/packages/@aws-cdk/aws-eks-v2-alpha/package.json
@@ -84,7 +84,7 @@
   "license": "Apache-2.0",
   "devDependencies": {
     "@aws-cdk/cdk-build-tools": "0.0.0",
-    "@aws-cdk/integ-runner": "^2.188.0",
+    "@aws-cdk/integ-runner": "^2.188.2",
     "@aws-cdk/integ-tests-alpha": "0.0.0",
     "@aws-cdk/pkglint": "0.0.0",
     "@aws-cdk/lambda-layer-kubectl-v24": "^2.0.242",
diff --git a/packages/@aws-cdk/aws-gamelift-alpha/package.json b/packages/@aws-cdk/aws-gamelift-alpha/package.json
@@ -82,7 +82,7 @@
   "license": "Apache-2.0",
   "devDependencies": {
     "@aws-cdk/cdk-build-tools": "0.0.0",
-    "@aws-cdk/integ-runner": "^2.188.0",
+    "@aws-cdk/integ-runner": "^2.188.2",
     "@aws-cdk/pkglint": "0.0.0",
     "@types/jest": "^29.5.14",
     "jest": "^29.7.0",
diff --git a/packages/@aws-cdk/aws-glue-alpha/package.json b/packages/@aws-cdk/aws-glue-alpha/package.json
@@ -82,7 +82,7 @@
   "license": "Apache-2.0",
   "devDependencies": {
     "@aws-cdk/cdk-build-tools": "0.0.0",
-    "@aws-cdk/integ-runner": "^2.188.0",
+    "@aws-cdk/integ-runner": "^2.188.2",
     "@aws-cdk/integ-tests-alpha": "0.0.0",
     "@aws-cdk/pkglint": "0.0.0",
     "@types/jest": "^29.5.14",
diff --git a/packages/@aws-cdk/aws-iot-actions-alpha/package.json b/packages/@aws-cdk/aws-iot-actions-alpha/package.json
@@ -82,7 +82,7 @@
   "license": "Apache-2.0",
   "devDependencies": {
     "@aws-cdk/cdk-build-tools": "0.0.0",
-    "@aws-cdk/integ-runner": "^2.188.0",
+    "@aws-cdk/integ-runner": "^2.188.2",
     "@aws-cdk/pkglint": "0.0.0",
     "@types/jest": "^29.5.14",
     "jest": "^29.7.0",
diff --git a/packages/@aws-cdk/aws-iot-alpha/package.json b/packages/@aws-cdk/aws-iot-alpha/package.json
@@ -82,7 +82,7 @@
   "license": "Apache-2.0",
   "devDependencies": {
     "@aws-cdk/cdk-build-tools": "0.0.0",
-    "@aws-cdk/integ-runner": "^2.188.0",
+    "@aws-cdk/integ-runner": "^2.188.2",
     "@aws-cdk/pkglint": "0.0.0",
     "@types/jest": "^29.5.14",
     "jest": "^29.7.0",
diff --git a/packages/@aws-cdk/aws-iotevents-actions-alpha/package.json b/packages/@aws-cdk/aws-iotevents-actions-alpha/package.json
@@ -75,7 +75,7 @@
   "license": "Apache-2.0",
   "devDependencies": {
     "@aws-cdk/cdk-build-tools": "0.0.0",
-    "@aws-cdk/integ-runner": "^2.188.0",
+    "@aws-cdk/integ-runner": "^2.188.2",
     "@aws-cdk/pkglint": "0.0.0",
     "@types/jest": "^29.5.14",
     "jest": "^29.7.0",
diff --git a/packages/@aws-cdk/aws-iotevents-alpha/package.json b/packages/@aws-cdk/aws-iotevents-alpha/package.json
@@ -84,7 +84,7 @@
   "license": "Apache-2.0",
   "devDependencies": {
     "@aws-cdk/cdk-build-tools": "0.0.0",
-    "@aws-cdk/integ-runner": "^2.188.0",
+    "@aws-cdk/integ-runner": "^2.188.2",
     "@aws-cdk/pkglint": "0.0.0",
     "@types/jest": "^29.5.14",
     "jest": "^29.7.0",
diff --git a/packages/@aws-cdk/aws-ivs-alpha/package.json b/packages/@aws-cdk/aws-ivs-alpha/package.json
@@ -85,7 +85,7 @@
   "license": "Apache-2.0",
   "devDependencies": {
     "@aws-cdk/cdk-build-tools": "0.0.0",
-    "@aws-cdk/integ-runner": "^2.188.0",
+    "@aws-cdk/integ-runner": "^2.188.2",
     "@aws-cdk/pkglint": "0.0.0",
     "@types/jest": "^29.5.14",
     "aws-cdk-lib": "0.0.0",
diff --git a/packages/@aws-cdk/aws-kinesisanalytics-flink-alpha/package.json b/packages/@aws-cdk/aws-kinesisanalytics-flink-alpha/package.json
@@ -78,7 +78,7 @@
   "license": "Apache-2.0",
   "devDependencies": {
     "@aws-cdk/cdk-build-tools": "0.0.0",
-    "@aws-cdk/integ-runner": "^2.188.0",
+    "@aws-cdk/integ-runner": "^2.188.2",
     "@aws-cdk/pkglint": "0.0.0",
     "@types/jest": "^29.5.14",
     "jest": "^29.7.0",
diff --git a/packages/@aws-cdk/aws-lambda-go-alpha/package.json b/packages/@aws-cdk/aws-lambda-go-alpha/package.json
@@ -78,7 +78,7 @@
   "license": "Apache-2.0",
   "devDependencies": {
     "@aws-cdk/cdk-build-tools": "0.0.0",
-    "@aws-cdk/integ-runner": "^2.188.0",
+    "@aws-cdk/integ-runner": "^2.188.2",
     "@aws-cdk/integ-tests-alpha": "0.0.0",
     "@aws-cdk/pkglint": "0.0.0",
     "@types/jest": "^29.5.14",
diff --git a/packages/@aws-cdk/aws-lambda-python-alpha/package.json b/packages/@aws-cdk/aws-lambda-python-alpha/package.json
@@ -77,7 +77,7 @@
   "license": "Apache-2.0",
   "devDependencies": {
     "@aws-cdk/cdk-build-tools": "0.0.0",
-    "@aws-cdk/integ-runner": "^2.188.0",
+    "@aws-cdk/integ-runner": "^2.188.2",
     "@aws-cdk/pkglint": "0.0.0",
     "@types/jest": "^29.5.14",
     "aws-cdk-lib": "0.0.0",
diff --git a/packages/@aws-cdk/aws-location-alpha/package.json b/packages/@aws-cdk/aws-location-alpha/package.json
@@ -85,7 +85,7 @@
   "license": "Apache-2.0",
   "devDependencies": {
     "@aws-cdk/cdk-build-tools": "0.0.0",
-    "@aws-cdk/integ-runner": "^2.188.0",
+    "@aws-cdk/integ-runner": "^2.188.2",
     "@aws-cdk/pkglint": "0.0.0",
     "@types/jest": "^29.5.14",
     "aws-cdk-lib": "0.0.0",
diff --git a/packages/@aws-cdk/aws-msk-alpha/package.json b/packages/@aws-cdk/aws-msk-alpha/package.json
@@ -84,7 +84,7 @@
   "license": "Apache-2.0",
   "devDependencies": {
     "@aws-cdk/cdk-build-tools": "0.0.0",
-    "@aws-cdk/integ-runner": "^2.188.0",
+    "@aws-cdk/integ-runner": "^2.188.2",
     "@aws-cdk/pkglint": "0.0.0",
     "@types/jest": "^29.5.14",
     "jest": "^29.7.0",
diff --git a/packages/@aws-cdk/aws-neptune-alpha/package.json b/packages/@aws-cdk/aws-neptune-alpha/package.json
@@ -83,7 +83,7 @@
   "license": "Apache-2.0",
   "devDependencies": {
     "@aws-cdk/cdk-build-tools": "0.0.0",
-    "@aws-cdk/integ-runner": "^2.188.0",
+    "@aws-cdk/integ-runner": "^2.188.2",
     "@aws-cdk/pkglint": "0.0.0",
     "@types/jest": "^29.5.14",
     "aws-cdk-lib": "0.0.0",
diff --git a/packages/@aws-cdk/aws-pipes-alpha/package.json b/packages/@aws-cdk/aws-pipes-alpha/package.json
@@ -82,7 +82,7 @@
   "license": "Apache-2.0",
   "devDependencies": {
     "@aws-cdk/cdk-build-tools": "0.0.0",
-    "@aws-cdk/integ-runner": "^2.188.0",
+    "@aws-cdk/integ-runner": "^2.188.2",
     "@aws-cdk/pkglint": "0.0.0",
     "@types/jest": "^29.5.14",
     "jest": "^29",
diff --git a/packages/@aws-cdk/aws-pipes-enrichments-alpha/package.json b/packages/@aws-cdk/aws-pipes-enrichments-alpha/package.json
@@ -82,7 +82,7 @@
   "license": "Apache-2.0",
   "devDependencies": {
     "@aws-cdk/cdk-build-tools": "0.0.0",
-    "@aws-cdk/integ-runner": "^2.188.0",
+    "@aws-cdk/integ-runner": "^2.188.2",
     "@aws-cdk/pkglint": "0.0.0",
     "@types/jest": "^29.5.14",
     "jest": "^29",
diff --git a/packages/@aws-cdk/aws-pipes-sources-alpha/package.json b/packages/@aws-cdk/aws-pipes-sources-alpha/package.json
@@ -82,7 +82,7 @@
   "license": "Apache-2.0",
   "devDependencies": {
     "@aws-cdk/cdk-build-tools": "0.0.0",
-    "@aws-cdk/integ-runner": "^2.188.0",
+    "@aws-cdk/integ-runner": "^2.188.2",
     "@aws-cdk/pkglint": "0.0.0",
     "@types/jest": "^29.5.14",
     "jest": "^29",
diff --git a/packages/@aws-cdk/aws-pipes-targets-alpha/package.json b/packages/@aws-cdk/aws-pipes-targets-alpha/package.json
@@ -82,7 +82,7 @@
   "license": "Apache-2.0",
   "devDependencies": {
     "@aws-cdk/cdk-build-tools": "0.0.0",
-    "@aws-cdk/integ-runner": "^2.188.0",
+    "@aws-cdk/integ-runner": "^2.188.2",
     "@aws-cdk/pkglint": "0.0.0",
     "@types/jest": "^29.5.14",
     "jest": "^29",
diff --git a/packages/@aws-cdk/aws-redshift-alpha/package.json b/packages/@aws-cdk/aws-redshift-alpha/package.json
@@ -85,7 +85,7 @@
   "license": "Apache-2.0",
   "devDependencies": {
     "@aws-cdk/cdk-build-tools": "0.0.0",
-    "@aws-cdk/integ-runner": "^2.188.0",
+    "@aws-cdk/integ-runner": "^2.188.2",
     "@aws-cdk/pkglint": "0.0.0",
     "@aws-cdk/custom-resource-handlers": "0.0.0",
     "@aws-sdk/client-redshift": "3.632.0",
diff --git a/packages/@aws-cdk/aws-route53resolver-alpha/package.json b/packages/@aws-cdk/aws-route53resolver-alpha/package.json
@@ -83,7 +83,7 @@
   "license": "Apache-2.0",
   "devDependencies": {
     "@aws-cdk/cdk-build-tools": "0.0.0",
-    "@aws-cdk/integ-runner": "^2.188.0",
+    "@aws-cdk/integ-runner": "^2.188.2",
     "@aws-cdk/pkglint": "0.0.0",
     "@types/jest": "^29.5.14",
     "aws-cdk-lib": "0.0.0",
diff --git a/packages/@aws-cdk/aws-s3objectlambda-alpha/package.json b/packages/@aws-cdk/aws-s3objectlambda-alpha/package.json
@@ -85,7 +85,7 @@
   "license": "Apache-2.0",
   "devDependencies": {
     "@aws-cdk/cdk-build-tools": "0.0.0",
-    "@aws-cdk/integ-runner": "^2.188.0",
+    "@aws-cdk/integ-runner": "^2.188.2",
     "@aws-cdk/pkglint": "0.0.0",
     "@types/jest": "^29.5.14",
     "jest": "^29.7.0",
diff --git a/packages/@aws-cdk/aws-sagemaker-alpha/package.json b/packages/@aws-cdk/aws-sagemaker-alpha/package.json
@@ -83,7 +83,7 @@
   "license": "Apache-2.0",
   "devDependencies": {
     "@aws-cdk/cdk-build-tools": "0.0.0",
-    "@aws-cdk/integ-runner": "^2.188.0",
+    "@aws-cdk/integ-runner": "^2.188.2",
     "@aws-cdk/pkglint": "0.0.0",
     "@types/jest": "^29.5.14",
     "jest": "^29.7.0",
diff --git a/packages/@aws-cdk/aws-servicecatalogappregistry-alpha/package.json b/packages/@aws-cdk/aws-servicecatalogappregistry-alpha/package.json
@@ -85,7 +85,7 @@
   "license": "Apache-2.0",
   "devDependencies": {
     "@aws-cdk/cdk-build-tools": "0.0.0",
-    "@aws-cdk/integ-runner": "^2.188.0",
+    "@aws-cdk/integ-runner": "^2.188.2",
     "@aws-cdk/pkglint": "0.0.0",
     "@types/jest": "^29.5.14",
     "aws-cdk-lib": "0.0.0",
diff --git a/packages/@aws-cdk/cx-api/package.json b/packages/@aws-cdk/cx-api/package.json
@@ -82,12 +82,12 @@
     "semver": "^7.7.2"
   },
   "peerDependencies": {
-    "@aws-cdk/cloud-assembly-schema": ">=44.1.0"
+    "@aws-cdk/cloud-assembly-schema": ">=45.0.0"
   },
   "license": "Apache-2.0",
   "devDependencies": {
     "@aws-cdk/cdk-build-tools": "0.0.0",
-    "@aws-cdk/cloud-assembly-schema": "^44.8.0",
+    "@aws-cdk/cloud-assembly-schema": "^45.0.0",
     "@aws-cdk/pkglint": "0.0.0",
     "@types/jest": "^29.5.14",
     "@types/mock-fs": "^4.13.4",
diff --git a/packages/@aws-cdk/example-construct-library/package.json b/packages/@aws-cdk/example-construct-library/package.json
@@ -75,7 +75,7 @@
   "devDependencies": {
     "aws-cdk-lib": "0.0.0",
     "@aws-cdk/cdk-build-tools": "0.0.0",
-    "@aws-cdk/integ-runner": "^2.188.0",
+    "@aws-cdk/integ-runner": "^2.188.2",
     "@aws-cdk/pkglint": "0.0.0",
     "@types/jest": "^29.5.14",
     "jest": "^29.7.0"
diff --git a/packages/@aws-cdk/integ-tests-alpha/package.json b/packages/@aws-cdk/integ-tests-alpha/package.json
@@ -67,7 +67,7 @@
   "license": "Apache-2.0",
   "devDependencies": {
     "@aws-cdk/cdk-build-tools": "0.0.0",
-    "@aws-cdk/integ-runner": "^2.188.0",
+    "@aws-cdk/integ-runner": "^2.188.2",
     "@aws-cdk/pkglint": "0.0.0",
     "@aws-cdk/aws-custom-resource-sdk-adapter": "0.0.0",
     "@aws-sdk/client-ec2": "3.632.0",
diff --git a/packages/aws-cdk-lib/core/lib/private/feature-flag-report.ts b/packages/aws-cdk-lib/core/lib/private/feature-flag-report.ts
@@ -0,0 +1,39 @@
+import { ArtifactType, FeatureFlag } from '@aws-cdk/cloud-assembly-schema';
+import { IConstruct } from 'constructs';
+import { CloudAssemblyBuilder } from '../../../cx-api';
+import * as feats from '../../../cx-api/lib/features';
+import { FlagInfo } from '../../../cx-api/lib/private/flag-modeling';
+
+/**
+ * Creates a FeatureFlag object based on flag information given.
+ */
+function parseFeatureFlagInfo(flagName: string, info: FlagInfo, root: IConstruct): FeatureFlag {
+  const userValue = root.node.tryGetContext(flagName) ?? undefined;
+
+  let parsedFlag: FeatureFlag = {
+    userValue: userValue,
+    recommendedValue: info.recommendedValue,
+    explanation: info.summary,
+  };
+
+  return parsedFlag;
+}
+
+/**
+ * Iterate through all feature flags, retrieve the user's context,
+ * and create a Feature Flag report.
+ */
+export function generateFeatureFlagReport(builder: CloudAssemblyBuilder, root: IConstruct): void {
+  const featureFlags: Record<string, FeatureFlag> = {};
+  for (const [flagName, flagInfo] of Object.entries(feats.FLAGS)) {
+    featureFlags[flagName] = parseFeatureFlagInfo(flagName, flagInfo, root);
+  }
+
+  builder.addArtifact('aws-cdk-lib/feature-flag-report', {
+    type: ArtifactType.FEATURE_FLAG_REPORT,
+    properties: {
+      module: 'aws-cdk-lib',
+      flags: featureFlags,
+    },
+  });
+}
diff --git a/packages/aws-cdk-lib/core/lib/private/synthesis.ts b/packages/aws-cdk-lib/core/lib/private/synthesis.ts
@@ -15,6 +15,7 @@ import { Stack } from '../stack';
 import { ISynthesisSession } from '../stack-synthesizers/types';
 import { Stage, StageSynthesisOptions } from '../stage';
 import { IPolicyValidationPluginBeta1 } from '../validation';
+import { generateFeatureFlagReport } from './feature-flag-report';
 import { ConstructTree } from '../validation/private/construct-tree';
 import { PolicyValidationReportFormatter, NamedValidationPluginReport } from '../validation/private/report';
 
@@ -64,6 +65,8 @@ export function synthesize(root: IConstruct, options: SynthesisOptions = { }): c
   // stacks to add themselves to the synthesized cloud assembly.
   synthesizeTree(root, builder, options.validateOnSynthesis);
 
+  generateFeatureFlagReport(builder, root);
+
   const assembly = builder.buildAssembly();
 
   invokeValidationPlugins(root, builder.outdir, assembly);
diff --git a/packages/aws-cdk-lib/core/test/feature-flag-report.test.ts b/packages/aws-cdk-lib/core/test/feature-flag-report.test.ts
diff --git a/packages/aws-cdk-lib/core/test/stage.test.ts b/packages/aws-cdk-lib/core/test/stage.test.ts
diff --git a/packages/aws-cdk-lib/core/test/synthesis.test.ts b/packages/aws-cdk-lib/core/test/synthesis.test.ts
diff --git a/packages/aws-cdk-lib/package.json b/packages/aws-cdk-lib/package.json
diff --git a/yarn.lock b/yarn.lock
