@adobe/alloy 2.22.0-alpha.0 → 2.22.0-alpha.1

package/libEs5/components/Personalization/createFetchDataHandler.js

@@ -2,6 +2,7 @@
 
 exports.default = void 0;
 var _index = require("../../utils/index.js");
+var _pageWideScope = require("../../constants/pageWideScope.js");
 /*
 Copyright 2023 Adobe. All rights reserved.
 This file is licensed to you under the Apache License, Version 2.0 (the "License");
@@ -16,6 +17,7 @@ governing permissions and limitations under the License.
 
 const DECISIONS_HANDLE = "personalization:decisions";
 var _default = ({
+  logger,
   prehidingStyle,
   showContainers,
   hideContainers,
@@ -51,6 +53,16 @@ var _default = ({
       response
     }) => {
       const handles = response.getPayloadsByType(DECISIONS_HANDLE);
+      if (!(0, _index.isNonEmptyArray)(handles)) {
+        logger.logOnContentRendering({
+          status: "no-offers",
+          message: "No offers were returned.",
+          logLevel: "info",
+          detail: {
+            query: personalizationDetails.createQueryDetails()
+          }
+        });
+      }
       const propositions = handles.map(handle => createProposition(handle));
       const {
         page: pagePropositions = [],
@@ -67,6 +79,28 @@ var _default = ({
           returnedPropositions,
           returnedDecisions
         } = processPropositions([...pagePropositions, ...currentViewPropositions], nonRenderedPropositions));
+        if ((0, _index.isNonEmptyArray)(pagePropositions)) {
+          logger.logOnContentRendering({
+            status: "rendering-started",
+            message: "Started rendering propositions for page-wide scope.",
+            logLevel: "info",
+            detail: {
+              scope: _pageWideScope.default,
+              propositions: pagePropositions.map(proposition => proposition.toJSON())
+            }
+          });
+        }
+        if ((0, _index.isNonEmptyArray)(currentViewPropositions)) {
+          logger.logOnContentRendering({
+            status: "rendering-started",
+            message: "Rendering propositions started for view scope - " + personalizationDetails.getViewName() + ".",
+            logLevel: "info",
+            detail: {
+              scope: personalizationDetails.getViewName(),
+              propositions: currentViewPropositions.map(proposition => proposition.toJSON())
+            }
+          });
+        }
         render().then(handleNotifications);
 
         // Render could take a long time especially if one of the renders

package/libEs5/components/Personalization/createViewChangeHandler.js

@@ -14,7 +14,8 @@ governing permissions and limitations under the License.
 */
 var _default = ({
   processPropositions,
-  viewCache
+  viewCache,
+  logger
 }) => {
   return ({
     personalizationDetails,
@@ -37,6 +38,15 @@ var _default = ({
           returnedPropositions,
           returnedDecisions
         } = processPropositions(propositions));
+        logger.logOnContentRendering({
+          status: "rendering-started",
+          message: "Started rendering propositions for view scope - " + viewName + ".",
+          logLevel: "info",
+          detail: {
+            scope: viewName,
+            propositions: propositions.map(proposition => proposition.toJSON())
+          }
+        });
         return render();
       }
       ({

package/libEs5/components/Personalization/flicker/index.js

@@ -1,6 +1,6 @@
 "use strict";
 
-exports.showElements = exports.showContainers = exports.hideElements = exports.hideContainers = void 0;
+exports.showElements = exports.hideElements = exports.createShowContainers = exports.createHideContainers = void 0;
 var _index = require("../../../utils/dom/index.js");
 var _tagName = require("../../../constants/tagName.js");
 var _index2 = require("../dom-actions/dom/index.js");
@@ -51,39 +51,53 @@ const showElements = prehidingSelector => {
   }
 };
 exports.showElements = showElements;
-const hideContainers = prehidingStyle => {
-  if (!prehidingStyle) {
-    return;
-  }
+const createHideContainers = logger => {
+  return prehidingStyle => {
+    if (!prehidingStyle) {
+      return;
+    }
 
-  // If containers prehiding style has been added
-  // by customer's prehiding snippet we don't
-  // want to add the same node
-  const node = (0, _index2.getElementById)(PREHIDING_ID);
-  if (node) {
-    return;
-  }
-  const nonce = (0, _index2.getNonce)();
-  const attrs = {
-    id: PREHIDING_ID,
-    ...(nonce && {
-      nonce
-    })
-  };
-  const props = {
-    textContent: prehidingStyle
+    // If containers prehiding style has been added
+    // by customer's prehiding snippet we don't
+    // want to add the same node
+    const node = (0, _index2.getElementById)(PREHIDING_ID);
+    if (node) {
+      return;
+    }
+    const nonce = (0, _index2.getNonce)();
+    const attrs = {
+      id: PREHIDING_ID,
+      ...(nonce && {
+        nonce
+      })
+    };
+    const props = {
+      textContent: prehidingStyle
+    };
+    const styleNode = (0, _index.createNode)(_tagName.STYLE, attrs, props);
+    logger.logOnContentHiding({
+      status: "hide-containers",
+      message: "Prehiding style applied to hide containers.",
+      logLevel: "info"
+    });
+    (0, _index.appendNode)(document.head, styleNode);
   };
-  const styleNode = (0, _index.createNode)(_tagName.STYLE, attrs, props);
-  (0, _index.appendNode)(document.head, styleNode);
 };
-exports.hideContainers = hideContainers;
-const showContainers = () => {
-  // If containers prehiding style exists
-  // we will remove it
-  const node = (0, _index2.getElementById)(PREHIDING_ID);
-  if (!node) {
-    return;
-  }
-  (0, _index.removeNode)(node);
+exports.createHideContainers = createHideContainers;
+const createShowContainers = logger => {
+  return () => {
+    // If containers prehiding style exists
+    // we will remove it
+    const node = (0, _index2.getElementById)(PREHIDING_ID);
+    if (!node) {
+      return;
+    }
+    logger.logOnContentHiding({
+      status: "show-containers",
+      message: "Prehiding style removed to show containers.",
+      logLevel: "info"
+    });
+    (0, _index.removeNode)(node);
+  };
 };
-exports.showContainers = showContainers;
+exports.createShowContainers = createShowContainers;

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

@@ -1,6 +1,7 @@
 "use strict";
 
 exports.default = void 0;
+var _index = require("../../../utils/index.js");
 /*
 Copyright 2023 Adobe. All rights reserved.
 This file is licensed to you under the Apache License, Version 2.0 (the "License");
@@ -23,14 +24,21 @@ var _default = ({
       }
       return true;
     }).catch(error => {
-      if (logger.enabled) {
-        const {
-          message,
-          stack
-        } = error;
-        const warning = "Failed to execute action " + item.toString() + ". " + message + " " + stack;
-        logger.warn(warning);
-      }
+      const {
+        message,
+        stack
+      } = error;
+      const warning = "Failed to execute action " + item.toString() + ". " + message + " " + stack;
+      logger.logOnContentRendering({
+        status: "rendering-failed",
+        detail: {
+          propositionDetails: item.getProposition().getNotification(),
+          item: item.toJSON()
+        },
+        error,
+        message: warning,
+        logLevel: "warn"
+      });
       return false;
     });
   };
@@ -166,7 +174,19 @@ var _default = ({
       p.addToReturnValues(returnedPropositions, returnedDecisions, p.getItems(), false);
     });
     const render = () => {
-      return Promise.all(renderers.map(renderer => renderer())).then(metas => metas.filter(meta => meta));
+      return Promise.all(renderers.map(renderer => renderer())).then(metas => {
+        const renderedPropositions = metas.filter(meta => meta);
+        const propsByScope = (0, _index.groupBy)(renderedPropositions, p => p.scope);
+        logger.logOnContentRendering({
+          status: "rendering-succeeded",
+          detail: {
+            ...propsByScope
+          },
+          message: "Scopes: " + propsByScope + " successfully executed.",
+          logLevel: "info"
+        });
+        return renderedPropositions;
+      });
     };
     return {
       returnedPropositions,

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

@@ -29,6 +29,15 @@ var _default = ({
       decisionsMeta: [item.getProposition().getNotification()],
       documentMayUnload: true
     }).then(() => {
+      logger.logOnContentRendering({
+        status: "rendering-redirect",
+        detail: {
+          propositionDetails: item.getProposition().getNotification(),
+          redirect: content
+        },
+        message: "Redirect action " + item.toString() + " executed.",
+        logLevel: "info"
+      });
       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

package/libEs5/components/Personalization/handlers/injectCreateProposition.js

@@ -73,9 +73,6 @@ var _default = ({
     } = scopeDetails || {};
     return {
       getScope() {
-        if (!scope) {
-          return scope;
-        }
         return scope;
       },
       getScopeType() {

package/libEs5/components/Personalization/index.js

@@ -66,6 +66,8 @@ const createPersonalization = ({
     eventManager,
     mergeDecisionsMeta: _event.mergeDecisionsMeta
   });
+  const showContainers = (0, _index3.createShowContainers)(logger);
+  const hideContainers = (0, _index3.createHideContainers)(logger);
   const {
     storeInteractionMeta,
     getInteractionMetas
@@ -121,13 +123,14 @@ const createPersonalization = ({
   const notificationHandler = (0, _createNotificationHandler.default)(collect, renderedPropositions);
   const fetchDataHandler = (0, _createFetchDataHandler.default)({
     prehidingStyle,
-    showContainers: _index3.showContainers,
-    hideContainers: _index3.hideContainers,
+    showContainers,
+    hideContainers,
     mergeQuery: _event.mergeQuery,
     processPropositions,
     createProposition,
     notificationHandler,
-    consent
+    consent,
+    logger
   });
   const onClickHandler = (0, _createOnClickHandler.default)({
     mergeDecisionsMeta: _event.mergeDecisionsMeta,
@@ -140,7 +143,8 @@ const createPersonalization = ({
   });
   const viewChangeHandler = (0, _createViewChangeHandler.default)({
     processPropositions,
-    viewCache
+    viewCache,
+    logger
   });
   const applyPropositions = (0, _createApplyPropositions.default)({
     processPropositions,
@@ -157,7 +161,7 @@ const createPersonalization = ({
     notificationHandler
   });
   const handleConsentFlicker = (0, _createHandleConsentFlicker.default)({
-    showContainers: _index3.showContainers,
+    showContainers,
     consent
   });
   return (0, _createComponent.default)({
@@ -169,7 +173,7 @@ const createPersonalization = ({
     isAuthoringModeEnabled: _isAuthoringModeEnabled.default,
     mergeQuery: _event.mergeQuery,
     viewCache,
-    showContainers: _index3.showContainers,
+    showContainers,
     applyPropositions,
     setTargetMigration,
     mergeDecisionsMeta: _event.mergeDecisionsMeta,

package/libEs5/constants/libraryVersion.js

@@ -14,4 +14,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
-var _default = exports.default = "2.22.0-alpha.0";
+var _default = exports.default = "2.22.0-alpha.1";

package/libEs5/core/createLogger.js

@@ -82,6 +82,19 @@ var _default = ({
       notifyMonitors("onNetworkError", data);
       log("error", "Request " + data.requestId + ": Network request failed.", data.error);
     },
+    logOnContentHiding(data) {
+      notifyMonitors("onContentHiding", {
+        status: data.status
+      });
+      log(data.logLevel, data.message);
+    },
+    logOnContentRendering(data) {
+      notifyMonitors("onContentRendering", {
+        status: data.status,
+        payload: data.detail
+      });
+      log(data.logLevel, data.message);
+    },
     /**
      * Outputs informational message to the web console. In some
      * browsers a small "i" icon is displayed next to these items

package/libEs6/components/Personalization/createFetchDataHandler.js

@@ -9,9 +9,11 @@ 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 { groupBy } from "../../utils/index.js";
+import { groupBy, isNonEmptyArray } from "../../utils/index.js";
+import PAGE_WIDE_SCOPE from "../../constants/pageWideScope.js";
 const DECISIONS_HANDLE = "personalization:decisions";
 export default (({
+  logger,
   prehidingStyle,
   showContainers,
   hideContainers,
@@ -47,6 +49,16 @@ export default (({
       response
     }) => {
       const handles = response.getPayloadsByType(DECISIONS_HANDLE);
+      if (!isNonEmptyArray(handles)) {
+        logger.logOnContentRendering({
+          status: "no-offers",
+          message: "No offers were returned.",
+          logLevel: "info",
+          detail: {
+            query: personalizationDetails.createQueryDetails()
+          }
+        });
+      }
       const propositions = handles.map(handle => createProposition(handle));
       const {
         page: pagePropositions = [],
@@ -63,6 +75,28 @@ export default (({
           returnedPropositions,
           returnedDecisions
         } = processPropositions([...pagePropositions, ...currentViewPropositions], nonRenderedPropositions));
+        if (isNonEmptyArray(pagePropositions)) {
+          logger.logOnContentRendering({
+            status: "rendering-started",
+            message: "Started rendering propositions for page-wide scope.",
+            logLevel: "info",
+            detail: {
+              scope: PAGE_WIDE_SCOPE,
+              propositions: pagePropositions.map(proposition => proposition.toJSON())
+            }
+          });
+        }
+        if (isNonEmptyArray(currentViewPropositions)) {
+          logger.logOnContentRendering({
+            status: "rendering-started",
+            message: `Rendering propositions started for view scope - ${personalizationDetails.getViewName()}.`,
+            logLevel: "info",
+            detail: {
+              scope: personalizationDetails.getViewName(),
+              propositions: currentViewPropositions.map(proposition => proposition.toJSON())
+            }
+          });
+        }
         render().then(handleNotifications);
 
         // Render could take a long time especially if one of the renders

package/libEs6/components/Personalization/createViewChangeHandler.js

@@ -12,7 +12,8 @@ governing permissions and limitations under the License.
 
 export default (({
   processPropositions,
-  viewCache
+  viewCache,
+  logger
 }) => {
   return ({
     personalizationDetails,
@@ -35,6 +36,15 @@ export default (({
           returnedPropositions,
           returnedDecisions
         } = processPropositions(propositions));
+        logger.logOnContentRendering({
+          status: "rendering-started",
+          message: `Started rendering propositions for view scope - ${viewName}.`,
+          logLevel: "info",
+          detail: {
+            scope: viewName,
+            propositions: propositions.map(proposition => proposition.toJSON())
+          }
+        });
         return render();
       }
       ({

package/libEs6/components/Personalization/flicker/index.js

@@ -46,37 +46,51 @@ export const showElements = prehidingSelector => {
     delete styleNodes[prehidingSelector];
   }
 };
-export const hideContainers = prehidingStyle => {
-  if (!prehidingStyle) {
-    return;
-  }
+export const createHideContainers = logger => {
+  return prehidingStyle => {
+    if (!prehidingStyle) {
+      return;
+    }
 
-  // If containers prehiding style has been added
-  // by customer's prehiding snippet we don't
-  // want to add the same node
-  const node = getElementById(PREHIDING_ID);
-  if (node) {
-    return;
-  }
-  const nonce = getNonce();
-  const attrs = {
-    id: PREHIDING_ID,
-    ...(nonce && {
-      nonce
-    })
-  };
-  const props = {
-    textContent: prehidingStyle
+    // If containers prehiding style has been added
+    // by customer's prehiding snippet we don't
+    // want to add the same node
+    const node = getElementById(PREHIDING_ID);
+    if (node) {
+      return;
+    }
+    const nonce = getNonce();
+    const attrs = {
+      id: PREHIDING_ID,
+      ...(nonce && {
+        nonce
+      })
+    };
+    const props = {
+      textContent: prehidingStyle
+    };
+    const styleNode = createNode(STYLE, attrs, props);
+    logger.logOnContentHiding({
+      status: "hide-containers",
+      message: "Prehiding style applied to hide containers.",
+      logLevel: "info"
+    });
+    appendNode(document.head, styleNode);
   };
-  const styleNode = createNode(STYLE, attrs, props);
-  appendNode(document.head, styleNode);
 };
-export const showContainers = () => {
-  // If containers prehiding style exists
-  // we will remove it
-  const node = getElementById(PREHIDING_ID);
-  if (!node) {
-    return;
-  }
-  removeNode(node);
+export const createShowContainers = logger => {
+  return () => {
+    // If containers prehiding style exists
+    // we will remove it
+    const node = getElementById(PREHIDING_ID);
+    if (!node) {
+      return;
+    }
+    logger.logOnContentHiding({
+      status: "show-containers",
+      message: "Prehiding style removed to show containers.",
+      logLevel: "info"
+    });
+    removeNode(node);
+  };
 };

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

@@ -10,6 +10,7 @@ OF ANY KIND, either express or implied. See the License for the specific languag
 governing permissions and limitations under the License.
 */
 
+import { groupBy } from "../../../utils/index.js";
 export default (({
   schemaProcessors,
   logger
@@ -21,14 +22,21 @@ export default (({
       }
       return true;
     }).catch(error => {
-      if (logger.enabled) {
-        const {
-          message,
-          stack
-        } = error;
-        const warning = `Failed to execute action ${item.toString()}. ${message} ${stack}`;
-        logger.warn(warning);
-      }
+      const {
+        message,
+        stack
+      } = error;
+      const warning = `Failed to execute action ${item.toString()}. ${message} ${stack}`;
+      logger.logOnContentRendering({
+        status: "rendering-failed",
+        detail: {
+          propositionDetails: item.getProposition().getNotification(),
+          item: item.toJSON()
+        },
+        error,
+        message: warning,
+        logLevel: "warn"
+      });
       return false;
     });
   };
@@ -164,7 +172,19 @@ export default (({
       p.addToReturnValues(returnedPropositions, returnedDecisions, p.getItems(), false);
     });
     const render = () => {
-      return Promise.all(renderers.map(renderer => renderer())).then(metas => metas.filter(meta => meta));
+      return Promise.all(renderers.map(renderer => renderer())).then(metas => {
+        const renderedPropositions = metas.filter(meta => meta);
+        const propsByScope = groupBy(renderedPropositions, p => p.scope);
+        logger.logOnContentRendering({
+          status: "rendering-succeeded",
+          detail: {
+            ...propsByScope
+          },
+          message: `Scopes: ${propsByScope} successfully executed.`,
+          logLevel: "info"
+        });
+        return renderedPropositions;
+      });
     };
     return {
       returnedPropositions,

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

@@ -26,6 +26,15 @@ export default (({
       decisionsMeta: [item.getProposition().getNotification()],
       documentMayUnload: true
     }).then(() => {
+      logger.logOnContentRendering({
+        status: "rendering-redirect",
+        detail: {
+          propositionDetails: item.getProposition().getNotification(),
+          redirect: content
+        },
+        message: `Redirect action ${item.toString()} executed.`,
+        logLevel: "info"
+      });
       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

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

@@ -71,9 +71,6 @@ export default (({
     } = scopeDetails || {};
     return {
       getScope() {
-        if (!scope) {
-          return scope;
-        }
         return scope;
       },
       getScopeType() {

package/libEs6/components/Personalization/index.js

@@ -14,7 +14,7 @@ import { anyOf, boolean, literal, objectOf, string } from "../../utils/validatio
 import createComponent from "./createComponent.js";
 import { initDomActionsModules } from "./dom-actions/index.js";
 import createCollect from "../../utils/createCollect.js";
-import { hideContainers, showContainers } from "./flicker/index.js";
+import { createHideContainers, createShowContainers } from "./flicker/index.js";
 import createFetchDataHandler from "./createFetchDataHandler.js";
 import collectClicks from "./dom-actions/clicks/collectClicks.js";
 import isAuthoringModeEnabled from "./utils/isAuthoringModeEnabled.js";
@@ -63,6 +63,8 @@ const createPersonalization = ({
     eventManager,
     mergeDecisionsMeta
   });
+  const showContainers = createShowContainers(logger);
+  const hideContainers = createHideContainers(logger);
   const {
     storeInteractionMeta,
     getInteractionMetas
@@ -124,7 +126,8 @@ const createPersonalization = ({
     processPropositions,
     createProposition,
     notificationHandler,
-    consent
+    consent,
+    logger
   });
   const onClickHandler = createOnClickHandler({
     mergeDecisionsMeta,
@@ -137,7 +140,8 @@ const createPersonalization = ({
   });
   const viewChangeHandler = createViewChangeHandler({
     processPropositions,
-    viewCache
+    viewCache,
+    logger
   });
   const applyPropositions = createApplyPropositions({
     processPropositions,

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.22.0-alpha.0";
+export default "2.22.0-alpha.1";

package/libEs6/core/createLogger.js

@@ -80,6 +80,19 @@ export default (({
       notifyMonitors("onNetworkError", data);
       log("error", `Request ${data.requestId}: Network request failed.`, data.error);
     },
+    logOnContentHiding(data) {
+      notifyMonitors("onContentHiding", {
+        status: data.status
+      });
+      log(data.logLevel, data.message);
+    },
+    logOnContentRendering(data) {
+      notifyMonitors("onContentRendering", {
+        status: data.status,
+        payload: data.detail
+      });
+      log(data.logLevel, data.message);
+    },
     /**
      * Outputs informational message to the web console. In some
      * browsers a small "i" icon is displayed next to these items

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/alloy",
-  "version": "2.22.0-alpha.0",
+  "version": "2.22.0-alpha.1",
   "description": "Adobe Experience Platform Web SDK",
   "type": "module",
   "main": "libEs5/index.js",
@@ -95,7 +95,7 @@
     "uuid": "^10.0.0"
   },
   "devDependencies": {
-    "@adobe/alloy": "^2.21.1",
+    "@adobe/alloy": "^2.22.0-alpha.0",
     "@babel/cli": "^7.24.8",
     "@babel/plugin-transform-runtime": "^7.24.7",
     "@eslint/js": "^9.7.0",