LibreChat/client/src/utils/latex.spec.ts
Danny Avila c7e4523d7c
🎯 refactor: LaTeX and Math Rendering (#7952)
* refactor: Markdown LaTeX processing

- Added micromark-extension-llm-math as a dependency in package.json and package-lock.json.
- Updated Vite configuration to alias micromark-extension-math.
- Modified Markdown components to use singleDollarTextMath: false for improved LaTeX rendering.
- Refactored latex utility functions to enhance LaTeX processing and escaping mechanisms.

* chore: linting of `EditTextPart`

* fix: handle key up to initiate edit of latest user message by adding id prop to Edit Message HoverButton

* chore: linting in Artifact component

* refactor: enhance LaTeX preprocessing functionality

- Updated `preprocessLaTeX` to improve handling of currency and LaTeX expressions.
- Introduced optimized regex patterns for better performance.
- Added support for escaping mhchem commands and handling code blocks.
- Enhanced tests for various LaTeX scenarios, including currency and special characters.
- Refactored existing tests to align with new preprocessing logic.

* chore: filter out false positives in unused packages workflow

- Added a grep command to exclude the micromark-extension-llm-math package from the list of unused dependencies in the GitHub Actions workflow.
2025-06-18 00:58:51 -04:00

210 lines
8.5 KiB
TypeScript

import { preprocessLaTeX } from './latex';
describe('preprocessLaTeX', () => {
test('returns the same string if no LaTeX patterns are found', () => {
const content = 'This is a test string without LaTeX or dollar signs';
expect(preprocessLaTeX(content)).toBe(content);
});
test('returns the same string if no dollar signs are present', () => {
const content = 'This has LaTeX \\(x^2\\) and \\[y^2\\] but no dollars';
expect(preprocessLaTeX(content)).toBe(content);
});
test('preserves valid inline LaTeX delimiters \\(...\\)', () => {
const content = 'This is inline LaTeX: \\(x^2 + y^2 = z^2\\)';
expect(preprocessLaTeX(content)).toBe(content);
});
test('preserves valid block LaTeX delimiters \\[...\\]', () => {
const content = 'This is block LaTeX: \\[E = mc^2\\]';
expect(preprocessLaTeX(content)).toBe(content);
});
test('preserves valid double dollar delimiters', () => {
const content = 'This is valid: $$x^2 + y^2 = z^2$$';
expect(preprocessLaTeX(content)).toBe(content);
});
test('converts single dollar delimiters to double dollars', () => {
const content = 'Inline math: $x^2 + y^2 = z^2$';
const expected = 'Inline math: $$x^2 + y^2 = z^2$$';
expect(preprocessLaTeX(content)).toBe(expected);
});
test('converts multiple single dollar expressions', () => {
const content = 'First $a + b = c$ and second $x^2 + y^2 = z^2$';
const expected = 'First $$a + b = c$$ and second $$x^2 + y^2 = z^2$$';
expect(preprocessLaTeX(content)).toBe(expected);
});
test('escapes currency dollar signs', () => {
const content = 'Price is $50 and $100';
const expected = 'Price is \\$50 and \\$100';
expect(preprocessLaTeX(content)).toBe(expected);
});
test('escapes currency with spaces', () => {
const content = '$50 is $20 + $30';
const expected = '\\$50 is \\$20 + \\$30';
expect(preprocessLaTeX(content)).toBe(expected);
});
test('escapes currency with commas', () => {
const content = 'The price is $1,000,000 for this item.';
const expected = 'The price is \\$1,000,000 for this item.';
expect(preprocessLaTeX(content)).toBe(expected);
});
test('escapes currency with decimals', () => {
const content = 'Total: $29.50 plus tax';
const expected = 'Total: \\$29.50 plus tax';
expect(preprocessLaTeX(content)).toBe(expected);
});
test('converts LaTeX expressions while escaping currency', () => {
const content = 'LaTeX $x^2$ and price $50';
const expected = 'LaTeX $$x^2$$ and price \\$50';
expect(preprocessLaTeX(content)).toBe(expected);
});
test('handles Goldbach Conjecture example', () => {
const content = '- **Goldbach Conjecture**: $2n = p + q$ (every even integer > 2)';
const expected = '- **Goldbach Conjecture**: $$2n = p + q$$ (every even integer > 2)';
expect(preprocessLaTeX(content)).toBe(expected);
});
test('does not escape already escaped dollar signs', () => {
const content = 'Already escaped \\$50 and \\$100';
expect(preprocessLaTeX(content)).toBe(content);
});
test('does not convert already escaped single dollars', () => {
const content = 'Escaped \\$x^2\\$ should not change';
expect(preprocessLaTeX(content)).toBe(content);
});
test('escapes mhchem commands', () => {
const content = '$\\ce{H2O}$ and $\\pu{123 J}$';
const expected = '$$\\\\ce{H2O}$$ and $$\\\\pu{123 J}$$';
expect(preprocessLaTeX(content)).toBe(expected);
});
test('handles empty string', () => {
expect(preprocessLaTeX('')).toBe('');
});
test('handles complex mixed content', () => {
const content = `Valid double $$y^2$$
Currency $100 and $200
Single dollar math $x^2 + y^2$
Chemical $\\ce{H2O}$
Valid brackets \\[z^2\\]`;
const expected = `Valid double $$y^2$$
Currency \\$100 and \\$200
Single dollar math $$x^2 + y^2$$
Chemical $$\\\\ce{H2O}$$
Valid brackets \\[z^2\\]`;
expect(preprocessLaTeX(content)).toBe(expected);
});
test('handles multiple equations with currency', () => {
const content = `- **Euler's Totient Function**: $\\phi(n) = n \\prod_{p|n} \\left(1 - \\frac{1}{p}\\right)$
- **Total Savings**: $500 + $200 + $150 = $850`;
const expected = `- **Euler's Totient Function**: $$\\phi(n) = n \\prod_{p|n} \\left(1 - \\frac{1}{p}\\right)$$
- **Total Savings**: \\$500 + \\$200 + \\$150 = \\$850`;
expect(preprocessLaTeX(content)).toBe(expected);
});
test('handles inline code blocks', () => {
const content = 'Outside $x^2$ and inside code: `$100`';
const expected = 'Outside $$x^2$$ and inside code: `$100`';
expect(preprocessLaTeX(content)).toBe(expected);
});
test('handles multiline code blocks', () => {
const content = '```\n$100\n$variable\n```\nOutside $x^2$';
const expected = '```\n$100\n$variable\n```\nOutside $$x^2$$';
expect(preprocessLaTeX(content)).toBe(expected);
});
test('preserves LaTeX expressions with special characters', () => {
const content = 'The set is defined as $\\{x | x > 0\\}$.';
const expected = 'The set is defined as $$\\{x | x > 0\\}$$.';
expect(preprocessLaTeX(content)).toBe(expected);
});
test('handles complex physics equations', () => {
const content = `- **Schrödinger Equation**: $i\\hbar\\frac{\\partial}{\\partial t}|\\psi\\rangle = \\hat{H}|\\psi\\rangle$
- **Einstein Field Equations**: $G_{\\mu\\nu} = \\frac{8\\pi G}{c^4} T_{\\mu\\nu}$`;
const expected = `- **Schrödinger Equation**: $$i\\hbar\\frac{\\partial}{\\partial t}|\\psi\\rangle = \\hat{H}|\\psi\\rangle$$
- **Einstein Field Equations**: $$G_{\\mu\\nu} = \\frac{8\\pi G}{c^4} T_{\\mu\\nu}$$`;
expect(preprocessLaTeX(content)).toBe(expected);
});
test('handles financial calculations with currency', () => {
const content = `- **Simple Interest**: $A = P + Prt = $1,000 + ($1,000)(0.05)(2) = $1,100$
- **ROI**: $\\text{ROI} = \\frac{$1,200 - $1,000}{$1,000} \\times 100\\% = 20\\%$`;
const expected = `- **Simple Interest**: $$A = P + Prt = \\$1,000 + (\\$1,000)(0.05)(2) = \\$1,100$$
- **ROI**: $$\\text{ROI} = \\frac{\\$1,200 - \\$1,000}{\\$1,000} \\times 100\\% = 20\\%$$`;
expect(preprocessLaTeX(content)).toBe(expected);
});
test('does not convert partial or malformed expressions', () => {
const content = 'A single $ sign should not be converted';
const expected = 'A single $ sign should not be converted';
expect(preprocessLaTeX(content)).toBe(expected);
});
test('handles nested parentheses in LaTeX', () => {
const content =
'Matrix determinant: $\\det(A) = \\sum_{\\sigma \\in S_n} \\text{sgn}(\\sigma) \\prod_{i=1}^n a_{i,\\sigma(i)}$';
const expected =
'Matrix determinant: $$\\det(A) = \\sum_{\\sigma \\in S_n} \\text{sgn}(\\sigma) \\prod_{i=1}^n a_{i,\\sigma(i)}$$';
expect(preprocessLaTeX(content)).toBe(expected);
});
test('preserves spacing in equations', () => {
const content = 'Equation: $f(x) = 2x + 3$ where x is a variable.';
const expected = 'Equation: $$f(x) = 2x + 3$$ where x is a variable.';
expect(preprocessLaTeX(content)).toBe(expected);
});
test('handles LaTeX with newlines inside should not be converted', () => {
const content = `This has $x
y$ which spans lines`;
const expected = `This has $x
y$ which spans lines`;
expect(preprocessLaTeX(content)).toBe(expected);
});
test('handles multiple dollar signs in text', () => {
const content = 'Price $100 then equation $x + y = z$ then another price $50';
const expected = 'Price \\$100 then equation $$x + y = z$$ then another price \\$50';
expect(preprocessLaTeX(content)).toBe(expected);
});
test('handles complex LaTeX with currency in same expression', () => {
const content = 'Calculate $\\text{Total} = \\$500 + \\$200$';
const expected = 'Calculate $$\\text{Total} = \\$500 + \\$200$$';
expect(preprocessLaTeX(content)).toBe(expected);
});
test('preserves already escaped dollars in LaTeX', () => {
const content = 'The formula $f(x) = \\$2x$ represents cost';
const expected = 'The formula $$f(x) = \\$2x$$ represents cost';
expect(preprocessLaTeX(content)).toBe(expected);
});
test('handles adjacent LaTeX and currency', () => {
const content = 'Formula $x^2$ costs $25';
const expected = 'Formula $$x^2$$ costs \\$25';
expect(preprocessLaTeX(content)).toBe(expected);
});
test('handles LaTeX with special characters and currency', () => {
const content = 'Set $\\{x | x > \\$0\\}$ for positive prices';
const expected = 'Set $$\\{x | x > \\$0\\}$$ for positive prices';
expect(preprocessLaTeX(content)).toBe(expected);
});
});