richie-education 2.29.2 → 2.29.3-dev48

package/js/widgets/Dashboard/components/DashboardItem/Order/DashboardItemSavePaymentMethod.spec.tsx

@@ -0,0 +1,116 @@
+/**
+ * Test suite for DashboardItem component with an order in the state TO_SAVE_PAYMENT_METHOD.
+ */
+import fetchMock from 'fetch-mock';
+import { screen } from '@testing-library/react';
+import { within } from '@testing-library/dom';
+import { RichieContextFactory as mockRichieContextFactory } from 'utils/test/factories/richie';
+import { CredentialOrderFactory } from 'utils/test/factories/joanie';
+import { OrderState } from 'types/Joanie';
+import { setupJoanieSession } from 'utils/test/wrappers/JoanieAppWrapper';
+import { render } from 'utils/test/render';
+import { DashboardTest } from 'widgets/Dashboard/components/DashboardTest';
+import { LearnerDashboardPaths } from 'widgets/Dashboard/utils/learnerRoutesPaths';
+import { BaseJoanieAppWrapper } from 'utils/test/wrappers/BaseJoanieAppWrapper';
+import { mockCourseProductWithOrder } from 'utils/test/mockCourseProductWithOrder';
+import { expectBannerError, expectNoBannerError } from 'utils/test/expectBanner';
+
+jest.mock('utils/context', () => ({
+  __esModule: true,
+  default: mockRichieContextFactory({
+    authentication: { backend: 'fonzie', endpoint: 'https://demo.endpoint' },
+    joanie_backend: { endpoint: 'https://joanie.endpoint' },
+  }).one(),
+}));
+
+describe('DashboardItem / Save Payment Methode State', () => {
+  setupJoanieSession();
+  beforeEach(() => {
+    fetchMock.get(
+      'begin:https://joanie.endpoint/api/v1.0/enrollments/',
+      { results: [], next: null, previous: null, count: null },
+      { overwriteRoutes: true },
+    );
+  });
+  afterEach(() => {
+    fetchMock.restore();
+  });
+
+  describe('non-writable', () => {
+    it('renders elements to explain that a payment method is missing', async () => {
+      const order = CredentialOrderFactory({
+        state: OrderState.TO_SAVE_PAYMENT_METHOD,
+      }).one();
+
+      fetchMock.get('begin:https://joanie.endpoint/api/v1.0/orders/', {
+        results: [order],
+        next: null,
+        previous: null,
+        count: null,
+      });
+
+      const { product } = mockCourseProductWithOrder(order);
+
+      render(<DashboardTest initialRoute={LearnerDashboardPaths.COURSES} />, {
+        wrapper: BaseJoanieAppWrapper,
+      });
+
+      const dashboardItem = await screen.findByTestId(`dashboard-item-order-${order.id}`);
+      within(dashboardItem).getByRole('heading', { level: 5, name: product.title });
+      within(dashboardItem).getByText('A payment method is missing');
+      within(dashboardItem).getByText(
+        'You must define a payment method to finalize your subscription.',
+      );
+      const link = within(dashboardItem).getByRole('link', { name: 'Define' });
+      expect(link).toHaveAttribute('href', `/courses/orders/${order.id}`);
+      await expectNoBannerError(
+        'You have to define a payment method to finalize your subscription.',
+      );
+    });
+  });
+
+  describe('writable', () => {
+    it('renders elements to explain that a payment method is missing', async () => {
+      const order = CredentialOrderFactory({
+        state: OrderState.TO_SAVE_PAYMENT_METHOD,
+      }).one();
+
+      fetchMock.get(
+        'https://joanie.endpoint/api/v1.0/orders/',
+        { results: [order], next: null, previous: null, count: null },
+        { overwriteRoutes: true },
+      );
+
+      const url = `begin:https://joanie.endpoint/api/v1.0/orders/?`;
+      fetchMock.get(url, [order]);
+
+      const { product } = mockCourseProductWithOrder(order);
+
+      render(
+        <DashboardTest initialRoute={LearnerDashboardPaths.ORDER.replace(':orderId', order.id)} />,
+        {
+          wrapper: BaseJoanieAppWrapper,
+        },
+      );
+
+      const dashboardItem = await screen.findByTestId(`dashboard-item-order-${order.id}`);
+      within(dashboardItem).getByRole('heading', { level: 5, name: product.title });
+      expect(
+        within(dashboardItem).queryByText('A payment method is missing'),
+      ).not.toBeInTheDocument();
+      expect(within(dashboardItem).queryByRole('link', { name: 'Define' })).not.toBeInTheDocument();
+      await expectBannerError('You have to define a payment method to finalize your subscription.');
+      const link = screen.getByRole('link', { name: 'define a payment method' });
+      expect(link).toHaveAttribute('href', '#dashboard-item-payment-method');
+
+      // The payment block should display information about the missing payment method
+      const paymentBlock = screen.getByTestId('dashboard-item-payment-method');
+      const title = within(paymentBlock).getByText('Payment');
+      expect(title.parentElement).toHaveClass('dashboard-splitted-card__item__title--dot');
+      within(paymentBlock).getByText(
+        'To finalize your subscription, you must define a payment method.',
+      );
+      within(paymentBlock).getByRole('button', { name: 'Define' });
+    });
+  });
+});

