Rename fetch flags

adobe · Oct 23, 2023 · cc012c1 · cc012c1
1 parent 33288d6
commit cc012c1
Show file tree

Hide file tree

Showing 11 changed files with 47 additions and 50 deletions.
diff --git a/src/components/DataCollector/validateApplyResponse.js b/src/components/DataCollector/validateApplyResponse.js
@@ -31,8 +31,8 @@ export default ({ options }) => {
       ).required()
     }).required(),
     personalization: objectOf({
-      sendDisplayNotifications: boolean().default(true)
-    }).default({ sendDisplayNotifications: true })
+      sendDisplayEvent: boolean().default(true)
+    }).default({ sendDisplayEvent: true })
   }).noUnknownFields();
 
   return validator(options);

diff --git a/src/components/DataCollector/validateUserEventOptions.js b/src/components/DataCollector/validateUserEventOptions.js
@@ -31,9 +31,9 @@ export default ({ options }) => {
     personalization: objectOf({
       decisionScopes: arrayOf(string()).uniqueItems(),
       surfaces: arrayOf(string()).uniqueItems(),
-      sendDisplayNotifications: boolean().default(true),
-      includePendingDisplayNotifications: boolean().default(false)
-    }).default({ sendDisplayNotifications: true }),
+      sendDisplayEvent: boolean().default(true),
+      includeRenderedPropositions: boolean().default(false)
+    }).default({ sendDisplayEvent: true }),
     datasetId: string(),
     mergeId: string(),
     edgeConfigOverrides: validateConfigOverride

