@adobe/helix-shared-config 1.7.22 → 2.0.1

package/src/ConfigValidator.js

@@ -1,95 +0,0 @@
-/*
- * Copyright 2018 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.
- */
-
-/* eslint-disable max-classes-per-file */
-
-const Ajv = require('ajv').default;
-const ajvFormats = require('ajv-formats');
-const ValidationError = require('./ValidationError.js');
-
-const schemas = [
-  /* eslint-disable global-require */
-  require('./schemas/config.schema.json'),
-  require('./schemas/version-lock.schema.json'),
-  require('./schemas/runtimestrain.schema.json'),
-  require('./schemas/proxystrain.schema.json'),
-  require('./schemas/strains.schema.json'),
-  require('./schemas/giturl.schema.json'),
-  require('./schemas/staticgiturl.schema.json'),
-  require('./schemas/origin.schema.json'),
-  require('./schemas/performance.schema.json'),
-  require('./schemas/redirectrule.schema.json'),
-  require('./schemas/conditions.schema.json'),
-  /* eslint-enable global-require */
-];
-
-class HelixConfigValidationError extends ValidationError {
-  constructor(msg, errors = []) {
-    super(msg, errors, HelixConfigValidationError.mapError, HelixConfigValidationError.prettyname);
-  }
-
-  static prettyname(path, schema) {
-    if (path && path.startsWith('.strains')) {
-      return `${schema.title || 'Invalid Strain'} ${path.replace(/\.strains(\.|\[')(.*)/, '$2').replace(/'.*/, '')}`;
-    }
-    return ValidationError.prettyname(path, schema);
-  }
-
-  static mapError({
-    keyword, dataPath, message, data, params, parentSchema,
-  }, prettyname) {
-    if (keyword === 'required' && dataPath === '') {
-      return 'A set of strains and a default strain are missing.';
-    }
-    if (keyword === 'required' && dataPath === '.strains') {
-      return 'A default strain is missing.';
-    }
-    if (keyword === 'oneOf' && dataPath.startsWith('.strains')) {
-      return `${prettyname(dataPath, parentSchema)} must be either a Runtime Strain or a Proxy Strain`;
-    }
-    return ValidationError.mapError(keyword, dataPath, message, data, params, parentSchema);
-  }
-}
-
-class ConfigValidator {
-  constructor() {
-    this._ajv = new Ajv({
-      allErrors: true,
-      verbose: true,
-      useDefaults: true,
-      coerceTypes: true,
-      strict: false,
-    });
-    this._ajv.addSchema(schemas);
-    ajvFormats(this._ajv);
-  }
-
-  validate(config = {}) {
-    this._ajv.errors = [];
-    return this._ajv.validate('https://ns.adobe.com/helix/shared/config', config);
-  }
-
-  assetValid(config = {}) {
-    // handle simple case for no strains. since the ajv error is a bit cryptic.
-    if (!config.strains
-      || ((config.strains.find && !config.strains.find((s) => s.name === 'default'))
-        && !config.strains.default)) {
-      throw new HelixConfigValidationError('A list of strains and a strain with the name "default" is required.');
-    }
-    const valid = this.validate(config);
-    if (!valid) {
-      throw new HelixConfigValidationError(this._ajv.errorsText(), this._ajv.errors);
-    }
-  }
-}
-
-module.exports = ConfigValidator;

package/src/DataEmbedValidator.js

@@ -1,51 +0,0 @@
-/*
- * Copyright 2018 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.
- */
-
-const Ajv = require('ajv').default;
-const ajvFormats = require('ajv-formats');
-
-const schemas = [
-  /* eslint-disable global-require */
-  require('./schemas/data-embed-response.schema.json'),
-  require('./schemas/row.schema.json'),
-  require('./schemas/sheet.schema.json'),
-  require('./schemas/workbook.schema.json'),
-  /* eslint-enable global-require */
-];
-
-class DataEmbedValidator {
-  constructor() {
-    this._ajv = new Ajv({
-      allErrors: true,
-      verbose: true,
-      useDefaults: false,
-      coerceTypes: false,
-      strict: false,
-    });
-    this._ajv.addSchema(schemas);
-    ajvFormats(this._ajv);
-  }
-
-  validate(response = {}) {
-    this._ajv.errors = [];
-    return this._ajv.validate('https://ns.adobe.com/helix/data-embed/response', response);
-  }
-
-  assertValid(response) {
-    const valid = this.validate(response);
-    if (!valid) {
-      throw new Error(this._ajv.errorsText());
-    }
-  }
-}
-
-module.exports = DataEmbedValidator;

package/src/DynamicRedirect.js

