Merge pull request #1116 from aligent/release/v4.1.0

Release/v4.1.0

Author: tvhees

.github/instructions/nx.instructions.md

@@ -0,0 +1,40 @@
+---
+applyTo: '**'
+---
+
+// This file is automatically generated by Nx Console
+
+You are in an nx workspace using Nx 21.3.11 and yarn as the package manager.
+
+You have access to the Nx MCP server and the tools it provides. Use them. Follow these guidelines in order to best help the user:
+
+# General Guidelines
+- When answering questions, use the nx_workspace tool first to gain an understanding of the workspace architecture
+- For questions around nx configuration, best practices or if you're unsure, use the nx_docs tool to get relevant, up-to-date docs!! Always use this instead of assuming things about nx configuration
+- If the user needs help with an Nx configuration or project graph error, use the 'nx_workspace' tool to get any errors
+- To help answer questions about the workspace structure or simply help with demonstrating how tasks depend on each other, use the 'nx_visualize_graph' tool
+
+# Generation Guidelines
+If the user wants to generate something, use the following flow:
+
+- learn about the nx workspace and any specifics the user needs by using the 'nx_workspace' tool and the 'nx_project_details' tool if applicable
+- get the available generators using the 'nx_generators' tool
+- decide which generator to use. If no generators seem relevant, check the 'nx_available_plugins' tool to see if the user could install a plugin to help them
+- get generator details using the 'nx_generator_schema' tool
+- you may use the 'nx_docs' tool to learn more about a specific generator or technology if you're unsure
+- decide which options to provide in order to best complete the user's request. Don't make any assumptions and keep the options minimalistic
+- open the generator UI using the 'nx_open_generate_ui' tool
+- wait for the user to finish the generator
+- read the generator log file using the 'nx_read_generator_log' tool
+- use the information provided in the log file to answer the user's question or continue with what they were doing
+
+# Running Tasks Guidelines
+If the user wants help with tasks or commands (which include keywords like "test", "build", "lint", or other similar actions), use the following flow:
+- Use the 'nx_current_running_tasks_details' tool to get the list of tasks (this can include tasks that were completed, stopped or failed).
+- If there are any tasks, ask the user if they would like help with a specific task then use the 'nx_current_running_task_output' tool to get the terminal output for that task/command
+- Use the terminal output from 'nx_current_running_task_output' to see what's wrong and help the user fix their problem. Use the appropriate tools if necessary
+- If the user would like to rerun the task or command, always use `nx run <taskId>` to rerun in the terminal. This will ensure that the task will run in the nx context and will be run the same way it originally executed
+- If the task was marked as "continuous" do not offer to rerun the task. This task is already running and the user can see the output in the terminal. You can use 'nx_current_running_task_output' to get the output of the task to verify the output. 
+
+
+

README.md

@@ -69,6 +69,22 @@ yarn nx g service test-app --type=general
 # Will create a project called @services/test-app in the services/ folder
 ```
 
+Newly added service may not be detected by Nx immediately. You will need to update lockfile then reset Nx cache & stop its daemon and update Nx’s internal dependency graph and ensure your workspace is in sync.
+
+```bash
+# Update lockfile
+yarn install
+
+# Reset Nx cache and stop the daemon
+yarn nx reset
+
+# Update Nx's internal dependency graph and ensure workspace is in sync
+yarn nx sync
+
+# Alternatively, you can combine them into one line
+yarn install && yarn nx reset && yarn nx sync
+```
+
 Import and instantiate the service in `ApplicationStage` inside `applications/core/bin/main.ts`:
 
 ```typescript
