@adobe/helix-deploy 4.12.2 → 4.15.0

package/CHANGELOG.md

@@ -1,3 +1,59 @@
+# [4.15.0](https://github.com/adobe/helix-deploy/compare/v4.14.1...v4.15.0) (2021-11-20)
+
+
+### Features
+
+* improve development server setup ([#338](https://github.com/adobe/helix-deploy/issues/338)) ([9d2b44a](https://github.com/adobe/helix-deploy/commit/9d2b44a6a8d14953fe351dd0b8362ebdfd4a9a6b))
+
+## [4.14.1](https://github.com/adobe/helix-deploy/compare/v4.14.0...v4.14.1) (2021-11-15)
+
+
+### Bug Fixes
+
+* update package in gateway is missing dicts ([854b87e](https://github.com/adobe/helix-deploy/commit/854b87e929dcbdc22bbc33d03f60dcf3dcd82a7b))
+
+# [4.14.0](https://github.com/adobe/helix-deploy/compare/v4.13.0...v4.14.0) (2021-11-12)
+
+
+### Bug Fixes
+
+* **bundler:** add browser-based shims as fallbacks for node core API when running in edge compute ([8f54188](https://github.com/adobe/helix-deploy/commit/8f541884f456c6c28dcb252a4fb97b88c355c272))
+* **bundler:** exclude google storage dependency (included in Google Runtime) ([024f09f](https://github.com/adobe/helix-deploy/commit/024f09f2a123b8f23643f7a894a0e195515113a9))
+* **bundler:** use `globalThis` for increased compatibility with Cloudflare Workers ([8fef7bf](https://github.com/adobe/helix-deploy/commit/8fef7bf86ef0dd42e2b209d9774df3af6402adb1))
+* **cloudflare:** remove hard-coded account id ([3a11aa1](https://github.com/adobe/helix-deploy/commit/3a11aa1602b4766c7327029a521f03068ef2824e))
+* **fastly:** fix package param code ([c77fe82](https://github.com/adobe/helix-deploy/commit/c77fe82c5b5cff3cc27efaeb57ecb2043acbb66e))
+* **fastly:** fix test domain subdomain ([ec60b2a](https://github.com/adobe/helix-deploy/commit/ec60b2a527ac8946ee5e6b44045e4ceedf8aec51))
+* **gateway:** do not attempt to perform empty updates ([e99f4be](https://github.com/adobe/helix-deploy/commit/e99f4be0af2c6a82ee098f88399b16c7d59bd027))
+* **gateway:** do not create duplicate dictionaries ([2ca6eca](https://github.com/adobe/helix-deploy/commit/2ca6eca36af22b74a3eacb43ea3a9adbda869bb8))
+* **gateway:** further massaging of gateway syntax ([4935538](https://github.com/adobe/helix-deploy/commit/49355385adfeb9589ff676e23fa0077a6682208b))
+* **gateway:** set content type of synthetic response ([873ea06](https://github.com/adobe/helix-deploy/commit/873ea067c7ff42e598605e7e0fb0d576fec51b07))
+* **gateway:** tweak synthetic syntax, again ([00f47e3](https://github.com/adobe/helix-deploy/commit/00f47e3cdc820333a56bdf1bc6524474a90d2eed))
+* **gateway:** use correct dictionary name ([91d219e](https://github.com/adobe/helix-deploy/commit/91d219e7deefb43d69850d7022cfe5aba1c894da))
+* **gateway:** use correct number of commas in JSON ([3250f6c](https://github.com/adobe/helix-deploy/commit/3250f6c2b11bd63541e8d45d28cdd55301f7bd75))
+* **template:** better check for existence of `addEventListener` ([c5d8568](https://github.com/adobe/helix-deploy/commit/c5d85684edb130a473930516b617b4a78214801d))
+
+
+### Features
+
+* **bundler:** add working cloudflare support ([09635c2](https://github.com/adobe/helix-deploy/commit/09635c2c13679e401bcc6d2b9bebe0208399b38b))
+* **cloudflare:** add support for `context.env` in wrapper ([ecc0e7b](https://github.com/adobe/helix-deploy/commit/ecc0e7bda6a55a43b81c81e0279813688889c599))
+* **cloudflare:** create KV store for package params, use env vars for action params ([d63144d](https://github.com/adobe/helix-deploy/commit/d63144d8569e3ef71f96b9eb41cdc1dfbc0aae25))
+* **cloudflare:** deploy edge script as cloudflare worker script ([66ed931](https://github.com/adobe/helix-deploy/commit/66ed931101e3b560f665d3b9d0f151c18facc72b))
+* **cloudflare:** minimal wrapper script ([bb56dcd](https://github.com/adobe/helix-deploy/commit/bb56dcd7ea5967ddccbc1aa354e43d63873d735a))
+* **fastly:** create bundle and deploy to compute at edge ([476a605](https://github.com/adobe/helix-deploy/commit/476a605e7f19aec316e093d82f7f411f2fbc0a85))
+* **fastly:** use parameters from edge dictionary ([0c586a7](https://github.com/adobe/helix-deploy/commit/0c586a78b0c0a2aa2314f914d562a5008338c568))
+* **gateway:** add basic support for package parameters in gateway ([36519e4](https://github.com/adobe/helix-deploy/commit/36519e40a1a24b4a329318b97557d06797ed8cd2))
+* **gateway:** set shared secret (token) for package parameters ([adcbd92](https://github.com/adobe/helix-deploy/commit/adcbd92b27a91ffb44a8f115da7230a6095fe37f))
+* **gateway:** update package parameters in dictionary ([5315dd4](https://github.com/adobe/helix-deploy/commit/5315dd46098cd5d4ed1c0d8eb391487d6c2dad5a))
+* **template:** support service worker API as main entry point for Fastly/Cloudflare ([ba0ec25](https://github.com/adobe/helix-deploy/commit/ba0ec25b148de242ae207e4013641dac9223df22))
+
+# [4.13.0](https://github.com/adobe/helix-deploy/compare/v4.12.2...v4.13.0) (2021-11-10)
+
+
+### Features
+
+* option to use rollup as bundler that supports ESM modules ([186ceaa](https://github.com/adobe/helix-deploy/commit/186ceaad5dbcaa931335f2dc519e4cb4cc0c5d31)), closes [#228](https://github.com/adobe/helix-deploy/issues/228) [#227](https://github.com/adobe/helix-deploy/issues/227)
+
 ## [4.12.2](https://github.com/adobe/helix-deploy/compare/v4.12.1...v4.12.2) (2021-11-06)
 
 

package/README.md

@@ -1,5 +1,5 @@
 # Helix Deploy
-> A multi-cloud deployment tool for serverless functions running on AWS Lambda, Adobe I/O Runtime, Azure Functions, and Google Cloud Functions. Write once, run everywhere.
+> A multi-cloud deployment tool for serverless and edge-compute functions running on AWS Lambda, Adobe I/O Runtime, Azure Functions, Google Cloud Functions, Cloudflare Workers, and Fastly Compute@Edge. Write once, run everywhere.
 
 ## Status
 [![GitHub license](https://img.shields.io/github/license/adobe/helix-deploy.svg)](https://github.com/adobe/helix-deploy/blob/main/LICENSE.txt)

package/index.js

@@ -10,7 +10,7 @@
  * governing permissions and limitations under the License.
  */
 const ActionBuilder = require('./src/ActionBuilder.js');
-const Bundler = require('./src/Bundler.js');
+const Bundler = require('./src/bundler/WebpackBundler.js');
 const BaseConfig = require('./src/BaseConfig.js');
 const CLI = require('./src/cli.js');
 const DevelopmentServer = require('./src/DevelopmentServer.js');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/helix-deploy",
-  "version": "4.12.2",
+  "version": "4.15.0",
   "description": "Library and Commandline Tools to build and deploy OpenWhisk Actions",
   "license": "Apache-2.0",
   "repository": {
@@ -11,7 +11,8 @@
     "url": "https://github.com/adobe/helix-deploy/issues"
   },
   "keywords": [
-    "openwhisk"
+    "helix",
+    "serverless"
   ],
   "main": "index.js",
   "bin": {
@@ -30,35 +31,46 @@
     "require": "test/setup-env.js"
   },
   "peerDependencies": {
-    "@adobe/helix-universal": ">=1.6.0"
+    "@adobe/helix-universal": ">=1.9.0"
   },
   "dependencies": {
     "@adobe/fastly-native-promises": "2.0.0",
     "@adobe/helix-fetch": "3.0.0",
-    "@aws-sdk/client-apigatewayv2": "3.40.0",
-    "@aws-sdk/client-lambda": "3.40.0",
-    "@aws-sdk/client-s3": "3.40.0",
-    "@aws-sdk/client-secrets-manager": "3.40.0",
-    "@aws-sdk/client-ssm": "3.40.0",
+    "@aws-sdk/client-apigatewayv2": "3.41.0",
+    "@aws-sdk/client-lambda": "3.41.0",
+    "@aws-sdk/client-s3": "3.41.0",
+    "@aws-sdk/client-secrets-manager": "3.41.0",
+    "@aws-sdk/client-ssm": "3.41.0",
     "@azure/arm-appservice": "9.0.0",
     "@azure/ms-rest-nodeauth": "3.1.0",
+    "@fastly/js-compute": "0.2.1",
     "@google-cloud/functions": "1.2.0",
     "@google-cloud/secret-manager": "3.10.1",
-    "@google-cloud/storage": "5.15.5",
+    "@google-cloud/storage": "5.16.0",
+    "@rollup/plugin-alias": "3.1.8",
+    "@rollup/plugin-commonjs": "21.0.1",
+    "@rollup/plugin-json": "4.1.0",
+    "@rollup/plugin-node-resolve": "13.0.6",
     "archiver": "5.3.0",
     "chalk": "4.1.2",
+    "constants-browserify": "1.0.0",
     "dotenv": "10.0.0",
     "express": "4.17.1",
+    "form-data": "4.0.0",
     "fs-extra": "10.0.0",
+    "get-stream": "6.0.1",
     "isomorphic-git": "1.10.1",
-    "openwhisk": "3.21.4",
+    "openwhisk": "3.21.5",
     "proxyquire": "2.1.3",
+    "rollup": "2.60.0",
+    "rollup-plugin-terser": "7.0.2",
     "semver": "7.3.5",
-    "webpack": "5.62.1",
+    "tar": "6.1.11",
+    "webpack": "5.64.0",
     "yargs": "17.2.1"
   },
   "devDependencies": {
-    "@adobe/eslint-config-helix": "1.3.0",
+    "@adobe/eslint-config-helix": "1.3.1",
     "@adobe/helix-shared-wrap": "1.0.0",
     "@adobe/helix-status": "9.2.4",
     "@adobe/helix-universal-logger": "2.0.0",
@@ -69,16 +81,16 @@
     "codecov": "3.8.3",
     "eslint": "8.2.0",
     "eslint-plugin-header": "3.1.1",
-    "eslint-plugin-import": "2.25.2",
+    "eslint-plugin-import": "2.25.3",
     "ghooks": "2.0.4",
-    "lint-staged": "11.2.6",
+    "lint-staged": "12.0.2",
     "mocha": "9.1.3",
     "mocha-junit-reporter": "2.0.2",
     "mocha-multi-reporters": "1.5.1",
-    "nock": "13.1.4",
+    "nock": "13.2.1",
     "nyc": "15.1.0",
     "semantic-release": "18.0.0",
-    "sinon": "11.1.2",
+    "sinon": "12.0.1",
     "yauzl": "2.10.0"
   },
   "engines": {

package/src/ActionBuilder.js

@@ -9,14 +9,28 @@
  * OF ANY KIND, either express or implied. See the License for the specific language
  * governing permissions and limitations under the License.
  */
+/* eslint-disable no-await-in-loop */
 
 const path = require('path');
 const fs = require('fs');
 const fse = require('fs-extra');
 const chalk = require('chalk');
 const git = require('isomorphic-git');
-const Bundler = require('./Bundler');
+const WebpackBundler = require('./bundler/WebpackBundler');
+const EdgeBundler = require('./bundler/EdgeBundler');
+const RollupBundler = require('./bundler/RollupBundler');
 const { version } = require('../package.json');
+
+const Bundlers = {
+  node: {
+    webpack: WebpackBundler,
+    rollup: RollupBundler,
+  },
+  edge: {
+    webpack: EdgeBundler,
+  },
+};
+
 /**
  * Returns the `origin` remote url or `''` if none is defined.
  *
@@ -184,7 +198,11 @@ module.exports = class ActionBuilder {
       cfg.zipFile = path.resolve(cfg.distDir, cfg.packageName, `${cfg.name}.zip`);
     }
     if (!cfg.bundle) {
-      cfg.bundle = path.resolve(cfg.distDir, cfg.packageName, `${cfg.name}-bundle.cjs`);
+      const ext = cfg.esm ? '.mjs' : '.cjs';
+      cfg.bundle = path.resolve(cfg.distDir, cfg.packageName, `${cfg.name}-bundle${ext}`);
+    }
+    if (!cfg.edgeBundle) {
+      cfg.edgeBundle = path.resolve(cfg.distDir, cfg.packageName, `${cfg.name}-edge-bundle.cjs`);
     }
     if (!cfg.depFile) {
       cfg.depFile = path.resolve(cfg.distDir, cfg.packageName, `${cfg.name}-dependencies.json`);
@@ -254,6 +272,30 @@ module.exports = class ActionBuilder {
     this.validated = true;
   }
 
+  async validateBundlers() {
+    if (this.validated) {
+      return;
+    }
+    // disable edge build
+
+    const { cfg } = this;
+    this.bundlers = [];
+    cfg.archs.forEach((arch) => {
+      const bnds = Bundlers[arch];
+      if (!bnds) {
+        throw Error(`Invalid arch '${arch}' specified. Valid options are: ${Object.keys(Bundlers)}`);
+      }
+      const BundlerClass = bnds[cfg.bundler];
+      if (!BundlerClass) {
+        throw Error(`Invalid bundler '${cfg.bundler}' for '${arch}'. Valid options are: ${Object.keys(bnds)}`);
+      }
+      this.bundlers.push(new BundlerClass().withConfig(cfg));
+    });
+    for (const bundler of this.bundlers) {
+      await bundler.init();
+    }
+  }
+
   async execute(fnName, msg, ...args) {
     const { cfg } = this;
     const deps = Object.values(this._deployers)
@@ -333,14 +375,14 @@ module.exports = class ActionBuilder {
     cfg.log.info(chalk`{grey universal-action-builder v${version}}`);
     await this.validate();
     await this.validateAdditionalTasks();
-
-    const bundler = new Bundler().withConfig(cfg);
-    await bundler.init();
+    await this.validateBundlers();
 
     if (cfg.build) {
-      await bundler.createBundle();
-      await bundler.createArchive();
-      await bundler.validateBundle();
+      for (const bundler of this.bundlers) {
+        await bundler.createBundle();
+        await bundler.createArchive();
+        await bundler.validateBundle();
+      }
     }
 
     if (cfg.updatePackage) {
@@ -354,7 +396,9 @@ module.exports = class ActionBuilder {
         const relZip = path.relative(process.cwd(), cfg.zipFile);
         cfg.log.info(chalk`{green ok:} using: {yellow ${relZip}}.`);
         cfg.dependencies = await fse.readJson(cfg.depFile);
-        await bundler.validateBundle();
+        for (const bundler of this.bundlers) {
+          await bundler.validateBundle();
+        }
       }
       await this.deploy();
     }
@@ -379,22 +423,32 @@ module.exports = class ActionBuilder {
       await this.runCleanup();
     }
 
+    // update gateway
     if (this._gateways.fastly && this._gateways.fastly.ready()) {
-      await this.validateDeployers();
-      Object.values(this._deployers).forEach((d) => {
-        this._gateways.fastly.withDeployer(d);
-      });
+      Object.values(this._deployers)
+        .filter((deployer) => !deployer.noGatewayBackend)
+        .forEach((deplyer) => {
+          this._gateways.fastly.withDeployer(deplyer);
+        });
 
-      this._gateways.fastly.init();
-      await this._gateways.fastly.deploy();
-    }
+      const updateLinks = cfg.links && cfg.links.length;
+      const updatePackage = cfg.updatePackage && cfg.packageParams && cfg.packageToken;
 
-    if (this._gateways.fastly
-      && this._gateways.fastly.updateable()
-      && cfg.links && cfg.links.length) {
-      await this.validateDeployers();
-      this._gateways.fastly.init();
-      await this._gateways.fastly.updateLinks(cfg.links, cfg.version);
+      // links and package also need a deployed gateway
+      if ((updateLinks || updatePackage || cfg.deploy)) {
+        this._gateways.fastly.init();
+        if (this._gateways.fastly.canDeploy()) {
+          await this._gateways.fastly.deploy();
+        }
+      }
+
+      if (updateLinks) {
+        await this._gateways.fastly.updateLinks(cfg.links, cfg.version);
+      }
+
+      if (updatePackage) {
+        await this._gateways.fastly.updatePackage();
+      }
     }
 
     if (cfg.deploy) {

package/src/BaseConfig.js

@@ -87,6 +87,9 @@ class BaseConfig {
       updatedBy: null,
       targets: [],
       functionURL: '',
+      esm: false,
+      archs: ['node', 'edge'],
+      bundler: 'webpack',
       format: {
         aws: DEFAULT_ACTION_FORMAT,
       },
@@ -162,8 +165,11 @@ class BaseConfig {
       .withVerbose(argv.verbose)
       .withDirectory(argv.directory)
       .withTarget(argv.target)
+      .withArch(argv.arch)
       .withBuild(argv.build)
       .withMinify(argv.minify)
+      .withESM(argv.esm)
+      .withBundler(argv.bundler)
       .withDelete(argv.delete)
       .withDeploy(argv.deploy)
       .withTest(argv.test)
@@ -199,6 +205,7 @@ class BaseConfig {
       .withCleanupPatch(argv.cleanupPatch)
       .withCleanupMinor(argv.cleanupMinor)
       .withCleanupMajor(argv.cleanupMajor)
+      .withPackageToken(argv.packageToken)
       .withProperties(argv.property);
   }
 
@@ -222,6 +229,16 @@ class BaseConfig {
     return this;
   }
 
+  withArch(value) {
+    this.archs = [];
+    value.forEach((v) => {
+      v.split(',').forEach((t) => {
+        this.archs.push(t.trim());
+      });
+    });
+    return this;
+  }
+
   withDeploy(enable) {
     this.deploy = enable;
     return this;
@@ -237,6 +254,16 @@ class BaseConfig {
     return this;
   }
 
+  withESM(enable) {
+    this.esm = enable;
+    return this;
+  }
+
+  withBundler(bundler) {
+    this.bundler = bundler;
+    return this;
+  }
+
   withDelete(enable) {
     this.delete = enable;
     return this;
@@ -507,6 +534,11 @@ class BaseConfig {
     return this;
   }
 
+  withPackageToken(value) {
+    this.packageToken = value;
+    return this;
+  }
+
   get log() {
     if (!this._logger) {
       // poor men's logging...
@@ -572,12 +604,22 @@ class BaseConfig {
         default: false,
       })
 
-      .group(['minify', 'static', 'entryFile', 'externals', 'modules', 'adapterFile'], 'Build Options')
+      .group(['minify', 'static', 'entryFile', 'externals', 'modules', 'adapterFile', 'esm', 'bundler'], 'Build Options')
       .option('minify', {
         description: 'Minify the final bundle',
         type: 'boolean',
         default: false,
       })
+      .option('bundler', {
+        description: 'Select bundler backend (webpack, rollup)',
+        type: 'string',
+        default: 'webpack',
+      })
+      .option('esm', {
+        description: 'Produce EcmaScript Module (experimental, disables edge arch)',
+        type: 'boolean',
+        default: false,
+      })
       .option('modules', {
         alias: 'm',
         description: 'Include a node_module as is.',
@@ -598,10 +640,16 @@ class BaseConfig {
         description: 'Specifies the adapter file (the exported module).',
       })
       .option('externals', {
-        description: 'Defines the externals for webpack.',
+        description: 'Defines the externals for the bundler.',
         type: 'array',
         default: [],
       })
+      .option('arch', {
+        description: 'Select archs(s) for bundles (node,edge).',
+        type: 'string',
+        default: ['node'],
+        array: true,
+      })
 
       .group(['target', 'hints'], 'Deploy Options')
       .option('target', {
@@ -662,8 +710,10 @@ class BaseConfig {
         type: 'object',
         default: {},
       })
-      .group(['cleanup-ci', 'cleanup-patch', 'cleanup-minor', 'cleanup-major'],
-        'Cleanup Old Deployments: automatically delete redundant versions older than specified. \n  Use a pattern like 7d or 1m to specify time frames.\n  Use a simple number like --cleanup-ci=5 to retain the last five CI builds')
+      .group(
+        ['cleanup-ci', 'cleanup-patch', 'cleanup-minor', 'cleanup-major'],
+        'Cleanup Old Deployments: automatically delete redundant versions older than specified. \n  Use a pattern like 7d or 1m to specify time frames.\n  Use a simple number like --cleanup-ci=5 to retain the last five CI builds',
+      )
       .option('cleanup-ci', {
         description: 'Automatically delete redundant CI versions',
         coerce: coerceDate,
@@ -710,6 +760,11 @@ class BaseConfig {
           return value;
         },
       })
+      .option('package-token', {
+        description: 'Protects access to the gateway-stored package parameters with this token. leave empty to generate random token.',
+        type: 'string',
+        default: crypto.randomBytes(32).toString('base64'),
+      })
       .option('params', {
         alias: 'p',
         description: 'Include the given action param. can be json or env.',

package/src/DevelopmentServer.js

@@ -70,6 +70,7 @@ module.exports = class DevelopmentServer {
     this._main = main;
     this._cwd = process.cwd();
     this._port = process.env.WEBSERVER_PORT || 3000;
+    this._xfh = 'helix-pages.anywhere.run';
   }
 
   withPort(value) {
@@ -77,6 +78,11 @@ module.exports = class DevelopmentServer {
     return this;
   }
 
+  withXFH(value) {
+    this._xfh = value;
+    return this;
+  }
+
   get port() {
     return this._port;
   }
@@ -131,21 +137,21 @@ module.exports = class DevelopmentServer {
    */
   async start() {
     this.app = express();
-    this.app.use(rawBody());
-    this.app.use(addRequestHeader('x-forwarded-host', 'helix-pages.anywhere.run'));
-    this.app.all('*', this._handler);
     await new Promise((resolve, reject) => {
       try {
         this.server = this.app.listen(this._port, () => {
           this._port = this.server.address().port;
           // eslint-disable-next-line no-console
-          console.log(`Started development server on port ${this._port}`);
+          console.log(`Started development server at http://localhost:${this._port}/`);
           resolve();
         });
       } catch (e) {
         reject(e);
       }
     });
+    this.app.use(rawBody());
+    this.app.use(addRequestHeader('x-forwarded-host', this._xfh.replace('{port}', this._port)));
+    this.app.all('*', this._handler);
   }
 
   /**