feat(lib): move to webpack

Author: vvo

README.md

@@ -1,8 +1,8 @@
-# aws-lambda-nodejs-rollup [![GitHub license](https://img.shields.io/github/license/vvo/aws-lambda-nodejs-rollup?style=flat)](https://github.com/vvo/aws-lambda-nodejs-rollup/blob/master/LICENSE) [![Tests](https://github.com/vvo/aws-lambda-nodejs-rollup/workflows/CI/badge.svg)](https://github.com/vvo/aws-lambda-nodejs-rollup/actions) [![codecov](https://codecov.io/gh/vvo/aws-lambda-nodejs-rollup/branch/master/graph/badge.svg)](https://codecov.io/gh/vvo/aws-lambda-nodejs-rollup) ![npm](https://img.shields.io/npm/v/aws-lambda-nodejs-rollup)
+# aws-lambda-nodejs-webpack [![GitHub license](https://img.shields.io/github/license/vvo/aws-lambda-nodejs-webpack?style=flat)](https://github.com/vvo/aws-lambda-nodejs-webpack/blob/master/LICENSE) [![Tests](https://github.com/vvo/aws-lambda-nodejs-webpack/workflows/CI/badge.svg)](https://github.com/vvo/aws-lambda-nodejs-webpack/actions) [![codecov](https://codecov.io/gh/vvo/aws-lambda-nodejs-webpack/branch/master/graph/badge.svg)](https://codecov.io/gh/vvo/aws-lambda-nodejs-webpack) ![npm](https://img.shields.io/npm/v/aws-lambda-nodejs-webpack)
 
 ---
 
