From 1e73722b3b63ca218cc54209265ac358503459f5 Mon Sep 17 00:00:00 2001
From: Shafin Al Karim <129021108+shafin-deriv@users.noreply.github.com>
Date: Wed, 11 Oct 2023 22:32:50 +0800
Subject: [PATCH] chore: show snackbar if strategy changed while running bot
 (#10393)

* chore: show snackbar if strategy changed while running bot

* chore: added test cases

* fix: notification icon

* fix: remove timer if mouse over

* fix: update notification timer on everytime the snackbar opens
---
 packages/bot-web-ui/src/app/app.scss          |   1 +
 .../__tests__/bot-snackbar.spec.tsx           | 103 ++++++++++++++++++
 .../components/bot-snackbar/bot-snackbar.scss |  36 ++++++
 .../components/bot-snackbar/bot-snackbar.tsx  |  57 ++++++++++
 .../src/components/bot-snackbar/index.tsx     |   4 +
 .../dashboard/bot-builder/bot-builder.tsx     |  43 +++++++-
 6 files changed, 242 insertions(+), 2 deletions(-)
 create mode 100644 packages/bot-web-ui/src/components/bot-snackbar/__tests__/bot-snackbar.spec.tsx
 create mode 100644 packages/bot-web-ui/src/components/bot-snackbar/bot-snackbar.scss
 create mode 100644 packages/bot-web-ui/src/components/bot-snackbar/bot-snackbar.tsx
 create mode 100644 packages/bot-web-ui/src/components/bot-snackbar/index.tsx

diff --git a/packages/bot-web-ui/src/app/app.scss b/packages/bot-web-ui/src/app/app.scss
index 74c48607c549..9bc3e6996dbe 100644
--- a/packages/bot-web-ui/src/app/app.scss
+++ b/packages/bot-web-ui/src/app/app.scss
@@ -15,4 +15,5 @@
     --zindex-drawer: 5;
     --zindex-modal: 6;
     --zindex-draggable-modal: 7;
+    --zindex-snackbar: 8;
 }
