feat: Add release version to lambda conext for logging #4655

npalm · 2025-07-03T20:50:03Z

This pull request introduces changes to improve release management and enhance the lambda's loggin.

Release updates lambda package.json file with the release version in the release PR. See example: cloud-scouts#15

The version of the lambda is added to the log context.
(diffhunk://#diff-8e1eeb7f895c1c12c548abcc3b9bcf66106ea5366250af44a364db81b5384446R40)`)

* 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

npalm · 2025-07-03T20:53:00Z

.release-please-manifest.json

This file is mandatory when using a release manifest

npalm · 2025-07-03T20:53:34Z

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

 const defaultValues = {
  region: process.env.AWS_REGION,
  environment: process.env.ENVIRONMENT || 'N/A',
 };

+function getReleaseVersion(): string {
+  let version = 'unknown';
+  try {


Inention is here to avoid an excetion can crash the lambda.

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

Copilot

Pull Request Overview

This PR adds release version management by reading the package.json version in the logger and propagating it into the AWS Lambda log context, and configures the release-please action to update that version across multiple Lambda packages.

Introduce getReleaseVersion() in the logger to read and persist the version attribute.
Add tests covering missing and present package.json scenarios for the logger.
Configure .release-please-manifest.json, .release-please-config.json, and update the release workflow to bump versions.

Reviewed Changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
lambdas/libs/aws-powertools-util/src/logger/index.ts	Added `getReleaseVersion()` and included `version` in log context
lambdas/libs/aws-powertools-util/src/logger/logger.test.ts	Added tests and file setup/cleanup for version handling
.release-please-manifest.json	Added manifest file to pin root package version for releases
.release-please-config.json	Configured extra-files paths for all Lambda package versions
.github/workflows/release.yml	Updated Release-Please action to use the new manifest and config

Comments suppressed due to low confidence (1)

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

The variable packageFilePath is undefined in this context. It should be replaced with versionFilePath to read the mock package.json correctly.

    const originalPackageData = fs.existsSync(versionFilePath) ? fs.readFileSync(packageFilePath, 'utf-8') : null;

Copilot · 2025-07-04T05:59:09Z

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

+}
+
 function setContext(context: Context, module?: string) {
  logger.addPersistentLogAttributes({
    'aws-request-id': context.awsRequestId,
    'function-name': context.functionName,
+    version: getReleaseVersion(),


[nitpick] Calling getReleaseVersion() on every invocation performs synchronous file I/O repeatedly. Consider reading and caching the version once at module load to avoid repeated filesystem access.

Suggested change

}

function setContext(context: Context, module?: string) {

logger.addPersistentLogAttributes({

'aws-request-id': context.awsRequestId,

'function-name': context.functionName,

version: getReleaseVersion(),

})();

function setContext(context: Context, module?: string) {

logger.addPersistentLogAttributes({

'aws-request-id': context.awsRequestId,

'function-name': context.functionName,

version: releaseVersion,

Looks a good catch, but as far I know the context is only called once via pwoertools.

Seems like a fair defensive thing to do,

let releaseVersion: string | null = null; function setContext(context: Context, module?: string) { if (releaseVersion === null) { releaseVersion = getReleaseVersion(); } // ... }

but yeah probably minor, does look like it's only called once per function.

iainlane · 2025-07-06T14:57:16Z

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

@@ -20,6 +37,7 @@ function setContext(context: Context, module?: string) {
    childLogger.addPersistentLogAttributes({


This isn't new in this PR so doesn't matter for the review, but it caught my eye... Why do we have to store the child loggers? Should be possible to arrange that only the root logger is ever seen and so we don't need to repeat the attribute addition, right?

iainlane · 2025-07-06T15:11:07Z

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

+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);
+  }
+});


I'd be a bit concerned about messing with the real package.json file here, what happens if tests get run in parallel, and the reinitialisaion which seems complex. I would consider doing this with dependency injection. Make getReleaseVersion() take a directory, like this:

function getReleaseVersion(packageDir: string = __dirname): string { // ... }

and then each test could make its own temp dir and set it up how it wants.

It would make sense to still have one integration test which uses the real file under __dirname, to ensure that there's always a version set in there.

iainlane · 2025-07-06T15:14:32Z

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

+}
+
 function setContext(context: Context, module?: string) {
  logger.addPersistentLogAttributes({
    'aws-request-id': context.awsRequestId,
    'function-name': context.functionName,
+    version: getReleaseVersion(),


Seems like a fair defensive thing to do,

let releaseVersion: string | null = null; function setContext(context: Context, module?: string) { if (releaseVersion === null) { releaseVersion = getReleaseVersion(); } // ... }

but yeah probably minor, does look like it's only called once per function.

npalm requested review from a team as code owners July 3, 2025 20:50

npalm requested review from koendelaat and rjaegers July 3, 2025 20:50

npalm commented Jul 3, 2025

View reviewed changes

.release-please-manifest.json Outdated

Copy link

Member Author

npalm Jul 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This file is mandatory when using a release manifest

npalm commented Jul 3, 2025

View reviewed changes

npalm changed the title ~~feat: Add release version to lambda conext for logging (#14)~~ feat: Add release version to lambda conext for logging Jul 3, 2025

koendelaat reviewed Jul 4, 2025

View reviewed changes

lambdas/libs/aws-powertools-util/src/logger/logger.test.ts Outdated Show resolved Hide resolved

npalm and others added 2 commits July 4, 2025 07:49

Update logger.test.ts

623e9ad

clean-up vibe coding collaterals

d7b0898

npalm requested review from Copilot and koendelaat July 4, 2025 05:58

Copilot AI reviewed Jul 4, 2025

View reviewed changes

koendelaat approved these changes Jul 4, 2025

View reviewed changes

iainlane reviewed Jul 6, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat: Add release version to lambda conext for logging #4655

feat: Add release version to lambda conext for logging #4655

npalm commented Jul 3, 2025

Uh oh!

npalm Jul 3, 2025

Uh oh!

npalm Jul 3, 2025

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Jul 4, 2025

Uh oh!

npalm Jul 4, 2025

Uh oh!

iainlane Jul 6, 2025

Uh oh!

iainlane Jul 6, 2025

Uh oh!

iainlane Jul 6, 2025

Uh oh!

iainlane Jul 6, 2025

Uh oh!

Uh oh!

		@@ -20,6 +37,7 @@ function setContext(context: Context, module?: string) {
		childLogger.addPersistentLogAttributes({

feat: Add release version to lambda conext for logging #4655

Are you sure you want to change the base?

feat: Add release version to lambda conext for logging #4655

Conversation

npalm commented Jul 3, 2025

Uh oh!

npalm Jul 3, 2025

Choose a reason for hiding this comment

Uh oh!

npalm Jul 3, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Jul 4, 2025

Choose a reason for hiding this comment

Uh oh!

npalm Jul 4, 2025

Choose a reason for hiding this comment

Uh oh!

iainlane Jul 6, 2025

Choose a reason for hiding this comment

Uh oh!

iainlane Jul 6, 2025

Choose a reason for hiding this comment

Uh oh!

iainlane Jul 6, 2025

Choose a reason for hiding this comment

Uh oh!

iainlane Jul 6, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!