@monodog/backend 1.1.22 → 1.2.0

package/README.md

@@ -0,0 +1,72 @@
+# Monodog: Monorepo Analytics and Health API
+
+## 🎯 Overview
+
+This is the backend service designed to provide comprehensive analytics, health monitoring, and dependency tracking for a large **JavaScript/TypeScript monorepo**.
+It leverages specialized **@monodog** tools and a database layer (via **Prisma**) to efficiently manage, persist, and expose data about all packages within the repository.
+
+This service is typically run locally or on a central server to power a dedicated frontend dashboard.
+
+---
+
+## 🛠 Technology Stack
+
+| Component | Technology | Description |
+|------------|-------------|--------------|
+| **Language** | TypeScript & Node.js | Core language for runtime execution. |
+| **Framework** | Express.js | Handles all API routing and middleware. |
+| **ORM** | Prisma | Database layer for managing package and health status records. |
+| **Scanning** | @monodog/monorepo-scanner | Core logic for file system scanning and package metadata extraction. |
+| **VCS** | GitService | Used to fetch and analyze commit history per package path. |
+| **Networking** | cors, body-parser | Essential middleware for API connectivity. |
+
+---
+
+## ⚙️ Prerequisites
+
+You must have the following installed to run the service:
+
+- **Node.js:** Version 18+ recommended
+- **Package Manager:** `pnpm` or `npm` (use the one your monorepo uses)
+- **Database:** A running instance of a database supported by Prisma (e.g., PostgreSQL, SQLite, MySQL)
+
+---
+
+## 🚀 Getting Started
+
+###  Installation
+
+Clone the repository and install the dependencies:
+
+```bash
+# Clone the repository
+git clone https://github.com/lakinmindfire/MonoDog.git
+cd packages/backend
+
+# Install dependencies
+pnpm install
+
+# Database Setup (Prisma)
+
+The application requires the database schema to be set up using **Prisma Migrate**.
+
+pnpm prisma generate
+
+pnpm prisma migrate dev
+
+### Run backend server on port 4000 (default)
+
+pnpm monodog-cli --serve --root .
+```
+
+### Key API Endpoints
+
+| Method | Route | Purpose | Persistence |
+|--------|--------|----------|-------------|
+| **GET** | `/api/packages` | Retrieve all package metadata from the database. | Cached / Persistent |
+| **GET** | `/api/packages/refresh` | Trigger a full file scan of the monorepo and update/sync the database. | Triggers write |
+| **GET** | `/api/packages/:name` | Get detailed info, reports, and CI status for a package. | Cached / Persistent |
+| **GET** | `/api/health/packages` | Fetch the latest health metrics (score, build status) for all packages. | Persistent |
+| **GET** | `/api/health/refresh` | Recalculate all package health metrics (tests, lint, security) and update the database. | Triggers write |
+| **GET** | `/api/commits/:packagePath` | Fetch Git commit history for a specific package directory. | Generated runtime |
+| **GET** | `/api/config/files` | Scan the monorepo for essential configuration files (e.g., `tsconfig`, `.eslintrc`). | Generated runtime |

package/dist/cli.js

@@ -155,9 +155,9 @@ function copyPackageToWorkspace(rootDir) {
         // Post-copy instructions
         console.log("\n*** IMPORTANT NEXT STEPS (MANDATORY) ***");
         console.log("1.Migrate Database:");
-        console.log(`   - pnpm exec prisma migrate --schema ./node_modules/${folderName}/backend/prisma/schema.prisma`);
+        console.log(`   - pnpm prisma migrate --schema ./node_modules/@monodog/backend/prisma/schema.prisma`);
         console.log("2. Generate Client:");
-        console.log(`   - pnpm exec prisma generate --schema ./node_modules/${folderName}/backend/prisma/schema.prisma`);
+        console.log(`   - pnpm exec prisma generate --schema ./node_modules/@monodog/backend/prisma/schema.prisma`);
         console.log("3. Run Backend app server with dashboard setup");
         console.log(`   - pnpm monodog-cli @monodog/dashboard --serve --root .`);
     }

package/dist/index.js

@@ -115,7 +115,7 @@ function startServer(rootPath) {
             const packages = (0, helpers_1.scanMonorepo)(rootDir);
             console.log('packages -->', packages.length);
             for (const pkg of packages) {
-                (0, helpers_2.storePackage)(pkg);
+                await (0, helpers_2.storePackage)(pkg);
             }
             res.json(packages);
         }
@@ -229,25 +229,24 @@ function startServer(rootPath) {
         }
     });
     // Get dependency graph
