@shopgate/pwa-common 7.32.0-beta.2 → 7.32.0-beta.20

package/providers/toast/index.js

@@ -32,47 +32,41 @@ let ToastProvider = /*#__PURE__*/function (_Component) {
       if (!toast.message) {
         return;
       }
-      const {
-        toasts
-      } = _this.state;
-
-      // Check if the toast id already is present.
-      const found = toasts.find(({
-        id
-      }) => toast.id === id);
+      const nextToast = {
+        id: toast.id,
+        action: toast.action,
+        actionLabel: toast.actionLabel,
+        onLongPress: toast.onLongPress,
+        message: toast.message,
+        messageParams: toast.messageParams,
+        duration: toast.duration || _this.props.theme.transitions.duration.toast
+      };
 
-      // If found, update the toast with the new data.
-      if (found) {
-        found.action = toast.action;
-        found.actionLabel = toast.actionLabel;
-        found.message = toast.message;
-        found.messageParams = toast.messageParams;
-        found.duration = toast.duration || _this.props.theme.transitions.duration.toast;
-      } else {
-        toasts.push({
-          id: toast.id,
-          action: toast.action,
-          actionLabel: toast.actionLabel,
-          message: toast.message,
-          messageParams: toast.messageParams,
-          duration: toast.duration || _this.props.theme.transitions.duration.toast
-        });
-      }
-      _this.setState({
+      // Update the queue immutably: consumers rely on the array reference changing to re-render
+      // (e.g. the SnackBar memoizes the currently shown toast on this reference). A toast whose id
+      // is already queued replaces that entry with the new data; otherwise it is appended.
+      _this.setState(({
         toasts
+      }) => {
+        const exists = toasts.some(({
+          id
+        }) => id === toast.id);
+        return {
+          toasts: exists ? toasts.map(item => item.id === toast.id ? nextToast : item) : [].concat(toasts, [nextToast])
+        };
       });
     };
     /**
      * Removes the first toast from the list.
      */
     _this.removeToast = () => {
-      const {
-        toasts
-      } = _this.state;
-      toasts.shift();
-      _this.setState({
+      // Drop the first toast immutably so the array reference changes and the SnackBar advances to
+      // the next queued toast (rather than re-rendering the same, now-stale, memoized toast).
+      _this.setState(({
         toasts
-      });
+      }) => ({
+        toasts: toasts.slice(1)
+      }));
     };
     _this.flushToasts = () => {
       if (_this.state.toasts.length) {
@@ -90,11 +84,21 @@ let ToastProvider = /*#__PURE__*/function (_Component) {
   }
 
   /**
-   * Returns the context value to be passed to consumers.
-   * @returns {Object}
+   * Removes the UIEvents listeners registered in the constructor.
    */
   _inheritsLoose(ToastProvider, _Component);
   var _proto = ToastProvider.prototype;
+  _proto.componentWillUnmount = function componentWillUnmount() {
+    UIEvents.removeListener(this.constructor.ADD, this.addToast);
+    UIEvents.removeListener(this.constructor.FLUSH, this.flushToasts);
+  }
+
+  /**
+   * Returns the context value to be passed to consumers. The object reference is cached and only
+   * rebuilt when `toasts` changes, so consumers (Toaster → SnackBarContainer → SnackBar) don't
+   * re-render on every unrelated ToastProvider render.
+   * @returns {Object}
+   */;
   /**
    * @returns {JSX}
    */
@@ -107,14 +111,24 @@ let ToastProvider = /*#__PURE__*/function (_Component) {
   return _createClass(ToastProvider, [{
     key: "provided",
     get: function () {
-      return {
-        addToast: this.addToast,
-        removeToast: this.removeToast,
-        toasts: this.state.toasts
-      };
+      if (!this.providedCache || this.providedCache.toasts !== this.state.toasts) {
+        this.providedCache = {
+          addToast: this.addToast,
+          removeToast: this.removeToast,
+          toasts: this.state.toasts
+        };
+      }
+      return this.providedCache;
     }
   }]);
 }(Component);
 ToastProvider.ADD = 'toast_add';
 ToastProvider.FLUSH = 'toast_flush';
-export default withTheme(ToastProvider);
+const ThemedToastProvider = withTheme(ToastProvider);
+
+// The HOC returns a new component which doesn't carry over the statics of the wrapped class. They
+// are part of the public API of this module (consumers emit UIEvents on ToastProvider.ADD), so they
+// are re-attached explicitly.
+ThemedToastProvider.ADD = ToastProvider.ADD;
+ThemedToastProvider.FLUSH = ToastProvider.FLUSH;
+export default ThemedToastProvider;

package/subscriptions/error.js

@@ -1,7 +1,4 @@
 import "core-js/modules/es.array.includes.js";
-import after from 'lodash/after';
-import before from 'lodash/before';
-import over from 'lodash/over';
 import { isAvailable } from '@shopgate/native-modules';
 import { init, addBreadcrumb, configureScope, captureException, captureMessage, captureEvent, withScope, Severity as SentrySeverity } from '@sentry/browser';
 import { EBIGAPI, emitter, errorManager, ETIMEOUT, ENETUNREACH, EUNKNOWN, EFAVORITE } from '@shopgate/pwa-core';
@@ -12,7 +9,7 @@ import {
 // eslint-disable-next-line import/no-named-default
 default as appConfig, themeName, pckVersion } from "../helpers/config";
 import { env } from "../helpers/environment";
-import { transformGeneralPipelineError } from "./helpers/pipeline";
+import { transformGeneralPipelineError, getDisplayErrorMessage } from "./helpers/pipeline";
 import { historyPop } from "../actions/router";
 import showModal from "../actions/modal/showModal";
 import { getUserData } from "../selectors/user";
@@ -24,6 +21,9 @@ import { getRouterStack } from "../selectors/router";
 import { MODAL_PIPELINE_ERROR } from "../constants/ModalTypes";
 import ToastProvider from "../providers/toast";
 
+// Generic, translated fallback shown when a backend error carries no code we can map to a message.
+const GENERIC_ERROR_MESSAGE = 'modal.body_error';
+
 /**
  * App errors subscriptions.
  * @param {Function} subscribe The subscribe function.
@@ -60,15 +60,35 @@ export default subscribe => {
       error
     } = action;
     const {
-      message,
       code,
       context,
       meta = {}
     } = error;
     const {
-      behavior
+      behavior,
+      message: originalMessage
     } = meta;
-    if (behavior) {
+
+    // Never surface a raw backend message to the user: show the extension's own translated
+    // message, a code-mapped translated message, or a generic fallback. The resolver is the single
+    // source of truth for both the text and whether it is ready-to-display (`displayTranslated`) or
+    // a locale key that must still go through I18n.Text.
+    const {
+      message: displayMessage,
+      translated: displayTranslated
+    } = getDisplayErrorMessage(error, GENERIC_ERROR_MESSAGE);
+
+    // Unknown/generic and connection-style backend errors are treated as general platform issues.
+    // EUNKNOWN is always treated as general — even when the backend supplied a translated message —
+    // so it is shown as a toast with its translated message or generic fallback, never a modal.
+    const isConnectionError = displayMessage === 'error.general' || [ETIMEOUT, ENETUNREACH].includes(code);
+    const isGeneralError = isConnectionError || displayMessage === GENERIC_ERROR_MESSAGE || code === EUNKNOWN;
+
+    // Some pipeline actions (e.g. fetchCategory) register an error behavior for *every* error via
+    // `setResponseBehavior`. Those behaviors are only meaningful for the specific errors they
+    // expect; when the platform fails with an unexpected/unmappable message we skip the behavior
+    // and fall through to the generic toast handling instead of, for example, showing a modal.
+    if (behavior && !isGeneralError) {
       behavior({
         dispatch,
         getState,
@@ -78,38 +98,41 @@ export default subscribe => {
       return;
     }
 
-    /** Show modal thunk */
-    const showModalError = () => {
+    /**
+     * Shows the pipeline error modal. When openWithDetails is set, the modal opens directly on the
+     * developer detail view (pipeline, code, raw message, params) — used for the toast long-press.
+     * @param {boolean} [openWithDetails=false] Whether to open the modal in developer detail mode.
+     */
+    const showModalError = (openWithDetails = false) => {
       dispatch(showModal({
         confirm: 'modal.ok',
         dismiss: null,
         title: null,
-        message,
+        message: displayMessage,
         type: MODAL_PIPELINE_ERROR,
         params: {
           pipeline: context,
           request: meta.input,
-          message: meta.message,
-          code
+          message: originalMessage,
+          code,
+          translated: displayTranslated,
+          messageParams: meta.additionalParams,
+          openWithDetails
         }
       }));
     };
-    let shouldShowToast = message === 'error.general';
-    if ([ETIMEOUT, ENETUNREACH].includes(code) && message === 'modal.body_error') {
-      shouldShowToast = true;
-    }
-    // It was transformed general error. let it popup after 10 toast clicks
-    if (shouldShowToast) {
-      const showToastAfter = after(9, showModalError);
-      // Recursively show same toast message until clicked 10 times
-      const showToast = before(10, () => {
-        events.emit(ToastProvider.ADD, {
-          id: 'pipeline.error',
-          message: 'error.general',
-          action: over([showToast, showToastAfter])
-        });
+
+    // General platform errors surface as a toast instead of a modal.
+    // Long-pressing the toast opens the error modal in developer detail mode.
+    if (isGeneralError) {
+      // Connection-style errors show the generic connection message, but never override a message
+      // an extension already translated for us.
+      const useGenericConnectionText = isConnectionError && !displayTranslated;
+      events.emit(ToastProvider.ADD, {
+        id: 'pipeline.error',
+        message: useGenericConnectionText ? 'error.general' : displayMessage,
+        onLongPress: () => showModalError(true)
       });
-      showToast();
       return;
     }
     showModalError();

package/subscriptions/helpers/pipeline.js

@@ -1,3 +1,5 @@
+import { i18n } from '@shopgate/engage/core/helpers';
+
 /**
  * @param {Object} error error
  * @returns {string|*}
@@ -12,4 +14,70 @@ export function transformGeneralPipelineError(error) {
     return 'error.general';
   }
   return message;
+}
+
+/**
+ * @typedef {Object} DisplayErrorMessage
+ * @property {string} message The text to display — an already-translated string or a locale key.
+ * @property {boolean} translated Whether `message` is ready-to-display text (`true`) or a locale
+ *   key that still needs to go through I18n.Text (`false`).
+ */
+
+/**
+ * Resolves the message to display for a pipeline error, without ever surfacing raw backend text.
+ * Also reports whether the result is ready-to-display text or a locale key
+ * Precedence:
+ * 1. An extension's own message when it is explicitly flagged as already translated.
+ * 2. A resolvable i18n key — safe to surface even when errorManager did not remap it, because a
+ *    translation key (e.g. `cart.error_out_of_stock`) is not raw backend text. `i18n.has` confirms
+ *    the key actually resolves in the loaded locales, rather than merely looking like a key.
+ * 3. The code-mapped message. When errorManager maps the error code it resolves a message that
+ *    differs from the raw backend text (`error.meta.message`).
+ * 4. A generic, translated fallback otherwise — including when nothing mapped and errorManager fell
+ *    back to the raw backend message (`error.message === error.meta.message`).
+ * @param {Object} error The queued pipeline error.
+ * @param {string} error.message The message resolved by errorManager (code-mapped or raw fallback).
+ * @param {Object} [error.meta] The error meta data.
+ * @param {boolean} [error.meta.translated] Whether the backend message is already translated.
+ * @param {string} [error.meta.message] The original, raw backend message.
+ * @param {string} genericMessage The generic fallback message key.
+ * @returns {DisplayErrorMessage}
+ */
+export function getDisplayErrorMessage(error, genericMessage) {
+  const {
+    message,
+    meta = {}
+  } = error;
+  const {
+    translated,
+    message: originalMessage
+  } = meta;
+  if (translated && originalMessage) {
+    return {
+      message: originalMessage,
+      translated: true
+    };
+  }
+
+  // A translation key is never raw backend text, so surface it even when errorManager left it
+  // untouched (`message === originalMessage`).
+  if (typeof message === 'string' && i18n.has(message)) {
+    return {
+      message,
+      translated: false
+    };
+  }
+
+  // Only trust `message` when we have the raw backend message to compare against and a mapping
+  // actually replaced it. Without the raw message we cannot rule out that `message` is raw text.
+  if (originalMessage !== undefined && message !== originalMessage) {
+    return {
+      message,
+      translated: false
+    };
+  }
+  return {
+    message: genericMessage,
+    translated: false
+  };
 }

package/subscriptions/router.js

@@ -9,7 +9,7 @@ import Route from '@virtuous/conductor/Route';
 import { Linking } from '@shopgate/native-modules';
 import { HISTORY_RESET_TO } from '@shopgate/pwa-common/constants/ActionTypes';
 import { logger } from '@shopgate/pwa-core';
-import { isPageAdminPreviewActive } from '@shopgate/engage/admin-preview/helpers';
+import { isNavigationBlocked } from '@shopgate/engage/admin-preview/helpers';
 import addCouponsToCart from '@shopgate/pwa-common-commerce/cart/actions/addCouponsToCart';
 import { getCurrentRoute, getRouterStackIndex } from "../selectors/router";
 import { LoadingProvider } from "../providers";
@@ -31,7 +31,7 @@ import ToastProvider from "../providers/toast";
  */
 export default function routerSubscriptions(subscribe) {
   subscribe(navigate$, async params => {
-    if (isPageAdminPreviewActive()) {
+    if (isNavigationBlocked()) {
       // No navigation is allowed in page preview mode.
       return;
     }

package/action-creators/app/spec.js

@@ -1,96 +0,0 @@
-import { APP_WILL_START, APP_DID_START, PWA_DID_APPEAR, PWA_DID_DISAPPEAR, WILL_REGISTER_LINK_EVENTS, DID_REGISTER_LINK_EVENTS, OPEN_DEEP_LINK, OPEN_PUSH_NOTIFICATION, OPEN_UNIVERSAL_LINK } from "../../constants/ActionTypes";
-import { appWillStart, appDidStart, pwaDidAppear, pwaDidDisappear, willRegisterLinkEvents, didRegisterLinkEvents, openDeepLink, openPushNotification, openUniversalLink } from "./index";
-const dataMock = {
-  some: 'data'
-};
-describe('Action Creators: app', () => {
-  describe('appWillStart()', () => {
-    it('should work as expected', () => {
-      const expected = {
-        type: APP_WILL_START,
-        location: dataMock
-      };
-      expect(appWillStart(dataMock)).toEqual(expected);
-    });
-  });
-  describe('appDidStart()', () => {
-    it('should work as expected', () => {
-      const expected = {
-        type: APP_DID_START
-      };
-      expect(appDidStart()).toEqual(expected);
-    });
-  });
-  describe('pwaDidAppear()', () => {
-    it('should work as expected', () => {
-      const expected = {
-        type: PWA_DID_APPEAR
-      };
-      expect(pwaDidAppear()).toEqual(expected);
-    });
-  });
-  describe('pwaDidDisappear()', () => {
-    it('should work as expected', () => {
-      const expected = {
-        type: PWA_DID_DISAPPEAR
-      };
-      expect(pwaDidDisappear()).toEqual(expected);
-    });
-  });
-  describe('willRegisterLinkEvents()', () => {
-    it('should work as expected', () => {
-      const expected = {
-        type: WILL_REGISTER_LINK_EVENTS
-      };
-      expect(willRegisterLinkEvents()).toEqual(expected);
-    });
-  });
-  describe('didRegisterLinkEvents()', () => {
-    it('should work as expected', () => {
-      const expected = {
-        type: DID_REGISTER_LINK_EVENTS
-      };
-      expect(didRegisterLinkEvents()).toEqual(expected);
-    });
-  });
-  describe('openDeepLink()', () => {
-    it('should work as expected', () => {
-      const expected = {
-        type: OPEN_DEEP_LINK,
-        payload: dataMock
-      };
-      expect(openDeepLink(dataMock)).toEqual(expected);
-    });
-  });
-  describe('openPushNotification()', () => {
-    const notificationId = 'abc123';
-    const link = '/link/to/somewhere';
-    it('should work as expected', () => {
-      const expected = {
-        type: OPEN_PUSH_NOTIFICATION,
-        notificationId,
-        link
-      };
-      expect(openPushNotification(notificationId, link)).toEqual(expected);
-    });
-    it('should work as expected when the link is empty', () => {
-      const expected = {
-        type: OPEN_PUSH_NOTIFICATION,
-        notificationId,
-        link: ''
-      };
-      expect(openPushNotification(notificationId)).toEqual(expected);
-    });
-  });
-  describe('openUniversalLink()', () => {
-    const expected = {
-      type: OPEN_UNIVERSAL_LINK,
-      payload: {
-        link: 'https://testshop.shopgate.com/item/313131313132',
-        wasOpenedFromSearchIndex: true,
-        linkSerial: 1003
-      }
-    };
-    expect(openUniversalLink(expected.payload)).toEqual(expected);
-  });
-});

package/action-creators/client/spec.js

@@ -1,44 +0,0 @@
-import { requestClientInformation, receiveClientInformation, errorClientInformation, receiveClientConnectivity } from "./index";
-import { REQUEST_CLIENT_INFORMATION, RECEIVE_CLIENT_INFORMATION, ERROR_CLIENT_INFORMATION, RECEIVE_CLIENT_CONNECTIVITY } from "../../constants/ActionTypes";
-describe('Action Creators: client', () => {
-  describe('requestClientInformation()', () => {
-    it('should work as expected', () => {
-      const expected = {
-        type: REQUEST_CLIENT_INFORMATION
-      };
-      expect(requestClientInformation()).toEqual(expected);
-    });
-  });
-  describe('receiveClientInformation()', () => {
-    it('should work as expected', () => {
-      const data = {
-        some: 'data'
-      };
-      const expected = {
-        type: RECEIVE_CLIENT_INFORMATION,
-        data
-      };
-      expect(receiveClientInformation(data)).toEqual(expected);
-    });
-  });
-  describe('errorClientInformation()', () => {
-    it('should work as expected', () => {
-      const expected = {
-        type: ERROR_CLIENT_INFORMATION
-      };
-      expect(errorClientInformation()).toEqual(expected);
-    });
-  });
-  describe('receiveClientConnectivity()', () => {
-    it('should work as expected', () => {
-      const data = {
-        some: 'data'
-      };
-      const expected = {
-        type: RECEIVE_CLIENT_CONNECTIVITY,
-        data
-      };
-      expect(receiveClientConnectivity(data)).toEqual(expected);
-    });
-  });
-});

package/action-creators/menu/spec.js

@@ -1,37 +0,0 @@
-import { REQUEST_MENU, RECEIVE_MENU, ERROR_MENU } from "../../constants/ActionTypes";
-import { requestMenu, receiveMenu, errorMenu } from "./index";
-const entries = [{
-  url: '/',
-  label: 'Page Label'
-}];
-const id = 'quicklinks';
-describe('Action Creators: menu', () => {
-  describe('requestMenu()', () => {
-    it('should work as expected', () => {
-      const expected = {
-        type: REQUEST_MENU,
-        id
-      };
-      expect(requestMenu(id)).toEqual(expected);
-    });
-  });
-  describe('receiveMenu()', () => {
-    it('should work as expected', () => {
-      const expected = {
-        type: RECEIVE_MENU,
-        id,
-        entries
-      };
-      expect(receiveMenu(id, entries)).toEqual(expected);
-    });
-  });
-  describe('errorMenu()', () => {
-    it('should work as expected', () => {
-      const expected = {
-        type: ERROR_MENU,
-        id
-      };
-      expect(errorMenu(id)).toEqual(expected);
-    });
-  });
-});

package/action-creators/modal/spec.js

@@ -1,26 +0,0 @@
-import { CREATE_MODAL, REMOVE_MODAL } from "../../constants/ActionTypes";
-import { createModal, removeModal } from "./index";
-const options = {
-  some: 'data'
-};
-const id = 'modalId';
-describe('Action Creators: modal', () => {
-  describe('createModal()', () => {
-    it('should work as expected', () => {
-      const expected = {
-        type: CREATE_MODAL,
-        options
-      };
-      expect(createModal(options)).toEqual(expected);
-    });
-  });
-  describe('removeModal()', () => {
-    it('should work as expected', () => {
-      const expected = {
-        type: REMOVE_MODAL,
-        id
-      };
-      expect(removeModal(id)).toEqual(expected);
-    });
-  });
-});

package/action-creators/page/spec.js

@@ -1,38 +0,0 @@
-import { REQUEST_PAGE_CONFIG, RECEIVE_PAGE_CONFIG, ERROR_PAGE_CONFIG } from "../../constants/ActionTypes";
-import { requestPageConfig, receivePageConfig, errorPageConfig } from "./index";
-const pageId = 'index';
-const config = {
-  some: 'data'
-};
-describe('Action Creators: page', () => {
-  describe('requestPageConfig()', () => {
-    it('should work as expected', () => {
-      const expected = {
-        type: REQUEST_PAGE_CONFIG,
-        pageId
-      };
-      expect(requestPageConfig(pageId)).toEqual(expected);
-    });
-  });
-  describe('receivePageConfig()', () => {
-    it('should work as expected', () => {
-      const expected = {
-        type: RECEIVE_PAGE_CONFIG,
-        pageId,
-        config
-      };
-      expect(receivePageConfig(pageId, config)).toEqual(expected);
-    });
-  });
-  describe('errorPageConfig()', () => {
-    it('should work as expected', () => {
-      const errorCode = 'error';
-      const expected = {
-        type: ERROR_PAGE_CONFIG,
-        errorCode,
-        pageId
-      };
-      expect(errorPageConfig(pageId, errorCode)).toEqual(expected);
-    });
-  });
-});

package/action-creators/url/spec.js

@@ -1,45 +0,0 @@
-import { RECEIVE_URL, REQUEST_URL, ERROR_URL } from "../../constants/ActionTypes";
-import { receiveUrl, requestUrl, errorUrl } from "./index";
-const url = 'https://www.myshop.com/checkout';
-const urlType = 'checkout';
-const expires = 123456;
-describe('Action Creators: url', () => {
-  describe('receiveUrl()', () => {
-    it('should work as expected', () => {
-      const expected = {
-        type: RECEIVE_URL,
-        url,
-        urlType,
-        expires
-      };
-      expect(receiveUrl(urlType, url, expires)).toEqual(expected);
-    });
-    it('should work as expected when no expires parameter is passed', () => {
-      const expected = {
-        type: RECEIVE_URL,
-        url,
-        urlType,
-        expires: null
-      };
-      expect(receiveUrl(urlType, url)).toEqual(expected);
-    });
-  });
-  describe('requestUrl()', () => {
-    it('should work as expected', () => {
-      const expected = {
-        type: REQUEST_URL,
-        urlType
-      };
-      expect(requestUrl(urlType)).toEqual(expected);
-    });
-  });
-  describe('errorUrl()', () => {
-    it('should work as expected', () => {
-      const expected = {
-        type: ERROR_URL,
-        urlType
-      };
-      expect(errorUrl(urlType)).toEqual(expected);
-    });
-  });
-});