@adobe/alloy 2.20.0-alpha.1 → 2.20.0-beta.2

package/libEs6/core/index.js

@@ -1,236 +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.
-*/
-
-import createInstanceFunction from "./createInstanceFunction";
-import { getApexDomain, injectStorage, cookieJar, isFunction, createLoggingCookieJar, injectFireReferrerHideableImage } from "../utils";
-import createLogController from "./createLogController";
-import createLifecycle from "./createLifecycle";
-import createComponentRegistry from "./createComponentRegistry";
-import injectSendNetworkRequest from "./network/injectSendNetworkRequest";
-import injectExtractEdgeInfo from "./edgeNetwork/injectExtractEdgeInfo";
-import createConsent from "./consent/createConsent";
-import createConsentStateMachine from "./consent/createConsentStateMachine";
-import createEvent from "./createEvent";
-import injectCreateResponse from "./injectCreateResponse";
-import injectExecuteCommand from "./injectExecuteCommand";
-import validateCommandOptions from "./validateCommandOptions";
-import componentCreators from "./componentCreators";
-import buildAndValidateConfig from "./buildAndValidateConfig";
-import initializeComponents from "./initializeComponents";
-import createConfig from "./config/createConfig";
-import createCoreConfigs from "./config/createCoreConfigs";
-import injectHandleError from "./injectHandleError";
-import injectSendFetchRequest from "./network/requestMethods/injectSendFetchRequest";
-import injectSendXhrRequest from "./network/requestMethods/injectSendXhrRequest";
-import injectSendBeaconRequest from "./network/requestMethods/injectSendBeaconRequest";
-import createLogger from "./createLogger";
-import createEventManager from "./createEventManager";
-import createCookieTransfer from "./createCookieTransfer";
-import injectShouldTransferCookie from "./injectShouldTransferCookie";
-import { createDataCollectionRequest, createDataCollectionRequestPayload, createGetAssuranceValidationTokenParams } from "../utils/request";
-import injectSendEdgeNetworkRequest from "./edgeNetwork/injectSendEdgeNetworkRequest";
-import injectProcessWarningsAndErrors from "./edgeNetwork/injectProcessWarningsAndErrors";
-import injectGetLocationHint from "./edgeNetwork/injectGetLocationHint";
-import isRequestRetryable from "./network/isRequestRetryable";
-import getRequestRetryDelay from "./network/getRequestRetryDelay";
-import injectApplyResponse from "./edgeNetwork/injectApplyResponse";
-const createNamespacedStorage = injectStorage(window);
-const {
-  console,
-  fetch,
-  navigator,
-  XMLHttpRequest
-} = window;
-
-// set this up as a function so that monitors can be added at anytime
-// eslint-disable-next-line no-underscore-dangle
-const getMonitors = () => window.__alloyMonitors || [];
-const coreConfigValidators = createCoreConfigs();
-const apexDomain = getApexDomain(window, cookieJar);
-const sendFetchRequest = isFunction(fetch) ? injectSendFetchRequest({
-  fetch
-}) : injectSendXhrRequest({
-  XMLHttpRequest
-});
-const fireReferrerHideableImage = injectFireReferrerHideableImage();
-const getAssuranceValidationTokenParams = createGetAssuranceValidationTokenParams({
-  window,
-  createNamespacedStorage
-});
-export const createExecuteCommand = ({
-  instanceName,
-  logController: {
-    setDebugEnabled,
-    logger,
-    createComponentLogger
-  }
-}) => {
-  const componentRegistry = createComponentRegistry();
-  const lifecycle = createLifecycle(componentRegistry);
-  const setDebugCommand = options => {
-    setDebugEnabled(options.enabled, {
-      fromConfig: false
-    });
-  };
-  const loggingCookieJar = createLoggingCookieJar({
-    logger,
-    cookieJar
-  });
-  const configureCommand = options => {
-    const config = buildAndValidateConfig({
-      options,
-      componentCreators,
-      coreConfigValidators,
-      createConfig,
-      logger,
-      setDebugEnabled
-    });
-    const {
-      orgId,
-      targetMigrationEnabled
-    } = config;
-    const shouldTransferCookie = injectShouldTransferCookie({
-      orgId,
-      targetMigrationEnabled
-    });
-    const cookieTransfer = createCookieTransfer({
-      cookieJar: loggingCookieJar,
-      shouldTransferCookie,
-      apexDomain,
-      dateProvider: () => new Date()
-    });
-    const sendBeaconRequest = isFunction(navigator.sendBeacon) ? injectSendBeaconRequest({
-      // Without the bind(), the browser will complain about an
-      // illegal invocation.
-      sendBeacon: navigator.sendBeacon.bind(navigator),
-      sendFetchRequest,
-      logger
-    }) : sendFetchRequest;
-    const sendNetworkRequest = injectSendNetworkRequest({
-      logger,
-      sendFetchRequest,
-      sendBeaconRequest,
-      isRequestRetryable,
-      getRequestRetryDelay
-    });
-    const processWarningsAndErrors = injectProcessWarningsAndErrors({
-      logger
-    });
-    const extractEdgeInfo = injectExtractEdgeInfo({
-      logger
-    });
-    const createResponse = injectCreateResponse({
-      extractEdgeInfo
-    });
-    const getLocationHint = injectGetLocationHint({
-      orgId,
-      cookieJar
-    });
-    const sendEdgeNetworkRequest = injectSendEdgeNetworkRequest({
-      config,
-      lifecycle,
-      cookieTransfer,
-      sendNetworkRequest,
-      createResponse,
-      processWarningsAndErrors,
-      getLocationHint,
-      getAssuranceValidationTokenParams
-    });
-    const applyResponse = injectApplyResponse({
-      lifecycle,
-      cookieTransfer,
-      createResponse,
-      processWarningsAndErrors
-    });
-    const generalConsentState = createConsentStateMachine({
-      logger
-    });
-    const consent = createConsent({
-      generalConsentState,
-      logger
-    });
-    const eventManager = createEventManager({
-      config,
-      logger,
-      lifecycle,
-      consent,
-      createEvent,
-      createDataCollectionRequestPayload,
-      createDataCollectionRequest,
-      sendEdgeNetworkRequest,
-      applyResponse
-    });
-    return initializeComponents({
-      componentCreators,
-      lifecycle,
-      componentRegistry,
-      getImmediatelyAvailableTools(componentName) {
-        const componentLogger = createComponentLogger(componentName);
-        return {
-          config,
-          componentRegistry,
-          consent,
-          eventManager,
-          fireReferrerHideableImage,
-          logger: componentLogger,
-          lifecycle,
-          sendEdgeNetworkRequest,
-          handleError: injectHandleError({
-            errorPrefix: `[${instanceName}] [${componentName}]`,
-            logger: componentLogger
-          }),
-          createNamespacedStorage,
-          apexDomain
-        };
-      }
-    });
-  };
-  const handleError = injectHandleError({
-    errorPrefix: `[${instanceName}]`,
-    logger
-  });
-  const executeCommand = injectExecuteCommand({
-    logger,
-    configureCommand,
-    setDebugCommand,
-    handleError,
-    validateCommandOptions
-  });
-  return executeCommand;
-};
-export default (() => {
-  // eslint-disable-next-line no-underscore-dangle
-  const instanceNames = window.__alloyNS;
-  if (instanceNames) {
-    instanceNames.forEach(instanceName => {
-      const logController = createLogController({
-        console,
-        locationSearch: window.location.search,
-        createLogger,
-        instanceName,
-        createNamespacedStorage,
-        getMonitors
-      });
-      const executeCommand = createExecuteCommand({
-        instanceName,
-        logController
-      });
-      const instance = createInstanceFunction(executeCommand);
-      const queue = window[instanceName].q;
-      queue.push = instance;
-      logController.logger.logOnInstanceCreated({
-        instance
-      });
-      queue.forEach(instance);
-    });
-  }
-});

