@oas-tools/oas-telemetry 0.3.0 → 0.5.0

package/dist/types/exporters/InMemoryDbExporter.d.ts

@@ -0,0 +1,16 @@
+export class InMemoryExporter {
+    static plugins: any[];
+    _spans: any;
+    _stopped: boolean;
+    export(readableSpans: any, resultCallback: any): any;
+    start(): void;
+    stop(): void;
+    shutdown(): Promise<void>;
+    /**
+     * Exports any pending spans in the exporter
+     */
+    forceFlush(): Promise<void>;
+    reset(): void;
+    getFinishedSpans(): any;
+    activatePlugin(plugin: any): void;
+}

package/dist/types/index.d.ts

@@ -0,0 +1 @@
+export default function oasTelemetry(tlConfig?: any): import("express-serve-static-core").Router;

package/dist/types/telemetry.d.ts

@@ -0,0 +1,2 @@
+export const inMemoryExporter: InMemoryExporter;
+import { InMemoryExporter } from './exporters/InMemoryDbExporter.js';

package/dist/types/ui.d.ts

@@ -0,0 +1,4 @@
+export default function ui(): {
+    main: string;
+    detail: string;
+};

package/package.json

@@ -1,71 +1,75 @@
-{
-  "name": "@oas-tools/oas-telemetry",
-  "version": "0.3.0",
-  "description": "This package exports an Express middleware that traces requests and responses of an Express application using OpenTelemetry.",
-  "author": "Manuel Otero",
-  "contributors": [
-    "Alejandro Santisteban",
-    "Pablo Fernandez"
-  ],
-  "license": "Apache-2.0",
-  "type": "module",
-  "scripts": {
-    "devImportUi": "node dev/ui/importUiToHtml.js",
-    "devExportUi": "node dev/ui/exportHtmlToUi.js",
-    "build": "babel src -d dist --out-file-extension .cjs",
-    "devUi": "nodemon --watch dev/ui --ext html --exec \"npm run devExportUi && npm run build && node test/functional/otTestServer.cjs\"",
-    "publish": "npm run build && npm publish",
-    "testPerformance": "npm i && cd test/performance/ && ./test.sh",
-    "pretest": "npm run build",
-    "test": "npm run testCJS && npm run testMJS",
-    "testCJS": "npm run preTestCJS && npm run launchTestCJS && npm run postTestCJS",
-    "preTestCJS": "node test/functional/otTestServer.cjs &",
-    "launchTestCJS": "npx -y wait-on http://localhost:3000/api/v1/pets && npm run sendRequests && sleep 4 && npm run checkRequestsLog",
-    "postTestCJS": "kill `ps -uax | grep \"node test/functional/otTestServer\" | grep -v \"grep\" | grep -v \"sh\" | awk '{print $2}'`",
-    "testMJS": "npm run preTestMJS && npm run launchTestMJS && npm run postTestMJS",
-    "preTestMJS": "node test/functional/otTestServer.mjs &",
-    "launchTestMJS": "npx -y wait-on http://localhost:3000/api/v1/pets && npm run sendRequests && sleep 4 && npm run checkRequestsLog",
-    "postTestMJS": "kill `ps -uax | grep \"node test/functional/otTestServer\" | grep -v \"grep\" | grep -v \"sh\" | awk '{print $2}'`",
-    "sendRequests": "npx -y newman run test/functional/request-collection.json -e test/functional/request-environment.json",
-    "checkRequestsLog": "npx -y newman run test/functional/request-collection-check.json -e test/functional/request-environment.json",
-    "launchKSApi": "npm run build; (cd test/performance/ks-api ; node indexTelemetry.js)",
-    "launchDevel": "export OTDEBUG=true && npm run launchKSApi"
-  },
-  "files": [
-    "dist",
-    "src"
-  ],
-  "main": "./dist/index.cjs",
-  "module": "./src/index.js",
-  "exports": {
-    "require": "./dist/index.cjs",
-    "import": "./src/index.js",
-    "default": "./src/index.js"
-  },
-  "dependencies": {
-    "@opentelemetry/instrumentation-http": "^0.51.0",
-    "@opentelemetry/resources": "^1.24.0",
-    "@opentelemetry/sdk-node": "^0.49.1",
-    "axios": "^1.6.8",
-    "dynamic-installer": "^1.0.1",
-    "express": "^4.19.2",
-    "import-from-string": "^0.0.4",
-    "js-yaml": "^4.1.0",
-    "nedb": "^1.8.0",
-    "readline": "^1.3.0",
-    "v8": "^0.1.0"
-  },
-  "devDependencies": {
-    "@babel/cli": "^7.24.1",
-    "@babel/core": "^7.24.4",
-    "@babel/plugin-proposal-class-properties": "^7.18.6",
-    "@babel/plugin-proposal-object-rest-spread": "^7.20.7",
-    "@babel/preset-env": "^7.24.4",
-    "@opentelemetry/api": "^1.8.0",
-    "@opentelemetry/auto-instrumentations-node": "^0.43.0",
-    "apipecker": "^1.3.1",
-    "babel-plugin-add-module-exports": "^1.0.4",
-    "babel-plugin-module-extension": "^0.1.3",
-    "nodemon": "^3.1.0"
-  }
-}
+{
+  "name": "@oas-tools/oas-telemetry",
+  "version": "0.5.0",
+  "description": "This package exports an Express middleware that traces requests and responses of an Express application using OpenTelemetry.",
+  "author": "Manuel Otero",
+  "contributors": [
+    "Alejandro Santisteban",
+    "Pablo Fernandez"
+  ],
+  "license": "Apache-2.0",
+  "type": "module",
+  "scripts": {
+    "devImportUi": "node dev/ui/importUiToHtml.js",
+    "devExportUi": "node dev/ui/exportHtmlToUi.js",
+    "build": "babel src -d dist --out-file-extension .cjs",
+    "devUi": "nodemon --watch dev/ui src --ext html --exec \"npm run devExportUi && npm run build && node test/functional/otTestServer.cjs\"",
+    "devUiEsm": "nodemon --watch dev/ui --ext html --exec \"npm run devExportUi && node test/functional/otTestServer.mjs\"",
+    "publish": "npm run build && npm publish",
+    "testPerformance": "npm i && cd test/performance/ && ./test.sh",
+    "pretest": "npm run build",
+    "test": "npm run testCJS && npm run testMJS",
+    "testCJS": "npm run preTestCJS && npm run launchTestCJS && npm run postTestCJS",
+    "preTestCJS": "node test/functional/otTestServer.cjs &",
+    "launchTestCJS": "npx -y wait-on http://localhost:3000/api/v1/pets && npm run sendRequests && sleep 4 && npm run checkRequestsLog",
+    "postTestCJS": "kill `ps -uax | grep \"node test/functional/otTestServer\" | grep -v \"grep\" | grep -v \"sh\" | awk '{print $2}'`",
+    "testMJS": "npm run preTestMJS && npm run launchTestMJS && npm run postTestMJS",
+    "preTestMJS": "node test/functional/otTestServer.mjs &",
+    "launchTestMJS": "npx -y wait-on http://localhost:3000/api/v1/pets && npm run sendRequests && sleep 4 && npm run checkRequestsLog",
+    "postTestMJS": "kill `ps -uax | grep \"node test/functional/otTestServer\" | grep -v \"grep\" | grep -v \"sh\" | awk '{print $2}'`",
+    "sendRequests": "npx -y newman run test/functional/request-collection.json -e test/functional/request-environment.json",
+    "checkRequestsLog": "npx -y newman run test/functional/request-collection-check.json -e test/functional/request-environment.json",
+    "launchKSApi": "npm run build; (cd test/performance/ks-api ; node indexTelemetry.js)",
+    "launchDevel": "export OTDEBUG=true && npm run launchKSApi"
+  },
+  "files": [
+    "dist",
+    "src"
+  ],
+  "main": "./dist/index.cjs",
+  "module": "./src/index.js",
+  "exports": {
+    "require": "./dist/index.cjs",
+    "import": "./src/index.js",
+    "default": "./src/index.js"
+  },
+  "dependencies": {
+    "@opentelemetry/instrumentation-http": "^0.51.0",
+    "@opentelemetry/resources": "^1.24.0",
+    "@opentelemetry/sdk-node": "^0.49.1",
+    "axios": "^1.6.8",
+    "cookie-parser": "^1.4.7",
+    "dynamic-installer": "^1.1.1",
+    "express": "^4.19.2",
+    "flatted": "^3.3.2",
+    "import-from-string": "^0.0.4",
+    "js-yaml": "^4.1.0",
+    "jsonwebtoken": "^9.0.2",
+    "nedb": "^1.8.0",
+    "readline": "^1.3.0",
+    "v8": "^0.1.0"
+  },
+  "devDependencies": {
+    "@babel/cli": "^7.24.1",
+    "@babel/core": "^7.24.4",
+    "@babel/plugin-proposal-class-properties": "^7.18.6",
+    "@babel/plugin-proposal-object-rest-spread": "^7.20.7",
+    "@babel/preset-env": "^7.24.4",
+    "@opentelemetry/api": "^1.8.0",
+    "@opentelemetry/auto-instrumentations-node": "^0.43.0",
+    "apipecker": "^1.3.1",
+    "babel-plugin-add-module-exports": "^1.0.4",
+    "babel-plugin-module-extension": "^0.1.3",
+    "nodemon": "^3.1.0"
+  }
+}