diff --git a/src/components/Personalization/createApplyPropositions.js b/src/components/Personalization/createApplyPropositions.js
@@ -19,7 +19,7 @@ const SUPPORTED_SCHEMAS = [DOM_ACTION, HTML_CONTENT_ITEM];
 export default ({
   processPropositions,
   createProposition,
-  pendingDisplayNotifications,
+  renderedPropositions,
   viewCache
 }) => {
   const filterItemsPredicate = item =>
@@ -77,8 +77,8 @@ export default ({
   return ({ propositions = [], 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 renderedPropositionsDeferred = defer();
+    renderedPropositions.concat(renderedPropositionsDeferred.promise);
 
     const propositionsToExecute = preparePropositions({
       propositions,
@@ -98,7 +98,7 @@ export default ({
           ...additionalPropositions
         ]);
 
-        render().then(displayNotificationsDeferred.resolve);
+        render().then(renderedPropositionsDeferred.resolve);
 
         return {
           propositions: returnedPropositions

diff --git a/src/components/Personalization/createComponent.js b/src/components/Personalization/createComponent.js
@@ -29,7 +29,7 @@ export default ({
   applyPropositions,
   setTargetMigration,
   mergeDecisionsMeta,
-  pendingDisplayNotifications
+  renderedPropositions
 }) => {
   return {
     lifecycle: {
@@ -68,8 +68,8 @@ export default ({
         });
 
         const decisionsMetaPromises = [];
-        if (personalizationDetails.shouldAddPendingDisplayNotifications()) {
-          decisionsMetaPromises.push(pendingDisplayNotifications.clear());
+        if (personalizationDetails.shouldIncludeRenderedPropositions()) {
+          decisionsMetaPromises.push(renderedPropositions.clear());
         }
 
         if (personalizationDetails.shouldFetchData()) {

diff --git a/src/components/Personalization/createFetchDataHandler.js b/src/components/Personalization/createFetchDataHandler.js
@@ -21,7 +21,7 @@ export default ({
   collect,
   processPropositions,
   createProposition,
-  pendingDisplayNotifications
+  renderedPropositions
 }) => {
   return ({ cacheUpdate, personalizationDetails, event, onResponse }) => {
     if (personalizationDetails.isRenderDecisions()) {
@@ -32,7 +32,7 @@ export default ({
     mergeQuery(event, personalizationDetails.createQueryDetails());
 
     let handleNotifications;
-    if (personalizationDetails.isSendDisplayNotifications()) {
+    if (personalizationDetails.isSendDisplayEvent()) {
       handleNotifications = decisionsMeta => {
         if (decisionsMeta.length > 0) {
           collect({
@@ -42,9 +42,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 }) => {

diff --git a/src/components/Personalization/createPersonalizationDetails.js b/src/components/Personalization/createPersonalizationDetails.js
@@ -51,11 +51,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;

diff --git a/src/components/Personalization/index.js b/src/components/Personalization/index.js
@@ -80,7 +80,7 @@ const createPersonalization = ({ config, logger, eventManager }) => {
     logger
   });
 
-  const pendingDisplayNotifications = createAsyncArray();
+  const renderedPropositions = createAsyncArray();
   const fetchDataHandler = createFetchDataHandler({
     prehidingStyle,
     showContainers,
@@ -89,7 +89,7 @@ const createPersonalization = ({ config, logger, eventManager }) => {
     collect,
     processPropositions,
     createProposition,
-    pendingDisplayNotifications
+    renderedPropositions
   });
   const onClickHandler = createOnClickHandler({
     mergeDecisionsMeta,
@@ -104,7 +104,7 @@ const createPersonalization = ({ config, logger, eventManager }) => {
   const applyPropositions = createApplyPropositions({
     processPropositions,
     createProposition,
-    pendingDisplayNotifications,
+    renderedPropositions,
     viewCache
   });
   const setTargetMigration = createSetTargetMigration({
@@ -123,7 +123,7 @@ const createPersonalization = ({ config, logger, eventManager }) => {
     applyPropositions,
     setTargetMigration,
     mergeDecisionsMeta,
-    pendingDisplayNotifications
+    renderedPropositions
   });
 };
 

diff --git a/test/unit/specs/components/Personalization/createApplyPropositions.spec.js b/test/unit/specs/components/Personalization/createApplyPropositions.spec.js
@@ -28,7 +28,7 @@ const METADATA = {
 describe("Personalization::createApplyPropositions", () => {
   let processPropositions;
   let createProposition;
-  let pendingDisplayNotifications;
+  let renderedPropositions;
   let viewCache;
   let applyPropositions;
   let render;
@@ -49,16 +49,15 @@ describe("Personalization::createApplyPropositions", () => {
       isPageWideSurface: () => false
     });
 
-    pendingDisplayNotifications = jasmine.createSpyObj(
-      "pendingDisplayNotifications",
-      ["concat"]
-    );
+    renderedPropositions = jasmine.createSpyObj("renderedPropositions", [
+      "concat"
+    ]);
     viewCache = jasmine.createSpyObj("viewCache", ["getView"]);
     viewCache.getView.and.returnValue(Promise.resolve([]));
     applyPropositions = createApplyPropositions({
       processPropositions,
       createProposition,
-      pendingDisplayNotifications,
+      renderedPropositions,
       viewCache
     });
   });

diff --git a/test/unit/specs/components/Personalization/createComponent.spec.js b/test/unit/specs/components/Personalization/createComponent.spec.js
@@ -25,7 +25,7 @@ describe("Personalization", () => {
   let personalizationComponent;
   let setTargetMigration;
   let mergeDecisionsMeta;
-  let pendingDisplayNotifications;
+  let renderedPropositions;
   let cacheUpdate;
 
   const build = () => {
@@ -40,7 +40,7 @@ describe("Personalization", () => {
       showContainers,
       setTargetMigration,
       mergeDecisionsMeta,
-      pendingDisplayNotifications
+      renderedPropositions
     });
   };
 
@@ -67,10 +67,9 @@ describe("Personalization", () => {
     viewCache.createCacheUpdate.and.returnValue(cacheUpdate);
     setTargetMigration = jasmine.createSpy("setTargetMigration");
     mergeDecisionsMeta = jasmine.createSpy("mergeDecisionsMeta");
-    pendingDisplayNotifications = jasmine.createSpyObj(
-      "pendingDisplayNotifications",
-      ["clear"]
-    );
+    renderedPropositions = jasmine.createSpyObj("renderedPropositions", [
+      "clear"
+    ]);
 
     build();
   });

diff --git a/test/unit/specs/components/Personalization/createFetchDataHandler.spec.js b/test/unit/specs/components/Personalization/createFetchDataHandler.spec.js
@@ -23,7 +23,7 @@ describe("Personalization::createFetchDataHandler", () => {
   let collect;
   let processPropositions;
   let createProposition;
-  let pendingDisplayNotifications;
+  let renderedPropositions;
 
   let cacheUpdate;
   let personalizationDetails;
@@ -43,20 +43,19 @@ describe("Personalization::createFetchDataHandler", () => {
       preprocess: data => data,
       isPageWideSurface: () => false
     });
-    pendingDisplayNotifications = jasmine.createSpyObj(
-      "pendingDisplayNotifications",
-      ["concat"]
-    );
+    renderedPropositions = jasmine.createSpyObj("renderedPropositions", [
+      "concat"
+    ]);
 
     cacheUpdate = jasmine.createSpyObj("cacheUpdate", ["update"]);
     personalizationDetails = jasmine.createSpyObj("personalizationDetails", [
       "isRenderDecisions",
       "createQueryDetails",
       "getViewName",
-      "isSendDisplayNotifications"
+      "isSendDisplayEvent"
     ]);
     personalizationDetails.createQueryDetails.and.returnValue("myquerydetails");
-    personalizationDetails.isSendDisplayNotifications.and.returnValue(true);
+    personalizationDetails.isSendDisplayEvent.and.returnValue(true);
     event = "myevent";
     onResponse = jasmine.createSpy();
     response = jasmine.createSpyObj("response", ["getPayloadsByType"]);
@@ -71,7 +70,7 @@ describe("Personalization::createFetchDataHandler", () => {
       collect,
       processPropositions,
       createProposition,
-      pendingDisplayNotifications
+      renderedPropositions
     });
     fetchDataHandler({
       cacheUpdate,

diff --git a/test/unit/specs/components/Personalization/topLevel/buildAlloy.js b/test/unit/specs/components/Personalization/topLevel/buildAlloy.js
@@ -113,7 +113,7 @@ const buildComponent = ({
     logger
   });
 
-  const pendingDisplayNotifications = createAsyncArray();
+  const renderedPropositions = createAsyncArray();
   const fetchDataHandler = createFetchDataHandler({
     prehidingStyle,
     showContainers,
@@ -122,7 +122,7 @@ const buildComponent = ({
     collect,
     processPropositions,
     createProposition,
-    pendingDisplayNotifications
+    renderedPropositions
   });
   const onClickHandler = createOnClickHandler({
     mergeDecisionsMeta,
@@ -137,7 +137,7 @@ const buildComponent = ({
   const applyPropositions = createApplyPropositions({
     processPropositions,
     createProposition,
-    pendingDisplayNotifications,
+    renderedPropositions,
     viewCache
   });
   const setTargetMigration = createSetTargetMigration({
@@ -156,7 +156,7 @@ const buildComponent = ({
     applyPropositions,
     setTargetMigration,
     mergeDecisionsMeta,
-    pendingDisplayNotifications
+    renderedPropositions
   });
 };
 
@@ -179,7 +179,7 @@ export default mocks => {
         event,
         renderDecisions,
         decisionScopes,
-        personalization: personalization || { sendDisplayNotifications: true },
+        personalization: personalization || { sendDisplayEvent: true },
         onResponse: callbacks.add
       });
       const results = await callbacks.call({ response });