Overleaf 編譯鏈路全解一次編譯請求如何變成 PDF【免費(fèi)下載鏈接】overleafA web-based collaborative LaTeX editor項(xiàng)目地址: https://gitcode.com/GitHub_Trending/ov/overleafOverleaf 的編譯不是前端調(diào)一下 LaTeX這么簡單web 服務(wù)先把項(xiàng)目文件打包成一個(gè) JSON 請求發(fā)給獨(dú)立的 CLSI 編譯微服務(wù)CLSI 再用 Docker 起一個(gè) TeX Live 容器跑 latexmk產(chǎn)出 output.pdf、日志和 synctex 文件最后按 build 編號(hào)把下載地址還給前端渲染。讀完這篇你能說清每個(gè)環(huán)節(jié)由哪個(gè)文件負(fù)責(zé)、出問題時(shí)該看哪段配置。編譯按鈕背后請求先經(jīng)過 web 服務(wù)這一層你點(diǎn)編譯后請求并不直接到 CLSI。web 服務(wù)里的 ClsiManager 負(fù)責(zé)組裝請求它從數(shù)據(jù)庫取出項(xiàng)目文件按內(nèi)容內(nèi)聯(lián)或給 URL 讓 CLSI 去 filestore 下載兩種方式填進(jìn) resources 數(shù)組再 POST 到 CLSI 的/project/:project_id/compile路由路由定義在 services/clsi/app.js。CLSI 默認(rèn)監(jiān)聽 TCP/3013這個(gè)端口就是編譯 API 入口另外 3048 端口匯報(bào)負(fù)載、3049 端口用于服務(wù)控制三個(gè)端口的默認(rèn)值都能在 settings.defaults.cjs 里找到。請求體大致長這樣摘自 services/clsi/README.md{ compile: { options: { compiler: pdflatex, timeout: 40 }, rootResourcePath: main.tex, resources: [ { path: main.tex, content: \\documentclass{article} ... \\end{document} } ] } }注意resources里既可以直接傳content也可以傳url加modified時(shí)間戳CLSI 會(huì)緩存已下載的 URL 文件只有modified更新時(shí)才重新拉取。web 側(cè)給這次請求留了 12 分鐘超時(shí)COMPILE_REQUEST_TIMEOUT_MS而 CLSI 自身在 app.js 里把 Express 超時(shí)提到 630 秒就是為了覆蓋下載文件 跑 LaTeX的總耗時(shí)。CLSI 內(nèi)部怎么跑加鎖、拼命令、起容器請求進(jìn)來后的核心路徑在 CompileController.js先由 RequestParser 校驗(yàn)請求再標(biāo)記項(xiàng)目剛被訪問然后調(diào)CompileManager.doCompileWithLock加鎖執(zhí)行——同一個(gè)項(xiàng)目同時(shí)只允許一個(gè)編譯在跑。真正拼命令的地方是 LatexRunner.js它執(zhí)行的不是裸的 pdflatex而是 latexmk 驅(qū)動(dòng)的多輪編譯自動(dòng)處理參考文獻(xiàn)、索引的反復(fù) pass命令骨架是latexmk -cd -jobnameoutput -auxdir$COMPILE_DIR -outdir$COMPILE_DIR \ -synctex1 -interactionbatchmode -time -f -pdf $COMPILE_DIR/main.tex其中-synctex1生成.synctex.gz是后面點(diǎn) PDF 跳源碼的基礎(chǔ)-f表示遇錯(cuò)繼續(xù)跑完所有 pass若請求里帶stopOnFirstError則換成-halt-on-error。引擎由請求里的compiler字段決定映射關(guān)系寫死在 LatexRunner 的COMPILER_FLAGS里pdflatex → -pdf、xelatex → -xelatex、lualatex → -lualatex、latex → -pdfdvi不傳時(shí)默認(rèn)pdflatex。社區(qū)版默認(rèn)本機(jī)進(jìn)程直接跑設(shè)置SANDBOXED_COMPILEStrue后CLSI 會(huì)通過掛載的 Docker socket 起一個(gè)兄弟容器執(zhí)行編譯鏡像由TEXLIVE_IMAGE指定并套用 seccomp 安全策略——注意 settings.defaults.cjs 里有一處顯式檢查沙箱編譯依賴 Server Pro 才提供的 DockerRunner純社區(qū)版打開這個(gè)開關(guān)會(huì)直接退出進(jìn)程。關(guān)鍵參數(shù)匯總參數(shù)含義默認(rèn)值定義位置timeout請求內(nèi)單次編譯進(jìn)程超時(shí)60 秒LatexRunner.jsCOMPILE_SIZE_LIMIT編譯請求體大小上限7mbsettings.defaults.cjsTEXLIVE_IMAGE沙箱編譯用的 TeX Live 鏡像quay.io/sharelatex/texlive-full:2017.1settings.defaults.cjsPROCESS_LIFE_SPAN_LIMIT_MSCLSI 進(jìn)程壽命到期自毀換新2 天settings.defaults.cjsCOMPILE_GROUP_DOCKER_CONFIGS按編譯組覆蓋 Docker 資源參數(shù)無settings.defaults.cjs編譯產(chǎn)物去哪了buildId 與下載 URLCLSI 判定編譯成功的標(biāo)準(zhǔn)很樸素輸出文件里必須存在大小大于 0 的output.pdfCompileController 里寫死的檢查否則即使 latexmk 退出碼為 0 也標(biāo)為 failure。每次成功編譯生成一個(gè)buildId產(chǎn)物落在該項(xiàng)目的 build 目錄下前端拿到的 URL 形如{downloadHost}/project/{projectId}/build/{buildId}/output/output.pdfdownloadHost與輸出前綴由Settings.apis.clsi注入見 settings.defaults.cjs 中apis.clsi.downloadHost具體由哪層反代把下載流量轉(zhuǎn)發(fā)到 CLSI需結(jié)合 server-ce/nginx/ 配置確認(rèn)。CLSI 還提供GET .../build/:build_id/output/output.zip路由OutputController.js把整包產(chǎn)物壓成 zip 供下載。日志文件output.stdout/stderr由 LatexRunner 在進(jìn)程結(jié)束后落盤排錯(cuò)時(shí)這就是第一現(xiàn)場。項(xiàng)目文件的本體則不歸 CLSI 管它只是按請求里的 URL 從 filestore 服務(wù)默認(rèn)http://127.0.0.1:3009見 settings.defaults.cjs 的apis.filestore.url拉取文件生命周期由 services/filestore/ 維護(hù)。點(diǎn) PDF 跳回源碼Synctex 雙向同步CLSI 除了編譯還暴露了兩個(gè)同步接口路由同樣在 services/clsi/app.jsGET /project/:project_id/sync/pdf傳 PDF 頁碼和頁面內(nèi)坐標(biāo)返回對應(yīng)源碼位置GET /project/:project_id/sync/code傳文件、行號(hào)、列號(hào)返回 PDF 頁內(nèi)位置。二者背后的.synctex.gz解析邏輯在 SynctexOutputParser.js。所以編輯器里選中報(bào)錯(cuò)行能定位到 PDF 頁、點(diǎn) PDF 又能回到源碼行靠的不是前端魔法而是編譯時(shí)就燒進(jìn)產(chǎn)物里的 synctex 映射。排障與避坑超時(shí)、423/409、磁盤與負(fù)載編譯超時(shí)status: timedout定位路徑是請求里的timeout字段默認(rèn) 60 秒LatexRunner.js和 web 側(cè)的 630 秒app.js。大文檔先查是否 biber/minted 等外部工具拖慢 pass 數(shù)stats 里有l(wèi)atex-runs計(jì)數(shù)再考慮調(diào)大請求 timeout仍不夠就拆文檔。注意 60 秒上限是單進(jìn)程級(jí)和 CLSI 整體 630 秒超時(shí)不是一回事。返回 423 或 409423compile-in-progress說明同項(xiàng)目已有編譯在跑等它結(jié)束即可409 分兩種——conflict文件版本對不上重試編譯和missing-updates響應(yīng)里帶baseHistoryVersionweb 側(cè)需先補(bǔ)歷史更新再重發(fā)。這兩類都是 CompileController.js 把特定錯(cuò)誤映射成的 HTTP 碼看到碼先查對應(yīng)分支。服務(wù)整體變 503 或健康檢查失敗CLSI 的/health_check在進(jìn)程壽命將盡或磁盤告急時(shí)直接返回 500app.js 中檢查processTooOld和ProjectPersistenceManager.isAnyDiskCriticalLow()負(fù)載端口 3048 上報(bào)的可用率會(huì)隨之降為 0 觸發(fā)流量摘除。web 側(cè)對 503 有兜底ClsiManager 會(huì)開啟 20 分鐘的 compile-from-cache用 clsi-cache 分片緩存的近期產(chǎn)物頂替編譯避免用戶直接看到失敗。全鏈路一覽整條鏈路的設(shè)計(jì)思路可以概括為web 服務(wù)只管組裝與呈現(xiàn)編譯邏輯全部收進(jìn) CLSI 這個(gè)可水平擴(kuò)展的微服務(wù)里沙箱容器隔離 LaTeX 進(jìn)程buildId 讓每次產(chǎn)物可追溯synctex 把源碼位置 ? PDF 位置的映射提前算好存進(jìn)產(chǎn)物。理解到這一層再遇到編譯慢、預(yù)覽不更新或同步失效基本都能順著 web → CLSI → 容器 → 產(chǎn)物文件這條線快速定位到責(zé)任環(huán)節(jié)?！久赓M(fèi)下載鏈接】overleafA web-based collaborative LaTeX editor項(xiàng)目地址: https://gitcode.com/GitHub_Trending/ov/overleaf創(chuàng)作聲明：本文部分內(nèi)容由AI輔助生成（AIGC），僅供參考 Overleaf 編譯鏈路全解：一次編譯請求如何變成 PDF
Overleaf 編譯鏈路全解一次編譯請求如何變成 PDF【免費(fèi)下載鏈接】overleafA web-based collaborative LaTeX editor項(xiàng)目地址: https://gitcode.com/GitHub_Trending/ov/overleafOverleaf 的編譯不是前端調(diào)一下 LaTeX這么簡單web 服務(wù)先把項(xiàng)目文件打包成一個(gè) JSON 請求發(fā)給獨(dú)立的 CLSI 編譯微服務(wù)CLSI 再用 Docker 起一個(gè) TeX Live 容器跑 latexmk產(chǎn)出 output.pdf、日志和 synctex 文件最后按 build 編號(hào)把下載地址還給前端渲染。讀完這篇你能說清每個(gè)環(huán)節(jié)由哪個(gè)文件負(fù)責(zé)、出問題時(shí)該看哪段配置。編譯按鈕背后請求先經(jīng)過 web 服務(wù)這一層你點(diǎn)編譯后請求并不直接到 CLSI。web 服務(wù)里的 ClsiManager 負(fù)責(zé)組裝請求它從數(shù)據(jù)庫取出項(xiàng)目文件按內(nèi)容內(nèi)聯(lián)或給 URL 讓 CLSI 去 filestore 下載兩種方式填進(jìn) resources 數(shù)組再 POST 到 CLSI 的/project/:project_id/compile路由路由定義在 services/clsi/app.js。CLSI 默認(rèn)監(jiān)聽 TCP/3013這個(gè)端口就是編譯 API 入口另外 3048 端口匯報(bào)負(fù)載、3049 端口用于服務(wù)控制三個(gè)端口的默認(rèn)值都能在 settings.defaults.cjs 里找到。請求體大致長這樣摘自 services/clsi/README.md{ compile: { options: { compiler: pdflatex, timeout: 40 }, rootResourcePath: main.tex, resources: [ { path: main.tex, content: \\documentclass{article} ... \\end{document} } ] } }注意resources里既可以直接傳content也可以傳url加modified時(shí)間戳CLSI 會(huì)緩存已下載的 URL 文件只有modified更新時(shí)才重新拉取。web 側(cè)給這次請求留了 12 分鐘超時(shí)COMPILE_REQUEST_TIMEOUT_MS而 CLSI 自身在 app.js 里把 Express 超時(shí)提到 630 秒就是為了覆蓋下載文件 跑 LaTeX的總耗時(shí)。CLSI 內(nèi)部怎么跑加鎖、拼命令、起容器請求進(jìn)來后的核心路徑在 CompileController.js先由 RequestParser 校驗(yàn)請求再標(biāo)記項(xiàng)目剛被訪問然后調(diào)CompileManager.doCompileWithLock加鎖執(zhí)行——同一個(gè)項(xiàng)目同時(shí)只允許一個(gè)編譯在跑。真正拼命令的地方是 LatexRunner.js它執(zhí)行的不是裸的 pdflatex而是 latexmk 驅(qū)動(dòng)的多輪編譯自動(dòng)處理參考文獻(xiàn)、索引的反復(fù) pass命令骨架是latexmk -cd -jobnameoutput -auxdir$COMPILE_DIR -outdir$COMPILE_DIR \ -synctex1 -interactionbatchmode -time -f -pdf $COMPILE_DIR/main.tex其中-synctex1生成.synctex.gz是后面點(diǎn) PDF 跳源碼的基礎(chǔ)-f表示遇錯(cuò)繼續(xù)跑完所有 pass若請求里帶stopOnFirstError則換成-halt-on-error。引擎由請求里的compiler字段決定映射關(guān)系寫死在 LatexRunner 的COMPILER_FLAGS里pdflatex → -pdf、xelatex → -xelatex、lualatex → -lualatex、latex → -pdfdvi不傳時(shí)默認(rèn)pdflatex。社區(qū)版默認(rèn)本機(jī)進(jìn)程直接跑設(shè)置SANDBOXED_COMPILEStrue后CLSI 會(huì)通過掛載的 Docker socket 起一個(gè)兄弟容器執(zhí)行編譯鏡像由TEXLIVE_IMAGE指定并套用 seccomp 安全策略——注意 settings.defaults.cjs 里有一處顯式檢查沙箱編譯依賴 Server Pro 才提供的 DockerRunner純社區(qū)版打開這個(gè)開關(guān)會(huì)直接退出進(jìn)程。關(guān)鍵參數(shù)匯總參數(shù)含義默認(rèn)值定義位置timeout請求內(nèi)單次編譯進(jìn)程超時(shí)60 秒LatexRunner.jsCOMPILE_SIZE_LIMIT編譯請求體大小上限7mbsettings.defaults.cjsTEXLIVE_IMAGE沙箱編譯用的 TeX Live 鏡像quay.io/sharelatex/texlive-full:2017.1settings.defaults.cjsPROCESS_LIFE_SPAN_LIMIT_MSCLSI 進(jìn)程壽命到期自毀換新2 天settings.defaults.cjsCOMPILE_GROUP_DOCKER_CONFIGS按編譯組覆蓋 Docker 資源參數(shù)無settings.defaults.cjs編譯產(chǎn)物去哪了buildId 與下載 URLCLSI 判定編譯成功的標(biāo)準(zhǔn)很樸素輸出文件里必須存在大小大于 0 的output.pdfCompileController 里寫死的檢查否則即使 latexmk 退出碼為 0 也標(biāo)為 failure。每次成功編譯生成一個(gè)buildId產(chǎn)物落在該項(xiàng)目的 build 目錄下前端拿到的 URL 形如{downloadHost}/project/{projectId}/build/{buildId}/output/output.pdfdownloadHost與輸出前綴由Settings.apis.clsi注入見 settings.defaults.cjs 中apis.clsi.downloadHost具體由哪層反代把下載流量轉(zhuǎn)發(fā)到 CLSI需結(jié)合 server-ce/nginx/ 配置確認(rèn)。CLSI 還提供GET .../build/:build_id/output/output.zip路由OutputController.js把整包產(chǎn)物壓成 zip 供下載。日志文件output.stdout/stderr由 LatexRunner 在進(jìn)程結(jié)束后落盤排錯(cuò)時(shí)這就是第一現(xiàn)場。項(xiàng)目文件的本體則不歸 CLSI 管它只是按請求里的 URL 從 filestore 服務(wù)默認(rèn)http://127.0.0.1:3009見 settings.defaults.cjs 的apis.filestore.url拉取文件生命周期由 services/filestore/ 維護(hù)。點(diǎn) PDF 跳回源碼Synctex 雙向同步CLSI 除了編譯還暴露了兩個(gè)同步接口路由同樣在 services/clsi/app.jsGET /project/:project_id/sync/pdf傳 PDF 頁碼和頁面內(nèi)坐標(biāo)返回對應(yīng)源碼位置GET /project/:project_id/sync/code傳文件、行號(hào)、列號(hào)返回 PDF 頁內(nèi)位置。二者背后的.synctex.gz解析邏輯在 SynctexOutputParser.js。所以編輯器里選中報(bào)錯(cuò)行能定位到 PDF 頁、點(diǎn) PDF 又能回到源碼行靠的不是前端魔法而是編譯時(shí)就燒進(jìn)產(chǎn)物里的 synctex 映射。排障與避坑超時(shí)、423/409、磁盤與負(fù)載編譯超時(shí)status: timedout定位路徑是請求里的timeout字段默認(rèn) 60 秒LatexRunner.js和 web 側(cè)的 630 秒app.js。大文檔先查是否 biber/minted 等外部工具拖慢 pass 數(shù)stats 里有l(wèi)atex-runs計(jì)數(shù)再考慮調(diào)大請求 timeout仍不夠就拆文檔。注意 60 秒上限是單進(jìn)程級(jí)和 CLSI 整體 630 秒超時(shí)不是一回事。返回 423 或 409423compile-in-progress說明同項(xiàng)目已有編譯在跑等它結(jié)束即可409 分兩種——conflict文件版本對不上重試編譯和missing-updates響應(yīng)里帶baseHistoryVersionweb 側(cè)需先補(bǔ)歷史更新再重發(fā)。這兩類都是 CompileController.js 把特定錯(cuò)誤映射成的 HTTP 碼看到碼先查對應(yīng)分支。服務(wù)整體變 503 或健康檢查失敗CLSI 的/health_check在進(jìn)程壽命將盡或磁盤告急時(shí)直接返回 500app.js 中檢查processTooOld和ProjectPersistenceManager.isAnyDiskCriticalLow()負(fù)載端口 3048 上報(bào)的可用率會(huì)隨之降為 0 觸發(fā)流量摘除。web 側(cè)對 503 有兜底ClsiManager 會(huì)開啟 20 分鐘的 compile-from-cache用 clsi-cache 分片緩存的近期產(chǎn)物頂替編譯避免用戶直接看到失敗。全鏈路一覽整條鏈路的設(shè)計(jì)思路可以概括為web 服務(wù)只管組裝與呈現(xiàn)編譯邏輯全部收進(jìn) CLSI 這個(gè)可水平擴(kuò)展的微服務(wù)里沙箱容器隔離 LaTeX 進(jìn)程buildId 讓每次產(chǎn)物可追溯synctex 把源碼位置 ? PDF 位置的映射提前算好存進(jìn)產(chǎn)物。理解到這一層再遇到編譯慢、預(yù)覽不更新或同步失效基本都能順著 web → CLSI → 容器 → 產(chǎn)物文件這條線快速定位到責(zé)任環(huán)節(jié)?！久赓M(fèi)下載鏈接】overleafA web-based collaborative LaTeX editor項(xiàng)目地址: https://gitcode.com/GitHub_Trending/ov/overleaf創(chuàng)作聲明：本文部分內(nèi)容由AI輔助生成（AIGC），僅供參考