diff --git a/packages/bot-web-ui/src/components/bot-snackbar/__tests__/bot-snackbar.spec.tsx b/packages/bot-web-ui/src/components/bot-snackbar/__tests__/bot-snackbar.spec.tsx
new file mode 100644
index 000000000000..03763a79cdcf
--- /dev/null
+++ b/packages/bot-web-ui/src/components/bot-snackbar/__tests__/bot-snackbar.spec.tsx
@@ -0,0 +1,103 @@
+import React from 'react';
+import { mockStore, StoreProvider } from '@deriv/stores';
+// eslint-disable-next-line import/no-extraneous-dependencies
+import { act, fireEvent, render, screen } from '@testing-library/react';
+// eslint-disable-next-line import/no-extraneous-dependencies
+import userEvent from '@testing-library/user-event';
+import RootStore from '../../../stores/root-store';
+import { DBotStoreProvider, mockDBotStore } from '../../../stores/useDBotStore';
+import BotSnackbar from '../bot-snackbar';
+
+jest.mock('@deriv/shared', () => ({
+    ...jest.requireActual('@deriv/shared'),
+    isMobile: jest.fn(() => false),
+}));
+
+jest.mock('@deriv/bot-skeleton/src/scratch/blockly', () => jest.fn());
+jest.mock('@deriv/bot-skeleton/src/scratch/dbot', () => ({
+    saveRecentWorkspace: jest.fn(),
+    unHighlightAllBlocks: jest.fn(),
+}));
+jest.mock('@deriv/bot-skeleton/src/scratch/hooks/block_svg', () => jest.fn());
+jest.mock('@deriv/deriv-charts', () => ({
+    setSmartChartsPublicPath: jest.fn(),
+}));
+
+const mock_ws = {
+    authorized: {
+        subscribeProposalOpenContract: jest.fn(),
+        send: jest.fn(),
+    },
+    storage: {
+        send: jest.fn(),
+    },
+    contractUpdate: jest.fn(),
+    subscribeTicksHistory: jest.fn(),
+    forgetStream: jest.fn(),
+    activeSymbols: jest.fn(),
+    send: jest.fn(),
+};
+
+jest.useFakeTimers();
+
+describe('BotSnackbar', () => {
+    let wrapper: ({ children }: { children: JSX.Element }) => JSX.Element, mock_DBot_store: RootStore | undefined;
+    const mockHandleClose = jest.fn();
+    beforeAll(() => {
+        const mock_store = mockStore({});
+        mock_DBot_store = mockDBotStore(mock_store, mock_ws);
+
+        wrapper = ({ children }: { children: JSX.Element }) => (
+            <StoreProvider store={mock_store}>
+                <DBotStoreProvider ws={mock_ws} mock={mock_DBot_store}>
+                    {children}
+                </DBotStoreProvider>
+            </StoreProvider>
+        );
+    });
+    it('should render BotSnackbar with correct message', () => {
+        const test_message = 'message test';
+        render(<BotSnackbar message={test_message} handleClose={mockHandleClose} is_open={true} />, {
+            wrapper,
+        });
+        expect(screen.getByText(test_message)).toBeInTheDocument();
+    });
+
+    it('should not render BotSnackbar if snack bar is not opened', () => {
+        const test_message = 'message test';
+        render(<BotSnackbar message={test_message} handleClose={mockHandleClose} is_open={false} />, {
+            wrapper,
+        });
+        expect(screen.queryByText(test_message)).not.toBeInTheDocument();
+    });
+
+    it('should render close button if snackbar is open', () => {
+        render(<BotSnackbar message='test' handleClose={mockHandleClose} is_open={true} />, {
+            wrapper,
+        });
+        const cls_btn = screen.getByTestId('bot-snackbar-notification-close');
+        expect(cls_btn).toBeInTheDocument();
+    });
+
+    it('should hanlde close function on click close button', async () => {
+        render(<BotSnackbar message='test' handleClose={mockHandleClose} is_open={true} />, {
+            wrapper,
+        });
+        const cls_btn = screen.getByTestId('bot-snackbar-notification-close');
+        await userEvent.click(cls_btn);
+        expect(mockHandleClose).toBeCalled();
+    });
+
+    it('should close snackbar after timeout is passed and mouse is not over the snackbar', async () => {
+        render(<BotSnackbar message='test' handleClose={mockHandleClose} is_open={true} timeout={4000} />, {
+            wrapper,
+        });
+        const element = screen.getByTestId('bot-snackbar-notification-container');
+        act(() => {
+            fireEvent.mouseLeave(element);
+            jest.advanceTimersByTime(4100);
+        });
+        const cls_btn = screen.queryByTestId('bot-snackbar-notification-close');
+        expect(cls_btn).not.toBeInTheDocument();
+    });
+});
diff --git a/packages/bot-web-ui/src/components/bot-snackbar/bot-snackbar.scss b/packages/bot-web-ui/src/components/bot-snackbar/bot-snackbar.scss
new file mode 100644
index 000000000000..73e1a2cde9da
--- /dev/null
+++ b/packages/bot-web-ui/src/components/bot-snackbar/bot-snackbar.scss
@@ -0,0 +1,36 @@
+.bot-snackbar {
+    position: fixed;
+    z-index: var(--zindex-snackbar);
+    right: 38rem;
+    top: 12rem;
+
+    .dc-toast {
+        width: 100%;
+        &__message {
+            background: var(--text-prominent);
+            color: var(--general-main-1);
+            padding: 1rem 1.6rem;
+        }
+        &__message-content {
+            display: flex;
+
+            @include mobile {
+                align-items: center;
+            }
+        }
+    }
+
+    @include mobile {
+        top: unset;
+        left: 0;
+        right: 0;
+        bottom: 10.5rem;
+    }
+
+    .notification-close {
+        cursor: pointer;
+        filter: invert(1);
+        margin-left: 1rem;
+        margin-top: 0.1rem;
+    }
+}
diff --git a/packages/bot-web-ui/src/components/bot-snackbar/bot-snackbar.tsx b/packages/bot-web-ui/src/components/bot-snackbar/bot-snackbar.tsx
new file mode 100644
index 000000000000..df518174f7e6
--- /dev/null
+++ b/packages/bot-web-ui/src/components/bot-snackbar/bot-snackbar.tsx
@@ -0,0 +1,57 @@
+import React, { useState } from 'react';
+import { Icon, Toast } from '@deriv/components';
+import { Localize } from '@deriv/translations';
+
+type TBotSnackbar = {
+    className?: string;
+    is_open: boolean;
+    onClick?: React.MouseEventHandler<HTMLDivElement>;
+    handleClose: () => void;
+    type?: 'error' | 'info' | 'notification';
+    timeout?: number;
+    msg_localize_components?: JSX.Element[];
+    message: string;
+};
+
+const BotSnackbar = ({
+    message,
+    msg_localize_components = [],
+    timeout = 6000,
+    is_open,
+    onClick,
+    handleClose,
+    type,
+    className,
+}: TBotSnackbar) => {
+    const [notification_timer, setNotificationTimer] = useState(timeout);
+
+    React.useEffect(() => {
+        if (is_open) {
+            setNotificationTimer(timeout);
+        }
+    }, [is_open, timeout]);
+
+    return (
+        <div
+            onMouseOver={() => {
+                setNotificationTimer(0);
+            }}
+            onMouseLeave={() => {
+                setNotificationTimer(timeout);
+            }}
+            className={className ?? 'bot-snackbar'}
+            data-testid='bot-snackbar-notification-container'
+        >
+            <Toast is_open={is_open} type={type} timeout={notification_timer} onClick={onClick} onClose={handleClose}>
+                <div>{message && <Localize i18n_default_text={message} components={msg_localize_components} />}</div>
+                <Icon
+                    icon='IcCross'
+                    className={'notification-close'}
+                    data_testid={'bot-snackbar-notification-close'}
+                    onClick={handleClose}
+                />
+            </Toast>
+        </div>
+    );
+};
+export default BotSnackbar;
diff --git a/packages/bot-web-ui/src/components/bot-snackbar/index.tsx b/packages/bot-web-ui/src/components/bot-snackbar/index.tsx
new file mode 100644
index 000000000000..28deeddded1e
--- /dev/null
+++ b/packages/bot-web-ui/src/components/bot-snackbar/index.tsx
@@ -0,0 +1,4 @@
+import BotSnackbar from './bot-snackbar';
+import './bot-snackbar.scss';
+
+export default BotSnackbar;
diff --git a/packages/bot-web-ui/src/components/dashboard/bot-builder/bot-builder.tsx b/packages/bot-web-ui/src/components/dashboard/bot-builder/bot-builder.tsx
index 3caffd8258e4..71ba996f978a 100644
--- a/packages/bot-web-ui/src/components/dashboard/bot-builder/bot-builder.tsx
+++ b/packages/bot-web-ui/src/components/dashboard/bot-builder/bot-builder.tsx
@@ -1,9 +1,10 @@
-import React from 'react';
+import React, { useRef, useState } from 'react';
 import classNames from 'classnames';
 
 import { observer } from '@deriv/stores';
 
 import { useDBotStore } from '../../../stores/useDBotStore';