package/libEs6/core/initializeComponents.js

@@ -1,40 +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.
-*/
-
-import { stackError } from "../utils";
-export default (({
-  componentCreators,
-  lifecycle,
-  componentRegistry,
-  getImmediatelyAvailableTools
-}) => {
-  componentCreators.forEach(createComponent => {
-    const {
-      namespace
-    } = createComponent;
-    // TO-DOCUMENT: Helpers that we inject into factories.
-    const tools = getImmediatelyAvailableTools(namespace);
-    let component;
-    try {
-      component = createComponent(tools);
-    } catch (error) {
-      throw stackError({
-        error,
-        message: `[${namespace}] An error occurred during component creation.`
-      });
-    }
-    componentRegistry.register(namespace, component);
-  });
-  return lifecycle.onComponentsRegistered({
-    lifecycle
-  }).then(() => componentRegistry);
-});

package/libEs6/core/injectCreateResponse.js

@@ -1,70 +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.
-*/
-
-import { flatMap } from "../utils";
-import { ADOBE_EDGE } from "../constants/httpHeaderNames";
-
-/**
- * Creates a representation of a gateway response with the addition of
- * helper methods.
- * @returns Response
- */
-export default (({
-  extractEdgeInfo
-}) => ({
-  content = {},
-  getHeader
-}) => {
-  const {
-    handle = [],
-    errors = [],
-    warnings = []
-  } = content;
-
-  /**
-   * Response object.
-   * @typedef {Object} Response
-   */
-  return {
-    /**
-     * Returns matching fragments of the response by type.
-     * @param {String} type A string with the current format: <namespace:action>
-     *
-     * @example
-     * getPayloadsByType("identity:persist")
-     */
-    getPayloadsByType(type) {
-      return flatMap(handle.filter(fragment => fragment.type === type), fragment => fragment.payload);
-    },
-    /**
-     * Returns all errors.
-     */
-    getErrors() {
-      return errors;
-    },
-    /**
-     * Returns all warnings.
-     */
-    getWarnings() {
-      return warnings;
-    },
-    /**
-     * Returns an object containing the regionId from the x-adobe-edge header
-     */
-    getEdge() {
-      return extractEdgeInfo(getHeader(ADOBE_EDGE));
-    },
-    toJSON() {
-      return content;
-    }
-  };
-});