@@ -91,8 +107,6 @@ class ApplicationStage extends Stage {
 }
 ```
 
-Note: You will need to run `yarn install` and `yarn nx sync` before other projects will detect the new service
-
 ---
 
 ### 🧪 Testing the application
@@ -161,6 +175,7 @@ yarn nx g remove <service-name>
 
 You may need to remove imports of the service from the application first.
 You may need to remove references to the service in `nx.json` afterwards.
+You may need to run `yarn install` to remove the service reference from the lock file.
 
 ### 🧪 Testing with Mock Services
 

applications/core/bin/main.ts

@@ -4,7 +4,7 @@ import {
     NodeJsFunctionDefaultsInjector,
     StepFunctionDefaultsInjector,
     VersionFunctionsAspect,
-} from '@libs/cdk-utils';
+} from '@libs/cdk-utils/infra';
 import { App, Aspects, Duration, Stage, Tags, type StageProps } from 'aws-cdk-lib';
 import { Architecture, Runtime } from 'aws-cdk-lib/aws-lambda';
 import type { Construct } from 'constructs';
@@ -48,11 +48,7 @@ new ApplicationStage(app, 'dev', {
     propertyInjectors: [
         // NOTE: Property Injectors will only apply ONCE each, so adding one here
         // overrides the same injector at the app level
-        new NodeJsFunctionDefaultsInjector({
-            sourceMap: false,
-            esm: true,
-            minify: false,
-        }).withProps({
+        new NodeJsFunctionDefaultsInjector({ sourceMap: false }).withProps({
             timeout: Duration.seconds(6),
             memorySize: 192,
             runtime: Runtime.NODEJS_22_X,

libs/cdk-utils/package.json

@@ -3,11 +3,6 @@
   "version": "0.0.1",
   "type": "module",
   "exports": {
-    ".": {
-      "types": "./src/index.ts",
-      "import": "./src/index.ts",
-      "default": "./src/index.ts"
-    },
     "./infra": {
       "types": "./src/infra.ts",
       "import": "./src/infra.ts"
@@ -19,5 +14,17 @@
     "./package.json": "./package.json"
   },
   "main": "./src/index.ts",
-  "types": "./src/index.ts"
+  "types": "./src/index.ts",
+  "nx": {
+    "targets": {
+      "build": {
+        "executor": "nx:run-commands",
+        "options": {
+          "command": "tsc --build tsconfig.lib.json",
+          "color": true,
+          "cwd": "{projectRoot}"
+        }
+      }
+    }
+  }
 }

libs/cdk-utils/src/infra.ts

@@ -1,3 +1,5 @@
 /* v8 ignore start */
+export * from './lib/aspects';
 export * from './lib/constructs';
+export * from './lib/injectors';
 export * from './lib/rules/microservice-checks';

libs/cdk-utils/src/lib/injectors/nodejs-function-defaults-injector.test.ts

@@ -66,22 +66,13 @@ describe('NodeJsFunctionDefaultsInjector', () => {
     });
 
     test('merges bundling and environment properties correctly', () => {
-        PropertyInjectors.of(stack).add(
-            new NodeJsFunctionDefaultsInjector({
-                sourceMap: false,
-                esm: true,
-                minify: false,
-            })
-        );
+        // Sourcemaps would normally be false in 'dev' configuration
+        PropertyInjectors.of(stack).add(new NodeJsFunctionDefaultsInjector({ sourceMap: true }));
 
         new NodejsFunction(stack, 'TestFunction', {
             runtime: Runtime.NODEJS_22_X,
             handler: 'index.handler',
             code: Code.fromInline('exports.handler = async () => ({ statusCode: 200 });'),
-            bundling: {
-                // Sourcemaps would normally be false in 'dev' configuration
-                sourceMap: true,
-            },
             environment: {
                 BUCKET_NAME: 'test-bucket',
             },

libs/cdk-utils/src/lib/injectors/nodejs-function-defaults-injector.ts

@@ -1,30 +1,8 @@
 import { type InjectionContext, type IPropertyInjector } from 'aws-cdk-lib';
 import { Runtime, Tracing } from 'aws-cdk-lib/aws-lambda';
-import {
-    NodejsFunction,
-    OutputFormat,
-    type NodejsFunctionProps,
-} from 'aws-cdk-lib/aws-lambda-nodejs';
+import { NodejsFunction, type NodejsFunctionProps } from 'aws-cdk-lib/aws-lambda-nodejs';
 import { logInjector } from './log-injector';
 
-/**
- * ESM support banner
- *
- * This is a workaround to support ESM in Lambda functions.
- * Aliases are used to avoid name conflicts, this may not be a real issue
- *
- * @see https://github.com/evanw/esbuild/issues/1944
- * @see https://aws.plainenglish.io/significantly-improve-typescript-lambda-function-readability-in-aws-console-613bc5ae98f6
- */
-const ESM_SUPPORT_BANNER = [
-    `import { fileURLToPath } from 'url';`,
-    `import { createRequire as topLevelCreateRequire } from 'module';`,
-    `import { dirname as ddirname } from 'path';`,
-    `const require = topLevelCreateRequire(import.meta.url);`,
-    `const __filename = fileURLToPath(import.meta.url);`,
-    `const __dirname = ddirname(__filename);`,
-].join(''); // Must be a single line, if the banner has `\n` characters they cause a syntax error
-
 /**
  * Property injector for Node.js Lambda functions with configuration-aware defaults
  *
@@ -66,23 +44,16 @@ export class NodeJsFunctionDefaultsInjector implements IPropertyInjector {
      *
      * @param configuration - Configuration identifier used to select appropriate defaults. Uses production defaults if not specified.
      * @param configuration.sourceMap - Whether to enable source maps.
-     * @param configuration.esm - Whether to enable ESM support.
-     * @param configuration.minify - Whether to enable minification.
      */
     constructor(
         private readonly configuration: {
             sourceMap: boolean;
-            esm: boolean;
-            minify: boolean;
         } = {
             sourceMap: true,
-            esm: true,
-            minify: true,
         }
     ) {
         this.defaultProps = {
             runtime: Runtime.NODEJS_22_X,
-            bundling: bundlingProperties(configuration),
             tracing: Tracing.ACTIVE,
         };
     }
@@ -100,8 +71,6 @@ export class NodeJsFunctionDefaultsInjector implements IPropertyInjector {
      * ```typescript
      * const customInjector = new NodeJsFunctionDefaultsInjector({
      *   sourceMaps: false,
-     *   esm: false,
-     *   minify: false,
      * })
      *   .withProps({
      *     timeout: Duration.minutes(5),
@@ -143,7 +112,7 @@ export class NodeJsFunctionDefaultsInjector implements IPropertyInjector {
         // If source maps are enabled in our bundling, add the required NODE_OPTIONS flag to the environment
         const environment = {
             ...props.environment,
-            ...(props.bundling?.sourceMap ? { NODE_OPTIONS: '--enable-source-maps' } : {}),
+            ...(this.configuration.sourceMap ? { NODE_OPTIONS: '--enable-source-maps' } : {}),
         };
 
         return {
@@ -152,37 +121,3 @@ export class NodeJsFunctionDefaultsInjector implements IPropertyInjector {
         };
     }
 }
-
-/**
- * Returns configuration-specific bundling properties for Lambda functions
- *
- * Provides optimized bundling configurations for different environments:
- * - 'dev': Fast builds for development (no minification, bundle analysis enabled)
- * - 'stg': Balanced configuration for staging
- * - Default: Production-optimized (minified, tree-shaking enabled)
- *
- * @param configuration - Configuration identifier to determine bundling strategy
- * @returns Bundling properties optimized for the specified configuration
- */
-function bundlingProperties({
-    sourceMap,
-    esm,
-    minify,
-}: {
-    sourceMap: boolean;
-    esm: boolean;
-    minify: boolean;
-}) {
-    return {
-        ...(sourceMap && { sourceMap: true }),
-        ...(esm && { format: OutputFormat.ESM, banner: ESM_SUPPORT_BANNER }),
-        ...(minify && {
-            keepNames: true,
-            minify: true,
-            buildArgs: {
-                bundle: 'true',
-                treeShaking: 'true',
-            },
-        }),
-    };
-}

libs/cdk-utils/vite.config.mjs

@@ -1,14 +1,14 @@
 import { defineConfig, mergeConfig } from 'vitest/config';
 import { viteBaseConfig } from '../../vite.config.base.mjs';
 
-export default mergeConfig(
-    viteBaseConfig,
-    defineConfig({
-        cacheDir: '../../node_modules/.vite/cdk-utils',
-        test: {
-            environment: {
-                NODE_ENV: 'test',
+export default defineConfig(configEnv =>
+    mergeConfig(
+        viteBaseConfig(configEnv),
+        defineConfig({
+            cacheDir: '../../node_modules/.vite/cdk-utils',
+            test: {
+                env: { NODE_ENV: 'test' },
             },
-        },
-    })
+        })
+    )
 );

nx.json

@@ -36,8 +36,13 @@
             "dependsOn": ["^build"],
             "inputs": ["production", "^production"]
         },
+        "cdk": {
+            "dependsOn": ["^build"],
+            "inputs": ["production", "^production"]
+        },
         "pg": {
             "executor": "nx:run-commands",
+            "dependsOn": ["^build"],
             "options": {
                 "color": true,
                 "cwd": "{workspaceRoot}/applications/core"

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aligent/app",
-  "version": "4.0.0",
+  "version": "4.1.0",
   "description": "Aligent AWS microservices template using Typescript and AWS CDK",
   "author": "Aligent Consulting",
   "type": "module",
@@ -25,13 +25,13 @@
   ],
   "devDependencies": {
     "@aligent/ts-code-standards": "^4.0.2",
-    "@nx/devkit": "21.3.11",
-    "@nx/esbuild": "21.3.11",
-    "@nx/eslint": "21.3.11",
-    "@nx/eslint-plugin": "21.3.11",
-    "@nx/js": "21.3.11",
-    "@nx/vite": "21.3.11",
-    "@nx/web": "21.3.11",
+    "@nx/devkit": "21.4.0",
+    "@nx/esbuild": "21.4.0",
+    "@nx/eslint": "21.4.0",
+    "@nx/eslint-plugin": "21.4.0",
+    "@nx/js": "21.4.0",
+    "@nx/vite": "21.4.0",
+    "@nx/web": "21.4.0",
     "@swc-node/register": "^1.10.10",
     "@swc/core": "^1.13.3",
     "@swc/helpers": "^0.5.17",
@@ -49,16 +49,16 @@
     "esbuild-visualizer": "^0.7.0",
     "eslint": "^9.32.0",
     "eslint-config-prettier": "10.1.8",
+    "fast-glob": "^3.3.3",
     "jiti": "2.5.1",
     "jsonc-eslint-parser": "^2.4.0",
-    "nx": "21.3.11",
+    "nx": "21.4.0",
     "open": "^10.2.0",
     "prettier": "^3.6.2",
     "store-parameters": "^1.0.6",
     "tslib": "^2.8.1",
     "typescript": "~5.9.2",
     "vite": "6.3.5",
-    "vite-tsconfig-paths": "~4.3.2",
     "vitest": "^3.2.4"
   },
   "engines": {