import * as assert from 'node:assert'; import { outdent } from 'outdent'; import { RewritingStream } from '../lib/index.js'; import { loadSAXParserTestData } from 'parse5-test-utils/utils/load-sax-parser-test-data.js'; import { finished, getStringDiffMsg, writeChunkedToStream, WritableStreamStub, } from 'parse5-test-utils/utils/common.js'; const srcHtml = outdent`
Hey ya
`; const LONG_TEXT = 'a'.repeat((1 << 16) + 1); const LONG_TEXT_WITH_COMMENT = `${'a'.repeat((1 << 16) - 5)}`; function createRewriterTest({ src, expected, assignTokenHandlers = (): void => { /* Ignore */ }, }: { src: string; expected: string; assignTokenHandlers?: (rewriter: RewritingStream) => void; }) { return async (): Promise => { const rewriter = new RewritingStream(); const writable = new WritableStreamStub(); rewriter.pipe(writable); assignTokenHandlers(rewriter); writeChunkedToStream(src, rewriter); await finished(writable); assert.ok(writable.writtenData === expected, getStringDiffMsg(writable.writtenData, expected)); }; } describe('RewritingStream', () => { // Raw data tests for (const [idx, data] of loadSAXParserTestData().entries()) { // NOTE: if we don't have any event handlers assigned, stream should use raw // data for the serialization, so serialized content should identical to the original. it( `Raw token serialization - ${idx + 1}.${data.name}`, createRewriterTest({ src: data.src, expected: data.src, }), ); } it( 'rewrite start tags', createRewriterTest({ src: srcHtml, expected: outdent`
Hey ya
`, assignTokenHandlers: (rewriter) => { rewriter.on('startTag', (token) => { if (token.tagName === 'head') { token.tagName = 'body'; } else if (token.tagName === 'body') { token.tagName = 'head'; } rewriter.emitStartTag(token); }); }, }), ); it( 'rewrite end tags', createRewriterTest({ src: srcHtml, expected: outdent`
Hey ya `, assignTokenHandlers: (rewriter) => { rewriter.on('endTag', (token) => { token.tagName = 'rewritten'; rewriter.emitEndTag(token); }); }, }), ); it( 'rewrite text', createRewriterTest({ src: srcHtml, expected: outdent`
42
`, assignTokenHandlers: (rewriter) => { rewriter.on('text', (token) => { if (token.text.trim().length > 0) { token.text = '42'; } rewriter.emitText(token); }); }, }), ); it( 'rewrite comment', createRewriterTest({ src: srcHtml, expected: outdent`
Hey ya
`, assignTokenHandlers: (rewriter) => { rewriter.on('comment', (token) => { token.text = '42'; rewriter.emitComment(token); }); }, }), ); it( 'rewrite doctype', createRewriterTest({ src: srcHtml, expected: outdent`
Hey ya
`, assignTokenHandlers: (rewriter) => { rewriter.on('doctype', (token) => { token.publicId = '42'; token.systemId = 'hey'; rewriter.emitDoctype(token); }); }, }), ); it( 'rewrite doctype (no public id)', createRewriterTest({ src: srcHtml, expected: outdent`
Hey ya
`, assignTokenHandlers: (rewriter) => { rewriter.on('doctype', (token) => { token.publicId = null; token.systemId = 'hey'; rewriter.emitDoctype(token); }); }, }), ); it( 'emit multiple', createRewriterTest({ src: srcHtml, expected: outdent`
Hey ya
`, assignTokenHandlers: (rewriter) => { rewriter.on('startTag', (token) => { rewriter.emitRaw(''); if (token.tagName === 'head') { token.selfClosing = true; } rewriter.emitStartTag(token); rewriter.emitRaw(''); }); }, }), ); it( 'rewrite raw', createRewriterTest({ src: srcHtml, expected: outdent` 42 42 42 42 42 42 42
42Hey ya
42 42 42 `, assignTokenHandlers: (rewriter) => { const rewriteRaw = (_: unknown, raw: string): void => { rewriter.emitRaw(`${raw}42`); }; rewriter .on('doctype', rewriteRaw) .on('startTag', rewriteRaw) .on('endTag', rewriteRaw) .on('comment', rewriteRaw); }, }), ); it( 'Should escape entities in attributes and text', createRewriterTest({ src: outdent`
foo&bar
`, expected: outdent`
foo&bar
`, assignTokenHandlers: (rewriter) => { rewriter.on('startTag', (token) => rewriter.emitStartTag(token)); rewriter.on('text', (token) => rewriter.emitText(token)); }, }), ); it('Last text chunk must be flushed (GH-271)', async () => { const parser = new RewritingStream(); let foundText = false; parser.on('text', ({ text }) => { foundText = true; assert.strictEqual(text, 'text'); }); parser.write('text'); parser.end(); await finished(parser); assert.ok(foundText); }); it('Should not accept binary input (GH-269)', () => { const stream = new RewritingStream(); const buf = Buffer.from('test'); assert.throws(() => stream.write(buf), TypeError); }); it( 'Should pass long text correctly (GH-292)', createRewriterTest({ src: LONG_TEXT, expected: LONG_TEXT, }), ); it( 'Should emit comment after text correctly', createRewriterTest({ src: LONG_TEXT_WITH_COMMENT, expected: LONG_TEXT_WITH_COMMENT, }), ); it( 'Should emit text in script without escaping (GH-339)', createRewriterTest({ src: '', expected: '', assignTokenHandlers: (rewriter) => { // On a script tag, emit the text without escaping rewriter.on('startTag', (token) => { rewriter.emitStartTag(token); if (token.tagName === 'script') { rewriter.emitText({ text: 'foo && bar' }); } }); }, }), ); });