package/libEs6/core/injectExecuteCommand.js

@@ -1,100 +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.
-*/
-
-import { isFunction, isObject } from "../utils";
-import { CONFIGURE, SET_DEBUG } from "../constants/coreCommands";
-export default (({
-  logger,
-  configureCommand,
-  setDebugCommand,
-  handleError,
-  validateCommandOptions
-}) => {
-  let configurePromise;
-  const getExecutor = (commandName, options) => {
-    let executor;
-    if (commandName === CONFIGURE) {
-      if (configurePromise) {
-        throw new Error("The library has already been configured and may only be configured once.");
-      }
-      executor = () => {
-        configurePromise = configureCommand(options);
-        return configurePromise.then(() => {
-          // Don't expose internals to the user.
-        });
-      };
-    } else {
-      if (!configurePromise) {
-        throw new Error(`The library must be configured first. Please do so by executing the configure command.`);
-      }
-      if (commandName === SET_DEBUG) {
-        executor = () => setDebugCommand(options);
-      } else {
-        executor = () => {
-          return configurePromise.then(componentRegistry => {
-            const command = componentRegistry.getCommand(commandName);
-            if (!command || !isFunction(command.run)) {
-              const commandNames = [CONFIGURE, SET_DEBUG].concat(componentRegistry.getCommandNames()).join(", ");
-              throw new Error(`The ${commandName} command does not exist. List of available commands: ${commandNames}.`);
-            }
-            const validatedOptions = validateCommandOptions({
-              command,
-              options
-            });
-            return command.run(validatedOptions);
-          }, () => {
-            logger.warn(`An error during configuration is preventing the ${commandName} command from executing.`);
-            // If configuration failed, we prevent the configuration
-            // error from bubbling here because we don't want the
-            // configuration error to be reported in the console every
-            // time any command is executed. Only having it bubble
-            // once when the configure command runs is sufficient.
-            // Instead, for this command, we'll just return a promise
-            // that never gets resolved.
-            return new Promise(() => {});
-          });
-        };
-      }
-    }
-    return executor;
-  };
-  return (commandName, options = {}) => {
-    return new Promise(resolve => {
-      // We have to wrap the getExecutor() call in the promise so the promise
-      // will be rejected if getExecutor() throws errors.
-      const executor = getExecutor(commandName, options);
-      logger.logOnBeforeCommand({
-        commandName,
-        options
-      });
-      resolve(executor());
-    }).catch(error => {
-      return handleError(error, `${commandName} command`);
-    }).catch(error => {
-      logger.logOnCommandRejected({
-        commandName,
-        options,
-        error
-      });
-      throw error;
-    }).then(rawResult => {
-      // We should always be returning an object from every command.
-      const result = isObject(rawResult) ? rawResult : {};
-      logger.logOnCommandResolved({
-        commandName,
-        options,
-        result
-      });
-      return result;
-    });
-  };
-});