@@ -1,125 +0,0 @@
-/*
- * Copyright 2019 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.
- */
-const { URL } = require('url');
-const fetchAPI = require('@adobe/helix-fetch');
-
-const { fetch } = process.env.HELIX_FETCH_FORCE_HTTP1
-  ? fetchAPI.context({
-    alpnProtocols: [fetchAPI.ALPN_HTTP1_1],
-  })
-  /* istanbul ignore next */
-  : fetchAPI;
-
-const DEFAULT_TYPE = 'permanent';
-const FROM_NAMES = ['from', 'src', 'source', 'origin'];
-const TO_NAMES = ['to', 'target', 'dest', 'destination'];
-const TYPE_NAMES = ['type', 'kind'];
-
-function getProp(entry, names) {
-  const pair = Object.entries(entry).find(([key]) => names.includes(key.toLowerCase()));
-  return pair ? pair[1] : null;
-}
-
-function getPath(value) {
-  if (value && value.startsWith('https://')) {
-    return new URL(value).pathname;
-  }
-  return value;
-}
-
-function trim(value) {
-  if (value && typeof value === 'string') {
-    return value.trim();
-  }
-  return value;
-}
-
-function clean(entry) {
-  return {
-    from: getPath(trim(getProp(entry, FROM_NAMES))),
-    to: trim(getProp(entry, TO_NAMES)),
-    type: trim(getProp(entry, TYPE_NAMES)),
-  };
-}
-
-class DynamicRedirect {
-  constructor(src, logger) {
-    this._src = src;
-    this._data = null;
-    this._logger = logger;
-    this._transactionID = null;
-    this._githubToken = null;
-  }
-
-  withTransactionID(id) {
-    this._transactionID = id;
-    return this;
-  }
-
-  withGithubToken(token) {
-    this._githubToken = token;
-    return this;
-  }
-
-  async fetch() {
-    if (!this._data) {
-      try {
-        let url = new URL(this._src);
-        if (!this._src.endsWith('.json')) {
-        // load via universal runtime (todo: do this via a plugin)
-          url = new URL('https://helix-pages.anywhere.run/helix-services/data-embed@v2');
-          url.searchParams.append('src', this._src);
-        }
-        const res = await fetch(url.href, {
-          headers: {
-            ...(this._transactionID ? { 'x-request-id': this._transactionID } : {}),
-            ...(this._githubToken ? { 'x-github-token': this._githubToken } : {}),
-          },
-        });
-        const data = await res.json();
-        if (res.ok) {
-          this._data = data;
-          if ('data' in this._data) {
-            this._data = this._data.data;
-          }
-          this._data = this._data.map(clean);
-        }
-        this._logger.info(`loaded lookup table from ${this._src}`);
-      } catch (e) {
-        this._logger.warn(`failed to get ${this._src} ${e.message}`);
-      }
-    }
-  }
-
-  async match(path) {
-    await this.fetch();
-    if (this._data) {
-      const hit = this._data.find((entry) => entry.from === path
-        || entry.from === path.replace(/[ äӓ]/g, encodeURIComponent));
-      return hit ? {
-        url: hit.to,
-        type: hit.type || DEFAULT_TYPE,
-      } : null;
-    }
-    return null;
-  }
-
-  async all() {
-    await this.fetch();
-    if (this._data) {
-      return this._data;
-    }
-    return [];
-  }
-}
-
-module.exports = DynamicRedirect;

package/src/HelixConfig.js

