feat: Turn esbuild into its own workflow (#320)

* Create new esbuild workflow

* Fix esbuild workflow capability

Author: mildaniel

aws_lambda_builders/workflows/__init__.py

@@ -11,3 +11,4 @@
 import aws_lambda_builders.workflows.java_maven
 import aws_lambda_builders.workflows.dotnet_clipackage
 import aws_lambda_builders.workflows.custom_make
+import aws_lambda_builders.workflows.nodejs_npm_esbuild

aws_lambda_builders/workflows/nodejs_npm/DESIGN.md

@@ -323,7 +323,7 @@ directly.
 }
 ```
 
-For a full example, see the [`with-deps-esbuild`](../../../tests/integration/workflows/nodejs_npm/testdata/with-deps-esbuild/) test project.
+For a full example, see the [`with-deps-esbuild`](../../../tests/integration/workflows/nodejs_npm_esbuild/testdata/with-deps-esbuild/) test project.
 
 #### Building typescript
 
@@ -350,7 +350,7 @@ as in the example below. There is no transpiling process needed upfront.
 }
 ```
 
-For a full example, see the [`with-deps-esbuild-typescript`](../../../tests/integration/workflows/nodejs_npm/testdata/with-deps-esbuild-typescript/) test project.
+For a full example, see the [`with-deps-esbuild-typescript`](../../../tests/integration/workflows/nodejs_npm_esbuild/testdata/with-deps-esbuild-typescript/) test project.
 
 **important note:** esbuild does not perform type checking, so users wanting to ensure type-checks need to run the `tsc` process as part of their 
 testing flow before invoking `sam build`. For additional typescript caveats with esbuild, check out <https://esbuild.github.io/content-types/#typescript>.

aws_lambda_builders/workflows/nodejs_npm/actions.py

@@ -6,7 +6,6 @@
 
 from aws_lambda_builders.actions import BaseAction, Purpose, ActionFailedError
 from .npm import NpmExecutionError
-from .esbuild import EsbuildExecutionError
 
 LOG = logging.getLogger(__name__)
 
@@ -287,79 +286,3 @@ def execute(self):
 
         except OSError as ex:
             raise ActionFailedError(str(ex))
-
-
-class EsbuildBundleAction(BaseAction):
-
-    """
-    A Lambda Builder Action that packages a Node.js package using esbuild into a single file
-    optionally transpiling TypeScript
-    """
-
-    NAME = "EsbuildBundle"
-    DESCRIPTION = "Packaging source using Esbuild"
-    PURPOSE = Purpose.COPY_SOURCE
-
-    def __init__(self, source_dir, artifacts_dir, bundler_config, osutils, subprocess_esbuild):
-        """
-        :type source_dir: str
-        :param source_dir: an existing (readable) directory containing source files
-
-
-        :type artifacts_dir: str
-        :param artifacts_dir: an existing (writable) directory where to store the output.
-            Note that the actual result will be in the 'package' subdirectory here.
-
-        :type osutils: aws_lambda_builders.workflows.nodejs_npm.utils.OSUtils
-        :param osutils: An instance of OS Utilities for file manipulation
-
-        :type subprocess_esbuild: aws_lambda_builders.workflows.nodejs_npm.npm.SubprocessEsbuild
-        :param subprocess_esbuild: An instance of the Esbuild process wrapper
-        """
-        super(EsbuildBundleAction, self).__init__()
-        self.source_dir = source_dir
-        self.artifacts_dir = artifacts_dir
-        self.bundler_config = bundler_config
-        self.osutils = osutils
-        self.subprocess_esbuild = subprocess_esbuild
-
-    def execute(self):
-        """
-        Runs the action.
-
-        :raises lambda_builders.actions.ActionFailedError: when esbuild packaging fails
-        """
-
-        if "entry_points" not in self.bundler_config:
-            raise ActionFailedError("entry_points not set ({})".format(self.bundler_config))
-
-        entry_points = self.bundler_config["entry_points"]
-
-        if not isinstance(entry_points, list):
-            raise ActionFailedError("entry_points must be a list ({})".format(self.bundler_config))
-
-        if not entry_points:
-            raise ActionFailedError("entry_points must not be empty ({})".format(self.bundler_config))
-
-        entry_paths = [self.osutils.joinpath(self.source_dir, entry_point) for entry_point in entry_points]
-
-        LOG.debug("NODEJS building %s using esbuild to %s", entry_paths, self.artifacts_dir)
-
-        for entry_point in entry_paths:
-            if not self.osutils.file_exists(entry_point):
-                raise ActionFailedError("entry point {} does not exist".format(entry_point))
-
-        args = entry_points + ["--bundle", "--platform=node", "--format=cjs"]
-        minify = self.bundler_config.get("minify", True)
-        sourcemap = self.bundler_config.get("sourcemap", True)
-        target = self.bundler_config.get("target", "es2020")
-        if minify:
-            args.append("--minify")
-        if sourcemap:
-            args.append("--sourcemap")
-        args.append("--target={}".format(target))
-        args.append("--outdir={}".format(self.artifacts_dir))
-        try:
-            self.subprocess_esbuild.run(args, cwd=self.source_dir)
-        except EsbuildExecutionError as ex:
-            raise ActionFailedError(str(ex))

