@adobe/helix-deploy 4.14.0 → 5.0.0

package/CHANGELOG.md

@@ -1,3 +1,36 @@
+# [5.0.0](https://github.com/adobe/helix-deploy/compare/v4.15.1...v5.0.0) (2021-12-02)
+
+
+### Features
+
+* convert to ESM ([2946721](https://github.com/adobe/helix-deploy/commit/294672121135f32495cc48e58f636553b3473489))
+
+
+### BREAKING CHANGES
+
+* exported APIs only available through ESM
+
+## [4.15.1](https://github.com/adobe/helix-deploy/compare/v4.15.0...v4.15.1) (2021-11-20)
+
+
+### Bug Fixes
+
+* **deps:** update external fixes ([21e2af6](https://github.com/adobe/helix-deploy/commit/21e2af69186b80607747d390aa4f98507b02e070))
+
+# [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)
 
 

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "@adobe/helix-deploy",
-  "version": "4.14.0",
+  "version": "5.0.0",
   "description": "Library and Commandline Tools to build and deploy OpenWhisk Actions",
   "license": "Apache-2.0",
+  "homepage": "https://github.com/adobe/helix-deploy#readme",
   "repository": {
     "type": "git",
     "url": "https://github.com/adobe/helix-deploy.git"
@@ -15,15 +16,17 @@
     "serverless"
   ],
   "main": "index.js",
+  "type": "module",
   "bin": {
     "hedy": "src/index.js"
   },
   "scripts": {
     "lint": "eslint .",
-    "test": "nyc mocha -i -g Integration",
-    "test-ci": "npm run lint && nyc mocha -i -g Integration && codecov",
-    "integration-ci": "nyc mocha --reporter-options=configFile=.mocha-multi.json -g Integration && codecov",
-    "semantic-release": "semantic-release"
+    "test": "c8 mocha -i -g Integration",
+    "test-ci": "npm run lint && c8 mocha -i -g Integration && codecov",
+    "integration-ci": "c8 mocha -g Integration && codecov",
+    "semantic-release": "semantic-release",
+    "prepare": "husky install"
   },
   "mocha": {
     "reporter": "mocha-multi-reporters",
@@ -36,19 +39,19 @@
   "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.42.0",
+    "@aws-sdk/client-lambda": "3.42.0",
+    "@aws-sdk/client-s3": "3.42.0",
+    "@aws-sdk/client-secrets-manager": "3.42.0",
+    "@aws-sdk/client-ssm": "3.42.0",
     "@azure/arm-appservice": "9.0.0",
     "@azure/ms-rest-nodeauth": "3.1.0",
-    "@fastly/js-compute": "0.2.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",
-    "@rollup/plugin-alias": "3.1.6",
-    "@rollup/plugin-commonjs": "21.0.0",
+    "@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",
@@ -60,13 +63,13 @@
     "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.58.0",
+    "rollup": "2.60.1",
     "rollup-plugin-terser": "7.0.2",
     "semver": "7.3.5",
     "tar": "6.1.11",
-    "webpack": "5.62.1",
+    "webpack": "5.64.4",
     "yargs": "17.2.1"
   },
   "devDependencies": {
@@ -76,20 +79,20 @@
     "@adobe/helix-universal-logger": "2.0.0",
     "@semantic-release/changelog": "6.0.1",
     "@semantic-release/git": "10.0.1",
+    "c8": "7.10.0",
     "chai": "4.3.4",
     "chai-http": "4.3.0",
     "codecov": "3.8.3",
-    "eslint": "8.2.0",
+    "eslint": "8.3.0",
     "eslint-plugin-header": "3.1.1",
-    "eslint-plugin-import": "2.25.2",
-    "ghooks": "2.0.4",
-    "lint-staged": "11.2.6",
+    "eslint-plugin-import": "2.25.3",
+    "husky": "7.0.4",
+    "lint-staged": "12.1.2",
     "mocha": "9.1.3",
     "mocha-junit-reporter": "2.0.2",
     "mocha-multi-reporters": "1.5.1",
-    "nock": "13.1.4",
-    "nyc": "15.1.0",
-    "semantic-release": "18.0.0",
+    "nock": "13.2.1",
+    "semantic-release": "18.0.1",
     "sinon": "12.0.1",
     "yauzl": "2.10.0"
   },
@@ -98,11 +101,5 @@
   },
   "lint-staged": {
     "*.js": "eslint"
-  },
-  "config": {
-    "ghooks": {
-      "pre-commit": "npx lint-staged"
-    }
-  },
-  "homepage": "https://github.com/adobe/helix-deploy#readme"
+  }
 }

package/src/ActionBuilder.js

@@ -11,15 +11,15 @@
  */
 /* 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 WebpackBundler = require('./bundler/WebpackBundler');
-const EdgeBundler = require('./bundler/EdgeBundler');
-const RollupBundler = require('./bundler/RollupBundler');
-const { version } = require('../package.json');
+import path from 'path';
+import fs from 'fs';
+import fse from 'fs-extra';
+import chalk from 'chalk';
+import git from 'isomorphic-git';
+import WebpackBundler from './bundler/WebpackBundler.js';
+import EdgeBundler from './bundler/EdgeBundler.js';
+import RollupBundler from './bundler/RollupBundler.js';
+import pkgJson from './package.cjs';
 
 const Bundlers = {
   node: {
@@ -62,7 +62,7 @@ async function getCurrentRevision(dir) {
   }
 }
 
-module.exports = class ActionBuilder {
+export default class ActionBuilder {
   /**
    * Iterates the given params and resolves potential file references.
    * @param {object} params the params
@@ -372,7 +372,7 @@ module.exports = class ActionBuilder {
 
   async _run() {
     const { cfg } = this;
-    cfg.log.info(chalk`{grey universal-action-builder v${version}}`);
+    cfg.log.info(chalk`{grey universal-action-builder v${pkgJson.version}}`);
     await this.validate();
     await this.validateAdditionalTasks();
     await this.validateBundlers();
@@ -423,29 +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 (this._gateways.fastly
-      && this._gateways.fastly.updateable()
-      && cfg.packageParams && cfg.packageToken) {
-      this._gateways.fastly.init();
-      await this._gateways.fastly.updatePackage();
+      if (updatePackage) {
+        await this._gateways.fastly.updatePackage();
+      }
     }
 
     if (cfg.deploy) {
@@ -463,4 +466,4 @@ module.exports = class ActionBuilder {
     await this.runAdditionalTasks();
     return '';
   }
-};
+}

package/src/BaseConfig.js

@@ -9,11 +9,11 @@
  * OF ANY KIND, either express or implied. See the License for the specific language
  * governing permissions and limitations under the License.
  */
-const crypto = require('crypto');
-const path = require('path');
-const fse = require('fs-extra');
-const chalk = require('chalk');
-const dotenv = require('dotenv');
+import crypto from 'crypto';
+import path from 'path';
+import fse from 'fs-extra';
+import chalk from 'chalk';
+import dotenv from 'dotenv';
 
 // eslint-disable-next-line no-template-curly-in-string
 const DEFAULT_ACTION_FORMAT = '/${packageName}/${baseName}/${version}';
@@ -41,7 +41,7 @@ function coerceDate(value) {
  * @field baseName Name of the function w/o the version. eg `my-action`
  * @field packageName Name of the function package. eg `my-package`
  */
-class BaseConfig {
+export default class BaseConfig {
   constructor() {
     Object.assign(this, {
       cwd: process.cwd(),
@@ -806,5 +806,3 @@ class BaseConfig {
       });
   }
 }
-
-module.exports = BaseConfig;

package/src/DevelopmentServer.js

@@ -9,12 +9,16 @@
  * OF ANY KIND, either express or implied. See the License for the specific language
  * governing permissions and limitations under the License.
  */
-const fse = require('fs-extra');
-const path = require('path');
-const express = require('express');
+import { createRequire } from 'module';
+import fse from 'fs-extra';
+import path from 'path';
+import express from 'express';
+import ActionBuilder from './ActionBuilder.js';
+import BaseConfig from './BaseConfig.js';
+
+// load proxyquire specially since it doesn't support ESM yet.
+const require = createRequire(import.meta.url);
 const proxyquire = require('proxyquire').noCallThru();
-const ActionBuilder = require('./ActionBuilder');
-const BaseConfig = require('./BaseConfig.js');
 
 function rawBody() {
   return (req, res, next) => {
@@ -61,7 +65,7 @@ function addRequestHeader(name, value) {
  *
  * @type {DevelopmentServer}
  */
-module.exports = class DevelopmentServer {
+export default class DevelopmentServer {
   /**
    * Creates a new development server using the given universal function.
    * @param {UniversalFunction} main - The universal function
@@ -70,6 +74,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 +82,11 @@ module.exports = class DevelopmentServer {
     return this;
   }
 
+  withXFH(value) {
+    this._xfh = value;
+    return this;
+  }
+
   get port() {
     return this._port;
   }
@@ -131,21 +141,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);
   }
 
   /**
@@ -163,4 +173,4 @@ module.exports = class DevelopmentServer {
       });
     });
   }
-};
+}

package/src/bundler/BaseBundler.js

@@ -9,19 +9,22 @@
  * OF ANY KIND, either express or implied. See the License for the specific language
  * governing permissions and limitations under the License.
  */
-
-const path = require('path');
-const fse = require('fs-extra');
-const chalk = require('chalk');
-const archiver = require('archiver');
-const semver = require('semver');
-const { validateBundle } = require('../utils.js');
-const { dependencies } = require('../../package.json');
+import path from 'path';
+import { fileURLToPath } from 'url';
+import fse from 'fs-extra';
+import chalk from 'chalk';
+import archiver from 'archiver';
+import semver from 'semver';
+import { validateBundle } from '../utils.js';
+import pkgJson from '../package.cjs';
+
+// eslint-disable-next-line no-underscore-dangle
+const __dirname = path.resolve(fileURLToPath(import.meta.url), '..');
 
 /**
  * Base for all bundlers
  */
-module.exports = class BaseBundler {
+export default class BaseBundler {
   /**
    * Simple string substitute. Replaces all `${key}` occurrences from the given object.
    * @param {string} str string to substitute
@@ -112,8 +115,8 @@ module.exports = class BaseBundler {
           // google cloud installs these dependencies at deploy time
           // all other environments ignore them – this allows us to
           // avoid bundling something that only google needs
-          '@google-cloud/secret-manager': dependencies['@google-cloud/secret-manager'],
-          '@google-cloud/storage': dependencies['@google-cloud/storage'],
+          '@google-cloud/secret-manager': pkgJson.dependencies['@google-cloud/secret-manager'],
+          '@google-cloud/storage': pkgJson.dependencies['@google-cloud/storage'],
         },
       };
       archive.pipe(output);
@@ -186,4 +189,4 @@ module.exports = class BaseBundler {
       archive.file(path.resolve(__dirname, '..', 'template', 'aws-esm-adapter.js'), { name: 'esm-adapter/index.js' });
     }
   }
-};
+}

package/src/bundler/EdgeBundler.js

@@ -9,15 +9,18 @@
  * 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 webpack from 'webpack';
+import WebpackBundler from './WebpackBundler.js';
 
-const path = require('path');
-const webpack = require('webpack');
-const WebpackBundler = require('./WebpackBundler.js');
+// eslint-disable-next-line no-underscore-dangle
+const __dirname = path.resolve(fileURLToPath(import.meta.url), '..');
 
 /**
  * Creates the action bundle
  */
-module.exports = class EdgeBundler extends WebpackBundler {
+export default class EdgeBundler extends WebpackBundler {
   async getWebpackConfig() {
     const { cfg } = this;
     const opts = {
@@ -48,8 +51,11 @@ module.exports = class EdgeBundler extends WebpackBundler {
       }, {}),
       module: {
         rules: [{
-          test: /\.mjs$/,
+          test: /\.js$/,
           type: 'javascript/auto',
+        }, {
+          test: /\.mjs$/,
+          type: 'javascript/esm',
         }],
       },
       resolve: {
@@ -115,4 +121,4 @@ module.exports = class EdgeBundler extends WebpackBundler {
     }
     return this.createWebpackBundle('edge');
   }
-};
+}

package/src/bundler/RollupBundler.js

@@ -10,21 +10,26 @@
  * governing permissions and limitations under the License.
  */
 
-const path = require('path');
-const fse = require('fs-extra');
-const rollup = require('rollup');
-const chalk = require('chalk');
-const { nodeResolve } = require('@rollup/plugin-node-resolve');
-const commonjs = require('@rollup/plugin-commonjs');
-const alias = require('@rollup/plugin-alias');
-const pluginJson = require('@rollup/plugin-json');
-const { terser } = require('rollup-plugin-terser');
-const BaseBundler = require('./BaseBundler.js');
+import path from 'path';
+import fse from 'fs-extra';
+import { fileURLToPath } from 'url';
+import { rollup } from 'rollup';
+import chalk from 'chalk';
+import { nodeResolve } from '@rollup/plugin-node-resolve';
+import commonjs from '@rollup/plugin-commonjs';
+import alias from '@rollup/plugin-alias';
+import pluginJson from '@rollup/plugin-json';
+import { terser } from 'rollup-plugin-terser';
+
+import BaseBundler from './BaseBundler.js';
+
+// eslint-disable-next-line no-underscore-dangle
+const __dirname = path.resolve(fileURLToPath(import.meta.url), '..');
 
 /**
  * Creates the action bundle using rollup
  */
-module.exports = class Bundler extends BaseBundler {
+export default class Bundler extends BaseBundler {
   async getRollupConfig() {
     const { cfg } = this;
     /**
@@ -92,7 +97,7 @@ module.exports = class Bundler extends BaseBundler {
 
     cfg.log.info(`--: creating ${cfg.esm ? 'esm ' : ''}${cfg.minify ? 'minified ' : ''}bundle using rollup...`);
     const config = await this.getRollupConfig();
-    const bundle = await rollup.rollup(config);
+    const bundle = await rollup(config);
 
     const { output } = await bundle.generate(config.output);
     await this.resolveDependencyInfos(output);
@@ -162,4 +167,4 @@ module.exports = class Bundler extends BaseBundler {
           .sort((d0, d1) => d0.name.localeCompare(d1.name));
       });
   }
-};
+}

package/src/bundler/WebpackBundler.js

@@ -9,17 +9,20 @@
  * 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 webpack from 'webpack';
+import chalk from 'chalk';
+import BaseBundler from './BaseBundler.js';
 
-const path = require('path');
-const fse = require('fs-extra');
-const webpack = require('webpack');
-const chalk = require('chalk');
-const BaseBundler = require('./BaseBundler.js');
+// eslint-disable-next-line no-underscore-dangle
+const __dirname = path.resolve(fileURLToPath(import.meta.url), '..');
 
 /**
  * Webpack based bundler
  */
-module.exports = class WebpackBundler extends BaseBundler {
+export default class WebpackBundler extends BaseBundler {
   async init() {
     if (this.cfg.esm) {
       throw new Error('Webpack bundler does not support ESM builds.');
@@ -33,6 +36,7 @@ module.exports = class WebpackBundler extends BaseBundler {
       mode: 'development',
       // the universal adapter is the entry point
       entry: cfg.adapterFile || path.resolve(__dirname, '..', 'template', 'node-index.js'),
+      context: cfg.cwd,
       output: {
         path: cfg.cwd,
         filename: path.relative(cfg.cwd, cfg.bundle),
@@ -56,8 +60,11 @@ module.exports = class WebpackBundler extends BaseBundler {
       }, {}),
       module: {
         rules: [{
-          test: /\.mjs$/,
+          test: /\.js$/,
           type: 'javascript/auto',
+        }, {
+          test: /\.mjs$/,
+          type: 'javascript/esm',
         }],
       },
       resolve: {
@@ -197,4 +204,4 @@ module.exports = class WebpackBundler extends BaseBundler {
           .sort((d0, d1) => d0.name.localeCompare(d1.name));
       });
   }
-};
+}

package/src/cli.js

@@ -11,18 +11,18 @@
  */
 
 /* eslint-disable no-console */
-const yargs = require('yargs');
-const chalk = require('chalk');
-
-const BaseConfig = require('./BaseConfig.js');
-
-const OpenWhiskDeployer = require('./deploy/OpenWhiskDeployer');
-const AWSDeployer = require('./deploy/AWSDeployer');
-const AzureDeployer = require('./deploy/AzureDeployer');
-const GoogleDeployer = require('./deploy/GoogleDeployer');
-const CloudflareDeployer = require('./deploy/CloudflareDeployer');
-const ComputeAtEdgeDeployer = require('./deploy/ComputeAtEdgeDeployer');
-const FastlyGateway = require('./gateway/FastlyGateway');
+import yargs from 'yargs';
+import chalk from 'chalk';
+import { config as envConfig } from 'dotenv';
+import BaseConfig from './BaseConfig.js';
+import OpenWhiskDeployer from './deploy/OpenWhiskDeployer.js';
+import AWSDeployer from './deploy/AWSDeployer.js';
+import AzureDeployer from './deploy/AzureDeployer.js';
+import GoogleDeployer from './deploy/GoogleDeployer.js';
+import CloudflareDeployer from './deploy/CloudflareDeployer.js';
+import ComputeAtEdgeDeployer from './deploy/ComputeAtEdgeDeployer.js';
+import FastlyGateway from './gateway/FastlyGateway.js';
+import ActionBuilder from './ActionBuilder.js';
 
 const PLUGINS = [
   OpenWhiskDeployer,
@@ -34,11 +34,9 @@ const PLUGINS = [
   FastlyGateway,
 ];
 
-const defaultConfig = require('./config/adobeioruntime-node10.js');
-
-require('dotenv').config();
+envConfig();
 
-class CLI {
+export default class CLI {
   constructor() {
     this._yargs = yargs()
       .pkgConf('wsk')
@@ -48,18 +46,11 @@ class CLI {
     this._yargs.help();
   }
 
-  // eslint-disable-next-line class-methods-use-this
-  createBuilder() {
-    // eslint-disable-next-line global-require
-    const ActionBuilder = require('./ActionBuilder.js');
-    return new ActionBuilder();
-  }
-
   prepare(args) {
     const argv = this._yargs.parse(args);
 
     if (argv.externals.length === 0) {
-      argv.externals = defaultConfig.externals;
+      argv.externals = [/^openwhisk(\/.*)?$/];
     }
 
     const config = new BaseConfig().configure(argv);
@@ -68,7 +59,7 @@ class CLI {
       return new PluginClass(config, pluginConfig);
     });
 
-    return this.createBuilder()
+    return new ActionBuilder()
       .withConfig(config)
       .withPlugins(plugins);
   }
@@ -85,5 +76,3 @@ class CLI {
     }
   }
 }
-
-module.exports = CLI;

package/src/deploy/AWSConfig.js

@@ -13,7 +13,7 @@
 // eslint-disable-next-line no-template-curly-in-string
 const DEFAULT_LAMBDA_FORMAT = '${packageName}--${baseName}';
 
-class AWSConfig {
+export default class AWSConfig {
   constructor() {
     Object.assign(this, {
       region: '',
@@ -125,5 +125,3 @@ class AWSConfig {
       });
   }
 }
-
-module.exports = AWSConfig;