@aws-sdk/find-v2 0.4.1 → 0.4.3

package/README.md

@@ -32,31 +32,18 @@ Commands:
 Run `lambda` command to scan Lambda Node.js Functions for JavaScript SDK v2.
 
 ```console
-$ npx @aws-sdk/find-v2 lambda --yes
-[
-  {
-    "FunctionName": "fn-without-aws-sdk-in-bundle",
-    "Region": "us-east-2",
-    "ContainsAwsSdkJsV2": false
-  },
-  {
-    "FunctionName": "fn-with-aws-sdk-in-bundle",
-    "Region": "us-east-2",
-    "ContainsAwsSdkJsV2": true,
-    "AwsSdkJsV2Location": "Bundled in index file."
-  },
-  {
-    "FunctionName": "fn-with-aws-sdk-in-package-json-deps",
-    "Region": "us-east-2",
-    "ContainsAwsSdkJsV2": true,
-    "AwsSdkJsV2Location": "Defined in package.json dependencies."
-  },
-  {
-    "FunctionName": "fn-without-aws-sdk-in-package-json-deps",
-    "Region": "us-east-2",
-    "ContainsAwsSdkJsV2": false
-  }
-]
+$ npx @aws-sdk/find-v2 lambda --yes --output table
+┌─────────────────────────────────────────┬───────────┬────────────────────────────────────────────────┐
+│ FunctionName                            │ Region    │ ContainsAwsSdkJsV2                             │
+├─────────────────────────────────────────┼───────────┼────────────────────────────────────────────────┤
+│ fn-without-aws-sdk-in-bundle            │ us-east-2 │ No.                                            │
+├─────────────────────────────────────────┼───────────┼────────────────────────────────────────────────┤
+│ fn-with-aws-sdk-in-bundle               │ us-east-2 │ Yes. Bundled in 'index.js'                     │
+├─────────────────────────────────────────┼───────────┼────────────────────────────────────────────────┤
+│ fn-with-aws-sdk-in-package-json-deps    │ us-east-2 │ Yes. Defined in dependencies of 'package.json' │
+├─────────────────────────────────────────┼───────────┼────────────────────────────────────────────────┤
+│ fn-without-aws-sdk-in-package-json-deps │ us-east-2 │ No.                                            │
+└─────────────────────────────────────────┴───────────┴────────────────────────────────────────────────┘
 ```
 
 This script requires AWS Managed Policy [AWSLambda_ReadOnlyAccess][].

package/dist/cli.js

@@ -1,7 +1,8 @@
-import { Command } from "commander";
+import { Command, Option } from "commander";
 import { cpus } from "node:os";
 import packageJson from "../package.json" with { type: "json" };
 import { scanLambdaFunctions } from "./scanLambdaFunctions.js";
