@adobe/alloy 2.19.0-beta.0 → 2.19.0-beta.10

package/libEs6/core/edgeNetwork/injectExtractEdgeInfo.js

@@ -9,32 +9,31 @@ the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTA
 OF ANY KIND, either express or implied. See the License for the specific language
 governing permissions and limitations under the License.
 */
+
 export default (({
   logger
 }) => adobeEdgeHeader => {
   if (adobeEdgeHeader) {
     const headerParts = adobeEdgeHeader.split(";");
-
     if (headerParts.length >= 2 && headerParts[1].length > 0) {
       try {
-        const regionId = parseInt(headerParts[1], 10); // eslint recommends using Number.isNaN instead, but this function is
+        const regionId = parseInt(headerParts[1], 10);
+        // eslint recommends using Number.isNaN instead, but this function is
         // not available in Internet Explorer. Number.isNaN is more robust to
         // non-numeric parameters. Since we already know regionId will be an
         // integer, using isNaN is okay.
         // https://github.com/airbnb/javascript#standard-library--isnan
         // eslint-disable-next-line no-restricted-globals
-
         if (!isNaN(regionId)) {
           return {
             regionId
           };
         }
-      } catch (e) {// No need to do anything. The log statement below will log an error
+      } catch (e) {
+        // No need to do anything. The log statement below will log an error
       }
     }
-
     logger.warn(`Invalid adobe edge: "${adobeEdgeHeader}"`);
   }
-
   return {};
 });

package/libEs6/core/edgeNetwork/injectGetLocationHint.js

@@ -9,6 +9,7 @@ the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTA
 OF ANY KIND, either express or implied. See the License for the specific language
 governing permissions and limitations under the License.
 */
+
 import { getNamespacedCookieName } from "../../utils";
 import { CLUSTER } from "../../constants/cookieNameKey";
 import { MBOX_EDGE_CLUSTER } from "../../constants/legacyCookies";
