@aws-sdk/find-v2 0.5.0 → 0.6.1

package/README.md

@@ -33,17 +33,17 @@ Run `lambda` command to scan Lambda Node.js Functions for JavaScript SDK v2.
 
 ```console
 $ npx @aws-sdk/find-v2 lambda --yes --output table
-┌─────────────────────────────────────────┬───────────┬────────────┬────────────────────────────────────────────────┐
-│ FunctionName                            │ Region    │ Runtime    │ ContainsAwsSdkJsV2                             │
-├─────────────────────────────────────────┼───────────┼────────────┼────────────────────────────────────────────────┤
-│ fn-without-aws-sdk-in-bundle            │ us-east-2 │ nodejs24.x │ No.                                            │
-├─────────────────────────────────────────┼───────────┼────────────┼────────────────────────────────────────────────┤
-│ fn-with-aws-sdk-in-bundle               │ us-east-2 │ nodejs24.x │ Yes. Bundled in 'index.js'                     │
-├─────────────────────────────────────────┼───────────┼────────────┼────────────────────────────────────────────────┤
-│ fn-with-aws-sdk-in-package-json-deps    │ us-east-2 │ nodejs24.x │ Yes. Defined in dependencies of 'package.json' │
-├─────────────────────────────────────────┼───────────┼────────────┼────────────────────────────────────────────────┤
-│ fn-without-aws-sdk-in-package-json-deps │ us-east-2 │ nodejs24.x │ No.                                            │
-└─────────────────────────────────────────┴───────────┴────────────┴────────────────────────────────────────────────┘
+┌─────────────────────────────────────────┬───────────┬────────────┬────────────┬────────────────────────────────────────────────┐
+│ FunctionName                            │ Region    │ Runtime    │ SdkVersion │ ContainsAwsSdkJsV2                             │
+├─────────────────────────────────────────┼───────────┼────────────┼────────────┼────────────────────────────────────────────────┤
+│ fn-without-aws-sdk-in-bundle            │ us-east-2 │ nodejs24.x │ >=2.0.0    │ No.                                            │
+├─────────────────────────────────────────┼───────────┼────────────┼────────────┼────────────────────────────────────────────────┤
+│ fn-with-aws-sdk-in-bundle               │ us-east-2 │ nodejs24.x │ >=2.0.0    │ Yes. Bundled in 'index.js'                     │
+├─────────────────────────────────────────┼───────────┼────────────┼────────────┼────────────────────────────────────────────────┤
+│ fn-with-aws-sdk-in-package-json-deps    │ us-east-2 │ nodejs24.x │ >=2.0.0    │ Yes. Defined in dependencies of 'package.json' │
+├─────────────────────────────────────────┼───────────┼────────────┼────────────┼────────────────────────────────────────────────┤
+│ fn-without-aws-sdk-in-package-json-deps │ us-east-2 │ nodejs24.x │ >=2.0.0    │ No.                                            │
+└─────────────────────────────────────────┴───────────┴────────────┴────────────┴────────────────────────────────────────────────┘
 ```
 
 This script requires AWS Managed Policy [AWSLambda_ReadOnlyAccess][].

package/dist/cli.js

@@ -29,6 +29,15 @@ export const createProgram = () => {
         }
         return value;
     }, ">=20")
+        .option("--sdk <semver>", "Semver range string to check for AWS SDK for JavaScript v2", (value) => {
+        try {
+            satisfies("0", value);
+        }
+        catch {
+            throw new Error(`Invalid semver range: ${value}`);
+        }
+        return value;
+    }, ">=2.0.0")
         .option("--region <region>", "AWS region to scan")
         .option("--profile <profile>", "AWS profile to use")
         .addOption(new Option("-o, --output <output>", "Output format")

package/dist/scanLambdaFunctions.js

@@ -6,7 +6,7 @@ import { getLambdaFunctionScanOutput } from "./utils/getLambdaFunctionScanOutput
 import { getLambdaNodeJsMatchingVersions } from "./utils/getLambdaNodeJsMatchingVersions.js";
 import { LambdaCommandOutputType, printLambdaCommandOutput, } from "./utils/printLambdaCommandOutput.js";
 export const scanLambdaFunctions = async (options) => {
-    const { yes, node, region, profile, output, jobs } = options;
+    const { yes, node, sdk, region, profile, output, jobs } = options;
     const client = new Lambda({
         ...(region && { region }),
         ...(profile && { profile }),
@@ -43,6 +43,7 @@ export const scanLambdaFunctions = async (options) => {
         functionName: fn.FunctionName,
         region: clientRegion,
         runtime: fn.Runtime,
+        sdkVersionRange: sdk,
     }))));
     printLambdaCommandOutput(scanOutput, output);
 };

