@oas-tools/oas-telemetry 0.5.0 → 0.5.2

package/src/index.js

@@ -22,6 +22,7 @@ if (process.env.OTDEBUG == "true")
  * @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.
@@ -51,12 +52,10 @@ export default function oasTelemetry(OasTlmConfig) {
             console.error("No spec available !");
         }
     }
-
-    router.use(cookieParser());
+    let allAuthMiddlewares = getWrappedMiddlewares(() => globalOasTlmConfig.authEnabled, [cookieParser(),authRoutes,authMiddleware]);
     const baseURL = globalOasTlmConfig.baseURL;
     router.use(json());
-    router.use(baseURL, authRoutes);
-    router.use(baseURL, authMiddleware); // Add the auth middleware
+    router.use(baseURL, allAuthMiddlewares);
     router.use(baseURL, telemetryRoutes);
 
     if (globalOasTlmConfig.autoActivate) {
@@ -67,7 +66,6 @@ export default function oasTelemetry(OasTlmConfig) {
 }
 
 
-
 /**
  * @typedef OasTlmExporter
  * Represents an exporter that processes and manages telemetry data.
@@ -83,3 +81,32 @@ export default function oasTelemetry(OasTlmConfig) {
  * @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/openTelemetry.js

@@ -8,7 +8,7 @@ import { globalOasTlmConfig } from './config.js';
 
   // DynamicExporter allows changing to any exporter at runtime;
   const traceExporter = globalOasTlmConfig.dynamicExporter;
-
+//  Alternative 1: Using NodeSDK
   const sdk = new NodeSDK({
     resource: new Resource({
       service: 'oas-telemetry-service'
@@ -19,4 +19,18 @@ import { globalOasTlmConfig } from './config.js';
 
   if (process.env.OASTLM_MODULE_DISABLED !== 'true') {
     sdk.start()
-  }
+  }
+
+// Alternative 2:
+// const provider = new NodeTracerProvider();
+// provider.addSpanProcessor(new SimpleSpanProcessor(traceExporter));
+
+// if (process.env.OASTLM_MODULE_DISABLED !== 'true') {
+//   provider.register();
+//   registerInstrumentations({
+//     instrumentations: [
+//       new HttpInstrumentation(),
+//       new ExpressInstrumentation(),
+//     ],
+//   });
+// }

package/src/services/uiService.js

@@ -1,17 +1,17 @@
-
-
-// WARNING: This file is autogenerated. DO NOT EDIT!
-//This file is autogenerated by dev/ui/exportHtmlToUi.js
-const ui = (baseURL) => {
-    if(!baseURL) return htmlMap;
-    return Object.keys(htmlMap).reduce((acc, key) => {
-        acc[key] = htmlMap[key].replace(/\/telemetry/g, baseURL);
-        return acc;
-    }, {});
-}
-
-export const htmlMap = 
-    {
+
+
+// WARNING: This file is autogenerated. DO NOT EDIT!
+//This file is autogenerated by dev/ui/exportHtmlToUi.js
+const ui = (baseURL) => {
+    if(!baseURL) return htmlMap;
+    return Object.keys(htmlMap).reduce((acc, key) => {
+        acc[key] = htmlMap[key].replace(/\/telemetry/g, baseURL);
+        return acc;
+    }, {});
+}
+
+export const htmlMap = 
+    {
 detail: `<!DOCTYPE html>
 <html lang="en">
 
@@ -632,7 +632,7 @@ detail: `<!DOCTYPE html>
 
 </body>
 
-</html>`,
+</html>`,
 login: `<!DOCTYPE html>
 <html lang="en">
 <head>
@@ -813,7 +813,7 @@ login: `<!DOCTYPE html>
     </script>
 </body>
 </html>
-`,
+`,
 main: `<!DOCTYPE html>
 <html lang="en">
 
@@ -1513,8 +1513,8 @@ main: `<!DOCTYPE html>
     </script>
 </body>
 
-</html>`,
-};
-
-    
-export default ui
+</html>`,
+};
+
+    
+export default ui

package/dist/client.cjs

@@ -1,14 +0,0 @@
-"use strict";
-
-// client.js
-
-function sendRequest(url, options = {}) {
-  const apiKey = localStorage.getItem('apiKey');
-  if (!options.headers) {
-    options.headers = {};
-  }
-  options.headers['x-api-key'] = apiKey;
-  return fetch(url, options);
-}
-
-// ...existing code...

package/dist/middleware/auth.cjs

@@ -1,17 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = auth;
-function auth(req, res, next) {
-  const apiKey = req.query.apiKey || req.body.apiKey;
-  if (apiKey === process.env.APIKEY) {
-    next();
-  } else {
-    res.status(401).send({
-      valid: false
-    });
-  }
-}
-module.exports = exports.default;

package/dist/telemetry.cjs

@@ -1,23 +0,0 @@
-// tracing.js
-
-'use strict';
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.inMemoryExporter = void 0;
-var _sdkNode = require("@opentelemetry/sdk-node");
-var _resources = require("@opentelemetry/resources");
-var _instrumentationHttp = require("@opentelemetry/instrumentation-http");
-var _InMemoryDbExporter = require("./exporters/InMemoryDbExporter.cjs");
-// import { getNodeAutoInstrumentations } from '@opentelemetry/auto-instrumentations-node';
-
-// Create an in-memory span exporter
-const inMemoryExporter = exports.inMemoryExporter = new _InMemoryDbExporter.InMemoryExporter();
-const traceExporter = inMemoryExporter;
-const sdk = new _sdkNode.NodeSDK({
-  resource: new _resources.Resource(),
-  traceExporter,
-  instrumentations: [new _instrumentationHttp.HttpInstrumentation()]
-});
-sdk.start();

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

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

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

package/dist/types/telemetry.d.ts

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

package/dist/types/ui.d.ts

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