@adobe/helix-deploy 11.1.15 → 12.0.0-pre.2

package/index.js

@@ -10,6 +10,7 @@
  * governing permissions and limitations under the License.
  */
 export { default as ActionBuilder } from './src/ActionBuilder.js';
-export { default as Bundler } from './src/bundler/WebpackBundler.js';
+export { default as WebpackBundler } from './src/bundler/WebpackBundler.js';
 export { default as BaseConfig } from './src/BaseConfig.js';
+export { default as BaseDeployer } from './src/deploy/BaseDeployer.js';
 export { default as CLI } from './src/cli.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/helix-deploy",
-  "version": "11.1.15",
+  "version": "12.0.0-pre.2",
   "description": "Library and Commandline Tools to build and deploy OpenWhisk Actions",
   "license": "Apache-2.0",
   "homepage": "https://github.com/adobe/helix-deploy#readme",
@@ -37,7 +37,6 @@
     "@adobe/helix-universal": ">=4.1.1"
   },
   "dependencies": {
-    "@adobe/fastly-native-promises": "3.0.10",
     "@adobe/fetch": "4.1.8",
     "@adobe/helix-shared-process-queue": "3.0.4",
     "@aws-sdk/client-apigatewayv2": "3.600.0",
@@ -46,25 +45,16 @@
     "@aws-sdk/client-secrets-manager": "3.600.0",
     "@aws-sdk/client-ssm": "3.600.0",
     "@aws-sdk/client-sts": "3.600.0",
-    "@fastly/js-compute": "3.16.0",
     "@google-cloud/functions": "3.4.0",
     "@google-cloud/secret-manager": "5.6.0",
     "@google-cloud/storage": "7.11.2",
-    "@rollup/plugin-alias": "5.1.0",
-    "@rollup/plugin-commonjs": "26.0.1",
-    "@rollup/plugin-json": "6.1.0",
-    "@rollup/plugin-node-resolve": "15.2.3",
-    "@rollup/plugin-terser": "0.4.4",
     "archiver": "7.0.1",
     "chalk-template": "1.1.0",
-    "constants-browserify": "1.0.0",
     "dotenv": "16.4.5",
-    "form-data": "4.0.0",
     "fs-extra": "11.2.0",
     "isomorphic-git": "1.26.1",
     "openwhisk": "3.21.8",
     "semver": "7.6.2",
-    "tar": "7.4.0",
     "webpack": "5.92.1",
     "yargs": "17.7.2"
   },