package/js/widgets/Dashboard/components/DashboardItem/Order/Installment/index.tsx

@@ -0,0 +1,175 @@
+import { Alert, Button, useModal, VariantType } from '@openfun/cunningham-react';
+import { defineMessages, FormattedMessage, useIntl } from 'react-intl';
+import classNames from 'classnames';
+import { CredentialOrder, CredentialProduct, OrderState } from 'types/Joanie';
+import { OrderHelper } from 'utils/OrderHelper';
+import { useCourseProduct } from 'hooks/useCourseProducts';
+import { OrderPaymentDetailsModal } from 'widgets/Dashboard/components/DashboardItem/Order/OrderPaymentDetailsModal';
+import { OrderPaymentRetryModal } from 'widgets/Dashboard/components/DashboardItem/Order/OrderPaymentRetryModal';
+import { SaleTunnel } from 'components/SaleTunnel';
+import { Spinner } from 'components/Spinner';
+import PaymentScheduleHelper from 'utils/PaymentScheduleHelper';
+
+const messages = defineMessages({
+  paymentTitle: {
+    id: 'components.DashboardItemOrder.Installment.paymentTitle',
+    description: 'Label for the payment block',
+    defaultMessage: 'Payment',
+  },
+  paymentMethodMissingMessage: {
+    id: 'components.DashboardItemOrder.Installment.paymentMethodMissingMessage',
+    description: 'Message displayed when payment method is missing',
+    defaultMessage: 'To finalize your subscription, you must define a payment method.',
+  },
+  paymentInactiveDescription: {
+    id: 'components.DashboardItemOrder.Installment.paymentInactiveDescription',
+    description:
+      'Explanation displayed when the order is not yet active and do not miss payment method',
+    defaultMessage:
+      'You will able to manage your payment installment here once your subscription is finalized.',
+  },
+  paymentNeededMessage: {
+    id: 'components.DashboardItemOrder.Installment.paymentNeededMessage',
+    description: 'Message displayed when payment is needed',
+    defaultMessage: 'A payment failed, please update your payment method',
+  },
+  paymentNeededButton: {
+    id: 'components.DashboardItemOrder.Installment.paymentNeededButton',
+    description: 'Button label for the payment needed message',
+    defaultMessage: 'Pay {amount}',
+  },
+  paymentLabel: {
+    id: 'components.DashboardItemOrder.Installment.paymentLabel',
+    description: 'Label for the payment block',
+    defaultMessage: 'You can see and manage all installments.',
+  },
+  paymentButton: {
+    id: 'components.DashboardItemOrder.Installment.paymentButton',
+    description: 'Button label for the payment block',
+    defaultMessage: 'Manage payment',
+  },
+  defineButton: {
+    id: 'components.DashboardItemOrder.Installment.defineButton',
+    description: 'Button label to define payment method',
+    defaultMessage: 'Define',
+  },
+});
+
+type Props = {
+  order: CredentialOrder;
+};
+
+const Installment = ({ order }: Props) => {
+  const isActive = OrderHelper.isActive(order);
+  const failedInstallment = PaymentScheduleHelper.getFailedInstallment(order.payment_schedule);
+  const needsPaymentMethod = order.state === OrderState.TO_SAVE_PAYMENT_METHOD;
+  const shouldDisplayDot = needsPaymentMethod || !!failedInstallment;
+
+  return (
+    <div
+      id="dashboard-item-payment-method"
+      data-testid="dashboard-item-payment-method"
+      className="dashboard-splitted-card__item"
+    >
+      <div
+        className={classNames('dashboard-splitted-card__item__title', {
+          'dashboard-splitted-card__item__title--dot': shouldDisplayDot,
+        })}
+      >
+        <span>
+          <FormattedMessage {...messages.paymentTitle} />
+        </span>
+      </div>
+      {!isActive && !needsPaymentMethod && (
+        <p className="dashboard-splitted-card__item__description">
+          <FormattedMessage {...messages.paymentInactiveDescription} />
+        </p>
+      )}
+      <PaymentMethodManager order={order} />
+      {isActive && <InstallmentManager order={order} />}
+    </div>
+  );
+};
+
+const PaymentMethodManager = ({ order }: Props) => {
+  const needsPaymentMethod = order.state === OrderState.TO_SAVE_PAYMENT_METHOD;
+  const { item: relation, states } = useCourseProduct({
+    course_id: order.course.code,
+    product_id: order.product_id,
+  });
+  const modal = useModal({ isOpenDefault: false });
+
+  if (!order || states.fetching) {
+    return <Spinner size="small" />;
+  }
+
+  return (
+    <>
+      {needsPaymentMethod && (
+        <div>
+          <p>
+            <FormattedMessage {...messages.paymentMethodMissingMessage} />
+          </p>
+          <Button size="small" onClick={modal.open}>
+            <FormattedMessage {...messages.defineButton} />
+          </Button>
+        </div>
+      )}
+      <SaleTunnel
+        {...modal}
+        product={relation.product as CredentialProduct}
+        course={relation.course}
+      />
+    </>
+  );
+};
+
+const InstallmentManager = ({ order }: Props) => {
+  const intl = useIntl();
+  const modal = useModal();
+  const retryModal = useModal();
+  const failedInstallment = PaymentScheduleHelper.getFailedInstallment(order.payment_schedule);
+
+  const pay = async () => {
+    retryModal.open();
+  };
+  return (
+    <>
+      {failedInstallment && (
+        <Alert
+          className="mb-t"
+          type={VariantType.ERROR}
+          buttons={
+            <Button size="small" onClick={pay}>
+              <FormattedMessage
+                {...messages.paymentNeededButton}
+                values={{
+                  amount: intl.formatNumber(failedInstallment.amount, {
+                    style: 'currency',
+                    currency: failedInstallment.currency,
+                  }),
+                }}
+              />
+            </Button>
+          }
+        >
+          <FormattedMessage {...messages.paymentNeededMessage} />
+        </Alert>
+      )}
+      <div className="dashboard-splitted-card__item__description">
+        <FormattedMessage {...messages.paymentLabel} />
+      </div>
+      <div className="dashboard-splitted-card__item__actions">
+        <Button size="small" color="secondary" onClick={modal.open}>
+          <FormattedMessage {...messages.paymentButton} />
+        </Button>
+      </div>
+      <OrderPaymentDetailsModal {...modal} order={order} />
+      {failedInstallment && (
+        <OrderPaymentRetryModal {...retryModal} installment={failedInstallment} order={order} />
+      )}
+    </>
+  );
+};
+
+export default Installment;