package/dist/utils/constants.js

@@ -0,0 +1,3 @@
+export const PACKAGE_JSON = "package.json";
+export const NODE_MODULES = "node_modules";
+export const AWS_SDK = "aws-sdk";

package/dist/utils/getLambdaFunctionContents.js

@@ -1,5 +1,6 @@
 import StreamZip from "node-stream-zip";
-const PACKAGE_JSON_FILENAME = "package.json";
+import { AWS_SDK, NODE_MODULES, PACKAGE_JSON } from "./constants.js";
+import { join } from "node:path";
 /**
  * Extracts the contents of a Lambda Function zip file.
  * Returns string contents of package.json files, if available.
@@ -11,6 +12,7 @@ const PACKAGE_JSON_FILENAME = "package.json";
 export const getLambdaFunctionContents = async (zipPath) => {
     const zip = new StreamZip.async({ file: zipPath });
     const packageJsonFiles = [];
+    const awsSdkPackageJsonMap = {};
     let zipEntries = {};
     try {
         zipEntries = await zip.entries();
@@ -20,11 +22,16 @@ export const getLambdaFunctionContents = async (zipPath) => {
         // ToDo: add warning when logging is supported in future.
     }
     for (const zipEntry of Object.values(zipEntries)) {
-        // Skip 'node_modules' directory, as it's not the customer source code.
-        if (zipEntry.name.includes("node_modules/"))
+        // Skip 'node_modules' directory, except for aws-sdk package.json file.
+        if (zipEntry.name.includes(`${NODE_MODULES}/`)) {
+            if (zipEntry.name.endsWith(join(NODE_MODULES, AWS_SDK, PACKAGE_JSON)) && zipEntry.isFile) {
+                const packageJsonContent = await zip.entryData(zipEntry.name);
+                awsSdkPackageJsonMap[zipEntry.name] = packageJsonContent.toString();
+            }
             continue;
+        }
         // Skip anything which is not 'package.json'
-        if (!zipEntry.name.endsWith(PACKAGE_JSON_FILENAME))
+        if (!zipEntry.name.endsWith(PACKAGE_JSON))
             continue;
         // Skip if 'package.json' is not a file
         if (!zipEntry.isFile)
@@ -43,7 +50,10 @@ export const getLambdaFunctionContents = async (zipPath) => {
     }
     if (packageJsonFiles.length !== 0) {
         await zip.close();
-        return { packageJsonFiles };
+        return {
+            packageJsonFiles,
+            ...(Object.keys(awsSdkPackageJsonMap).length > 0 && { awsSdkPackageJsonMap }),
+        };
     }
     for (const path of ["index.js", "index.mjs", "index.cjs"]) {
         if (!zipEntries[path])

package/dist/utils/getLambdaFunctionScanOutput.js

@@ -1,14 +1,28 @@
+import { satisfies, validate } from "compare-versions";
 import { downloadFile } from "./downloadFile.js";
 import { getLambdaFunctionContents, } from "./getLambdaFunctionContents.js";
 import { hasSdkV2InBundle } from "./hasSdkV2InBundle.js";
 import { rm } from "node:fs/promises";
 import { tmpdir } from "node:os";
-import { join } from "node:path";
-export const getLambdaFunctionScanOutput = async (client, { functionName, region, runtime }) => {
+import { dirname, join } from "node:path";
+import { AWS_SDK, NODE_MODULES, PACKAGE_JSON } from "./constants.js";
+/**
+ * Scans a Lambda function to detect AWS SDK for JavaScript v2 usage.
+ *
+ * Downloads the function code, extracts it, and checks for v2 SDK in:
+ * 1. package.json dependencies
+ * 2. Bundled index file
+ *
+ * @param client - AWS Lambda client instance
+ * @param options - Scan configuration options
+ * @returns Scan results including SDK v2 detection status and location
+ */
+export const getLambdaFunctionScanOutput = async (client, { functionName, region, runtime, sdkVersionRange }) => {
     const output = {
         FunctionName: functionName,
         Region: region,
         Runtime: runtime,
+        SdkVersion: sdkVersionRange,
         ContainsAwsSdkJsV2: null,
     };
     const response = await client.getFunction({ FunctionName: functionName });
@@ -23,23 +37,54 @@ export const getLambdaFunctionScanOutput = async (client, { functionName, region
         lambdaFunctionContents = await getLambdaFunctionContents(zipPath);
     }
     catch (error) {
+        const errorPrefix = "Error downloading or reading Lambda function code";
         output.AwsSdkJsV2Error =
-            error instanceof Error
-                ? `Error downloading or reading Lambda function code: ${error.message}`
-                : "Error downloading or reading Lambda function code.";
+            error instanceof Error ? `${errorPrefix}: ${error.message}` : errorPrefix;
         return output;
     }
     finally {
         await rm(zipPath, { force: true });
     }
-    const { packageJsonFiles, bundleFile } = lambdaFunctionContents;
-    // Search for "aws-sdk" in package.json dependencies if present.
+    const { packageJsonFiles, awsSdkPackageJsonMap, bundleFile } = lambdaFunctionContents;
+    // Search for JS SDK v2 in package.json dependencies if present.
     if (packageJsonFiles && packageJsonFiles.length > 0) {
         for (const { path: packageJsonPath, content: packageJsonContent } of packageJsonFiles) {
             try {
                 const packageJson = JSON.parse(packageJsonContent);
                 const dependencies = packageJson.dependencies || {};
-                if ("aws-sdk" in dependencies) {
+                if (AWS_SDK in dependencies) {
+                    const awsSdkVersionInPackageJson = dependencies[AWS_SDK];
+                    const awsSdkPackageJsonPathInNodeModules = join(NODE_MODULES, AWS_SDK, PACKAGE_JSON);
+                    // Get aws-sdk package.json from nested node_modules or root node_modules.
+                    const awsSdkPackageJson = awsSdkPackageJsonMap
+                        ? (awsSdkPackageJsonMap[join(dirname(packageJsonPath), awsSdkPackageJsonPathInNodeModules)] ?? awsSdkPackageJsonMap[awsSdkPackageJsonPathInNodeModules])
+                        : undefined;
+                    let awsSdkVersionInNodeModules;
+                    try {
+                        if (awsSdkPackageJson) {
+                            awsSdkVersionInNodeModules = JSON.parse(awsSdkPackageJson).version;
+                        }
+                    }
+                    catch {
+                        // Skip if JSON can't be parsed.
+                        // ToDo: add warning when logging is supported in future.
+                    }
+                    const sdkVersionToCheck = validate(awsSdkVersionInPackageJson) || awsSdkPackageJson === undefined
+                        ? // Use version in package.json dependencies, if fixed version is defined or aws-sdk package.json is not available.
+                            awsSdkVersionInPackageJson
+                        : // Use version from aws-sdk package.json, if defined
+                            (awsSdkVersionInNodeModules ?? awsSdkVersionInPackageJson);
+                    try {
+                        if (!satisfies(sdkVersionToCheck, sdkVersionRange)) {
+                            continue;
+                        }
+                    }
+                    catch (error) {
+                        const errorPrefix = `Error checking version range '${sdkVersionRange}' for aws-sdk@${dependencies["aws-sdk"]} in '${packageJsonPath}'`;
+                        output.AwsSdkJsV2Error =
+                            error instanceof Error ? `${errorPrefix}: ${error.message}` : errorPrefix;
+                        return output;
+                    }
                     output.ContainsAwsSdkJsV2 = true;
                     output.AwsSdkJsV2Location = `Defined in dependencies of '${packageJsonPath}'`;
                     return output;
@@ -53,13 +98,23 @@ export const getLambdaFunctionScanOutput = async (client, { functionName, region
             }
         }
     }
-    // Check for code of "aws-sdk" in bundle, if not found in package.json dependencies.
-    if (bundleFile && hasSdkV2InBundle(bundleFile.content)) {
-        output.ContainsAwsSdkJsV2 = true;
-        output.AwsSdkJsV2Location = `Bundled in '${bundleFile.path}'`;
-        return output;
+    // Check for signature of JS SDK v2 in bundle, if not found in package.json dependencies.
+    if (bundleFile) {
+        try {
+            if (hasSdkV2InBundle(bundleFile.content, sdkVersionRange)) {
+                output.ContainsAwsSdkJsV2 = true;
+                output.AwsSdkJsV2Location = `Bundled in '${bundleFile.path}'`;
+                return output;
+            }
+        }
+        catch (error) {
+            const errorPrefix = `Error reading bundle '${bundleFile.path}' for aws-sdk@${sdkVersionRange}`;
+            output.AwsSdkJsV2Error =
+                error instanceof Error ? `${errorPrefix}: ${error.message}` : errorPrefix;
+            return output;
+        }
     }
-    // "aws-sdk" dependency/code not found.
+    // JS SDK v2 dependency/code not found.
     output.ContainsAwsSdkJsV2 = false;
     return output;
 };

package/dist/utils/hasSdkV2InBundle.js

@@ -1,3 +1,4 @@
+import { satisfies } from "compare-versions";
 const AWS_SDK_ENV_VARS = [
     "AWS_CONFIG_FILE",
     // "AWS_CONTAINER_AUTHORIZATION_TOKEN", // Tree shaken by esbuild
@@ -32,13 +33,23 @@ const AWS_SDK_ENV_VARS = [
  * Checks if AWS SDK v2 is present in the provided bundle content by looking for specific environment variables.
  *
  * @param bundleContent - The string content of the bundle to check.
+ * @param sdkVersionRange - Semver range string to check for AWS SDK for JavaScript v2
  * @returns boolean - Returns true if all AWS SDK v2 environment variables are found in the bundle content, false otherwise.
  */
-export const hasSdkV2InBundle = (bundleContent) => {
+export const hasSdkV2InBundle = (bundleContent, sdkVersionRange) => {
     for (const envVar of AWS_SDK_ENV_VARS) {
         if (!bundleContent.includes(envVar)) {
             return false;
         }
     }
-    return true;
+    // Get version number from `VERSION:'2.X.Y'` or `VERSION: '2.X.Y'`, including double quotes and backticks.
+    const matches = bundleContent.match(/VERSION:\s*(['"`])(2\.\d+\.\d+)\1/);
+    if (matches && matches[2]) {
+        const version = matches[2];
+        // If version is in the specified range, return true
+        if (satisfies(version, sdkVersionRange)) {
+            return true;
+        }
+    }
+    return false;
 };

package/dist/utils/printLambdaCommandOutput.js

@@ -13,7 +13,7 @@ export const printLambdaCommandOutput = (output, outputType) => {
     }
     // Output as table
     const table = new Table({
-        head: ["FunctionName", "Region", "Runtime", "ContainsAwsSdkJsV2"],
+        head: ["FunctionName", "Region", "Runtime", "SdkVersion", "ContainsAwsSdkJsV2"],
         style: { head: ["bold"] },
     });
     for (const scanOutput of output) {
@@ -28,7 +28,13 @@ export const printLambdaCommandOutput = (output, outputType) => {
         if (scanOutput.AwsSdkJsV2Location !== undefined) {
             notes += ` ${scanOutput.AwsSdkJsV2Location}`;
         }
-        table.push([scanOutput.FunctionName, scanOutput.Region, scanOutput.Runtime, notes]);
+        table.push([
+            scanOutput.FunctionName,
+            scanOutput.Region,
+            scanOutput.Runtime,
+            scanOutput.SdkVersion,
+            notes,
+        ]);
     }
     console.log(table.toString());
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aws-sdk/find-v2",
-  "version": "0.5.0",
+  "version": "0.6.1",
   "description": "CLI to find resources which call AWS using JavaScript SDK v2",
   "main": "dist/cli.js",
   "types": "dist/cli.d.ts",
@@ -25,12 +25,12 @@
     "@tsconfig/node-ts": "^23.6.2",
     "@tsconfig/node20": "^20.1.8",
     "@types/node": "^20.14.8",
-    "aws-sdk": "^2.1692.0",
+    "aws-sdk": "2.1693.0",
     "esbuild": "~0.27.1",
-    "oxfmt": "^0.18.0",
+    "oxfmt": "^0.21.0",
     "oxlint": "^1.33.0",
     "parcel": "^2.16.3",
-    "rolldown": "1.0.0-beta.54",
+    "rolldown": "1.0.0-beta.58",
     "rollup": "^4.53.3",
     "typescript": "^5.9.3",
     "vitest": "^4.0.15",