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

package/src/deploy/CloudflareDeployer.js

@@ -1,178 +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 fs from 'fs';
-import FormData from 'form-data';
-import BaseDeployer from './BaseDeployer.js';
-import CloudflareConfig from './CloudflareConfig.js';
-
-export default class CloudflareDeployer extends BaseDeployer {
-  constructor(baseConfig, config) {
-    super(baseConfig);
-    Object.assign(this, {
-      id: 'cloudflare',
-      name: 'Cloudflare',
-      _cfg: config,
-      noGatewayBackend: true,
-    });
-  }
-
-  ready() {
-    return !!this._cfg.auth && !!this._cfg.accountID && !!this.cfg.edgeBundle;
-  }
-
-  validate() {
-    if (!this.ready()) {
-      throw new Error('Cloudflare target needs email, token, and account ID');
-    }
-  }
-
-  get fullFunctionName() {
-    return `${this.cfg.packageName}--${this.cfg.name}`
-      .replace(/\./g, '_')
-      .replace('@', '_');
-  }
-
-  async deploy() {
-    const body = fs.readFileSync(this.cfg.edgeBundle);
-    const settings = await this.getSettings();
-    const { id } = await this.createKVNamespace(`${this.cfg.packageName}--secrets`);
-
-    const metadata = {
-      body_part: 'script',
-      bindings: [
-        ...Object.entries(this.cfg.params).map(([key, value]) => ({
-          name: key,
-          type: 'secret_text',
-          text: value,
-        })),
-        {
-          name: 'PACKAGE',
-          namespace_id: id,
-          type: 'kv_namespace',
-        },
-      ],
-    };
-
-    // what https://api.cloudflare.com/#worker-script-upload-worker won't tell you:
-    // you can use multipart/formdata to set metadata according to
-    // https://community.cloudflare.com/t/bind-kv-and-workers-via-api/221391
-    const form = new FormData();
-    form.append('script', body, {
-      contentType: 'application/javascript',
-    });
-    form.append('metadata', JSON.stringify(metadata), {
-      contentType: 'application/json',
-    });
-
-    const res = await this.fetch(`https://api.cloudflare.com/client/v4/accounts/${this._cfg.accountID}/workers/scripts/${this.fullFunctionName}`, {
-      method: 'PUT',
-      headers: form.getHeaders({
-        Authorization: `Bearer ${this._cfg.auth}`,
-      }),
-      body: form.getBuffer(),
-    });
-
-    if (!res.ok) {
-      const { errors } = await res.json();
-      throw new Error(`Unable to upload worker to Cloudflare: ${errors[0].message}`);
-    }
-
-    await this.updatePackageParams(id, this.cfg.packageParams);
-
-    await this.restoreSettings(settings);
-  }
-
-  async getSettings() {
-    const res = await this.fetch(`https://api.cloudflare.com/client/v4/accounts/${this._cfg.accountID}/workers/scripts/${this.fullFunctionName}/script-settings`, {
-      method: 'GET',
-      headers: {
-        Authorization: `Bearer ${this._cfg.auth}`,
-      },
-    });
-    if (!res.ok) {
-      return null;
-    }
-    const { result } = await res.json();
-    return result;
-  }
-
-  async restoreSettings(existing) {
-    if (!existing) {
-      return true;
-    }
-    const res = await this.fetch(`https://api.cloudflare.com/client/v4/accounts/${this._cfg.accountID}/workers/scripts/${this.fullFunctionName}/script-settings`, {
-      method: 'PATCH',
-      headers: {
-        Authorization: `Bearer ${this._cfg.auth}`,
-        'content-type': 'application/json',
-      },
-      body: JSON.stringify(existing),
-    });
-    return res.ok;
-  }
-
-  async updatePackageParams(id, params) {
-    const kvlist = Object.entries(params).map(([key, value]) => ({
-      key, value,
-    }));
-    if (!kvlist.length) {
-      return true;
-    }
-
-    const res = await this.fetch(`https://api.cloudflare.com/client/v4/accounts/${this._cfg.accountID}/storage/kv/namespaces/${id}/bulk`, {
-      method: 'PUT',
-      headers: {
-        Authorization: `Bearer ${this._cfg.auth}`,
-        'content-type': 'application/json',
-      },
-      body: JSON.stringify(kvlist),
-    });
-    return res.ok;
-  }
-
-  async createKVNamespace(name) {
-    const postres = await this.fetch(`https://api.cloudflare.com/client/v4/accounts/${this._cfg.accountID}/storage/kv/namespaces`, {
-      method: 'POST',
-      headers: {
-        Authorization: `Bearer ${this._cfg.auth}`,
-        'content-type': 'application/json',
-      },
-      body: {
-        title: name,
-      },
-    });
-    let { result } = await postres.json();
-    if (!result) {
-      const listres = await this.fetch(`https://api.cloudflare.com/client/v4/accounts/${this._cfg.accountID}/storage/kv/namespaces`, {
-        method: 'GET',
-        headers: {
-          Authorization: `Bearer ${this._cfg.auth}`,
-        },
-      });
-      const { result: results } = await listres.json();
-      result = results.find((r) => r.title === name);
-    }
-    return result;
-  }
-
-  async test() {
-    return this._cfg.testDomain
-      ? this.testRequest({
-        url: `https://${this.fullFunctionName}.${this._cfg.testDomain}.workers.dev`,
-        idHeader: 'CF-RAY',
-        retry404: 0,
-      })
-      : undefined;
-  }
-}
-
-CloudflareDeployer.Config = CloudflareConfig;

