@adobe/alloy 2.19.0-beta.1 → 2.19.0-beta.11

package/libEs6/components/Personalization/createFetchDataHandler.js

@@ -19,7 +19,7 @@ export default (({
   collect,
   processPropositions,
   createProposition,
-  pendingDisplayNotifications
+  renderedPropositions
 }) => {
   return ({
     cacheUpdate,
@@ -29,10 +29,12 @@ export default (({
   }) => {
     if (personalizationDetails.isRenderDecisions()) {
       hideContainers(prehidingStyle);
+    } else {
+      showContainers();
     }
     mergeQuery(event, personalizationDetails.createQueryDetails());
     let handleNotifications;
-    if (personalizationDetails.isSendDisplayNotifications()) {
+    if (personalizationDetails.isSendDisplayEvent()) {
       handleNotifications = decisionsMeta => {
         if (decisionsMeta.length > 0) {
           collect({
@@ -42,9 +44,9 @@ export default (({
         }
       };
     } else {
-      const displayNotificationsDeferred = defer();
-      pendingDisplayNotifications.concat(displayNotificationsDeferred.promise);
-      handleNotifications = displayNotificationsDeferred.resolve;
+      const renderedPropositionsDeferred = defer();
+      renderedPropositions.concat(renderedPropositionsDeferred.promise);
+      handleNotifications = renderedPropositionsDeferred.resolve;
     }
     onResponse(({
       response
@@ -66,13 +68,12 @@ export default (({
           returnedPropositions,
           returnedDecisions
         } = processPropositions([...pagePropositions, ...currentViewPropositions], nonRenderedPropositions));
-        render().then(decisionsMeta => {
-          showContainers();
-          handleNotifications(decisionsMeta);
-        }).catch(e => {
-          showContainers();
-          throw e;
-        });
+        render().then(handleNotifications);
+
+        // Render could take a long time especially if one of the renders
+        // is waiting for html to appear on the page. We show the containers
+        // immediately, and whatever renders quickly will not have flicker.
+        showContainers();
       } else {
         ({
           returnedPropositions,

package/libEs6/components/Personalization/createOnClickHandler.js

@@ -10,10 +10,9 @@ OF ANY KIND, either express or implied. See the License for the specific languag
 governing permissions and limitations under the License.
 */
 
-import { isNonEmptyArray, isNonEmptyString } from "../../utils";
+import { isNonEmptyArray } from "../../utils";
 import { INTERACT } from "./constants/eventType";
 import { PropositionEventType } from "./constants/propositionEventType";
-import PAGE_WIDE_SCOPE from "../../constants/pageWideScope";
 export default (({
   mergeDecisionsMeta,
   collectClicks,
@@ -29,17 +28,17 @@ export default (({
     if (isNonEmptyArray(selectors)) {
       const {
         decisionsMeta,
-        eventLabel
+        eventLabel,
+        viewName
       } = collectClicks(clickedElement, selectors, getClickMetasBySelector);
       if (isNonEmptyArray(decisionsMeta)) {
         const xdm = {
           eventType: INTERACT
         };
-        const scope = decisionsMeta[0].scope;
-        if (isNonEmptyString(scope) && scope !== PAGE_WIDE_SCOPE) {
+        if (viewName) {
           xdm.web = {
             webPageDetails: {
-              viewName: scope.toLowerCase()
+              viewName
             }
           };
         }

package/libEs6/components/Personalization/createPersonalizationDetails.js

@@ -40,11 +40,11 @@ export default (({
     isRenderDecisions() {
       return renderDecisions;
     },
-    isSendDisplayNotifications() {
-      return !!personalization.sendDisplayNotifications;
+    isSendDisplayEvent() {
+      return !!personalization.sendDisplayEvent;
     },
-    shouldAddPendingDisplayNotifications() {
-      return !!personalization.includePendingDisplayNotifications;
+    shouldIncludeRenderedPropositions() {
+      return !!personalization.includeRenderedPropositions;
     },
     getViewName() {
       return viewName;
@@ -64,7 +64,7 @@ export default (({
         scopes.push(...personalization.decisionScopes);
       }
       const eventSurfaces = normalizeSurfaces(personalization.surfaces, getPageLocation, logger);
-      if (!this.isCacheInitialized()) {
+      if (!this.isCacheInitialized() || personalization.requestPersonalization) {
         addPageWideScope(scopes);
         addPageSurface(eventSurfaces, getPageLocation);
       }
@@ -82,7 +82,7 @@ export default (({
       return isCacheInitialized;
     },
     shouldFetchData() {
-      return this.hasScopes() || this.hasSurfaces() || !this.isCacheInitialized();
+      return this.hasScopes() || this.hasSurfaces() || personalization.requestPersonalization || !this.isCacheInitialized() && personalization.requestPersonalization !== false;
     },
     shouldUseCachedData() {
       return this.hasViewName() && this.isCacheInitialized();

package/libEs6/components/Personalization/createViewCacheManager.js

@@ -10,17 +10,17 @@ OF ANY KIND, either express or implied. See the License for the specific languag
 governing permissions and limitations under the License.
 */
 
-import { assign, groupBy } from "../../utils";
+import { groupBy } from "../../utils";
 import defer from "../../utils/defer";
 import { DEFAULT_CONTENT_ITEM } from "./constants/schema";
+import { VIEW_SCOPE_TYPE } from "./constants/scopeType";
 export default (({
   createProposition
 }) => {
-  const viewStorage = {};
   let cacheUpdateCreatedAtLeastOnce = false;
-  let previousUpdateCacheComplete = Promise.resolve();
-  const getViewPropositions = (currentViewStorage, viewName) => {
-    const viewPropositions = currentViewStorage[viewName.toLowerCase()];
+  let viewStoragePromise = Promise.resolve({});
+  const getViewPropositions = (viewStorage, viewName) => {
+    const viewPropositions = viewStorage[viewName.toLowerCase()];
     if (viewPropositions && viewPropositions.length > 0) {
       return viewPropositions;
     }
@@ -28,7 +28,7 @@ export default (({
       scope: viewName,
       scopeDetails: {
         characteristics: {
-          scopeType: "view"
+          scopeType: VIEW_SCOPE_TYPE
         }
       },
       items: [{
@@ -42,9 +42,7 @@ export default (({
   const createCacheUpdate = viewName => {
     const updateCacheDeferred = defer();
     cacheUpdateCreatedAtLeastOnce = true;
-    previousUpdateCacheComplete = previousUpdateCacheComplete.then(() => updateCacheDeferred.promise).then(newViewStorage => {
-      assign(viewStorage, newViewStorage);
-    }).catch(() => {});
+    viewStoragePromise = viewStoragePromise.then(oldViewStorage => updateCacheDeferred.promise.catch(() => oldViewStorage));
     return {
       update(viewPropositions) {
         const viewPropositionsWithScope = viewPropositions.filter(proposition => proposition.getScope());
@@ -61,7 +59,7 @@ export default (({
     };
   };
   const getView = viewName => {
-    return previousUpdateCacheComplete.then(() => getViewPropositions(viewStorage, viewName));
+    return viewStoragePromise.then(viewStorage => getViewPropositions(viewStorage, viewName));
   };
   const isInitialized = () => {
     return cacheUpdateCreatedAtLeastOnce;

package/libEs6/components/Personalization/createViewChangeHandler.js

@@ -10,15 +10,12 @@ OF ANY KIND, either express or implied. See the License for the specific languag
 governing permissions and limitations under the License.
 */
 
-import { PropositionEventType } from "./constants/propositionEventType";
 export default (({
-  mergeDecisionsMeta,
   processPropositions,
   viewCache
 }) => {
   return ({
     personalizationDetails,
-    event,
     onResponse
   }) => {
     let returnedPropositions;
@@ -45,8 +42,6 @@ export default (({
         returnedDecisions
       } = processPropositions([], propositions));
       return [];
-    }).then(decisionsMeta => {
-      mergeDecisionsMeta(event, decisionsMeta, PropositionEventType.DISPLAY);
     });
   };
 });

package/libEs6/components/Personalization/dom-actions/clicks/collectClicks.js

@@ -11,6 +11,7 @@ governing permissions and limitations under the License.
 */
 
 import matchesSelectorWithEq from "../dom/matchesSelectorWithEq";
+import { VIEW_SCOPE_TYPE } from "../../constants/scopeType";
 const getMetasIfMatches = (clickedElement, selector, getClickMetasBySelector) => {
   const {
     documentElement
@@ -20,17 +21,20 @@ const getMetasIfMatches = (clickedElement, selector, getClickMetasBySelector) =>
   while (element && element !== documentElement) {
     if (matchesSelectorWithEq(selector, element)) {
       const matchedMetas = getClickMetasBySelector(selector);
+      const returnValue = {
+        metas: matchedMetas
+      };
       const foundMetaWithLabel = matchedMetas.find(meta => meta.trackingLabel);
       if (foundMetaWithLabel) {
-        return {
-          metas: matchedMetas,
-          label: foundMetaWithLabel.trackingLabel,
-          weight: i
-        };
+        returnValue.label = foundMetaWithLabel.trackingLabel;
+        returnValue.weight = i;
       }
-      return {
-        metas: matchedMetas
-      };
+      const foundMetaWithScopeTypeView = matchedMetas.find(meta => meta.scopeType === VIEW_SCOPE_TYPE);
+      if (foundMetaWithScopeTypeView) {
+        returnValue.viewName = foundMetaWithScopeTypeView.scope;
+        returnValue.weight = i;
+      }
+      return returnValue;
     }
     element = element.parentNode;
     i += 1;
@@ -40,8 +44,12 @@ const getMetasIfMatches = (clickedElement, selector, getClickMetasBySelector) =>
   };
 };
 const cleanMetas = metas => metas.map(meta => {
-  delete meta.trackingLabel;
-  return meta;
+  const {
+    trackingLabel,
+    scopeType,
+    ...rest
+  } = meta;
+  return rest;
 });
 const dedupMetas = metas => metas.filter((meta, index) => {
   const stringifiedMeta = JSON.stringify(meta);
@@ -51,13 +59,16 @@ export default ((clickedElement, selectors, getClickMetasBySelector) => {
   const result = [];
   let resultLabel = "";
   let resultLabelWeight = Number.MAX_SAFE_INTEGER;
+  let resultViewName;
+  let resultViewNameWeight = Number.MAX_SAFE_INTEGER;
 
   /* eslint-disable no-continue */
   for (let i = 0; i < selectors.length; i += 1) {
     const {
       metas,
       label,
-      weight
+      weight,
+      viewName
     } = getMetasIfMatches(clickedElement, selectors[i], getClickMetasBySelector);
     if (!metas) {
       continue;
@@ -66,10 +77,15 @@ export default ((clickedElement, selectors, getClickMetasBySelector) => {
       resultLabel = label;
       resultLabelWeight = weight;
     }
+    if (viewName && weight <= resultViewNameWeight) {
+      resultViewName = viewName;
+      resultViewNameWeight = weight;
+    }
     result.push(...cleanMetas(metas));
   }
   return {
     decisionsMeta: dedupMetas(result),
-    eventLabel: resultLabel
+    eventLabel: resultLabel,
+    viewName: resultViewName
   };
 });

package/libEs6/components/Personalization/{utils/isPageWideScope.js → dom-actions/createRedirect.js}

@@ -1,5 +1,5 @@
 /*
-Copyright 2022 Adobe. All rights reserved.
+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
@@ -10,6 +10,9 @@ OF ANY KIND, either express or implied. See the License for the specific languag
 governing permissions and limitations under the License.
 */
 
-import { isPageWideSurface } from "./surfaceUtils";
-import PAGE_WIDE_SCOPE from "../../../constants/pageWideScope";
-export default (scope => scope === PAGE_WIDE_SCOPE || isPageWideSurface(scope));
+export default (window => url => {
+  window.location.replace(url);
+  // Return a promise that never resolves because redirects never complete
+  // within the current page.
+  return new Promise(() => undefined);
+});

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

@@ -20,16 +20,26 @@ export default (({
   } = 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,
@@ -38,7 +48,10 @@ export default (({
   }
   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()),

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

@@ -18,11 +18,17 @@ export default (({
     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: () => {

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

@@ -26,8 +26,8 @@ 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;
     });

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

@@ -23,10 +23,14 @@ export default (({
   }
   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

@@ -11,11 +11,12 @@ 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,
@@ -24,9 +25,6 @@ export default (({
       } = {}
     } = item;
     const processedData = preprocess(data);
-    if (trackingLabel) {
-      meta.trackingLabel = trackingLabel;
-    }
     return {
       getSchema() {
         return schema;
@@ -34,8 +32,11 @@ export default (({
       getData() {
         return processedData;
       },
-      getMeta() {
-        return meta;
+      getProposition() {
+        return proposition;
+      },
+      getTrackingLabel() {
+        return trackingLabel;
       },
       getOriginalItem() {
         return item;
@@ -69,19 +70,15 @@ export default (({
       },
       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 {

package/libEs6/components/Personalization/index.js

@@ -31,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";
@@ -39,6 +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,7 +133,8 @@ const createPersonalization = ({
     showContainers,
     applyPropositions,
     setTargetMigration,
-    pendingNotificationsHandler
+    mergeDecisionsMeta,
+    renderedPropositions
   });
 };
 createPersonalization.namespace = "Personalization";

package/libEs6/constants/libraryVersion.js

@@ -13,4 +13,4 @@ governing permissions and limitations under the License.
 // The __VERSION__ keyword will be replace at alloy build time with the package.json version.
 // see babel-plugin-version
 
-export default "2.19.0-beta.1";
+export default "2.19.0-beta.11";

package/libEs6/core/createEvent.js

@@ -120,7 +120,7 @@ export default (() => {
       return shouldSendEvent;
     },
     getViewName() {
-      if (!userXdm || !userXdm.web || !userXdm.web.webPageDetails || !userXdm.web.webPageDetails.viewName) {
+      if (!userXdm || !userXdm.web || !userXdm.web.webPageDetails) {
         return undefined;
       }
       return userXdm.web.webPageDetails.viewName;

package/libEs6/core/createEventManager.js

@@ -32,19 +32,13 @@ export default (({
   return {
     createEvent,
     /**
-     * Sends an event. This includes running the event and payload through
-     * the appropriate lifecycle hooks, sending the request to the server,
-     * and handling the response.
-     * @param {Object} event This will be JSON stringified and used inside
-     * the request payload.
-     * @param {Object} [options]
-     * @param {boolean} [options.renderDecisions=false]
-     * @param {Array} [options.decisionScopes] Note: this option will soon
-     * be deprecated, please use *personalization.decisionScopes* instead
-     * @param {Object} [options.personalization]
-     * @param {Object} [options.serverState]
-     * This will be passed to components
-     * so they can take appropriate action.
+     * Sends an event. This includes running the event and payload through the
+     * appropriate lifecycle hooks, sending the request to the server, and
+     * handling the response.
+     * @param {Object} event This will be JSON stringified and used inside the
+     * request payload.
+     * @param {Object} [options] Options to pass on to the onBeforeEvent
+     * lifecycle method
      * @param {Object} [options.edgeConfigOverrides] Settings that take
      * precedence over the global datastream configuration, including which
      * datastream to use.
@@ -52,10 +46,8 @@ export default (({
      */
     sendEvent(event, options = {}) {
       const {
-        renderDecisions = false,
-        decisionScopes,
         edgeConfigOverrides: localConfigOverrides,
-        personalization
+        ...otherOptions
       } = options;
       const requestParams = createRequestParams({
         payload: createDataCollectionRequestPayload(),
@@ -66,10 +58,8 @@ export default (({
       const onResponseCallbackAggregator = createCallbackAggregator();
       const onRequestFailureCallbackAggregator = createCallbackAggregator();
       return lifecycle.onBeforeEvent({
+        ...otherOptions,
         event,
-        renderDecisions,
-        decisionScopes,
-        personalization,
         onResponse: onResponseCallbackAggregator.add,
         onRequestFailure: onRequestFailureCallbackAggregator.add
       }).then(() => {

package/libEs6/utils/dom/selectNodesWithShadow.js

@@ -17,7 +17,7 @@ const splitWithShadow = selector => {
   return selector.split(SHADOW_SEPARATOR);
 };
 const transformPrefix = (parent, selector) => {
-  const result = selector.trim();
+  const result = selector;
   const hasChildCombinatorPrefix = startsWith(result, ">");
   if (!hasChildCombinatorPrefix) {
     return result;
@@ -45,8 +45,15 @@ export default ((context, selector) => {
   // find each subselector element based on the previously selected node's shadowRoot
   let parent = context;
   for (let i = 0; i < parts.length; i += 1) {
-    const part = transformPrefix(parent, parts[i]);
-    const partNode = querySelectorAll(parent, part);
+    const part = parts[i].trim();
+    // if part is empty, it means there's a chained :eq:shadow selector
+    if (part === "" && parent.shadowRoot) {
+      parent = parent.shadowRoot;
+      // eslint-disable-next-line no-continue
+      continue;
+    }
+    const prefixed = transformPrefix(parent, part);
+    const partNode = querySelectorAll(parent, prefixed);
     if (partNode.length === 0 || !partNode[0] || !partNode[0].shadowRoot) {
       return partNode;
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/alloy",
-  "version": "2.19.0-beta.1",
+  "version": "2.19.0-beta.11",
   "description": "Adobe Experience Platform Web SDK",
   "main": "libEs5/index.js",
   "module": "libEs6/index.js",
@@ -66,7 +66,7 @@
     "uuid": "^3.3.2"
   },
   "devDependencies": {
-    "@adobe/alloy": "^2.19.0-beta.0",
+    "@adobe/alloy": "^2.19.0-beta.10",
     "@babel/cli": "^7.12.8",
     "@babel/core": "^7.2.2",
     "@babel/plugin-proposal-object-rest-spread": "^7.3.2",
@@ -84,7 +84,7 @@
     "eslint-config-airbnb-base": "^14.0.0",
     "eslint-config-prettier": "^6.4.0",
     "eslint-plugin-ban": "^1.5.2",
-    "eslint-plugin-import": "^2.16.0",
+    "eslint-plugin-import": "^2.28.1",
     "eslint-plugin-prettier": "^3.0.1",
     "eslint-plugin-testcafe": "^0.2.1",
     "glob": "^7.1.3",