@aligent/nx-cdk 0.0.1 → 0.1.0

package/src/generators/preset/files/application/_internal/microservice-checks.ts.template

@@ -1,58 +0,0 @@
-import { CfnResource } from 'aws-cdk-lib';
-import { NagMessageLevel, NagPack, rules, type NagPackProps } from 'cdk-nag';
-import type { IConstruct } from 'constructs';
-
-/**
- * Microservice Checks are a compilation of rules to validate infrastructure-as-code template
- * against recommended practices using the cdk-nag library.
- *
- * @see https://github.com/cdk-patterns/cdk-nag/
- *
- * @example
- * const app = new App();
- * const stack = new Stack(app, 'MyStack');
- * Aspects.of(stack).add(new MicroservicesChecks());
- */
-export class MicroserviceChecks extends NagPack {
-    constructor(props?: NagPackProps) {
-        super(props);
-        this.packName = 'Microservices';
-    }
-
-    public visit(node: IConstruct) {
-        if (node instanceof CfnResource) {
-            this.applyRule({
-                info: 'The Lambda function does not have an explicit memory value configured.',
-                explanation:
-                    "Lambda allocates CPU power in proportion to the amount of memory configured. By default, your functions have 128 MB of memory allocated. You can increase that value up to 10 GB. With more CPU resources, your Lambda function's duration might decrease.  You can use tools such as AWS Lambda Power Tuning to test your function at different memory settings to find the one that matches your cost and performance requirements the best.",
-                level: NagMessageLevel.ERROR,
-                rule: rules.lambda.LambdaDefaultMemorySize,
-                node: node,
-            });
-            this.applyRule({
-                info: 'The Lambda function does not have an explicitly defined timeout value.',
-                explanation:
-                    'Lambda functions have a default timeout of 3 seconds. If your timeout value is too short, Lambda might terminate invocations prematurely. On the other side, setting the timeout much higher than the average execution may cause functions to execute for longer upon code malfunction, resulting in higher costs and possibly reaching concurrency limits depending on how such functions are invoked. You can also use AWS Lambda Power Tuning to test your function at different timeout settings to find the one that matches your cost and performance requirements the best.',
-                level: NagMessageLevel.ERROR,
-                rule: rules.lambda.LambdaDefaultTimeout,
-                node: node,
-            });
-            this.applyRule({
-                info: 'The Lambda function does not have tracing set to Tracing.ACTIVE.',
-                explanation:
-                    'When a Lambda function has ACTIVE tracing, Lambda automatically samples invocation requests, based on the sampling algorithm specified by X-Ray.',
-                level: NagMessageLevel.ERROR,
-                rule: rules.lambda.LambdaTracing,
-                node: node,
-            });
-            this.applyRule({
-                info: 'The CloudWatch Log Group does not have an explicit retention policy defined.',
-                explanation:
-                    'By default, logs are kept indefinitely and never expire. You can adjust the retention policy for each log group, keeping the indefinite retention, or choosing a retention period between one day and 10 years. For Lambda functions, this applies to their automatically created CloudWatch Log Groups.',
-                level: NagMessageLevel.ERROR,
-                rule: rules.cloudwatch.CloudWatchLogGroupRetentionPeriod,
-                node: node,
-            });
-        }
-    }
-}

package/src/generators/preset/files/application/_internal/nodejs-function-defaults-injector.ts.template

