feat: Add release version to lambda conext for logging (#14)

* fix: add lambda version to context logging

* release tests

* release tests

* fix: Add lambda version to log context

* fix: Add lambda version to log context

* fix: Add lambda version to log context

* fix: Add lambda version to log context

* fix: Add lambda version to log context

* feat: Add lambda version to log context

Author: npalm

.github/workflows/release.yml

@@ -40,7 +40,8 @@ jobs:
         uses: googleapis/release-please-action@a02a34c4d625f9be7cb89156071d8567266a2445 # v4.2.0
         with:
           target-branch: ${{ steps.branch.outputs.name }}
-          release-type: terraform-module
+          manifest-file: .release-please-manifest.json
+          config-file: .release-please-config.json
           token: ${{ steps.token.outputs.token }}
       - name: Attest
         if: ${{ steps.release.outputs.releases_created == 'true' }}

.release-please-config.json

@@ -0,0 +1,34 @@
+{
+  "release-type": "simple",
+  "packages": {
+    ".": {
+      "extra-files": [
+        {
+          "type": "json",
+          "path": "lambdas/functions/ami-housekeeper/package.json",
+          "jsonpath": "$.version"
+        },
+        {
+          "type": "json",
+          "path": "lambdas/functions/control-plane/package.json",
+          "jsonpath": "$.version"
+        },
+        {
+          "type": "json",
+          "path": "lambdas/functions/gh-agent-syncer/package.json",
+          "jsonpath": "$.version"
+        },
+        {
+          "type": "json",
+          "path": "lambdas/functions/termination-watcher/package.json",
+          "jsonpath": "$.version"
+        },
+        {
+          "type": "json",
+          "path": "lambdas/functions/webhook/package.json",
+          "jsonpath": "$.version"
+        }
+      ]
+    }
+  }
+}

.release-please-manifest.json

@@ -0,0 +1,3 @@
+{
+  ".": "6.6.0"
+}

lambdas/libs/aws-powertools-util/src/logger/index.ts

@@ -1,17 +1,34 @@
 import { Logger } from '@aws-lambda-powertools/logger';
 import { Context } from 'aws-lambda';
+import * as fs from 'fs';
+import * as path from 'path';
+import { fileURLToPath } from 'url';
 
 const childLoggers: Logger[] = [];
 
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
+
 const defaultValues = {
   region: process.env.AWS_REGION,
   environment: process.env.ENVIRONMENT || 'N/A',
 };
 
+function getReleaseVersion(): string {
+  let version = 'unknown';
+  try {
+    const packageFilePath = path.resolve(__dirname, 'package.json');
+    version = JSON.parse(fs.readFileSync(packageFilePath, 'utf-8')).version || 'unknown';
+  } catch (error) {
+    logger.debug(`Failed to read package.json for version: ${(error as Error)?.message ?? 'Unknown error'}`);
+  }
+  return version;
+}
+
 function setContext(context: Context, module?: string) {
   logger.addPersistentLogAttributes({
     'aws-request-id': context.awsRequestId,
     'function-name': context.functionName,
+    version: getReleaseVersion(),
     module: module,
   });
 
@@ -20,6 +37,7 @@ function setContext(context: Context, module?: string) {
     childLogger.addPersistentLogAttributes({
       'aws-request-id': context.awsRequestId,
       'function-name': context.functionName,
+      version: getReleaseVersion(),
     });
   });
 }

lambdas/libs/aws-powertools-util/src/logger/logger.test.ts

@@ -1,7 +1,8 @@
 import { Context } from 'aws-lambda';
+import * as fs from 'fs';
+import * as path from 'path';
 
-import { logger, setContext } from '../';
-import { describe, test, expect, beforeEach, vi } from 'vitest';
+import { describe, test, expect, beforeEach, afterEach, vi } from 'vitest';
 
 beforeEach(() => {
   vi.clearAllMocks();
@@ -29,6 +30,31 @@ const context: Context = {
   },
 };
 
+const versionFilePath = path.resolve(__dirname, 'version.json');
+
+let logger: typeof import('../').logger;
+let setContext: typeof import('../').setContext;
+
+beforeEach(async () => {
+  // Clear the module cache and reload the logger module
+  vi.resetModules();
+  const loggerModule = await import('../');
+  logger = loggerModule.logger;
+  setContext = loggerModule.setContext;
+
+  // Ensure a clean state before each test
+  if (fs.existsSync(versionFilePath)) {
+    fs.unlinkSync(versionFilePath);
+  }
+});
+
+afterEach(() => {
+  // Clean up after each test
+  if (fs.existsSync(versionFilePath)) {
+    fs.unlinkSync(versionFilePath);
+  }
+});
+
 describe('A root logger.', () => {
   test('Should log set context.', async () => {
     setContext(context, 'unit-test');
@@ -42,3 +68,52 @@ describe('A root logger.', () => {
     );
   });
 });
+
+describe('Logger version handling', () => {
+  test('Should not fail if package.json does not exist', () => {
+    const packageFilePath = path.resolve(__dirname, 'package.json');
+
+    // Temporarily rename package.json to simulate its absence
+    const tempFilePath = `${packageFilePath}.bak`;
+    if (fs.existsSync(packageFilePath)) {
+      fs.renameSync(packageFilePath, tempFilePath);
+    }
+
+    setContext(context, 'unit-test');
+
+    expect(logger.getPersistentLogAttributes()).toEqual(
+      expect.objectContaining({
+        version: 'unknown',
+      }),
+    );
+
+    // Restore package.json
+    if (fs.existsSync(tempFilePath)) {
+      fs.renameSync(tempFilePath, packageFilePath);
+    }
+  });
+
+  test('Should log version from package.json', () => {
+    const packageFilePath = path.resolve(__dirname, 'package.json');
+
+    // Create a mock package.json file
+    const originalPackageData = fs.existsSync(packageFilePath) ? fs.readFileSync(packageFilePath, 'utf-8') : null;
+    const mockPackageData = JSON.stringify({ version: '1.0.0' });
+    fs.writeFileSync(packageFilePath, mockPackageData);
+
+    setContext(context, 'unit-test');
+
+    expect(logger.getPersistentLogAttributes()).toEqual(
+      expect.objectContaining({
+        version: '1.0.0',
+      }),
+    );
+
+    // Restore the original package.json file
+    if (originalPackageData) {
+      fs.writeFileSync(packageFilePath, originalPackageData);
+    } else {
+      fs.unlinkSync(packageFilePath);
+    }
+  });
+});