[WEB + CLSI] Download as docx file feature (#32851)

* using CLSI logic for fetching the project contents and skip the .zip export

* Use unique conversion directory for project-to-docx export to avoid corrupting the shared compile
  directory when a compile runs concurrently

* Remove X-Accel-Buffering header — not needed as CLSI does not run behind nginx

* moving log before sending the data

* Return CLSI stream directly instead of buffering to disk on web

  Previously convertProjectToDocx wrote the CLSI response to a temp file
  on disk, then the controller read it back to stream to the client.
  Now the stream is returned directly and piped to the response,
  avoiding unnecessary disk I/O on the web server.

* Use href redirect for docx export instead of fetching blob into memory

* making functions and files more generic so they can be used in future for other documents exports as well

* adding export-docx split test

* adding unit tests

* adding cypress E2E test

* format:fix

* renaming the route to download from convert

* adding new icon for export docx button

* format:fix

* remove unused showExportDocumentErrorToast export and adding guard against invalid Content-Length header from CLSI

* format:fix

* refactor(clsi): move promisify(parse) into RequestParser

* refactor: generic conversion endpoint with type as route
  param

* refactor: use type→extension map for validated conversion types

* refactor(clsi): remove --standalone flag and fix rejection test

* fixing the href in cypress test

* renaming function

* adding type to Metrics.inc

* fix: rename exportProjectDocument, add WithLock wrapper and metrics type label

* format:fix

* fix: hide docx export from anonymous users and add WithLock wrapper

* format fix

* remove redundant Content-Length validation from DocumentConversionManager

* format:fix

* removing trailing icon

GitOrigin-RevId: e9764fefac2c4b625d23be9e942ea4a8b283c70d
This commit is contained in:
Davinder Singh
2026-04-24 08:06:10 +00:00
committed by Copybot
parent b6ec7945f4
commit be5a7b56c8
20 changed files with 772 additions and 41 deletions
@@ -1,5 +1,6 @@
import Settings from '@overleaf/settings'
import CompileManager from '../Compile/CompileManager.mjs'
import ClsiManager from '../Compile/ClsiManager.mjs'
import fs from 'node:fs'
import fsPromises from 'node:fs/promises'
import logger from '@overleaf/logger'
@@ -38,14 +39,7 @@ async function convertDocxToLaTeXZipArchive(path, userId) {
signal: abortController.signal,
})
const contentLengthHeader = response.headers.get('Content-Length')
if (contentLengthHeader == null) {
logger.warn(
'CLSI did not provide Content-Length header for converted document'
)
throw new OError('CLSI response missing Content-Length header')
}
const contentLength = parseInt(contentLengthHeader, 10)
const contentLength = parseInt(response.headers.get('Content-Length'), 10)
if (contentLength > Settings.maxUploadSize) {
abortController.abort()
stream.destroy()
@@ -77,8 +71,35 @@ async function convertDocxToLaTeXZipArchive(path, userId) {
return outputPath
}
async function convertProjectToDocument(projectId, userId, type) {
const limits = await CompileManager.promises._getUserCompileLimits(userId)
const clsiRequest =
await ClsiManager.promises.buildDocumentConversionRequest(projectId)
const clsiUrl = new URL(Settings.apis.clsi.url)
clsiUrl.pathname = `/project/${projectId}/user/${userId}/download/project-to-document`
clsiUrl.searchParams.set('type', type)
clsiUrl.searchParams.set('compileBackendClass', limits.compileBackendClass)
clsiUrl.searchParams.set('compileGroup', limits.compileGroup)
logger.debug(
{ clsiUrl: clsiUrl.toString(), projectId, userId, type },
'sending project to CLSI for document conversion'
)
const { stream, response } = await fetchStreamWithResponse(clsiUrl, {
method: 'POST',
json: clsiRequest,
})
const contentLength = parseInt(response.headers.get('Content-Length'), 10)
return { stream, contentLength }
}
export default {
promises: {
convertDocxToLaTeXZipArchive,
convertProjectToDocument,
},
}