@@ -1,110 +0,0 @@
-import { type IPropertyInjector } from 'aws-cdk-lib';
-import { Runtime, Tracing } from 'aws-cdk-lib/aws-lambda';
-import { NodejsFunction, type NodejsFunctionProps } from 'aws-cdk-lib/aws-lambda-nodejs';
-
-interface Config {
-    runtime: Runtime;
-    sourceMap?: boolean;
-}
-
-/**
- * Property injector for Node.js Lambda functions with configuration-aware defaults
- *
- * Applies configuration-specific bundling and runtime settings to Lambda functions.
- * Different configurations can optimize for different priorities such as build speed,
- * bundle size, or debugging capabilities.
- *
- * @example
- * ```typescript
- * // Apply configuration-specific defaults
- * PropertyInjectors.of(scope).add(
- *   new NodeJsFunctionDefaultsInjector({
- *     sourceMaps: true,
- *     esm: true,
- *     minify: true,
- *   }).withProps({
- *     timeout: Duration.seconds(30),
- *     memorySize: 256,
- *   })
- * );
- *
- * // Functions automatically inherit configuration defaults
- * new Function(stack, 'MyFunction', {
- *   code: Code.fromAsset('src/lambda'),
- *   handler: 'index.handler',
- *   // bundling and runtime config applied automatically
- * });
- * ```
- *
- * @see https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_lambda_nodejs.NodejsFunction.html
- */
-export class NodeJsFunctionDefaultsInjector implements IPropertyInjector {
-    public readonly constructUniqueId = NodejsFunction.PROPERTY_INJECTION_ID;
-    private readonly config: Required<Config>;
-    private defaultProps: NodejsFunctionProps;
-
-    /**
-     * Creates a new NodeJsFunctionDefaultsInjector
-     *
-     * @param config - Configuration identifier used to select appropriate defaults. Uses production defaults if not specified.
-     */
-    constructor(config: Config) {
-        this.config = { ...config, sourceMap: config.sourceMap || true };
-        this.defaultProps = { runtime: config.runtime, tracing: Tracing.ACTIVE };
-    }
-
-    /**
-     * Creates a new injector instance with additional properties
-     *
-     * Returns a new injector that inherits the current configuration but includes
-     * additional properties that override the configuration defaults.
-     *
-     * @param props - Additional properties to merge with configuration defaults
-     * @returns A new injector instance with merged properties
-     *
-     * @example
-     * ```typescript
-     * const customInjector = new NodeJsFunctionDefaultsInjector({
-     *   sourceMaps: false,
-     * })
-     *   .withProps({
-     *     timeout: Duration.minutes(5),
-     *     memorySize: 1024,
-     *   });
-     * ```
-     *
-     * TODO: Provide a nice way to inherit global properties from previous injectors
-     */
-    public withProps(props: NodejsFunctionProps) {
-        const modifiedInjector = new NodeJsFunctionDefaultsInjector(this.config);
-        modifiedInjector.defaultProps = { ...this.defaultProps, ...props };
-        return modifiedInjector;
-    }
-
-    /**
-     * Injects configuration-appropriate defaults into Lambda function properties
-     *
-     * Merges configuration-specific defaults with user-provided properties,
-     * automatically configuring bundling options and runtime settings.
-     *
-     * @param originalProps - Properties provided when creating the function
-     * @returns Merged properties with injected defaults
-     */
-    public inject(originalProps: NodejsFunctionProps) {
-        // The NodeJsFunction constructor pre-sets runtime to 16.x or LATEST depending on feature flags
-        // We assume that using this injector means you want to standardise the runtime across all lambdas
-        const props = {
-            ...this.defaultProps,
-            ...originalProps,
-            runtime: this.defaultProps.runtime,
-        };
-
-        // If source maps are enabled in our bundling, add the required NODE_OPTIONS flag to the environment
-        const environment = {
-            ...props.environment,
-            ...(this.config.sourceMap ? { NODE_OPTIONS: '--enable-source-maps' } : {}),
-        };
-
-        return { ...props, environment };
-    }
-}

package/src/generators/preset/files/application/_internal/step-function-defaults-injector.ts.template

@@ -1,126 +0,0 @@
-import { type InjectionContext, type IPropertyInjector } from 'aws-cdk-lib';
-import { LogGroup } from 'aws-cdk-lib/aws-logs';
-import {
-    LogLevel,
-    StateMachine,
-    StateMachineType,
-    type StateMachineProps,
-} from 'aws-cdk-lib/aws-stepfunctions';
-import type { Construct } from 'constructs';
-
-type StepFunctionDefaults = Omit<StateMachineProps, 'definition' | 'definitionSubstitutions'>;
-
-/**
- * Property injector for Step Functions with configuration-aware defaults
- *
- * Applies configuration-specific settings to Step Functions. All configurations enable
- * X-Ray tracing by default for observability. For EXPRESS state machines, automatically
- * creates log groups and configures comprehensive logging.
- *
- * @example
- * ```typescript
- * // Apply configuration-specific defaults
- * PropertyInjectors.of(scope).add(
- *   new StepFunctionDefaultsInjector('dev').withProps({
- *     timeout: Duration.minutes(30),
- *   })
- * );
- *
- * // Step Functions automatically inherit defaults
- * new StateMachine(stack, 'MyWorkflow', {
- *   stateMachineType: StateMachineType.EXPRESS,
- *   definitionBody: DefinitionBody.fromFile('workflow.asl.yaml'),
- *   // tracing enabled and logging configured automatically for EXPRESS
- * });
- * ```
- *
- * @see https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions.StateMachine.html
- */
-export class StepFunctionDefaultsInjector implements IPropertyInjector {
-    public readonly constructUniqueId = StateMachine.PROPERTY_INJECTION_ID;
-    private readonly config: Record<string, never>;
-    private defaultProps: StateMachineProps;
-
-    /**
-     * Creates a new StepFunctionDefaultsInjector
-     *
-     * @param config - Configuration identifier (currently unused but maintained for consistency).
-     *                 All configurations enable tracing by default.
-     */
-    constructor(config: Record<string, never> = {}) {
-        this.config = { ...config };
-        this.defaultProps = { tracingEnabled: true };
-    }
-
-    /**
-     * Creates a new injector instance with additional properties
-     *
-     * Returns a new injector that inherits the current configuration but includes
-     * additional properties that override the configuration defaults.
-     *
-     * @param props - Additional properties to merge with configuration defaults
-     * @returns A new injector instance with merged properties
-     *
-     * @example
-     * ```typescript
-     * const customInjector = new StepFunctionDefaultsInjector('prod')
-     *   .withProps({
-     *     timeout: Duration.hours(1),
-     *     stateMachineName: 'custom-workflow',
-     *   });
-     * ```
-     */
-    public withProps(props: StateMachineProps) {
-        const modifiedInjector = new StepFunctionDefaultsInjector(this.config);
-        modifiedInjector.defaultProps = { ...this.defaultProps, ...props };
-        return modifiedInjector;
-    }
-
-    /**
-     * Injects configuration-appropriate defaults into Step Function properties
-     *
-     * Enables X-Ray tracing for all state machines. For EXPRESS state machines,
-     * automatically creates log groups and configures comprehensive logging.
-     *
-     * @param originalProps - Properties provided when creating the state machine
-     * @param context - CDK injection context containing construct information
-     * @returns Merged properties with injected defaults and logging configuration
-     */
-    public inject(originalProps: StateMachineProps, context: InjectionContext) {
-        // Prepare logging configuration for EXPRESS step functions
-        const logging = expressLogProperties(context.scope, context.id, originalProps);
-        return { ...this.defaultProps, ...originalProps, ...logging };
-    }
-}
-
-/**
- * Build the logging configuration for an express step function, respecting
- * existing logging configuration.
- *
- * @param machineScope - The scope of the step function.
- * @param machineId - The id of the step function.
- * @param props - The properties for the step function.
- * @returns The logging configuration for an express step function
- */
-function expressLogProperties(
-    machineScope: Construct,
-    machineId: string,
-    props: StepFunctionDefaults
-) {
-    if (props.stateMachineType !== StateMachineType.EXPRESS) {
-        return {};
-    }
-
-    // Create a new log group if one is not provided
-    const logGroup =
-        props.logs?.destination ?? new LogGroup(machineScope, `/aws/states/${machineId}`);
-
-    return {
-        logs: {
-            destination: logGroup,
-            level: LogLevel.ALL,
-            includeExecutionData: true,
-            ...props.logs,
-        },
-    };
-}

