@eeacms/volto-eea-chatbot 2.0.0 → 2.0.2

package/src/ChatBlock/services/streamingService.ts

@@ -1,5 +1,11 @@
-import { PacketType, type Packet } from '../types/streamingModels';
-import type { FileDescriptor, Filters } from '../types/interfaces';
+import {
+  PacketType,
+  type Packet,
+} from '@eeacms/volto-eea-chatbot/ChatBlock/types/streamingModels';
+import type {
+  FileDescriptor,
+  Filters,
+} from '@eeacms/volto-eea-chatbot/ChatBlock/types/interfaces';
 
 export interface SendMessageParams {
   regenerate: boolean;

package/src/ChatBlock/utils/citations.ts

@@ -1,4 +1,4 @@
-import type { Message } from '../types/interfaces';
+import type { Message } from '@eeacms/volto-eea-chatbot/ChatBlock/types/interfaces';
 
 /**
  * Regex to match citation markers like [1], [2], etc.

package/src/halloumi/filtering.test.js

@@ -1,4 +1,12 @@
-import { parseExcludeIndices } from './filtering';
+import fetch from 'node-fetch';
+
+import {
+  parseExcludeIndices,
+  callLLM,
+  excludeClaimSentences,
+  excludeContextSentences,
+} from './filtering';
+jest.mock('node-fetch');
 
 describe('parseExcludeIndices', () => {
   it('parses single indices', () => {
@@ -42,3 +50,193 @@ describe('parseExcludeIndices', () => {
     expect(result).toEqual(new Set());
   });
 });
+
+describe('callLLM', () => {
+  beforeEach(() => {
+    fetch.mockReset();
+  });
+
+  afterEach(() => {
+    fetch.mockReset();
+  });
+
+  it('makes POST request with correct headers', async () => {
+    const mockResponse = { choices: [{ message: { content: 'result' } }] };
+    fetch.mockResolvedValue({
+      json: () => Promise.resolve(mockResponse),
+    });
+
+    await callLLM('https://api.example.com', 'my-api-key', { model: 'gpt-4' });
+
+    expect(fetch).toHaveBeenCalledWith(
+      'https://api.example.com',
+      expect.objectContaining({
+        method: 'POST',
+        headers: expect.objectContaining({
+          'Content-Type': 'application/json',
+          Authorization: 'Bearer my-api-key',
+        }),
+      }),
+    );
+  });
+
+  it('omits Authorization header when no apiKey', async () => {
+    fetch.mockResolvedValue({
+      json: () => Promise.resolve({}),
+    });
+
+    await callLLM('https://api.example.com', null, { model: 'gpt-4' });
+
+    const headers = fetch.mock.calls[0][1].headers;
+    expect(headers['Authorization']).toBeUndefined();
+  });
+
+  it('adds X-Forwarded-For header when ip is provided', async () => {
+    fetch.mockResolvedValue({
+      json: () => Promise.resolve({}),
+    });
+
+    await callLLM('https://api.example.com', null, {}, { ip: '1.2.3.4' });
+
+    const headers = fetch.mock.calls[0][1].headers;
+    expect(headers['X-Forwarded-For']).toBe('1.2.3.4');
+  });
+
+  it('returns parsed JSON response', async () => {
+    const mockResponse = { choices: [{ message: { content: 'hello' } }] };
+    fetch.mockResolvedValue({
+      json: () => Promise.resolve(mockResponse),
+    });
+
+    const result = await callLLM('https://api.example.com', null, {});
+    expect(result).toEqual(mockResponse);
+  });
+});
+
+describe('excludeClaimSentences', () => {
+  beforeEach(() => {
+    fetch.mockReset();
+  });
+
+  afterEach(() => {
+    fetch.mockReset();
+  });
+
+  it('returns empty set for empty sentences array', async () => {
+    const result = await excludeClaimSentences([]);
+    expect(result).toEqual(new Set());
+    expect(fetch).not.toHaveBeenCalled();
+  });
+
+  it('calls LLM and returns excluded sentence indices', async () => {
+    fetch.mockResolvedValue({
+      json: () =>
+        Promise.resolve({
+          choices: [{ message: { content: '1,3' } }],
+        }),
+    });
+
+    const sentences = ['Sentence one.', 'Sentence two.', 'Sentence three.'];
+    const result = await excludeClaimSentences(sentences);
+
+    expect(result).toEqual(new Set([1, 3]));
+    expect(fetch).toHaveBeenCalledTimes(1);
+  });
+
+  it('returns empty set when LLM returns NONE', async () => {
+    fetch.mockResolvedValue({
+      json: () =>
+        Promise.resolve({
+          choices: [{ message: { content: 'NONE' } }],
+        }),
+    });
+
+    const sentences = ['Some factual sentence.', 'Another factual sentence.'];
+    const result = await excludeClaimSentences(sentences);
+
+    expect(result).toEqual(new Set());
+  });
+
+  it('returns empty set on LLM error', async () => {
+    fetch.mockRejectedValue(new Error('Network error'));
+
+    const sentences = ['Sentence one.'];
+    const result = await excludeClaimSentences(sentences);
+
+    expect(result).toEqual(new Set());
+  });
+
+  it('passes ip option to LLM call', async () => {
+    fetch.mockResolvedValue({
+      json: () =>
+        Promise.resolve({ choices: [{ message: { content: 'NONE' } }] }),
+    });
+
+    await excludeClaimSentences(['test sentence'], { ip: '10.0.0.1' });
+
+    const headers = fetch.mock.calls[0][1].headers;
+    expect(headers['X-Forwarded-For']).toBe('10.0.0.1');
+  });
+});
+
+describe('excludeContextSentences', () => {
+  const MIN_SENTENCES = 75;
+
+  beforeEach(() => {
+    fetch.mockReset();
+  });
+
+  afterEach(() => {
+    fetch.mockReset();
+  });
+
+  it('returns empty set when context sentences <= minimum threshold', async () => {
+    const shortContext = Array(10).fill('Short sentence.');
+    const claims = ['A claim.'];
+    const result = await excludeContextSentences(shortContext, claims);
+
+    expect(result).toEqual(new Set());
+    expect(fetch).not.toHaveBeenCalled();
+  });
+
+  it('calls LLM when context exceeds minimum threshold', async () => {
+    fetch.mockResolvedValue({
+      json: () =>
+        Promise.resolve({
+          choices: [{ message: { content: '1,2' } }],
+        }),
+    });
+
+    const longContext = Array(MIN_SENTENCES + 1).fill('Context sentence.');
+    const claims = ['A claim.'];
+    const result = await excludeContextSentences(longContext, claims);
+
+    expect(result).toEqual(new Set([1, 2]));
+    expect(fetch).toHaveBeenCalledTimes(1);
+  });
+
+  it('returns empty set on LLM error', async () => {
+    fetch.mockRejectedValue(new Error('timeout'));
+
+    const longContext = Array(MIN_SENTENCES + 1).fill('Context sentence.');
+    const claims = ['A claim.'];
+    const result = await excludeContextSentences(longContext, claims);
+
+    expect(result).toEqual(new Set());
+  });
+
+  it('returns empty set when LLM returns NONE for context', async () => {
+    fetch.mockResolvedValue({
+      json: () =>
+        Promise.resolve({
+          choices: [{ message: { content: 'NONE' } }],
+        }),
+    });
+
+    const longContext = Array(MIN_SENTENCES + 1).fill('Context sentence.');
+    const claims = ['A claim.'];
+    const result = await excludeContextSentences(longContext, claims);
+
+    expect(result).toEqual(new Set());
+  });
+});

package/src/ChatBlock/tests/AIMessage.test.jsx

@@ -1,95 +0,0 @@
-import { MemoryRouter } from 'react-router-dom';
-import configureStore from 'redux-mock-store';
-import renderer from 'react-test-renderer';
-
-import '@testing-library/jest-dom';
-import { Provider } from 'react-intl-redux';
-import { AIMessage } from '../chat/AIMessage';
-
-const mockStore = configureStore();
-
-describe('AIMessage', () => {
-  let store;
-
-  beforeEach(() => {
-    store = mockStore({
-      userSession: { token: '1234' },
-      intl: { locale: 'en', messages: {} },
-    });
-  });
-
-  const renderComponent = (props) =>
-    renderer.create(
-      <Provider store={store}>
-        <MemoryRouter>
-          <AIMessage {...props} />
-        </MemoryRouter>
-      </Provider>,
-    );
-
-  it('renders AI message with content', () => {
-    const props = {
-      message: {
-        messageId: 1,
-        message: 'Hello, I am an AI assistant',
-        type: 'assistant',
-      },
-    };
-
-    const component = renderComponent(props);
-    const json = component.toJSON();
-    expect(json).toMatchSnapshot();
-  });
-
-  it('renders AI message with sources', () => {
-    const props = {
-      message: {
-        messageId: 1,
-        message: 'Here is some information',
-        type: 'assistant',
-        documents: [
-          {
-            document_id: 'doc1',
-            semantic_identifier: 'Source 1',
-            link: 'https://example.com/1',
-            source_type: 'web',
-          },
-        ],
-      },
-    };
-
-    const component = renderComponent(props);
-    const json = component.toJSON();
-    expect(json).toMatchSnapshot();
-  });
-
-  it('renders AI message with feedback options', () => {
-    const props = {
-      message: {
-        messageId: 1,
-        message: 'This is a response',
-        type: 'assistant',
-      },
-      onFeedback: jest.fn(),
-      enableFeedback: true,
-    };
-
-    const component = renderComponent(props);
-    const json = component.toJSON();
-    expect(json).toMatchSnapshot();
-  });
-
-  it('renders empty AI message', () => {
-    const props = {
-      message: {
-        messageId: 1,
-        message: '',
-        type: 'assistant',
-      },
-    };
-
-    const component = renderComponent(props);
-    const json = component.toJSON();
-    expect(json).toMatchSnapshot();
-  });
-});

package/src/ChatBlock/tests/AutoResizeTextarea.test.jsx

@@ -1,49 +0,0 @@
-import { render, fireEvent } from '@testing-library/react';
-import '@testing-library/jest-dom';
-import AutoResizeTextarea from '../components/AutoResizeTextarea';
-
-jest.mock('@eeacms/volto-matomo/utils', () => ({
-  trackEvent: jest.fn(),
-}));
-
-describe('AutoResizeTextarea', () => {
-  it('renders textarea and button', () => {
-    const { getByRole, getByLabelText } = render(
-      <AutoResizeTextarea onSubmit={jest.fn()} />,
-    );
-
-    expect(getByRole('textbox')).toBeInTheDocument();
-    expect(getByLabelText('Send')).toBeInTheDocument();
-  });
-
-  it('calls onSubmit with input text on Enter key press', () => {
-    const mockSubmit = jest.fn();
-    const { getByRole } = render(<AutoResizeTextarea onSubmit={mockSubmit} />);
-    const textarea = getByRole('textbox');
-
-    fireEvent.change(textarea, { target: { value: 'Hello' } });
-    fireEvent.keyDown(textarea, { key: 'Enter', code: 'Enter' });
-
-    expect(mockSubmit).toHaveBeenCalledWith({ message: 'Hello' });
-  });
-
-  it('does not call onSubmit if input is empty', () => {
-    const mockSubmit = jest.fn();
-    const { getByRole } = render(<AutoResizeTextarea onSubmit={mockSubmit} />);
-    const textarea = getByRole('textbox');
-
-    fireEvent.keyDown(textarea, { key: 'Enter', code: 'Enter' });
-
-    expect(mockSubmit).not.toHaveBeenCalled();
-  });
-
-  it('adds newline on Shift+Enter', () => {
-    const { getByRole } = render(<AutoResizeTextarea onSubmit={jest.fn()} />);
-    const textarea = getByRole('textbox');
-
-    fireEvent.change(textarea, { target: { value: 'Line 1' } });
-    fireEvent.keyDown(textarea, { key: 'Enter', shiftKey: true });
-
-    expect(textarea.value).toBe('Line 1\n');
-  });
-});

package/src/ChatBlock/tests/BlinkingDot.test.jsx

@@ -1,71 +0,0 @@
-import { MemoryRouter } from 'react-router-dom';
-import configureStore from 'redux-mock-store';
-import renderer from 'react-test-renderer';
-
-import '@testing-library/jest-dom';
-import { Provider } from 'react-intl-redux';
-import { BlinkingDot } from '../components/BlinkingDot';
-
-const mockStore = configureStore();
-
-describe('BlinkingDot', () => {
-  let store;
-
-  beforeEach(() => {
-    store = mockStore({
-      userSession: { token: '1234' },
-      intl: { locale: 'en', messages: {} },
-    });
-  });
-
-  const renderComponent = (props) =>
-    renderer.create(
-      <Provider store={store}>
-        <MemoryRouter>
-          <BlinkingDot {...props} />
-        </MemoryRouter>
-      </Provider>,
-    );
-
-  it('renders blinking dot when active', () => {
-    const props = {
-      isActive: true,
-    };
-
-    const component = renderComponent(props);
-    const json = component.toJSON();
-    expect(json).toMatchSnapshot();
-  });
-
-  it('renders inactive dot when not active', () => {
-    const props = {
-      isActive: false,
-    };
-
-    const component = renderComponent(props);
-    const json = component.toJSON();
-    expect(json).toMatchSnapshot();
-  });
-
-  it('applies custom className', () => {
-    const props = {
-      isActive: true,
-      className: 'custom-class',
-    };
-
-    const component = renderComponent(props);
-    const json = component.toJSON();
-    expect(json).toMatchSnapshot();
-  });
-
-  it('applies custom size', () => {
-    const props = {
-      isActive: true,
-      size: 20,
-    };
-
-    const component = renderComponent(props);
-    const json = component.toJSON();
-    expect(json).toMatchSnapshot();
-  });
-});

package/src/ChatBlock/tests/ChatMessage.test.jsx

@@ -1,75 +0,0 @@
-import { MemoryRouter } from 'react-router-dom';
-import configureStore from 'redux-mock-store';
-import renderer from 'react-test-renderer';
-
-import '@testing-library/jest-dom';
-import { Provider } from 'react-intl-redux';
-import { ChatMessage } from '../chat/ChatMessage';
-
-const mockStore = configureStore();
-
-// Mock loadable components
-jest.mock('@loadable/component', () => {
-  const loadable = () => {
-    const MockComponent = ({ children }) => <div>{children}</div>;
-    return MockComponent;
-  };
-  loadable.lib = () => {
-    const MockComponent = ({ children }) =>
-      children ? children({ default: {} }) : null;
-    return MockComponent;
-  };
-  return { __esModule: true, default: loadable };
-});
-
-describe('ChatMessage', () => {
-  let store;
-
-  beforeEach(() => {
-    store = mockStore({
-      userSession: { token: '1234' },
-      intl: { locale: 'en', messages: {} },
-    });
-  });
-
-  const renderComponent = (props) =>
-    renderer.create(
-      <Provider store={store}>
-        <MemoryRouter>
-          <ChatMessage {...props} />
-        </MemoryRouter>
-      </Provider>,
-    );
-
-  it('renders error message correctly', () => {
-    const props = {
-      message: {
-        messageId: 3,
-        type: 'error',
-        error: 'Something went wrong',
-      },
-      libs: { remarkGfm: { default: [] } },
-      isLoading: false,
-    };
-
-    const component = renderComponent(props);
-    const json = component.toJSON();
-    expect(json).toMatchSnapshot();
-  });
-
-  it('returns null for unknown message type', () => {
-    const props = {
-      message: {
-        messageId: 4,
-        message: 'Unknown type',
-        type: 'unknown',
-      },
-      libs: { remarkGfm: { default: [] } },
-      isLoading: false,
-    };
-
-    const component = renderComponent(props);
-    const json = component.toJSON();
-    expect(json).toBeNull();
-  });
-});

package/src/ChatBlock/tests/ChatMessageFeedback.test.jsx

@@ -1,73 +0,0 @@
-import '@testing-library/jest-dom';
-import { render, screen, fireEvent } from '@testing-library/react';
-import ChatMessageFeedback from '../components/ChatMessageFeedback';
-
-jest.mock('../components/FeedbackModal', () => (props) => {
-  const { modalOpen, onClose, onToast } = props;
-
-  return modalOpen ? (
-    <div data-testid="feedback-modal">
-      Modal Open
-      <button
-        onClick={() => {
-          onToast('Thank you for your feedback!', 'success');
-          onClose();
-        }}
-      >
-        Submit Feedback
-      </button>
-    </div>
-  ) : null;
-});
-
-jest.mock('../components/Icon', () => ({ name }) => (
-  <img src={name} alt="icon" />
-));
-
-jest.mock('../components/markdown', () => ({
-  SVGIcon: ({ name }) => <img src={name} alt="icon" />,
-}));
-
-jest.mock('../../icons/thumbs-up.svg', () => 'thumbs-up.svg');
-jest.mock('../../icons/thumbs-down.svg', () => 'thumbs-down.svg');
-
-describe('ChatMessageFeedback', () => {
-  const defaultProps = {
-    message: {
-      messageId: 1,
-      message: 'Test message',
-      type: 'assistant',
-    },
-    feedbackReasons: ['Reason 1', 'Reason 2'],
-  };
-
-  it('renders Like and Dislike buttons', () => {
-    render(<ChatMessageFeedback {...defaultProps} />);
-    expect(screen.getByLabelText('Like')).toBeInTheDocument();
-    expect(screen.getByLabelText('Dislike')).toBeInTheDocument();
-  });
-
-  it('opens modal when Like is clicked', () => {
-    render(<ChatMessageFeedback {...defaultProps} />);
-    fireEvent.click(screen.getByLabelText('Like'));
-    expect(screen.getByTestId('feedback-modal')).toBeInTheDocument();
-  });
-
-  it('opens modal when Dislike is clicked', () => {
-    render(<ChatMessageFeedback {...defaultProps} />);
-    fireEvent.click(screen.getByLabelText('Dislike'));
-    expect(screen.getByTestId('feedback-modal')).toBeInTheDocument();
-  });
-
-  it('shows toast after submitting feedback in modal', () => {
-    render(<ChatMessageFeedback {...defaultProps} />);
-    fireEvent.click(screen.getByLabelText('Like'));
-
-    const submitButton = screen.getByText('Submit Feedback');
-    fireEvent.click(submitButton);
-
-    expect(
-      screen.getByText('Thank you for your feedback!'),
-    ).toBeInTheDocument();
-  });
-});

package/src/ChatBlock/tests/Citation.test.jsx

@@ -1,107 +0,0 @@
-import { MemoryRouter } from 'react-router-dom';
-import configureStore from 'redux-mock-store';
-import renderer from 'react-test-renderer';
-
-import '@testing-library/jest-dom';
-import { Provider } from 'react-intl-redux';
-import { Citation } from '../components/markdown/Citation';
-
-const mockStore = configureStore();
-
-describe('Citation', () => {
-  it('should render the component with link', () => {
-    const store = mockStore({
-      userSession: { token: '1234' },
-      intl: {
-        locale: 'en',
-        messages: {},
-      },
-    });
-
-    const component = renderer.create(
-      <Provider store={store}>
-        <MemoryRouter>
-          <Citation
-            message={{
-              messageId: 6428,
-              message: 'Donec quam felis ultricies nec',
-              type: 'assistant',
-              query: 'Pellentesque libero tortor tincidunt et?',
-              documents: [
-                {
-                  document_id: 'https://www.example.com',
-                  semantic_identifier: 'Nam ipsum risus rutrum vitae',
-                  link: 'https://www.example.com',
-                  blurb:
-                    'Nullam nulla eros, ultricies sit amet, nonummy id, imperdiet feugiat, pede. ',
-                  source_type: 'web',
-                  match_highlights: ['', 'Praesent ac sem eget est', ''],
-                  updated_at: null,
-                  db_doc_id: 99186,
-                },
-              ],
-              citations: {
-                1: 99186,
-              },
-              parentMessageId: 6427,
-              alternateAssistantID: null,
-            }}
-            value={['[1]']}
-            link="https://www.example.com"
-          />
-        </MemoryRouter>
-      </Provider>,
-    );
-    const json = component.toJSON();
-    expect(json).toMatchSnapshot();
-  });
-});
-
-describe('Citation', () => {
-  it('should render the component without link', () => {
-    const store = mockStore({
-      userSession: { token: '1234' },
-      intl: {
-        locale: 'en',
-        messages: {},
-      },
-    });
-
-    const component = renderer.create(
-      <Provider store={store}>
-        <MemoryRouter>
-          <Citation
-            message={{
-              messageId: 6428,
-              message: 'Donec quam felis ultricies nec',
-              type: 'assistant',
-              query: 'Pellentesque libero tortor tincidunt et?',
-              documents: [
-                {
-                  document_id: 'https://www.example.com',
-                  semantic_identifier: 'Nam ipsum risus rutrum vitae',
-                  link: 'https://www.example.com',
-                  blurb:
-                    'Nullam nulla eros, ultricies sit amet, nonummy id, imperdiet feugiat, pede. ',
-                  source_type: 'web',
-                  match_highlights: ['', 'Praesent ac sem eget est', ''],
-                  updated_at: null,
-                  db_doc_id: 99186,
-                },
-              ],
-              citations: {
-                1: 99186,
-              },
-              parentMessageId: 6427,
-              alternateAssistantID: null,
-            }}
-            value={['[1]']}
-            link=""
-          />
-        </MemoryRouter>
-      </Provider>,
-    );
-    const json = component.toJSON();
-    expect(json).toMatchSnapshot();
-  });
-});