feat: provide 'shimRequire' and 'includeAwsSdk' options

Author: Inqnuam

package.json

@@ -1,6 +1,6 @@
 {
   "name": "serverless-aws-lambda",
-  "version": "4.8.3",
+  "version": "4.8.4",
   "description": "AWS Application Load Balancer and API Gateway - Lambda dev tool for Serverless. Allows Express synthax in handlers. Supports packaging, local invoking and offline ALB, APG, S3, SNS, SQS, DynamoDB Stream server mocking.",
   "author": "Inqnuam",
   "license": "MIT",

src/config.ts

@@ -15,6 +15,8 @@ export interface OfflineConfig {
 
 export interface Config {
   esbuild?: Omit<BuildOptions, "outExtension" | "outfile" | "bundle" | "splitting" | "stdin" | "platforme" | "metafile" | "format"> & { format?: "cjs" | "esm" };
+  shimRequire?: boolean;
+  includeAwsSdk?: boolean;
   offline?: OfflineConfig;
   buildCallback?: (result: BuildResult, isRebuild: boolean) => Promise<void> | void;
   afterDeployCallbacks?: (() => Promise<void> | void)[];

src/defineConfig.ts

@@ -95,6 +95,18 @@ export interface SlsAwsLambdaPlugin {
 
 export interface Options {
   esbuild?: Config["esbuild"];
+  /**
+   * shim `require`, `__dirname` and `__filename` when bundeling Lambdas with ESM format
+   * @default true
+   */
+  shimRequire?: boolean;
+  /**
+   * By default aws sdk packages are excluded from Lambda bundles as AWS Lambda Runtime already includes `aws-sdk` (v2) for Node < 18 and `@aws-sdk/*` for Node >=18 packages.
+   *
+   * Use this option to include aws-sdk if you prefer to control exact package version used by your Lambdas during runtime.
+   * @default false
+   */
+  includeAwsSdk?: boolean;
   offline?: {
     /**
      * Serve files locally from provided directory
@@ -167,6 +179,8 @@ function defineConfig(options: Options) {
   ): Promise<Omit<Config, "config" | "options">> {
     let config: Config = {
       esbuild: options.esbuild ?? {},
+      shimRequire: options.shimRequire,
+      includeAwsSdk: options.includeAwsSdk,
       offline: {
         staticPath: options.offline?.staticPath,
         port: options.offline?.port,

src/index.ts

@@ -57,6 +57,8 @@ class ServerlessAwsLambda extends Daemon {
   afterDeployCallbacks: (() => void | Promise<void>)[] = [];
   afterPackageCallbacks: (() => void | Promise<void>)[] = [];
   resources: ReturnType<typeof getResources> = { ddb: {}, kinesis: {}, sns: {}, sqs: {} };
+  shimRequire: boolean = true;
+  includeAwsSdk: boolean = false;
   static tags: string[] = ["build"];
   constructor(serverless: any, options: any, pluginUtils: PluginUtils) {
     super({ debug: process.env.SLS_DEBUG == "*" });
@@ -209,7 +211,9 @@ class ServerlessAwsLambda extends Daemon {
         log.RED(`You are running on NodeJS ${process.version} which is lower than '${this.nodeVersion}' found in serverless.yml.`);
       }
       esBuildConfig.target = `node${this.nodeVersion}`;
-      esBuildConfig.plugins?.push(buildOptimizer({ isLocal, nodeVersion: this.nodeVersion, buildCallback: this.buildCallback }));
+      esBuildConfig.plugins?.push(
+        buildOptimizer({ isLocal, nodeVersion: this.nodeVersion, shimRequire: this.shimRequire, includeAwsSdk: this.includeAwsSdk, buildCallback: this.buildCallback })
+      );
     }
     if (!isLocal) {
       esBuildConfig.dropLabels!.push("LOCAL");
@@ -580,6 +584,14 @@ class ServerlessAwsLambda extends Daemon {
         throw new Error(`Can not find config at: ${configPath}`);
       }
 
+      if (typeof exportedObject.shimRequire == "boolean") {
+        this.shimRequire = exportedObject.shimRequire;
+      }
+
+      if (typeof exportedObject.includeAwsSdk == "boolean") {
+        this.includeAwsSdk = exportedObject.includeAwsSdk;
+      }
+
       if (typeof exportedObject.buildCallback == "function") {
         this.customBuildCallback = exportedObject.buildCallback;
       }

src/lib/esbuild/buildOptimizer.ts

@@ -10,10 +10,14 @@ const requirePoly = (nodePrefix: "node:" | "") =>
 export const buildOptimizer = ({
   isLocal,
   nodeVersion,
+  shimRequire,
+  includeAwsSdk,
   buildCallback,
 }: {
   isLocal: boolean;
   nodeVersion: number;
+  shimRequire: boolean;
+  includeAwsSdk: boolean;
   buildCallback: (result: BuildResult, isRebuild: boolean, format: string, outdir: string) => void | Promise<void>;
 }): Plugin => {
   return {
@@ -49,25 +53,27 @@ export const buildOptimizer = ({
         }
 
         build.initialOptions.external!.push(...knownCjs);
-      } else {
+      } else if (!includeAwsSdk) {
         build.initialOptions.external!.push(nodeVersion < 18 ? awsSdkV2 : awsSdkV3);
       }
 
       if (build.initialOptions.format != "esm") {
         return;
       }
 
-      const r = requirePoly(nodeVersion < 18 ? "" : "node:");
-      if (build.initialOptions.banner) {
-        if (build.initialOptions.banner.js) {
-          build.initialOptions.banner.js = `${r}${build.initialOptions.banner.js}`;
+      if (shimRequire) {
+        const r = requirePoly(nodeVersion < 18 ? "" : "node:");
+        if (build.initialOptions.banner) {
+          if (build.initialOptions.banner.js) {
+            build.initialOptions.banner.js = `${r}${build.initialOptions.banner.js}`;
+          } else {
+            build.initialOptions.banner.js = r;
+          }
         } else {
-          build.initialOptions.banner.js = r;
+          build.initialOptions.banner = {
+            js: r,
+          };
         }
-      } else {
-        build.initialOptions.banner = {
-          js: r,
-        };
       }
     },
   };