texlite 0.7.3 → 0.7.6

package/dist/server/routes/compile.js

@@ -8,19 +8,34 @@ import { resolveSourcePath, safeRelativePath, texFileStem } from "../files.js";
 import { captureCompileSnapshot, cleanCompileArtifacts, cleanCompileCache, compileProject, discardCompileSnapshot, hasCompileCache, publishCompileArtifacts, publishedCompileArtifacts } from "../compiler.js";
 import { parseCompileDiagnostics } from "../compileDiagnostics.js";
 import { pdfToSource, sourceToPdf } from "../synctex.js";
-import { availablePdf, compileRunPdf, compileMainFile, compilePdfUrl, isTextCompileArtifact, listCompileArtifacts, syncArtifacts } from "../compileArtifacts.js";
-import { apiError, contentDisposition } from "../http.js";
+import { availablePdf, compileRunPdf, compileMainFile, compilePdfUrl, isTextCompileArtifact, listCompileArtifacts, pdfLoadingMode, syncArtifacts } from "../compileArtifacts.js";
+import { MAX_TEXT_PREVIEW_BYTES } from "../limits.js";
+import { apiError, contentDisposition, httpError } from "../http.js";
 const now = () => new Date().toISOString();
 const timingDuration = (milliseconds) => Math.round(milliseconds * 10) / 10;
 const MAX_SNAPSHOT_ATTEMPTS = 3;
 const SNAPSHOT_RETRY_AFTER_SECONDS = 1;
+function pdfResponseMetadata(config, pdfPath) {
+    if (!pdfPath)
+        return { pdfSizeBytes: null, pdfLoadingMode: null };
+    const stat = regularFileStat(pdfPath);
+    if (!stat)
+        return {
+            pdfSizeBytes: null,
+            pdfLoadingMode: config.pdfLoadingStrategy === "range" ? "range" : "full"
+        };
+    return {
+        pdfSizeBytes: stat.size,
+        pdfLoadingMode: pdfLoadingMode(config, stat.size)
+    };
+}
 function mainDocumentChangedError() {
-    return Object.assign(new Error("项目主文档在编译排队期间发生变化，请重新发起编译"), { statusCode: 409, code: "MAIN_DOCUMENT_CHANGED" });
+    return httpError(409, "MAIN_DOCUMENT_CHANGED");
 }
 class CompileSnapshotBusyError extends Error {
     code = "COMPILE_SNAPSHOT_BUSY";
     constructor() {
-        super("项目源码尚未完成稳定保存，暂时无法编译，请稍后重试");
+        super("COMPILE_SNAPSHOT_BUSY");
         this.name = "CompileSnapshotBusyError";
     }
 }
