feat: Add CloudFormation telemetry (#10)

* feat: Add CloudFormation telemtry

* Added tests

* assert => expect

* expect => expect().toStrictEqual()

src/control-plane/control-plane.ts

@@ -13,7 +13,7 @@ import { Services } from './services';
 import { Tables } from './tables';
 import { TenantConfigService } from './tenant-config/tenant-config-service';
 import { DestroyPolicySetter } from '../cdk-aspect/destroy-policy-setter';
-import { EventManager } from '../utils';
+import { EventManager, setTemplateDesc } from '../utils';
 
 export interface ControlPlaneProps {
   readonly applicationPlaneEventSource: string;
@@ -33,6 +33,8 @@ export class ControlPlane extends Construct {
 
   constructor(scope: Construct, id: string, props: ControlPlaneProps) {
     super(scope, id);
+    setTemplateDesc(this, 'SaaS Builder Toolkit - CoreApplicationPlane (uksb-1tupboc57)');
+
     cdk.Aspects.of(this).add(new DestroyPolicySetter());
 
     const messaging = new Messaging(this, 'messaging-stack');

src/core-app-plane/core-app-plane.ts

@@ -8,7 +8,7 @@ import { Construct } from 'constructs';
 import { BashJobOrchestrator } from './bash-job-orchestrator';
 import { BashJobRunner } from './bash-job-runner';
 import { DestroyPolicySetter } from '../cdk-aspect/destroy-policy-setter';
-import { EventManager } from '../utils';
+import { EventManager, setTemplateDesc } from '../utils';
 
 /**
  * Provides metadata for outgoing events.
@@ -133,6 +133,8 @@ export interface CoreApplicationPlaneProps {
 export class CoreApplicationPlane extends Construct {
   constructor(scope: Construct, id: string, props: CoreApplicationPlaneProps) {
     super(scope, id);
+    setTemplateDesc(this, 'SaaS Builder Toolkit - CoreApplicationPlane (uksb-1tupboc57)');
+
     cdk.Aspects.of(this).add(new DestroyPolicySetter());
 
     const eventBus = EventBus.fromEventBusArn(this, 'eventBus', props.eventBusArn);

src/utils/index.ts

@@ -2,3 +2,4 @@
 // SPDX-License-Identifier: Apache-2.0
 
 export * from './event-manager';
+export * from './utils';

src/utils/utils.ts

@@ -0,0 +1,11 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import { Stack } from 'aws-cdk-lib';
+import { Construct } from 'constructs';
+
+export const setTemplateDesc = (construct: Construct, sbtDesc: string) => {
+  const stackDesc = Stack.of(construct).templateOptions.description;
+  let description = stackDesc === undefined ? sbtDesc : stackDesc + ' - ' + sbtDesc;
+  Stack.of(construct).templateOptions.description = description;
+};

test/control-plane.test.ts

@@ -59,7 +59,7 @@ describe('No unsuppressed cdk-nag Warnings or Errors', () => {
   });
 });
 
-describe('ControlPlane', () => {
+describe('ControlPlane without Description', () => {
   const app = new cdk.App();
   interface TestStackProps extends cdk.StackProps {
     systemAdminEmail: string;
@@ -113,4 +113,20 @@ describe('ControlPlane', () => {
       expect(targetsCapture.asArray()).toHaveLength(1);
     } while (targetsCapture.next());
   });
+
+  it('should have a fixed template description, when the containing stack does not have description', () => {
+    const actual = controlPlaneTestStack.templateOptions.description;
+    const expected = 'SaaS Builder Toolkit - CoreApplicationPlane (uksb-1tupboc57)';
+    expect(actual).toStrictEqual(expected);
+  });
+
+  it('should have a concatenated template description, when the containing stack has an existing desc', () => {
+    const stackWithDescription = new TestStack(app, 'stackWithDescription', {
+      systemAdminEmail: '[email protected]',
+      description: 'ABC',
+    });
+    const actual = stackWithDescription.templateOptions.description;
+    const expected = 'ABC - SaaS Builder Toolkit - CoreApplicationPlane (uksb-1tupboc57)';
+    expect(expected).toStrictEqual(actual);
+  });
 });