+import BotSnackbar from '../../bot-snackbar';
 import LoadModal from '../../load-modal';
 import SaveModal from '../dashboard-component/load-bot-preview/save-modal';
 import BotBuilderTourHandler from '../dbot-tours/bot-builder-tour';
@@ -12,8 +13,11 @@ import QuickStrategy from '../quick-strategy';
 import WorkspaceWrapper from './workspace-wrapper';
 
 const BotBuilder = observer(() => {
-    const { dashboard, app } = useDBotStore();
+    const { dashboard, app, run_panel } = useDBotStore();
     const { active_tab, active_tour, is_preview_on_popup } = dashboard;
+    const { is_running } = run_panel;
+    const is_blockly_listener_registered = useRef(false);
+    const [show_snackbar, setShowSnackbar] = useState(false);
 
     const { onMount, onUnmount } = app;
     const el_ref = React.useRef<HTMLInputElement | null>(null);
@@ -23,8 +27,43 @@ const BotBuilder = observer(() => {
         return () => onUnmount();
     }, []);
 
+    const handleBlockChangeOnBotRun = (e: Event) => {
+        if (e.type !== 'ui') {
+            setShowSnackbar(true);
+            removeBlockChangeListener();
+        }
+    };
+
+    const removeBlockChangeListener = () => {
+        is_blockly_listener_registered.current = false;
+        window.Blockly?.derivWorkspace?.removeChangeListener(handleBlockChangeOnBotRun);
+    };
+
+    React.useEffect(() => {
+        const workspace = window.Blockly?.derivWorkspace;
+        if (workspace && is_running && !is_blockly_listener_registered.current) {
+            is_blockly_listener_registered.current = true;
+            workspace.addChangeListener(handleBlockChangeOnBotRun);
+        } else {
+            setShowSnackbar(false);
+            removeBlockChangeListener();
+        }
+
+        return () => {
+            if (workspace && is_blockly_listener_registered.current) {
+                removeBlockChangeListener();
+            }
+        };
+        // eslint-disable-next-line react-hooks/exhaustive-deps
+    }, [is_running]);
+
     return (
         <>
+            <BotSnackbar
+                is_open={show_snackbar}
+                message='Changes you make will not affect your running bot.'
+                handleClose={() => setShowSnackbar(false)}
+            />
             <div
                 className={classNames('bot-builder', {
                     'bot-builder--active': active_tab === 1 && !is_preview_on_popup,