@@ -33,11 +48,11 @@ export function registerCompileRoutes(app, context) {
         const { id } = request.params;
         const project = accessibleProject(db, id, user);
         if (!project)
-            return apiError(reply, 404, "PROJECT_NOT_FOUND", "项目不存在");
+            return apiError(reply, 404, "PROJECT_NOT_FOUND");
         const query = request.query;
         const mainFile = compileMainFile(config, id, project.main_file, query.mainFile);
         if (!mainFile)
-            return apiError(reply, 400, "MAIN_DOCUMENT_INVALID", "所选文件不是有效的 LaTeX 主文档");
+            return apiError(reply, 400, "MAIN_DOCUMENT_INVALID");
         const latest = db.prepare(`SELECT run.id, run.status, run.log, run.created_at, run.finished_at,
       run.requested_by, user.username AS requested_by_username, user.display_name AS requested_by_name
       FROM compile_runs run LEFT JOIN users user ON user.id = run.requested_by
@@ -52,6 +67,7 @@ export function registerCompileRoutes(app, context) {
         // A retained legacy PDF has no run bundle, so its file version (mtime) is
         // the only stable token that can be resolved back to those bytes.
         const pdfVersion = published?.runId ?? pdf?.version;
+        const pdfMetadata = pdfResponseMetadata(config, pdf?.path ?? null);
         return {
             mainFile,
             latestRun: latest ? {
@@ -66,7 +82,8 @@ export function registerCompileRoutes(app, context) {
             } : null,
             hasPdf: Boolean(pdf),
             pdfUrl: pdf ? compilePdfUrl(id, mainFile, pdfVersion ?? pdf.version) : null,
-            pdfCompiledAt: publishedRun?.finished_at ?? latestSuccess?.finished_at ?? null
+            pdfCompiledAt: publishedRun?.finished_at ?? latestSuccess?.finished_at ?? null,
+            ...pdfMetadata
         };
     });
     app.get("/api/projects/:id/compile/artifacts", async (request, reply) => {
@@ -76,11 +93,11 @@ export function registerCompileRoutes(app, context) {
         const { id } = request.params;
         const project = accessibleProject(db, id, user);
         if (!project)
-            return apiError(reply, 404, "PROJECT_NOT_FOUND", "项目不存在");
+            return apiError(reply, 404, "PROJECT_NOT_FOUND");
         const query = request.query;
         const mainFile = compileMainFile(config, id, project.main_file, query.mainFile);
         if (!mainFile)
-            return apiError(reply, 400, "MAIN_DOCUMENT_INVALID", "所选文件不是有效的 LaTeX 主文档");
+            return apiError(reply, 400, "MAIN_DOCUMENT_INVALID");
         const published = publishedCompileArtifacts(config, id, mainFile, mainFile === project.main_file);
         if (!query.path) {
             if (!published)
@@ -98,23 +115,23 @@ export function registerCompileRoutes(app, context) {
             }
         }
         if (!published)
-            return apiError(reply, 404, "COMPILE_ARTIFACTS_NOT_FOUND", "尚无可用的编译产物");
+            return apiError(reply, 404, "COMPILE_ARTIFACTS_NOT_FOUND");
         const relative = safeRelativePath(query.path);
         const absolute = path.join(published.output, relative);
         const outputDirectory = path.resolve(published.output);
         const resolved = path.resolve(absolute);
         if (!resolved.startsWith(`${outputDirectory}${path.sep}`)) {
-            return apiError(reply, 404, "COMPILE_ARTIFACT_NOT_FOUND", "编译产物不存在");
+            return apiError(reply, 404, "COMPILE_ARTIFACT_NOT_FOUND");
         }
         let stat;
         try {
             stat = fs.statSync(resolved);
             if (!stat.isFile())
-                return apiError(reply, 404, "COMPILE_ARTIFACT_NOT_FOUND", "编译产物不存在");
+                return apiError(reply, 404, "COMPILE_ARTIFACT_NOT_FOUND");
         }
         catch (error) {
             if (isMissingFileError(error))
-                return apiError(reply, 404, "COMPILE_ARTIFACT_NOT_FOUND", "编译产物不存在");
+                return apiError(reply, 404, "COMPILE_ARTIFACT_NOT_FOUND");
             throw error;
         }
         if (query.download === "1") {
@@ -127,7 +144,7 @@ export function registerCompileRoutes(app, context) {
             catch (error) {
                 await fs.promises.rm(temporaryFile, { force: true }).catch(() => undefined);
                 if (isMissingFileError(error))
-                    return apiError(reply, 404, "COMPILE_ARTIFACT_NOT_FOUND", "编译产物不存在");
+                    return apiError(reply, 404, "COMPILE_ARTIFACT_NOT_FOUND");
                 throw error;
             }
             reply.header("Content-Type", "application/octet-stream");
@@ -139,15 +156,15 @@ export function registerCompileRoutes(app, context) {
             stream.once("error", cleanup);
             return reply.send(stream);
         }
-        if (stat.size > 2 * 1024 * 1024 || !isTextCompileArtifact(relative)) {
-            return apiError(reply, 415, "ARTIFACT_PREVIEW_UNSUPPORTED", "该产物不能作为文本预览，请下载后查看");
+        if (stat.size > MAX_TEXT_PREVIEW_BYTES || !isTextCompileArtifact(relative)) {
+            return apiError(reply, 415, "ARTIFACT_PREVIEW_UNSUPPORTED");
         }
         try {
             return { path: relative, content: fs.readFileSync(resolved, "utf8") };
         }
         catch (error) {
             if (isMissingFileError(error))
-                return apiError(reply, 404, "COMPILE_ARTIFACT_NOT_FOUND", "编译产物不存在");
+                return apiError(reply, 404, "COMPILE_ARTIFACT_NOT_FOUND");
             throw error;
         }
     });
@@ -158,19 +175,19 @@ export function registerCompileRoutes(app, context) {
         const { id } = request.params;
         const project = accessibleProject(db, id, user);
         if (!project || !canEdit(project))
-            return apiError(reply, 403, "COMPILE_FORBIDDEN", "没有清理编译产物的权限");
+            return apiError(reply, 403, "COMPILE_FORBIDDEN");
         const body = (request.body ?? {});
         const mainFile = compileMainFile(config, id, project.main_file, body.mainFile);
         if (!mainFile)
-            return apiError(reply, 400, "MAIN_DOCUMENT_INVALID", "所选文件不是有效的 LaTeX 主文档");
+            return apiError(reply, 400, "MAIN_DOCUMENT_INVALID");
         if (body.mode !== "cache" && body.mode !== "artifacts") {
-            return apiError(reply, 400, "REQUEST_INVALID", "清理模式无效");
+            return apiError(reply, 400, "REQUEST_INVALID");
         }
         return await projectMutations.runCompileExclusive(id, () => {
             const activeRun = db.prepare(`SELECT 1 AS active FROM compile_runs
         WHERE project_id = ? AND main_file = ? AND status IN ('queued', 'running') LIMIT 1`).get(id, mainFile);
             if (activeRun)
-                return apiError(reply, 409, "COMPILE_CLEAN_BUSY", "当前主文档正在编译，请稍后再清理");
+                return apiError(reply, 409, "COMPILE_CLEAN_BUSY");
             const requestedBy = { id: user.id, username: user.username, name: user.display_name };
             if (body.mode === "cache") {
                 cleanCompileCache(config, id, mainFile);
@@ -186,7 +203,7 @@ export function registerCompileRoutes(app, context) {
             }
             const currentProject = accessibleProject(db, id, user);
             if (!currentProject || !canEdit(currentProject))
-                return apiError(reply, 403, "COMPILE_FORBIDDEN", "没有清理编译产物的权限");
+                return apiError(reply, 403, "COMPILE_FORBIDDEN");
             const runs = db.prepare(`SELECT id FROM compile_runs
         WHERE project_id = ? AND main_file = ? AND status NOT IN ('queued', 'running')`).all(id, mainFile);
             cleanCompileArtifacts(config, id, mainFile, currentProject.main_file, runs.map((run) => run.id));
@@ -204,10 +221,10 @@ export function registerCompileRoutes(app, context) {
         }, { preflight: () => {
                 const current = accessibleProject(db, id, user);
                 if (!current || !canEdit(current))
-                    throw Object.assign(new Error("没有清理编译产物的权限"), { statusCode: 403, code: "COMPILE_FORBIDDEN" });
+                    throw httpError(403, "COMPILE_FORBIDDEN");
                 const selected = compileMainFile(config, id, current.main_file, body.mainFile);
                 if (!selected || selected !== mainFile)
-                    throw Object.assign(new Error("所选文件不是有效的 LaTeX 主文档"), { statusCode: 400, code: "MAIN_DOCUMENT_INVALID" });
+                    throw httpError(400, "MAIN_DOCUMENT_INVALID");
             } });
     });
     app.get("/api/projects/:id/sync/pdf", async (request, reply) => {
@@ -217,28 +234,28 @@ export function registerCompileRoutes(app, context) {
         const { id } = request.params;
         const project = accessibleProject(db, id, user);
         if (!project)
-            return apiError(reply, 404, "PROJECT_NOT_FOUND", "项目不存在");
+            return apiError(reply, 404, "PROJECT_NOT_FOUND");
         const query = request.query;
         const mainFile = compileMainFile(config, id, project.main_file, query.mainFile);
         if (!mainFile)
-            return apiError(reply, 400, "MAIN_DOCUMENT_INVALID", "所选文件不是有效的 LaTeX 主文档");
+            return apiError(reply, 400, "MAIN_DOCUMENT_INVALID");
         const sourcePath = safeRelativePath(query.path ?? "");
         const line = Number(query.line);
         const column = Number(query.column ?? 1);
         if (!Number.isInteger(line) || line < 1 || !Number.isInteger(column) || column < 1) {
-            return apiError(reply, 400, "SYNC_SOURCE_INVALID", "源码位置无效");
+            return apiError(reply, 400, "SYNC_SOURCE_INVALID");
         }
         return await projectMutations.runConsistentRead(id, async () => {
             if (!fs.existsSync(resolveSourcePath(config, id, sourcePath))) {
-                return apiError(reply, 404, "SOURCE_FILE_NOT_FOUND", "源码文件不存在");
+                return apiError(reply, 404, "SOURCE_FILE_NOT_FOUND");
             }
             const artifacts = syncArtifacts(config, id, mainFile, project.main_file);
             if (!artifacts)
-                return apiError(reply, 409, "SYNCTEX_NOT_AVAILABLE", "项目尚无可用的 SyncTeX 数据，请重新编译");
+                return apiError(reply, 409, "SYNCTEX_NOT_AVAILABLE");
             return await sourceToPdf(artifacts.source, artifacts.pdf, sourcePath, line, column);
         }, { preflight: () => {
                 if (!accessibleProject(db, id, user))
-                    throw Object.assign(new Error("项目不存在"), { statusCode: 404, code: "PROJECT_NOT_FOUND" });
+                    throw httpError(404, "PROJECT_NOT_FOUND");
             } });
     });
     app.get("/api/projects/:id/sync/source", async (request, reply) => {
@@ -248,31 +265,31 @@ export function registerCompileRoutes(app, context) {
         const { id } = request.params;
         const project = accessibleProject(db, id, user);
         if (!project)
-            return apiError(reply, 404, "PROJECT_NOT_FOUND", "项目不存在");
+            return apiError(reply, 404, "PROJECT_NOT_FOUND");
         const query = request.query;
         const mainFile = compileMainFile(config, id, project.main_file, query.mainFile);
         if (!mainFile)
-            return apiError(reply, 400, "MAIN_DOCUMENT_INVALID", "所选文件不是有效的 LaTeX 主文档");
+            return apiError(reply, 400, "MAIN_DOCUMENT_INVALID");
         const page = Number(query.page);
         const x = Number(query.x);
         const y = Number(query.y);
         if (!Number.isInteger(page) || page < 1 || !Number.isFinite(x) || x < 0 || !Number.isFinite(y) || y < 0) {
-            return apiError(reply, 400, "SYNC_PDF_INVALID", "PDF 位置无效");
+            return apiError(reply, 400, "SYNC_PDF_INVALID");
         }
         return await projectMutations.runConsistentRead(id, async () => {
             const artifacts = syncArtifacts(config, id, mainFile, project.main_file);
             if (!artifacts)
-                return apiError(reply, 409, "SYNCTEX_NOT_AVAILABLE", "项目尚无可用的 SyncTeX 数据，请重新编译");
+                return apiError(reply, 409, "SYNCTEX_NOT_AVAILABLE");
             const location = await pdfToSource(artifacts.source, artifacts.pdf, page, x, y);
             const sourceDirectory = path.resolve(artifacts.source);
             const relative = path.relative(sourceDirectory, path.resolve(location.input));
             if (!relative || relative.startsWith("..") || path.isAbsolute(relative)) {
-                return apiError(reply, 400, "SYNCTEX_EXTERNAL_PATH", "SyncTeX 返回了项目外部的源码路径");
+                return apiError(reply, 400, "SYNCTEX_EXTERNAL_PATH");
             }
             return { path: safeRelativePath(relative.replaceAll(path.sep, "/")), line: location.line, column: location.column };
         }, { preflight: () => {
                 if (!accessibleProject(db, id, user))
-                    throw Object.assign(new Error("项目不存在"), { statusCode: 404, code: "PROJECT_NOT_FOUND" });
+                    throw httpError(404, "PROJECT_NOT_FOUND");
             } });
     });
     app.post("/api/projects/:id/compile", async (request, reply) => {
@@ -283,12 +300,12 @@ export function registerCompileRoutes(app, context) {
         const { id } = request.params;
         const initialProject = accessibleProject(db, id, user);
         if (!initialProject || !canEdit(initialProject))
-            return apiError(reply, 403, "COMPILE_FORBIDDEN", "没有编译权限");
+            return apiError(reply, 403, "COMPILE_FORBIDDEN");
         const body = (request.body ?? {});
         const requestedMainFile = typeof body.mainFile === "string" && body.mainFile ? body.mainFile : null;
         const initialMainFile = compileMainFile(config, id, initialProject.main_file, body.mainFile);
         if (!initialMainFile)
-            return apiError(reply, 400, "MAIN_DOCUMENT_INVALID", "所选文件不是有效的 LaTeX 主文档");
+            return apiError(reply, 400, "MAIN_DOCUMENT_INVALID");
         const runId = randomUUID();
         // Admission must stay cheap. In particular, do not call
         // captureCompileSnapshot here: several collaborators can reach this
@@ -537,8 +554,9 @@ export function registerCompileRoutes(app, context) {
                             // archive/read or another output mutation. The long latexmk
                             // process above remains outside that queue.
                             await projectMutations.runSerialized(id, () => {
-                                if (!db.prepare("SELECT 1 FROM projects WHERE id = ?").get(id))
-                                    throw new Error("项目已被删除");
+                                if (!db.prepare("SELECT 1 FROM projects WHERE id = ?").get(id)) {
+                                    throw new Error("Project was deleted before compile artifacts could be published.");
+                                }
                                 publishCompileArtifacts(config, id, snapshot, compiled);
                             }, { flush: false });
                             refreshSnapshotStale();
@@ -620,7 +638,7 @@ export function registerCompileRoutes(app, context) {
                 `snapshot;dur=${timingDuration(result.snapshotMs ?? 0)}`,
                 `total;dur=${timingDuration(requestMs)}`
             ].join(", "));
-            return apiError(reply, 409, result.errorCode ?? "COMPILE_SNAPSHOT_BUSY", result.log, { retryable: true, retryAfterSeconds: SNAPSHOT_RETRY_AFTER_SECONDS });
+            return apiError(reply, 409, result.errorCode ?? "COMPILE_SNAPSHOT_BUSY", { retryable: true, retryAfterSeconds: SNAPSHOT_RETRY_AFTER_SECONDS });
         }
         if (result.timings) {
             metrics.record("compile.cacheSync", result.timings.cacheSyncMs);
@@ -631,6 +649,8 @@ export function registerCompileRoutes(app, context) {
         const timings = result.timings
             ? { snapshotMs: result.snapshotMs ?? 0, ...result.timings, requestMs }
             : { snapshotMs: result.snapshotMs ?? 0, requestMs };
+        const responsePdf = result.ok ? availablePdf(config, id, mainFile, project.main_file) : null;
+        const pdfMetadata = pdfResponseMetadata(config, responsePdf?.path ?? null);
         reply.header("Server-Timing", [
             `snapshot;dur=${timingDuration(result.snapshotMs ?? 0)}`,
             result.timings ? `cache;dur=${timingDuration(result.timings.cacheSyncMs)}` : "",
@@ -643,6 +663,7 @@ export function registerCompileRoutes(app, context) {
             mainFile, runId: result.runId, ok: result.ok, skipped: result.skipped === true, log: result.log, diagnostics: result.diagnostics,
             pdfUrl: result.ok ? compilePdfUrl(id, mainFile, result.runId) : null,
             pdfCompiledAt: result.ok ? completed?.finished_at ?? null : null,
+            ...pdfMetadata,
             timings
         };
     });
@@ -658,36 +679,36 @@ export function registerCompileRoutes(app, context) {
         const { id } = request.params;
         const project = accessibleProject(db, id, user);
         if (!project)
-            return apiError(reply, 404, "PROJECT_NOT_FOUND", "项目不存在");
+            return apiError(reply, 404, "PROJECT_NOT_FOUND");
         const query = request.query;
         const mainFile = compileMainFile(config, id, project.main_file, query.mainFile);
         if (!mainFile)
-            return apiError(reply, 400, "MAIN_DOCUMENT_INVALID", "所选文件不是有效的 LaTeX 主文档");
+            return apiError(reply, 400, "MAIN_DOCUMENT_INVALID");
         const downloading = query.download === "1";
         let artifact = availablePdf(config, id, mainFile, project.main_file);
         if (!artifact)
-            return apiError(reply, 404, "PDF_NOT_FOUND", "尚未生成 PDF");
+            return apiError(reply, 404, "PDF_NOT_FOUND");
         let versioned = false;
         if (query.run) {
             if (/^[a-f0-9-]{36}$/i.test(query.run)) {
                 const run = db.prepare(`SELECT main_file, status FROM compile_runs
           WHERE id = ? AND project_id = ?`).get(query.run, id);
                 if (!run || run.status !== "succeeded" || run.main_file !== mainFile) {
-                    return apiError(reply, 404, "PDF_NOT_FOUND", "指定的编译 PDF 不存在");
+                    return apiError(reply, 404, "PDF_NOT_FOUND");
                 }
                 artifact = compileRunPdf(config, id, mainFile, query.run);
                 if (!artifact)
-                    return apiError(reply, 404, "PDF_NOT_FOUND", "指定的编译 PDF 已被清理");
+                    return apiError(reply, 404, "PDF_NOT_FOUND");
                 versioned = true;
             }
             else if (artifact.version !== query.run) {
-                return apiError(reply, 404, "PDF_NOT_FOUND", "指定的编译 PDF 不存在");
+                return apiError(reply, 404, "PDF_NOT_FOUND");
             }
         }
         const pdf = artifact.path;
         const stat = regularFileStat(pdf);
         if (!stat)
-            return apiError(reply, 404, "PDF_NOT_FOUND", "尚未生成 PDF");
+            return apiError(reply, 404, "PDF_NOT_FOUND");
         const etag = `"${stat.size.toString(16)}-${Math.trunc(stat.mtimeMs).toString(16)}"`;
         reply.header("Content-Type", "application/pdf");
         const targetSuffix = mainFile === project.main_file ? "" : `-${texFileStem(mainFile)}`;
@@ -721,7 +742,7 @@ export function registerCompileRoutes(app, context) {
             }
             catch (error) {
                 if (isMissingFileError(error))
-                    return apiError(reply, 404, "PDF_NOT_FOUND", "尚未生成 PDF");
+                    return apiError(reply, 404, "PDF_NOT_FOUND");
                 throw error;
             }
             return reply.code(206).send(stream);
@@ -733,7 +754,7 @@ export function registerCompileRoutes(app, context) {
         }
         catch (error) {
             if (isMissingFileError(error))
-                return apiError(reply, 404, "PDF_NOT_FOUND", "尚未生成 PDF");
+                return apiError(reply, 404, "PDF_NOT_FOUND");
             throw error;
         }
         return reply.code(200).send(stream);