@servicetitan/titan-chatbot-ui-cypress 3.1.0 → 3.1.1

package/src/tests/titan-chat-ui/message-user.shared-tests.tsx

@@ -0,0 +1,138 @@
+import { Container } from '@servicetitan/react-ioc';
+import {
+    CHAT_UI_BACKEND_STORE_TOKEN,
+    CHAT_UI_STORE_TOKEN,
+    ChatUiBackendEchoStore,
+    IChatUiBackendStore,
+    IChatUiStore,
+} from '@servicetitan/titan-chat-ui-common';
+import { FC, ReactNode } from 'react';
+import { ChatUiSelectors } from '../../utils/chat-ui-selectors';
+import { testInitContainer, testRenderWrapper } from '../../utils/test-utils';
+
+interface MessageUserProps {
+    children?: ReactNode;
+    messageFooter?: ReactNode;
+    isError?: boolean;
+    className?: string;
+}
+
+export function runMessageUserSharedTests(
+    MessageUserComponent: FC<MessageUserProps>,
+    TextComponent: FC<any>
+) {
+    let container: Container;
+    let chatUiStore: IChatUiStore;
+    let chatUiBackendStore: IChatUiBackendStore;
+
+    beforeEach(() => {
+        container = testInitContainer();
+        chatUiStore = container.get<IChatUiStore>(CHAT_UI_STORE_TOKEN);
+        chatUiBackendStore = container.get<ChatUiBackendEchoStore>(CHAT_UI_BACKEND_STORE_TOKEN);
+        cy.viewport(800, 800);
+    });
+
+    const render = (
+        children?: ReactNode,
+        messageFooter?: ReactNode,
+        isError?: boolean,
+        className?: string,
+        onAfterInit?: () => void
+    ) =>
+        cy.wrap(null).then(() =>
+            testRenderWrapper(
+                chatUiStore,
+                chatUiBackendStore,
+                <MessageUserComponent
+                    messageFooter={messageFooter}
+                    isError={isError}
+                    className={className}
+                >
+                    {children}
+                </MessageUserComponent>,
+                onAfterInit
+            )
+        );
+
+    it('should render user message with basic content', () => {
+        render(<TextComponent data-cy="content">message user content</TextComponent>);
+
+        ChatUiSelectors.chatMessageUser.should('be.visible');
+        ChatUiSelectors.chatMessageContent
+            .should('be.visible')
+            .should('contain.text', 'message user content');
+    });
+
+    it('should render user message with long text content', () => {
+        const longText = 'message user content '.repeat(100).trim();
+        render(<TextComponent data-cy="content">{longText}</TextComponent>);
+
+        ChatUiSelectors.chatMessageContent.should('be.visible').should('contain.text', longText);
+    });
+
+    it('should render user message with footer', () => {
+        render(
+            <TextComponent data-cy="content">message user content</TextComponent>,
+            <TextComponent>message user footer</TextComponent>
+        );
+
+        ChatUiSelectors.chatMessageFooter.should('be.visible');
+        ChatUiSelectors.chatMessageFooter.should('contain.text', 'message user footer');
+    });
+
+    it('should render user message with error state', () => {
+        render(
+            <TextComponent data-cy="content">error message content</TextComponent>,
+            undefined,
+            true
+        );
+
+        ChatUiSelectors.chatMessageUser.should('be.visible');
+        ChatUiSelectors.chatMessageContent.should('be.visible');
+    });
+
+    it('should render user message with custom className', () => {
+        render(
+            <TextComponent data-cy="content">message content</TextComponent>,
+            undefined,
+            false,
+            'custom-message-class'
+        );
+
+        ChatUiSelectors.chatMessageUser.should('be.visible');
+        ChatUiSelectors.chatMessageUser.should('have.class', 'custom-message-class');
+    });
+
+    it('should not render footer when messageFooter is not provided', () => {
+        render(<TextComponent data-cy="content">message without footer</TextComponent>);
+
+        ChatUiSelectors.chatMessageUser.should('be.visible');
+        ChatUiSelectors.chatMessageFooter.should('not.exist');
+    });
+
+    it('should have proper data-cy attributes for testing', () => {
+        render(<TextComponent data-cy="content">test message</TextComponent>);
+
+        ChatUiSelectors.chatMessageUser.should('have.attr', 'data-cy', 'titan-chat-message-user');
+        ChatUiSelectors.chatMessageContent.should(
+            'have.attr',
+            'data-cy',
+            'titan-chat-message-content'
+        );
+    });
+
+    it('should render both content and footer when both are provided', () => {
+        render(
+            <TextComponent data-cy="content">message content</TextComponent>,
+            <TextComponent data-cy="footer">message footer</TextComponent>
+        );
+
+        ChatUiSelectors.chatMessageUser.should('be.visible');
+        ChatUiSelectors.chatMessageContent
+            .should('be.visible')
+            .should('contain.text', 'message content');
+        ChatUiSelectors.chatMessageFooter
+            .should('be.visible')
+            .should('contain.text', 'message footer');
+    });
+}