package/src/deploy/ComputeAtEdgeConfig.js

@@ -1,91 +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 ComputeAtEdgeConfig {
-  constructor() {
-    Object.assign(this, {});
-  }
-
-  configure(argv) {
-    return this
-      .withServiceID(argv.computeServiceId)
-      .withAuth(argv.fastlyAuth)
-      .withCoralogixToken(argv.coralogixToken)
-      .withFastlyGateway(argv.fastlyGateway)
-      .withComputeDomain(argv.computeTestDomain)
-      .withCoralogixApp(argv.computeCoralogixApp);
-  }
-
-  withServiceID(value) {
-    this.service = value;
-    return this;
-  }
-
-  withAuth(value) {
-    this.auth = value;
-    return this;
-  }
-
-  withCoralogixToken(value) {
-    this.coralogixToken = value;
-    return this;
-  }
-
-  withCoralogixApp(value) {
-    this.coralogixApp = value;
-    return this;
-  }
-
-  withFastlyGateway(value) {
-    this.fastlyGateway = value;
-    return this;
-  }
-
-  withComputeDomain(value) {
-    this.testDomain = value;
-    return this;
-  }
-
-  static yarg(yargs) {
-    return yargs
-      .group(['compute-service-id', 'compute-domain', 'fastly-auth', 'coralogix-token', 'compute-coralogix-app'], 'Fastly Compute@Edge Options')
-      .option('compute-service-id', {
-        description: 'the Fastly Service to deploy the action to',
-        type: 'string',
-        default: '',
-      })
-      .option('compute-test-domain', {
-        description: 'the domain name of the Compute@Edge service (used for testing)',
-        type: 'string',
-        default: '',
-      })
-      .option('fastly-auth', {
-        description: 'the Fastly token',
-        type: 'string',
-        default: '',
-      })
-      .option('coralogix-token', {
-        description: 'the Coralogix token (to enable logging)',
-        type: 'string',
-        default: '',
-      })
-      .option('fastly-gateway', {
-        description: 'the hostname of the Fastly gateway for package params',
-        type: 'string',
-        default: '',
-      })
-      .option('compute-coralogix-app', {
-        description: 'the Application name',
-        type: 'string',
-        default: 'fastly-compute',
-      });
-  }
-}

package/src/deploy/ComputeAtEdgeDeployer.js

