Skip to content

Commit cf18cf6

Browse files
rix0rrrrix0rrr
authored
chore: add feature flag report to package (#32607)
Include a file `recommended-feature-flags.json` into the `aws-cdk-lib` package. At build time, the CLI will copy the current `aws-cdk-lib` and `constructs` version, as well as the feature flag report, into its own package directory, and it will use those to initialize a new project. This decouples the init version number from the CLI version number, and it removes the need for the CLI to read `cx-api` at init time. Closes aws/aws-cdk-cli#7 ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
1 parent 0546ec2 commit cf18cf6

File tree

18 files changed

+219
-27
lines changed

18 files changed

+219
-27
lines changed

‎packages/@aws-cdk/cli-lib-alpha/.eslintrc.js

+1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
const baseConfig = require('@aws-cdk/cdk-build-tools/config/eslintrc');
22
baseConfig.parserOptions.project = __dirname + '/tsconfig.json';
3+
baseConfig.ignorePatterns.push('**/*.template.ts');
34

45
baseConfig.rules['import/no-extraneous-dependencies'] = ['error', { devDependencies: true, peerDependencies: true } ];
56
baseConfig.rules['import/order'] = 'off';

‎packages/@aws-cdk/cli-lib-alpha/.gitignore

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
*.js.map
33
*.d.ts
44
*.gz
5-
!lib/init-templates/**/javascript/**/*
5+
lib/init-templates/
66
node_modules
77
dist
88
.jsii

‎packages/@aws-cdk/cli-lib-alpha/build-tools/copy-cli-resources.sh

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
#!/bin/bash
2+
set -euo pipefail
3+
4+
aws_cdk="$1"
5+
6+
# Copy all resources that aws_cdk/generate.sh produced, and some othersCall the generator for the
7+
cp $aws_cdk/build-info.json ./
8+
cp -R $aws_cdk/lib/init-templates ./lib/
9+
10+
mkdir -p ./lib/api/bootstrap/ && cp $aws_cdk/lib/api/bootstrap/bootstrap-template.yaml ./lib/api/bootstrap/
11+
cp $aws_cdk/lib/index_bg.wasm ./lib/
12+
cp $aws_cdk/db.json.gz ./

‎packages/@aws-cdk/cli-lib-alpha/package.json

+4-4
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@
66
"main": "lib/main.js",
77
"types": "lib/index.d.ts",
88
"jsii": {
9+
"excludeTypescript": [
10+
"**/*.template.ts"
11+
],
912
"outdir": "dist",
1013
"targets": {
1114
"dotnet": {
@@ -52,7 +55,7 @@
5255
"build+test+package": "yarn build+test && yarn package",
5356
"bundle": "esbuild --bundle lib/index.ts --target=node18 --platform=node --external:fsevents --minify-whitespace --outfile=lib/main.js",
5457
"compat": "cdk-compat",
55-
"gen": "../../../packages/aws-cdk/generate.sh",
58+
"gen": "build-tools/copy-cli-resources.sh ../../../packages/aws-cdk",
5659
"lint": "cdk-lint",
5760
"package": "cdk-package",
5861
"pkglint": "pkglint -f",
@@ -63,9 +66,6 @@
6366
"cdk-build": {
6467
"post": [
6568
"yarn attribute",
66-
"mkdir -p ./lib/api/bootstrap/ && cp ../../aws-cdk/lib/api/bootstrap/bootstrap-template.yaml ./lib/api/bootstrap/",
67-
"cp ../../../node_modules/cdk-from-cfn/index_bg.wasm ./lib/",
68-
"cp ../../../node_modules/@aws-cdk/aws-service-spec/db.json.gz ./",
6969
"yarn bundle",
7070
"node ./lib/main.js >/dev/null 2>/dev/null </dev/null"
7171
],

‎packages/@aws-cdk/integ-runner/build-tools/generate.sh

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
#!/bin/bash
2+
set -euo pipefail
3+
4+
# Copy the recommended-feature-flags.json file out from aws-cdk-lib.
5+
path=$(node -p 'require.resolve("aws-cdk-lib/recommended-feature-flags.json")')
6+
cp $path lib/recommended-feature-flags.json

‎packages/@aws-cdk/integ-runner/lib/runner/runner-base.ts

+12-2
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
import * as path from 'path';
33
import { CdkCliWrapper, ICdk } from '@aws-cdk/cdk-cli-wrapper';
44
import { TestCase, DefaultCdkOptions } from '@aws-cdk/cloud-assembly-schema';
5-
import { AVAILABILITY_ZONE_FALLBACK_CONTEXT_KEY, TARGET_PARTITIONS, NEW_PROJECT_CONTEXT } from '@aws-cdk/cx-api';
5+
import { AVAILABILITY_ZONE_FALLBACK_CONTEXT_KEY, TARGET_PARTITIONS } from '@aws-cdk/cx-api';
66
import * as fs from 'fs-extra';
77
import { IntegTestSuite, LegacyIntegTestSuite } from './integ-test-suite';
88
import { IntegTest } from './integration-tests';
@@ -365,7 +365,7 @@ export abstract class IntegRunner {
365365

366366
protected getContext(additionalContext?: Record<string, any>): Record<string, any> {
367367
return {
368-
...NEW_PROJECT_CONTEXT,
368+
...currentlyRecommendedAwsCdkLibFlags(),
369369
...this.legacyContext,
370370
...additionalContext,
371371

@@ -432,3 +432,13 @@ export const DEFAULT_SYNTH_OPTIONS = {
432432
CDK_INTEG_SUBNET_ID: 'subnet-0dff1a399d8f6f92c',
433433
},
434434
};
435+
436+
/**
437+
* Return the currently recommended flags for `aws-cdk-lib`.
438+
*
439+
* These have been built into the CLI at build time.
440+
*/
441+
export function currentlyRecommendedAwsCdkLibFlags() {
442+
const recommendedFlagsFile = path.join(__dirname, '..', 'recommended-feature-flags.json');
443+
return JSON.parse(fs.readFileSync(recommendedFlagsFile, { encoding: 'utf-8' }));
444+
}

‎packages/@aws-cdk/integ-runner/package.json

+1
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
"integ-runner": "bin/integ-runner"
99
},
1010
"scripts": {
11+
"gen": "./build-tools/generate.sh",
1112
"build": "cdk-build",
1213
"lint": "cdk-lint",
1314
"package": "cdk-package",

‎packages/aws-cdk-lib/cx-api/build-tools/flag-report.ts

+8-1
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,9 @@ async function main() {
1515
diff: changedFlags(),
1616
migratejson: migrateJson(),
1717
});
18+
19+
// Write to the package root
20+
await updateRecommendedFlagsFile(path.join(__dirname, '..', '..', 'recommended-feature-flags.json'));
1821
}
1922

2023
function flagsTable() {
@@ -117,7 +120,7 @@ function oldBehavior(flag: FlagInfo): string | undefined {
117120
function recommendedJson() {
118121
return [
119122
'```json',
120-
JSON.stringify({ context: feats.NEW_PROJECT_CONTEXT }, undefined, 2),
123+
JSON.stringify({ context: feats.CURRENTLY_RECOMMENDED_FLAGS }, undefined, 2),
121124
'```',
122125
].join('\n');
123126
}
@@ -206,6 +209,10 @@ async function updateMarkdownFile(filename: string, sections: Record<string, str
206209
await fs.writeFile(filename, contents, { encoding: 'utf-8' });
207210
}
208211

212+
async function updateRecommendedFlagsFile(filename: string) {
213+
await fs.writeFile(filename, JSON.stringify(feats.CURRENTLY_RECOMMENDED_FLAGS, undefined, 2), { encoding: 'utf-8' });
214+
}
215+
209216
function firstCmp(...xs: number[]) {
210217
return xs.find(x => x !== 0) ?? 0;
211218
}

‎packages/aws-cdk-lib/cx-api/lib/features.ts

+8-5
Original file line numberDiff line numberDiff line change
@@ -1317,10 +1317,13 @@ export const CURRENT_VERSION_EXPIRED_FLAGS: string[] = Object.entries(FLAGS)
13171317
* Add a flag in here (typically with the value `true`), to enable
13181318
* backwards-breaking behavior changes only for new projects. New projects
13191319
* generated through `cdk init` will include these flags in their generated
1320+
* project config.
13201321
*
13211322
* Tests must cover the default (disabled) case and the future (enabled) case.
1323+
*
1324+
* Going forward, this should *NOT* be consumed directly anymore.
13221325
*/
1323-
export const NEW_PROJECT_CONTEXT = Object.fromEntries(
1326+
export const CURRENTLY_RECOMMENDED_FLAGS = Object.fromEntries(
13241327
Object.entries(FLAGS)
13251328
.filter(([_, flag]) => flag.recommendedValue !== flag.defaults?.[CURRENT_MV] && flag.introducedIn[CURRENT_MV])
13261329
.map(([name, flag]) => [name, flag.recommendedValue]),
@@ -1352,10 +1355,10 @@ export function futureFlagDefault(flag: string): boolean {
13521355
/** @deprecated use CURRENT_VERSION_EXPIRED_FLAGS instead */
13531356
export const FUTURE_FLAGS_EXPIRED = CURRENT_VERSION_EXPIRED_FLAGS;
13541357

1355-
/** @deprecated use NEW_PROJECT_CONTEXT instead */
1356-
export const FUTURE_FLAGS = Object.fromEntries(Object.entries(NEW_PROJECT_CONTEXT)
1358+
/** @deprecated do not use at all! */
1359+
export const FUTURE_FLAGS = Object.fromEntries(Object.entries(CURRENTLY_RECOMMENDED_FLAGS)
13571360
.filter(([_, v]) => typeof v === 'boolean'));
13581361

1359-
/** @deprecated use NEW_PROJECT_CONTEXT instead */
1360-
export const NEW_PROJECT_DEFAULT_CONTEXT = Object.fromEntries(Object.entries(NEW_PROJECT_CONTEXT)
1362+
/** @deprecated do not use at all! */
1363+
export const NEW_PROJECT_DEFAULT_CONTEXT = Object.fromEntries(Object.entries(CURRENTLY_RECOMMENDED_FLAGS)
13611364
.filter(([_, v]) => typeof v !== 'boolean'));

‎packages/aws-cdk-lib/cx-api/lib/private/flag-modeling.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ export interface FlagInfoBase {
3030
/** Version number the flag was introduced in each version line. `undefined` means flag does not exist in that line. */
3131
readonly introducedIn: { v1?: string; v2?: string };
3232
/** Default value, if flag is unset by user. Adding a flag with a default may not change behavior after GA! */
33-
readonly defaults?: { v2?: any };
33+
readonly defaults?: { v1?: any; v2?: any };
3434
/** Default in new projects */
3535
readonly recommendedValue: any;
3636
};

‎packages/aws-cdk-lib/package.json

+1
Original file line numberDiff line numberDiff line change
@@ -509,6 +509,7 @@
509509
"./pipelines/.warnings.jsii.js": "./pipelines/.warnings.jsii.js",
510510
"./pipelines/lib/helpers-internal": "./pipelines/lib/helpers-internal/index.js",
511511
"./pipelines/package.json": "./pipelines/package.json",
512+
"./recommended-feature-flags.json": "./recommended-feature-flags.json",
512513
"./region-info": "./region-info/index.js",
513514
"./triggers": "./triggers/index.js"
514515
},

‎packages/aws-cdk-lib/recommended-feature-flags.json

+63
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
{
2+
"@aws-cdk/aws-lambda:recognizeLayerVersion": true,
3+
"@aws-cdk/core:checkSecretUsage": true,
4+
"@aws-cdk/core:target-partitions": [
5+
"aws",
6+
"aws-cn"
7+
],
8+
"@aws-cdk-containers/ecs-service-extensions:enableDefaultLogDriver": true,
9+
"@aws-cdk/aws-ec2:uniqueImdsv2TemplateName": true,
10+
"@aws-cdk/aws-ecs:arnFormatIncludesClusterName": true,
11+
"@aws-cdk/aws-iam:minimizePolicies": true,
12+
"@aws-cdk/core:validateSnapshotRemovalPolicy": true,
13+
"@aws-cdk/aws-codepipeline:crossAccountKeyAliasStackSafeResourceName": true,
14+
"@aws-cdk/aws-s3:createDefaultLoggingPolicy": true,
15+
"@aws-cdk/aws-sns-subscriptions:restrictSqsDescryption": true,
16+
"@aws-cdk/aws-apigateway:disableCloudWatchRole": true,
17+
"@aws-cdk/core:enablePartitionLiterals": true,
18+
"@aws-cdk/aws-events:eventsTargetQueueSameAccount": true,
19+
"@aws-cdk/aws-ecs:disableExplicitDeploymentControllerForCircuitBreaker": true,
20+
"@aws-cdk/aws-iam:importedRoleStackSafeDefaultPolicyName": true,
21+
"@aws-cdk/aws-s3:serverAccessLogsUseBucketPolicy": true,
22+
"@aws-cdk/aws-route53-patters:useCertificate": true,
23+
"@aws-cdk/customresources:installLatestAwsSdkDefault": false,
24+
"@aws-cdk/aws-rds:databaseProxyUniqueResourceName": true,
25+
"@aws-cdk/aws-codedeploy:removeAlarmsFromDeploymentGroup": true,
26+
"@aws-cdk/aws-apigateway:authorizerChangeDeploymentLogicalId": true,
27+
"@aws-cdk/aws-ec2:launchTemplateDefaultUserData": true,
28+
"@aws-cdk/aws-secretsmanager:useAttachedSecretResourcePolicyForSecretTargetAttachments": true,
29+
"@aws-cdk/aws-redshift:columnId": true,
30+
"@aws-cdk/aws-stepfunctions-tasks:enableEmrServicePolicyV2": true,
31+
"@aws-cdk/aws-ec2:restrictDefaultSecurityGroup": true,
32+
"@aws-cdk/aws-apigateway:requestValidatorUniqueId": true,
33+
"@aws-cdk/aws-kms:aliasNameRef": true,
34+
"@aws-cdk/aws-autoscaling:generateLaunchTemplateInsteadOfLaunchConfig": true,
35+
"@aws-cdk/core:includePrefixInUniqueNameGeneration": true,
36+
"@aws-cdk/aws-efs:denyAnonymousAccess": true,
37+
"@aws-cdk/aws-opensearchservice:enableOpensearchMultiAzWithStandby": true,
38+
"@aws-cdk/aws-lambda-nodejs:useLatestRuntimeVersion": true,
39+
"@aws-cdk/aws-efs:mountTargetOrderInsensitiveLogicalId": true,
40+
"@aws-cdk/aws-rds:auroraClusterChangeScopeOfInstanceParameterGroupWithEachParameters": true,
41+
"@aws-cdk/aws-appsync:useArnForSourceApiAssociationIdentifier": true,
42+
"@aws-cdk/aws-rds:preventRenderingDeprecatedCredentials": true,
43+
"@aws-cdk/aws-codepipeline-actions:useNewDefaultBranchForCodeCommitSource": true,
44+
"@aws-cdk/aws-cloudwatch-actions:changeLambdaPermissionLogicalIdForLambdaAction": true,
45+
"@aws-cdk/aws-codepipeline:crossAccountKeysDefaultValueToFalse": true,
46+
"@aws-cdk/aws-codepipeline:defaultPipelineTypeToV2": true,
47+
"@aws-cdk/aws-kms:reduceCrossAccountRegionPolicyScope": true,
48+
"@aws-cdk/aws-eks:nodegroupNameAttribute": true,
49+
"@aws-cdk/aws-ec2:ebsDefaultGp3Volume": true,
50+
"@aws-cdk/aws-ecs:removeDefaultDeploymentAlarm": true,
51+
"@aws-cdk/custom-resources:logApiResponseDataPropertyTrueDefault": false,
52+
"@aws-cdk/aws-s3:keepNotificationInImportedBucket": false,
53+
"@aws-cdk/aws-ecs:reduceEc2FargateCloudWatchPermissions": true,
54+
"@aws-cdk/aws-dynamodb:resourcePolicyPerReplica": true,
55+
"@aws-cdk/aws-ec2:ec2SumTImeoutEnabled": true,
56+
"@aws-cdk/aws-appsync:appSyncGraphQLAPIScopeLambdaPermission": true,
57+
"@aws-cdk/aws-rds:setCorrectValueForDatabaseInstanceReadReplicaInstanceResourceId": true,
58+
"@aws-cdk/core:cfnIncludeRejectComplexResourceUpdateCreatePolicyIntrinsics": true,
59+
"@aws-cdk/aws-lambda-nodejs:sdkV3ExcludeSmithyPackages": true,
60+
"@aws-cdk/aws-stepfunctions-tasks:fixRunEcsTaskPolicy": true,
61+
"@aws-cdk/aws-ec2:bastionHostUseAmazonLinux2023ByDefault": true,
62+
"@aws-cdk/aws-route53-targets:userPoolDomainNameMethodWithoutCustomResource": true
63+
}

‎packages/aws-cdk/.gitignore

+2
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
!lib/init-templates/**/javascript/**/*
55
lib/init-templates/**/*.hook.js
66
lib/init-templates/**/*.hook.d.ts
7+
lib/init-templates/.*.json
78
node_modules
89
dist
910

@@ -40,5 +41,6 @@ test/integ/cli/*.d.ts
4041

4142
junit.xml
4243

44+
4345
lib/**/*.wasm
4446
db.json.gz

‎packages/aws-cdk/generate.sh

+9
Original file line numberDiff line numberDiff line change
@@ -14,3 +14,12 @@ cat > build-info.json <<HERE
1414
"commit": "${commit:0:7}"
1515
}
1616
HERE
17+
18+
# Copy the current 'aws-cdk-lib' version out from the monorepo.
19+
cdk_version=$(node -p 'require("aws-cdk-lib/package.json").version')
20+
constructs_range=$(node -p 'require("aws-cdk-lib/package.json").peerDependencies.constructs')
21+
echo '{"aws-cdk-lib": "'"$cdk_version"'", "constructs": "'"$constructs_range"'"}' > lib/init-templates/.init-version.json
22+
23+
# Copy the recommended-feature-flags.json file out from aws-cdk-lib.
24+
path=$(node -p 'require.resolve("aws-cdk-lib/recommended-feature-flags.json")')
25+
cp $path lib/init-templates/.recommended-feature-flags.json

‎packages/aws-cdk/lib/init-templates/lib/typescript/tsconfig.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,6 @@
2626
},
2727
"exclude": [
2828
"node_modules",
29-
"cdk.out"
29+
"cdk.out",
3030
]
3131
}

‎packages/aws-cdk/lib/init.ts

+45-7
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
import * as childProcess from 'child_process';
22
import * as path from 'path';
3-
import * as cxapi from '@aws-cdk/cx-api';
43
import * as chalk from 'chalk';
54
import * as fs from 'fs-extra';
65
import { invokeBuiltinHooks } from './init-hooks';
@@ -126,6 +125,7 @@ export class InitTemplate {
126125
const projectInfo: ProjectInfo = {
127126
name: decamelize(path.basename(path.resolve(targetDirectory))),
128127
stackName,
128+
versions: await loadInitVersions(),
129129
};
130130

131131
const sourceDirectory = path.join(this.basePath, language);
@@ -173,11 +173,9 @@ export class InitTemplate {
173173
}
174174

175175
private expand(template: string, language: string, project: ProjectInfo) {
176-
// eslint-disable-next-line @typescript-eslint/no-require-imports
177-
const manifest = require(path.join(rootDir(), 'package.json'));
178-
const MATCH_VER_BUILD = /\+[a-f0-9]+$/; // Matches "+BUILD" in "x.y.z-beta+BUILD"
179-
const cdkVersion = manifest.version.replace(MATCH_VER_BUILD, '');
180-
let constructsVersion = manifest.devDependencies.constructs.replace(MATCH_VER_BUILD, '');
176+
const cdkVersion = project.versions['aws-cdk-lib'];
177+
let constructsVersion = project.versions.constructs;
178+
181179
switch (language) {
182180
case 'java':
183181
case 'csharp':
@@ -222,7 +220,7 @@ export class InitTemplate {
222220
const config = await fs.readJson(cdkJson);
223221
config.context = {
224222
...config.context,
225-
...cxapi.NEW_PROJECT_CONTEXT,
223+
...await currentlyRecommendedAwsCdkLibFlags(),
226224
};
227225

228226
await fs.writeJson(cdkJson, config, { spaces: 2 });
@@ -248,6 +246,8 @@ interface ProjectInfo {
248246
/** The value used for %name% */
249247
readonly name: string;
250248
readonly stackName?: string;
249+
250+
readonly versions: Versions;
251251
}
252252

253253
export async function availableInitTemplates(): Promise<InitTemplate[]> {
@@ -471,3 +471,41 @@ async function execute(cmd: string, args: string[], { cwd }: { cwd: string }) {
471471
});
472472
});
473473
}
474+
475+
interface Versions {
476+
['aws-cdk-lib']: string;
477+
constructs: string;
478+
}
479+
480+
/**
481+
* Return the 'aws-cdk-lib' version we will init
482+
*
483+
* This has been built into the CLI at build time.
484+
*/
485+
async function loadInitVersions(): Promise<Versions> {
486+
const recommendedFlagsFile = path.join(__dirname, './init-templates/.init-version.json');
487+
const contents = JSON.parse(await fs.readFile(recommendedFlagsFile, { encoding: 'utf-8' }));
488+
489+
const ret = {
490+
'aws-cdk-lib': contents['aws-cdk-lib'],
491+
'constructs': contents.constructs,
492+
};
493+
for (const [key, value] of Object.entries(ret)) {
494+
/* istanbul ignore next */
495+
if (!value) {
496+
throw new Error(`Missing init version from ${recommendedFlagsFile}: ${key}`);
497+
}
498+
}
499+
500+
return ret;
501+
}
502+
503+
/**
504+
* Return the currently recommended flags for `aws-cdk-lib`.
505+
*
506+
* These have been built into the CLI at build time.
507+
*/
508+
export async function currentlyRecommendedAwsCdkLibFlags() {
509+
const recommendedFlagsFile = path.join(__dirname, './init-templates/.recommended-feature-flags.json');
510+
return JSON.parse(await fs.readFile(recommendedFlagsFile, { encoding: 'utf-8' }));
511+
}

0 commit comments

Comments
 (0)