package/src/tests/titan-chatbot-ui/chatbot-filters.shared-tests.tsx

@@ -0,0 +1,164 @@
+import { Container } from '@servicetitan/react-ioc';
+import {
+    CHATBOT_API_CLIENT,
+    CHATBOT_UI_STORE_TOKEN,
+    ChatbotUiStore,
+    IChatbotUiStore,
+    ModelsMocks,
+} from '@servicetitan/titan-chatbot-api';
+import { FC, ReactElement } from 'react';
+import { CypressMocks, testInitContainerChatbot, testRenderWrapperChatbot } from '../..';
+import { ChatUiSelectors } from '../../utils/chat-ui-selectors';
+
+interface IChatFiltersProps {
+    className?: string;
+}
+
+export function runChatbotFiltersSharedTests(
+    ChatFiltersComponent: FC<IChatFiltersProps>,
+    wrapperComponent?: (component: ReactElement) => ReactElement
+) {
+    let container: Container;
+    let api: CypressMocks.ChatbotApiClientMock;
+    let chatbotUiStore: IChatbotUiStore;
+
+    const filter = (index: number) => ChatUiSelectors.chatbotFilterButton.eq(index);
+    const filterOptions = (index: number) =>
+        ChatUiSelectors.chatbotFilterOptions.then($options =>
+            ChatUiSelectors.chatbotFilterOptions.eq($options.length === 1 ? 0 : index)
+        );
+    const filterContent = (index: number) => {
+        const selector = `[data-cy="${ChatUiSelectors.cy.chatbotFilterContent}"], [data-anvil-component="Popover"]`;
+        return cy
+            .get(selector)
+            .then($options => cy.get(selector).eq($options.length === 1 ? 0 : index));
+    };
+
+    const mockApiClient = () => {
+        api.postSession = cy.stub().resolves(ModelsMocks.mockSession());
+        api.getOptions = cy.stub().resolves(ModelsMocks.mockFrontendModel());
+    };
+
+    beforeEach(() => {
+        container = testInitContainerChatbot();
+        api = container.get<CypressMocks.ChatbotApiClientMock>(CHATBOT_API_CLIENT);
+        chatbotUiStore = container.get<ChatbotUiStore>(CHATBOT_UI_STORE_TOKEN);
+        mockApiClient();
+        cy.viewport(550, 800);
+    });
+
+    const render = (className?: string, onAfterInit?: () => void) => {
+        return cy.wrap(null).then(() => {
+            const component = (
+                <div
+                    style={{
+                        position: 'absolute',
+                        bottom: '2rem',
+                        left: '2rem',
+                        width: 'calc(100% - 4rem)',
+                    }}
+                >
+                    <ChatFiltersComponent className={className} />
+                </div>
+            );
+            const wrappedComponent = wrapperComponent ? wrapperComponent(component) : component;
+
+            return testRenderWrapperChatbot(container, wrappedComponent, onAfterInit);
+        });
+    };
+
+    it('should render filters container when filters are available', () => {
+        render().then(() => {
+            chatbotUiStore.setFilters(ModelsMocks.mockFrontendModel());
+        });
+
+        ChatUiSelectors.chatbotFilters.should('be.visible');
+        ChatUiSelectors.chatbotFilterButton.should('have.length', 1);
+    });
+
+    it('should not render anything when no filters are available', () => {
+        render().then(() => {
+            chatbotUiStore.setFilters(ModelsMocks.mockFrontendModelEmpty());
+        });
+
+        ChatUiSelectors.chatbotFilters.should('not.exist');
+    });
+
+    it('should apply custom className to filters container', () => {
+        const customClass = 'custom-filters-class';
+
+        render(customClass).then(() => {
+            chatbotUiStore.setFilters(ModelsMocks.mockFrontendModel());
+        });
+
+        ChatUiSelectors.chatbotFilters.should('have.class', customClass);
+    });
+
+    it('should cascade filters 1', () => {
+        render().then(() => {
+            chatbotUiStore.setFilters(ModelsMocks.mockFrontendModel());
+        });
+
+        filter(0).click();
+        filterOptions(0).within(() => {
+            cy.contains('Knowledge Base').should('be.visible');
+            cy.contains('Jarvis').should('be.visible').click();
+        });
+
+        ChatUiSelectors.chatbotFilterButton.should('have.length', 2);
+        filter(0).should('contain.text', 'Sources');
+        filter(1).should('contain.text', 'Content Types').click();
+        filterOptions(1).within(() => {
+            cy.contains('Xxx').should('be.visible').click();
+            cy.contains('Yyy').should('be.visible').click();
+            cy.contains('Release Notes').should('be.visible').click();
+        });
+
+        ChatUiSelectors.chatbotFilterButton.should('have.length', 2);
+        filter(0).should('contain.text', 'Sources1');
+        filter(1).should('contain.text', 'Content Types3');
+    });
+
+    it('should cascade filters 2', () => {
+        render().then(() => {
+            chatbotUiStore.setFilters(ModelsMocks.mockFrontendModel());
+        });
+
+        filter(0).click();
+        filterOptions(0).within(() => {
+            cy.contains('Knowledge Base').should('be.visible').click();
+            cy.contains('Jarvis').should('be.visible').click();
+        });
+
+        ChatUiSelectors.chatbotFilterButton.should('have.length', 3);
+        filter(0).should('contain.text', 'Sources');
+        filter(1).should('contain.text', 'Content Types').click();
+        filter(2).should('contain.text', 'Product Areas');
+        filterOptions(1).within(() => {
+            cy.contains('Xxx').should('be.visible').click();
+            cy.contains('Yyy').should('be.visible').click();
+            cy.contains('FAQ').should('be.visible').click();
+            cy.contains('How To').should('be.visible').click();
+            cy.contains('Release Notes').should('be.visible').click();
+        });
+
+        filter(2).should('contain.text', 'Product Areas').click();
+        filterOptions(2).within(() => {
+            cy.contains('Call Booking').should('be.visible').click();
+            cy.contains('Marketing').should('be.visible').click();
+            cy.contains('Marketing Pro').should('be.visible').click();
+        });
+
+        ChatUiSelectors.chatbotFilterButton.should('have.length', 3);
+        filter(0).should('contain.text', 'Sources2');
+        filter(1).should('contain.text', 'Content Types5');
+        filter(2).should('contain.text', 'Product Areas3');
+
+        filter(0).click();
+        filterContent(0).within(() => {
+            ChatUiSelectors.chatbotFilterNone.click();
+        });
+
+        ChatUiSelectors.chatbotFilterButton.should('have.length', 1);
+    });
+}

