@adobe/helix-deploy 12.3.11 → 12.4.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [12.4.0](https://github.com/adobe/helix-deploy/compare/v12.3.11...v12.4.0) (2024-12-06)
+
+
+### Features
+
+* support `esbuild` as alternative bundler ([#760](https://github.com/adobe/helix-deploy/issues/760)) ([fc9c85a](https://github.com/adobe/helix-deploy/commit/fc9c85a7671d736fc219fb0c24b93590f68ce873))
+
 ## [12.3.11](https://github.com/adobe/helix-deploy/compare/v12.3.10...v12.3.11) (2024-12-05)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/helix-deploy",
-  "version": "12.3.11",
+  "version": "12.4.0",
   "description": "Library and Commandline Tools to build and deploy OpenWhisk Actions",
   "license": "Apache-2.0",
   "homepage": "https://github.com/adobe/helix-deploy#readme",
@@ -51,6 +51,7 @@
     "archiver": "7.0.1",
     "chalk-template": "1.1.0",
     "dotenv": "16.4.6",
+    "esbuild": "0.24.0",
     "escalade": "3.2.0",
     "fs-extra": "11.2.0",
     "isomorphic-git": "1.27.2",

package/src/BaseConfig.js

@@ -212,7 +212,8 @@ export default class BaseConfig {
       .withCleanupMinor(argv.cleanupMinor)
       .withCleanupMajor(argv.cleanupMajor)
       .withPackageToken(argv.packageToken)
-      .withProperties(argv.property);
+      .withProperties(argv.property)
+      .withBundler(argv.bundler);
   }
 
   withVerbose(enable) {
@@ -565,6 +566,14 @@ export default class BaseConfig {
     return this;
   }
 
+  withBundler(bundler) {
+    if (!bundler) {
+      return this;
+    }
+    this.bundler = bundler;
+    return this;
+  }
+
   get log() {
     if (!this._logger) {
       // poor men's logging...

package/src/bundler/ESBuildBundler.js

@@ -0,0 +1,186 @@
+/*
+ * Copyright 2019 Adobe. All rights reserved.
+ * This file is licensed to you under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License. You may obtain a copy
+ * of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under
+ * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+ * OF ANY KIND, either express or implied. See the License for the specific language
+ * governing permissions and limitations under the License.
+ */
+import { fileURLToPath } from 'url';
+import path from 'path';
+import fse from 'fs-extra';
+import * as esbuild from 'esbuild';
+import chalk from 'chalk-template';
+
+import processQueue from '@adobe/helix-shared-process-queue';
+
+import BaseBundler from './BaseBundler.js';
+
+// eslint-disable-next-line no-underscore-dangle
+const __dirname = path.resolve(fileURLToPath(import.meta.url), '..');
+
+/**
+ * Webpack based bundler
+ */
+export default class ESBuildBundler extends BaseBundler {
+  /**
+   * Create a new bundler.
+   *
+   * @param {import('../BaseConfig.js')} cfg base config
+   */
+  constructor(cfg) {
+    super(cfg);
+    this.arch = 'node';
+    this.type = 'esbuild';
+  }
+
+  async init() {
+    if (!this.cfg.esm) {
+      throw new Error('ESBuild bundler only supports ESM builds.');
+    }
+  }
+
+  async getESBuildConfig() {
+    const { cfg } = this;
+    /** @type {esbuild.BuildOptions} */
+    const opts = {
+      format: 'esm',
+      platform: 'node',
+      bundle: true,
+      outfile: path.relative(cfg.cwd, cfg.bundle),
+      external: [
+        '@aws-sdk/*',
+        // the following are imported by the universal adapter and are assumed to be available
+        './params.json',
+        'aws-sdk',
+        '@google-cloud/secret-manager',
+        '@google-cloud/storage',
+      ],
+      banner: {
+        js: [
+          'import { createRequire } from "module";',
+          'const require = createRequire(import.meta.url);',
+          '',
+        ].join('\n'),
+      },
+      entryPoints: [
+        cfg.adapterFile || path.resolve(__dirname, '..', 'template', 'node-index.mjs'),
+      ],
+      absWorkingDir: cfg.cwd,
+      plugins: [{
+        name: 'alias-main',
+        setup: (build) => {
+          build.onResolve({ filter: /^\.\/main\.js$/ }, () => ({ path: cfg.file }));
+          // use @adobe/helix-universal in the calling service, not ours
+          build.onResolve(
+            { filter: /^@adobe\/helix-universal$/ },
+            (args) => ({ path: path.resolve(cfg.cwd, 'node_modules', args.path, 'src', 'index.js') }),
+          );
+          cfg.externals.forEach((filter) => {
+            build.onResolve({ filter }, (args) => ({ path: args.path, external: true }));
+          });
+          cfg.serverlessExternals.forEach((filter) => {
+            build.onResolve({ filter }, (args) => ({ path: args.path, external: true }));
+          });
+        },
+      }],
+      metafile: true,
+    };
+    if (cfg.minify) {
+      opts.minify = cfg.minify;
+    }
+
+    if (cfg.progressHandler) {
+      this.initProgressHandler(opts, cfg);
+    }
+    return opts;
+  }
+
+  async createESBuildBundle(arch) {
+    const { cfg } = this;
+    if (!cfg.depFile) {
+      throw Error('dependencies info path is undefined');
+    }
+    const m = cfg.minify ? 'minified ' : '';
+    if (!cfg.progressHandler) {
+      cfg.log.info(`--: creating ${arch} ${m}bundle using esbuild ...`);
+    }
+    const config = await this.getESBuildConfig();
+    const result = await esbuild.build(config);
+
+    await this.resolveDependencyInfos(result.metafile);
+    // write dependencies info file
+    await fse.writeJson(cfg.depFile, cfg.dependencies, { spaces: 2 });
+    if (!cfg.progressHandler) {
+      cfg.log.info(chalk`{green ok:} created ${arch} bundle {yellow ${config.outfile}}`);
+    }
+    return result;
+  }
+
+  async createBundle() {
+    if (!this.cfg.bundle) {
+      throw Error('bundle path is undefined');
+    }
+    return this.createESBuildBundle('node');
+  }
+
+  /**
+   * Resolves the dependencies by chunk. eg:
+   *
+   * {
+   *   'src/idx_json.bundle.js': [{
+   *      id: '@adobe/helix-epsagon:1.2.0',
+   *      name: '@adobe/helix-epsagon',
+   *      version: '1.2.0' },
+   *   ],
+   *   ...
+   * }
+   */
+  async resolveDependencyInfos(metafile) {
+    const { cfg } = this;
+
+    // get list of dependencies
+    const resolved = {};
+    const deps = {};
+
+    const depNames = [...Object.keys(metafile.inputs)];
+    await processQueue(depNames, async (depName) => {
+      const absDepPath = path.resolve(cfg.cwd, depName);
+      const segs = absDepPath.split('/');
+      let idx = segs.lastIndexOf('node_modules');
+      if (idx < 0) {
+        return;
+      }
+      if (idx >= 0) {
+        idx += 1;
+        if (segs[idx].charAt(0) === '@') {
+          idx += 1;
+        }
+      }
+      segs.splice(idx + 1);
+      const dir = path.resolve('/', ...segs);
+      try {
+        if (!resolved[dir]) {
+          const pkgJson = await fse.readJson(path.resolve(dir, 'package.json'));
+          const id = `${pkgJson.name}:${pkgJson.version}`;
+          resolved[dir] = {
+            id,
+            name: pkgJson.name,
+            version: pkgJson.version,
+          };
+        }
+        const dep = resolved[dir];
+        deps[dep.id] = dep;
+      } catch (e) {
+        // ignore
+      }
+    });
+
+    // sort the deps
+    cfg.dependencies.main = Object.values(deps)
+      .sort((d0, d1) => d0.name.localeCompare(d1.name));
+  }
+}

package/src/cli.js

@@ -22,12 +22,14 @@ import AWSDeployer from './deploy/AWSDeployer.js';
 import GoogleDeployer from './deploy/GoogleDeployer.js';
 import ActionBuilder from './ActionBuilder.js';
 import WebpackBundler from './bundler/WebpackBundler.js';
+import ESBuildBundler from './bundler/ESBuildBundler.js';
 
 const PLUGINS = [
   OpenWhiskDeployer,
   AWSDeployer,
   GoogleDeployer,
   WebpackBundler,
+  ESBuildBundler,
 ];
 
 const PKG_CONF = [