@aws-sdk/find-v2 0.0.1

package/LICENSE

@@ -0,0 +1,175 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.

package/README.md

@@ -0,0 +1,64 @@
+## @aws-sdk/find-v2
+
+CLI to find resources which call AWS using JavaScript SDK v2
+
+## Prerequisites
+
+- Install [Node.js][install-nodejs].
+- Set up [SDK authentication with AWS][] with the required permissions for the task.
+
+## Usage
+
+Running `npx @aws-sdk/find-v2` returns help information.
+
+```console
+$ npx @aws-sdk/find-v2
+
+Usage: @aws-sdk/find-v2 [options] [command]
+
+CLI to find resources which call AWS using JavaScript SDK v2
+
+Options:
+  -v, --version   output the version number
+  -h, --help      display help for command
+
+Commands:
+  lambda          Scans Lambda Node.js Functions for JavaScript SDK v2.
+  help [command]  display help for command
+```
+
+### lambda
+
+Run `lambda` command to scan Lambda Node.js Functions for JavaScript SDK v2.
+
+```console
+$ npx @aws-sdk/find-v2 lambda
+
+Note about output:
+- [Y] means "aws-sdk" is found in Lambda function, and migration is recommended.
+- [N] means "aws-sdk" is not found in Lambda function.
+- [?] means script was not able to proceed, and it emits reason.
+
+Reading 4 functions.
+[N] fn-without-aws-sdk-in-bundle
+[Y] fn-with-aws-sdk-in-bundle
+[Y] fn-with-aws-sdk-in-package-json-deps
+[N] fn-without-aws-sdk-in-package-json-deps
+
+Done.
+```
+
+This script requires AWS Managed Policy [AWSLambda_ReadOnlyAccess][].
+It lists all Lambda functions, and performs download, unzip and scan for mentions of JS SDK v2.
+
+## Security
+
+See [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more information.
+
+## License
+
+This project is licensed under the Apache-2.0 License.
+
+[AWSLambda_ReadOnlyAccess]: https://docs.aws.amazon.com/aws-managed-policy/latest/reference/AWSLambda_ReadOnlyAccess.html
+[install-nodejs]: https://nodejs.dev/learn/how-to-install-nodejs
+[SDK authentication with AWS]: https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/getting-your-credentials.html

package/bin/@aws-sdk/find-v2

@@ -0,0 +1,4 @@
+#!/usr/bin/env node
+import { createProgram } from "../../dist/cli.js";
+
+createProgram().parse();

package/dist/cli.js

@@ -0,0 +1,23 @@
+import { Command } from "commander";
+import packageJson from "../package.json" with { type: "json" };
+import { scanLambdaFunctions } from "./scanLambdaFunctions.js";
+/**
+ * Creates and configures the CLI program with available commands.
+ *
+ * @returns The configured Commander program instance
+ * @internal
+ */
+export const createProgram = () => {
+    const program = new Command();
+    program
+        .name(packageJson.name)
+        .description("CLI to find resources which call AWS using JavaScript SDK v2")
+        .version(packageJson.version, "-v, --version");
+    program
+        .command("lambda")
+        .description("Scans Lambda Node.js Functions for JavaScript SDK v2.")
+        .action(async () => {
+        await scanLambdaFunctions();
+    });
+    return program;
+};

package/dist/constants.js

@@ -0,0 +1,5 @@
+export const JS_SDK_V2_MARKER = {
+    Y: "[Y]",
+    N: "[N]",
+    UNKNOWN: "[?]",
+};

package/dist/scanLambdaFunction.js

@@ -0,0 +1,47 @@
+import { JS_SDK_V2_MARKER } from "./constants.js";
+import { downloadFile } from "./utils/downloadFile.js";
+import { getLambdaFunctionContents, } from "./utils/getLambdaFunctionContents.js";
+import { hasSdkV2InBundle } from "./utils/hasSdkV2InBundle.js";
+import { rm } from "node:fs/promises";
+import { tmpdir } from "node:os";
+import { join } from "node:path";
+export const scanLambdaFunction = async (client, functionName) => {
+    const response = await client.getFunction({ FunctionName: functionName });
+    if (!response.Code?.Location) {
+        console.log(`${JS_SDK_V2_MARKER.UNKNOWN} ${functionName}: Code location not found.`);
+        return;
+    }
+    const zipPath = join(tmpdir(), `${functionName}.zip`);
+    let lambdaFunctionContents;
+    try {
+        await downloadFile(response.Code.Location, zipPath);
+        lambdaFunctionContents = await getLambdaFunctionContents(zipPath);
+    }
+    finally {
+        await rm(zipPath, { force: true });
+    }
+    const { packageJsonContents, bundleContent } = lambdaFunctionContents;
+    // Search for "aws-sdk" in package.json dependencies if present.
+    if (packageJsonContents && packageJsonContents.length > 0) {
+        for (const packageJsonContent of packageJsonContents) {
+            try {
+                const packageJson = JSON.parse(packageJsonContent);
+                const dependencies = packageJson.dependencies || {};
+                if ("aws-sdk" in dependencies) {
+                    console.log(`${JS_SDK_V2_MARKER.Y} ${functionName}`);
+                    return;
+                }
+            }
+            catch (error) {
+                // Parsing failure for package.json which is rare, continue.
+            }
+        }
+    }
+    // Check for code of "aws-sdk" in bundle, if not found in package.json dependencies.
+    if (bundleContent && hasSdkV2InBundle(bundleContent)) {
+        console.log(`${JS_SDK_V2_MARKER.Y} ${functionName}`);
+        return;
+    }
+    // "aws-sdk" dependency/code not found.
+    console.log(`${JS_SDK_V2_MARKER.N} ${functionName}`);
+};

package/dist/scanLambdaFunctions.js

@@ -0,0 +1,29 @@
+import { Lambda, paginateListFunctions, } from "@aws-sdk/client-lambda";
+import { JS_SDK_V2_MARKER } from "./constants.js";
+import { scanLambdaFunction } from "./scanLambdaFunction.js";
+const client = new Lambda();
+const getNodeJsFunctionNames = (functions) => (functions ?? [])
+    .filter((fn) => fn.Runtime?.startsWith("nodejs"))
+    .map((fn) => fn.FunctionName)
+    .filter((fnName) => fnName !== undefined);
+export const scanLambdaFunctions = async () => {
+    const functions = [];
+    const paginator = paginateListFunctions({ client }, {});
+    for await (const page of paginator) {
+        functions.push(...getNodeJsFunctionNames(page.Functions));
+    }
+    const functionsLength = functions.length;
+    if (functionsLength === 0) {
+        console.log("No functions found.");
+        process.exit(0);
+    }
+    console.log(`Note about output:`);
+    console.log(`- ${JS_SDK_V2_MARKER.Y} means "aws-sdk" is found in Lambda function, and migration is recommended.`);
+    console.log(`- ${JS_SDK_V2_MARKER.N} means "aws-sdk" is not found in Lambda function.`);
+    console.log(`- ${JS_SDK_V2_MARKER.UNKNOWN} means script was not able to proceed, and it emits reason.\n`);
+    console.log(`Reading ${functionsLength} function${functionsLength > 1 ? "s" : ""}.`);
+    for (const functionName of functions) {
+        await scanLambdaFunction(client, functionName);
+    }
+    console.log("\nDone.");
+};

package/dist/utils/downloadFile.js

@@ -0,0 +1,19 @@
+import { writeFile } from "node:fs/promises";
+/**
+ * Downloads a file from a URL and saves it to the specified path.
+ *
+ * @param url - The URL of the file to download.
+ * @param outputPath - The local file path where the downloaded file should be saved.
+ * @throws {Error} If the download fails or response body is null.
+ * @returns Promise that resolves when file is downloaded and saved.
+ */
+export const downloadFile = async (url, outputPath) => {
+    const response = await fetch(url);
+    if (!response.ok) {
+        throw new Error(`Failed to download '${url}'. Received ${response.status} with '${response.statusText}'.`);
+    }
+    if (!response.body) {
+        throw new Error(`Response body is null for '${url}'`);
+    }
+    await writeFile(outputPath, response.body);
+};

package/dist/utils/getLambdaFunctionContents.js

@@ -0,0 +1,38 @@
+import unzipper from "unzipper";
+const PACKAGE_JSON_FILENAME = "package.json";
+/**
+ * Extracts the contents of a Lambda Function zip file.
+ * Returns string contents of package.json files, if available.
+ * Otherwise, returns the contents of bundle file.
+ *
+ * @param zipPath - The path to the zip file of Lambda Function.
+ * @returns Promise<LambdaFunctionContents> - Resolves to an object containing the extracted contents.
+ */
+export const getLambdaFunctionContents = async (zipPath) => {
+    const directory = await unzipper.Open.file(zipPath);
+    const packageJsonContents = [];
+    for (const file of directory.files) {
+        // Skip 'node_modules' directory, as it's not the customer source code.
+        if (file.path.includes("node_modules/"))
+            continue;
+        // Skip anything which is not `package.json`
+        if (!file.path.endsWith(PACKAGE_JSON_FILENAME))
+            continue;
+        const packageJsonContent = await file.buffer();
+        packageJsonContents.push(packageJsonContent.toString());
+    }
+    if (packageJsonContents.length !== 0) {
+        return { packageJsonContents };
+    }
+    let indexFile;
+    for (const path of ["index.js", "index.mjs", "index.cjs"]) {
+        indexFile = directory.files.find((f) => f.path === path && f.type === "File");
+        if (indexFile)
+            break;
+    }
+    if (indexFile) {
+        const bundleContent = await indexFile.buffer();
+        return { bundleContent: bundleContent.toString() };
+    }
+    return {};
+};

package/dist/utils/hasSdkV2InBundle.js

@@ -0,0 +1,44 @@
+const AWS_SDK_ENV_VARS = [
+    "AWS_CONFIG_FILE",
+    // "AWS_CONTAINER_AUTHORIZATION_TOKEN", // Tree shaken by esbuild
+    // "AWS_CONTAINER_AUTHORIZATION_TOKEN_FILE", // Tree shaken by esbuild
+    // "AWS_CONTAINER_CREDENTIALS_RELATIVE_URI", // Tree shaken by esbuild
+    // "AWS_CONTAINER_CREDENTIALS_FULL_URI", // Tree shaken by esbuild
+    // "AWS_CSM_CLIENT_ID", // v3 doesn't support CSM. Tree shaken by esbuild.
+    // "AWS_CSM_ENABLED", // v3 doesn't support CSM. Tree shaken by esbuild.
+    // "AWS_CSM_HOST", // v3 doesn't support CSM. Tree shaken by esbuild.
+    // "AWS_CSM_PORT", // v3 doesn't support CSM. Tree shaken by esbuild.
+    // "AWS_EC2_METADATA_DISABLED", // Tree shaken by esbuild
+    // "AWS_EC2_METADATA_SERVICE_ENDPOINT", // Tree shaken by esbuild
+    // "AWS_EC2_METADATA_SERVICE_ENDPOINT_MODE", // Tree shaken by esbuild
+    // "AWS_EC2_METADATA_V1_DISABLED", // Added in Nov'23 https://github.com/aws/aws-sdk-js/pull/4517. Tree shaken by esbuild.
+    "AWS_ENABLE_ENDPOINT_DISCOVERY",
+    "AWS_ENDPOINT_DISCOVERY_ENABLED",
+    "AWS_EXECUTION_ENV",
+    "AWS_LAMBDA_FUNCTION_NAME", // Added in May'22 https://github.com/aws/aws-sdk-js/pull/4111
+    // "AWS_NODEJS_CONNECTION_REUSE_ENABLED", // v3 enabled connection reuse by default. Tree shaken by esbuild.
+    "AWS_PROFILE",
+    // "AWS_REGION", // Tree shaken by esbuild
+    // "AWS_ROLE_ARN", // Tree shaken by esbuild
+    // "AWS_ROLE_SESSION_NAME", // Tree shaken by esbuild
+    "AWS_SDK_LOAD_CONFIG", // v3 loads config by default
+    "AWS_SHARED_CREDENTIALS_FILE",
+    "AWS_STS_REGIONAL_ENDPOINTS",
+    // "AWS_USE_DUALSTACK_ENDPOINT", // Added in Nov'21 https://github.com/aws/aws-sdk-js/pull/3957. Tree shaken by esbuild.
+    // "AWS_USE_FIPS_ENDPOINT", // Added in Nov'21 https://github.com/aws/aws-sdk-js/pull/3951. Tree shaken by esbuild.
+    // "AWS_WEB_IDENTITY_TOKEN_FILE", // Tree shaken by esbuild
+];
+/**
+ * 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.
+ * @returns boolean - Returns true if all AWS SDK v2 environment variables are found in the bundle content, false otherwise.
+ */
+export const hasSdkV2InBundle = (bundleContent) => {
+    for (const envVar of AWS_SDK_ENV_VARS) {
+        if (!bundleContent.includes(envVar)) {
+            return false;
+        }
+    }
+    return true;
+};

package/package.json

@@ -0,0 +1,63 @@
+{
+  "name": "@aws-sdk/find-v2",
+  "version": "0.0.1",
+  "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",
+    "commander": "^14.0.2",
+    "unzipper": "^0.12.3"
+  },
+  "devDependencies": {
+    "@aws-sdk/client-sts": "^3.946.0",
+    "@rollup/plugin-commonjs": "^29.0.0",
+    "@rollup/plugin-json": "^6.1.0",
+    "@rollup/plugin-node-resolve": "^16.0.3",
+    "@rollup/plugin-terser": "^0.4.4",
+    "@tsconfig/node-ts": "^23.6.2",
+    "@tsconfig/node20": "^20.1.8",
+    "@types/node": "^20.14.8",
+    "@types/unzipper": "^0.10.11",
+    "aws-sdk": "^2.1692.0",
+    "esbuild": "~0.27.1",
+    "rolldown": "1.0.0-beta.54",
+    "rollup": "^4.53.3",
+    "typescript": "^5.9.3",
+    "vitest": "^4.0.15",
+    "webpack": "^5.103.0",
+    "webpack-cli": "^6.0.1"
+  },
+  "scripts": {
+    "build": "tsc",
+    "test": "vitest",
+    "test:generate:bundles": "node scripts/generateBundles.ts"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/awslabs/aws-sdk-js-find-v2.git"
+  },
+  "keywords": [],
+  "author": {
+    "name": "Amazon Web Services",
+    "url": "http://aws.amazon.com"
+  },
+  "contributors": [
+    "Kamat, Trivikram <trivikr.dev@gmail.com>"
+  ],
+  "files": [
+    "bin",
+    "dist"
+  ],
+  "license": "Apache-2.0",
+  "bugs": {
+    "url": "https://github.com/awslabs/aws-sdk-js-find-v2/issues"
+  },
+  "homepage": "https://github.com/awslabs/aws-sdk-js-find-v2",
+  "engines": {
+    "node": ">=20.0.0"
+  },
+  "packageManager": "yarn@4.12.0",
+  "type": "module"
+}