@adobe/helix-deploy 4.14.0 → 5.0.0

package/src/gateway/FastlyGateway.js

@@ -9,14 +9,16 @@
  * OF ANY KIND, either express or implied. See the License for the specific language
  * governing permissions and limitations under the License.
  */
-const Fastly = require('@adobe/fastly-native-promises');
+import Fastly from '@adobe/fastly-native-promises';
+import chalk from 'chalk';
+import FastlyConfig from './FastlyConfig.js';
+import BaseDeployer from '../deploy/BaseDeployer.js';
+
 const {
   toString, vcl, time, req, res, str, concat,
-} = require('@adobe/fastly-native-promises').loghelpers;
-const FastlyConfig = require('./FastlyConfig.js');
-const BaseDeployer = require('../deploy/BaseDeployer.js');
+} = Fastly.loghelpers;
 
-class FastlyGateway {
+export default class FastlyGateway {
   constructor(baseConfig, config) {
     Object.assign(this, {
       cfg: baseConfig,
@@ -29,20 +31,15 @@ class FastlyGateway {
   }
 
   ready() {
-    return !!this._cfg.service && !!this._cfg.auth && !!this._cfg.checkpath;
+    return !!this._cfg.service && !!this._cfg.auth;
   }
 
-  /**
-   * A weaker version of `ready` that works without a check path
-   * and checks whether links can be updated.
-   * @returns boolean true if links can be updated
-   */
-  updateable() {
-    return !!this._cfg.service && !!this._cfg.auth;
+  canDeploy() {
+    return this.ready() && this._deployers.length > 0;
   }
 
   async updateLinks(links, version) {
-    this.log.info(`Updating links on the Gateway for version ${version}`);
+    this.log.info(`--: updating links on the Gateway for version ${version}...`);
     const fakeDeployer = new BaseDeployer({
       links, version, log: this.log,
     });
@@ -58,6 +55,7 @@ class FastlyGateway {
 
     await this._fastly.bulkUpdateDictItems(undefined, 'aliases', ...versionstrings);
     this._fastly.discard();
+    this.log.info(chalk`{green ok:} updated links on the Gateway for version ${version}.`);
   }
 
   init() {
@@ -91,6 +89,7 @@ class FastlyGateway {
     }
     await this._fastly.updateDictItem(undefined, 'tokens', this.cfg.packageToken, `${Math.floor(Date.now() / 1000) + (365 * 24 * 3600)}`);
     this._fastly.discard();
+    this.log.info(chalk`{green ok:} updating app (package) parameters on Fastly gateway.`);
   }
 
   selectBackendVCL() {
@@ -190,7 +189,7 @@ if (req.url ~ "^/([^/]+)/([^/@_]+)([@_]([^/@_?]+)+)?(.*$)") {
 
   async enableLogging(version) {
     if (this._cfg.coralogixToken) {
-      this.log.info('Set up Gateway logging to Coralogix');
+      this.log.info(chalk`--: Set up Gateway logging to {yellow Coralogix}`);
       await this._fastly.writeHttps(version, 'helix-coralogix', {
         name: 'helix-coralogix',
         format: toString({
@@ -303,198 +302,207 @@ if (req.url ~ "^/([^/]+)/([^/@_]+)([@_]([^/@_?]+)+)?(.*$)") {
   }
 
   async deploy() {
-    this.log.info('Set up Fastly Gateway');
-
-    await this._fastly.transact(async (newversion) => {
-      await this.enableLogging(newversion);
-
-      this.log.info('create condition');
-      await this._fastly.writeCondition(newversion, 'false', {
-        name: 'false',
-        statement: 'false',
-        type: 'request',
-      });
-
-      await this._fastly.writeDictionary(newversion, 'priorities', {
-        name: 'priorities',
-        write_only: 'false',
-      });
-
-      await this._fastly.writeDictionary(newversion, 'aliases', {
-        name: 'aliases',
-        write_only: 'false',
-      });
-
-      await this._fastly.writeDictionary(newversion, 'tokens', {
-        name: 'tokens',
-        write_only: 'false',
-      });
-
-      await this._fastly.writeDictionary(newversion, 'packageparams', {
-        name: 'packageparams',
-        write_only: 'true',
-      });
-
-      if (this._cfg.checkinterval > 0) {
-      // set up health checks
+    this.log.info(chalk`--: Set up {yellow Fastly} Gateway`);
+    try {
+      await this._fastly.transact(async (newversion) => {
+        await this.enableLogging(newversion);
+
+        this.log.info('--: create condition');
+        await this._fastly.writeCondition(newversion, 'false', {
+          name: 'false',
+          statement: 'false',
+          type: 'request',
+        });
+
+        this.log.info('--: create dictionaries');
+        await this._fastly.writeDictionary(newversion, 'priorities', {
+          name: 'priorities',
+          write_only: 'false',
+        });
+
+        await this._fastly.writeDictionary(newversion, 'aliases', {
+          name: 'aliases',
+          write_only: 'false',
+        });
+
+        await this._fastly.writeDictionary(newversion, 'tokens', {
+          name: 'tokens',
+          write_only: 'false',
+        });
+
+        await this._fastly.writeDictionary(newversion, 'packageparams', {
+          name: 'packageparams',
+          write_only: 'true',
+        });
+
+        if (this._cfg.checkinterval > 0 && this._cfg.checkpath) {
+          this.log.info('--: setup health-check');
+          // set up health checks
+          await Promise.all(this._deployers
+            .map((deployer) => ({
+              check_interval: this._cfg.checkinterval,
+              expected_response: 200,
+              host: deployer.host,
+              http_version: '1.1',
+              method: 'GET',
+              initial: 1,
+              name: `${deployer.name}Check`,
+              path: `${deployer.basePath}${this._cfg.checkpath}`,
+              threshold: 2,
+              timeout: 5000,
+              window: 3,
+            }))
+            .map((healthcheck) => this._fastly
+              .writeHealthcheck(newversion, healthcheck.name, healthcheck)));
+        }
+
+        // set up backends
         await Promise.all(this._deployers
           .map((deployer) => ({
-            check_interval: this._cfg.checkinterval,
-            expected_response: 200,
-            host: deployer.host,
-            http_version: '1.1',
-            method: 'GET',
-            initial: 1,
-            name: `${deployer.name}Check`,
-            path: deployer.basePath + this._cfg.checkpath,
-            threshold: 2,
-            timeout: 5000,
-            window: 3,
+            hostname: deployer.host,
+            ssl_cert_hostname: deployer.host,
+            ssl_sni_hostname: deployer.host,
+            address: deployer.host,
+            override_host: deployer.host,
+            name: deployer.name,
+            error_threshold: 0,
+            first_byte_timeout: 60000,
+            weight: 100,
+            connect_timeout: 5000,
+            port: 443,
+            between_bytes_timeout: 10000,
+            shield: '', // 'bwi-va-us',
+            max_conn: 200,
+            use_ssl: true,
+            request_condition: 'false',
           }))
-          .map((healthcheck) => this._fastly
-            .writeHealthcheck(newversion, healthcheck.name, healthcheck)));
-      }
-
-      // set up backends
-      await Promise.all(this._deployers
-        .map((deployer) => ({
-          hostname: deployer.host,
-          ssl_cert_hostname: deployer.host,
-          ssl_sni_hostname: deployer.host,
-          address: deployer.host,
-          override_host: deployer.host,
-          name: deployer.name,
-          error_threshold: 0,
-          first_byte_timeout: 60000,
-          weight: 100,
-          connect_timeout: 5000,
-          port: 443,
-          between_bytes_timeout: 10000,
-          shield: '', // 'bwi-va-us',
-          max_conn: 200,
-          use_ssl: true,
-          request_condition: 'false',
-        }))
-        .map((backend) => {
-          const retval = backend;
-          if (this._cfg.checkinterval > 0) {
-            retval.healthcheck = `${backend.name}Check`;
-          }
-          return retval;
-        })
-        .map(async (backend) => {
-          try {
-            return await this._fastly.createBackend(newversion, backend);
-          } catch (e) {
-            return this._fastly.updateBackend(newversion, backend.name, backend);
-          }
-        }));
-
-      await this._fastly.writeSnippet(newversion, 'packageparams.auth', {
-        name: 'packageparams.auth',
-        priority: 9,
-        dynamic: 0,
-        type: 'recv',
-        content: `
-if (req.http.Authorization) {
-  if(time.is_after(std.time(table.lookup(tokens, regsub(req.http.Authorization, "^Bearer ", ""), "expired"), std.integer2time(0)), time.start)) {
-    error 600 "Get Package Params";
+          .map((backend) => {
+            const retval = backend;
+            if (this._cfg.checkinterval > 0 && this._cfg.checkpath) {
+              retval.healthcheck = `${backend.name}Check`;
+            }
+            return retval;
+          })
+          .map(async (backend) => {
+            this.log.info(`--: create backend ${backend.name} -> ${backend.hostname}`);
+            try {
+              return await this._fastly.createBackend(newversion, backend);
+            } catch (e) {
+              return this._fastly.updateBackend(newversion, backend.name, backend);
+            }
+          }));
+
+        this.log.info('--: write VLC snippets');
+        await this._fastly.writeSnippet(newversion, 'packageparams.auth', {
+          name: 'packageparams.auth',
+          priority: 9,
+          dynamic: 0,
+          type: 'recv',
+          content: `
+  if (req.http.Authorization) {
+    if(time.is_after(std.time(table.lookup(tokens, regsub(req.http.Authorization, "^Bearer ", ""), "expired"), std.integer2time(0)), time.start)) {
+      error 600 "Get Package Params";
+    }
+  }`,
+        });
+
+        await this._fastly.writeSnippet(newversion, `${this.cfg.packageName}.params`, {
+          name: `${this.cfg.packageName}.params`,
+          priority: 10,
+          dynamic: 0,
+          type: 'error',
+          content: this.listPackageParamsVCL(),
+        });
+
+        await this._fastly.writeSnippet(newversion, 'backend', {
+          name: 'backend',
+          priority: 10,
+          dynamic: 0,
+          type: 'recv',
+          content: this.selectBackendVCL(),
+        });
+
+        await this._fastly.writeSnippet(newversion, 'missurl', {
+          name: 'missurl',
+          priority: 10,
+          dynamic: 0,
+          type: 'miss',
+          content: this.setURLVCL(),
+        });
+
+        await this._fastly.writeSnippet(newversion, 'passurl', {
+          name: 'passurl',
+          priority: 10,
+          dynamic: 0,
+          type: 'pass',
+          content: this.setURLVCL(),
+        });
+
+        await this._fastly.writeSnippet(newversion, 'logurl', {
+          name: 'logurl',
+          priority: 10,
+          dynamic: 0,
+          type: 'fetch',
+          content: `set beresp.http.X-Backend-URL = bereq.url;
+  set beresp.http.X-Backend-Name = req.backend;
+  set beresp.http.X-Backend-Health = req.http.X-Backend-Health;
+  set beresp.cacheable = false;`,
+        });
+
+        await this._fastly.writeSnippet(newversion, 'stashsurrogates', {
+          name: 'stashsurrogates',
+          priority: 10,
+          dynamic: 0,
+          type: 'fetch',
+          content: `
+  set beresp.http.X-Surrogate-Key = beresp.http.Surrogate-Key;
+  set beresp.http.X-Surrogate-Control = beresp.http.Surrogate-Control;`,
+        });
+
+        let restartcontent = `
+  # restart the request in case of flakiness
+  if (req.restarts < 2 && (resp.status == 503 || resp.status == 504) && (req.request == "GET" || req.request == "HEAD" || req.request == "PUT" || req.request == "DELETE")) {
+    restart;
   }
-}`,
-      });
-
-      await this._fastly.writeSnippet(newversion, `${this.cfg.packageName}.params`, {
-        name: `${this.cfg.packageName}.params`,
-        priority: 10,
-        dynamic: 0,
-        type: 'error',
-        content: this.listPackageParamsVCL(),
-      });
-
-      await this._fastly.writeSnippet(newversion, 'backend', {
-        name: 'backend',
-        priority: 10,
-        dynamic: 0,
-        type: 'recv',
-        content: this.selectBackendVCL(),
-      });
-
-      await this._fastly.writeSnippet(newversion, 'missurl', {
-        name: 'missurl',
-        priority: 10,
-        dynamic: 0,
-        type: 'miss',
-        content: this.setURLVCL(),
-      });
-
-      await this._fastly.writeSnippet(newversion, 'passurl', {
-        name: 'passurl',
-        priority: 10,
-        dynamic: 0,
-        type: 'pass',
-        content: this.setURLVCL(),
-      });
-
-      await this._fastly.writeSnippet(newversion, 'logurl', {
-        name: 'logurl',
-        priority: 10,
-        dynamic: 0,
-        type: 'fetch',
-        content: `set beresp.http.X-Backend-URL = bereq.url;
-set beresp.http.X-Backend-Name = req.backend;
-set beresp.http.X-Backend-Health = req.http.X-Backend-Health;
-set beresp.cacheable = false;`,
-      });
-
-      await this._fastly.writeSnippet(newversion, 'stashsurrogates', {
-        name: 'stashsurrogates',
-        priority: 10,
-        dynamic: 0,
-        type: 'fetch',
-        content: `
-set beresp.http.X-Surrogate-Key = beresp.http.Surrogate-Key;
-set beresp.http.X-Surrogate-Control = beresp.http.Surrogate-Control;`,
-      });
-
-      let restartcontent = `
-# restart the request in case of flakiness
-if (req.restarts < 2 && (resp.status == 503 || resp.status == 504) && (req.request == "GET" || req.request == "HEAD" || req.request == "PUT" || req.request == "DELETE")) {
-  restart;
-}
-set resp.http.x-gateway-restarts = req.restarts;
-unset resp.http.Fastly-Restarts;`;
-
-      if (this._deployers.find((deployer) => deployer.name === 'Google')) {
-        restartcontent += `
-# If Google can't find a function, it sends a redirect to the login page instead
-# of a 404. This fixes it.
-if (resp.status == 302 && req.backend == F_Google && resp.http.Location ~ "^https://accounts.google.com/ServiceLogin") {
-  set resp.status = 404;
-}
-`;
-      }
-      await this._fastly.writeSnippet(newversion, 'restart', {
-        name: 'restart',
-        priority: 10,
-        dynamic: 0,
-        type: 'deliver',
-        content: restartcontent,
-      });
-
-      await this._fastly.writeSnippet(newversion, 'restoresurrogates', {
-        name: 'restoresurrogates',
-        priority: 10,
-        dynamic: 0,
-        type: 'deliver',
-        content: `
-set resp.http.Surrogate-Key = resp.http.X-Surrogate-Key;
-set resp.http.Surrogate-Control = resp.http.X-Surrogate-Control;`,
-      });
-    }, true);
-
-    this._fastly.discard();
+  set resp.http.x-gateway-restarts = req.restarts;
+  unset resp.http.Fastly-Restarts;`;
+
+        if (this._deployers.find((deployer) => deployer.name === 'Google')) {
+          restartcontent += `
+  # If Google can't find a function, it sends a redirect to the login page instead
+  # of a 404. This fixes it.
+  if (resp.status == 302 && req.backend == F_Google && resp.http.Location ~ "^https://accounts.google.com/ServiceLogin") {
+    set resp.status = 404;
+  }
+  `;
+        }
+        await this._fastly.writeSnippet(newversion, 'restart', {
+          name: 'restart',
+          priority: 10,
+          dynamic: 0,
+          type: 'deliver',
+          content: restartcontent,
+        });
+
+        await this._fastly.writeSnippet(newversion, 'restoresurrogates', {
+          name: 'restoresurrogates',
+          priority: 10,
+          dynamic: 0,
+          type: 'deliver',
+          content: `
+  set resp.http.Surrogate-Key = resp.http.X-Surrogate-Key;
+  set resp.http.Surrogate-Control = resp.http.X-Surrogate-Control;`,
+        });
+      }, true);
+
+      this.log.info(chalk`{green ok}: Set up {yellow Fastly} Gateway done.`);
+    } catch (e) {
+      this.log.error(chalk`{red error}: failed to setup gateway: ${e.message}`);
+      throw e;
+    } finally {
+      this._fastly.discard();
+    }
   }
 }
 
 FastlyGateway.Config = FastlyConfig;
-module.exports = FastlyGateway;

package/src/index.js

@@ -12,6 +12,6 @@
  * governing permissions and limitations under the License.
  */
 
-const CLI = require('./cli.js');
+import CLI from './cli.js';
 
 new CLI().run(process.argv.slice(2));

package/src/{config/adobeioruntime-node10.js → package.cjs}

@@ -1,5 +1,5 @@
 /*
- * Copyright 2019 Adobe. All rights reserved.
+ * 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
@@ -9,15 +9,4 @@
  * OF ANY KIND, either express or implied. See the License for the specific language
  * governing permissions and limitations under the License.
  */
-
-module.exports = {
-  // modules that are provided by the runtime container
-  externals: [
-    // 'express',
-    // 'body-parser',
-    // 'cls-hooked',
-    // 'request',
-    // 'request-promise',
-    /^openwhisk(\/.*)?$/,
-  ],
-};
+module.exports = require('../package.json');

package/src/template/node-index.js

@@ -9,9 +9,7 @@
  * OF ANY KIND, either express or implied. See the License for the specific language
  * governing permissions and limitations under the License.
  */
-// eslint-disable-next-line no-underscore-dangle
-global.__rootdir = __dirname;
-
+const { dirname } = require('path');
 const {
   openwhisk,
   aws,
@@ -19,6 +17,9 @@ const {
   azure,
 } = require('@adobe/helix-universal').adapter;
 
+// eslint-disable-next-line no-underscore-dangle
+global.__rootdir = dirname(__filename); // __dirname is transformed by webpack, __filename isn't
+
 module.exports = Object.assign(azure, {
   main: openwhisk,
   lambda: aws,

package/src/template/serviceworker-index.js

@@ -10,8 +10,8 @@
  * governing permissions and limitations under the License.
  */
 /* eslint-env serviceworker */
-const fastly = require('./fastly-adapter');
-const cloudflare = require('./cloudflare-adapter');
+const fastly = require('./fastly-adapter.js');
+const cloudflare = require('./cloudflare-adapter.js');
 
 /* eslint-disable no-restricted-globals */
 if (typeof addEventListener === 'function') {

package/src/utils.js

@@ -9,8 +9,12 @@
  * OF ANY KIND, either express or implied. See the License for the specific language
  * governing permissions and limitations under the License.
  */
-const { fork } = require('child_process');
-const path = require('path');
+import { fileURLToPath } from 'url';
+import { fork } from 'child_process';
+import path from 'path';
+
+// eslint-disable-next-line no-underscore-dangle
+const __dirname = path.resolve(fileURLToPath(import.meta.url), '..');
 
 /**
  * @typedef {object} VersionCoordinates
@@ -54,7 +58,7 @@ const path = require('path');
  * @param {VersionSpec} versionspec - which version is current
  * @returns {NamedAction[]} - a list of actions that can safely be deleted
  */
-function filterActions(fns, now, {
+export function filterActions(fns, now, {
   ciAge, patchAge, minorAge, majorAge, ciNum, patchNum, minorNum, majorNum,
 } = {}, { patchVersion, minorVersion, majorVersion } = {}) {
   // sort by updated date
@@ -151,7 +155,7 @@ function filterActions(fns, now, {
     ...cleanmajorbyage, ...cleanmajorbycount];
 }
 
-async function validateBundle(bundlePath, invoke = false) {
+export async function validateBundle(bundlePath, invoke = false) {
   try {
     const opts = {
       invoke,
@@ -175,8 +179,3 @@ async function validateBundle(bundlePath, invoke = false) {
     };
   }
 }
-
-module.exports = {
-  filterActions,
-  validateBundle,
-};