feat(resource): introduce resource usage controller and endpoints using pidusage

Author: Saifallak

package.json

@@ -52,6 +52,7 @@
     "merge-deep": "^3.0.3",
     "moment": "^2.30.1",
     "multer": "^1.4.5-lts.2",
+    "pidusage": "^3.0.2",
     "qrcode": "^1.5.4",
     "sharp": "^0.34.5",
     "socket.io": "^4.8.3",
@@ -82,6 +83,7 @@
     "@types/mime-types": "^3.0.1",
     "@types/multer": "^1.4.13",
     "@types/node": "^22.19.3",
+    "@types/pidusage": "^2.0.2",
     "@types/qrcode": "^1.5.6",
     "@types/swagger-ui-express": "^4.1.8",
     "@types/unzipper": "^0.10.11",

src/controller/resourceController.ts

@@ -0,0 +1,152 @@
+/*
+ * Copyright 2021 WPPConnect Team
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { Request, Response } from 'express';
+
+import config from '../config';
+import { SessionResourceMonitor } from '../util/SessionResourceMonitor';
+
+// Initialize the resource monitor with custom userDataDir from config
+const resourceMonitor = new SessionResourceMonitor(
+  config.customUserDataDir || './userDataDir/',
+  5000 // 5 seconds cache
+);
+
+/**
+ * Get resource usage for a specific session
+ * GET /api/:session/resource-usage
+ */
+export async function getSessionResourceUsage(req: Request, res: Response) {
+  /**
+   * #swagger.tags = ["Auth"]
+   #swagger.operationId = 'SessionResourceUsage'
+   #swagger.autoBody=false
+   #swagger.security = [{
+   "bearerAuth": []
+   }]
+   #swagger.parameters["session"] = {
+   schema: 'NERDWHATS_AMERICA'
+   }
+   */
+  try {
+    const { session } = req.params;
+
+    if (!session) {
+      return res.status(400).json({
+        success: false,
+        error: 'Session name is required',
+      });
+    }
+
+    const usage = await resourceMonitor.getSessionUsage(session);
+
+    return res.json({
+      success: true,
+      data: usage,
+    });
+  } catch (error) {
+    console.error('Error getting session resource usage:', error);
+    return res.status(500).json({
+      success: false,
+      error: 'Failed to get session resource usage',
+      // message: error.message,
+    });
+  }
+}
+
+/**
+ * Get resource usage for all sessions
+ * GET /api/sessions/resource-usage
+ */
+export async function getAllSessionsResourceUsage(req: Request, res: Response) {
+  /**
+   * #swagger.tags = ["Auth"]
+   #swagger.autoBody=false
+   #swagger.operationId = 'AllSessionsResourceUsage'
+   #swagger.autoQuery=false
+   #swagger.autoHeaders=false
+   #swagger.security = [{
+   "bearerAuth": []
+   }]
+   #swagger.parameters["secretkey"] = {
+   schema: 'THISISMYSECURETOKEN'
+   }
+   */
+  const { secretkey } = req.params;
+  const { authorization: token } = req.headers;
+
+  let tokenDecrypt: any = '';
+
+  if (secretkey === undefined) {
+    tokenDecrypt = token?.split(' ')[0];
+  } else {
+    tokenDecrypt = secretkey;
+  }
+
+  if (tokenDecrypt !== req.serverOptions.secretKey) {
+    res.status(400).json({
+      response: false,
+      message: 'The token is incorrect',
+    });
+  }
+
+  try {
+    const usage = await resourceMonitor.getAllSessionsUsage();
+
+    return res.json({
+      success: true,
+      data: usage,
+    });
+  } catch (error) {
+    console.error('Error getting all sessions resource usage:', error);
+    return res.status(500).json({
+      success: false,
+      error: 'Failed to get resource usage for all sessions',
+      // message: error.message
+    });
+  }
+}
+
+/**
+ * Clear resource monitor cache
+ * POST /api/resource-usage/clear-cache
+ */
+export async function clearResourceCache(req: Request, res: Response) {
+  try {
+    const { session } = req.body;
+
+    if (session) {
+      resourceMonitor.clearSessionCache(session);
+      return res.json({
+        success: true,
+        message: `Cache cleared for session: ${session}`,
+      });
+    } else {
+      resourceMonitor.clearCache();
+      return res.json({
+        success: true,
+        message: 'All cache cleared',
+      });
+    }
+  } catch (error) {
+    console.error('Error clearing resource cache:', error);
+    return res.status(500).json({
+      success: false,
+      error: 'Failed to clear cache',
+      // message: error.message
+    });
+  }
+}

src/routes/index.ts

@@ -31,6 +31,7 @@ import * as NewsletterController from '../controller/newsletterController';
 import * as OrderController from '../controller/orderController';
 import * as SessionController from '../controller/sessionController';
 import * as StatusController from '../controller/statusController';
+import * as ResourceController from '../controller/resourceController';
 import verifyToken from '../middleware/auth';
 import * as HealthCheck from '../middleware/healthCheck';
 import * as prometheusRegister from '../middleware/instrumentation';
@@ -48,9 +49,18 @@ routes.get(
   '/api/:secretkey/show-all-sessions',
   SessionController.showAllSessions
 );
+routes.get(
+  '/api/:secretkey/all-sessions-resource-usage',
+  ResourceController.getAllSessionsResourceUsage
+);
 routes.post('/api/:secretkey/start-all', SessionController.startAllSessions);
 
 // Sessions
+routes.get(
+  '/api/:session/resource-usage',
+  verifyToken,
+  ResourceController.getSessionResourceUsage
+);
 routes.get(
   '/api/:session/check-connection-session',
   verifyToken,