package/js/widgets/Dashboard/components/DashboardItem/Order/OrderPaymentDetailsModal/_styles.scss

@@ -0,0 +1,7 @@
+.order-payment-details {
+  &__title {
+    font-weight: var(--c--theme--font--weights--bold);
+    font-size: var(--c--theme--font--sizes--l);
+    text-align: left;
+  }
+}

package/js/widgets/Dashboard/components/DashboardItem/Order/OrderPaymentDetailsModal/index.tsx

@@ -0,0 +1,127 @@
+import {
+  Alert,
+  Button,
+  Loader,
+  Modal,
+  ModalProps,
+  ModalSize,
+  useModal,
+  VariantType,
+} from '@openfun/cunningham-react';
+import { defineMessages, FormattedMessage, useIntl } from 'react-intl';
+import { useState, useEffect } from 'react';
+import { PaymentScheduleGrid } from 'components/PaymentScheduleGrid';
+import { CreditCard, Order } from 'types/Joanie';
+import { CreditCardSelector } from 'components/CreditCardSelector';
+import { OrderPaymentRetryModal } from 'widgets/Dashboard/components/DashboardItem/Order/OrderPaymentRetryModal';
+import { Maybe } from 'types/utils';
+import { useCreditCard } from 'hooks/useCreditCards';
+import PaymentScheduleHelper from 'utils/PaymentScheduleHelper';
+
+const messages = defineMessages({
+  title: {
+    id: 'components.DashboardItemOrder.PaymentModal.title',
+    defaultMessage: 'Payment details',
+    description: 'Title of the payment modal',
+  },
+  scheduleTitle: {
+    id: 'components.DashboardItemOrder.PaymentModal.scheduleTitle',
+    defaultMessage: 'Payment schedule',
+    description: 'Title of the payment schedule',
+  },
+  paymentMethodTitle: {
+    id: 'components.DashboardItemOrder.PaymentModal.paymentMethodTitle',
+    defaultMessage: 'Payment method',
+    description: 'Title of the payment method section',
+  },
+  paymentNeededMessage: {
+    id: 'components.DashboardItemOrder.paymentNeededMessage',
+    description: 'Message displayed when payment is needed',
+    defaultMessage: 'The payment failed, please update your payment method',
+  },
+  paymentNeededButton: {
+    id: 'components.DashboardItemOrder.paymentNeededButton',
+    description: 'Button label for the payment needed message',
+    defaultMessage: 'Pay {amount}',
+  },
+});
+
+interface PaymentModalProps extends Pick<ModalProps, 'isOpen' | 'onClose'> {
+  order: Order;
+}
+
+export const OrderPaymentDetailsModal = ({ order, ...props }: PaymentModalProps) => {
+  const intl = useIntl();
+  const retryModal = useModal();
+  const failedInstallment = PaymentScheduleHelper.getFailedInstallment(order.payment_schedule);
+
+  return (
+    <>
+      <Modal {...props} size={ModalSize.MEDIUM} title={intl.formatMessage(messages.title)}>
+        <h3 className="order-payment-details__title mb-s">
+          <FormattedMessage {...messages.paymentMethodTitle} />
+        </h3>
+        <CreditCardSelectorWrapper selectedCreditCardId={order.credit_card_id} />
+        <h3 className="order-payment-details__title mb-s mt-b">
+          <FormattedMessage {...messages.scheduleTitle} />
+        </h3>
+        {failedInstallment && (
+          <Alert
+            className="mb-t"
+            type={VariantType.ERROR}
+            buttons={
+              <Button size="small" onClick={retryModal.open}>
+                <FormattedMessage
+                  {...messages.paymentNeededButton}
+                  values={{
+                    amount: intl.formatNumber(failedInstallment.amount, {
+                      style: 'currency',
+                      currency: failedInstallment.currency,
+                    }),
+                  }}
+                />
+              </Button>
+            }
+          >
+            <FormattedMessage {...messages.paymentNeededMessage} />
+          </Alert>
+        )}
+        {order.payment_schedule && <PaymentScheduleGrid schedule={order.payment_schedule} />}
+      </Modal>
+      {failedInstallment && (
+        <OrderPaymentRetryModal {...retryModal} installment={failedInstallment} order={order} />
+      )}
+    </>
+  );
+};
+
+const CreditCardSelectorWrapper = ({
+  selectedCreditCardId,
+}: {
+  selectedCreditCardId: Maybe<string>;
+}) => {
+  const {
+    item: creditCard,
+    states: { fetching },
+  } = useCreditCard(selectedCreditCardId);
+  const [selectedCreditCard, setSelectedCreditCard] = useState<Maybe<CreditCard>>(creditCard);
+
+  useEffect(() => {
+    if (!selectedCreditCard && creditCard) {
+      setSelectedCreditCard(creditCard);
+    }
+  }, [creditCard]);
+
+  if (fetching) {
+    return <Loader size="small" />;
+  }
+
+  return (
+    <CreditCardSelector
+      creditCard={selectedCreditCard || creditCard}
+      setCreditCard={setSelectedCreditCard}
+      quickRemove={false}
+      allowEdit={false}
+    />
+  );
+};