+import { LambdaCommandOutputType } from "./utils/printLambdaCommandOutput.js";
 /**
  * Creates and configures the CLI program with available commands.
  *
@@ -17,9 +18,12 @@ export const createProgram = () => {
     program
         .command("lambda")
         .description("Scans Lambda Node.js Functions for JavaScript SDK v2")
-        .option("-y, --yes", "answer yes for all prompts")
+        .option("-y, --yes", "answer yes for all prompts", false)
         .option("-r, --region <region>", "AWS region to scan")
         .option("-p, --profile <profile>", "AWS profile to use")
+        .addOption(new Option("-o, --output <output>", "Output format")
+        .choices(Object.values(LambdaCommandOutputType))
+        .default(LambdaCommandOutputType.json))
         .option("-j, --jobs <count>", "number of parallel jobs", (value) => {
         const trimmed = value.trim();
         if (!/^\d+$/.test(trimmed)) {

package/dist/scanLambdaFunctions.js

@@ -1,10 +1,11 @@
 import { Lambda } from "@aws-sdk/client-lambda";
 import pLimit from "p-limit";
-import { getLambdaFunctionScanOutput } from "./getLambdaFunctionScanOutput.js";
 import { getDownloadConfirmation } from "./utils/getDownloadConfirmation.js";
 import { getLambdaFunctions } from "./utils/getLambdaFunctions.js";
-export const scanLambdaFunctions = async (options = {}) => {
-    const { region, yes, jobs, profile } = options;
+import { getLambdaFunctionScanOutput } from "./utils/getLambdaFunctionScanOutput.js";
+import { LambdaCommandOutputType, printLambdaCommandOutput, } from "./utils/printLambdaCommandOutput.js";
+export const scanLambdaFunctions = async (options) => {
+    const { yes, region, profile, output, jobs } = options;
     const client = new Lambda({
         ...(region && { region }),
         ...(profile && { profile }),
@@ -32,9 +33,9 @@ export const scanLambdaFunctions = async (options = {}) => {
     }
     const clientRegion = await client.config.region();
     const limit = pLimit(concurrency);
-    const output = await Promise.all(functions.map((fn) => limit(() => getLambdaFunctionScanOutput(client, {
+    const scanOutput = await Promise.all(functions.map((fn) => limit(() => getLambdaFunctionScanOutput(client, {
         functionName: fn.FunctionName,
         region: clientRegion,
     }))));
-    console.log(JSON.stringify(output, null, 2));
+    printLambdaCommandOutput(scanOutput, output);
 };

package/dist/utils/getLambdaFunctionContents.js

@@ -10,7 +10,7 @@ const PACKAGE_JSON_FILENAME = "package.json";
  */
 export const getLambdaFunctionContents = async (zipPath) => {
     const zip = new StreamZip.async({ file: zipPath });
-    const packageJsonContents = [];
+    const packageJsonFiles = [];
     let zipEntries = {};
     try {
         zipEntries = await zip.entries();
@@ -31,16 +31,19 @@ export const getLambdaFunctionContents = async (zipPath) => {
             continue;
         try {
             const packageJsonContent = await zip.entryData(zipEntry.name);
-            packageJsonContents.push(packageJsonContent.toString());
+            packageJsonFiles.push({
+                path: zipEntry.name,
+                content: packageJsonContent.toString(),
+            });
         }
         catch {
             // Continue without adding package.json file, if entry data can't be read.
             // ToDo: add warning when logging is supported in future.
         }
     }
-    if (packageJsonContents.length !== 0) {
+    if (packageJsonFiles.length !== 0) {
         await zip.close();
-        return { packageJsonContents };
+        return { packageJsonFiles };
     }
     for (const path of ["index.js", "index.mjs", "index.cjs"]) {
         if (!zipEntries[path])
@@ -50,7 +53,12 @@ export const getLambdaFunctionContents = async (zipPath) => {
         try {
             const bundleContent = await zip.entryData(path);
             await zip.close();
-            return { bundleContent: bundleContent.toString() };
+            return {
+                bundleFile: {
+                    path,
+                    content: bundleContent.toString(),
+                },
+            };
         }
         catch {
             // Continue processing next index file, if entry data can't be read.

package/dist/{getLambdaFunctionScanOutput.js → utils/getLambdaFunctionScanOutput.js}

@@ -1,6 +1,6 @@
-import { downloadFile } from "./utils/downloadFile.js";
-import { getLambdaFunctionContents, } from "./utils/getLambdaFunctionContents.js";
-import { hasSdkV2InBundle } from "./utils/hasSdkV2InBundle.js";
+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";
@@ -31,32 +31,31 @@ export const getLambdaFunctionScanOutput = async (client, { functionName, region
     finally {
         await rm(zipPath, { force: true });
     }
-    const { packageJsonContents, bundleContent } = lambdaFunctionContents;
+    const { packageJsonFiles, bundleFile } = lambdaFunctionContents;
     // Search for "aws-sdk" in package.json dependencies if present.
-    if (packageJsonContents && packageJsonContents.length > 0) {
-        for (const packageJsonContent of packageJsonContents) {
+    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) {
                     output.ContainsAwsSdkJsV2 = true;
-                    output.AwsSdkJsV2Location = "Defined in package.json dependencies.";
+                    output.AwsSdkJsV2Location = `Defined in dependencies of '${packageJsonPath}'`;
                     return output;
                 }
             }
             catch (error) {
+                const errorPrefix = `Error parsing '${packageJsonPath}'`;
                 output.AwsSdkJsV2Error =
-                    error instanceof Error
-                        ? `Error parsing package.json: ${error.message}`
-                        : "Error parsing package.json";
+                    error instanceof Error ? `${errorPrefix}: ${error.message}` : errorPrefix;
                 return output;
             }
         }
     }
     // Check for code of "aws-sdk" in bundle, if not found in package.json dependencies.
-    if (bundleContent && hasSdkV2InBundle(bundleContent)) {
+    if (bundleFile && hasSdkV2InBundle(bundleFile.content)) {
         output.ContainsAwsSdkJsV2 = true;
-        output.AwsSdkJsV2Location = "Bundled in index file.";
+        output.AwsSdkJsV2Location = `Bundled in '${bundleFile.path}'`;
         return output;
     }
     // "aws-sdk" dependency/code not found.

package/dist/utils/printLambdaCommandOutput.js

@@ -0,0 +1,34 @@
+import Table from "cli-table3";
+export const LambdaCommandOutputType = {
+    // prints output as JSON
+    json: "json",
+    // prints human-readable representation in a table
+    table: "table",
+};
+export const printLambdaCommandOutput = (output, outputType) => {
+    // Output as JSON
+    if (outputType === LambdaCommandOutputType.json) {
+        console.log(JSON.stringify(output, null, 2));
+        return;
+    }
+    // Output as table
+    const table = new Table({
+        head: ["FunctionName", "Region", "ContainsAwsSdkJsV2"],
+        style: { head: ["bold"] },
+    });
+    for (const scanOutput of output) {
+        let notes = scanOutput.ContainsAwsSdkJsV2 === null
+            ? "N/A."
+            : scanOutput.ContainsAwsSdkJsV2
+                ? "Yes."
+                : "No.";
+        if (scanOutput.AwsSdkJsV2Error !== undefined) {
+            notes += ` ${scanOutput.AwsSdkJsV2Error}`;
+        }
+        if (scanOutput.AwsSdkJsV2Location !== undefined) {
+            notes += ` ${scanOutput.AwsSdkJsV2Location}`;
+        }
+        table.push([scanOutput.FunctionName, scanOutput.Region, notes]);
+    }
+    console.log(table.toString());
+};

package/package.json

@@ -1,12 +1,13 @@
 {
   "name": "@aws-sdk/find-v2",
-  "version": "0.4.1",
+  "version": "0.4.3",
   "description": "CLI to find resources which call AWS using JavaScript SDK v2",
   "main": "dist/cli.js",
   "types": "dist/cli.d.ts",
   "bin": "bin/@aws-sdk/find-v2",
   "dependencies": {
     "@aws-sdk/client-lambda": "^3.942.0",
+    "cli-table3": "^0.6.5",
     "commander": "^14.0.2",
     "node-stream-zip": "^1.15.0",
     "p-limit": "^7.2.0"