@oas-tools/oas-telemetry 0.6.2 → 0.7.0-alpha.0

package/src/controllers/telemetryController.js

@@ -1,69 +0,0 @@
-import v8 from 'v8';
-import { globalOasTlmConfig } from '../config.js';
-
-
-export const startTelemetry = (req, res) => {
-    globalOasTlmConfig.dynamicExporter.exporter.start();
-    res.send('Telemetry started');
-}
-
-export const stopTelemetry = (req, res) => {
-    globalOasTlmConfig.dynamicExporter.exporter.stop();
-    res.send('Telemetry stopped');
-}
-
-export const statusTelemetry = (req, res) => {
-    const isRunning = globalOasTlmConfig.dynamicExporter.exporter.isRunning() || false;
-    res.send({ active: isRunning });
-}
-
-export const resetTelemetry = (req, res) => {
-    globalOasTlmConfig.dynamicExporter.exporter.reset();
-    res.send('Telemetry reset');
-}
-
-export const listTelemetry = async (req, res) => {
-    try {
-        const spans = await globalOasTlmConfig.dynamicExporter.exporter.getFinishedSpans();
-        res.send({ spansCount: spans.length, spans: spans });
-    } catch (err) {
-        console.error(err);
-        res.status(500).send({ error: 'Failed to list telemetry data' });
-    }
-}
-
-export const heapStats = (req, res) => {
-    var heapStats = v8.getHeapStatistics();
-    var roundedHeapStats = Object.getOwnPropertyNames(heapStats).reduce(function (map, stat) {
-        map[stat] = Math.round((heapStats[stat] / 1024 / 1024) * 1000) / 1000;
-        return map;
-    }, {});
-    roundedHeapStats['units'] = 'MB';
-    res.send(roundedHeapStats);
-}
-
-export const findTelemetry = (req, res) => {
-    const body = req.body;
-    const search = body?.search ? body.search : {};
-    if (body?.flags?.containsRegex) {
-        try {
-            body.config?.regexIds?.forEach(regexId => {
-                if(search[regexId]) search[regexId] = new RegExp(search[regexId]);
-            });
-        } catch (e) {
-            console.error(e);
-            res.status(404).send({ spansCount: 0, spans: [], error: e });
-            return;
-        }
-    }
-        globalOasTlmConfig.dynamicExporter.exporter.find(search,(err, docs) => {
-            if (err) {
-                console.error(err);
-                res.status(404).send({ spansCount: 0, spans: [], error: err });
-                return;
-            }
-            const spans = docs;
-            res.send({ spansCount: spans.length, spans: spans });
-        });
-    
-}

package/src/controllers/uiController.js

@@ -1,69 +0,0 @@
-import { globalOasTlmConfig } from '../config.js';
-import { readFileSync } from 'fs';
-import path from 'path';
-import yaml from 'js-yaml';
-import ui from '../services/uiService.js';
-
-export const apiPage = (req, res) => {
-    const baseURL = globalOasTlmConfig.baseURL;
-    let text = `
-    <h1>Telemetry API routes:</h1>
-    <ul>
-        <li><a href="${baseURL}/start">${baseURL}/start</a></li>
-        <li><a href="${baseURL}/stop">${baseURL}/stop</a></li>
-        <li><a href="${baseURL}/status">${baseURL}/status</a></li>
-        <li><a href="${baseURL}/reset">${baseURL}/reset</a></li>
-        <li><a href="${baseURL}/list">${baseURL}/list</a></li>
-        <li><a href="${baseURL}/heapStats">${baseURL}/heapStats</a></li>
-        <li>${baseURL}/find [POST]</li>
-    </ul>
-    `;
-    res.send(text);
-}
-
-export const mainPage = (req, res) => {
-    const baseURL = globalOasTlmConfig.baseURL;
-    res.set('Content-Type', 'text/html');
-    res.send(ui(baseURL).main);
-}
-
-export const detailPage = (req, res) => {
-    const baseURL = globalOasTlmConfig.baseURL;
-    res.set('Content-Type', 'text/html');
-    res.send(ui(baseURL).detail);
-}
-
-export const specLoader = (req, res) => {
-    if (globalOasTlmConfig.specFileName) {
-        try {
-            const data = readFileSync(globalOasTlmConfig.specFileName, { encoding: 'utf8', flag: 'r' });
-            const extension = path.extname(globalOasTlmConfig.specFileName);
-            let json = data;
-            if (extension == yaml)
-                json = JSON.stringify(yaml.SafeLoad(data), null, 2);
-            res.setHeader('Content-Type', 'application/json');
-            res.send(json);
-        } catch (e) {
-            console.error(`ERROR loading spec file ${globalOasTlmConfig.specFileName}: ${e}`);
-        }
-    } else if (globalOasTlmConfig.spec) {
-            let spec = false;
-            try {
-                spec = JSON.parse(globalOasTlmConfig.spec);
-            } catch (ej) {
-                try {
-                    spec = JSON.stringify(yaml.load(globalOasTlmConfig.spec), null, 2);
-                } catch (ey) {
-                    console.error(`Error parsing spec: ${ej} - ${ey}`);
-                }
-            }
-            if (!spec) {
-                res.status(404);
-            } else {
-                res.setHeader('Content-Type', 'application/json');
-                res.send(spec);
-            }
-    } else {
-        res.status(404);
-    }
-}