@@ -1,185 +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 chalk from 'chalk-template';
-import path from 'path';
-import fs from 'fs/promises';
-import * as tar from 'tar';
-import Fastly from '@adobe/fastly-native-promises';
-import { compileApplicationToWasm } from '@fastly/js-compute/src/compileApplicationToWasm.js';
-import { parseInputs } from '@fastly/js-compute/src/parseInputs.js';
-import BaseDeployer from './BaseDeployer.js';
-import ComputeAtEdgeConfig from './ComputeAtEdgeConfig.js';
-
-/**
- * The class ComputeAtEdgeDeployer deploys to Fastly's Compute(at)Edge (WASM) runtime.
- * It should be seen as a functional equivalent to the CloudflareDeployer
- * and not confused with the FastlyGateway (which only routes requests, but
- * does not handle them.)
- */
-export default class ComputeAtEdgeDeployer extends BaseDeployer {
-  constructor(baseConfig, config) {
-    super(baseConfig);
-    Object.assign(this, {
-      id: 'c@e',
-      name: 'Fastly Compute@Edge',
-      _cfg: config,
-      _fastly: null,
-      noGatewayBackend: true,
-    });
-  }
-
-  ready() {
-    return !!this._cfg.service && !!this._cfg.auth && !!this.cfg.edgeBundle;
-  }
-
-  validate() {
-    if (!this.ready()) {
-      throw new Error('Compute@Edge target needs token and service ID');
-    }
-  }
-
-  init() {
-    if (this.ready() && !this._fastly) {
-      this._fastly = Fastly(this._cfg.auth, this._cfg.service, 60000);
-    }
-  }
-
-  get log() {
-    return this.cfg.log;
-  }
-
-  /**
-   *
-   * @returns
-   */
-  async bundle() {
-    const bundleDir = path.dirname(this.cfg.edgeBundle);
-    this.log.debug(`--: creating fastly.toml in ${bundleDir}`);
-    fs.writeFile(path.resolve(bundleDir, 'fastly.toml'), `
-# This file describes a Fastly Compute@Edge package. To learn more visit:
-# https://developer.fastly.com/reference/fastly-toml/
-
-authors = ["Helix Deploy"]
-description = "${this.cfg.packageName} project generated by Helix Deploy"
-language = "javascript"
-manifest_version = 2
-name = "${this.cfg.packageName}"
-service_id = ""
-    `);
-
-    const {
-      input,
-      output,
-      wasmEngine,
-    } = await parseInputs([this.cfg.edgeBundle, path.resolve(bundleDir, 'bin', 'main.wasm')]);
-
-    return new Promise((resolve, reject) => {
-      this.log.debug('--: creating WASM bundle of script and interpreter');
-      compileApplicationToWasm(input, output, wasmEngine, false, false)
-        .then(async () => {
-          const file = path.resolve(bundleDir, 'fastly-bundle.tar.gz');
-          this.log.debug(chalk`{green ok:} created WASM bundle of script and interpreter in ${bundleDir}/bin/main.wasm`);
-          await tar.c({
-            gzip: true,
-            // sync: true,
-            cwd: bundleDir,
-            prefix: this.cfg.packageName,
-            file,
-          }, ['bin/main.wasm', 'fastly.toml']);
-          this.log.debug(chalk`{green ok:} created tar file in ${bundleDir}/fastly-bundle.tar.gz`);
-          resolve(fs.readFile(file));
-        })
-        // c8 ignore next 3
-        .catch((err) => {
-          reject(err);
-        });
-    });
-  }
-
-  async deploy() {
-    const buf = await this.bundle();
-    this.init();
-
-    await this._fastly.transact(async (version) => {
-      this.log.debug('--: uploading package to fastly, service version', version);
-      await this._fastly.writePackage(version, buf);
-
-      this.log.debug('--: creating secrets dictionary');
-      await this._fastly.writeDictionary(version, 'secrets', {
-        name: 'secrets',
-        write_only: 'true',
-      });
-
-      const host = this._cfg.fastlyGateway;
-      const backend = {
-        hostname: host,
-        ssl_cert_hostname: host,
-        ssl_sni_hostname: host,
-        address: host,
-        override_host: host,
-        name: 'gateway',
-        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,
-      };
-      if (host) {
-        this.log.debug(`--: updating gateway backend: ${host}`);
-        await this._fastly.writeBackend(version, 'gateway', backend);
-      }
-    }, true);
-
-    await this._fastly.discard();
-  }
-
-  async updatePackage() {
-    this.log.info(`--: updating app (gateway) config for https://${this._cfg.fastlyGateway}/${this.cfg.packageName}/...`);
-
-    this.init();
-
-    const functionparams = Object
-      .entries(this.cfg.params)
-      .map(([key, value]) => ({
-        item_key: key,
-        item_value: value,
-        op: 'update',
-      }));
-
-    await this._fastly.bulkUpdateDictItems(undefined, 'secrets', ...functionparams);
-    await this._fastly.updateDictItem(undefined, 'secrets', '_token', this.cfg.packageToken);
-    await this._fastly.updateDictItem(undefined, 'secrets', '_package', `https://${this._cfg.fastlyGateway}/${this.cfg.packageName}/`);
-
-    await this._fastly.discard();
-  }
-
-  get fullFunctionName() {
-    return `${this.cfg.packageName}--${this.cfg.name}`
-      .replace(/\./g, '_')
-      .replace('@', '_');
-  }
-
-  async test() {
-    return this._cfg.testDomain
-      ? this.testRequest({
-        url: `https://${this._cfg.testDomain}.edgecompute.app`,
-        retry404: 0,
-      })
-      : undefined;
-  }
-}
-
-ComputeAtEdgeDeployer.Config = ComputeAtEdgeConfig;

