@heliyos/heliyos-api-core 1.0.35 → 1.0.36

package/dist/mongoose.js

@@ -10,6 +10,18 @@ var __createBinding = (this && this.__createBinding) || (Object.create ? (functi
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];
 }));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
@@ -22,13 +34,10 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.mongooseConnection = exports.mongoInstance = exports.MongoConnectionManager = void 0;
 exports.initializeDatabase = initializeDatabase;
-const mongoose_1 = __importDefault(require("mongoose"));
+const mongoose_1 = __importStar(require("mongoose"));
 const logger_1 = require("./logger");
 // Export commonly used mongoose types
 __exportStar(require("mongoose"), exports);
@@ -65,6 +74,7 @@ class MongoConnectionManager {
             retryReads: true,
             maxConnecting: 1,
             minHeartbeatFrequencyMS: 2000,
+            family: 4,
             // Add monitoring capability
             monitorCommands: true,
         };
@@ -194,3 +204,157 @@ mongoose_1.default.Query.prototype.paginate = function () {
         }
     });
 };
+const ENABLE_METRICS = process.env.MONGO_METRICS === "true";
+const DEBUG_QUERIES = process.env.MONGO_DEBUG === "true";
+const originalExec = mongoose_1.Query.prototype.exec;
+mongoose_1.Query.prototype.exec = function (...args) {
+    return __awaiter(this, void 0, void 0, function* () {
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o;
+        // Skip metrics collection if disabled
+        if (!ENABLE_METRICS) {
+            return originalExec.apply(this, args);
+        }
+        const startTime = Date.now();
+        const queryName = this.model.modelName;
+        const operation = this.op;
+        // Enhanced query details for debugging
+        const queryDetails = {
+            filter: this.getFilter(),
+            sort: this.getSort(),
+            limit: this.options.limit,
+            skip: this.options.skip,
+            select: this.getOptions().select,
+            collection: this.model.collection.name,
+            operation: this.op,
+            options: this.getOptions(),
+        };
+        // Debug log the query details
+        if (DEBUG_QUERIES) {
+            logger_1.logger.debug(`MongoDB Query Details [${queryName}:${operation}]:`, {
+                timestamp: new Date().toISOString(),
+                queryDetails,
+                stack: (_a = new Error().stack) === null || _a === void 0 ? void 0 : _a.split("\n").slice(2).map((line) => line.trim()),
+            });
+        }
+        try {
+            // Run explain only for read operations and when debugging is enabled
+            let explainPromise;
+            if (DEBUG_QUERIES &&
+                ["find", "findOne", "count", "countDocuments"].includes(operation)) {
+                explainPromise = this.model
+                    .find(queryDetails.filter)
+                    .explain("executionStats")
+                    .catch((err) => {
+                    logger_1.logger.debug("Explain analysis failed:", {
+                        error: err.message,
+                        queryName,
+                        operation,
+                    });
+                    return null;
+                });
+            }
+            // Execute original query
+            const result = yield originalExec.apply(this, args);
+            const executionTimeMs = Date.now() - startTime;
+            // Get explain data if available
+            const explainData = yield explainPromise;
+            const metrics = Object.assign({ queryName,
+                operation,
+                executionTimeMs, timestamp: new Date().toISOString(), documentCount: Array.isArray(result) ? result.length : 1, queryDetails }, (explainData && {
+                explainData: {
+                    nReturned: (_b = explainData.executionStats) === null || _b === void 0 ? void 0 : _b.nReturned,
+                    totalKeysExamined: (_c = explainData.executionStats) === null || _c === void 0 ? void 0 : _c.totalKeysExamined,
+                    totalDocsExamined: (_d = explainData.executionStats) === null || _d === void 0 ? void 0 : _d.totalDocsExamined,
+                    executionTimeMillis: (_e = explainData.executionStats) === null || _e === void 0 ? void 0 : _e.executionTimeMillis,
+                    indexesUsed: ((_h = (_g = (_f = explainData.queryPlanner) === null || _f === void 0 ? void 0 : _f.winningPlan) === null || _g === void 0 ? void 0 : _g.inputStage) === null || _h === void 0 ? void 0 : _h.indexName)
+                        ? [explainData.queryPlanner.winningPlan.inputStage.indexName]
+                        : [],
+                    isMultiKey: (_l = (_k = (_j = explainData.queryPlanner) === null || _j === void 0 ? void 0 : _j.winningPlan) === null || _k === void 0 ? void 0 : _k.inputStage) === null || _l === void 0 ? void 0 : _l.isMultiKey,
+                    inMemorySort: ((_o = (_m = explainData.executionStats) === null || _m === void 0 ? void 0 : _m.executionStages) === null || _o === void 0 ? void 0 : _o.stage) === "SORT",
+                    queryPlan: DEBUG_QUERIES ? explainData.queryPlanner : undefined,
+                },
+            }));
+            // Analyze query performance and log recommendations
+            analyzeQueryPerformance(metrics);
+            // Debug log the result summary
+            if (DEBUG_QUERIES) {
+                logger_1.logger.debug(`MongoDB Query Complete [${queryName}:${operation}]:`, {
+                    executionTimeMs,
+                    resultSize: Array.isArray(result) ? result.length : 1,
+                    resultSample: Array.isArray(result)
+                        ? result.slice(0, 2).map((doc) => (Object.assign({ _id: doc._id }, doc)))
+                        : result === null || result === void 0 ? void 0 : result._id,
+                });
+            }
+            return result;
+        }
+        catch (error) {
+            const errorDetails = {
+                queryName,
+                operation,
+                queryDetails,
+                error: {
+                    message: error.message,
+                    code: error.code,
+                    name: error.name,
+                    stack: DEBUG_QUERIES ? error.stack : undefined,
+                },
+                duration: Date.now() - startTime,
+            };
+            logger_1.logger.error("Query execution failed:", errorDetails);
+            throw error;
+        }
+    });
+};
+function analyzeQueryPerformance(metrics) {
+    const warnings = [];
+    const suggestions = [];
+    let logLevel = "info";
+    // Performance thresholds
+    const SLOW_QUERY_THRESHOLD = 100; // ms
+    const VERY_SLOW_QUERY_THRESHOLD = 1000; // ms
+    const DOCS_EXAMINED_RATIO_THRESHOLD = 3;
+    const LARGE_RESULT_SET = 1000;
+    // Check execution time
+    if (metrics.executionTimeMs > VERY_SLOW_QUERY_THRESHOLD) {
+        warnings.push(`Very slow query: ${metrics.executionTimeMs}ms`);
+        logLevel = "error";
+    }
+    else if (metrics.executionTimeMs > SLOW_QUERY_THRESHOLD) {
+        warnings.push(`Slow query: ${metrics.executionTimeMs}ms`);
+        logLevel = "warn";
+    }
+    // Analyze explain data if available
+    if (metrics.explainData) {
+        const { totalDocsExamined, nReturned, indexesUsed, inMemorySort } = metrics.explainData;
+        // Check index usage
+        if (totalDocsExamined && !(indexesUsed === null || indexesUsed === void 0 ? void 0 : indexesUsed.length)) {
+            warnings.push("No indexes used (COLLSCAN)");
+            suggestions.push("Consider adding an index for this query pattern");
+        }
+        // Check documents examined ratio
+        if (totalDocsExamined && nReturned) {
+            const examineRatio = totalDocsExamined / nReturned;
+            if (examineRatio > DOCS_EXAMINED_RATIO_THRESHOLD) {
+                warnings.push(`High document examine ratio: ${examineRatio.toFixed(1)}`);
+                suggestions.push("Review index coverage or query selectivity");
+            }
+        }
+        // Check for in-memory sorts
+        if (inMemorySort) {
+            warnings.push("In-memory sort detected");
+            suggestions.push("Add index to support sort operation");
+        }
+    }
+    // Check result set size
+    if (metrics.documentCount > LARGE_RESULT_SET) {
+        warnings.push(`Large result set: ${metrics.documentCount} documents`);
+        suggestions.push("Consider implementing pagination");
+    }
+    // Check for potential limit issues
+    if (!metrics.queryDetails.limit && metrics.operation === "find") {
+        suggestions.push("Consider adding a limit to the query");
+    }
+    // Log the analysis
+    logger_1.logger[logLevel]("Query Performance Analysis:", Object.assign(Object.assign({}, metrics), { warnings: warnings.length ? warnings : undefined, suggestions: suggestions.length ? suggestions : undefined, performanceCategory: logLevel }));
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@heliyos/heliyos-api-core",
-  "version": "1.0.35",
+  "version": "1.0.36",
   "description": "Heliyos's core api functions and middlewares. Its a private package hosted on npm.",
   "main": "./dist/index.js",
   "scripts": {