-    app.get('/api/graph', async (_req, res) => {
-        try {
-            const packages = (0, helpers_1.scanMonorepo)(process.cwd());
-            const graph = (0, helpers_1.generateDependencyGraph)(packages);
-            const circularDeps = (0, helpers_1.findCircularDependencies)(packages);
-            res.json({
-                ...graph,
-                circularDependencies: circularDeps,
-                metadata: {
-                    totalNodes: graph.nodes.length,
-                    totalEdges: graph.edges.length,
-                    circularDependencies: circularDeps.length,
-                },
-            });
-        }
-        catch (error) {
-            res.status(500).json({ error: 'Failed to generate dependency graph' });
-        }
-    });
+    // app.get('/api/graph', async (_req, res) => {
+    //   try {
+    //     const packages = scanMonorepo(process.cwd());
+    //     const graph = generateDependencyGraph(packages);
+    //     const circularDeps = findCircularDependencies(packages);
+    //     res.json({
+    //       ...graph,
+    //       circularDependencies: circularDeps,
+    //       metadata: {
+    //         totalNodes: graph.nodes.length,
+    //         totalEdges: graph.edges.length,
+    //         circularDependencies: circularDeps.length,
+    //       },
+    //     });
+    //   } catch (error) {
+    //     res.status(500).json({ error: 'Failed to generate dependency graph' });
+    //   }
+    // });
     // Get monorepo statistics
     app.get('/api/stats', async (_req, res) => {
         try {
@@ -1106,7 +1105,7 @@ function startServer(rootPath) {
         console.log(`   - GET  /api/packages`);
         console.log(`   - GET  /api/packages/:name`);
         console.log(`   - GET  /api/commits/:packagePath`);
-        console.log(`   - GET  /api/graph`);
+        // console.log(`   - GET  /api/graph`);
         console.log(`   - GET  /api/stats`);
         console.log(`   - GET  /api/ci/status`);
         console.log(`   - POST /api/ci/trigger`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@monodog/backend",
-  "version": "1.1.22",
+  "version": "1.2.0",
   "description": "Backend API server for monodog monorepo dashboard",
   "main": "dist/index.js",
   "license": "MIT",

package/src/cli.ts

@@ -138,9 +138,9 @@ function copyPackageToWorkspace(rootDir: string): void  {
         // Post-copy instructions
         console.log("\n*** IMPORTANT NEXT STEPS (MANDATORY) ***");
         console.log("1.Migrate Database:");
-        console.log(`   - pnpm exec prisma migrate --schema ./node_modules/${folderName}/backend/prisma/schema.prisma`);
+        console.log(`   - pnpm prisma migrate --schema ./node_modules/@monodog/backend/prisma/schema.prisma`);
         console.log("2. Generate Client:");
-        console.log(`   - pnpm exec prisma generate --schema ./node_modules/${folderName}/backend/prisma/schema.prisma`);
+        console.log(`   - pnpm exec prisma generate --schema ./node_modules/@monodog/backend/prisma/schema.prisma`);
         console.log("3. Run Backend app server with dashboard setup");
         console.log(`   - pnpm monodog-cli @monodog/dashboard --serve --root .`);
 

package/src/index.ts

@@ -145,7 +145,7 @@ app.get('/api/packages/refresh', async (_req, res) => {
     const packages = scanMonorepo(rootDir);
     console.log('packages -->', packages.length);
     for (const pkg of packages) {
-      storePackage(pkg)
+      await storePackage(pkg)
     }
 
     res.json(packages);
@@ -275,25 +275,25 @@ app.get('/api/commits/:packagePath', async (_req, res) => {
 });
 
 // Get dependency graph
-app.get('/api/graph', async (_req, res) => {
-  try {
-    const packages = scanMonorepo(process.cwd());
-    const graph = generateDependencyGraph(packages);
-    const circularDeps = findCircularDependencies(packages);
+// app.get('/api/graph', async (_req, res) => {
+//   try {
+//     const packages = scanMonorepo(process.cwd());
+//     const graph = generateDependencyGraph(packages);
+//     const circularDeps = findCircularDependencies(packages);
 
-    res.json({
-      ...graph,
-      circularDependencies: circularDeps,
-      metadata: {
-        totalNodes: graph.nodes.length,
-        totalEdges: graph.edges.length,
-        circularDependencies: circularDeps.length,
-      },
-    });
-  } catch (error) {
-    res.status(500).json({ error: 'Failed to generate dependency graph' });
-  }
-});
+//     res.json({
+//       ...graph,
+//       circularDependencies: circularDeps,
+//       metadata: {
+//         totalNodes: graph.nodes.length,
+//         totalEdges: graph.edges.length,
+//         circularDependencies: circularDeps.length,
+//       },
+//     });
+//   } catch (error) {
+//     res.status(500).json({ error: 'Failed to generate dependency graph' });
+//   }
+// });
 
 // Get monorepo statistics
 app.get('/api/stats', async (_req, res) => {
@@ -1279,7 +1279,7 @@ app.listen(PORT, () => {
   console.log(`   - GET  /api/packages`);
   console.log(`   - GET  /api/packages/:name`);
   console.log(`   - GET  /api/commits/:packagePath`);
-  console.log(`   - GET  /api/graph`);
+  // console.log(`   - GET  /api/graph`);
   console.log(`   - GET  /api/stats`);
   console.log(`   - GET  /api/ci/status`);
   console.log(`   - POST /api/ci/trigger`);