feat(sdk): add SDK version to AWS Lambda client user agent (#440)

Include SDK version in the Lambda client's customUserAgent to enable better
    debugging visibility. This allows cross-referencing SDK versions with API
    request IDs when troubleshooting issues.
    
    The version and package name are injected at build time by Rollup from
    package.json using environment variable replacement.
    
    Changes:
    - Add NPM_PACKAGE_NAME to Rollup replace plugin
    - Use process.env.NPM_PACKAGE_NAME and process.env.NPM_PACKAGE_VERSION
    - Configure LambdaClient with customUserAgent including SDK name and version
    - Update tests to use process.env constants
    - Rollup replaces these at build time with actual values from package.json

Author: ParidelPooya

packages/aws-durable-execution-sdk-js/src/durable-execution-api-client/durable-execution-api-client-caching.test.ts

@@ -1,5 +1,6 @@
 import { LambdaClient } from "@aws-sdk/client-lambda";
 import { DurableExecutionApiClient } from "./durable-execution-api-client";
+import { SDK_NAME, SDK_VERSION } from "../utils/constants/version";
 
 // Mock the LambdaClient
 jest.mock("@aws-sdk/client-lambda", () => {
@@ -49,6 +50,7 @@ describe("DurableExecutionApiClient Caching", () => {
 
     // Verify the constructor was called with correct configuration
     expect(LambdaClient).toHaveBeenCalledWith({
+      customUserAgent: [[SDK_NAME, SDK_VERSION]],
       requestHandler: {
         connectionTimeout: 5000,
         socketTimeout: 50000,

packages/aws-durable-execution-sdk-js/src/durable-execution-api-client/durable-execution-api-client.test.ts

@@ -10,6 +10,7 @@ import { OperationSubType } from "../types";
 import { log } from "../utils/logger/logger";
 import { DurableExecutionApiClient } from "./durable-execution-api-client";
 import { DurableExecutionClient } from "../types/durable-execution";
+import { SDK_NAME, SDK_VERSION } from "../utils/constants/version";
 
 // Mock the logger
 jest.mock("../utils/logger/logger", () => ({
@@ -46,6 +47,7 @@ describe("ApiStorage", () => {
 
     // Verify that LambdaClient was constructed with the correct default configuration
     expect(LambdaClient).toHaveBeenCalledWith({
+      customUserAgent: [[SDK_NAME, SDK_VERSION]],
       requestHandler: {
         connectionTimeout: 5000,
         socketTimeout: 50000,

packages/aws-durable-execution-sdk-js/src/durable-execution-api-client/durable-execution-api-client.ts

@@ -10,6 +10,7 @@ import {
 import { DurableExecutionClient } from "../types/durable-execution";
 import { log } from "../utils/logger/logger";
 import { DurableLogger } from "../types/durable-logger";
+import { SDK_NAME, SDK_VERSION } from "../utils/constants/version";
 
 let defaultLambdaClient: LambdaClient | undefined;
 
@@ -27,6 +28,7 @@ export class DurableExecutionApiClient implements DurableExecutionClient {
     if (!client) {
       if (!defaultLambdaClient) {
         defaultLambdaClient = new LambdaClient({
+          customUserAgent: [[SDK_NAME, SDK_VERSION]],
           requestHandler: {
             connectionTimeout: 5000,
             socketTimeout: 50000,

packages/aws-durable-execution-sdk-js/src/utils/constants/version.ts

@@ -0,0 +1,14 @@
+/**
+ * SDK metadata injected by Rollup at build time from package.json.
+ *
+ * At build time, Rollup replaces process.env.NPM_PACKAGE_NAME and
+ * process.env.NPM_PACKAGE_VERSION with actual values from package.json.
+ *
+ * Defaults are provided for test environments where Rollup doesn't run
+ * and process.env values are undefined.
+ *
+ * @internal
+ */
+export const SDK_NAME =
+  process.env.NPM_PACKAGE_NAME || "@aws/durable-execution-sdk-js";
+export const SDK_VERSION = process.env.NPM_PACKAGE_VERSION || "0.0.0";

rollup.config.js

@@ -34,6 +34,7 @@ export function createBuildOptions(options, mode, packageJson) {
         "process.env.IS_ESM": JSON.stringify(mode === "esm"),
         "process.env.NODE_ENV": JSON.stringify("production"),
         "process.env.NPM_PACKAGE_VERSION": JSON.stringify(packageJson.version),
+        "process.env.NPM_PACKAGE_NAME": JSON.stringify(packageJson.name),
       },
     }),
   ];