feat(baseclass): added base class with observability functionality

Author: Dinesh Sajwan

src/common/base-class/README.md

@@ -0,0 +1,17 @@
+# BaseClass
+<!--BEGIN STABILITY BANNER-->
+
+---
+
+![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge)
+
+> All classes are under active development and subject to non-backward compatible changes or removal in any
+> future version. These are not subject to the [Semantic Versioning](https://semver.org/) model.
+> This means that while you may use them, you may need to update your source code when upgrading to a newer version of this package.
+
+---
+<!--END STABILITY BANNER-->
+
+The Baseclass includes the basic building blocks of the AWS Generative AI CDK Constructs library. It defines the core funnctions that are used in the rest of the constructs. The purpose is to standardize and accelerate development for builders.
+
+

src/common/base-class/base-class.ts

@@ -10,13 +10,16 @@
  *  OR CONDITIONS OF ANY KIND, express or implied. See the License for the specific language governing permissions
  *  and limitations under the License.
  */
-import { Construct } from 'constructs';
-import {  version } from '../helpers/utils';
-import * as lambda from 'aws-cdk-lib/aws-lambda';
 import { Stack } from 'aws-cdk-lib';
+import * as appsync from 'aws-cdk-lib/aws-appsync';
+import * as lambda from 'aws-cdk-lib/aws-lambda';
+import * as logs from 'aws-cdk-lib/aws-logs';
+import { Construct } from 'constructs';
+import { version } from '../helpers/utils';
+
 
 export interface BaseClassProps {
-   /**
+  /**
    * Value will be appended to resources name.
    *
    * @default - _dev
@@ -36,51 +39,116 @@ export interface BaseClassProps {
    */
   readonly enableOperationalMetric?: boolean;
 
-   lambdaFunctions: lambda.DockerImageFunction[]
-   constructorName: string
-   constructId: string
+  /**
+   * name of the construct.
+   *
+   */
+  readonly constructorName: string;
+
+  /**
+   * construct id.
+   *
+   */
+  readonly constructId: string;
+
+  /**
+   * Enable observability. Warning: associated cost with the services
+   * used. Best practice to enable by default.
+   *
+   * @default - true
+   */
+  readonly observability?: boolean;
 }
 
 export class BaseClass extends Construct {
 
-    readonly CONSTRUCT_TRACKING_CODE = 'uksb-1tupboc45';
+  /**
+   * construct tracking code, added in template description
+   */
+  readonly constructTrackingCode = 'uksb-1tupboc45';
 
-    //static readonly solutionId = `genai_cdk_${version}/${this.constructor.name}/${id}`;
+  /**
+   * Value will be appended to resources name.
+   *
+   * @default - _dev
+   */
+  stage!: string;
 
-    stage!: string;
+  /**
+   * enable disable lambda tracing
+   *
+   * @default - Active
+   */
+  lambdaTracing: lambda.Tracing=lambda.Tracing.ACTIVE;
 
-    constructor(scope: Construct, id: string) {
-        super(scope, id)    
+  /**
+   * enable disable xray tracing
+   *
+   * @default - True
+   */
+  enablexray: boolean = true;
 
-    }
+  /**
+   * Default  log config for all constructs
+   */
+  fieldLogLevel:appsync.FieldLogLevel=appsync.FieldLogLevel.ALL;
+
+  /**
+   * Default  log retention config for all constructs
+   */
+  retention: logs.RetentionDays=logs.RetentionDays.TEN_YEARS;
+
+
+  constructor(scope: Construct, id: string) {
+    super(scope, id);
 
-  public updateEnvSuffix(props: BaseClassProps){
-      let stage = '-dev';
-      if (props?.stage) {
-        stage = props.stage;
-      }
-      this.stage = stage;
   }
 
-  public updateConstructTrackingCode(props: BaseClassProps,scope: Construct){
-      const enableOperationalMetric =
-      props.enableOperationalMetric !== undefined && 
+  //overwrite default env suffix
+  protected updateEnvSuffix(props: BaseClassProps) {
+    let stage = '-dev';
+    if (props?.stage) {
+      stage = props.stage;
+    }
+    this.stage = stage;
+  }
+
+  /*
+  * If enableOperationalMetric is set to true,
+  * update template description with construct tracking code and
+  * add AWS_SDK_UA_APP_ID to user agent on aws sdk.
+  */
+  protected updateConstructTrackingCode(props: BaseClassProps, scope: Construct, lambdaFunctions: lambda.DockerImageFunction[],
+  ) {
+    const solutionId = `genai_cdk_${version}/${props.constructorName}/${props.constructId}`;
+
+    const enableOperationalMetric =
+      props.enableOperationalMetric !== undefined &&
       props.enableOperationalMetric !== null ? props.enableOperationalMetric : true;
 
     if (enableOperationalMetric) {
-    
-      // iterate props.lambdaFunction array
-      const solutionId = `genai_cdk_${version}/${props.constructorName}/${props.constructId}`;
-      for(let lambdaFunction of props.lambdaFunctions)
-      {
+      if (lambdaFunctions
+          && lambdaFunctions.length > 0) {
+        for (let lambdaFunction of lambdaFunctions) {
           lambdaFunction.addEnvironment(
-              'AWS_SDK_UA_APP_ID', solutionId,
-            );
+            'AWS_SDK_UA_APP_ID', solutionId,
+          );
+        }
       }
-      // ADD unique key in CFN stack
-      Stack.of(scope).templateOptions.description =solutionId
+      // ADD unique key in template description
+      // format  (tracking id:usbxxxx) (version:1.xx) (construct name:awsappsyncxxxx) (construct id:awsappsyncxxxx)
+      Stack.of(scope).templateOptions.description =`(tracking id:${this.constructTrackingCode}) (version:${version}) (construct name:${props.constructorName}) (construct id:${props.constructId})`;
+
+    };
+  }
 
+  // observability
+  protected addObservabilityToConstruct(props: BaseClassProps) {
+    if (props.observability == false) {
+      this.enablexray = false;
+      this.lambdaTracing = lambda.Tracing.DISABLED;
+      this.fieldLogLevel= appsync.FieldLogLevel.NONE,
+      this.retention= logs.RetentionDays.TEN_YEARS;
     };
   }
-  
-}  
+}

src/index.ts

@@ -24,3 +24,4 @@ export { version } from './common/helpers/utils';
 export * from './common/props/DockerLambdaCustomProps';
 export * from './common/props/LangchainProps';
 export * from './common/props/AdapterProps';
+export * from './common/base-class';

src/patterns/gen-ai/aws-contentgen-appsync-lambda/index.ts

@@ -23,9 +23,10 @@ import * as logs from 'aws-cdk-lib/aws-logs';
 import * as s3 from 'aws-cdk-lib/aws-s3';
 import { NagSuppressions } from 'cdk-nag';
 import { Construct } from 'constructs';
+import { BaseClass, BaseClassProps } from '../../../common/base-class';
 import { buildDockerLambdaFunction } from '../../../common/helpers/lambda-builder-helper';
 import * as s3_bucket_helper from '../../../common/helpers/s3-bucket-helper';
-import { version, lambdaMemorySizeLimiter } from '../../../common/helpers/utils';
+import { lambdaMemorySizeLimiter } from '../../../common/helpers/utils';
 import * as vpc_helper from '../../../common/helpers/vpc-helper';
 import { DockerLambdaCustomProps } from '../../../common/props/DockerLambdaCustomProps';
 
@@ -127,7 +128,7 @@ export interface ContentGenerationAppSyncLambdaProps {
 /**
  * @summary The ContentGenerationAppSyncLambda class.
  */
-export class ContentGenerationAppSyncLambda extends Construct {
+export class ContentGenerationAppSyncLambda extends BaseClass {
   /**
    * Returns the instance of ec2.IVpc used by the construct
    */
@@ -170,27 +171,16 @@ export class ContentGenerationAppSyncLambda extends Construct {
   constructor(scope: Construct, id: string, props: ContentGenerationAppSyncLambdaProps) {
     super(scope, id);
 
-    // stage
-    let stage = '-dev';
-    if (props?.stage) {
-      stage = props.stage;
-    }
-
-    // observability
-    let lambda_tracing = lambda.Tracing.ACTIVE;
-    let enable_xray = true;
-    let api_log_config = {
-      fieldLogLevel: appsync.FieldLogLevel.ALL,
-      retention: logs.RetentionDays.TEN_YEARS,
+    const baseProps: BaseClassProps={
+      stage: props.stage,
+      enableOperationalMetric: props.enableOperationalMetric,
+      constructorName: this.constructor.name,
+      constructId: id,
+      observability: props.observability,
     };
-    if (props.observability == false) {
-      enable_xray = false;
-      lambda_tracing = lambda.Tracing.DISABLED;
-      api_log_config = {
-        fieldLogLevel: appsync.FieldLogLevel.NONE,
-        retention: logs.RetentionDays.TEN_YEARS,
-      };
-    }
+
+    this.updateEnvSuffix(baseProps);
+    this.addObservabilityToConstruct(baseProps);
 
     vpc_helper.CheckVpcProps(props);
     s3_bucket_helper.CheckS3Props({
@@ -211,7 +201,7 @@ export class ContentGenerationAppSyncLambda extends Construct {
       this.securityGroup = new ec2.SecurityGroup(this, 'securityGroup', {
         vpc: this.vpc,
         allowAllOutbound: true,
-        securityGroupName: 'securityGroup' + stage,
+        securityGroupName: 'securityGroup' + this.stage,
       });
     }
 
@@ -230,7 +220,7 @@ export class ContentGenerationAppSyncLambda extends Construct {
     // bucket for storing server access logging
     const serverAccessLogBucket = new s3.Bucket(
       this,
-      'serverAccessLogBucket' + stage,
+      'serverAccessLogBucket' + this.stage,
       {
         blockPublicAccess: s3.BlockPublicAccess.BLOCK_ALL,
         encryption: s3.BucketEncryption.S3_MANAGED,
@@ -250,10 +240,10 @@ export class ContentGenerationAppSyncLambda extends Construct {
     if (!props.existingGeneratedAssetsBucketObj) {
       let tmpBucket: s3.Bucket;
       if (!props.generatedAssetsBucketProps) {
-        tmpBucket = new s3.Bucket(this, 'generatedAssetsBucket' + stage, {
+        tmpBucket = new s3.Bucket(this, 'generatedAssetsBucket' + this.stage, {
           blockPublicAccess: s3.BlockPublicAccess.BLOCK_ALL,
           encryption: s3.BucketEncryption.S3_MANAGED,
-          bucketName: 'generated-asset-bucket' + stage + '-' + Aws.ACCOUNT_ID,
+          bucketName: 'generated-asset-bucket' + this.stage + '-' + Aws.ACCOUNT_ID,
           serverAccessLogsBucket: serverAccessLogBucket,
           enforceSSL: true,
           versioned: true,
@@ -266,7 +256,7 @@ export class ContentGenerationAppSyncLambda extends Construct {
       } else {
         tmpBucket = new s3.Bucket(
           this,
-          'generatedAssetsBucket' + stage,
+          'generatedAssetsBucket' + this.stage,
           props.generatedAssetsBucketProps,
         );
       }
@@ -284,7 +274,7 @@ export class ContentGenerationAppSyncLambda extends Construct {
       this,
       'generateImageGraphqlApi',
       {
-        name: 'generateImageGraphqlApi' + stage,
+        name: 'generateImageGraphqlApi' + this.stage,
         definition: appsync.Definition.fromFile(
           path.join(
             __dirname,
@@ -302,8 +292,11 @@ export class ContentGenerationAppSyncLambda extends Construct {
             },
           ],
         },
-        xrayEnabled: enable_xray,
-        logConfig: api_log_config,
+        xrayEnabled: this.enablexray,
+        logConfig: {
+          fieldLogLevel: this.fieldLogLevel,
+          retention: this.retention,
+        },
       },
     );
 
@@ -345,9 +338,9 @@ export class ContentGenerationAppSyncLambda extends Construct {
     if (!props.existingBusInterface) {
       this.generatedImageBus = new events.EventBus(
         this,
-        'generateImageEventBus' + stage,
+        'generateImageEventBus' + this.stage,
         {
-          eventBusName: 'generateImageEventBus' + stage,
+          eventBusName: 'generateImageEventBus' + this.stage,
         },
       );
     } else {
@@ -356,10 +349,10 @@ export class ContentGenerationAppSyncLambda extends Construct {
 
     // create httpdatasource with generate_image_graphql_api
     const event_bridge_datasource = this.graphqlApi.addEventBridgeDataSource(
-      'generateImageEventBridgeDataSource' + stage,
+      'generateImageEventBridgeDataSource' + this.stage,
       this.generatedImageBus,
       {
-        name: 'generateImageEventBridgeDataSource' + stage,
+        name: 'generateImageEventBridgeDataSource' + this.stage,
       },
     );
 
@@ -488,10 +481,10 @@ export class ContentGenerationAppSyncLambda extends Construct {
           '../../../../lambda/aws-contentgen-appsync-lambda/src',
         ),
       ),
-      functionName: 'lambda_generate_image' + stage,
+      functionName: 'lambda_generate_image' + this.stage,
       description: 'Lambda function for generating image',
       vpc: this.vpc,
-      tracing: lambda_tracing,
+      tracing: this.lambdaTracing,
       vpcSubnets: { subnetType: ec2.SubnetType.PRIVATE_WITH_EGRESS },
       securityGroups: [this.securityGroup],
       memorySize: lambdaMemorySizeLimiter(this, 1_769 * 4),
@@ -510,23 +503,16 @@ export class ContentGenerationAppSyncLambda extends Construct {
     };
 
     const generate_image_function = buildDockerLambdaFunction(this,
-      'lambda_content_generation' + stage,
+      'lambda_content_generation' + this.stage,
       construct_docker_lambda_props,
       props.customDockerLambdaProps,
     );
 
     generate_image_function.currentVersion;
 
-    const enableOperationalMetric =
-      props.enableOperationalMetric !== undefined && props.enableOperationalMetric !== null ? props.enableOperationalMetric : true;
+    const lambdaFunctions=[generate_image_function];
+    this.updateConstructTrackingCode( baseProps, scope, lambdaFunctions);
 
-    if (enableOperationalMetric) {
-      const solutionId = `genai_cdk_${version}/${this.constructor.name}/${id}`;
-      generate_image_function.addEnvironment(
-        'AWS_SDK_UA_APP_ID',
-        solutionId,
-      );
-    }
 
     // Add GraphQl permissions to the IAM role for the Lambda function
     generate_image_function.addToRolePolicy(
@@ -575,7 +561,7 @@ export class ContentGenerationAppSyncLambda extends Construct {
       ),
     });
 
-    const rule = new events.Rule(this, 'textToImageRule' + stage, {
+    const rule = new events.Rule(this, 'textToImageRule' + this.stage, {
       description: 'Rule to trigger textToImage function',
       eventBus: this.generatedImageBus,
       eventPattern: {