@@ -86,7 +76,7 @@
     "yauzl": "3.1.3"
   },
   "engines": {
-    "node": ">=12.0"
+    "node": ">=18.0"
   },
   "lint-staged": {
     "*.js": "eslint"

package/params.json

@@ -0,0 +1,3 @@
+{
+    "Parameters": []
+}

package/src/ActionBuilder.js

@@ -16,19 +16,8 @@ import fs from 'fs';
 import fse from 'fs-extra';
 import chalk from 'chalk-template';
 import git from 'isomorphic-git';
-import WebpackBundler from './bundler/WebpackBundler.js';
-import EdgeBundler from './bundler/EdgeBundler.js';
 import pkgJson from './package.cjs';
 
-const Bundlers = {
-  node: {
-    webpack: WebpackBundler,
-  },
-  edge: {
-    webpack: EdgeBundler,
-  },
-};
-
 /**
  * Returns the `origin` remote url or `''` if none is defined.
  *
@@ -126,7 +115,8 @@ export default class ActionBuilder {
     Object.assign(this, {
       cfg: {},
       _deployers: {},
-      _gateways: { },
+      _gateways: {},
+      _bundlers: {},
     });
   }
 
@@ -143,6 +133,19 @@ export default class ActionBuilder {
       if (plg.isGateway) {
         this._gateways[plg.id] = plg;
       }
+      if (plg.isBundler) {
+        let arch = this._bundlers[plg.arch];
+        if (!arch) {
+          arch = [];
+          this._bundlers[plg.arch] = arch;
+        }
+        let bnds = arch[plg.type];
+        if (!bnds) {
+          bnds = [];
+          arch[plg.type] = bnds;
+        }
+        bnds.push(plg);
+      }
     });
     return this;
   }
@@ -274,20 +277,18 @@ export default class ActionBuilder {
     if (this.validated) {
       return;
     }
-    // disable edge build
-
     const { cfg } = this;
     this.bundlers = [];
     cfg.archs.forEach((arch) => {
-      const bnds = Bundlers[arch];
+      const bnds = this._bundlers[arch];
       if (!bnds) {
-        throw Error(`Invalid arch '${arch}' specified. Valid options are: ${Object.keys(Bundlers)}`);
+        throw Error(`Invalid arch '${arch}' specified. Valid options are: ${Object.keys(this._bundlers)}`);
       }
-      const BundlerClass = bnds[cfg.bundler];
-      if (!BundlerClass) {
+      const bundler = bnds[cfg.bundler];
+      if (!bundler) {
         throw Error(`Invalid bundler '${cfg.bundler}' for '${arch}'. Valid options are: ${Object.keys(bnds)}`);
       }
-      this.bundlers.push(new BundlerClass().withConfig(cfg));
+      this.bundlers.push(...bundler);
     });
     for (const bundler of this.bundlers) {
       await bundler.init();

package/src/BaseConfig.js

@@ -219,8 +219,8 @@ export default class BaseConfig {
     return this;
   }
 
-  withDirectory(value) {
-    this.cwd = value === '.' ? process.cwd() : value;
+  withDirectory(value = '.') {
+    this.cwd = path.resolve(process.cwd(), value);
     return this;
   }
 
@@ -597,7 +597,7 @@ export default class BaseConfig {
         default: '.',
       })
 
-      .group(['help', 'build', 'deploy', 'test', 'test-bundle', 'update-package', 'version-link', 'delete'], 'Operation Options')
+      .group(['help', 'build', 'deploy', 'test', 'test-bundle', 'update-package', 'version-link', 'delete', 'plugin'], 'Operation Options')
       .option('build', {
         description: 'Build the deployment package',
         type: 'boolean',
@@ -632,6 +632,12 @@ export default class BaseConfig {
         type: 'boolean',
         default: false,
       })
+      .option('plugin', {
+        description: 'Specify bundler or deploy plugins.',
+        type: 'string',
+        array: true,
+        default: [],
+      })
 
       .group(['minify', 'static', 'entryFile', 'externals', 'edge-externals', 'serverless-externals', 'modules', 'adapterFile', 'esm', 'bundler'], 'Build Options')
       .option('minify', {

package/src/bundler/BaseBundler.js

@@ -37,17 +37,15 @@ export default class BaseBundler {
     }, str);
   }
 
-  constructor() {
+  constructor(cfg) {
     Object.assign(this, {
-      cfg: {},
+      isBundler: true,
+      cfg,
+      arch: '',
+      type: '',
     });
   }
 
-  withConfig(cfg) {
-    this.cfg = cfg;
-    return this;
-  }
-
   // eslint-disable-next-line class-methods-use-this,no-empty-function
   async init() {
   }
@@ -155,7 +153,7 @@ export default class BaseBundler {
 
   async updateArchive(archive, packageJson) {
     const { cfg } = this;
-    if (cfg.archs.includes('node')) {
+    if (this.arch === 'node') {
       archive.file(cfg.bundle, { name: 'index.js' });
     }
 
@@ -178,14 +176,6 @@ export default class BaseBundler {
 
     archive.append(JSON.stringify(packageJson, null, '  '), { name: 'package.json' });
 
-    // edge function stuff
-    archive.append([
-      'account_id = "fakefakefake"',
-      `name = "${this.cfg.packageName}/${this.cfg.name}"`,
-      'type = "javascript"',
-      'workers_dev = true',
-    ].join('\n'), { name: 'wrangler.toml' });
-
     // this allows to use a cjs loader for the esm modules. but it still doesn't work on AWS
     if (cfg.esm) {
       archive.directory('esm-adapter');

package/src/bundler/WebpackBundler.js

@@ -23,6 +23,12 @@ const __dirname = path.resolve(fileURLToPath(import.meta.url), '..');
  * Webpack based bundler
  */
 export default class WebpackBundler extends BaseBundler {
+  constructor(cfg) {
+    super(cfg);
+    this.arch = 'node';
+    this.type = 'webpack';
+  }
+
   async init() {
     if (this.cfg.esm) {
       throw new Error('Webpack bundler does not support ESM builds.');
@@ -105,7 +111,7 @@ export default class WebpackBundler extends BaseBundler {
     }
 
     if (cfg.progressHandler) {
-      opts.plugins.push(new webpack.ProgressPlugin(cfg.progressHandler));
+      this.initProgressHandler(opts, cfg);
     }
 
     const customizePath = path.join(cfg.cwd, 'hlx.webpack.customize.js');
@@ -119,6 +125,11 @@ export default class WebpackBundler extends BaseBundler {
     return opts;
   }
 
+  // eslint-disable-next-line class-methods-use-this
+  initProgressHandler(opts, cfg) {
+    opts.plugins.push(new webpack.ProgressPlugin(cfg.progressHandler));
+  }
+
   async createWebpackBundle(arch) {
     const { cfg } = this;
     if (!cfg.depFile) {

package/src/cli.js

@@ -18,24 +18,55 @@ import BaseConfig from './BaseConfig.js';
 import OpenWhiskDeployer from './deploy/OpenWhiskDeployer.js';
 import AWSDeployer from './deploy/AWSDeployer.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';
+import WebpackBundler from './bundler/WebpackBundler.js';
 
 const PLUGINS = [
   OpenWhiskDeployer,
   AWSDeployer,
   GoogleDeployer,
-  CloudflareDeployer,
-  ComputeAtEdgeDeployer,
-  FastlyGateway,
+  WebpackBundler,
 ];
 
 envConfig();
 
+async function loadPlugin(name) {
+  const names = [
+    name,
+    `helix-deploy-${name}`,
+    `@adobe/helix-deploy-${name}`,
+  ];
+
+  let module;
+  let moduleName;
+  for (const n of names) {
+    try {
+      // eslint-disable-next-line no-await-in-loop
+      module = await import(n);
+      moduleName = n;
+      break;
+    } catch (e) {
+      if (e.code !== 'MODULE_NOT_FOUND') {
+        throw e;
+      }
+    }
+  }
+  if (!module) {
+    throw new Error(`Plugin not found: ${name}`);
+  }
+  const { plugins } = module;
+  if (!plugins) {
+    throw new Error(`Plugin ${module.name} does not export a plugins' array.`);
+  }
+  console.log('Loaded plugin:', moduleName);
+  for (const clazz of plugins) {
+    console.log('- ', clazz.name);
+  }
+  return plugins;
+}
+
 export default class CLI {
-  constructor() {
+  buildArgs(plugins) {
     this._yargs = yargs()
       .pkgConf('wsk')
       .env('HLX')
@@ -61,14 +92,27 @@ export default class CLI {
         });
       });
     BaseConfig.yarg(this._yargs);
-    PLUGINS.forEach((PluginClass) => PluginClass.Config.yarg(this._yargs));
+    plugins.forEach((PluginClass) => PluginClass.Config?.yarg(this._yargs));
     this._yargs
       .wrap(Math.min(120, this._yargs.terminalWidth()))
       .help();
   }
 
-  prepare(args) {
-    const argv = this._yargs.parse(args);
+  async prepare(args) {
+    const pluginClasses = [...PLUGINS];
+    this.buildArgs(pluginClasses);
+    let argv = this._yargs.parse(args);
+
+    // if args specify plugins, load them and parse again
+    if (argv.plugin.length) {
+      for (const pluginName of argv.plugin) {
+        // eslint-disable-next-line no-await-in-loop
+        const plugins = await loadPlugin(pluginName);
+        pluginClasses.push(...plugins);
+      }
+      this.buildArgs(pluginClasses);
+      argv = this._yargs.parse(args);
+    }
 
     // apply '!important' args (override env).
     Object.entries(argv).forEach(([key, value]) => {
@@ -83,8 +127,10 @@ export default class CLI {
     }
 
     const config = new BaseConfig().configure(argv);
-    const plugins = PLUGINS.map((PluginClass) => {
-      const pluginConfig = new PluginClass.Config().configure(argv);
+    const plugins = pluginClasses.map((PluginClass) => {
+      const pluginConfig = PluginClass.Config
+        ? new PluginClass.Config().configure(argv)
+        : null;
       return new PluginClass(config, pluginConfig);
     });
 
@@ -95,7 +141,7 @@ export default class CLI {
 
   async run(args) {
     try {
-      const res = await this.prepare(args).run();
+      const res = (await this.prepare(args)).run();
       if (res) {
         console.log(JSON.stringify(res, null, 2));
       }

package/src/bundler/EdgeBundler.js

@@ -1,132 +0,0 @@
-/*
- * Copyright 2021 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 webpack from 'webpack';
-import WebpackBundler from './WebpackBundler.js';
-
-// eslint-disable-next-line no-underscore-dangle
-const __dirname = path.resolve(fileURLToPath(import.meta.url), '..');
-
-/**
- * Creates the action bundle
- */
-export default class EdgeBundler extends WebpackBundler {
-  async getWebpackConfig() {
-    const { cfg } = this;
-    const opts = {
-      target: 'webworker',
-      mode: 'development',
-      // the universal adapter is the entry point
-      entry: cfg.adapterFile || path.resolve(__dirname, '..', 'template', 'serviceworker-index.js'),
-      output: {
-        path: cfg.cwd,
-        filename: path.relative(cfg.cwd, cfg.edgeBundle),
-        library: 'main',
-        libraryTarget: 'umd',
-        globalObject: 'globalThis',
-      },
-      devtool: false,
-      externals: [
-        ...cfg.externals, // user defined externals for all platforms
-        ...cfg.edgeExternals, // user defined externals for edge compute
-        // 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',
-        'fastly:env',
-      ].reduce((obj, ext) => {
-        // this makes webpack to ignore the module and just leave it as normal require.
-        // eslint-disable-next-line no-param-reassign
-        obj[ext] = `commonjs2 ${ext}`;
-        return obj;
-      }, {}),
-      module: {
-        rules: [{
-          test: /\.js$/,
-          type: 'javascript/auto',
-        }, {
-          test: /\.mjs$/,
-          type: 'javascript/esm',
-        }],
-      },
-      resolve: {
-        mainFields: ['main', 'module'],
-        extensions: ['.wasm', '.js', '.mjs', '.json'],
-        alias: {
-          // the main.js is imported in the universal adapter and is _the_ action entry point
-          './main.js': cfg.file,
-          // 'psl': path.resolve(__dirname, '../node_modules/psl/dist/psl.js'), // inlined data
-          '@adobe/fetch': path.resolve(__dirname, '../template/polyfills/fetch.js'),
-          '@adobe/helix-fetch': path.resolve(__dirname, '../template/polyfills/fetch.js'),
-        },
-        /*         fallback: {
-          assert: require.resolve('assert'),
-          buffer: require.resolve('buffer'),
-          console: require.resolve('console-browserify'),
-          constants: require.resolve('constants-browserify'),
-          crypto: require.resolve('crypto-browserify'),
-          domain: require.resolve('domain-browser'),
-          events: path.resolve(__dirname, '../node_modules/events/events.js'),
-          http: require.resolve('stream-http'),
-          https: require.resolve('https-browserify'),
-          os: require.resolve('os-browserify/browser'),
-          path: require.resolve('path-browserify'),
-          punycode: require.resolve('punycode'),
-          process: require.resolve('process/browser'),
-          querystring: require.resolve('querystring-es3'),
-          stream: require.resolve('stream-browserify'),
-          string_decoder: require.resolve('string_decoder'),
-          sys: require.resolve('util'),
-          timers: require.resolve('timers-browserify'),
-          tty: require.resolve('tty-browserify'),
-          url: require.resolve('url'),
-          util: require.resolve('util'),
-          vm: require.resolve('vm-browserify'),
-          zlib: require.resolve('browserify-zlib'),
-        }, */
-      },
-      node: {
-        __dirname: true,
-        __filename: false,
-      },
-      plugins: [],
-    };
-    if (cfg.minify) {
-      opts.optimization = {
-        minimize: cfg.minify,
-      };
-    }
-    if (cfg.modulePaths && cfg.modulePaths.length > 0) {
-      opts.resolve.modules = cfg.modulePaths;
-    }
-
-    if (cfg.progressHandler) {
-      opts.plugins.push(new webpack.ProgressPlugin(cfg.progressHandler));
-    }
-    return opts;
-  }
-
-  async createBundle() {
-    const { cfg } = this;
-    if (!cfg.edgeBundle) {
-      throw Error('edge bundle path is undefined');
-    }
-    return this.createWebpackBundle('edge');
-  }
-
-  // eslint-disable-next-line class-methods-use-this
-  validateBundle() {
-    // TODO: validate edge bundle, skipped since we're on node
-  }
-}

package/src/deploy/CloudflareConfig.js

@@ -1,74 +0,0 @@
-/*
- * Copyright 2021 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.
- */
-export default class CloudflareConfig {
-  constructor() {
-    Object.assign(this, {});
-  }
-
-  configure(argv) {
-    return this
-      .withEmail(argv.cloudflareEmail)
-      .withAuth(argv.cloudflareAuth)
-      .withTestDomain(argv.cloudflareTestDomain)
-      .withAccountID(argv.cloudflareAccountId);
-  }
-
-  withAccountID(value) {
-    this.accountID = value;
-    return this;
-  }
-
-  withEmail(value) {
-    this.email = value;
-    return this;
-  }
-
-  withTestDomain(value) {
-    this.testDomain = value;
-    return this;
-  }
-
-  withAuth(value) {
-    this.auth = value;
-    return this;
-  }
-
-  static yarg(yargs) {
-    return yargs
-      .group([
-        'cloudflare-account-id',
-        'cloudflare-auth',
-        'cloudflare-email',
-        'cloudflare-test-domain',
-      ], 'Cloudflare Workers Deployment Options')
-      .option('cloudflare-account-id', {
-        description: 'the Cloudflare account ID to deploy to',
-        type: 'string',
-        default: '',
-      })
-      .option('cloudflare-email', {
-        description: 'the Cloudflare email address belonging to the authentication token',
-        type: 'string',
-        default: '',
-      })
-      .option('cloudflare-test-domain', {
-        description: 'the *.workers.dev subdomain to use for testing deployed scripts',
-        type: 'string',
-        default: '',
-      })
-      .option('cloudflare-auth', {
-        description: 'the Cloudflare API token from https://dash.cloudflare.com/profile/api-tokens',
-        type: 'string',
-        default: '',
-      });
-  }
-}