package/src/dev/ui/login.html

@@ -1,32 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-<head>
-    <meta charset="UTF-8">
-    <meta name="viewport" content="width=device-width, initial-scale=1.0">
-    <title>Login</title>
-</head>
-<body>
-    <form id="loginForm">
-        <label for="apiKey">API Key:</label>
-        <input type="text" id="apiKey" name="apiKey" required>
-        <button type="submit">Login</button>
-    </form>
-
-    <script>
-        document.getElementById('loginForm').addEventListener('submit', function(event) {
-            event.preventDefault();
-            const apiKey = document.getElementById('apiKey').value;
-            fetch('/login', {
-                method: 'POST',
-                headers: {
-                    'Content-Type': 'application/json'
-                },
-                body: JSON.stringify({ apiKey })
-            })
-            .then(response => response.text())
-            .then(data => alert(data))
-            .catch(error => console.error('Error:', error));
-        });
-    </script>
-</body>
-</html>

package/src/exporters/InMemoryDbExporter.js

@@ -1,181 +0,0 @@
-import { ExportResultCode } from '@opentelemetry/core';
-
-let dbglog = () => { };
-
-if (process.env.OTDEBUG == "true")
-    dbglog = console.log;
-
-//import in memory database
-import dataStore from '@seald-io/nedb';
-
-export class InMemoryExporter {
-    constructor() {
-        this._spans = new dataStore();
-        this._stopped = true;
-    };
-
-    // Overrided by dynamic exporter
-    plugins = [];
-
-    export(readableSpans, resultCallback) {
-        try {
-            if (!this._stopped) {
-                // Prepare spans to be inserted into the in-memory database (remove circular references and convert to nested objects)
-                const cleanSpans = readableSpans
-                    .map(nestedSpan => removeCircularRefs(nestedSpan))// to avoid JSON parsing error
-                    .map(span => applyNesting(span))// to avoid dot notation in keys (neDB does not support dot notation in keys)
-                    .filter(span => !span.attributes?.http?.target?.includes("/telemetry"));// to avoid telemetry spans
-                // Insert spans into the in-memory database
-                this._spans.insert(cleanSpans, (err, newDoc) => {
-                    // p = {name, plugin
-                    this.plugins.forEach((pluginResource, i) => {
-                        cleanSpans.forEach((t) => {
-                            dbglog(`Sending trace <${t._id}> to plugin (Plugin #${i}) <${pluginResource.name}>`);
-                            dbglog(`Trace: \n<${JSON.stringify(t, null, 2)}`);
-                            //TODO: This should be called newSpan instead of newTrace
-                            pluginResource.plugin.newTrace(t);
-                        });
-                    });
-                    if (err) {
-                        console.error(err);
-                        return;
-                    }
-                });
-
-            }
-            setTimeout(() => resultCallback({ code: ExportResultCode.SUCCESS }), 0);
-        } catch (error) {
-            console.error('Error exporting spans\n' + error.message + '\n' + error.stack);
-            return resultCallback({
-                code: ExportResultCode.FAILED,
-                error: new Error('Error exporting spans\n' + error.message + '\n' + error.stack),
-            })
-        }
-    };
-    start() {
-        this._stopped = false;
-    };
-    stop() {
-        this._stopped = true;
-    };
-
-    isRunning() {
-        return !this._stopped;
-    };
-    shutdown() {
-        this._stopped = true;
-        this._spans = new dataStore();
-        return this.forceFlush();
-    };
-    /**
-     * Exports any pending spans in the exporter
-     */
-    forceFlush() {
-        return Promise.resolve();
-    };
-    //err,docs
-    find(search, callback) {
-        this._spans.find(search, callback);
-    }
-    reset() {
-        this._spans = new dataStore();
-    };
-    getFinishedSpans() {
-        return this._spans.getAllData();
-    };
-
-}
-
-function removeCircularRefs(obj) {
-    const seen = new WeakMap(); // Used to keep track of visited objects
-
-
-    // Replacer function to handle circular references
-    function replacer(key, value) {
-        if (key === "_spanProcessor") {
-            return "oas-telemetry skips this field to avoid circular reference";
-        }
-        // GENERIC CIRCULAR REFERENCE HANDLING
-        // if (typeof value === "object" && value !== null) {
-        //     // If the object has been visited before, return the name prefixed with "CIRCULAR+"
-        //     if (seen.has(value)) {
-        //         return `CIRCULAR${key}`;
-        //     }
-        //     seen.set(value, key); // Mark the object as visited with its name
-        // }
-        return value;
-    }
-
-    // Convert the object to a string and then parse it back
-    // This will trigger the replacer function to handle circular references
-    const jsonString = JSON.stringify(obj, replacer);
-    return JSON.parse(jsonString);
-}
-
-/**
- * Recursively converts dot-separated keys in an object to nested objects.
- * 
- * @param {Object} obj - The object to process.
- * @returns {Object} - The object with all dot-separated keys converted to nested objects.
- * @example
- * // Input:
- * // {
- * //   "http.method": "GET",
- * //   "http.url": "http://example.com",
- * //   "nested.obj.key": "value"
- * // }
- * // Output:
- * // {
- * //   "http": {
- * //     "method": "GET",
- * //     "url": "http://example.com"
- * //   },
- * //   "nested": {
- * //     "obj": {
- * //       "key": "value"
- * //     }
- * //   }
- * // }
- */
-function convertToNestedObject(obj) {
-    const result = {};
-
-    for (const key in obj) {
-        const keys = key.split('.');
-        let temp = result;
-
-        for (let i = 0; i < keys.length; i++) {
-            const currentKey = keys[i];
-
-            if (i === keys.length - 1) {
-                // Last key, set the value
-                temp[currentKey] = obj[key];
-            } else {
-                // Intermediate key, ensure the object exists
-                if (!temp[currentKey]) {
-                    temp[currentKey] = {};
-                }
-                temp = temp[currentKey];
-            }
-        }
-    }
-
-    return result;
-}
-
-/**
- * Applies nesting to all dot-separated keys within an object.
- * 
- * @param {Object} obj - The object to apply nesting to.
- * @returns {Object} - The transformed object with nested structures.
- */
-function applyNesting(obj) {
-    // Recursively apply convertToNestedObject to each level of the object
-    for (const key in obj) {
-        if (typeof obj[key] === 'object' && obj[key] !== null) {
-            obj[key] = applyNesting(obj[key]);
-        }
-    }
-
-    return convertToNestedObject(obj);
-}