package/src/tests/titan-chatbot-ui/chatbot-help-center.shared-tests.tsx

@@ -0,0 +1,225 @@
+import { ILog, Log } from '@servicetitan/log-service';
+import { Container, Provider } from '@servicetitan/react-ioc';
+import {
+    ApiClientHelpCenter,
+    CHATBOT_API_CLIENT,
+    CHATBOT_CLIENT_SETTINGS,
+    CHATBOT_UI_BACKEND_STORE_TOKEN,
+    CHATBOT_UI_STORE_TOKEN,
+    ChatbotCustomizations,
+    ChatbotUiBackendStore,
+    ChatbotUiStore,
+    IChatbotApiClient,
+    IChatbotUiBackendStore,
+    IChatbotUiStore,
+    Models,
+} from '@servicetitan/titan-chatbot-api';
+import axios from 'axios';
+import { mount } from 'cypress/react';
+import { FC, ReactElement, useMemo } from 'react';
+import { CypressMocks } from '../..';
+import { ChatUiSelectors } from '../../utils/chat-ui-selectors';
+
+const ChatbotBaseUrl = 'https://chatbot-api.example.com/base/url';
+
+const initializeHelpCenterChatbotContainer = () => {
+    const rootContainer = new Container();
+    const container = new Container();
+    container.parent = rootContainer;
+    container.bind<ILog>(Log).to(CypressMocks.LogMock).inSingletonScope();
+    container.bind<IChatbotUiStore>(CHATBOT_UI_STORE_TOKEN).to(ChatbotUiStore).inSingletonScope();
+    container
+        .bind<IChatbotUiBackendStore>(CHATBOT_UI_BACKEND_STORE_TOKEN)
+        .to(ChatbotUiBackendStore)
+        .inSingletonScope();
+
+    // Set up Helpcenter API client
+    const clientSettings: ApiClientHelpCenter.IChatbotClientSettingsHelpCenter = {
+        area: 'FloatingChat',
+        instance: 'STapp',
+        constructorParametersFactory: () => ({
+            baseUrl: ChatbotBaseUrl,
+            axiosInstance: axios.create(),
+        }),
+    };
+    container
+        .bind<ApiClientHelpCenter.IChatbotClientSettingsHelpCenter>(CHATBOT_CLIENT_SETTINGS)
+        .toConstantValue(clientSettings);
+    container
+        .bind<IChatbotApiClient>(CHATBOT_API_CLIENT)
+        .to(ApiClientHelpCenter.ChatbotApiClient)
+        .inSingletonScope();
+    return container;
+};
+
+interface IChatbotProps {
+    className?: string;
+    customizations?: ChatbotCustomizations;
+}
+
+export function runChatbotHelpCenterSharedTests(
+    ChatbotComponent: FC<IChatbotProps>,
+    wrapperComponent?: (component: ReactElement) => ReactElement
+) {
+    let container: Container;
+    let log: CypressMocks.LogMock;
+    let apiClientSettings: ApiClientHelpCenter.IChatbotClientSettingsHelpCenter;
+    let apiClient: ApiClientHelpCenter.ChatbotApiClient;
+    let uiStore: ChatbotUiStore;
+    let uiBackendStore: ChatbotUiBackendStore;
+
+    beforeEach(() => {
+        container = initializeHelpCenterChatbotContainer();
+        log = container.get<CypressMocks.LogMock>(Log);
+        apiClientSettings =
+            container.get<ApiClientHelpCenter.IChatbotClientSettingsHelpCenter>(
+                CHATBOT_CLIENT_SETTINGS
+            );
+        apiClient = container.get<ApiClientHelpCenter.ChatbotApiClient>(CHATBOT_API_CLIENT);
+        uiStore = container.get<ChatbotUiStore>(CHATBOT_UI_STORE_TOKEN);
+        uiBackendStore = container.get<ChatbotUiBackendStore>(CHATBOT_UI_BACKEND_STORE_TOKEN);
+        cy.viewport(550, 800);
+        cy.clock(Date.parse('2023-10-01T00:00:00Z'));
+    });
+
+    const render = () => {
+        const ChatbotWrapper: FC = () => {
+            const customizationContext = useMemo<ChatbotCustomizations>(
+                () => ({
+                    filters: { enabled: true },
+                    feedback: { title: 'TITLE' },
+                }),
+                []
+            );
+
+            const component = (
+                <ChatbotComponent
+                    className="h-100vh max-h-100vh of-x-hidden"
+                    customizations={customizationContext}
+                />
+            );
+
+            const wrappedComponent = wrapperComponent ? wrapperComponent(component) : component;
+
+            return (
+                <Provider
+                    singletons={[
+                        {
+                            provide: Log,
+                            useValue: log,
+                        },
+                        {
+                            provide: CHATBOT_CLIENT_SETTINGS,
+                            useValue: apiClientSettings,
+                        },
+                        { provide: CHATBOT_API_CLIENT, useValue: apiClient },
+                        {
+                            provide: CHATBOT_UI_STORE_TOKEN,
+                            useValue: uiStore,
+                        },
+                        {
+                            provide: CHATBOT_UI_BACKEND_STORE_TOKEN,
+                            useValue: uiBackendStore,
+                        },
+                    ]}
+                >
+                    {wrappedComponent}
+                </Provider>
+            );
+        };
+        cy.spy(uiStore, 'run').as('runSpy');
+        mount(<ChatbotWrapper />);
+        return cy.wrap(
+            new Promise(resolve => {
+                cy.get('@runSpy')
+                    .should('have.been.calledOnce')
+                    .then((invocation: any) => {
+                        const initPromise = invocation.firstCall.returnValue as ReturnType<
+                            IChatbotUiStore['run']
+                        >;
+                        initPromise.then(resolve);
+                    });
+            })
+        );
+    };
+
+    it('should render the chatbot with help center API', () => {
+        const sessionMock = CypressMocks.HC.CreateSession;
+        const messageMock = CypressMocks.HC.SendUserMessage;
+        const messageFeedbackMock = CypressMocks.HC.MessageFeedback;
+        const sessionFeedbackMock = CypressMocks.HC.SessionFeedback;
+
+        const aliasFilterOptions = CypressMocks.HC.interceptFilterOptions(ChatbotBaseUrl);
+        const aliasCreateSession = sessionMock.intercept(ChatbotBaseUrl);
+        const aliasSendUserMessage = messageMock.intercept(ChatbotBaseUrl);
+        const aliasMessageFeedback = messageFeedbackMock.intercept(ChatbotBaseUrl);
+        const aliasSessionFeedback = sessionFeedbackMock.intercept(ChatbotBaseUrl);
+
+        render().then(() => {
+            // Expect filters were loaded using the Help Center API
+            cy.wait(aliasFilterOptions).then(interception => {
+                // Check options were loaded correctly
+                expect(interception.request.url).to.equal(
+                    `${ChatbotBaseUrl}/api/Chat/filter-options`
+                );
+                expect(interception.response?.body).to.an('object');
+                expect(interception.response?.body?.sources).to.an('array');
+                expect(interception.response?.body?.contentTypes).to.an('array');
+                expect(interception.response?.body?.productAreas).to.an('array');
+                expect(interception.response?.statusCode).to.equal(200);
+            });
+
+            // Ask the bot a question
+            cy.log('Sending message...');
+            ChatUiSelectors.chatInput.type(`${messageMock.request.text}{enter}`, { delay: 0 });
+
+            // Check that the session was created
+            cy.wait(aliasCreateSession).then(interception => {
+                expect(interception.request.url).to.equal(
+                    `${ChatbotBaseUrl}/api/Chat/create-session`
+                );
+                expect(interception.request.body).to.deep.equal(sessionMock.request);
+                expect(interception.response?.body).to.deep.equal(sessionMock.response);
+                expect(interception.response?.statusCode).to.equal(200);
+            });
+
+            // Check the user message is sent
+            cy.wait(aliasSendUserMessage).then(interception => {
+                expect(interception.request.url).to.equal(
+                    `${ChatbotBaseUrl}/api/Chat/user-message`
+                );
+                expect(interception.request.body).to.deep.equal(messageMock.request);
+                expect(interception.response?.body).to.deep.equal(messageMock.response);
+                expect(interception.response?.statusCode).to.equal(200);
+            });
+
+            // Send session feedback (manually)
+            cy.log('Sending session feedback...');
+            uiStore.sendSessionFeedback(
+                new Models.Feedback({
+                    sessionId: sessionMock.response.id,
+                    description: 'Good answer!',
+                    rating: Models.FeedbackRatings.ThumbsUp,
+                })
+            );
+            cy.wait(aliasSessionFeedback).then(interception => {
+                expect(interception.request.url).to.equal(
+                    `${ChatbotBaseUrl}/api/Chat/session-feedback?sessionId=${sessionMock.response.id}`
+                );
+                expect(interception.request.body).to.deep.equal(sessionFeedbackMock.request);
+                expect(interception.response?.statusCode).to.equal(200);
+            });
+
+            // Check the feedback is sent with thumbs up
+            cy.log('Sending message feedback...');
+            ChatUiSelectors.chatbotMessageFeedbackThumbsUp.scrollIntoView().click({ force: true });
+            cy.wait(aliasMessageFeedback).then(interception => {
+                expect(interception.request.url).to.equal(
+                    `${ChatbotBaseUrl}/api/Chat/bot-message-feedback?sessionId=${messageMock.response.sessionId}&botMessageId=${messageMock.response.id}`
+                );
+                expect(interception.request.body).to.deep.equal(messageFeedbackMock.request);
+                expect(interception.response?.statusCode).to.equal(200);
+            });
+        });
+    });
+}