package/src/config.js

@@ -0,0 +1,19 @@
+import DynamicExporter from "./exporters/dynamicExporter.js";
+
+//Environment variables
+//OASTLM_API_KEY = 'oas-telemetry-api-key' //Cookie value for the API key
+//OASTLM_MODULE_DISABLED = 'true' //Disables the module (empty middleware and no tracing)
+
+export const globalOasTlmConfig = {
+    dynamicExporter: new DynamicExporter(),
+    baseURL: "/telemetry4",
+    spec: null,
+    specFileName: "",
+    autoActivate: true,
+    apiKeyMaxAge: 1000 * 60 * 60, // 1 hour
+    password: "oas-telemetry-password",
+    jwtSecret: "oas-telemetry-secret",
+};
+//5 name alternatives. one for globals 
+
+export default {globalOasTlmConfig}

package/src/controllers/pluginController.js

@@ -0,0 +1,115 @@
+
+import { globalOasTlmConfig } from '../config.js';
+import axios from 'axios';
+import { importFromString, requireFromString } from 'import-from-string';
+import { installDependencies } from 'dynamic-installer';
+
+let dbglog = () => { };
+
+if (process.env.OTDEBUG == "true")
+    dbglog = console.log;
+export const listPlugins = (req, res) => {
+    res.send(globalOasTlmConfig.dynamicExporter.getPlugins().map((p) => {
+        return {
+            id: p.id,
+            name: p.name,
+            url: p.url,
+            active: p.active
+        };
+    }));
+}
+
+export const registerPlugin = async (req, res) => {
+    let pluginResource = req.body;
+    dbglog(`Plugin Registration Request: = ${JSON.stringify(req.body, null, 2)}...`);
+    dbglog(`Getting plugin at ${pluginResource.url}...`);
+    let pluginCode;
+    if (!pluginResource.url && !pluginResource.code) {
+        res.status(400).send(`Plugin code or URL must be provided`);
+        return;
+    }
+
+    let module;
+    try {
+        if (pluginResource.code) {
+            pluginCode = pluginResource.code
+        } else {
+            const response = await axios.get(pluginResource.url);
+            pluginCode = response.data;
+        }
+        if (!pluginCode) {
+            res.status(400).send(`Plugin code could not be loaded`);
+            return;
+        }
+        if (pluginResource.install) {
+            const dependenciesStatus = await installDependencies(pluginResource.install);
+            if (!dependenciesStatus.success) {
+                if (pluginResource.install.ignoreErrors === true) {
+                    console.warn(`Warning: Error installing dependencies: ${JSON.stringify(dependenciesStatus.details)}`);
+                } else {
+                    res.status(400).send(`Error installing dependencies: ${JSON.stringify(dependenciesStatus.details)}`);
+                    return;
+                }
+            }
+        }
+
+        dbglog("Plugin size: " + pluginCode?.length);
+        dbglog("Plugin format: " + pluginResource?.moduleFormat);
+        if (pluginResource?.moduleFormat && pluginResource.moduleFormat.toUpperCase() == "ESM") {
+            console.log("ESM detected")
+            module = await importFromString(pluginCode)
+        } else {
+            console.log("CJS detected (default)")
+            module = await requireFromString(pluginCode)
+            console.log(module)
+        }
+    } catch (error) {
+        console.error(`Error loading plugin: ${error}`);
+        res.status(400).send(`Error loading plugin: ${error}`);
+        return;
+    }
+
+    const plugin = module.default?.plugin ?? module.plugin;
+
+    if (plugin == undefined) {
+        res.status(400).send(`Plugin code should export a "plugin" object`);
+        console.log("Error in plugin code: no plugin object exported");
+        return;
+    }
+    for (let requiredFunction of ["load", "getName", "isConfigured"]) {
+        if (plugin[requiredFunction] == undefined) {
+            res.status(400).send(`The plugin code exports a "plugin" object, however it should have a "${requiredFunction}" method`);
+            console.log("Error in plugin code: some required functions are missing");
+            return;
+        }
+    }
+
+    try {
+        await plugin.load(pluginResource.config);
+    } catch (error) {
+        console.error(`Error loading plugin configuration: ${error}`);
+        res.status(400).send(`Error loading plugin configuration: ${error}`);
+        return;
+    }
+    if (plugin.isConfigured()) {
+        dbglog(`Loaded plugin <${plugin.getName()}>`);
+        pluginResource.plugin = plugin;
+        pluginResource.name = plugin.getName();
+        pluginResource.active = true;
+        globalOasTlmConfig.dynamicExporter.pushPlugin(pluginResource);
+        globalOasTlmConfig.dynamicExporter.activatePlugin(pluginResource.plugin);
+        res.status(201).send(`Plugin registered`);
+    } else {
+        console.error(`Plugin <${plugin.getName()}> can not be configured`);
+        res.status(400).send(`Plugin configuration problem`);
+    }
+}
+
+export const checkApiKey = (req, res) => {
+    const apiKey = req.query.apiKey || req.body.apiKey;
+    if (apiKey === process.env.APIKEY) {
+        res.status(200).send({ valid: true });
+    } else {
+        res.status(401).send({ valid: false });
+    }
+}

package/src/controllers/telemetryController.js

@@ -0,0 +1,68 @@
+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

@@ -0,0 +1,69 @@
+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

@@ -0,0 +1,32 @@
+<!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>