package/src/generators/preset/files/application/_internal/version-functions-aspect.ts.template

@@ -1,74 +0,0 @@
-import type { IAspect } from 'aws-cdk-lib';
-import { Function } from 'aws-cdk-lib/aws-lambda';
-import {
-    CfnStateMachineAlias,
-    CfnStateMachineVersion,
-    StateMachine,
-} from 'aws-cdk-lib/aws-stepfunctions';
-import { IConstruct } from 'constructs';
-
-/**
- * Aspect that automatically adds versioning and aliases to Lambda and Step Functions
- *
- * Visits all constructs in the scope and automatically creates versions and aliases
- * for supported resource types. This enables blue-green deployments, traffic shifting,
- * and provides stable ARNs for external integrations.
- *
- * Currently supports:
- * - Lambda Functions: Creates function aliases
- * - Step Functions: Creates versions and aliases with 100% traffic routing
- *
- * @example
- * ```typescript
- * // Apply to entire app for automatic versioning
- * Aspects.of(app).add(new VersionFunctionsAspect());
- *
- * // Or with custom alias name
- * Aspects.of(app).add(new VersionFunctionsAspect({ alias: 'PROD' }));
- * ```
- */
-export class VersionFunctionsAspect implements IAspect {
-    /**
-     * Creates a new VersionFunctionsAspect
-     *
-     * @param props - Configuration for the aspect
-     * @param props.alias - Name for the alias to create. Defaults to 'LATEST'
-     */
-    constructor(
-        private readonly props: {
-            alias: string;
-        } = {
-            alias: 'LATEST',
-        }
-    ) {}
-
-    /**
-     * Visits a construct and applies versioning if it's a supported resource type
-     *
-     * For Lambda Functions: Adds a function alias pointing to $LATEST
-     * For Step Functions: Creates a version and alias with 100% traffic routing
-     *
-     * @param node - The construct to potentially add versioning to
-     */
-    visit(node: IConstruct): void {
-        if (node instanceof StateMachine) {
-            const version = new CfnStateMachineVersion(node, `Version`, {
-                stateMachineArn: node.stateMachineArn,
-            });
-
-            new CfnStateMachineAlias(node, `Alias`, {
-                name: this.props.alias,
-                routingConfiguration: [
-                    {
-                        stateMachineVersionArn: version.attrArn,
-                        weight: 100,
-                    },
-                ],
-            });
-        }
-
-        if (node instanceof Function) {
-            node.addAlias(this.props.alias);
-        }
-    }
-}

package/src/generators/preset/files/cdk-config.yml.template

@@ -1,16 +0,0 @@
-cdk-pipe:
-  commands:
-    cdk:
-      bootstrap: yarn nx run application:cdk bootstrap
-      deploy: yarn nx run application:cdk deploy
-      synth: yarn nx run application:cdk synth
-      diff: yarn nx run application:cdk diff
-    npm:
-      checks:
-        lint: yarn lint
-        format: yarn lint # Formatting is controlled by the lint step, we turn this off in the pipeline anyway
-      install: yarn install --immutable
-  beforeScripts:
-    - yarn --version
-  afterScripts:
-    - echo "Deployment is completed"