api-server / lib /mermaid-widget-html.js
XWX-AI's picture
fix(widget): 142号方案 mermaid定义信封渲染分支+本地vendor内联去CDN(方案D)+replace函数形式修复——背景:XWXExporter v3.2.5起扩展包内不得含远程脚本URL(CWS MV3远程托管代码政策,违规参考ID Blue Argon,2026-11-01 3.2.4被拒——content.bundle.js载荷里cdn.jsdelivr.net/npm/mermaid@10脚本URL被静态扫描判违规,即使扩展自身从不执行、URL仅为渲染端载荷),扩展改为只传定义信封{"_xwxMermaidDef":def},执行环境由本端自建——①新建lib/mermaid-widget-html.js:parseMermaidDefEnvelope互斥判别(完整HTML以<!DOCTYPE或<开头,信封以{开头且可解析出_xwxMermaidDef字符串字段;畸形/缺失/非字符串一律null落回旧路径)+buildMermaidWidgetCode(模板提供#widget-container容器,本代码以%%WIDGET_CODE%%注入其内,getElementById命中容器本身);②renderMermaid信封分支:识别→本地vendor内联构建执行代码,未识别→widgetHtml逐字透传(≤3.2.4旧扩展完整HTML载荷零改动向下兼容,v11→v10降级逻辑不受影响);③方案D去CDN:vendor/mermaid-10.9.1.min.js(3.3MB,与桌面BatchExporter pdf-render/vendor同版本)内联<script>,</script与<!--标准转义(esbuild/webpack内联同款;源文件实测0处</script、1处<!--且均在字符串字面量内)——单widget渲染实测~0.9s(旧CDN路径每次渲染联网拉3.3MB,预算15s),受限网络下不再依赖jsdelivr;④附带修复_renderWidgetPuppeteerImpl的template.replace('%%WIDGET_CODE%%',widgetCode)字符串形式会解释$&/$'/$$替换模式的静默损坏(压缩库与用户'$100'节点标签均可触发),改函数形式replace——本修复对所有widget类型的载荷注入生效,对旧载荷只会修复损坏不可能引入回归;⑤初始化参数与扩展旧执行模板逐字一致(theme default/flowchart htmlLabels/securityLevel loose,v10规避v11 ER themeVariables缺陷),导出位图与3.2.4前同语义。验证:Puppeteer真渲染探针26/26($&毒药样本/反引号/中文节点/sequenceDiagram/pie/信封判别8边界);docker pdf-test/pdf-prod双容器重建后经真实HTTP端到端实测:信封请求3.6s出SVG(viewBox=-8 -8 160 310,含中文节点'下单'),与插件发出的同款请求逐字段一致
ac5fcb4
Raw History Blame Contribute Delete
4.17 kB
/**
* Mermaid widget 执行环境构建器(备忘录 142)
*
* 背景:CWS MV3 远程托管代码政策(违规参考 ID Blue Argon)对扩展包做静态
* 扫描,任何指向包外的 <script src> 字符串——即使仅作为渲染端载荷、扩展自身
* 从不执行——都判违规。因此扩展只传 mermaid 定义信封
* {"_xwxMermaidDef": "<定义原文>"},执行环境由本模块在渲染端构建。
*
* 契约(三端必须保持一致,导出位图与 3.2.4 前逐像素同语义):
* - 库版本:mermaid 10.9.1 本地 vendor(v11 ER 图 themeVariables
* rowEven/rowOdd/nodeBorder 缺陷,server.js 旧格式 v11→v10 降级同款规避;
* 桌面端 BatchExporter widget_renderer.rs 同版本 vendor)
* - initialize 参数:{ startOnLoad: false, theme: 'default',
* flowchart: { htmlLabels: true }, securityLevel: 'loose' }
* - 渲染:mermaid.render('xwx-mmd', def) → #widget-container innerHTML;
* 失败置 document.title = 'MERMAID_RENDER_ERROR'(桌面端轮询 SVG in DOM,
* 标题信号保留与旧扩展模板一致)
* - 桌面端 BatchExporter widget_renderer.rs 的 mermaid 定义分支为本文件
* 的 Rust 同构实现,改参数须两端同步
*
* 信封识别(parseMermaidDefEnvelope):html 传输字段历史上有两种载荷——
* 完整执行 HTML(≤3.2.4 旧扩展)与本信封(≥3.2.5)。完整 HTML 以 <!DOCTYPE
* 或 < 开头,信封以 { 开头且可解析出 _xwxMermaidDef 字符串字段,判据互斥。
*/
const fs = require('fs');
const path = require('path');
/** vendor 库文本缓存(进程内只读一次;3.3MB 字符串常驻内存) */
let _mermaidLibJs = null;
/**
* 读取本地 vendor 的 mermaid 10.9.1 并做内联转义。
* 内联进 <script> 的标准转义:'</script' 会提前闭合脚本标签;'<!--' 会把
* HTML 解析器置入 script-data-escaped 状态。二者在 JS 字符串/正则/注释内
* 转义后(\/ 与 \!)语义不变,属于 esbuild/webpack 内联脚本的同款处理。
* @returns {string}
*/
function getMermaidVendorJs() {
if (_mermaidLibJs === null) {
const vendorPath = path.join(__dirname, '..', 'vendor', 'mermaid-10.9.1.min.js');
const raw = fs.readFileSync(vendorPath, 'utf8');
_mermaidLibJs = raw
.replace(/<\/script/gi, '<\\/script')
.replace(/<!--/g, '<\\!--');
}
return _mermaidLibJs;
}
/**
* 识别 mermaid 定义信封载荷。
* @param {string} widgetHtml - 传输字段原文(可能是完整 HTML 或信封 JSON)
* @returns {string|null} 定义原文;非信封载荷返回 null(走旧格式完整 HTML 路径)
*/
function parseMermaidDefEnvelope(widgetHtml) {
if (typeof widgetHtml !== 'string') return null;
const s = widgetHtml.trim();
if (!s.startsWith('{') || !s.includes('_xwxMermaidDef')) return null;
try {
const obj = JSON.parse(s);
const def = obj && typeof obj === 'object' ? obj._xwxMermaidDef : undefined;
return (typeof def === 'string' && def.trim().length > 0) ? def : null;
} catch {
return null;
}
}
/**
* mermaid 定义 → 可执行 widget 代码(不含外层文档——渲染模板
* templates/widget-render.html 已提供 #widget-container 容器,本代码作为
* %%WIDGET_CODE%% 注入该容器内,getElementById 命中的即容器本身)。
* @param {string} definition - mermaid 图定义(flowchart/sequenceDiagram/…)
* @returns {string}
*/
function buildMermaidWidgetCode(definition) {
const defJson = JSON.stringify(String(definition));
return `<script>${getMermaidVendorJs()}</script>` +
`<script>` +
`mermaid.initialize({ startOnLoad: false, theme: 'default', flowchart: { htmlLabels: true }, securityLevel: 'loose' });` +
`mermaid.render('xwx-mmd', ${defJson}).then(function (r) {` +
`document.getElementById('widget-container').innerHTML = r.svg;` +
`}).catch(function (e) { document.title = 'MERMAID_RENDER_ERROR'; document.getElementById('widget-container').textContent = String(e); });` +
`<\/script>`;
}
module.exports = { parseMermaidDefEnvelope, buildMermaidWidgetCode };