package/libEs6/core/injectHandleError.js

@@ -1,33 +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.
-*/
-
-import { toError, updateErrorMessage } from "../utils";
-import { DECLINED_CONSENT_ERROR_CODE } from "./consent/createConsentStateMachine";
-export default (({
-  errorPrefix,
-  logger
-}) => (error, operation) => {
-  const err = toError(error);
-
-  // In the case of declined consent, we've opted to not reject the promise
-  // returned to the customer, but instead resolve the promise with an
-  // empty result object.
-  if (err.code === DECLINED_CONSENT_ERROR_CODE) {
-    logger.warn(`The ${operation} could not fully complete. ${err.message}`);
-    return {};
-  }
-  updateErrorMessage({
-    error: err,
-    message: `${errorPrefix} ${err.message}`
-  });
-  throw err;
-});

package/libEs6/core/injectShouldTransferCookie.js

@@ -1,25 +0,0 @@
-/*
-Copyright 2022 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 { isNamespacedCookieName } from "../utils";
-import { AT_QA_MODE, MBOX } from "../constants/legacyCookies";
-export default (({
-  orgId,
-  targetMigrationEnabled
-}) => name => {
-  // We have a contract with the server that we will pass
-  // all cookies whose names are namespaced according to the
-  // logic in isNamespacedCookieName as well as any legacy
-  // cookie names (so that the server can handle migrating
-  // identities on websites previously using Visitor.js)
-  return isNamespacedCookieName(orgId, name) || name === AT_QA_MODE || targetMigrationEnabled && name === MBOX;
-});

package/libEs6/core/network/getRequestRetryDelay.js

@@ -1,72 +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.
-*/
-
-import { RETRY_AFTER } from "../../constants/httpHeaderNames";
-import { isInteger } from "../../utils";
-
-// The retry gets incrementally (but not exponentially) longer for each retry.
-const FIRST_DELAY_MILLIS = 1000;
-const INCREMENTAL_DELAY_MILLIS = 1000;
-
-// When the target delay is randomized, make it within the range of this percentage above or below the target delay.
-const MAX_RANDOM_VARIANCE_PERCENTAGE = 0.3;
-const calculateRetryDelay = retriesAttempted => {
-  const targetDelay = FIRST_DELAY_MILLIS + retriesAttempted * INCREMENTAL_DELAY_MILLIS;
-  const maxVariance = targetDelay * MAX_RANDOM_VARIANCE_PERCENTAGE;
-  const minDelay = targetDelay - maxVariance;
-  const maxDelay = targetDelay + maxVariance;
-  const randomizedDelayWithinRange = Math.round(minDelay + Math.random() * (maxDelay - minDelay));
-  return randomizedDelayWithinRange;
-};
-const getDelayFromHeader = response => {
-  // According to the HTTP spec, if the header is defined, its value will be a string that
-  // represents either:
-  //  * An integer indicating the number of seconds to delay.
-  //  * A date after which a retry may occur. The date would be in HTTP-date
-  //    format (https://tools.ietf.org/html/rfc7231#section-7.1.1.1). When debugging, it can
-  //    be helpful to know that this is the same format that a JavaScript date's
-  //    toGMTString() returns.
-  const headerValue = response.getHeader(RETRY_AFTER);
-  let delayInMillis;
-  if (headerValue) {
-    const headerValueInt = parseInt(headerValue, 10);
-    if (isInteger(headerValueInt)) {
-      delayInMillis = headerValueInt * 1000;
-    } else {
-      delayInMillis = Math.max(0, new Date(headerValue).getTime() - new Date().getTime());
-    }
-  }
-  return delayInMillis;
-};
-
-// These rules are in accordance with
-// https://git.corp.adobe.com/pages/experience-edge/konductor/#/apis/errors?id=handling-4xx-and-5xx-responses
-// For retry delays that don't come from a Retry-After response header, we try to stick with the following best
-// practices outlined in https://docs.microsoft.com/en-us/azure/architecture/best-practices/transient-faults:
-//  * Incremental retry
-//  * Random interval
-export default (({
-  response,
-  retriesAttempted
-}) => {
-  // Technically, only 429 or 503 responses should have a Retry-After header, but we'll respect the
-  // header if we find it on any response.
-  let delayInMillis = getDelayFromHeader(response);
-
-  // Note that the value of delay may be 0 at this point, which would be a valid delay we want to use
-  // and not override, which is why we don't do:
-  // if (!delay) { ... }
-  if (delayInMillis === undefined) {
-    delayInMillis = calculateRetryDelay(retriesAttempted);
-  }
-  return delayInMillis;
-});

