Merge pull request #11 from farrah-deriv/P2PS-726/refactor-nickname-form

farrah/P2PS-726/refactor nickname form

packages/p2p/src/components/app-content.jsx

@@ -1,6 +1,6 @@
 import * as React from 'react';
 import { isMobile } from '@deriv/shared';
-import { Loading, Tabs } from '@deriv/components';
+import { Loading, MobileWrapper, Tabs } from '@deriv/components';
 import { useStore } from '@deriv/stores';
 import { isAction, reaction } from 'mobx';
 import { observer } from 'mobx-react-lite';
@@ -56,7 +56,11 @@ const AppContent = ({ order_id }) => {
     }
 
     if (general_store.should_show_popup) {
-        return <NicknameForm />;
+        return (
+            <MobileWrapper>
+                <NicknameForm />
+            </MobileWrapper>
+        );
     }
 
     if (buy_sell_store?.show_advertiser_page && !buy_sell_store.should_show_verification) {

packages/p2p/src/components/modal-manager/modals/nickname-modal/index.ts

@@ -0,0 +1,3 @@
+import NicknameModal from './nickname-modal';
+
+export default NicknameModal;

packages/p2p/src/components/modal-manager/modals/nickname-modal/nickname-modal.tsx

@@ -0,0 +1,26 @@
+import React from 'react';
+import { Modal } from '@deriv/components';
+import { useModalManagerContext } from 'Components/modal-manager/modal-manager-context';
+import NicknameForm from 'Components/nickname-form';
+import { useStores } from 'Stores';
+
+const NicknameModal = () => {
+    const { hideModal, is_modal_open } = useModalManagerContext();
+    const { general_store } = useStores();
+
+    return (
+        <Modal
+            width='440px'
+            is_open={is_modal_open}
+            renderTitle={() => <></>}
+            toggleModal={() => {
+                hideModal();
+                general_store.onNicknamePopupClose();
+            }}
+        >
+            <NicknameForm onCancel={hideModal} />
+        </Modal>
+    );
+};
+
+export default NicknameModal;

packages/p2p/src/components/nickname-form/__tests__/nickname-form.spec.tsx

@@ -0,0 +1,179 @@
+import React from 'react';
+import { render, screen, waitFor } from '@testing-library/react';
+import userEvent from '@testing-library/user-event';
+import { useStores } from 'Stores/index';
+import NicknameForm from '../nickname-form';
+
+let mock_store: DeepPartial<ReturnType<typeof useStores>>;
+
+jest.mock('Stores', () => ({
+    ...jest.requireActual('Stores'),
+    useStores: jest.fn(() => mock_store),
+}));
+
+describe('<NicknameForm/>', () => {
+    beforeEach(() => {
+        mock_store = {
+            general_store: {
+                createAdvertiser: jest.fn(),
+                nickname: '',
+                onNicknamePopupClose: jest.fn(),
+                setNicknameError: jest.fn(),
+                validatePopup: (values: { [key: string]: string }) => {
+                    const validations = {
+                        nickname: [
+                            (v: string) => !!v,
+                            (v: string) => v.length >= 2,
+                            (v: string) => v.length <= 24,
+                            (v: string) => /^[a-zA-Z0-9\\.@_-]{2,24}$/.test(v),
+                            (v: string) =>
+                                /^(?!(.*(.)\\2{4,})|.*[\\.@_-]{2,}|^([\\.@_-])|.*([\\.@_-])$)[a-zA-Z0-9\\.@_-]{2,24}$/.test(
+                                    v
+                                ),
+                            (v: string) => !/([a-zA-Z0-9\\.@_-])\1{4}/.test(v),
+                        ],
+                    };
+
+                    const nickname_messages = [
+                        'Nickname is required',
+                        'Nickname is too short',
+                        'Nickname is too long',
+                        'Can only contain letters, numbers, and special characters .- _ @.',
+                        'Cannot start, end with, or repeat special characters.',
+                        'Cannot repeat a character more than 4 times.',
+                    ];
+
+                    const errors: { key?: string } = {};
+
+                    Object.entries(validations).forEach(([key, rules]) => {
+                        const error_index = rules.findIndex(v => {
+                            return !v(values[key]);
+                        });
+
+                        if (error_index !== -1) {
+                            switch (key) {
+                                case 'nickname':
+                                default: {
+                                    errors[key] = nickname_messages[error_index];
+                                    break;
+                                }
+                            }
+                        }
+                    });
+
+                    return errors;
+                },
+            },
+        };
+    });
+    it('should render the component', () => {
+        render(<NicknameForm />);
+
+        expect(screen.getByTestId('dt_nickname_form_content')).toBeInTheDocument();
+    });
+
+    it('should accept a valid nickname', () => {
+        render(<NicknameForm />);
+        userEvent.type(screen.getByLabelText(/nickname/i), 'Advertiser');
+
+        expect(screen.getByRole('button', { name: 'Confirm' })).toBeEnabled();
+    });
+
+    describe('should show an error if the user provides an invalid nickname', () => {
+        it('should show an error if the user provides a nickname with only 1 character', async () => {
+            render(<NicknameForm />);
+            userEvent.type(screen.getByLabelText(/nickname/i), 'A');
+
+            await waitFor(() => {
+                expect(screen.getByText('Nickname is too short')).toBeInTheDocument();
+                expect(screen.getByRole('button', { name: 'Confirm' })).toBeDisabled();
+            });
+        });
+
+        it('should show an error if the user provides a nickname with more than 24 characters', async () => {
+            render(<NicknameForm />);
+            userEvent.type(screen.getByLabelText(/nickname/i), 'Advertiser123456789012345678901');
+
+            await waitFor(() => {
+                expect(screen.getByText('Nickname is too long')).toBeInTheDocument();
+                expect(screen.getByRole('button', { name: 'Confirm' })).toBeDisabled();
+            });
+        });
+
+        it('should show an error if the user provides a nickname that contains special characters other than .- _ @', async () => {
+            render(<NicknameForm />);
+            userEvent.type(screen.getByLabelText(/nickname/i), 'Advertiser!');
+
+            await waitFor(() => {
+                expect(
+                    screen.getByText('Can only contain letters, numbers, and special characters .- _ @.')
+                ).toBeInTheDocument();
+                expect(screen.getByRole('button', { name: 'Confirm' })).toBeDisabled();
+            });
+        });
+
+        it('should show an error if the user provides a nickname that starts with special characters', async () => {
+            render(<NicknameForm />);
+            userEvent.type(screen.getByLabelText(/nickname/i), '.Advertiser');
+
+            await waitFor(() => {
+                expect(screen.getByText('Cannot start, end with, or repeat special characters.')).toBeInTheDocument();
+                expect(screen.getByRole('button', { name: 'Confirm' })).toBeDisabled();
+            });
+        });
+
+        it('should show an error if the user provides a nickname that ends with special characters', async () => {
+            render(<NicknameForm />);
+            userEvent.type(screen.getByLabelText(/nickname/i), 'Advertiser.');
+
+            await waitFor(() => {
+                expect(screen.getByText('Cannot start, end with, or repeat special characters.')).toBeInTheDocument();
+                expect(screen.getByRole('button', { name: 'Confirm' })).toBeDisabled();
+            });
+        });
+
+        it('should show an error if the user provides a nickname that repeats special characters', async () => {
+            render(<NicknameForm />);
+            userEvent.type(screen.getByLabelText(/nickname/i), 'Ad__test');
+
+            await waitFor(() => {
+                expect(screen.getByText('Cannot start, end with, or repeat special characters.')).toBeInTheDocument();
+                expect(screen.getByRole('button', { name: 'Confirm' })).toBeDisabled();
+            });
+        });
+
+        it('should show an error if the user provides a nickname that repeats a character more than 4 times', async () => {
+            render(<NicknameForm />);
+            userEvent.type(screen.getByLabelText(/nickname/i), 'aaaaadvertiser');
+
+            await waitFor(() => {
+                expect(screen.getByText('Cannot repeat a character more than 4 times.')).toBeInTheDocument();
+                expect(screen.getByRole('button', { name: 'Confirm' })).toBeDisabled();
+            });
+        });
+    });
+
+    it('should call onCancel on click of Cancel button', async () => {
+        const onCancel = jest.fn();
+
+        render(<NicknameForm onCancel={onCancel} />);
+
+        userEvent.click(screen.getByRole('button', { name: 'Cancel' }));
+
+        await waitFor(() => {
+            expect(onCancel).toHaveBeenCalled();
+            expect(mock_store.general_store.onNicknamePopupClose).toHaveBeenCalled();
+        });
+    });
+
+    it('should create the advertiser on click of Confirm button', async () => {
+        render(<NicknameForm />);
+
+        userEvent.type(screen.getByLabelText(/nickname/i), 'Advertiser');
+        userEvent.click(screen.getByRole('button', { name: 'Confirm' }));
+
+        await waitFor(() => {
+            expect(mock_store.general_store.createAdvertiser).toHaveBeenCalled();
+        });
+    });
+});

packages/p2p/src/components/nickname-form/index.js → packages/p2p/src/components/nickname-form/index.ts

@@ -1,4 +1,4 @@
-import NicknameForm from './nickname-form.jsx';
+import NicknameForm from './nickname-form';
 import './nickname-form.scss';
 
 export default NicknameForm;