Enhanced ChatGPT Clone: Features Agents, MCP, Skills, DeepSeek, Anthropic, AWS, OpenAI, Responses API, Azure, Groq, o1, GPT-5, Mistral, OpenRouter, Vertex AI, Gemini, Artifacts, AI model switching, message search, Code Interpreter, langchain, DALL-E-3, OpenAPI Actions, Functions, Secure Multi-User Auth, Presets, open-source for self-hosting. Active
TypeScript aianthropicartifactsawsazurechatgptchatgpt-cloneclaudeclonedeepseekgeminigooglegpt-5librechatmcpo1openairesponses-apivisionwebui
import * as fs from 'fs';
import * as path from 'path';
import { spawnSync } from 'child_process';
import {
_resetLibreOfficeProbeCache,
buildPdfEmbedDocument,
convertOfficeToPdf,
isLibreOfficeEnabled,
isLibreOfficeEnabledFor,
LibreOfficeConversionError,
LibreOfficeUnavailableError,
LIBREOFFICE_TIMEOUT_MS,
MAX_LIBREOFFICE_PDF_BYTES,
probeLibreOfficeBinary,
tryLibreOfficePreview,
} from './libreoffice';
/* Detect whether the host has a LibreOffice binary so the integration
* tests below can conditionally engage. Most CI runners don't have
* LibreOffice installed (it's a 500 MB dependency); we still exercise
* the env-gating, the wrapper builder, and the failure-fallthrough
* contract in those environments. */
function hasLibreOfficeOnPath(): boolean {
for (const candidate of ['soffice', 'libreoffice']) {
const result = spawnSync(candidate, ['--version'], { stdio: 'ignore' });
if (result.status === 0) {
return true;
}
}
return false;
}
const LIBREOFFICE_INSTALLED = hasLibreOfficeOnPath();
const itIfLibreOffice = LIBREOFFICE_INSTALLED ? it : it.skip;
/* Fixtures sit next to the source files (matches `html.spec.ts` resolution). */
const FIXTURES_DIR = __dirname;
function readFixture(name: string): Buffer {
return fs.readFileSync(path.join(FIXTURES_DIR, name));
}
describe('libreoffice (env gating + wrapper)', () => {
const ORIGINAL_FLAG = process.env.OFFICE_PREVIEW_LIBREOFFICE;
afterEach(() => {
_resetLibreOfficeProbeCache();
if (ORIGINAL_FLAG === undefined) {
delete process.env.OFFICE_PREVIEW_LIBREOFFICE;
} else {
process.env.OFFICE_PREVIEW_LIBREOFFICE = ORIGINAL_FLAG;
}
});
describe('isLibreOfficeEnabled (any-format check)', () => {
it.each([['true'], ['1'], ['yes'], ['TRUE'], ['Yes'], [' true ']])(
'returns true for %j (truthy = all formats enabled)',
(value) => {
process.env.OFFICE_PREVIEW_LIBREOFFICE = value;
expect(isLibreOfficeEnabled()).toBe(true);
},
);
it.each([['false'], ['0'], ['no'], ['']])('returns false for %j', (value) => {
process.env.OFFICE_PREVIEW_LIBREOFFICE = value;
expect(isLibreOfficeEnabled()).toBe(false);
});
it('returns false when the env var is unset', () => {
delete process.env.OFFICE_PREVIEW_LIBREOFFICE;
expect(isLibreOfficeEnabled()).toBe(false);
});
it('returns true for a comma-separated format list (any format counts)', () => {
process.env.OFFICE_PREVIEW_LIBREOFFICE = 'pptx';
expect(isLibreOfficeEnabled()).toBe(true);
process.env.OFFICE_PREVIEW_LIBREOFFICE = 'pptx,docx';
expect(isLibreOfficeEnabled()).toBe(true);
});
});
describe('isLibreOfficeEnabledFor (per-format opt-in)', () => {
/* Per-format gating lets operators trade off cold-start latency
* against fidelity per format. DOCX renders ~instantly via
* docx-preview, but PPTX needs LibreOffice for any reasonable
* fidelity (pptx-preview chokes on pptxgenjs decks). Operators
* should be able to enable LibreOffice for PPTX only. */
it.each([
['true', 'pptx', true],
['true', 'docx', true],
['true', 'xlsx', true],
['1', 'pptx', true],
['yes', 'docx', true],
['false', 'pptx', false],
['', 'pptx', false],
['pptx', 'pptx', true],
['pptx', 'docx', false],
['docx', 'pptx', false],
['docx', 'docx', true],
['pptx,docx', 'pptx', true],
['pptx,docx', 'docx', true],
['pptx,docx', 'xlsx', false],
[' pptx , docx ', 'pptx', true], // whitespace-tolerant
['PPTX', 'pptx', true], // case-insensitive
['pptx, ,docx', 'docx', true], // empty list entries dropped
['pptx, ,docx', 'pptx', true],
['pptx, ,docx', 'xlsx', false],
])('env=%j format=%j → %s', (envValue, format, expected) => {
process.env.OFFICE_PREVIEW_LIBREOFFICE = envValue;
expect(isLibreOfficeEnabledFor(format)).toBe(expected);
});
it('returns false for any format when the env var is unset', () => {
delete process.env.OFFICE_PREVIEW_LIBREOFFICE;
expect(isLibreOfficeEnabledFor('pptx')).toBe(false);
expect(isLibreOfficeEnabledFor('docx')).toBe(false);
expect(isLibreOfficeEnabledFor('xlsx')).toBe(false);
});
it('matches format names case-insensitively', () => {
process.env.OFFICE_PREVIEW_LIBREOFFICE = 'pptx';
expect(isLibreOfficeEnabledFor('PPTX')).toBe(true);
expect(isLibreOfficeEnabledFor('Pptx')).toBe(true);
});
});
describe('buildPdfEmbedDocument', () => {
/* The wrapper structure is the security-relevant surface. These
* tests lock down the CSP, the iframe shape, and the fallback
* contract — independent of whether LibreOffice is actually
* installed. Same posture as the docx-preview / pptx-preview CDN
* wrappers. */
const FAKE_PDF_B64 = 'JVBERi0xLjQK'; // "%PDF-1.4\n" base64
it('emits a complete sandboxed HTML document that renders via pdf.js to canvas', () => {
const html = buildPdfEmbedDocument(FAKE_PDF_B64);
expect(html).toMatch(/^<!DOCTYPE html>/);
expect(html).toContain('<title>Preview</title>');
/* PDF bytes embedded as a base64 data block — pdf.js decodes
* them at runtime and renders to canvas. We do NOT use any
* `<iframe src="data:application/pdf;...">` or `src="blob:...">`
* pattern because Chrome blocks BOTH data: AND blob: PDF
* navigations in sandboxed iframes (the built-in PDF viewer
* requires a top-level browsing context). The Sandpack host
* iframe is sandboxed, so neither approach renders. PDF.js
* draws to canvas which works in any context. Manual e2e on
* PR #12934. */
expect(html).toContain('id="lc-pdf-data"');
expect(html).toContain(FAKE_PDF_B64);
expect(html).toContain('id="lc-render"');
/* Negative assertions: we MUST NOT have any nested iframe
* navigation to a PDF URL. A future "let's just embed the PDF
* natively" rewrite can't silently re-introduce the Chrome
* block. */
expect(html).not.toMatch(/src="data:application\/pdf/);
expect(html).not.toMatch(/src="blob:[^"]*application\/pdf/);
expect(html).not.toMatch(/<iframe[^>]+id="lc-pdf"/);
/* PDF.js loaded from CDN. */
expect(html).toContain('cdn.jsdelivr.net/npm/pdfjs-dist@');
expect(html).toContain('pdfjsLib.getDocument');
expect(html).toContain('GlobalWorkerOptions.workerSrc');
expect(html).toContain('page.render');
});
it('CSP allows pdf.js script + worker from jsdelivr; locks down everything else', () => {
const html = buildPdfEmbedDocument(FAKE_PDF_B64);
const cspMatch = html.match(/<meta http-equiv="Content-Security-Policy" content="([^"]+)">/);
expect(cspMatch).not.toBeNull();
const csp = cspMatch![1];
expect(csp).toMatch(/default-src 'none'/);
/* pdf.js needs its main script + worker. Both come from the
* same jsdelivr host. */
expect(csp).toMatch(/script-src https:\/\/cdn\.jsdelivr\.net 'unsafe-inline'/);
expect(csp).toMatch(/worker-src[^;]*https:\/\/cdn\.jsdelivr\.net/);
expect(csp).toMatch(/worker-src[^;]*\bblob:/);
/* Negative assertions for the previous-iteration approaches:
* no `frame-src` (no nested iframes anymore), no PDF data: or
* blob: navigation paths. */
expect(csp).not.toMatch(/frame-src/);
/* No outbound HTTP from the rendered iframe — pdf.js doesn't
* fetch anything (PDF bytes are inline, fonts subset-embedded
* by LibreOffice). */
expect(csp).toMatch(/connect-src 'none'/);
expect(csp).not.toMatch(/unsafe-eval/);
expect(csp).toMatch(/base-uri 'none'/);
expect(csp).toMatch(/form-action 'none'/);
});
it('exposes a fallback message + diagnostic disclosure when pdf.js fails', () => {
const html = buildPdfEmbedDocument(FAKE_PDF_B64);
expect(html).toContain('id="lc-fallback"');
expect(html).toContain('PDF preview unavailable');
expect(html).toContain('id="lc-fallback-reason"');
expect(html).toContain('Diagnostic details');
/* Multiple failure paths feed showFallback: pdf.js not loaded,
* unhandled rejection from the parser, sync error from the
* bootstrap, render timeout. */
expect(html).toContain("typeof pdfjsLib === 'undefined'");
expect(html).toContain("addEventListener('unhandledrejection'");
expect(html).toContain('pdf-render-timeout');
expect(html).toContain('15000');
/* Reasons logged to console.error for power-user debugging. */
expect(html).toContain("console.error('[libreoffice-pdf] fallback fired:'");
});
it('embeds large base64 payloads inside the data block without escaping issues', () => {
/* The base64 alphabet (A-Za-z0-9+/=) contains no characters that
* could break out of `<script type="application/octet-stream;
* base64">...</script>`. Sanity-check the data round-trip. */
const big = 'A'.repeat(100_000);
const html = buildPdfEmbedDocument(big);
const dataBlock = html.match(
/<script id="lc-pdf-data" type="application\/octet-stream;base64">([^<]+)<\/script>/,
);
expect(dataBlock).not.toBeNull();
expect(dataBlock![1]).toBe(big);
});
});
describe('tryLibreOfficePreview (gating + fallthrough contract)', () => {
it('returns null when the env flag is unset (default behavior)', async () => {
delete process.env.OFFICE_PREVIEW_LIBREOFFICE;
const buf = readFixture('sample.docx');
const out = await tryLibreOfficePreview(buf, 'docx', 512 * 1024);
expect(out).toBeNull();
});
it('returns null when env flag is "false"', async () => {
process.env.OFFICE_PREVIEW_LIBREOFFICE = 'false';
const buf = readFixture('sample.docx');
const out = await tryLibreOfficePreview(buf, 'docx', 512 * 1024);
expect(out).toBeNull();
});
it('never throws — falls through to null on any conversion failure', async () => {
/* Truncate a real OOXML archive: LibreOffice can successfully
* autodetect plain text despite a .docx extension. */
process.env.OFFICE_PREVIEW_LIBREOFFICE = 'true';
const garbage = readFixture('sample.docx').subarray(0, 64);
let threw = false;
try {
const out = await tryLibreOfficePreview(garbage, 'docx', 512 * 1024);
expect(out).toBeNull();
} catch {
threw = true;
}
expect(threw).toBe(false);
});
});
describe('probeLibreOfficeBinary', () => {
it("caches the probe result so we don't re-spawn `--version` on every call", async () => {
_resetLibreOfficeProbeCache();
const first = await probeLibreOfficeBinary();
const second = await probeLibreOfficeBinary();
/* Reference equality — second call returns the cached object. */
expect(second).toBe(first);
});
it('returns availability=false with a reason when the binary is missing', async () => {
_resetLibreOfficeProbeCache();
/* Force the probe to miss by clobbering PATH so neither
* `soffice` nor `libreoffice` resolves. */
const originalPath = process.env.PATH;
process.env.PATH = '/nonexistent';
try {
const probe = await probeLibreOfficeBinary();
expect(probe.available).toBe(false);
expect(probe.binary).toBeNull();
expect(probe.reason).toMatch(/found on .?PATH/i);
} finally {
process.env.PATH = originalPath;
_resetLibreOfficeProbeCache();
}
});
});
describe('error tagging', () => {
it('LibreOfficeUnavailableError preserves the .name tag for callers', () => {
const err = new LibreOfficeUnavailableError('binary missing');
expect(err.name).toBe('LibreOfficeUnavailableError');
expect(err).toBeInstanceOf(Error);
});
it('LibreOfficeConversionError carries optional stderr context', () => {
const err = new LibreOfficeConversionError('exit 1', 'soffice: oops');
expect(err.name).toBe('LibreOfficeConversionError');
expect(err.stderr).toBe('soffice: oops');
});
it('exports tunable subprocess limits so tests can read documented values', () => {
expect(LIBREOFFICE_TIMEOUT_MS).toBe(30_000);
expect(MAX_LIBREOFFICE_PDF_BYTES).toBe(50 * 1024 * 1024);
});
});
});
/* eslint-disable jest/no-standalone-expect -- the `itIfLibreOffice` alias
* collapses to `it.skip` when LibreOffice isn't installed; the lint rule
* doesn't realize the `expect`s below are still scoped to a real test
* block via the alias. Disabling locally is cleaner than restructuring
* to satisfy a static check that's wrong about this pattern. */
describe('libreoffice integration (skipped unless LibreOffice is on $PATH)', () => {
/* These tests engage only when `soffice` (or `libreoffice`) is
* actually installed. Local dev with the binary present runs them;
* stock CI runners skip. The skip is per-test rather than describe-
* level so a printout makes the gating visible. */
const ORIGINAL_FLAG = process.env.OFFICE_PREVIEW_LIBREOFFICE;
beforeEach(() => {
_resetLibreOfficeProbeCache();
});
afterEach(() => {
if (ORIGINAL_FLAG === undefined) {
delete process.env.OFFICE_PREVIEW_LIBREOFFICE;
} else {
process.env.OFFICE_PREVIEW_LIBREOFFICE = ORIGINAL_FLAG;
}
});
itIfLibreOffice('probeLibreOfficeBinary detects the installed binary', async () => {
const probe = await probeLibreOfficeBinary();
expect(probe.available).toBe(true);
expect(probe.binary).toMatch(/^(soffice|libreoffice)$/);
expect(probe.versionLine).toMatch(/LibreOffice/i);
});
itIfLibreOffice(
'convertOfficeToPdf converts a DOCX to PDF bytes',
async () => {
const buf = readFixture('sample.docx');
const pdf = await convertOfficeToPdf(buf, 'docx');
/* PDF magic bytes: 25 50 44 46 == "%PDF". */
expect(pdf.subarray(0, 4).toString('ascii')).toBe('%PDF');
expect(pdf.length).toBeGreaterThan(500);
},
35_000,
);
itIfLibreOffice(
'convertOfficeToPdf converts a PPTX to PDF bytes',
async () => {
const buf = readFixture('sample.pptx');
const pdf = await convertOfficeToPdf(buf, 'pptx');
expect(pdf.subarray(0, 4).toString('ascii')).toBe('%PDF');
},
35_000,
);
itIfLibreOffice(
'tryLibreOfficePreview produces a PDF embed doc when env=true and binary is available',
async () => {
process.env.OFFICE_PREVIEW_LIBREOFFICE = 'true';
_resetLibreOfficeProbeCache();
const buf = readFixture('sample.docx');
const out = await tryLibreOfficePreview(buf, 'docx', 512 * 1024);
expect(out).not.toBeNull();
expect(out!).toMatch(/^<!DOCTYPE html>/);
/* PDF bytes embedded as a base64 data block; pdf.js renders to
* canvas (Chrome blocks both data: and blob: PDF navigations
* in sandboxed iframes — the canvas path is the only thing
* that works in our context). */
expect(out!).toContain('id="lc-pdf-data"');
expect(out!).toContain('pdfjsLib.getDocument');
expect(Buffer.byteLength(out!, 'utf-8')).toBeLessThanOrEqual(512 * 1024);
},
35_000,
);
itIfLibreOffice(
'returns null when the embedded PDF would exceed the output cap',
async () => {
/* Force the cap below the smallest possible PDF so the size
* check trips. The conversion still runs (verifying the
* subprocess works) but `tryLibreOfficePreview` declines to
* emit oversized output and the dispatcher falls through. */
process.env.OFFICE_PREVIEW_LIBREOFFICE = 'true';
_resetLibreOfficeProbeCache();
const buf = readFixture('sample.docx');
const out = await tryLibreOfficePreview(buf, 'docx', 100);
expect(out).toBeNull();
},
35_000,
);
});