package/libEs6/core/network/injectSendNetworkRequest.js

@@ -1,96 +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.
-*/
-
-import { stackError } from "../../utils";
-export default (({
-  logger,
-  sendFetchRequest,
-  sendBeaconRequest,
-  isRequestRetryable,
-  getRequestRetryDelay
-}) => {
-  /**
-   * Send a network request and returns details about the response.
-   */
-  return ({
-    requestId,
-    url,
-    payload,
-    useSendBeacon
-  }) => {
-    // We want to log raw payload and event data rather than
-    // our fancy wrapper objects. Calling payload.toJSON() is
-    // insufficient to get all the nested raw data, because it's
-    // not recursive (it doesn't call toJSON() on the event objects).
-    // Parsing the result of JSON.stringify(), however, gives the
-    // fully recursive raw data.
-    const stringifiedPayload = JSON.stringify(payload);
-    const parsedPayload = JSON.parse(stringifiedPayload);
-    logger.logOnBeforeNetworkRequest({
-      url,
-      requestId,
-      payload: parsedPayload
-    });
-    const executeRequest = (retriesAttempted = 0) => {
-      const requestMethod = useSendBeacon ? sendBeaconRequest : sendFetchRequest;
-      return requestMethod(url, stringifiedPayload).then(response => {
-        const requestIsRetryable = isRequestRetryable({
-          response,
-          retriesAttempted
-        });
-        if (requestIsRetryable) {
-          const requestRetryDelay = getRequestRetryDelay({
-            response,
-            retriesAttempted
-          });
-          return new Promise(resolve => {
-            setTimeout(() => {
-              resolve(executeRequest(retriesAttempted + 1));
-            }, requestRetryDelay);
-          });
-        }
-        let parsedBody;
-        try {
-          parsedBody = JSON.parse(response.body);
-        } catch (e) {
-          // Non-JSON. Something went wrong.
-        }
-        logger.logOnNetworkResponse({
-          requestId,
-          url,
-          payload: parsedPayload,
-          ...response,
-          parsedBody,
-          retriesAttempted
-        });
-        return {
-          statusCode: response.statusCode,
-          body: response.body,
-          parsedBody,
-          getHeader: response.getHeader
-        };
-      });
-    };
-    return executeRequest().catch(error => {
-      logger.logOnNetworkError({
-        requestId,
-        url,
-        payload: parsedPayload,
-        error
-      });
-      throw stackError({
-        error,
-        message: "Network request failed."
-      });
-    });
-  };
-});