-_[CDK](https://aws.amazon.com/cdk/) Construct to build Node.js AWS lambdas using [rollup.js](https://rollupjs.org/)_
+_[CDK](https://aws.amazon.com/cdk/) Construct to build Node.js AWS lambdas using [webpack](https://webpack.js.org/)_
 
 _Table of contents:_
 
@@ -16,15 +16,15 @@ _Table of contents:_
 ## Usage example
 
 ```bash
-yarn add aws-lambda-nodejs-rollup
+yarn add aws-lambda-nodejs-webpack
 ```
 
 ```js
 // infra/super-app-stack.js
 const sns = require("@aws-cdk/aws-sns");
 const subscriptions = require("@aws-cdk/aws-sns-subscriptions");
 const core = require("@aws-cdk/core");
-const { NodejsFunction } = require("aws-lambda-nodejs-rollup");
+const { NodejsFunction } = require("aws-lambda-nodejs-webpack");
 
 module.exports = class SuperAppProductionStack extends core.Stack {
   constructor(scope, id, props) {
@@ -72,32 +72,39 @@ I want to be clear: I respect a LOT the work of the CDK team, and especially [@j
 
 This is a list of features I thought could be interesting to users. If you need on of them, please contribute to the project.
 
-- [ ] Allow passing rollup options, like externals
-- [ ] Allow using TypeScript, see https://github.com/rollup/plugins/tree/master/packages/typescript
-- [ ] Allow using babel, if you need preset-env
-- [ ] Allow passing babel options
-- [ ] Allow usage without the need of `entry`: `new NodejsFunction(this, "slack-notifications-lambda");` that would mimic https://docs.aws.amazon.com/cdk/api/latest/docs/aws-lambda-nodejs-readme.html#nodejs-function
-- [ ] Generate a bundle where entry is moved to /index.js
-- [ ] Use [jsii](https://github.com/aws/jsii) to build for other languages
-- [ ] Ask CDK team if this could live under their repositories
-- [ ] Allow native modules, with option `nativeModules`. They would have to be installed into a temp folder with `npm_config_arch` and `npm_config_platform` and aliased in rollup configuration
+- [ ] Test/Get feedback on TypeScript support
+- [ ] Get feedback on monorepo support
+- [ ] Allow passing webpack/babel options/a function that can update the full webpack configuration
+- [ ] Allow native modules/passing externals, with option `nativeModules` or `externals`. They would have to be installed into a temp folder with `npm_config_arch` and `npm_config_platform` and aliased in webpack configuration/or considered as externals. Externals and nativeModules seems related options but may be completely different
+- [ ] Use [jsii](https://github.com/aws/jsii) to build the construct for other languages
 - [ ] Add tests
-- [ ] Monorepo support
-- [ ] If necessary/beneficial, implement Rollup cache, see https://github.com/drg-adaptive/serverless-rollup-plugin and https://github.com/rollup/rollup/issues/2182
-- [ ] Other ideas?
+- [ ] (if current way buggy): force people to provide aliases instead of considering cwd as base node_module
+- [ ] Allow usage without the need of `entry`: `new NodejsFunction(this, "slack-notifications-lambda");` that would mimic https://docs.aws.amazon.com/cdk/api/latest/docs/aws-lambda-nodejs-readme.html#nodejs-function
+- [ ]
+- [x] Generate a bundle where entry is moved to /main.js
+- [x] Allow using TypeScript
+- [x] use webpack and babel cache
+- [x] remove webpackconfig from bundle
+- [x] pass runtime to babel target
+- [x] cdk synth generates different builds even when the lambda code does not changes, issue?
+- [x] Allow using babel, if you need preset-env
+- [x] add babel preset env by default
+- [ ] ~add bundling timing information to output console~ note: this would pollute cdk synth
+- [ ] ~Ask CDK team if this could live under their repositories~ Better be just community based
+- [ ] Other ideas? Open an issue
 
 ## How to make changes and test locally
 
 ```
 // fork and clone
-cd aws-lambda-nodejs-rollup
+cd aws-lambda-nodejs-webpack
 yarn
 yarn link
 yarn start
 
 # in another terminal and project where you want to test changes
-yarn link aws-lambda-nodejs-rollup
-# cdk commands will now use your local aws-lambda-nodejs-rollup
+yarn link aws-lambda-nodejs-webpack
+# cdk commands will now use your local aws-lambda-nodejs-webpack
 ```
 
 ## Thanks

package.json

@@ -1,16 +1,16 @@
 {
-  "name": "aws-lambda-nodejs-rollup",
+  "name": "aws-lambda-nodejs-webpack",
   "version": "0.0.0-development",
   "private": false,
-  "description": "CDK Construct to build Node.js AWS lambdas using rollup.js",
+  "description": "CDK Construct to build Node.js AWS lambdas using webbpack",
   "repository": {
     "type": "git",
-    "url": "https://github.com/vvo/aws-lambda-nodejs-rollup"
+    "url": "https://github.com/vvo/aws-lambda-nodejs-webbpack"
   },
   "license": "MIT",
   "author": "Vincent Voyer <vincent@codeagain.com>",
   "main": "dist/index.js",
-  "module": "dist/aws-lambda-nodejs-rollup.esm.js",
+  "module": "dist/aws-lambda-nodejs-webpack.esm.js",
   "typings": "dist/index.d.ts",
   "files": [
     "src/",
@@ -43,14 +43,19 @@
     "trailingComma": "all"
   },
   "dependencies": {
-    "@rollup/plugin-commonjs": "14.0.0",
-    "@rollup/plugin-json": "4.1.0",
-    "@rollup/plugin-node-resolve": "8.4.0",
-    "rollup": "2.22.2"
+    "@babel/core": "7.10.5",
+    "@babel/plugin-transform-runtime": "7.10.5",
+    "@babel/preset-env": "7.10.4",
+    "babel-loader": "8.1.0",
+    "noop2": "2.0.0",
+    "ts-loader": "^8.0.1",
+    "webpack": "4.44.0",
+    "webpack-cli": "3.3.12"
   },
   "devDependencies": {
     "@aws-cdk/aws-lambda": "1.54.0",
     "@aws-cdk/core": "1.54.0",
+    "@typescript-eslint/parser": "^3.7.1",
     "eslint-plugin-import": "2.22.0",
     "eslint-plugin-jest": "23.18.0",
     "prettier-plugin-packagejson": "2.2.5",
@@ -73,12 +78,11 @@
       "jest": true,
       "node": true
     },
-    "parser": "babel-eslint",
+    "parser": "@typescript-eslint/parser",
     "parserOptions": {
       "ecmaVersion": 2019,
       "sourceType": "module"
     },
-    "sideEffects": false,
     "extends": [
       "eslint:recommended",
       "plugin:jest/recommended",

rollup.config.js

@@ -1,11 +1,12 @@
 import * as fs from "fs";
 import * as path from "path";
 import * as os from "os";
-import * as lambda from "@aws-cdk/aws-lambda";
-import * as cdk from "@aws-cdk/core";
 import * as process from "process";
 import { spawnSync } from "child_process";
 
+import * as lambda from "@aws-cdk/aws-lambda";
+import * as cdk from "@aws-cdk/core";
+
 /**
  * Properties for a NodejsFunction
  */
@@ -31,6 +32,17 @@ export interface NodejsFunctionProps extends lambda.FunctionOptions {
    */
   readonly runtime?: lambda.Runtime;
 
+  /**
+   * If you get "Module not found: Error: Can't resolve 'module_name'" errors, and you're not
+   * actually using those modules, then it means there's a module you're using that is trying to
+   * dynamically require other modules. This is the case with Knex.js. When this happens, pass all the modules
+   * names found in the build error in this array.
+   *
+   * Example if you're only using PostgreSQL with Knex.js, use:
+   *  `modulesToIgnore: ["mssql", "pg-native", "pg-query-stream", "tedious"]`
+   */
+  readonly modulesToIgnore?: string[];
+
   /**
    * Whether to automatically reuse TCP connections when working with the AWS
    * SDK for JavaScript.
@@ -64,10 +76,10 @@ export class NodejsFunction extends lambda.Function {
       );
     }
 
-    const entry = path.resolve(props.entry);
+    const entryFullPath = path.resolve(props.entry);
 
-    if (!fs.existsSync(entry)) {
-      throw new Error(`Cannot find entry file at ${entry}`);
+    if (!fs.existsSync(entryFullPath)) {
+      throw new Error(`Cannot find entry file at ${entryFullPath}`);
     }
 
     const handler = props.handler ?? "handler";
@@ -78,68 +90,110 @@ export class NodejsFunction extends lambda.Function {
     const runtime = props.runtime ?? defaultRunTime;
 
     const outputDir = fs.mkdtempSync(
-      path.join(os.tmpdir(), "aws-lambda-nodejs-rollup"),
-    );
-    const rollupConfigPath = path.join(outputDir, "rollup.config.js");
-    const rollupBin = path.join(
-      path.dirname(require.resolve("rollup")),
-      "bin/rollup",
-    );
-    const sampleRollupPluginPath = path.dirname(
-      require.resolve("@rollup/plugin-node-resolve"),
+      path.join(os.tmpdir(), "aws-lambda-nodejs-webpack"),
     );
-    const pluginsPath = sampleRollupPluginPath.slice(
-      0,
-      sampleRollupPluginPath.lastIndexOf("/node_modules"),
+    const webpackBinPath = require.resolve("webpack-cli");
+    const webpackConfigPath = path.join(outputDir, "webpack.config.js");
+    const pluginsPath = path.join(
+      webpackBinPath.slice(0, webpackBinPath.lastIndexOf("/node_modules")),
+      "node_modules",
     );
 
-    fs.writeFileSync(
-      rollupConfigPath,
-      `
-    import { nodeResolve } from "${pluginsPath}/node_modules/@rollup/plugin-node-resolve";
-    import commonjs from "${pluginsPath}/node_modules/@rollup/plugin-commonjs";
-    import json from "${pluginsPath}/node_modules/@rollup/plugin-json";
-    import { builtinModules } from "module";
-
-    export default {
-      input: "${entry}",
+    const webpackConfiguration = `
+    const { builtinModules } = require("module");
+    const { NormalModuleReplacementPlugin } = require("${path.join(
+      pluginsPath,
+      "webpack",
+    )}");
+
+    module.exports = {
+      mode: "none",
+      entry: "${entryFullPath}",
+      target: "node",
+      resolve: {
+        modules: ["node_modules", "."]
+      },
+      devtool: "source-map",
+      module: {
+        rules: [
+          {
+            test: /\\.js$/,
+            exclude: /node_modules/,
+            use: {
+              loader: "${path.join(pluginsPath, "babel-loader")}",
+              options: {
+                cacheDirectory: true,
+                presets: [
+                  [
+                    "${path.join(pluginsPath, "@babel/preset-env")}",
+                    {
+                      "targets": {
+                        "node": "${
+                          runtime.name.split("nodejs")[1].split(".")[0]
+                        }"
+                      },
+                      loose: true,
+                      bugfixes: true,
+                    },
+                  ]
+                ],
+                plugins: ["${path.join(
+                  pluginsPath,
+                  "@babel/plugin-transform-runtime",
+                )}"]
+              }
+            }
+          },
+          {
+            test: /\\.ts$/,
+            use: 'ts-loader',
+            exclude: /node_modules/,
+          },
+        ]
+      },
+      externals: [...builtinModules, "aws-sdk"],
       output: {
-        dir: "${outputDir}",
-        format: "cjs",
-        preserveModules: true,
-        exports: "auto",
-        sourcemap: "inline",
+        filename: "[name].js",
+        path: "${outputDir}",
+        libraryTarget: "commonjs2",
       },
+      ${(props.modulesToIgnore &&
+        `
       plugins: [
-        nodeResolve({
-          preferBuiltins: true,
-        }),
-        commonjs(),
-        json(),
-      ],
-      external: ["aws-sdk", ...builtinModules],
-    };
-    `,
-    );
-
-    const rollup = spawnSync(rollupBin, ["-c", rollupConfigPath]);
+        new NormalModuleReplacementPlugin(
+          /${props.modulesToIgnore.join("|")}/,
+          "${path.join(pluginsPath, "noop2")}",
+        ),
+      ]
+      `) ||
+        ""}
+    };`;
+
+    fs.writeFileSync(webpackConfigPath, webpackConfiguration);
+
+    // to implement cache, create a script that uses webpack API, store cache in a file with JSON.stringify, based on entry path key then reuse it
+    const webpack = spawnSync(webpackBinPath, ["--config", webpackConfigPath], {
+      cwd: process.cwd(),
+    });
 
-    if (rollup.status !== 0) {
-      console.error("Rollup had an error bundling.");
-      console.error(rollup.output.map(out => out?.toString()));
+    if (webpack.status !== 0) {
+      console.error("webpack had an error when bundling.");
+      console.error(
+        webpack?.output?.map(out => {
+          return out?.toString();
+        }),
+      );
+      console.error("webpack configuration was:", webpackConfiguration);
       process.exit(1);
     }
 
-    const entryWithoutExtension = path.join(
-      path.dirname(props.entry),
-      path.basename(props.entry, path.extname(props.entry)),
-    );
+    fs.unlinkSync(webpackConfigPath);
 
     super(scope, id, {
       ...props,
       runtime,
       code: lambda.Code.fromAsset(outputDir),
-      handler: `${entryWithoutExtension}.${handler}`,
+      handler: `main.${handler}`,
     });
 
     // Enable connection reuse for aws-sdk