Log texlab events to dedicated file and handle exited processes

Author: Makiras

services/web/app/src/Features/Texlab/TexlabController.mjs

@@ -1,6 +1,6 @@
 import SessionManager from '../Authentication/SessionManager.mjs'
-import logger from '@overleaf/logger'
 import TexlabManager from './TexlabManager.mjs'
+import texlabLogger from './TexlabLogger.mjs'
 
 async function complete(req, res) {
   const userId = SessionManager.getLoggedInUserId(req.session)
@@ -20,7 +20,7 @@ async function complete(req, res) {
     })
     res.json({ items: result.items || [] })
   } catch (err) {
-    logger.error({ err, userId, projectId }, '[Texlab] completion failed')
+    texlabLogger.error({ err, userId, projectId }, '[Texlab] completion failed')
     res.status(500).json({ error: 'texlab completion failed' })
   }
 }

services/web/app/src/Features/Texlab/TexlabLogger.mjs

@@ -0,0 +1,55 @@
+import fs from 'node:fs'
+import path from 'node:path'
+import logger from '@overleaf/logger'
+
+const TEXLAB_LOG_PATH =
+  process.env.TEXLAB_LOG_PATH ||
+  path.join(process.cwd(), 'logs', 'texlab.log')
+
+let texlabStream = null
+try {
+  fs.mkdirSync(path.dirname(TEXLAB_LOG_PATH), { recursive: true })
+  texlabStream = fs.createWriteStream(TEXLAB_LOG_PATH, { flags: 'a' })
+} catch (err) {
+  logger.warn({ err, TEXLAB_LOG_PATH }, '[Texlab] failed to open log file')
+}
+
+const levels = ['debug', 'info', 'warn', 'error']
+
+function toEntry(attributes, message) {
+  const base =
+    typeof attributes === 'string'
+      ? { msg: attributes }
+      : attributes || {}
+  if (message) {
+    return { ...base, msg: message }
+  }
+  return base
+}
+
+function write(level, attributes, message, ...args) {
+  const entry = toEntry(attributes, message)
+  const payload = {
+    ...entry,
+    level,
+    time: new Date().toISOString(),
+  }
+
+  // keep existing web logs
+  if (typeof logger[level] === 'function') {
+    logger[level](attributes, message, ...args)
+  }
+
+  // append to dedicated texlab log file
+  if (texlabStream) {
+    texlabStream.write(JSON.stringify(payload) + '\n')
+  }
+}
+
+const texlabLogger = {}
+for (const level of levels) {
+  texlabLogger[level] = (attributes, message, ...args) =>
+    write(level, attributes, message, ...args)
+}
+
+export default texlabLogger

services/web/app/src/Features/Texlab/TexlabManager.mjs

@@ -1,6 +1,6 @@
 import { spawn } from 'node:child_process'
 import { TextDecoder } from 'node:util'
-import logger from '@overleaf/logger'
+import texlabLogger from './TexlabLogger.mjs'
 
 const decoder = new TextDecoder()
 const TEXLAB_PATH = process.env.TEXLAB_PATH || 'texlab'
@@ -48,7 +48,7 @@ class TexlabProcess {
       this.tryParse()
     })
     this.child.stderr.on('data', data => {
-      logger.debug({ err: decoder.decode(data) }, '[Texlab] stderr')
+      texlabLogger.debug({ err: decoder.decode(data) }, '[Texlab] stderr')
     })
     this.child.on('error', err => {
       this.exited = true
@@ -59,7 +59,7 @@ class TexlabProcess {
     })
     this.child.on('exit', code => {
       this.exited = true
-      logger.debug({ code }, '[Texlab] texlab exit')
+      texlabLogger.debug({ code }, '[Texlab] texlab exit')
       for (const [, { reject }] of this.pending) {
         reject(new Error('texlab exited'))
       }
@@ -86,7 +86,7 @@ class TexlabProcess {
         const json = JSON.parse(body)
         this.handleResponse(json)
       } catch (err) {
-        logger.warn({ err }, '[Texlab] Failed to parse response')
+        texlabLogger.warn({ err }, '[Texlab] Failed to parse response')
       }
     }
   }
@@ -222,7 +222,7 @@ class TexlabProcess {
     try {
       this.child.kill()
     } catch (err) {
-      logger.warn({ err }, '[Texlab] dispose error')
+      texlabLogger.warn({ err }, '[Texlab] dispose error')
     }
     for (const [, { reject }] of this.pending) {
       reject(new Error('texlab disposed'))