@@ -17,19 +18,14 @@ export default (({
   cookieJar
 }) => {
   const clusterCookieName = getNamespacedCookieName(orgId, CLUSTER);
-
   const fromClusterCookie = () => cookieJar.get(clusterCookieName);
-
   const fromTarget = () => {
     const mboxEdgeCluster = cookieJar.get(MBOX_EDGE_CLUSTER);
-
     if (mboxEdgeCluster) {
       return `t${mboxEdgeCluster}`;
     }
-
     return undefined;
   };
-
   return () => {
     return fromClusterCookie() || fromTarget();
   };

package/libEs6/core/edgeNetwork/injectProcessWarningsAndErrors.js

@@ -9,6 +9,7 @@ the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTA
 OF ANY KIND, either express or implied. See the License for the specific language
 governing permissions and limitations under the License.
 */
+
 import { NO_CONTENT } from "../../constants/httpStatusCode";
 const MESSAGE_PREFIX = "The server responded with a";
 export default (({
@@ -20,13 +21,11 @@ export default (({
       body,
       parsedBody
     } = networkResponse;
-
     if (statusCode < 200 || statusCode >= 300 || !parsedBody && statusCode !== NO_CONTENT || parsedBody && !Array.isArray(parsedBody.handle)) {
       const bodyToLog = parsedBody ? JSON.stringify(parsedBody, null, 2) : body;
       const messageSuffix = bodyToLog ? `response body:\n${bodyToLog}` : `no response body.`;
       throw new Error(`${MESSAGE_PREFIX} status code ${statusCode} and ${messageSuffix}`);
     }
-
     if (parsedBody) {
       const {
         warnings = [],

package/libEs6/core/edgeNetwork/injectSendEdgeNetworkRequest.js

@@ -9,6 +9,7 @@ the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTA
 OF ANY KIND, either express or implied. See the License for the specific language
 governing permissions and limitations under the License.
 */
+
 import { ID_THIRD_PARTY as ID_THIRD_PARTY_DOMAIN } from "../../constants/domain";
 import apiVersion from "../../constants/apiVersion";
 import { createCallbackAggregator, noop } from "../../utils";
@@ -29,11 +30,11 @@ export default (({
     edgeBasePath,
     datastreamId
   } = config;
+
   /**
    * Sends a network request that is aware of payload interfaces,
    * lifecycle methods, configured edge domains, response structures, etc.
    */
-
   return ({
     request,
     runOnResponseCallbacks = noop,
@@ -55,7 +56,6 @@ export default (({
       const edgeBasePathWithLocationHint = locationHint ? `${edgeBasePath}/${locationHint}` : edgeBasePath;
       const configId = request.getDatastreamIdOverride() || datastreamId;
       const payload = request.getPayload();
-
       if (configId !== datastreamId) {
         payload.mergeMeta({
           sdkConfig: {
@@ -65,7 +65,6 @@ export default (({
           }
         });
       }
-
       const url = `https://${endpointDomain}/${edgeBasePathWithLocationHint}/${apiVersion}/${request.getAction()}?configId=${configId}&requestId=${request.getId()}${getAssuranceValidationTokenParams()}`;
       cookieTransfer.cookiesToPayload(payload, endpointDomain);
       return sendNetworkRequest({
@@ -87,11 +86,12 @@ export default (({
         content: parsedBody,
         getHeader
       });
-      cookieTransfer.responseToCookies(response); // Notice we're calling the onResponse lifecycle method even if there are errors
+      cookieTransfer.responseToCookies(response);
+
+      // Notice we're calling the onResponse lifecycle method even if there are errors
       // inside the response body. This is because the full request didn't actually fail--
       // only portions of it that are considered non-fatal (a specific, non-critical
       // Konductor plugin, for example).
-
       return onResponseCallbackAggregator.call({
         response
       }).then(mergeLifecycleResponses);

package/libEs6/core/index.js

@@ -9,6 +9,7 @@ the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTA
 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";
@@ -48,11 +49,11 @@ const {
   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
+} = 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({
@@ -75,18 +76,15 @@ export const createExecuteCommand = ({
 }) => {
   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,
@@ -175,7 +173,6 @@ export const createExecuteCommand = ({
       componentCreators,
       lifecycle,
       componentRegistry,
-
       getImmediatelyAvailableTools(componentName) {
         const componentLogger = createComponentLogger(componentName);
         return {
@@ -195,10 +192,8 @@ export const createExecuteCommand = ({
           apexDomain
         };
       }
-
     });
   };
-
   const handleError = injectHandleError({
     errorPrefix: `[${instanceName}]`,
     logger
@@ -215,7 +210,6 @@ export const createExecuteCommand = ({
 export default (() => {
   // eslint-disable-next-line no-underscore-dangle
   const instanceNames = window.__alloyNS;
-
   if (instanceNames) {
     instanceNames.forEach(instanceName => {
       const logController = createLogController({

package/libEs6/core/initializeComponents.js

@@ -9,6 +9,7 @@ the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTA
 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,
@@ -19,11 +20,10 @@ export default (({
   componentCreators.forEach(createComponent => {
     const {
       namespace
-    } = createComponent; // TO-DOCUMENT: Helpers that we inject into factories.
-
+    } = createComponent;
+    // TO-DOCUMENT: Helpers that we inject into factories.
     const tools = getImmediatelyAvailableTools(namespace);
     let component;
-
     try {
       component = createComponent(tools);
     } catch (error) {
@@ -32,7 +32,6 @@ export default (({
         message: `[${namespace}] An error occurred during component creation.`
       });
     }
-
     componentRegistry.register(namespace, component);
   });
   return lifecycle.onComponentsRegistered({

package/libEs6/core/injectCreateResponse.js

@@ -9,14 +9,15 @@ the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTA
 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
 }) => ({
@@ -28,11 +29,11 @@ export default (({
     errors = [],
     warnings = []
   } = content;
+
   /**
    * Response object.
    * @typedef {Object} Response
    */
-
   return {
     /**
      * Returns matching fragments of the response by type.
@@ -44,31 +45,26 @@ export default (({
     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

@@ -9,6 +9,7 @@ the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTA
 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 (({
@@ -19,60 +20,53 @@ export default (({
   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.
+        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
+            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

package/libEs6/core/injectHandleError.js

@@ -9,21 +9,22 @@ the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTA
 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
+  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}`

package/libEs6/core/injectShouldTransferCookie.js

@@ -9,6 +9,7 @@ the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTA
 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 (({

package/libEs6/core/network/getRequestRetryDelay.js

@@ -9,14 +9,16 @@ the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTA
 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.
+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 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;
@@ -25,7 +27,6 @@ const calculateRetryDelay = retriesAttempted => {
   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:
@@ -36,39 +37,36 @@ const getDelayFromHeader = response => {
   //    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
+};
+
+// 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
+  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

@@ -9,6 +9,7 @@ the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTA
 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,
@@ -39,7 +40,6 @@ export default (({
       requestId,
       payload: parsedPayload
     });
-
     const executeRequest = (retriesAttempted = 0) => {
       const requestMethod = useSendBeacon ? sendBeaconRequest : sendFetchRequest;
       return requestMethod(url, stringifiedPayload).then(response => {
@@ -47,7 +47,6 @@ export default (({
           response,
           retriesAttempted
         });
-
         if (requestIsRetryable) {
           const requestRetryDelay = getRequestRetryDelay({
             response,
@@ -59,14 +58,12 @@ export default (({
             }, requestRetryDelay);
           });
         }
-
         let parsedBody;
-
         try {
           parsedBody = JSON.parse(response.body);
-        } catch (e) {// Non-JSON. Something went wrong.
+        } catch (e) {
+          // Non-JSON. Something went wrong.
         }
-
         logger.logOnNetworkResponse({
           requestId,
           url,
@@ -83,7 +80,6 @@ export default (({
         };
       });
     };
-
     return executeRequest().catch(error => {
       logger.logOnNetworkError({
         requestId,

package/libEs6/core/network/isRequestRetryable.js

@@ -9,12 +9,14 @@ the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTA
 OF ANY KIND, either express or implied. See the License for the specific language
 governing permissions and limitations under the License.
 */
+
 import { TOO_MANY_REQUESTS, SERVICE_UNAVAILABLE, BAD_GATEWAY, GATEWAY_TIMEOUT } from "../../constants/httpStatusCode";
 import { includes } from "../../utils";
 const MAX_RETRIES = 3;
-const RETRYABLE_STATUS_CODES = [TOO_MANY_REQUESTS, SERVICE_UNAVAILABLE, BAD_GATEWAY, GATEWAY_TIMEOUT]; // These rules are in accordance with
-// https://git.corp.adobe.com/pages/experience-edge/konductor/#/apis/errors?id=handling-4xx-and-5xx-responses
+const RETRYABLE_STATUS_CODES = [TOO_MANY_REQUESTS, SERVICE_UNAVAILABLE, BAD_GATEWAY, GATEWAY_TIMEOUT];
 
+// These rules are in accordance with
+// https://git.corp.adobe.com/pages/experience-edge/konductor/#/apis/errors?id=handling-4xx-and-5xx-responses
 export default (({
   response,
   retriesAttempted

package/libEs6/core/network/requestMethods/injectSendBeaconRequest.js

@@ -9,6 +9,7 @@ the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTA
 OF ANY KIND, either express or implied. See the License for the specific language
 governing permissions and limitations under the License.
 */
+
 export default (({
   sendBeacon,
   sendFetchRequest,
@@ -18,22 +19,19 @@ export default (({
     const blob = new Blob([body], {
       type: "text/plain; charset=UTF-8"
     });
-
     if (!sendBeacon(url, blob)) {
       logger.info("Unable to use `sendBeacon`; falling back to `fetch`.");
       return sendFetchRequest(url, body);
-    } // Using sendBeacon, we technically don't get a response back from
+    }
+
+    // Using sendBeacon, we technically don't get a response back from
     // the server, but we'll resolve the promise with an object to maintain
     // consistency with other network strategies.
-
-
     return Promise.resolve({
       statusCode: 204,
-
       getHeader() {
         return null;
       },
-
       body: ""
     });
   };

package/libEs6/core/network/requestMethods/injectSendFetchRequest.js

@@ -9,6 +9,7 @@ the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTA
 OF ANY KIND, either express or implied. See the License for the specific language
 governing permissions and limitations under the License.
 */
+
 export default (({
   fetch
 }) => {
@@ -26,7 +27,6 @@ export default (({
     }).then(response => {
       return response.text().then(responseBody => ({
         statusCode: response.status,
-
         // We expose headers through a function instead of creating an object
         // with all the headers up front largely because the native
         // request.getResponseHeader method is case-insensitive but also because it prevents
@@ -34,7 +34,6 @@ export default (({
         getHeader(name) {
           return response.headers.get(name);
         },
-
         body: responseBody
       }));
     });

package/libEs6/core/network/requestMethods/injectSendXhrRequest.js

@@ -9,13 +9,13 @@ the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTA
 OF ANY KIND, either express or implied. See the License for the specific language
 governing permissions and limitations under the License.
 */
+
 export default (({
   XMLHttpRequest
 }) => {
   return (url, body) => {
     return new Promise((resolve, reject) => {
       const request = new XMLHttpRequest();
-
       request.onreadystatechange = () => {
         if (request.readyState === 4) {
           if (request.status === 0) {
@@ -23,7 +23,6 @@ export default (({
           } else {
             resolve({
               statusCode: request.status,
-
               // We expose headers through a function instead of creating an object
               // with all the headers up front because:
               // 1. It avoids having to add header parsing code to get all headers.
@@ -31,17 +30,14 @@ export default (({
               getHeader(name) {
                 return request.getResponseHeader(name);
               },
-
               body: request.responseText
             });
           }
         }
       };
-
       request.onloadstart = () => {
         request.responseType = "text";
       };
-
       request.open("POST", url, true);
       request.setRequestHeader("Content-Type", "text/plain; charset=UTF-8");
       request.withCredentials = true;

package/libEs6/core/validateCommandOptions.js

@@ -9,6 +9,7 @@ the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTA
 OF ANY KIND, either express or implied. See the License for the specific language
 governing permissions and limitations under the License.
 */
+
 const COMMAND_DOC_URI = "https://adobe.ly/3sHgQHb";
 export default (({
   command,
@@ -20,7 +21,6 @@ export default (({
     optionsValidator
   } = command;
   let validatedOptions = options;
-
   if (optionsValidator) {
     try {
       validatedOptions = optionsValidator(options);
@@ -29,6 +29,5 @@ export default (({
       throw new Error(invalidOptionsMessage);
     }
   }
-
   return validatedOptions;
 });