Merge pull request #1 from tshmieldev/prom

Prom

Author: tshmieldev

.env.example

@@ -1 +1,2 @@
-API_KEY=1234
+API_KEY=1234
+METRICS_API_KEY=5678

README.md

@@ -6,6 +6,13 @@ Prerequisites:
 - docker -> see `https://docs.docker.com/engine/install/`
 - docker image - python:3.10-slim -> `docker pull python:3.10-slim`
 - make sure the user running the code has docker permissions -> `sudo usermod -aG docker $USER`, then reload terminal or `newgrp docker`
+- to consume metrics, set METRICS_API_KEY in `.env` and `prometheus.yml`, then you can:
+```bash
+docker run -p 9090:9090 \
+  -v $(pwd)/prometheus.yml:/etc/prometheus/prometheus.yml \
+  prom/prometheus
+```
+and open localhost:9090
 
 To install dependencies:
 ```sh

bun.lock

@@ -3,4 +3,4 @@
 coveragePathIgnorePatterns = [
   "src/lib/docker.ts",
   "src/lib/files.ts"
-]
+]

bunfig.toml

@@ -5,6 +5,7 @@
         "start": "bun run src/index.ts"
     },
     "dependencies": {
+        "@hono/prometheus": "^1.0.2",
         "@hono/swagger-ui": "^0.5.2",
         "@hono/zod-openapi": "^1.1.4",
         "@scalar/hono-api-reference": "^0.9.22",
@@ -13,6 +14,9 @@
         "zod": "^4.0.14"
     },
     "devDependencies": {
-        "@types/bun": "^1.3.1"
+        "@types/bun": "^1.3.1",
+        "@typescript-eslint/eslint-plugin": "^8.46.2",
+        "@typescript-eslint/parser": "^8.46.2",
+        "eslint": "^9.38.0"
     }
 }

package.json

@@ -0,0 +1,7 @@
+scrape_configs:
+    - job_name: "runalyzer"
+      static_configs:
+          - targets: ["host.docker.internal:3001"]
+      metrics_path: /metrics
+      bearer_token: "5678"
+      scrape_interval: 1s

prometheus.yml

@@ -0,0 +1,19 @@
+[tool.pyright]
+# Global settings
+reportIncompatibleMethodOverride = false
+
+# Main configuration for src/lib/python
+include = ["src/lib/python/**/*.py"]
+reportOptionalMemberAccess = false
+reportMissingImports = false
+reportAny = false
+
+[[tool.pyright.executionEnvironments]]
+# Here, pretty much all rules must be disabled
+# This code will be executed in a container
+# And so, the linter does not know the context, and is unhappy about it.
+root = "tests/data"
+reportIncompatibleMethodOverride = false
+reportMissingImports = false
+reportAny = false
+reportMissingTypeArgument = false

pyproject.toml

@@ -0,0 +1,34 @@
+import {
+    OpenAPIHono,
+    type RouteConfigToTypedResponse,
+} from "@hono/zod-openapi";
+import { metricsRoute } from "../lib/openapi";
+import { printMetrics } from "../lib/prometheus";
+
+const app = new OpenAPIHono();
+
+// Path is overriden, as I prefer to have the
+// full path in lib/openapi.ts to keep the
+// semantics there and in index.ts
+app.openapi(
+    { ...metricsRoute, path: "/" },
+    async (c): Promise<RouteConfigToTypedResponse<typeof metricsRoute>> => {
+        if (
+            c.req.header("authorization") !==
+            `Bearer ${process.env.METRICS_API_KEY}`
+        ) {
+            return c.json(
+                {
+                    success: false,
+                    error: "Unauthorized",
+                },
+                401,
+            );
+        }
+        return printMetrics(c) as unknown as RouteConfigToTypedResponse<
+            typeof metricsRoute
+        >;
+    },
+);
+
+export default app;

src/controllers/metrics.ts

@@ -1,14 +1,20 @@
-import { OpenAPIHono, type RouteConfigToTypedResponse } from "@hono/zod-openapi";
+import {
+    OpenAPIHono,
+    type RouteConfigToTypedResponse,
+} from "@hono/zod-openapi";
 import { statusRoute } from "../lib/openapi";
 import { getActiveContainers } from "../lib/docker";
 
 const app = new OpenAPIHono();
 
+// Path is overriden, as I prefer to have the
+// full path in lib/openapi.ts to keep the
+// semantics there and in index.ts
 app.openapi(
     { ...statusRoute, path: "/" },
     async (c): Promise<RouteConfigToTypedResponse<typeof statusRoute>> => {
         return c.json({ runningContainers: getActiveContainers().size }, 200);
     },
 );
 
-export default app;
+export default app;

src/controllers/status.ts

@@ -1,98 +1,114 @@
 import {
-  OpenAPIHono,
-  type RouteConfigToTypedResponse,
+    OpenAPIHono,
+    type RouteConfigToTypedResponse,
 } from "@hono/zod-openapi";
 import { runUnitTestRequestSchema } from "../lib/validation";
 import { v4 } from "uuid";
 import {
-  cleanupSessionDirectory,
-  createSessionDirectory,
-  prepareUnitTestFiles,
+    cleanupSessionDirectory,
+    createSessionDirectory,
+    prepareUnitTestFiles,
 } from "../lib/files";
 import {
-  buildDockerCommand,
-  getContainerName,
-  trackContainer,
-  untrackContainer,
+    buildDockerCommand,
+    getContainerName,
+    trackContainer,
+    untrackContainer,
 } from "../lib/docker";
 import { unitTestRoute } from "../lib/openapi";
 
 const app = new OpenAPIHono();
 
+// Path is overriden, as I prefer to have the
+// full path in lib/openapi.ts to keep the
+// semantics there and in index.ts
 app.openapi(
-  { ...unitTestRoute, path: "/" },
-  async (c): Promise<RouteConfigToTypedResponse<typeof unitTestRoute>> => {
-    let body = null;
+    { ...unitTestRoute, path: "/" },
+    async (c): Promise<RouteConfigToTypedResponse<typeof unitTestRoute>> => {
+        let body = null;
 
-    try {
-      body = await c.req.json();
-    } catch {
-      return c.json({ success: false, error: "Invalid JSON" }, 400);
-    }
+        try {
+            body = await c.req.json();
+        } catch {
+            return c.json({ success: false, error: "Invalid JSON" }, 400);
+        }
 
-    const validatedData = runUnitTestRequestSchema.safeParse(body);
+        const validatedData = runUnitTestRequestSchema.safeParse(body);
 
-    if (!validatedData.success) {
-      return c.json(
-        { success: false, error: validatedData.error.message },
-        400,
-      );
-    }
+        if (!validatedData.success) {
+            return c.json(
+                { success: false, error: validatedData.error.message },
+                400,
+            );
+        }
 
-    const { user_code, unit_tests, api_key, config } = validatedData.data;
+        const { user_code, unit_tests, api_key, config } = validatedData.data;
 
-    if (api_key !== Bun.env.API_KEY) {
-      return c.json({ success: false, error: "Invalid API key" }, 401);
-    }
+        if (api_key !== Bun.env.API_KEY) {
+            return c.json({ success: false, error: "Invalid API key" }, 401);
+        }
 
-    // Create unique session
-    const sessionId = v4();
-    const sessionPath = await createSessionDirectory(sessionId);
-    const containerName = getContainerName(sessionId);
+        // Create unique session
+        const sessionId = v4();
+        const sessionPath = await createSessionDirectory(sessionId);
+        const containerName = getContainerName(sessionId);
 
-    try {
-      // Setup files and container
-      await prepareUnitTestFiles(sessionPath, user_code, unit_tests);
-      trackContainer(containerName);
+        try {
+            // Setup files and container
+            await prepareUnitTestFiles(sessionPath, user_code, unit_tests);
+            trackContainer(containerName);
 
-      // Execute in Docker
-      const command = buildDockerCommand(
-        sessionId,
-        sessionPath,
-        "unit-test",
-        config,
-      );
-      const proc = Bun.spawn(command, {
-        stdout: "pipe",
-        stderr: "pipe",
-      });
+            // Execute in Docker
+            const command = buildDockerCommand(sessionId, sessionPath, config);
+            const proc = Bun.spawn(command, {
+                stdout: "pipe",
+                stderr: "pipe",
+            });
 
-      const stdout = await new Response(proc.stdout).text();
-      const stderr = await new Response(proc.stderr).text();
+            const stdout = await new Response(proc.stdout).text();
+            const stderr = await new Response(proc.stderr).text();
 
-      // Wait for process to complete and get exit code
-      const exitCode = await proc.exited;
+            // Wait for process to complete and get exit code
+            const exitCode = await proc.exited;
 
-      const result = stdout ? JSON.parse(stdout) : undefined;
+            const result = stdout ? JSON.parse(stdout) : undefined;
 
-      return c.json(
-        {
-          success: exitCode == 0,
-          runalyzer_output: result,
-          runalyzer_errors:
-            stderr || (exitCode === 124 ? "Time limit exceeded" : ""),
-          exit_code: exitCode,
-        },
-        200,
-      );
-    } catch (error) {
-      console.error(error);
-      return c.json({ success: false, error: "Internal server error" }, 500);
-    } finally {
-      untrackContainer(containerName);
-      await cleanupSessionDirectory(sessionPath, sessionId);
-    }
-  },
+            // Yes, this could be one return
+            // But typescript wants it to be split
+            // Because of the discriminatory union
+            if (exitCode === 0) {
+                return c.json(
+                    {
+                        success: true,
+                        runalyzer_output: result,
+                        runalyzer_errors: stderr,
+                        exit_code: exitCode,
+                    },
+                    200,
+                );
+            }
+            return c.json(
+                {
+                    success: false,
+                    runalyzer_output: result,
+                    runalyzer_errors:
+                        stderr ||
+                        (exitCode === 124 ? "Time limit exceeded" : ""),
+                    exit_code: exitCode,
+                },
+                200,
+            );
+        } catch (error) {
+            console.error(error);
+            return c.json(
+                { success: false, error: "Internal server error" },
+                500,
+            );
+        } finally {
+            untrackContainer(containerName);
+            await cleanupSessionDirectory(sessionPath, sessionId);
+        }
+    },
 );
 
 export default app;