Admin tools: introduce Activ Projects tab on the Manage Site page

- code moved to modules/admin-tools (yu-i-i)
2026-11-14 14:13:43 +01:00 · 2026-09-22 02:41:41 +02:00
parent 8fa8b0dd83
commit 5185548301
5 changed files with 221 additions and 0 deletions
@@ -0,0 +1,101 @@
+import { expressify } from '@overleaf/promise-utils'
+import ProjectGetter from '../../../../app/src/Features/Project/ProjectGetter.mjs'
+import UserGetter from '../../../../app/src/Features/User/UserGetter.mjs'
+import request from 'request'
+import Settings from '@overleaf/settings'
+import logger from '@overleaf/logger'
+
+// Helper function to get all active projects from real-time service
+async function getActiveProjectsFromRealTime() {
+  return new Promise((resolve, reject) => {
+    const realTimeUrl = Settings.apis.realTime?.url || 'http://127.0.0.1:3026'
+    const url = `${realTimeUrl}/clients`
+    const user = Settings.apis.realTime?.user || process.env.WEB_API_USER || 'overleaf'
+    const pass = Settings.apis.realTime?.pass || process.env.WEB_API_PASSWORD || ''
+
+    logger.info({ url, user }, 'Fetching active clients from real-time service')
+
+    request.get({
+      url,
+      auth: { user, pass, sendImmediately: true },
+      json: true,
+      timeout: 10000
+    }, async (error, response, body) => {
+      if (error) {
+        logger.error({ err: error }, 'Error getting active clients from real-time')
+        return resolve([])
+      }
+      if (response.statusCode !== 200) {
+        logger.warn({ statusCode: response.statusCode }, 'Unexpected response from real-time service')
+        return resolve([])
+      }
+      if (!Array.isArray(body)) {
+        logger.warn({ body }, 'Unexpected response body from real-time service')
+        return resolve([])
+      }
+
+      // Group flat client list by project_id
+      const projectMap = new Map()
+      for (const client of body) {
+        if (!projectMap.has(client.project_id)) {
+          projectMap.set(client.project_id, [])
+        }
+        projectMap.get(client.project_id).push(client)
+      }
+
+      logger.info({ projectCount: projectMap.size }, 'Got active projects from real-time')
+
+      try {
+        const enrichedProjects = await Promise.all(
+          [...projectMap.entries()].map(async ([projectId, clients]) => {
+            try {
+              const project = await ProjectGetter.promises.getProject(projectId, {
+                name: 1,
+                _id: 1,
+                owner_ref: 1,
+              })
+              if (!project) {
+                logger.warn({ projectId }, 'Project not found in database')
+                return null
+              }
+              const owner = await UserGetter.promises.getUser(project.owner_ref, {
+                email: 1,
+                first_name: 1,
+                last_name: 1,
+              })
+              return {
+                id: project._id.toString(),
+                name: project.name,
+                owner: owner ? {
+                  email: owner.email,
+                  name: `${owner.first_name || ''} ${owner.last_name || ''}`.trim() || owner.email,
+                } : null,
+                activeUsers: clients.map(c => ({
+                  name: `${c.first_name} ${c.last_name}`.trim() || c.email || 'Unknown',
+                  email: c.email,
+                })),
+                connectionCount: clients.length,
+              }
+            } catch (err) {
+              logger.error({ err, projectId }, 'Error enriching project data')
+              return null
+            }
+          })
+        )
+        resolve(enrichedProjects.filter(p => p !== null))
+      } catch (err) {
+        logger.error({ err }, 'Error processing active projects')
+        resolve([])
+      }
+    })
+  })
+}
+
+async function activeProjects(req, res) {
+  const activeProjects = await getActiveProjectsFromRealTime()
+  res.json(activeProjects)
+}
+
+export default {
+  activeProjects: expressify(activeProjects),
+}
@@ -1,6 +1,7 @@
 import logger from '@overleaf/logger'
 import UserListController from './UserListController.mjs'
 import ProjectListController from './ProjectListController.mjs'
+import AdminToolsController from './AdminToolsController.mjs'
 import AuthorizationMiddleware from '../../../../app/src/Features/Authorization/AuthorizationMiddleware.mjs'
 import AuthenticationController from '../../../../app/src/Features/Authentication/AuthenticationController.mjs'

@@ -77,5 +78,10 @@ export default {
      AuthorizationMiddleware.ensureUserIsSiteAdmin,
      ProjectListController.undeleteProject
    )
+
+    webRouter.get('/admin/active-projects',
+      AuthorizationMiddleware.ensureUserIsSiteAdmin,
+      AdminToolsController.activeProjects,
+    )
  },
 }
@@ -0,0 +1,8 @@
+meta(name="ol-dummy", content="placeholder")
+
+h3 Active Projects (Currently Being Edited)
+p.text-muted Real-time information from the editor service showing who is actively working on which projects.
+#active-projects-container
+
+each file in entrypointScripts('modules/admin-tools/pages/active-projects')
+  script(type='text/javascript' nonce=scriptNonce src=file)