@adobe/alloy 2.19.0-beta.8 → 2.19.0

package/libEs6/components/DecisioningEngine/utils.js

@@ -0,0 +1,83 @@
+/*
+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.
+*/
+
+export const createRestoreStorage = (storage, storageKey) => {
+  return defaultValue => {
+    const stored = storage.getItem(storageKey);
+    if (!stored) {
+      return defaultValue;
+    }
+    try {
+      return JSON.parse(stored);
+    } catch (e) {
+      return defaultValue;
+    }
+  };
+};
+export const createSaveStorage = (storage, storageKey, prepareFn = value => value) => {
+  return value => {
+    storage.setItem(storageKey, JSON.stringify(prepareFn(value)));
+  };
+};
+export const getExpirationDate = retentionPeriod => {
+  const expirationDate = new Date();
+  expirationDate.setDate(expirationDate.getDate() - retentionPeriod);
+  return expirationDate;
+};
+export const getActivityId = proposition => {
+  const {
+    scopeDetails = {}
+  } = proposition;
+  const {
+    activity = {}
+  } = scopeDetails;
+  const {
+    id
+  } = activity;
+  return id;
+};
+export const createInMemoryStorage = () => {
+  const inMemoryStorage = {};
+  return {
+    getItem: key => {
+      return key in inMemoryStorage ? inMemoryStorage[key] : null;
+    },
+    setItem: (key, value) => {
+      inMemoryStorage[key] = value;
+    }
+  };
+};
+export const clearLocalStorage = storage => {
+  storage.clear();
+};
+export const hasExperienceData = xdm => {
+  const {
+    eventType = "",
+    _experience
+  } = xdm;
+  if (!eventType || eventType === "") {
+    return false;
+  }
+  if (!_experience || typeof _experience !== "object") {
+    return false;
+  }
+  return true;
+};
+export const getDecisionProvider = proposition => {
+  const {
+    scopeDetails = {}
+  } = proposition;
+  const {
+    decisionProvider
+  } = scopeDetails;
+  return decisionProvider;
+};

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

@@ -10,4 +10,6 @@ OF ANY KIND, either express or implied. See the License for the specific languag
 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/createActionsProvider.js

@@ -0,0 +1,70 @@
+/*
+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 createPreprocessors from "./createPreprocessors";
+import { assign } from "../../utils";
+export default (({
+  modules,
+  preprocessors = createPreprocessors(),
+  logger
+}) => {
+  const logActionError = (action, error) => {
+    if (logger.enabled) {
+      const details = JSON.stringify(action);
+      const {
+        message,
+        stack
+      } = error;
+      const errorMessage = `Failed to execute action ${details}. ${message} ${stack ? `\n ${stack}` : ""}`;
+      logger.warn(errorMessage);
+    }
+  };
+  const logActionCompleted = action => {
+    if (logger.enabled) {
+      const details = JSON.stringify(action);
+      logger.info(`Action ${details} executed.`);
+    }
+  };
+  const getExecuteAction = (schema, type) => {
+    if (!modules[schema] || !modules[schema][type]) {
+      return () => Promise.reject(new Error(`Action "${type}" not found for schema "${schema}"`));
+    }
+    return modules[schema][type];
+  };
+  const applyPreprocessors = action => {
+    const {
+      schema
+    } = action;
+    const preprocessorsList = preprocessors[schema];
+    if (!schema || !(preprocessorsList instanceof Array) || preprocessorsList.length === 0) {
+      return action;
+    }
+    return preprocessorsList.reduce((processed, fn) => assign(processed, fn(processed)), action);
+  };
+  const executeAction = action => {
+    const processedAction = applyPreprocessors(action);
+    const {
+      type,
+      schema
+    } = processedAction;
+    const execute = getExecuteAction(schema, type);
+    return execute(processedAction).then(result => {
+      logActionCompleted(processedAction);
+      return result;
+    }).catch(error => {
+      logActionError(processedAction, error);
+      throw error;
+    });
+  };
+  return {
+    executeAction
+  };
+});

package/libEs6/components/Personalization/createApplyPropositions.js

@@ -11,9 +11,9 @@ governing permissions and limitations under the License.
 */
 
 import { isNonEmptyArray, isObject, defer } from "../../utils";