package/src/gateway/FastlyConfig.js

@@ -1,96 +0,0 @@
-/*
- * Copyright 2020 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 FastlyConfig {
-  constructor() {
-    Object.assign(this, {
-      service: null,
-      auth: null,
-      checkpath: '',
-      checkinterval: 0,
-    });
-  }
-
-  configure(argv) {
-    return this
-      .withServiceID(argv.fastlyServiceId)
-      .withAuth(argv.fastlyAuth)
-      .withCoralogixToken(argv.coralogixToken)
-      .withCoralogixApp(argv.coralogixApp)
-      .withCheckInterval(argv.checkInterval)
-      .withCheckpath(argv.checkpath);
-  }
-
-  withAuth(value) {
-    this.auth = value;
-    return this;
-  }
-
-  withCheckInterval(value) {
-    this.checkinterval = value;
-    return this;
-  }
-
-  withServiceID(value) {
-    this.service = value;
-    return this;
-  }
-
-  withCheckpath(value) {
-    this.checkpath = value;
-    return this;
-  }
-
-  withCoralogixToken(value) {
-    this.coralogixToken = value;
-    return this;
-  }
-
-  withCoralogixApp(value) {
-    this.coralogixApp = value;
-    return this;
-  }
-
-  static yarg(yargs) {
-    return yargs
-      .group(['fastly-service-id', 'fastly-auth', 'checkpath', 'coralogix-token', 'coralogix-app'], 'Fastly Gateway Options')
-      .option('fastly-service-id', {
-        description: 'the Fastly Service to use as a gateway',
-        type: 'string',
-        default: '',
-      })
-      .option('fastly-auth', {
-        description: 'the Fastly token',
-        type: 'string',
-        default: '',
-      })
-      .option('coralogix-token', {
-        description: 'the Coralogix token (to enable logging)',
-        type: 'string',
-        default: '',
-      })
-      .option('coralogix-app', {
-        description: 'the Application name',
-        type: 'string',
-        default: 'universal-runtime',
-      })
-      .option('checkpath', {
-        description: 'the path to check as part of the Fastly health check',
-        type: 'string',
-        default: '',
-      })
-      .option('checkinterval', {
-        description: 'the interval in milliseconds that each Fastly POP should perform a health check. Set to 0 to disable health checks entirely.',
-        type: 'number',
-        default: 6000000,
-      });
-  }
-}