@@ -1,133 +0,0 @@
-/*
- * Copyright 2018 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.
- */
-
-const Strain = require('./Strain.js');
-const Strains = require('./Strains.js');
-const ConfigValidator = require('./ConfigValidator.js');
-const BaseConfig = require('./BaseConfig.js');
-
-const HELIX_CONFIG = 'helix-config.yaml';
-
-class HelixConfig extends BaseConfig {
-  constructor() {
-    super(HELIX_CONFIG);
-    this._strains = new Strains();
-  }
-
-  /**
-   * @name ResolveFn
-   * @function
-   * @param {Strain} left the current candidate strain (can be undefined)
-   * @param {Strain} right the alternative candidate strain (can be undefined)
-   */
-
-  /**
-   * Updates the current configuration with the strains of another configuration
-   * object and a user-defined resolver function.
-   * @param {HelixConfig} other another Helix Config to merge
-   * @param {ResolveFn} resolvefn a resolver function that returns either a strain or undefined
-   * @returns {HelixConfig} the merged Helix Config, i.e. `this`.
-   */
-  merge(other, resolvefn) {
-    const accept = (acceptedstrains, strainname) => {
-      const strain = resolvefn(
-        this.strains.get(strainname),
-        other.strains.get(strainname),
-      ); // resolve conflict with the resolverfn
-      if (strain) {
-        acceptedstrains.add(strain); // add the strain (if existing) to the new list of strains
-      }
-      return acceptedstrains;
-    };
-
-    this._strains = [...new Set([...other.strains.keys(), ...this.strains.keys()]).keys()]
-      .reduce(accept, new Strains());
-
-    return this;
-  }
-
-  /**
-   * Strains of this config.
-   * @returns {Strains}
-   */
-  get strains() {
-    return this._strains;
-  }
-
-  async validate() {
-    // convert strains-map to array if needed (see https://github.com/adobe/helix-shared/issues/71)
-    if (typeof this._cfg.strains === 'object' && !Array.isArray(this._cfg.strains)) {
-      this._cfg.strains = Object.keys(this._cfg.strains).map((name) => {
-        const strain = this._cfg.strains[name];
-        strain.name = name;
-        return strain;
-      });
-      // invalidate yaml document
-      this._document = null;
-    }
-    new ConfigValidator().assetValid(this._cfg);
-  }
-
-  async init() {
-    await this.loadConfig();
-    await this.validate();
-
-    this._version = this._cfg.version;
-    if (this._document) {
-      // create strains from document
-      const strains = this._document.contents.items.filter((item) => item.key.value === 'strains');
-      // strains.length is always > 0, since JSON schema mandates a strains object
-      this._strains.fromYAML(strains[0].value);
-    } else {
-      this._cfg.strains.forEach((strain) => {
-        this._strains.add(new Strain(strain));
-      });
-    }
-    return this;
-  }
-
-  get preflight() {
-    return this._cfg.preflight;
-  }
-
-  /**
-   * Gets a list of all preflight headers used in this config
-   * @returns String[]
-   */
-  get preflightHeaders() {
-    return [...this._strains
-      .getByFilter((s) => s.condition)
-      .map((s) => s.condition)
-      .reduce((s, c) => {
-        const headers = c.preflightHeaders;
-        if (headers && Array.isArray(headers)) {
-          headers.forEach((h) => s.add(h));
-        }
-        return s;
-      }, new Set())];
-  }
-
-  toJSON() {
-    const retval = {
-      version: this._version,
-      strains: this._strains.toJSON(),
-    };
-
-    if (this.preflight) {
-      retval.preflight = this.preflight;
-    }
-
-    return retval;
-  }
-}
-
-module.exports = HelixConfig;

package/src/MarkupConfig.js

@@ -1,35 +0,0 @@
-/*
- * Copyright 2019 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.
- */
-const SchemaDerivedConfig = require('./SchemaDerivedConfig.js');
-const { NamedMapHandler } = require('./NamedMapHandler');
-
-const markupConfigSchema = require('./schemas/markupconfig.schema.json');
-const markupSchema = require('./schemas/markup.schema.json');
-const markupMappingSchema = require('./schemas/markupmapping.schema.json');
-
-class MarkupConfig extends SchemaDerivedConfig {
-  constructor() {
-    super({
-      filename: 'helix-markup.yaml',
-      schemas: {
-        '^/$': markupConfigSchema,
-        '^/markup$': markupSchema,
-        '^/markup/.*$': markupMappingSchema,
-      },
-      handlers: {
-        '^/markup$': NamedMapHandler(),
-      },
-    });
-  }
-}
-
-module.exports = MarkupConfig;

package/src/Origin.js

