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

package/libEs6/components/Personalization/handlers/createProcessDomAction.js

@@ -18,33 +18,41 @@ export default (({
     type,
     selector
   } = item.getData() || {};
-
   if (!type) {
     logger.warn("Invalid DOM action data: missing type.", item.getData());
-    return {};
+    return {
+      setRenderAttempted: false,
+      includeInNotification: false
+    };
   }
-
   if (type === "click") {
     if (!selector) {
       logger.warn("Invalid DOM action data: missing selector.", item.getData());
-      return {};
+      return {
+        setRenderAttempted: false,
+        includeInNotification: false
+      };
     }
-
     storeClickMetrics({
       selector,
-      meta: item.getMeta()
+      meta: {
+        ...item.getProposition().getNotification(),
+        trackingLabel: item.getTrackingLabel(),
+        scopeType: item.getProposition().getScopeType()
+      }
     });
     return {
       setRenderAttempted: true,
       includeInNotification: false
     };
   }
-
   if (!modules[type]) {
     logger.warn("Invalid DOM action data: unknown type.", item.getData());
-    return {};
+    return {
+      setRenderAttempted: false,
+      includeInNotification: false
+    };
   }
-
   return {
     render: () => modules[type](item.getData()),
     setRenderAttempted: true,

package/libEs6/components/Personalization/handlers/createProcessHtmlContent.js

@@ -17,16 +17,19 @@ export default (({
     type,
     selector
   } = item.getData() || {};
-
   if (!selector || !type) {
-    return {};
+    return {
+      setRenderAttempted: false,
+      includeInNotification: false
+    };
   }
-
   if (!modules[type]) {
     logger.warn("Invalid HTML content data", item.getData());
-    return {};
+    return {
+      setRenderAttempted: false,
+      includeInNotification: false
+    };
   }
-
   return {
     render: () => {
       modules[type](item.getData());

package/libEs6/components/Personalization/handlers/createProcessPropositions.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 (({
   schemaProcessors,
   logger
@@ -18,7 +19,6 @@ export default (({
       if (logger.enabled) {
         logger.info(`Action ${item.toString()} executed.`);
       }
-
       return true;
     }).catch(error => {
       if (logger.enabled) {
@@ -26,34 +26,27 @@ export default (({
           message,
           stack
         } = error;
-        const errorMessage = `Failed to execute action ${item.toString()}. ${message} ${stack}`;
-        logger.error(errorMessage);
+        const warning = `Failed to execute action ${item.toString()}. ${message} ${stack}`;
+        logger.warn(warning);
       }
-
       return false;
     });
   };
-
   const renderItems = (renderers, meta) => Promise.all(renderers.map(renderer => renderer())).then(successes => {
     // as long as at least one renderer succeeds, we want to add the notification
     // to the display notifications
     if (!successes.includes(true)) {
       return undefined;
     }
-
     return meta;
   });
-
   const processItem = item => {
     const processor = schemaProcessors[item.getSchema()];
-
     if (!processor) {
       return {};
     }
-
     return processor(item);
   };
-
   const processItems = ({
     renderers: existingRenderers,
     returnedPropositions: existingReturnedPropositions,
@@ -74,7 +67,6 @@ export default (({
     let onlyRenderThis = false;
     let i = 0;
     let item;
-
     while (items.length > i) {
       item = items[i];
       ({
@@ -83,11 +75,9 @@ export default (({
         includeInNotification,
         onlyRenderThis
       } = processItem(item));
-
       if (onlyRenderThis) {
         returnedPropositions = [];
         returnedDecisions = [];
-
         if (setRenderAttempted) {
           renderedItems = [item];
           nonRenderedItems = [];
@@ -95,45 +85,36 @@ export default (({
           renderedItems = [];
           nonRenderedItems = [item];
         }
-
         renderers = [];
         itemRenderers = [render];
         atLeastOneWithNotification = includeInNotification;
         break;
       }
-
       if (render) {
         itemRenderers.push(wrapRenderWithLogging(render, item));
       }
-
       if (includeInNotification) {
         atLeastOneWithNotification = true;
       }
-
       if (setRenderAttempted) {
         renderedItems.push(item);
       } else {
         nonRenderedItems.push(item);
       }
-
       i += 1;
     }
-
     if (itemRenderers.length > 0) {
       const meta = atLeastOneWithNotification ? proposition.getNotification() : undefined;
       renderers.push(() => renderItems(itemRenderers, meta));
     } else if (atLeastOneWithNotification) {
       renderers.push(() => proposition.getNotification());
     }
-
     if (renderedItems.length > 0) {
       proposition.addToReturnValues(returnedPropositions, returnedDecisions, renderedItems, true);
     }
-
     if (nonRenderedItems.length > 0) {
       proposition.addToReturnValues(returnedPropositions, returnedDecisions, nonRenderedItems, false);
     }
-
     return {
       renderers,
       returnedPropositions,
@@ -141,7 +122,6 @@ export default (({
       onlyRenderThis
     };
   };
-
   return (renderPropositions, nonRenderPropositions = []) => {
     let renderers = [];
     let returnedPropositions = [];
@@ -150,7 +130,6 @@ export default (({
     let i = 0;
     let proposition;
     let items;
-
     while (renderPropositions.length > i) {
       proposition = renderPropositions[i];
       items = proposition.getItems();
@@ -166,14 +145,11 @@ export default (({
         items,
         proposition
       }));
-
       if (onlyRenderThis) {
         break;
       }
-
       i += 1;
     }
-
     if (onlyRenderThis) {
       // if onlyRenderThis is true, that means returnedPropositions and returnedDecisions
       // only contains the proposition that triggered only rendering this. We need to
@@ -184,15 +160,12 @@ export default (({
         }
       });
     }
-
     nonRenderPropositions.forEach(p => {
       p.addToReturnValues(returnedPropositions, returnedDecisions, p.getItems(), false);
     });
-
     const render = () => {
       return Promise.all(renderers.map(renderer => renderer())).then(metas => metas.filter(meta => meta));
     };
-
     return {
       returnedPropositions,
       returnedDecisions,

package/libEs6/components/Personalization/handlers/createProcessRedirect.js

@@ -17,17 +17,20 @@ export default (({
   const {
     content
   } = item.getData() || {};
-
   if (!content) {
     logger.warn("Invalid Redirect data", item.getData());
     return {};
   }
-
   const render = () => {
     return collect({
-      decisionsMeta: [item.getMeta()]
+      decisionsMeta: [item.getProposition().getNotification()],
+      documentMayUnload: true
     }).then(() => {
-      executeRedirect(content); // We've already sent the display notification, so don't return anything
+      return executeRedirect(content);
+      // Execute redirect will never resolve. If there are bottom of page events that are waiting
+      // for display notifications from this request, they will never run because this promise will
+      // not resolve. This is intentional because we don't want to run bottom of page events if
+      // there is a redirect.
     });
   };
 

package/libEs6/components/Personalization/handlers/injectCreateProposition.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 PAGE_WIDE_SCOPE from "../../../constants/pageWideScope";
+import { VIEW_SCOPE_TYPE, PAGE_SCOPE_TYPE, PROPOSITION_SCOPE_TYPE } from "../constants/scopeType";
 export default (({
   preprocess,
   isPageWideSurface
 }) => {
-  const createItem = (item, meta) => {
+  const createItem = (item, proposition) => {
     const {
       schema,
       data,
@@ -23,39 +25,30 @@ export default (({
       } = {}
     } = item;
     const processedData = preprocess(data);
-
-    if (trackingLabel) {
-      meta.trackingLabel = trackingLabel;
-    }
-
     return {
       getSchema() {
         return schema;
       },
-
       getData() {
         return processedData;
       },
-
-      getMeta() {
-        return meta;
+      getProposition() {
+        return proposition;
+      },
+      getTrackingLabel() {
+        return trackingLabel;
       },
-
       getOriginalItem() {
         return item;
       },
-
       toString() {
         return JSON.stringify(item);
       },
-
       toJSON() {
         return item;
       }
-
     };
   };
-
   return (payload, visibleInReturnedItems = true) => {
     const {
       id,
@@ -73,30 +66,20 @@ export default (({
         if (!scope) {
           return scope;
         }
-
         return scope;
       },
-
       getScopeType() {
         if (scope === PAGE_WIDE_SCOPE || isPageWideSurface(scope)) {
-          return "page";
+          return PAGE_SCOPE_TYPE;
         }
-
-        if (scopeType === "view") {
-          return "view";
+        if (scopeType === VIEW_SCOPE_TYPE) {
+          return VIEW_SCOPE_TYPE;
         }
-
-        return "proposition";
+        return PROPOSITION_SCOPE_TYPE;
       },
-
       getItems() {
-        return items.map(item => createItem(item, {
-          id,
-          scope,
-          scopeDetails
-        }));
+        return items.map(item => createItem(item, this));
       },
-
       getNotification() {
         return {
           id,
@@ -104,26 +87,24 @@ export default (({
           scopeDetails
         };
       },
-
       toJSON() {
         return payload;
       },
-
       addToReturnValues(propositions, decisions, includedItems, renderAttempted) {
         if (visibleInReturnedItems) {
-          propositions.push({ ...payload,
+          propositions.push({
+            ...payload,
             items: includedItems.map(i => i.getOriginalItem()),
             renderAttempted
           });
-
           if (!renderAttempted) {
-            decisions.push({ ...payload,
+            decisions.push({
+              ...payload,
               items: includedItems.map(i => i.getOriginalItem())
             });
           }
         }
       }
-
     };
   };
 });

package/libEs6/components/Personalization/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 { string, boolean, objectOf } from "../../utils/validation";
 import createComponent from "./createComponent";
 import { initDomActionsModules } from "./dom-actions";
@@ -30,7 +31,6 @@ import remapHeadOffers from "./dom-actions/remapHeadOffers";
 import createPreprocess from "./dom-actions/createPreprocess";
 import injectCreateProposition from "./handlers/injectCreateProposition";
 import createAsyncArray from "./utils/createAsyncArray";
-import createPendingNotificationsHandler from "./createPendingNotificationsHandler";
 import * as schema from "./constants/schema";
 import processDefaultContent from "./handlers/processDefaultContent";
 import { isPageWideSurface } from "./utils/surfaceUtils";
@@ -38,7 +38,7 @@ import createProcessDomAction from "./handlers/createProcessDomAction";
 import createProcessHtmlContent from "./handlers/createProcessHtmlContent";
 import createProcessRedirect from "./handlers/createProcessRedirect";
 import createProcessPropositions from "./handlers/createProcessPropositions";
-
+import createRedirect from "./dom-actions/createRedirect";
 const createPersonalization = ({
   config,
   logger,
@@ -69,6 +69,7 @@ const createPersonalization = ({
   const viewCache = createViewCacheManager({
     createProposition
   });
+  const executeRedirect = createRedirect(window);
   const schemaProcessors = {
     [schema.DEFAULT_CONTENT_ITEM]: processDefaultContent,
     [schema.DOM_ACTION]: createProcessDomAction({
@@ -82,7 +83,7 @@ const createPersonalization = ({
     }),
     [schema.REDIRECT_ITEM]: createProcessRedirect({
       logger,
-      executeRedirect: url => window.location.replace(url),
+      executeRedirect,
       collect
     })
   };
@@ -90,11 +91,7 @@ const createPersonalization = ({
     schemaProcessors,
     logger
   });
-  const pendingDisplayNotifications = createAsyncArray();
-  const pendingNotificationsHandler = createPendingNotificationsHandler({
-    pendingDisplayNotifications,
-    mergeDecisionsMeta
-  });
+  const renderedPropositions = createAsyncArray();
   const fetchDataHandler = createFetchDataHandler({
     prehidingStyle,
     showContainers,
@@ -103,7 +100,7 @@ const createPersonalization = ({
     collect,
     processPropositions,
     createProposition,
-    pendingDisplayNotifications
+    renderedPropositions
   });
   const onClickHandler = createOnClickHandler({
     mergeDecisionsMeta,
@@ -112,14 +109,13 @@ const createPersonalization = ({
     getClickMetasBySelector
   });
   const viewChangeHandler = createViewChangeHandler({
-    mergeDecisionsMeta,
     processPropositions,
     viewCache
   });
   const applyPropositions = createApplyPropositions({
     processPropositions,
     createProposition,
-    pendingDisplayNotifications,
+    renderedPropositions,
     viewCache
   });
   const setTargetMigration = createSetTargetMigration({
@@ -137,10 +133,10 @@ const createPersonalization = ({
     showContainers,
     applyPropositions,
     setTargetMigration,
-    pendingNotificationsHandler
+    mergeDecisionsMeta,
+    renderedPropositions
   });
 };
-
 createPersonalization.namespace = "Personalization";
 createPersonalization.configValidators = objectOf({
   prehidingStyle: string().nonEmpty(),

package/libEs6/components/Personalization/utils/addRenderAttemptedToDecisions.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 { assign } from "../../../utils";
 export default (({
   decisions,

package/libEs6/components/Personalization/utils/createAsyncArray.js

@@ -21,7 +21,6 @@ export default (() => {
         });
       });
     },
-
     /**
      * Clears the saved propositions, waiting until the next propositions are resolved and available.
      *
@@ -32,6 +31,5 @@ export default (() => {
       latest = Promise.resolve([]);
       return oldLatest;
     }
-
   };
 });

package/libEs6/components/Personalization/utils/isAuthoringModeEnabled.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 ((doc = document) => {
   return doc.location.href.indexOf("adobe_authoring_enabled") !== -1;
 });

package/libEs6/components/Personalization/utils/surfaceUtils.js

@@ -9,29 +9,23 @@ 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 { WEB, WEBAPP, SURFACE_TYPE_DELIMITER, FRAGMENT_DELIMITER } from "../constants/surface";
 import { startsWith, isNil, isNonEmptyString, includes } from "../../../utils";
 const SURFACE_REGEX = /^(\w+):\/\/([^/#]+)(\/[^#]*)?(#.*)?$/;
 const AUTHORITY_REGEX = /^(?:.*@)?(?:[a-z\d\u00a1-\uffff.-]+|\[[a-f\d:]+])(?::\d+)?$/;
 const PATH_REGEX = /^\/(?:[/\w\u00a1-\uffff-.~]|%[a-fA-F\d]{2})*$/;
 const FRAGMENT_REGEX = /^#(?:[/\w\u00a1-\uffff-.~]|%[a-fA-F\d]{2})+$/;
-
 const normalizePath = (path = "/") => {
   let end = path.length;
-
   while (end > 0 && "/".indexOf(path.charAt(end - 1)) !== -1) {
     end -= 1;
   }
-
   return path.substring(0, end) || "/";
 };
-
 const getSurfaceType = surfaceTypeMatch => isNonEmptyString(surfaceTypeMatch) ? surfaceTypeMatch.toLowerCase() : "";
-
 const getAuthority = authorityMatch => isNonEmptyString(authorityMatch) ? authorityMatch.toLowerCase() : "";
-
 const getPath = pathMatch => isNonEmptyString(pathMatch) ? normalizePath(pathMatch) : "/";
-
 const parseSurface = surfaceString => {
   const matched = surfaceString.match(SURFACE_REGEX);
   return matched ? {
@@ -41,53 +35,40 @@ const parseSurface = surfaceString => {
     fragment: matched[4]
   } : null;
 };
-
 const stringifySurface = surface => `${surface.surfaceType}${SURFACE_TYPE_DELIMITER}${surface.authority}${surface.path || ""}${surface.fragment || ""}`;
-
 export const buildPageSurface = getPageLocation => {
   const location = getPageLocation();
   const host = location.host.toLowerCase();
   const path = location.pathname;
   return WEB + SURFACE_TYPE_DELIMITER + host + normalizePath(path);
 };
-
 const expandFragmentSurface = (surface, getPageLocation) => startsWith(surface, FRAGMENT_DELIMITER) ? buildPageSurface(getPageLocation) + surface : surface;
-
 const validateSurface = (surface, getPageLocation, logger) => {
   const invalidateSurface = validationError => {
     logger.warn(validationError);
     return null;
   };
-
   if (!isNonEmptyString(surface)) {
     return invalidateSurface(`Invalid surface: ${surface}`);
   }
-
   const expanded = expandFragmentSurface(surface, getPageLocation);
   const parsed = parseSurface(expanded);
-
   if (parsed === null) {
     return invalidateSurface(`Invalid surface: ${surface}`);
   }
-
   if (!includes([WEB, WEBAPP], parsed.surfaceType)) {
     return invalidateSurface(`Unsupported surface type ${parsed.surfaceType} in surface: ${surface}`);
   }
-
   if (!parsed.authority || !AUTHORITY_REGEX.test(parsed.authority)) {
     return invalidateSurface(`Invalid authority ${parsed.authority} in surface: ${surface}`);
   }
-
   if (parsed.path && !PATH_REGEX.test(parsed.path)) {
     return invalidateSurface(`Invalid path ${parsed.path} in surface: ${surface}`);
   }
-
   if (parsed.fragment && !FRAGMENT_REGEX.test(parsed.fragment)) {
     return invalidateSurface(`Invalid fragment ${parsed.fragment} in surface: ${surface}`);
   }
-
   return parsed;
 };
-
 export const isPageWideSurface = scope => !!scope && scope.indexOf(WEB + SURFACE_TYPE_DELIMITER) === 0 && scope.indexOf(FRAGMENT_DELIMITER) === -1;
 export const normalizeSurfaces = (surfaces = [], getPageLocation, logger) => surfaces.map(surface => validateSurface(surface, getPageLocation, logger)).filter(surface => !isNil(surface)).map(stringifySurface);

package/libEs6/components/Personalization/validateApplyPropositionsOptions.js

@@ -22,7 +22,6 @@ export default (({
     metadata: objectOf(anything()),
     viewName: string()
   }).required();
-
   try {
     return applyPropositionsOptionsValidator(options);
   } catch (e) {

package/libEs6/components/Privacy/computeConsentHash.js

@@ -9,23 +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 { crc32 } from "../../utils"; // serialize an object with a consistent ordering
 
+import { crc32 } from "../../utils";
+
+// serialize an object with a consistent ordering
 const serialize = obj => {
   if (Array.isArray(obj)) {
     return obj.map(i => serialize(i));
   }
-
   if (typeof obj === "object" && obj !== null) {
     return Object.keys(obj).sort().reduce((memo, key) => {
       memo[key] = serialize(obj[key]);
       return memo;
     }, {});
   }
-
   return obj;
 };
-
 export default (obj => {
   return crc32(JSON.stringify(serialize(obj)));
 });

package/libEs6/components/Privacy/createComponent.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 { GENERAL } from "../../constants/consentPurpose";
 export default (({
   storedConsent,
@@ -26,31 +27,26 @@ export default (({
   let storedConsentByPurpose = storedConsent.read();
   const identityCookieExists = doesIdentityCookieExist();
   const consentCookieExists = storedConsentByPurpose[GENERAL] !== undefined;
-
   if (!identityCookieExists || !consentCookieExists) {
     consentHashStore.clear();
-  } // If the identity cookie is gone, remove the consent cookie because the
+  }
+  // If the identity cookie is gone, remove the consent cookie because the
   // consent info is tied to the identity.
-
-
   if (!identityCookieExists) {
     storedConsent.clear();
     storedConsentByPurpose = {};
   }
-
   consent.initializeConsent(defaultConsentByPurpose, storedConsentByPurpose);
-
   const readCookieIfQueueEmpty = () => {
     if (taskQueue.length === 0) {
-      const storedConsentObject = storedConsent.read(); // Only read cookies when there are no outstanding setConsent
+      const storedConsentObject = storedConsent.read();
+      // Only read cookies when there are no outstanding setConsent
       // requests. This helps with race conditions.
-
       if (storedConsentObject[GENERAL] !== undefined) {
         consent.setConsent(storedConsentObject);
       }
     }
   };
-
   return {
     commands: {
       setConsent: {
@@ -70,7 +66,6 @@ export default (({
                 edgeConfigOverrides
               });
             }
-
             return Promise.resolve();
           }).then(() => consentHashes.save()).finally(readCookieIfQueueEmpty);
         }