feat(sre): add default feature flags [INFRA-20920]

time-loop · Aug 30, 2024 · 8cd014c · 8cd014c
1 parent aba860f
commit 8cd014c
Show file tree

Hide file tree

Showing 8 changed files with 100 additions and 4 deletions.
diff --git a/API.md b/API.md
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/src/cdk-context-json.ts b/src/cdk-context-json.ts
@@ -32,6 +32,12 @@ export module cdkContextJson {
      * @default - do not create stack SampleCode for OIDC role
      */
     readonly createOidcRoleStack?: boolean;
+    /**
+     * Add default feature flags for CDK
+     *
+     * @default - true
+     */
+    readonly addDefaultFeatureFlags?: boolean;
     /**
      * You must configure this if you want to self-mutation cdk.context.json.
      *
@@ -40,6 +46,12 @@ export module cdkContextJson {
     readonly injectionOptions?: InjectionOptions;
   }
 
+  export function addDefaultFeatureFlags(project: awscdk.AwsCdkTypeScriptApp): void {
+    project.cdkConfig.json.addOverride('context', {
+      '@aws-cdk/aws-ecs:disableExplicitDeploymentControllerForCircuitBreaker': true,
+    });
+  }
+
   export function injectAwsAuthIntoBuild(project: awscdk.AwsCdkTypeScriptApp, options: InjectionOptions): void {
     const build = project.tryFindObjectFile('.github/workflows/build.yml');
     build?.addOverride('jobs.build.permissions', { 'id-token': 'write' });

diff --git a/src/clickup-cdk.ts b/src/clickup-cdk.ts
@@ -259,6 +259,10 @@ export module clickupCdk {
         }
       }
 
+      if (options.cdkContextJsonOptions?.addDefaultFeatureFlags !== false) {
+        cdkContextJson.addDefaultFeatureFlags(this);
+      }
+
       if (options.sendReleaseEvent === false) {
         this.datadogEvent = false;
       } else {

diff --git a/test/__snapshots__/cdk-context-json.test.ts.snap b/test/__snapshots__/cdk-context-json.test.ts.snap
diff --git a/test/__snapshots__/clickup-cdk.test.ts.snap b/test/__snapshots__/clickup-cdk.test.ts.snap
diff --git a/test/cdk-context-json.test.ts b/test/cdk-context-json.test.ts
@@ -27,3 +27,12 @@ describe('addOidcRoleStack', () => {
     expect(synth['src/github-actions-oidc-cdk-context-lookup-role.ts']).toMatchSnapshot();
   });
 });
+
+describe('addDefaultFeatureFlags', () => {
+  const project = new awscdk.AwsCdkTypeScriptApp(requiredParams);
+  cdkContextJson.addDefaultFeatureFlags(project);
+  const synth = Testing.synth(project);
+  test('adds feature flags', () => {
+    expect(synth['cdk.json']).toMatchSnapshot();
+  });
+});
diff --git a/test/clickup-cdk.test.ts b/test/clickup-cdk.test.ts
@@ -15,6 +15,7 @@ describe('ClickUpCdkTypeScriptApp', () => {
       'src/widget.ts',
       'test/widget.test.ts',
       '.github/workflows/release.yml',
+      'cdk.json',
     ].forEach((file) => {
       test(file, () => {
         expect(synth[file]).toMatchSnapshot();