package/js/widgets/Dashboard/components/DashboardItem/Order/OrderPaymentRetryModal/index.tsx

@@ -0,0 +1,216 @@
+import {
+  Alert,
+  Button,
+  Modal,
+  ModalProps,
+  ModalSize,
+  useModals,
+  VariantType,
+} from '@openfun/cunningham-react';
+import { defineMessages, FormattedMessage, useIntl } from 'react-intl';
+import { useRef, useState } from 'react';
+import {
+  CreditCard,
+  Order,
+  OrderEnrollment,
+  PaymentInstallment,
+  ACTIVE_ORDER_STATES,
+} from 'types/Joanie';
+import { CreditCardSelector } from 'components/CreditCardSelector';
+import { useJoanieApi } from 'contexts/JoanieApiContext';
+import { Payment, PaymentErrorMessageId } from 'components/PaymentInterfaces/types';
+import PaymentInterface from 'components/PaymentInterfaces';
+import { PAYMENT_SETTINGS } from 'settings';
+import { useOrders } from 'hooks/useOrders';
+import { Spinner } from 'components/Spinner';
+
+const messages = defineMessages({
+  title: {
+    id: 'components.DashboardItemOrder.OrderPaymentRetryModal.title',
+    defaultMessage: 'Retry payment',
+    description: 'Title of the payment retry modal',
+  },
+  description: {
+    id: 'components.DashboardItemOrder.OrderPaymentRetryModal.description',
+    defaultMessage:
+      'The payment failed, please choose another payment method or add a new one during the payment',
+    description: 'Message displayed when payment is needed',
+  },
+  submit: {
+    id: 'components.DashboardItemOrder.OrderPaymentRetryModal.submit',
+    defaultMessage: 'Pay {amount}',
+    description: 'Message displayed when payment is needed',
+  },
+  paymentInProgress: {
+    defaultMessage: 'Payment in progress',
+    description: 'Label for screen reader when a retry payment is in progress.',
+    id: 'components.DashboardItemOrder.OrderPaymentRetryModal.paymentInProgress',
+  },
+  successTitle: {
+    defaultMessage: 'Payment successful',
+    description: 'Title of the payment success modal',
+    id: 'components.DashboardItemOrder.OrderPaymentRetryModal.successTitle',
+  },
+  successDescription: {
+    defaultMessage: 'The payment was successful',
+    description: 'Description of the payment success modal',
+    id: 'components.DashboardItemOrder.OrderPaymentRetryModal.successDescription',
+  },
+  errorFailedSubmitInstallmentPayment: {
+    defaultMessage: 'Failed to submit installment payment, please retry later.',
+    description: 'Error message when submitting installment payment fails',
+    id: 'components.DashboardItemOrder.OrderPaymentRetryModal.errorFailedSubmitInstallmentPayment',
+  },
+  errorAbortingPolling: {
+    defaultMessage:
+      'Your payment has succeeded but your order validation is taking too long, you can close this dialog and come back later.',
+    description: 'Error message when submitting installment payment fails',
+    id: 'components.DashboardItemOrder.OrderPaymentRetryModal.errorAbortingPolling',
+  },
+});
+
+interface Props extends Pick<ModalProps, 'isOpen' | 'onClose'> {
+  installment: PaymentInstallment;
+  order: Order | OrderEnrollment;
+}
+
+enum ComponentStates {
+  IDLE = 'idle',
+  LOADING = 'loading',
+  ERROR = 'error',
+}
+
+export const OrderPaymentRetryModal = ({ installment, order, ...props }: Props) => {
+  const intl = useIntl();
+  const API = useJoanieApi();
+  const timeoutRef = useRef<NodeJS.Timeout>();
+  const { methods: orderMethods } = useOrders(undefined, { enabled: false });
+  const [payment, setPayment] = useState<Payment>();
+  const [state, setState] = useState<ComponentStates>(ComponentStates.IDLE);
+  const [error, setError] = useState<string>();
+  const [creditCard, setCreditCard] = useState<CreditCard>();
+  const modals = useModals();
+
+  const pay = async () => {
+    setState(ComponentStates.LOADING);
+    try {
+      const paymentResponse = await API.user.orders.submit_installment_payment(order.id, {
+        credit_card_id: creditCard?.id,
+      });
+      if (paymentResponse) {
+        setPayment(paymentResponse);
+      } else {
+        // In case of bug.
+        setError(intl.formatMessage(messages.errorFailedSubmitInstallmentPayment));
+        setState(ComponentStates.ERROR);
+      }
+      // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    } catch (_error) {
+      setError(intl.formatMessage(messages.errorFailedSubmitInstallmentPayment));
+      setState(ComponentStates.ERROR);
+    }
+  };
+
+  const handleError = (messageId: string = PaymentErrorMessageId.ERROR_DEFAULT) => {
+    setState(ComponentStates.ERROR);
+    setError(messageId);
+  };
+
+  const isOrderValidated = async (id: string): Promise<Boolean> => {
+    const orderToCheck = await API.user.orders.get({ id });
+    return orderToCheck !== null && ACTIVE_ORDER_STATES.includes(orderToCheck.state);
+  };
+
+  const settled = async () => {
+    await orderMethods.invalidate();
+    props.onClose();
+    await modals.messageModal({
+      messageType: VariantType.SUCCESS,
+      title: intl.formatMessage(messages.successTitle),
+      children: intl.formatMessage(messages.successDescription),
+    });
+  };
+
+  const handleSuccess = () => {
+    let round = 0;
+
+    const checkOrderValidity = async () => {
+      if (round >= PAYMENT_SETTINGS.pollLimit) {
+        timeoutRef.current = undefined;
+        setState(ComponentStates.ERROR);
+        setError(intl.formatMessage(messages.errorAbortingPolling));
+      } else {
+        const isValidated = await isOrderValidated(order.id);
+        if (isValidated) {
+          setState(ComponentStates.IDLE);
+          timeoutRef.current = undefined;
+          settled();
+        } else {
+          round++;
+          timeoutRef.current = setTimeout(checkOrderValidity, PAYMENT_SETTINGS.pollInterval);
+        }
+      }
+    };
+
+    checkOrderValidity();
+  };
+
+  return (
+    <>
+      <Modal
+        {...props}
+        size={ModalSize.MEDIUM}
+        title={intl.formatMessage(messages.title)}
+        closeOnEsc={state !== ComponentStates.LOADING}
+        preventClose={state === ComponentStates.LOADING}
+        hideCloseButton={state === ComponentStates.LOADING}
+        actions={
+          <Button
+            color="primary"
+            size="small"
+            fullWidth={true}
+            onClick={pay}
+            disabled={state === ComponentStates.LOADING}
+            data-testid="order-payment-retry-modal-submit-button"
+          >
+            {state === ComponentStates.LOADING ? (
+              <Spinner theme="light" aria-labelledby="payment-in-progress">
+                <span id="payment-in-progress">
+                  <FormattedMessage {...messages.paymentInProgress} />
+                </span>
+              </Spinner>
+            ) : (
+              <FormattedMessage
+                {...messages.submit}
+                values={{
+                  amount: intl.formatNumber(installment.amount, {
+                    style: 'currency',
+                    currency: installment.currency,
+                  }),
+                }}
+              />
+            )}
+          </Button>
+        }
+      >
+        {error && (
+          <Alert type={VariantType.ERROR} className="mb-t">
+            {error}
+          </Alert>
+        )}
+        <Alert className="mb-b">
+          <FormattedMessage {...messages.description} />
+        </Alert>
+        <CreditCardSelector
+          creditCard={creditCard}
+          setCreditCard={setCreditCard}
+          quickRemove={state !== ComponentStates.LOADING}
+          allowEdit={state !== ComponentStates.LOADING}
+        />
+      </Modal>
+      {state === ComponentStates.LOADING && payment && (
+        <PaymentInterface {...payment} onError={handleError} onSuccess={handleSuccess} />
+      )}
+    </>
+  );
+};