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

package/libEs5/components/Personalization/createApplyPropositions.js

@@ -84,6 +84,10 @@ var _default = function _default(_ref) {
       _ref4$metadata = _ref4.metadata,
       metadata = _ref4$metadata === void 0 ? {} : _ref4$metadata,
       viewName = _ref4.viewName;
+    // We need to immediately call concat so that subsequent sendEvent
+    // calls will wait for applyPropositions to complete before executing.
+    var displayNotificationsDeferred = (0, _utils.defer)();
+    pendingDisplayNotifications.concat(displayNotificationsDeferred.promise);
     var propositionsToExecute = preparePropositions({
       propositions: propositions,
       metadata: metadata
@@ -99,7 +103,7 @@ var _default = function _default(_ref) {
       var _processPropositions = processPropositions([].concat(_toConsumableArray(propositionsToExecute), _toConsumableArray(additionalPropositions))),
         render = _processPropositions.render,
         returnedPropositions = _processPropositions.returnedPropositions;
-      pendingDisplayNotifications.concat(render());
+      render().then(displayNotificationsDeferred.resolve);
       return {
         propositions: returnedPropositions
       };

package/libEs5/components/Personalization/createComponent.js

@@ -5,6 +5,7 @@ var _utils = require("../../utils");
 var _createPersonalizationDetails = require("./createPersonalizationDetails");
 var _loggerMessage = require("./constants/loggerMessage");
 var _validateApplyPropositionsOptions = require("./validateApplyPropositionsOptions");
+var _propositionEventType = require("./constants/propositionEventType");
 /*
 Copyright 2020 Adobe. All rights reserved.
 This file is licensed to you under the Apache License, Version 2.0 (the "License");
@@ -28,7 +29,8 @@ var _default = function _default(_ref) {
     showContainers = _ref.showContainers,
     applyPropositions = _ref.applyPropositions,
     setTargetMigration = _ref.setTargetMigration,
-    pendingNotificationsHandler = _ref.pendingNotificationsHandler;
+    mergeDecisionsMeta = _ref.mergeDecisionsMeta,
+    pendingDisplayNotifications = _ref.pendingDisplayNotifications;
   return {
     lifecycle: {
       onBeforeRequest: function onBeforeRequest(_ref2) {
@@ -74,11 +76,9 @@ var _default = function _default(_ref) {
           isCacheInitialized: viewCache.isInitialized(),
           logger: logger
         });
-        var handlerPromises = [];
+        var decisionsMetaPromises = [];
         if (personalizationDetails.shouldAddPendingDisplayNotifications()) {
-          handlerPromises.push(pendingNotificationsHandler({
-            event: event
-          }));
+          decisionsMetaPromises.push(pendingDisplayNotifications.clear());
         }
         if (personalizationDetails.shouldFetchData()) {
           var cacheUpdate = viewCache.createCacheUpdate(personalizationDetails.getViewName());
@@ -93,16 +93,24 @@ var _default = function _default(_ref) {
           });
         } else if (personalizationDetails.shouldUseCachedData()) {
           // eslint-disable-next-line consistent-return
-          handlerPromises.push(viewChangeHandler({
+          decisionsMetaPromises.push(viewChangeHandler({
             personalizationDetails: personalizationDetails,
             event: event,
             onResponse: onResponse,
             onRequestFailure: onRequestFailure
           }));
         }
-        // We can wait for personalization to be applied and for
-        // the fetch data request to complete in parallel.
-        return Promise.all(handlerPromises);
+
+        // This promise.all waits for both the pending display notifications to be resolved
+        // (i.e. the top of page call to finish rendering) and the view change handler to
+        // finish rendering anything for this view.
+        return Promise.all(decisionsMetaPromises).then(function (decisionsMetas) {
+          // We only want to call mergeDecisionsMeta once, but we can get the propositions
+          // from two places: the pending display notifications and the view change handler.
+          mergeDecisionsMeta(event, (0, _utils.flatMap)(decisionsMetas, function (dms) {
+            return dms;
+          }), _propositionEventType.PropositionEventType.DISPLAY);
+        });
       },
       onClick: function onClick(_ref4) {
         var event = _ref4.event,

package/libEs5/components/Personalization/createFetchDataHandler.js

@@ -76,13 +76,12 @@ var _default = function _default(_ref) {
         render = _processPropositions.render;
         returnedPropositions = _processPropositions.returnedPropositions;
         returnedDecisions = _processPropositions.returnedDecisions;
-        render().then(function (decisionsMeta) {
-          showContainers();
-          handleNotifications(decisionsMeta);
-        }).catch(function (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 {
         var _processPropositions2 = processPropositions([], [].concat(_toConsumableArray(pagePropositions), _toConsumableArray(currentViewPropositions), _toConsumableArray(nonRenderedPropositions)));
         returnedPropositions = _processPropositions2.returnedPropositions;

package/libEs5/components/Personalization/createViewChangeHandler.js

@@ -1,7 +1,6 @@
 "use strict";
 
 exports.default = void 0;
-var _propositionEventType = require("./constants/propositionEventType");
 /*
 Copyright 2020 Adobe. All rights reserved.
 This file is licensed to you under the Apache License, Version 2.0 (the "License");
@@ -14,12 +13,10 @@ OF ANY KIND, either express or implied. See the License for the specific languag
 governing permissions and limitations under the License.
 */
 var _default = function _default(_ref) {
-  var mergeDecisionsMeta = _ref.mergeDecisionsMeta,
-    processPropositions = _ref.processPropositions,
+  var processPropositions = _ref.processPropositions,
     viewCache = _ref.viewCache;
   return function (_ref2) {
     var personalizationDetails = _ref2.personalizationDetails,
-      event = _ref2.event,
       onResponse = _ref2.onResponse;
     var returnedPropositions;
     var returnedDecisions;
@@ -43,8 +40,6 @@ var _default = function _default(_ref) {
       returnedPropositions = _processPropositions2.returnedPropositions;
       returnedDecisions = _processPropositions2.returnedDecisions;
       return [];
-    }).then(function (decisionsMeta) {
-      mergeDecisionsMeta(event, decisionsMeta, _propositionEventType.PropositionEventType.DISPLAY);
     });
   };
 };

package/libEs5/components/Personalization/event.js

@@ -21,6 +21,11 @@ var EVENT_TYPE_TRUE = 1;
 /* eslint-disable no-underscore-dangle */
 var mergeDecisionsMeta = function mergeDecisionsMeta(event, decisionsMeta, eventType) {
   var eventLabel = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : "";
+  // Do not send a display notification with no decisions. Even empty view changes
+  // should include a proposition.
+  if (decisionsMeta.length === 0) {
+    return;
+  }
   var xdm = {
     _experience: {
       decisioning: {

package/libEs5/components/Personalization/index.js

@@ -22,7 +22,6 @@ var _remapHeadOffers = require("./dom-actions/remapHeadOffers");
 var _createPreprocess = require("./dom-actions/createPreprocess");
 var _injectCreateProposition = require("./handlers/injectCreateProposition");
 var _createAsyncArray = require("./utils/createAsyncArray");
-var _createPendingNotificationsHandler = require("./createPendingNotificationsHandler");
 var schema = require("./constants/schema");
 var _processDefaultContent = require("./handlers/processDefaultContent");
 var _surfaceUtils = require("./utils/surfaceUtils");
@@ -87,10 +86,6 @@ var createPersonalization = function createPersonalization(_ref) {
     logger: logger
   });
   var pendingDisplayNotifications = (0, _createAsyncArray.default)();
-  var pendingNotificationsHandler = (0, _createPendingNotificationsHandler.default)({
-    pendingDisplayNotifications: pendingDisplayNotifications,
-    mergeDecisionsMeta: _event.mergeDecisionsMeta
-  });
   var fetchDataHandler = (0, _createFetchDataHandler.default)({
     prehidingStyle: prehidingStyle,
     showContainers: _flicker.showContainers,
@@ -108,7 +103,6 @@ var createPersonalization = function createPersonalization(_ref) {
     getClickMetasBySelector: getClickMetasBySelector
   });
   var viewChangeHandler = (0, _createViewChangeHandler.default)({
-    mergeDecisionsMeta: _event.mergeDecisionsMeta,
     processPropositions: processPropositions,
     viewCache: viewCache
   });
@@ -133,7 +127,8 @@ var createPersonalization = function createPersonalization(_ref) {
     showContainers: _flicker.showContainers,
     applyPropositions: applyPropositions,
     setTargetMigration: setTargetMigration,
-    pendingNotificationsHandler: pendingNotificationsHandler
+    mergeDecisionsMeta: _event.mergeDecisionsMeta,
+    pendingDisplayNotifications: pendingDisplayNotifications
   });
 };
 createPersonalization.namespace = "Personalization";

package/libEs5/constants/libraryVersion.js

@@ -14,5 +14,5 @@ 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
-var _default = "2.19.0-beta.1";
+var _default = "2.19.0-beta.3";
 exports.default = _default;

package/libEs6/components/Personalization/createApplyPropositions.js

@@ -10,7 +10,7 @@ OF ANY KIND, either express or implied. See the License for the specific languag
 governing permissions and limitations under the License.
 */
 
-import { isNonEmptyArray, isObject } from "../../utils";
+import { isNonEmptyArray, isObject, defer } from "../../utils";
 import { DOM_ACTION, HTML_CONTENT_ITEM } from "./constants/schema";
 import PAGE_WIDE_SCOPE from "../../constants/pageWideScope";
 const SUPPORTED_SCHEMAS = [DOM_ACTION, HTML_CONTENT_ITEM];
@@ -76,6 +76,10 @@ export default (({
     metadata = {},
     viewName
   }) => {
+    // We need to immediately call concat so that subsequent sendEvent
+    // calls will wait for applyPropositions to complete before executing.
+    const displayNotificationsDeferred = defer();
+    pendingDisplayNotifications.concat(displayNotificationsDeferred.promise);
     const propositionsToExecute = preparePropositions({
       propositions,
       metadata
@@ -90,7 +94,7 @@ export default (({
         render,
         returnedPropositions
       } = processPropositions([...propositionsToExecute, ...additionalPropositions]);
-      pendingDisplayNotifications.concat(render());
+      render().then(displayNotificationsDeferred.resolve);
       return {
         propositions: returnedPropositions
       };

package/libEs6/components/Personalization/createComponent.js

@@ -10,10 +10,11 @@ OF ANY KIND, either express or implied. See the License for the specific languag
 governing permissions and limitations under the License.
 */
 
-import { noop } from "../../utils";
+import { noop, flatMap } from "../../utils";
 import createPersonalizationDetails from "./createPersonalizationDetails";
 import { AUTHORING_ENABLED } from "./constants/loggerMessage";
 import validateApplyPropositionsOptions from "./validateApplyPropositionsOptions";
+import { PropositionEventType } from "./constants/propositionEventType";
 export default (({
   getPageLocation,
   logger,
@@ -26,7 +27,8 @@ export default (({
   showContainers,
   applyPropositions,
   setTargetMigration,
-  pendingNotificationsHandler
+  mergeDecisionsMeta,
+  pendingDisplayNotifications
 }) => {
   return {
     lifecycle: {
@@ -67,11 +69,9 @@ export default (({
           isCacheInitialized: viewCache.isInitialized(),
           logger
         });
-        const handlerPromises = [];
+        const decisionsMetaPromises = [];
         if (personalizationDetails.shouldAddPendingDisplayNotifications()) {
-          handlerPromises.push(pendingNotificationsHandler({
-            event
-          }));
+          decisionsMetaPromises.push(pendingDisplayNotifications.clear());
         }
         if (personalizationDetails.shouldFetchData()) {
           const cacheUpdate = viewCache.createCacheUpdate(personalizationDetails.getViewName());
@@ -84,16 +84,22 @@ export default (({
           });
         } else if (personalizationDetails.shouldUseCachedData()) {
           // eslint-disable-next-line consistent-return
-          handlerPromises.push(viewChangeHandler({
+          decisionsMetaPromises.push(viewChangeHandler({
             personalizationDetails,
             event,
             onResponse,
             onRequestFailure
           }));
         }
-        // We can wait for personalization to be applied and for
-        // the fetch data request to complete in parallel.
-        return Promise.all(handlerPromises);
+
+        // This promise.all waits for both the pending display notifications to be resolved
+        // (i.e. the top of page call to finish rendering) and the view change handler to
+        // finish rendering anything for this view.
+        return Promise.all(decisionsMetaPromises).then(decisionsMetas => {
+          // We only want to call mergeDecisionsMeta once, but we can get the propositions
+          // from two places: the pending display notifications and the view change handler.
+          mergeDecisionsMeta(event, flatMap(decisionsMetas, dms => dms), PropositionEventType.DISPLAY);
+        });
       },
       onClick({
         event,

package/libEs6/components/Personalization/createFetchDataHandler.js

@@ -66,13 +66,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/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/event.js

@@ -14,6 +14,11 @@ const EVENT_TYPE_TRUE = 1;
 
 /* eslint-disable no-underscore-dangle */
 export const mergeDecisionsMeta = (event, decisionsMeta, eventType, eventLabel = "") => {
+  // Do not send a display notification with no decisions. Even empty view changes
+  // should include a proposition.
+  if (decisionsMeta.length === 0) {
+    return;
+  }
   const xdm = {
     _experience: {
       decisioning: {

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";
@@ -91,10 +90,6 @@ const createPersonalization = ({
     logger
   });
   const pendingDisplayNotifications = createAsyncArray();
-  const pendingNotificationsHandler = createPendingNotificationsHandler({
-    pendingDisplayNotifications,
-    mergeDecisionsMeta
-  });
   const fetchDataHandler = createFetchDataHandler({
     prehidingStyle,
     showContainers,
@@ -112,7 +107,6 @@ const createPersonalization = ({
     getClickMetasBySelector
   });
   const viewChangeHandler = createViewChangeHandler({
-    mergeDecisionsMeta,
     processPropositions,
     viewCache
   });
@@ -137,7 +131,8 @@ const createPersonalization = ({
     showContainers,
     applyPropositions,
     setTargetMigration,
-    pendingNotificationsHandler
+    mergeDecisionsMeta,
+    pendingDisplayNotifications
   });
 };
 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.3";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/alloy",
-  "version": "2.19.0-beta.1",
+  "version": "2.19.0-beta.3",
   "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.2",
     "@babel/cli": "^7.12.8",
     "@babel/core": "^7.2.2",
     "@babel/plugin-proposal-object-rest-spread": "^7.3.2",

package/libEs5/components/Personalization/createPendingNotificationsHandler.js

@@ -1,26 +0,0 @@
-"use strict";
-
-exports.default = void 0;
-var _propositionEventType = require("./constants/propositionEventType");
-/*
-Copyright 2023 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.
-*/
-var _default = function _default(_ref) {
-  var pendingDisplayNotifications = _ref.pendingDisplayNotifications,
-    mergeDecisionsMeta = _ref.mergeDecisionsMeta;
-  return function (_ref2) {
-    var event = _ref2.event;
-    return pendingDisplayNotifications.clear().then(function (decisionsMeta) {
-      mergeDecisionsMeta(event, decisionsMeta, _propositionEventType.PropositionEventType.DISPLAY);
-    });
-  };
-};
-exports.default = _default;

package/libEs6/components/Personalization/createPendingNotificationsHandler.js

@@ -1,22 +0,0 @@
-/*
-Copyright 2023 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 { PropositionEventType } from "./constants/propositionEventType";
-export default (({
-  pendingDisplayNotifications,
-  mergeDecisionsMeta
-}) => ({
-  event
-}) => {
-  return pendingDisplayNotifications.clear().then(decisionsMeta => {
-    mergeDecisionsMeta(event, decisionsMeta, PropositionEventType.DISPLAY);
-  });
-});