package/src/index.js

@@ -1,121 +0,0 @@
-import './openTelemetry.js';
-import { globalOasTlmConfig } from './config.js';
-import cookieParser from 'cookie-parser';
-import { Router, json } from 'express';
-import { authMiddleware } from './middleware/authMiddleware.js';
-import authRoutes from './routes/authRoutes.js';
-import { telemetryRoutes } from './routes/telemetryRoutes.js';
-import { InMemoryExporter } from './exporters/InMemoryDbExporter.js';
-import metricsRoutes from './routes/metricsRoutes.js';
-
-
-let dbglog = () => { };
-
-if (process.env.OTDEBUG == "true")
-    dbglog = console.log;
-
-/**
- * Returns the Oas Telemetry middleware. The parameters are the same as `globalOasTlmConfig`.
- * All parameters are optional. However, either `spec` or `specFileName` must be provided to enable endpoint filtering.
- * 
- * @param {Object} OasTlmConfig Configuration object.
- * @param {string} [OasTlmConfig.baseURL="/telemetry"] The base URL for the telemetry routes.
- * @param {Object} [OasTlmConfig.spec] The OpenAPI spec object.
- * @param {string} [OasTlmConfig.specFileName] Alternative to `spec`: the path to the OpenAPI spec file.
- * @param {boolean} [OasTlmConfig.autoActivate=true] Whether to start telemetry automatically on load.
- * @param {boolean} [OasTlmConfig.authEnabled=true] Whether to enable authentication middleware.
- * @param {number} [OasTlmConfig.apiKeyMaxAge=1800000] The maximum age of the API key in milliseconds.
- * @param {string} [OasTlmConfig.defaultApiKey] The default API key to use.
- * @param {OasTlmExporter} [OasTlmConfig.exporter=InMemoryExporter] The exporter to use. Must implement the `OasTlmExporter` interface.
- * @returns {Router} The middleware router for Oas Telemetry.
- */
-export default function oasTelemetry(OasTlmConfig) {
-    const router = Router();
-    router.use((req, res, next) => {
-        if (req.body !== undefined) {
-          return next(); // Ya parseado, evitar json()
-        }
-      
-        return json()(req, res, next);
-      });
-
-    if (process.env.OASTLM_MODULE_DISABLED === 'true') {
-        return router;
-    };
-    if (OasTlmConfig) {
-        console.log("User provided config");
-        // Global = user-provided || default, for each key
-        for (const key in globalOasTlmConfig) {
-            globalOasTlmConfig[key] = OasTlmConfig[key] ?? globalOasTlmConfig[key];
-        }
-    }
-    console.log("baseURL: ", globalOasTlmConfig.baseURL);
-    globalOasTlmConfig.dynamicExporter.changeExporter(globalOasTlmConfig.exporter ?? new InMemoryExporter());
-
-    if (globalOasTlmConfig.spec)
-        dbglog(`Spec content provided`);
-    else {
-        if (globalOasTlmConfig.specFileName != "")
-            dbglog(`Spec file used for telemetry: ${globalOasTlmConfig.specFileName}`);
-        else {
-            console.error("No spec available !");
-        }
-    }
-    let allAuthMiddlewares = getWrappedMiddlewares(() => globalOasTlmConfig.authEnabled, [cookieParser(), authRoutes, authMiddleware]);
-    const baseURL = globalOasTlmConfig.baseURL;
-    router.use(baseURL, allAuthMiddlewares);
-    router.use(baseURL, telemetryRoutes);
-    router.use(baseURL + "/metrics", metricsRoutes);
-
-    if (globalOasTlmConfig.autoActivate) {
-        globalOasTlmConfig.dynamicExporter.exporter?.start();
-    }
-
-    return router;
-}
-
-
-/**
- * @typedef OasTlmExporter
- * Represents an exporter that processes and manages telemetry data.
- * Any custom exporter must implement these methods.
- * 
- * @method {void} start() Starts the exporter, allowing it to process data.
- * @method {void} stop() Stops the exporter and halts data processing.
- * @method {void} reset() Resets the internal state of the exporter (e.g., clears buffers or data stores).
- * @method {boolean} isRunning() Returns whether the exporter is actively processing data.
- * @method {Array} getFinishedSpans() Retrieves the collected spans from the exporter.
- * @method {any} export(ReadableSpan, SpanExporterResultCallback) Exports spans.
- * @method {Promise<void>} shutdown() Gracefully shuts down the exporter, flushing data if necessary.
- * @method {Promise<void>} forceFlush() Exports any pending data that has not yet been processed.
- * @property {Array} plugins An array of plugins that can be activated by the exporter.
- */
-
-/**
- * This function wraps the provided middleware functions with a condition callback.
- * If the condition callback returns true, the middleware/router will be executed.
- * If the condition callback returns false, the middleware/router will be skipped.
- * 
- * @callback {function} conditionCallback A callback function that returns a boolean to determine if the middleware should be used.
- * @param {Array} middlewares An array of middleware or routers to be wrapped.
- * @returns {Array} An array of wrapped middleware functions.
- */
-function getWrappedMiddlewares(conditionCallback, middlewares) {
-    return middlewares.map(middleware => {
-        return function (req, res, next) {
-            if (conditionCallback()) {
-                if (typeof middleware === 'function') {
-                    // look for handle property, if it exists, it's a router. If not call middleware
-                    if (middleware.handle) {
-                        middleware.handle(req, res, next);
-                    } else {
-                        middleware(req, res, next);
-                    }
-                }
-            } else {
-                next();
-            }
-        };
-    }
-    );
-}