-import { DOM_ACTION, HTML_CONTENT_ITEM } from "./constants/schema";
+import { DOM_ACTION, HTML_CONTENT_ITEM, MESSAGE_IN_APP } from "../../constants/schema";
 import PAGE_WIDE_SCOPE from "../../constants/pageWideScope";
-const SUPPORTED_SCHEMAS = [DOM_ACTION, HTML_CONTENT_ITEM];
+const SUPPORTED_SCHEMAS = [DOM_ACTION, HTML_CONTENT_ITEM, MESSAGE_IN_APP];
 export default (({
   processPropositions,
   createProposition,

package/libEs6/components/Personalization/createClickStorage.js

@@ -14,22 +14,30 @@ 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 = () => {

package/libEs6/components/Personalization/createCollect.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 { DISPLAY } from "./constants/eventType";
-import { PropositionEventType } from "./constants/propositionEventType";
+import { DISPLAY } from "../../constants/eventType";
+import { getPropositionEventType } from "../../constants/propositionEventType";
 import { isNonEmptyArray } from "../../utils";
 export default (({
   eventManager,
@@ -19,12 +19,15 @@ export default (({
   // Called when a decision is auto-rendered for the __view__ scope or a SPA view(display and empty display notification)
   return ({
     decisionsMeta = [],
+    propositionAction,
     documentMayUnload = false,
+    eventType = DISPLAY,
+    propositionEventTypes = [getPropositionEventType(eventType)],
     viewName
   }) => {
     const event = eventManager.createEvent();
     const data = {
-      eventType: DISPLAY
+      eventType
     };
     if (viewName) {
       data.web = {
@@ -34,7 +37,7 @@ export default (({
       };
     }
     if (isNonEmptyArray(decisionsMeta)) {
-      mergeDecisionsMeta(event, decisionsMeta, PropositionEventType.DISPLAY);
+      mergeDecisionsMeta(event, decisionsMeta, propositionEventTypes, propositionAction);
     }
     event.mergeXdm(data);
     if (documentMayUnload) {

package/libEs6/components/Personalization/createComponent.js

@@ -13,8 +13,8 @@ governing permissions and limitations under the License.
 import { noop, flatMap, isNonEmptyArray } from "../../utils";
 import createPersonalizationDetails from "./createPersonalizationDetails";
 import { AUTHORING_ENABLED } from "./constants/loggerMessage";
+import { PropositionEventType } from "../../constants/propositionEventType";
 import validateApplyPropositionsOptions from "./validateApplyPropositionsOptions";
-import { PropositionEventType } from "./constants/propositionEventType";
 export default (({
   getPageLocation,
   logger,
@@ -28,10 +28,12 @@ export default (({
   applyPropositions,
   setTargetMigration,
   mergeDecisionsMeta,
-  renderedPropositions
+  renderedPropositions,
+  onDecisionHandler
 }) => {
   return {
     lifecycle: {
+      onDecision: onDecisionHandler,
       onBeforeRequest({
         request
       }) {
@@ -100,7 +102,7 @@ export default (({
           // 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);
+            mergeDecisionsMeta(event, decisionsMeta, [PropositionEventType.DISPLAY]);
           }
         });
       },

package/libEs6/components/Personalization/createFetchDataHandler.js

@@ -9,17 +9,16 @@ 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 { defer, groupBy } from "../../utils";
+import { groupBy } from "../../utils";
 const DECISIONS_HANDLE = "personalization:decisions";
 export default (({
   prehidingStyle,
   showContainers,
   hideContainers,
   mergeQuery,
-  collect,
   processPropositions,
   createProposition,
-  renderedPropositions
+  notificationHandler
 }) => {
   return ({
     cacheUpdate,
@@ -33,21 +32,7 @@ export default (({
       showContainers();
     }
     mergeQuery(event, personalizationDetails.createQueryDetails());
-    let handleNotifications;
-    if (personalizationDetails.isSendDisplayEvent()) {
-      handleNotifications = decisionsMeta => {
-        if (decisionsMeta.length > 0) {
-          collect({
-            decisionsMeta,
-            viewName: personalizationDetails.getViewName()
-          });
-        }
-      };
-    } else {
-      const renderedPropositionsDeferred = defer();
-      renderedPropositions.concat(renderedPropositionsDeferred.promise);
-      handleNotifications = renderedPropositionsDeferred.resolve;
-    }
+    const handleNotifications = notificationHandler(personalizationDetails.isSendDisplayEvent(), personalizationDetails.getViewName());
     onResponse(({
       response
     }) => {

package/libEs6/components/Personalization/createNotificationHandler.js

@@ -0,0 +1,29 @@
+/*
+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 { defer } from "../../utils";
+export default ((collect, renderedPropositions) => {
+  return (sendDisplayEvent, viewName) => {
+    if (!sendDisplayEvent) {
+      const renderedPropositionsDeferred = defer();
+      renderedPropositions.concat(renderedPropositionsDeferred.promise);
+      return renderedPropositionsDeferred.resolve;
+    }
+    return decisionsMeta => {
+      if (decisionsMeta.length > 0) {
+        collect({
+          decisionsMeta,
+          viewName
+        });
+      }
+    };
+  };
+});

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 { INTERACT } from "./constants/eventType";
-import { PropositionEventType } from "./constants/propositionEventType";
-import PAGE_WIDE_SCOPE from "../../constants/pageWideScope";
+import { isNonEmptyArray } from "../../utils";
+import { INTERACT } from "../../constants/eventType";
+import { PropositionEventType } from "../../constants/propositionEventType";
 export default (({
   mergeDecisionsMeta,
   collectClicks,
@@ -29,22 +28,24 @@ 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
             }
           };
         }
         event.mergeXdm(xdm);
-        mergeDecisionsMeta(event, decisionsMeta, PropositionEventType.INTERACT, eventLabel);
+        mergeDecisionsMeta(event, decisionsMeta, [PropositionEventType.INTERACT], eventLabel ? {
+          label: eventLabel
+        } : undefined);
       }
     }
   };

package/libEs6/components/Personalization/createOnDecisionHandler.js

@@ -0,0 +1,42 @@
+/*
+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.
+*/
+
+export default (({
+  processPropositions,
+  createProposition,
+  notificationHandler
+}) => {
+  return ({
+    renderDecisions,
+    propositions,
+    event,
+    personalization = {}
+  }) => {
+    if (!renderDecisions) {
+      return Promise.resolve();
+    }
+    const {
+      sendDisplayEvent = true
+    } = personalization;
+    const viewName = event ? event.getViewName() : undefined;
+    const propositionsToExecute = propositions.map(proposition => createProposition(proposition, true));
+    const {
+      render,
+      returnedPropositions
+    } = processPropositions(propositionsToExecute);
+    const handleNotifications = notificationHandler(sendDisplayEvent, viewName);
+    render().then(handleNotifications);
+    return Promise.resolve({
+      propositions: returnedPropositions
+    });
+  };
+});

package/libEs6/components/Personalization/createPersonalizationDetails.js

@@ -13,7 +13,7 @@ governing permissions and limitations under the License.
 import { includes, isNonEmptyString, isNonEmptyArray } from "../../utils";
 import { buildPageSurface, normalizeSurfaces } from "./utils/surfaceUtils";
 import PAGE_WIDE_SCOPE from "../../constants/pageWideScope";
-import { DEFAULT_CONTENT_ITEM, DOM_ACTION, HTML_CONTENT_ITEM, JSON_CONTENT_ITEM, REDIRECT_ITEM } from "./constants/schema";
+import { DEFAULT_CONTENT_ITEM, DOM_ACTION, HTML_CONTENT_ITEM, MESSAGE_IN_APP, JSON_CONTENT_ITEM, REDIRECT_ITEM, RULESET_ITEM, MESSAGE_FEED_ITEM } from "../../constants/schema";
 const addPageWideScope = scopes => {
   if (!includes(scopes, PAGE_WIDE_SCOPE)) {
     scopes.push(PAGE_WIDE_SCOPE);
@@ -64,11 +64,11 @@ export default (({
         scopes.push(...personalization.decisionScopes);
       }
       const eventSurfaces = normalizeSurfaces(personalization.surfaces, getPageLocation, logger);
-      if (!this.isCacheInitialized() || personalization.requestPersonalization) {
+      if (this.shouldRequestDefaultPersonalization()) {
         addPageWideScope(scopes);
         addPageSurface(eventSurfaces, getPageLocation);
       }
-      const schemas = [DEFAULT_CONTENT_ITEM, HTML_CONTENT_ITEM, JSON_CONTENT_ITEM, REDIRECT_ITEM];
+      const schemas = [DEFAULT_CONTENT_ITEM, HTML_CONTENT_ITEM, JSON_CONTENT_ITEM, REDIRECT_ITEM, RULESET_ITEM, MESSAGE_IN_APP, MESSAGE_FEED_ITEM];
       if (includes(scopes, PAGE_WIDE_SCOPE)) {
         schemas.push(DOM_ACTION);
       }
@@ -82,10 +82,13 @@ export default (({
       return isCacheInitialized;
     },
     shouldFetchData() {
-      return this.hasScopes() || this.hasSurfaces() || personalization.requestPersonalization || !this.isCacheInitialized() && personalization.requestPersonalization !== false;
+      return this.hasScopes() || this.hasSurfaces() || this.shouldRequestDefaultPersonalization();
     },
     shouldUseCachedData() {
-      return this.hasViewName() && this.isCacheInitialized();
+      return this.hasViewName() && !this.shouldFetchData();
+    },
+    shouldRequestDefaultPersonalization() {
+      return personalization.defaultPersonalizationEnabled || !this.isCacheInitialized() && personalization.defaultPersonalizationEnabled !== false;
     }
   };
 });

package/libEs6/components/Personalization/createPreprocessors.js

@@ -0,0 +1,19 @@
+/*
+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 { DOM_ACTION } from "../../constants/schema";
+import remapHeadOffers from "./dom-actions/remapHeadOffers";
+import remapCustomCodeOffers from "./dom-actions/remapCustomCodeOffers";
+export default (() => {
+  return {
+    [DOM_ACTION]: [remapHeadOffers, remapCustomCodeOffers]
+  };
+});

package/libEs6/components/Personalization/createViewCacheManager.js

@@ -10,9 +10,10 @@ 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";
+import { assign, groupBy } from "../../utils";
 import defer from "../../utils/defer";
-import { DEFAULT_CONTENT_ITEM } from "./constants/schema";
+import { DEFAULT_CONTENT_ITEM } from "../../constants/schema";
+import { VIEW_SCOPE_TYPE } from "./constants/scopeType";
 export default (({
   createProposition
 }) => {
@@ -27,7 +28,7 @@ export default (({
       scope: viewName,
       scopeDetails: {
         characteristics: {
-          scopeType: "view"
+          scopeType: VIEW_SCOPE_TYPE
         }
       },
       items: [{
@@ -41,7 +42,16 @@ export default (({
   const createCacheUpdate = viewName => {
     const updateCacheDeferred = defer();
     cacheUpdateCreatedAtLeastOnce = true;
-    viewStoragePromise = viewStoragePromise.then(oldViewStorage => updateCacheDeferred.promise.catch(() => oldViewStorage));
+
+    // Additional updates will merge the new view propositions with the old.
+    // i.e. if there are new "cart" view propositions they will overwrite the
+    // old "cart" view propositions, but if there are no new "cart" view
+    // propositions the old "cart" view propositions will remain.
+    viewStoragePromise = viewStoragePromise.then(oldViewStorage => {
+      return updateCacheDeferred.promise.then(newViewStorage => {
+        return assign({}, oldViewStorage, newViewStorage);
+      }).catch(() => oldViewStorage);
+    });
     return {
       update(viewPropositions) {
         const viewPropositionsWithScope = viewPropositions.filter(proposition => proposition.getScope());

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/dom-actions/createRedirect.js

@@ -10,4 +10,13 @@ OF ANY KIND, either express or implied. See the License for the specific languag
 governing permissions and limitations under the License.
 */
 
-export default (window => url => window.location.replace(url));
+export default (window => (url, preserveHistory = false) => {
+  if (preserveHistory) {
+    window.location.href = url;
+  } else {
+    window.location.replace(url);
+  }
+  // Return a promise that never resolves because redirects never complete
+  // within the current page.
+  return new Promise(() => undefined);
+});