Merge pull request #7 from lifeomic/allow-overriding-external

feat: Allow opting out from excluding the aws sdk

jest.config.js

@@ -1,5 +1,6 @@
 module.exports = {
   preset: 'ts-jest',
+  clearMocks: true,
   collectCoverage: true,
   coverageThreshold: {
     global: {

src/bin/cli.ts

@@ -4,7 +4,9 @@ import * as yargs from 'yargs';
 import { bundle } from '../bundle';
 
 const main = async () => {
-  const { entries, outdir, node } = await yargs(process.argv.slice(2))
+  const { entries, outdir, node, includeAwsSdk } = await yargs(
+    process.argv.slice(2),
+  )
     .option('entries', {
       type: 'string',
       description: 'The lambda entrypoints to bundle. Can be a glob pattern.',
@@ -20,6 +22,11 @@ const main = async () => {
       description: 'The Node version to target.',
       demandOption: true,
     })
+    .option('include-aws-sdk', {
+      type: 'boolean',
+      description: 'Allow opting out from excluding the aws sdk',
+      default: false,
+    })
     .strict()
     .parse();
 
@@ -28,6 +35,7 @@ const main = async () => {
     outdir: path.resolve(process.cwd(), outdir),
     node,
     cwd: process.cwd(),
+    includeAwsSdk,
   });
 };
 

src/bundle.test.ts

@@ -253,6 +253,28 @@ test('bundle works with an array of entries', async () => {
 });
 
 describe('AWS SDK bundling behavior', () => {
+  test('allows for ignoring AWS SDK exclusion behavior', async () => {
+    writeTestInputFile('first-file.js', `export const TMP = 'TMP';`);
+    await bundle({
+      entries: `${TEST_INPUT_DIR}/first-file.js`,
+      outdir: TEST_OUTPUT_DIR,
+      node: 15,
+      includeAwsSdk: true,
+    });
+
+    expect(build).toHaveBeenCalledTimes(1);
+    expect(build).toHaveBeenCalledWith(
+      expect.objectContaining({
+        bundle: true,
+        sourcemap: false,
+        platform: 'node',
+        target: 'node15',
+        external: [],
+        resolveExtensions: ['.jsx', '.js', '.tsx', '.ts', '.json'],
+      }),
+    );
+  });
+
   /** Bundles the code, returning the output. */
   const bundleCode = async (params: {
     node: number;

src/bundle.ts

@@ -23,6 +23,11 @@ export type BundleOptions = {
 
   cwd?: string;
 
+  /**
+   * Allows for opting out from excluding the aws sdk
+   */
+  includeAwsSdk?: boolean;
+
   /**
    * Override options to pass to esbuild. These override any options generated
    * by other internal settings.
@@ -38,6 +43,7 @@ export const bundle = async ({
   outdir,
   node: nodeVersion,
   cwd,
+  includeAwsSdk = false,
   esbuild,
 }: BundleOptions) => {
   const entryPoints = (typeof entries === 'string' ? [entries] : entries)
@@ -61,7 +67,11 @@ export const bundle = async ({
        *
        * https://aws.amazon.com/blogs/compute/node-js-18-x-runtime-now-available-in-aws-lambda/
        */
-      external: nodeVersion >= 18 ? ['@aws-sdk/*'] : ['aws-sdk'],
+      external: includeAwsSdk
+        ? []
+        : nodeVersion >= 18
+        ? ['@aws-sdk/*']
+        : ['aws-sdk'],
       /**
        * As of v0.14.44, esbuild by default prefers .ts over .js files.
        *