aws_lambda_builders/workflows/nodejs_npm/utils.py

@@ -9,8 +9,6 @@
 import shutil
 import json
 
-EXPERIMENTAL_FLAG_ESBUILD = "experimentalEsbuild"
-
 
 class OSUtils(object):
 
@@ -55,10 +53,3 @@ def is_windows(self):
     def parse_json(self, path):
         with open(path) as json_file:
             return json.load(json_file)
-
-
-def is_experimental_esbuild_scope(experimental_flags):
-    """
-    A function which will determine if experimental esbuild scope is active
-    """
-    return bool(experimental_flags) and EXPERIMENTAL_FLAG_ESBUILD in experimental_flags

aws_lambda_builders/workflows/nodejs_npm/workflow.py

@@ -3,8 +3,6 @@
 """
 
 import logging
-import json
-from typing import List
 
 from aws_lambda_builders.path_resolver import PathResolver
 from aws_lambda_builders.workflow import BaseWorkflow, Capability
@@ -13,22 +11,17 @@
     CleanUpAction,
     CopyDependenciesAction,
     MoveDependenciesAction,
-    BaseAction,
 )
-from aws_lambda_builders.utils import which
-from aws_lambda_builders.exceptions import WorkflowFailedError
+
 from .actions import (
     NodejsNpmPackAction,
     NodejsNpmLockFileCleanUpAction,
     NodejsNpmInstallAction,
     NodejsNpmrcCopyAction,
     NodejsNpmrcCleanUpAction,
-    NodejsNpmCIAction,
-    EsbuildBundleAction,
 )
-from .utils import OSUtils, is_experimental_esbuild_scope
+from .utils import OSUtils
 from .npm import SubprocessNpm
-from .esbuild import SubprocessEsbuild
 
 LOG = logging.getLogger(__name__)
 
@@ -64,16 +57,9 @@ def __init__(self, source_dir, artifacts_dir, scratch_dir, manifest_path, runtim
 
         subprocess_npm = SubprocessNpm(osutils)
 
-        manifest_config = self.get_manifest_config(osutils, manifest_path)
-
-        if manifest_config["bundler"] == "esbuild" and is_experimental_esbuild_scope(self.experimental_flags):
-            self.actions = self.actions_with_bundler(
-                source_dir, artifacts_dir, manifest_config, osutils, subprocess_npm
-            )
-        else:
-            self.actions = self.actions_without_bundler(
-                source_dir, artifacts_dir, scratch_dir, manifest_path, osutils, subprocess_npm
-            )
+        self.actions = self.actions_without_bundler(
+            source_dir, artifacts_dir, scratch_dir, manifest_path, osutils, subprocess_npm
+        )
 
     def actions_without_bundler(self, source_dir, artifacts_dir, scratch_dir, manifest_path, osutils, subprocess_npm):
         """
