copilot (#27)

* copilot

* 根据社区建议修改：1.精简注释，更改注释为中文。2.减少挂载数目，核心代码放在app下3.修改develop/docker-compose.dev.ymlip限制4.排除不必要文件5.解决newline at the end of file等

* 根据社区建议修改：1.精简注释，更改注释为中文。2.减少挂载数目，核心代码放在app下3.修改develop/docker-compose.dev.ymlip限制4.排除不必要文件5.解决newline at the end of file等

* 补充修改换行

* 部分优化

* 部分优化

* Delete services/web/.dockerignore

* Add .dockerignore to web service

* 部分优化

* 优化

* 优化settings使用

* 优化

* runit

* llm-toolbar.tsx style调整

* model choose

* apply 1.patch

* delete 1.patch

Author: HGChuang

.gitignore

@@ -3,4 +3,4 @@
 
 # user defined files
 .env
-docker-compose.override.yml
+docker-compose.override.yml

develop/dev.env

@@ -8,11 +8,13 @@ GRACEFUL_SHUTDOWN_DELAY_SECONDS=0
 HISTORY_V1_HOST=history-v1
 LISTEN_ADDRESS=0.0.0.0
 MONGO_HOST=mongo
+LLM_HOST=llm
 MONGO_URL=mongodb://mongo/sharelatex?directConnection=true
 NOTIFICATIONS_HOST=notifications
 PROJECT_HISTORY_HOST=project-history
 REALTIME_HOST=real-time
 REDIS_HOST=redis
+REDIS_URL=redis://redis:6379
 SPELLING_HOST=spelling
 WEBPACK_HOST=webpack
 WEB_API_PASSWORD=overleaf

develop/docker-compose.dev.yml

@@ -84,7 +84,7 @@ services:
     environment:
       - NODE_OPTIONS=--inspect=0.0.0.0:9229
     ports:
-      - "127.0.0.1:9236:9229"
+      - "127.0.0.1:9238:9229"
     volumes:
       - ../services/references/app:/overleaf/services/references/app
       - ../services/references/config:/overleaf/services/references/config
@@ -123,8 +123,20 @@ services:
       - ../services/real-time/app.js:/overleaf/services/real-time/app.js
       - ../services/real-time/config:/overleaf/services/real-time/config
 
+  llm:
+    command: ["node", "--watch", "app.js"]
+    environment:
+      - NODE_OPTIONS=--inspect=0.0.0.0:9229
+    ports:
+      - "127.0.0.1:9241:9229"
+    volumes:
+      - ../services/llm/app:/overleaf/app
+      - ../services/llm/app.js:/overleaf/services/llm/app.js
+      - ../services/llm/config:/overleaf/services/llm/config
+      
+
   web:
-    command: ["node", "--watch", "app.js", "--watch-locales"]
+    command: ["node", "--watch", "app.mjs", "--watch-locales"]
     environment:
       - NODE_OPTIONS=--inspect=0.0.0.0:9229
     ports:

develop/docker-compose.yml

@@ -123,6 +123,8 @@ services:
       dockerfile: services/real-time/Dockerfile
     env_file:
       - dev.env
+    environment:
+      - SESSION_SECRET=helloworld
 
   redis:
     image: redis:5
@@ -140,6 +142,16 @@ services:
     volumes:
       - spelling-cache:/overleaf/services/spelling/cache
 
+  llm:
+    build:
+      context: ..
+      dockerfile: services/llm/Dockerfile
+    env_file:
+      - dev.env
+    depends_on:
+      - mongo
+      - redis
+
   web:
     build:
       context: ..
@@ -153,7 +165,8 @@ services:
       - EMAIL_CONFIRMATION_DISABLED=true
       - NODE_ENV=development
       - OVERLEAF_ALLOW_PUBLIC_ACCESS=true
-    command: ["node", "app.js"]
+      - SESSION_SECRET=helloworld
+    command: ["node", "app.mjs"]
     volumes:
       - sharelatex-data:/var/lib/overleaf
       - web-data:/overleaf/services/web/data
@@ -172,8 +185,10 @@ services:
       - project-history
       - real-time
       - spelling
+      - llm
 
   webpack:
+    user: root
     build:
       context: ..
       dockerfile: services/web/Dockerfile

docker-compose.yml

@@ -153,4 +153,4 @@ services:
     #       - "443:443"
     #     volumes:
     #       - /var/run/docker.sock:/tmp/docker.sock:ro
-    #       - /home/overleaf/tmp:/etc/nginx/certs
+    #       - /home/overleaf/tmp:/etc/nginx/certs

package.json

@@ -59,6 +59,7 @@
     "services/history-v1",
     "services/idp",
     "services/latexqc",
+    "services/llm",
     "services/notifications",
     "services/project-history",
     "services/real-time",

server-ce/runit/llm-overleaf/run

@@ -0,0 +1,16 @@
+#!/bin/bash
+
+NODE_PARAMS=""
+if [ "$DEBUG_NODE" == "true" ]; then
+	  echo "running debug - llm"
+	  NODE_PARAMS="--inspect=0.0.0.0:30120"
+fi
+
+if [ -z "$REDIS_URL" ] && [ -n "$REDIS_HOST" ]; then
+	export REDIS_URL="redis://$REDIS_HOST:${REDIS_PORT:-6379}"
+fi
+if [ -z "$MONGO_URL" ] && [ -n "$OVERLEAF_MONGO_URL" ]; then
+	export MONGO_URL="$OVERLEAF_MONGO_URL"
+fi
+
+exec /sbin/setuser www-data /usr/bin/node $NODE_PARAMS /overleaf/services/llm/app.js >> /var/log/overleaf/llm.log 2>&1

services/llm/Dockerfile

@@ -0,0 +1,22 @@
+FROM node:20.19.5 AS base
+
+WORKDIR /overleaf/services/llm
+
+
+FROM base AS app
+
+COPY package.json package-lock.json /overleaf/
+COPY services/llm/package.json /overleaf/services/llm/
+COPY libraries/ /overleaf/libraries/
+COPY patches/ /overleaf/patches/
+
+
+RUN cd /overleaf && npm install
+
+COPY services/llm/ /overleaf/services/llm/
+
+FROM app
+USER node
+CMD ["node", "--expose-gc", "app.js"]
+
+

services/llm/app.js

@@ -0,0 +1,27 @@
+// src/app.js
+import express from 'express';
+import connectDB from './config/db.js';
+import keysRoutes from './app/routes/keys.routes.js';
+import llmRoutes from './app/routes/llm.routes.js';
+import cookieParser from 'cookie-parser';
+import settings from '@overleaf/settings'
+
+const app = express();
+
+app.use(cookieParser());
+
+app.use(express.json());
+
+// connect to database
+await connectDB();
+
+// register routes
+app.use('/api/v1/llm', keysRoutes);
+
+app.use('/api/v1/llm', llmRoutes);
+
+app.listen(settings.PORT, settings.LISTEN_ADDRESS, () => {
+  console.log(`server running on ${settings.PORT}`);
+});
+
+

services/llm/app/controllers/keys.controller.js

@@ -0,0 +1,80 @@
+import { KeysService } from '../services/keys.service.js';
+import {getUserIdentifier} from '../utils/common.js';
+export class KeysController {
+  constructor() {
+    this.keysService = new KeysService();
+  }
+
+  async saveKey(req, res) {
+    try {
+      const sid = req.cookies['overleaf.sid'];
+      const userIdentifier = await getUserIdentifier(sid);
+      const { name, baseUrl, apiKey } = req.body;
+      await this.keysService.saveApiKey(userIdentifier, name, baseUrl, apiKey);
+      res.status(200).json({ success: true });
+    } catch (error) {
+      res.status(400).json({ success: false, data: error.message });
+    }
+  }
+
+  async deleteKey(req, res) {
+    try {
+      const sid = req.cookies['overleaf.sid'];
+      const userIdentifier = await getUserIdentifier(sid);
+      const { name } = req.body;
+      const result = await this.keysService.deleteApiKey(userIdentifier, name);
+      res.status(200).json({ success: true, data: result });
+    } catch (error) {
+      console.log(error.message)
+      res.status(400).json({ success: false, data: error.message });
+    }
+  }
+
+  async getLlmInfo(req, res) {
+
+    try {
+      const sid = req.cookies['overleaf.sid'];
+      const userIdentifier = await getUserIdentifier(sid);
+      const result = await this.keysService.getLlmInfo(userIdentifier);
+      res.status(200).json({ success: true, data: result });
+    } catch (error) {
+      res.status(400).json({ success: false, data: error.message  });
+    }
+  }
+  async getUsingLlm(req, res) {
+    try {
+      const sid = req.cookies['overleaf.sid'];
+      const userIdentifier = await getUserIdentifier(sid);
+      const result = await this.keysService.getUsingLlm(userIdentifier);
+      res.status(200).json({ success: true, data: result });
+    } catch (error) {
+      res.status(400).json({ success: false, data: error.message });
+    }
+  }
+
+
+  async updateUsingLlm(req, res) {
+    try {
+      const sid = req.cookies['overleaf.sid'];
+      const userIdentifier = await getUserIdentifier(sid);
+      const { usingLlm } = req.body;
+      await this.keysService.updateUsingLlm(userIdentifier, usingLlm);
+      res.status(200).json({ success: true });
+    } catch (error) {
+      res.status(400).json({ success: false, data: error.message });
+    }
+  }
+  async updateUsingModel(req, res) {
+    try {
+      const sid = req.cookies['overleaf.sid'];
+      const userIdentifier = await getUserIdentifier(sid);
+      const { name, chatOrCompletion, newModel } = req.body;
+      await this.keysService.updateUsingModel(userIdentifier, name, chatOrCompletion, newModel);
+      res.status(200).json({ success: true });
+    } catch (error) {
+      res.status(400).json({ success: false, data: error.message });
+    }
+  }
+}
+
+