@@ -1,159 +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.
- */
-const URI = require('uri-js');
-const hash = require('object-hash');
-const pruneEmptyValues = require('@adobe/helix-shared-prune');
-
-class Origin {
-  constructor(cfg) {
-    if (typeof cfg === 'object') {
-      this._hostname = cfg.hostname || cfg.address;
-      this._errorThreshold = cfg.error_threshold || 0;
-      this._firstByteTimeout = cfg.first_byte_timeout || 0;
-      this._weight = cfg.weight || 100;
-      this._address = cfg.address;
-      this._connectTimeout = cfg.connect_timeout || 1000;
-      this._name = cfg.name || `Proxy${this._hostname.replace(/[^\w]/g, '')}${hash(this._hostname).substr(0, 4)}`;
-      this._betweenBytesTimeout = cfg.between_bytes_timeout || 10000;
-      this._shield = cfg.shield || 'bwi-va-us';
-      this._SSLCertHostname = cfg.ssl_cert_hostname || this._hostname;
-      this._maxConn = cfg.max_conn || 200;
-      this._useSSL = !(cfg.use_ssl === false);
-      this._path = cfg.path || '/';
-      this._overrideHost = cfg.override_host;
-      if (cfg.port && Number.parseInt(cfg.port, 10) > 0) {
-        this._port = cfg.port;
-      } else {
-        this._port = this._useSSL ? 443 : 80;
-      }
-    } else if (cfg && URI.parse(cfg).scheme) {
-      const backenduri = URI.parse(cfg);
-      this._hostname = backenduri.host;
-      this._errorThreshold = 0;
-      this._firstByteTimeout = 15000;
-      this._weight = 100;
-      this._address = backenduri.host;
-      this._connectTimeout = 1000;
-      this._name = `Proxy${this._hostname.replace(/[^\w]/g, '')}${hash(this._hostname).substr(0, 4)}`;
-      this._port = backenduri.port || (backenduri.scheme === 'https' ? 443 : 80);
-      this._betweenBytesTimeout = 10000;
-      this._shield = 'bwi-va-us';
-      this._SSLCertHostname = backenduri.host;
-      this._maxConn = 200;
-      this._useSSL = backenduri.scheme === 'https';
-      this._path = backenduri.path;
-    } else if (cfg) {
-      throw new Error('Origin must be an absolute URL or an Object');
-    } else {
-      throw new Error('Invalid or empty configuration');
-    }
-  }
-
-  get hostname() {
-    return this._hostname;
-  }
-
-  get errorThreshold() {
-    return this._errorThreshold;
-  }
-
-  get firstByteTimeout() {
-    return this._firstByteTimeout;
-  }
-
-  get weight() {
-    return this._weight;
-  }
-
-  get address() {
-    return this._address;
-  }
-
-  get connectTimeout() {
-    return Number.parseInt(this._connectTimeout, 10);
-  }
-
-  get name() {
-    return this._name;
-  }
-
-  get port() {
-    return Number.parseInt(this._port, 10);
-  }
-
-  get betweenBytesTimeout() {
-    return this._betweenBytesTimeout;
-  }
-
-  get shield() {
-    return this._shield;
-  }
-
-  get SSLCertHostname() {
-    return this._SSLCertHostname;
-  }
-
-  get maxConn() {
-    return this._maxConn;
-  }
-
-  get useSSL() {
-    return this._useSSL;
-  }
-
-  get path() {
-    return this._path;
-  }
-
-  get overrideHost() {
-    return this._overrideHost;
-  }
-
-  /**
-   * Returns a limited JSON representation that is compatible with the Fastly API
-   */
-  toFastlyJSON() {
-    const json = {
-      hostname: this.hostname,
-      error_threshold: this.errorThreshold,
-      first_byte_timeout: this.firstByteTimeout,
-      weight: this.weight,
-      address: this.address,
-      connect_timeout: this.connectTimeout,
-      name: this.name,
-      port: this.port,
-      between_bytes_timeout: this.betweenBytesTimeout,
-      shield: this.shield,
-      ssl_cert_hostname: this.SSLCertHostname,
-      max_conn: this.maxConn,
-      use_ssl: this.useSSL,
-    };
-    if (this.overrideHost) {
-      json.override_host = this.overrideHost;
-    }
-    return json;
-  }
-
-  /**
-   * Returns a full, round-trippable JSON representation
-   */
-  toJSON(opts) {
-    const json = this.toFastlyJSON();
-    json.path = this.path;
-    if (opts && opts.minimal) {
-      return pruneEmptyValues(json);
-    }
-    return json;
-  }
-}
-
-module.exports = Origin;

package/src/Performance.js

@@ -1,80 +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.
- */
-
-const YAML = require('yaml');
-const pruneEmptyValues = require('@adobe/helix-shared-prune');
-
-/**
- * Performance Definition
- */
-class Performance {
-  constructor(cfg = {}) {
-    this._device = cfg.device || '';
-    this._location = cfg.location || '';
-    this._connection = cfg.connection || '';
-    this._thresholds = Object.keys(cfg).reduce((p, k) => {
-      // copy all properties that are numbers
-      if (cfg[k] && typeof cfg[k] === 'number') {
-        // eslint-disable-next-line no-param-reassign
-        p[k] = cfg[k];
-      }
-      return p;
-    }, {});
-  }
-
-  get device() {
-    return this._device;
-  }
-
-  get location() {
-    return this._location;
-  }
-
-  get connection() {
-    return this._connection;
-  }
-
-  get thresholds() {
-    return this._thresholds;
-  }
-
-  /**
-   * JSON Serialization of Performance
-   * @typedef Performance~JSON
-   * @property {String} device
-   * @property {String} location
-   * @property {String} connection
-   */
-
-  /**
-   * Returns a json representation
-   * @returns {Performance~JSON}
-   */
-  toJSON(opts) {
-    const json = {
-      device: this.device,
-      location: this.location,
-      connection: this.connection,
-      ...this.thresholds,
-    };
-    if (opts && opts.minimal) {
-      return pruneEmptyValues(json);
-    }
-    return json;
-  }
-
-  toYAMLNode() {
-    const json = this.toJSON({ minimal: true });
-    return json ? YAML.createNode(json) : null;
-  }
-}
-module.exports = Performance;