@@ -147,67 +133,6 @@ def actions_without_bundler(self, source_dir, artifacts_dir, scratch_dir, manife
 
         return actions
 
-    def actions_with_bundler(self, source_dir, artifacts_dir, bundler_config, osutils, subprocess_npm):
-        """
-        Generate a list of Nodejs build actions with a bundler
-
-        :type source_dir: str
-        :param source_dir: an existing (readable) directory containing source files
-
-        :type artifacts_dir: str
-        :param artifacts_dir: an existing (writable) directory where to store the output.
-
-        :type bundler_config: dict
-        :param bundler_config: configurations for the bundler action
-
-        :type osutils: aws_lambda_builders.workflows.nodejs_npm.utils.OSUtils
-        :param osutils: An instance of OS Utilities for file manipulation
-
-        :type subprocess_npm: aws_lambda_builders.workflows.nodejs_npm.npm.SubprocessNpm
-        :param subprocess_npm: An instance of the NPM process wrapper
-
-        :rtype: list
-        :return: List of build actions to execute
-        """
-        lockfile_path = osutils.joinpath(source_dir, "package-lock.json")
-        shrinkwrap_path = osutils.joinpath(source_dir, "npm-shrinkwrap.json")
-        npm_bin_path = subprocess_npm.run(["bin"], cwd=source_dir)
-        executable_search_paths = [npm_bin_path]
-        if self.executable_search_paths is not None:
-            executable_search_paths = executable_search_paths + self.executable_search_paths
-        subprocess_esbuild = SubprocessEsbuild(osutils, executable_search_paths, which=which)
-
-        if osutils.file_exists(lockfile_path) or osutils.file_exists(shrinkwrap_path):
-            install_action = NodejsNpmCIAction(source_dir, subprocess_npm=subprocess_npm)
-        else:
-            install_action = NodejsNpmInstallAction(source_dir, subprocess_npm=subprocess_npm, is_production=False)
-
-        esbuild_action = EsbuildBundleAction(source_dir, artifacts_dir, bundler_config, osutils, subprocess_esbuild)
-        return [install_action, esbuild_action]
-
-    def get_manifest_config(self, osutils, manifest_path):
-        """
-        Get the aws_sam specific properties from the manifest, if they exist.
-
-        :type osutils: aws_lambda_builders.workflows.nodejs_npm.utils.OSUtils
-        :param osutils: An instance of OS Utilities for file manipulation
-
-        :type manifest_path: str
-        :param manifest_path: Path to the manifest file
-
-        :rtype: dict
-        :return: Dict with aws_sam specific bundler configs
-        """
-        LOG.debug("NODEJS reading manifest from %s", manifest_path)
-        try:
-            manifest = osutils.parse_json(manifest_path)
-            if self.CONFIG_PROPERTY in manifest and isinstance(manifest[self.CONFIG_PROPERTY], dict):
-                return manifest[self.CONFIG_PROPERTY]
-            else:
-                return {"bundler": ""}
-        except (OSError, json.decoder.JSONDecodeError) as ex:
-            raise WorkflowFailedError(workflow_name=self.NAME, action_name="ParseManifest", reason=str(ex))
-
     def get_resolvers(self):
         """
         specialized path resolver that just returns the list of executable for the runtime on the path.

aws_lambda_builders/workflows/nodejs_npm_esbuild/__init__.py

@@ -0,0 +1,5 @@
+"""
+Builds NodeJS Lambda functions using NPM dependency manager with esbuild bundler
+"""
+
+from .workflow import NodejsNpmEsbuildWorkflow

aws_lambda_builders/workflows/nodejs_npm_esbuild/actions.py

@@ -0,0 +1,84 @@
+"""
+Actions specific to the esbuild bundler
+"""
+import logging
+from aws_lambda_builders.actions import BaseAction, Purpose, ActionFailedError
+from .esbuild import EsbuildExecutionError
+
+LOG = logging.getLogger(__name__)
+
+
+class EsbuildBundleAction(BaseAction):
+
+    """
+    A Lambda Builder Action that packages a Node.js package using esbuild into a single file
+    optionally transpiling TypeScript
+    """
+
+    NAME = "EsbuildBundle"
+    DESCRIPTION = "Packaging source using Esbuild"
+    PURPOSE = Purpose.COPY_SOURCE
+
+    def __init__(self, source_dir, artifacts_dir, bundler_config, osutils, subprocess_esbuild):
+        """
+        :type source_dir: str
+        :param source_dir: an existing (readable) directory containing source files
+
+
+        :type artifacts_dir: str
+        :param artifacts_dir: an existing (writable) directory where to store the output.
+            Note that the actual result will be in the 'package' subdirectory here.
+
+        :type osutils: aws_lambda_builders.workflows.nodejs_npm.utils.OSUtils
+        :param osutils: An instance of OS Utilities for file manipulation
+
+        :type subprocess_esbuild: aws_lambda_builders.workflows.nodejs_npm.npm.SubprocessEsbuild
+        :param subprocess_esbuild: An instance of the Esbuild process wrapper
+        """
+        super(EsbuildBundleAction, self).__init__()
+        self.source_dir = source_dir
+        self.artifacts_dir = artifacts_dir
+        self.bundler_config = bundler_config
+        self.osutils = osutils
+        self.subprocess_esbuild = subprocess_esbuild
+
+    def execute(self):
+        """
+        Runs the action.
+
+        :raises lambda_builders.actions.ActionFailedError: when esbuild packaging fails
+        """
+
+        if "entry_points" not in self.bundler_config:
+            raise ActionFailedError("entry_points not set ({})".format(self.bundler_config))
+
+        entry_points = self.bundler_config["entry_points"]
+
+        if not isinstance(entry_points, list):
+            raise ActionFailedError("entry_points must be a list ({})".format(self.bundler_config))
+
+        if not entry_points:
+            raise ActionFailedError("entry_points must not be empty ({})".format(self.bundler_config))
+
+        entry_paths = [self.osutils.joinpath(self.source_dir, entry_point) for entry_point in entry_points]
+
+        LOG.debug("NODEJS building %s using esbuild to %s", entry_paths, self.artifacts_dir)
+
+        for entry_point in entry_paths:
+            if not self.osutils.file_exists(entry_point):
+                raise ActionFailedError("entry point {} does not exist".format(entry_point))
+
+        args = entry_points + ["--bundle", "--platform=node", "--format=cjs"]
+        minify = self.bundler_config.get("minify", True)
+        sourcemap = self.bundler_config.get("sourcemap", True)
+        target = self.bundler_config.get("target", "es2020")
+        if minify:
+            args.append("--minify")
+        if sourcemap:
+            args.append("--sourcemap")
+        args.append("--target={}".format(target))
+        args.append("--outdir={}".format(self.artifacts_dir))
+        try:
+            self.subprocess_esbuild.run(args, cwd=self.source_dir)
+        except EsbuildExecutionError as ex:
+            raise ActionFailedError(str(ex))

aws_lambda_builders/workflows/nodejs_npm/esbuild.py renamed to aws_lambda_builders/workflows/nodejs_npm_esbuild/esbuild.py

@@ -0,0 +1,12 @@
+"""
+esbuild specific utilities and feature flag
+"""
+
+EXPERIMENTAL_FLAG_ESBUILD = "experimentalEsbuild"
+
+
+def is_experimental_esbuild_scope(experimental_flags):
+    """
+    A function which will determine if experimental esbuild scope is active
+    """
+    return bool(experimental_flags) and EXPERIMENTAL_FLAG_ESBUILD in experimental_flags