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

package/libEs6/components/Identity/injectAwaitIdentityCookie.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 (({
   doesIdentityCookieExist,
   orgId
@@ -29,13 +30,15 @@ export default (({
         } else {
           // This logic assumes that the code setting the cookie is working as expected and that
           // the cookie was missing from the response.
-          const noIdentityCookieError = new Error(`An identity was not set properly. Please verify that the org ID ${orgId} configured in Alloy matches the org ID specified in the edge configuration.`); // Rejecting the promise will reject commands that were queued
+          const noIdentityCookieError = new Error(`An identity was not set properly. Please verify that the org ID ${orgId} configured in Alloy matches the org ID specified in the edge configuration.`);
+
+          // Rejecting the promise will reject commands that were queued
           // by the Identity component while waiting on the response to
           // the initial request.
+          reject(noIdentityCookieError);
 
-          reject(noIdentityCookieError); // Throwing an error will reject the event command that initiated
+          // Throwing an error will reject the event command that initiated
           // the request.
-
           throw noIdentityCookieError;
         }
       });

package/libEs6/components/Identity/injectEnsureSingleIdentity.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.
 */
+
 // TO-DOCUMENT: We queue subsequent requests until we have an identity cookie.
 export default (({
   doesIdentityCookieExist,
@@ -18,11 +19,11 @@ export default (({
   logger
 }) => {
   let obtainedIdentityPromise;
-
   const allowRequestToGoWithoutIdentity = request => {
     setDomainForInitialIdentityPayload(request);
     return addLegacyEcidToPayload(request.getPayload());
   };
+
   /**
    * Ensures that if no identity cookie exists, we only let one request at a
    * time without an identity until its response returns. In the meantime,
@@ -42,8 +43,6 @@ export default (({
    * an identity is to prevent a single malformed request causing all other
    * requests to never send.
    */
-
-
   return ({
     request,
     onResponse,
@@ -53,7 +52,6 @@ export default (({
       request.setIsIdentityEstablished();
       return Promise.resolve();
     }
-
     if (obtainedIdentityPromise) {
       // We don't have an identity cookie, but at least one request has
       // been sent to get it. Konductor may set the identity cookie in the
@@ -61,32 +59,35 @@ export default (({
       // requiring identity returns and awaitIdentityCookie confirms the
       // identity was set.
       logger.info("Delaying request while retrieving ECID from server.");
-      const previousObtainedIdentityPromise = obtainedIdentityPromise; // This promise resolves when we have an identity cookie. Additional
+      const previousObtainedIdentityPromise = obtainedIdentityPromise;
+
+      // This promise resolves when we have an identity cookie. Additional
       // requests are chained together so that only one is sent at a time
       // until we have the identity cookie.
-
       obtainedIdentityPromise = previousObtainedIdentityPromise.catch(() => {
         return awaitIdentityCookie({
           onResponse,
           onRequestFailure
         });
-      }); // When this returned promise resolves, the request will go out.
+      });
 
+      // When this returned promise resolves, the request will go out.
       return previousObtainedIdentityPromise.then(() => {
         logger.info("Resuming previously delayed request.");
         request.setIsIdentityEstablished();
-      }) // If Konductor did not set the identity cookie on the previous
+      })
+      // If Konductor did not set the identity cookie on the previous
       // request, then awaitIdentityCookie will reject its promise.
       // Catch the rejection here and allow this request to go out.
       .catch(() => {
         return allowRequestToGoWithoutIdentity(request);
       });
-    } // For Alloy+Konductor communication to be as robust as possible and
+    }
+
+    // For Alloy+Konductor communication to be as robust as possible and
     // to ensure we don't mint new ECIDs for requests that would otherwise
     // be sent in parallel, we'll let this request go out to fetch the
     // cookie
-
-
     obtainedIdentityPromise = awaitIdentityCookie({
       onResponse,
       onRequestFailure

package/libEs6/components/Identity/injectHandleResponseForIdSyncs.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 (({
   processIdSyncs
 }) => {

package/libEs6/components/Identity/injectProcessIdSyncs.js

@@ -10,21 +10,17 @@ 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";
-
 const createResultLogMessage = (idSync, success) => {
   return `ID sync ${success ? "succeeded" : "failed"}: ${idSync.spec.url}`;
 };
-
 export default (({
   fireReferrerHideableImage,
   logger
 }) => idSyncs => {
   const urlIdSyncs = idSyncs.filter(idSync => idSync.type === "url");
-
   if (!urlIdSyncs.length) {
     return Promise.resolve();
   }
-
   return Promise.all(urlIdSyncs.map(idSync => {
     return fireReferrerHideableImage(idSync.spec).then(() => {
       logger.info(createResultLogMessage(idSync, true));

package/libEs6/components/Identity/injectSetDomainForInitialIdentityPayload.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 getBrowser from "../../utils/getBrowser";
 export default (({
   thirdPartyCookiesEnabled,

package/libEs6/components/Identity/visitorService/awaitVisitorOptIn.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 { isObject } from "../../../utils";
 export default (({
   logger

package/libEs6/components/Identity/visitorService/getVisitor.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 } from "../../../utils";
 export default (window => {
   const Visitor = window.Visitor;

package/libEs6/components/Identity/visitorService/injectGetEcidFromVisitor.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 getVisitor from "./getVisitor";
 export default (({
   logger,
@@ -17,7 +18,6 @@ export default (({
 }) => {
   return () => {
     const Visitor = getVisitor(window);
-
     if (Visitor) {
       // Need to explicitly wait for optIn because visitor will call callback
       // with invalid values prior to optIn being approved
@@ -43,7 +43,6 @@ export default (({
         }
       });
     }
-
     return Promise.resolve();
   };
 });

package/libEs6/components/LibraryInfo/index.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 libraryVersion from "../../constants/libraryVersion";
 import { CONFIGURE, SET_DEBUG } from "../../constants/coreCommands";
-
 const prepareLibraryInfo = ({
   config,
   componentRegistry
 }) => {
   const allCommands = [...componentRegistry.getCommandNames(), CONFIGURE, SET_DEBUG].sort();
-  const resultConfig = { ...config
+  const resultConfig = {
+    ...config
   };
   Object.keys(config).forEach(key => {
     const value = config[key];
-
     if (typeof value !== "function") {
       return;
     }
-
     resultConfig[key] = value.toString();
   });
   return {
@@ -34,7 +33,6 @@ const prepareLibraryInfo = ({
     commands: allCommands
   };
 };
-
 const createLibraryInfo = ({
   config,
   componentRegistry
@@ -55,6 +53,5 @@ const createLibraryInfo = ({
     }
   };
 };
-
 createLibraryInfo.namespace = "LibraryInfo";
 export default createLibraryInfo;

package/libEs6/components/MachineLearning/index.js

@@ -9,8 +9,8 @@ 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 processResponse from "./processResponse";
 
+import processResponse from "./processResponse";
 const createMachineLearning = () => {
   return {
     lifecycle: {
@@ -19,6 +19,5 @@ const createMachineLearning = () => {
     commands: {}
   };
 };
-
 createMachineLearning.namespace = "MachineLearning";
 export default createMachineLearning;

package/libEs6/components/MachineLearning/processResponse.js

@@ -8,6 +8,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 (({
   response
 }) => {

package/libEs6/components/Personalization/constants/eventType.js

@@ -9,5 +9,6 @@ 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 const DISPLAY = "decisioning.propositionDisplay";
 export const INTERACT = "decisioning.propositionInteract";

package/libEs6/components/Personalization/constants/propositionEventType.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 const PropositionEventType = {
   DISPLAY: "display",
   INTERACT: "interact"

package/libEs6/components/Personalization/constants/schema.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 const DEFAULT_CONTENT_ITEM = "https://ns.adobe.com/personalization/default-content-item";
 export const DOM_ACTION = "https://ns.adobe.com/personalization/dom-action";
 export const HTML_CONTENT_ITEM = "https://ns.adobe.com/personalization/html-content-item";

package/libEs6/components/Personalization/constants/scopeType.js

@@ -9,4 +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 const VIEW_SCOPE_TYPE = "view";
+
+export const VIEW_SCOPE_TYPE = "view";
+export const PAGE_SCOPE_TYPE = "page";
+export const PROPOSITION_SCOPE_TYPE = "proposition";

package/libEs6/components/Personalization/constants/surface.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 const WEB = "web";
 export const WEBAPP = "webapp";
 export const SURFACE_TYPE_DELIMITER = "://";

package/libEs6/components/Personalization/createApplyPropositions.js

@@ -9,45 +9,44 @@ 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 { 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];
 export default (({
   processPropositions,
   createProposition,
-  pendingDisplayNotifications,
+  renderedPropositions,
   viewCache
 }) => {
   const filterItemsPredicate = item => SUPPORTED_SCHEMAS.indexOf(item.schema) > -1;
-
   const updatePropositionItems = ({
     items,
     metadataForScope
   }) => {
     return items.filter(filterItemsPredicate).map(item => {
       if (item.schema !== HTML_CONTENT_ITEM) {
-        return { ...item
+        return {
+          ...item
         };
       }
-
       if (isObject(metadataForScope)) {
-        return { ...item,
-          data: { ...item.data,
+        return {
+          ...item,
+          data: {
+            ...item.data,
             selector: metadataForScope.selector,
             type: metadataForScope.actionType
           }
         };
       }
-
       return undefined;
     }).filter(item => item);
   };
-
   const filterPropositionsPredicate = proposition => {
     return !(proposition.scope === PAGE_WIDE_SCOPE && proposition.renderAttempted);
   };
-
   const preparePropositions = ({
     propositions,
     metadata
@@ -69,16 +68,18 @@ export default (({
           })
         };
       }
-
       return proposition;
     }).filter(proposition => isNonEmptyArray(proposition.items));
   };
-
   return ({
     propositions = [],
     metadata = {},
     viewName
   }) => {
+    // We need to immediately call concat so that subsequent sendEvent
+    // calls will wait for applyPropositions to complete before executing.
+    const renderedPropositionsDeferred = defer();
+    renderedPropositions.concat(renderedPropositionsDeferred.promise);
     const propositionsToExecute = preparePropositions({
       propositions,
       metadata
@@ -87,14 +88,13 @@ export default (({
       if (viewName) {
         return viewCache.getView(viewName);
       }
-
       return [];
     }).then(additionalPropositions => {
       const {
         render,
         returnedPropositions
       } = processPropositions([...propositionsToExecute, ...additionalPropositions]);
-      pendingDisplayNotifications.concat(render());
+      render().then(renderedPropositionsDeferred.resolve);
       return {
         propositions: returnedPropositions
       };

package/libEs6/components/Personalization/createClickStorage.js

@@ -9,46 +9,47 @@ 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 metasToArray = metas => {
   return Object.keys(metas).map(key => {
     return {
       id: key,
-      scope: metas[key].scope,
-      scopeDetails: metas[key].scopeDetails,
-      trackingLabel: metas[key].trackingLabel
+      ...metas[key]
     };
   });
 };
-
 export default (() => {
   const clickStorage = {};
-
-  const storeClickMetrics = value => {
-    if (!clickStorage[value.selector]) {
-      clickStorage[value.selector] = {};
+  const storeClickMetrics = ({
+    selector,
+    meta: {
+      id,
+      scope,
+      scopeDetails,
+      trackingLabel,
+      scopeType
     }
-
-    clickStorage[value.selector][value.meta.id] = {
-      scope: value.meta.scope,
-      scopeDetails: value.meta.scopeDetails,
-      trackingLabel: value.meta.trackingLabel
+  }) => {
+    if (!clickStorage[selector]) {
+      clickStorage[selector] = {};
+    }
+    clickStorage[selector][id] = {
+      scope,
+      scopeDetails,
+      trackingLabel,
+      scopeType
     };
   };
-
   const getClickSelectors = () => {
     return Object.keys(clickStorage);
   };
-
   const getClickMetasBySelector = selector => {
     const metas = clickStorage[selector];
-
     if (!metas) {
       return {};
     }
-
     return metasToArray(clickStorage[selector]);
   };
-
   return {
     storeClickMetrics,
     getClickSelectors,

package/libEs6/components/Personalization/createCollect.js

@@ -26,7 +26,6 @@ export default (({
     const data = {
       eventType: DISPLAY
     };
-
     if (viewName) {
       data.web = {
         webPageDetails: {
@@ -34,17 +33,13 @@ export default (({
         }
       };
     }
-
     if (isNonEmptyArray(decisionsMeta)) {
       mergeDecisionsMeta(event, decisionsMeta, PropositionEventType.DISPLAY);
     }
-
     event.mergeXdm(data);
-
     if (documentMayUnload) {
       event.documentMayUnload();
     }
-
     return eventManager.sendEvent(event);
   };
 });

package/libEs6/components/Personalization/createComponent.js

@@ -9,10 +9,12 @@ 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 { noop } from "../../utils";
+
+import { noop, flatMap, isNonEmptyArray } 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,
@@ -25,7 +27,8 @@ export default (({
   showContainers,
   applyPropositions,
   setTargetMigration,
-  pendingNotificationsHandler
+  mergeDecisionsMeta,
+  renderedPropositions
 }) => {
   return {
     lifecycle: {
@@ -35,7 +38,6 @@ export default (({
         setTargetMigration(request);
         return Promise.resolve();
       },
-
       onBeforeEvent({
         event,
         renderDecisions,
@@ -49,16 +51,15 @@ export default (({
           propositions: []
         }));
         onRequestFailure(() => showContainers());
-
         if (isAuthoringModeEnabled()) {
-          logger.warn(AUTHORING_ENABLED); // If we are in authoring mode we disable personalization
+          logger.warn(AUTHORING_ENABLED);
 
+          // If we are in authoring mode we disable personalization
           mergeQuery(event, {
             enabled: false
           });
           return Promise.resolve();
         }
-
         const personalizationDetails = createPersonalizationDetails({
           getPageLocation,
           renderDecisions,
@@ -68,14 +69,10 @@ export default (({
           isCacheInitialized: viewCache.isInitialized(),
           logger
         });
-        const handlerPromises = [];
-
-        if (personalizationDetails.shouldAddPendingDisplayNotifications()) {
-          handlerPromises.push(pendingNotificationsHandler({
-            event
-          }));
+        const decisionsMetaPromises = [];
+        if (personalizationDetails.shouldIncludeRenderedPropositions()) {
+          decisionsMetaPromises.push(renderedPropositions.clear());
         }
-
         if (personalizationDetails.shouldFetchData()) {
           const cacheUpdate = viewCache.createCacheUpdate(personalizationDetails.getViewName());
           onRequestFailure(() => cacheUpdate.cancel());
@@ -87,19 +84,26 @@ 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.
+          const decisionsMeta = flatMap(decisionsMetas, dms => dms);
+          if (isNonEmptyArray(decisionsMeta)) {
+            mergeDecisionsMeta(event, decisionsMeta, PropositionEventType.DISPLAY);
+          }
+        });
       },
-
       onClick({
         event,
         clickedElement
@@ -109,7 +113,6 @@ export default (({
           clickedElement
         });
       }
-
     },
     commands: {
       applyPropositions: {

package/libEs6/components/Personalization/createFetchDataHandler.js

@@ -19,7 +19,7 @@ export default (({
   collect,
   processPropositions,
   createProposition,
-  pendingDisplayNotifications
+  renderedPropositions
 }) => {
   return ({
     cacheUpdate,
@@ -29,12 +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({
@@ -44,11 +44,10 @@ 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
     }) => {
@@ -63,27 +62,24 @@ export default (({
       let render;
       let returnedPropositions;
       let returnedDecisions;
-
       if (personalizationDetails.isRenderDecisions()) {
         ({
           render,
           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,
           returnedDecisions
         } = processPropositions([], [...pagePropositions, ...currentViewPropositions, ...nonRenderedPropositions]));
       }
-
       return {
         propositions: returnedPropositions,
         decisions: returnedDecisions