package/src/routes/authRoutes.js

@@ -1,53 +0,0 @@
-import { globalOasTlmConfig } from '../config.js';
-import { Router } from 'express';
-import { serialize } from 'cookie';
-import ui from '../services/uiService.js';
-import jwt from 'jsonwebtoken';
-
-const router = Router();
-
-router.post('/login', (req, res) => {
-    try {
-        const { password } = req.body;
-        if (password === globalOasTlmConfig.password) {
-            let options = {
-                maxAge: globalOasTlmConfig.apiKeyMaxAge,
-                httpOnly: true, // The cookie only accessible by the web server
-                secure: true, // Only sends cookie over https
-                signed: false // Indicates if the cookie should be signed
-            }
-            const apiKey = jwt.sign({ password: globalOasTlmConfig.password }, globalOasTlmConfig.jwtSecret);
-            res.cookie('apiKey', apiKey, options);
-            return res.status(200).json({ valid: true, message: 'API Key is valid' });
-        }
-        res.status(400).json({ valid: false, message: 'Invalid API Key' });
-
-    } catch (error) {
-        console.log("Error: ", error);
-        res.status(500).json({ valid: false, message: 'Internal server error' });
-    }
-});
-
-router.get('/logout', (req, res) => {
-    res.clearCookie('apiKey');
-    res.redirect(globalOasTlmConfig.baseURL + '/login');
-});
-
-//check is used in the UI (http polling) to validate the Cookies to redirect to the login page if needed
-router.get('/check', (req, res) => {
-    if (!req.cookies.apiKey) {
-        return res.status(200).json({ valid: false, message: 'API Key is invalid' });
-    }
-    const decoded = jwt.verify(req.cookies.apiKey, globalOasTlmConfig.jwtSecret);
-    if (decoded.password === globalOasTlmConfig.password) {
-        return res.status(200).json({ valid: true, message: 'API Key is valid' });
-    }
-    res.status(200).json({ valid: false, message: 'Invalid API Key' });
-});
-
-router.get('/login', (req, res) => {
-    const baseURL = globalOasTlmConfig.baseURL;
-    res.send(ui(baseURL).login);
-});
-
-export default router;

