@oas-tools/oas-telemetry 0.3.0 → 0.4.0

package/dist/index.cjs

@@ -13,6 +13,7 @@ var _jsYaml = _interopRequireDefault(require("js-yaml"));
 var _ui = _interopRequireDefault(require("./ui.cjs"));
 var _axios = _interopRequireDefault(require("axios"));
 var _importFromString = require("import-from-string");
+var _dynamicInstaller = require("dynamic-installer");
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 // telemetryMiddleware.js
 
@@ -224,7 +225,20 @@ const registerPlugin = async (req, res) => {
       res.status(400).send(`Plugin code could not be loaded`);
       return;
     }
+    //install dependencies if any
+    if (pluginResource.install) {
+      const dependenciesStatus = await (0, _dynamicInstaller.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 (0, _importFromString.importFromString)(pluginCode);
@@ -238,19 +252,28 @@ const registerPlugin = async (req, res) => {
     res.status(400).send(`Error loading plugin: ${error}`);
     return;
   }
-  if (module.plugin == undefined) {
+
+  // Check if the plugin is in module.default or module.plugin (supports default syntax)
+  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 (module.plugin[requiredFunction] == undefined) {
+    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;
     }
   }
-  let plugin = module.plugin;
+  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;

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,6 +1,6 @@
 {
   "name": "@oas-tools/oas-telemetry",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "description": "This package exports an Express middleware that traces requests and responses of an Express application using OpenTelemetry.",
   "author": "Manuel Otero",
   "contributors": [
@@ -47,7 +47,7 @@
     "@opentelemetry/resources": "^1.24.0",
     "@opentelemetry/sdk-node": "^0.49.1",
     "axios": "^1.6.8",
-    "dynamic-installer": "^1.0.1",
+    "dynamic-installer": "^1.1.1",
     "express": "^4.19.2",
     "import-from-string": "^0.0.4",
     "js-yaml": "^4.1.0",

package/src/index.js

@@ -254,6 +254,7 @@ const registerPlugin = async (req, res) => {
         }
 
         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)
@@ -268,20 +269,22 @@ const registerPlugin = async (req, res) => {
         return;
     }
 
-    if (module.plugin == undefined) {
-        res.status(400).send(`Plugin code should export a "plugin" object`);
-        console.log("Error in plugin code: no plugin object exported")
+// Check if the plugin is in module.default or module.plugin (supports default syntax)
+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;
     }
-    for (let requiredFunction of ["load", "getName", "isConfigured"]) {
-        if (module.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;
-        }
-    }
+}
 
-    let plugin = module.plugin
     try {
         await plugin.load(pluginResource.config);
     } catch (error) {