package/src/routes/telemetryRoutes.js

@@ -1,38 +0,0 @@
-import { Router } from 'express';
-import { mainPage, detailPage , specLoader, apiPage} from '../controllers/uiController.js';
-import {
-    startTelemetry,
-    stopTelemetry,
-    statusTelemetry,
-    resetTelemetry,
-    listTelemetry,
-    heapStats,
-    findTelemetry
-} from '../controllers/telemetryController.js';
-import { listPlugins, registerPlugin } from '../controllers/pluginController.js';
-
-export const telemetryRoutes = Router();
-
-
-
-
-// Main Pages
-telemetryRoutes.get('/', mainPage);
-telemetryRoutes.get('/detail/*', detailPage);
-telemetryRoutes.get('/spec', specLoader);
-telemetryRoutes.get('/api', apiPage);
-
-// Telemetry Control
-telemetryRoutes.get('/start', startTelemetry);
-telemetryRoutes.get('/stop', stopTelemetry);
-telemetryRoutes.get('/status', statusTelemetry);
-telemetryRoutes.get('/reset', resetTelemetry);
-telemetryRoutes.get('/list', listTelemetry);
-telemetryRoutes.post('/find', findTelemetry);
-telemetryRoutes.get('/heapStats', heapStats);
-
-// Plugins
-telemetryRoutes.get('/plugins', listPlugins);
-telemetryRoutes.post('/plugins', registerPlugin);
-
-export default telemetryRoutes;