expressjs-stats 1.0.7

package/README.md

@@ -0,0 +1,63 @@
+# **Simple and easy statistics**
+
+`expressjs-stats` is a small NPM package that allows you to create simple statistics for your ExpressJS REST API.
+
+### **Installation**
+
+```bash
+npm install expressjs-stats
+```
+
+## **Middleware implementation**
+
+The setup is super easy and done in under a minute. Just import `routesTracker` from `expressjs-stats`:
+
+```js
+const { routesTracker } = require('expressjs-stats')
+```
+
+After that add it to any route you want to get tracked.
+
+```js
+app.get('/', routesTracker, async (req, res) => {
+    return res.send('Awesome!')
+})
+```
+
+And you are completely done. Congratulations!
+
+## **Get statistics data**
+
+We do not only want to track them but also access the data. Simply import `getStats` from `expressjs-stats`.
+
+```js
+const { routesTracker, getStats } = require('expressjs-stats')
+```
+
+Now await this function anywhere you want and get the data.
+
+```js
+app.get('/stats', routesTracker, async(req, res) => {
+    const stats = await getStats()
+    return res.send(stats)
+})
+```
+
+There's also the `range` option. You can define the time period in which you want to get all the data. The default value is `alltime`.
+
+**Examples:**
+- `20min`
+- `3d`
+- `90d`
+- `1y`
+
+```js
+app.get('/stats', routesTracker, async(req, res) => {
+    const stats = await getStats(range = '1h')
+    return res.send(stats)
+})
+```
+
+**Example Response:**
+```json
+```

package/index.js

@@ -0,0 +1,109 @@
+const { PrismaClient } = require('@prisma/client')
+const prisma = new PrismaClient()
+
+const DeviceDetector = require("device-detector-js");
+const deviceDetector = new DeviceDetector();
+
+const ms = require('ms')
+
+async function routesTracker(req, res, next) {
+    const informations = deviceDetector.parse(req.headers['user-agent'])
+
+    var data = {
+        ip: null,
+        browser: null,
+        os: null,
+        device: null,
+        route: null,
+        timestamp: +new Date()
+    }
+
+    try { data.ip = req.headers['x-forwarded-for'] || req.connection.remoteAddress } catch (error) {}
+    if(data.ip == '::1') data.ip = 'localhost'
+    try { data.browser = informations.client.type } catch (error) {}
+    try { data.os = informations.os.name } catch (error) {}
+    try { data.device = informations.device.type } catch (error) {}
+    try { data.route = req.path } catch (error) {}
+
+    await prisma.requests.create({
+        data: data,
+    })
+
+    next()
+}
+
+async function getStats( range = 'alltime') {
+    var time_period = 0
+    if(range !== 'alltime') time_period = ms(range)
+    if(!time_period) return 'Invalid range'
+
+    var timestamp_gte = 0
+    if(range !== 'alltime') timestamp_gte = +new Date() - time_period
+
+    const getData = await prisma.requests.findMany({
+        where: {
+            timestamp: { 
+                gte: timestamp_gte
+            },
+        }
+    })
+
+    const ips = [...new Set(getData.map(data => data.ip))]
+    const devices = [...new Set(getData.map(data => data.device))]
+    const os = [...new Set(getData.map(data => data.os))]
+    const browsers = [...new Set(getData.map(data => data.browser))]
+    const routes = [...new Set(getData.map(data => data.route))]
+
+    const categories = ['ip', 'device', 'os', 'browser', 'route']
+    const values = [ips, devices, os, browsers, routes]
+
+    var dataArray = {}
+
+    const totalAmount = await prisma.requests.count({ where: { timestamp: { gte: timestamp_gte } } })
+
+    dataArray['time_range'] = range
+    dataArray['total_requests'] = totalAmount
+    dataArray['unique_users'] = ips.length
+
+    for (let index = 0; index < categories.length; index++) {
+        var catgAmount = 0
+        
+        if(categories[index] === 'device') catgAmount = await prisma.requests.count({ where: { timestamp: { gte: timestamp_gte }, NOT: { device: null } } })
+        if(categories[index] === 'os') catgAmount = await prisma.requests.count({ where: { timestamp: { gte: timestamp_gte }, NOT: { os: null } } })
+        if(categories[index] === 'browser') catgAmount = await prisma.requests.count({ where: { timestamp: { gte: timestamp_gte }, NOT: { browser: null } } })
+        if(categories[index] === 'route') catgAmount = await prisma.requests.count({ where: { timestamp: { gte: timestamp_gte } } })
+        
+        var categoryDataArray = []
+        
+        if(categories[index] !== 'ip') {
+            for (let i = 0; i < values[index].length; i++) {
+                const element = values[index][i]
+    
+                if(element) {
+                    var amount = 0
+
+                    if(categories[index] === 'device') amount = await prisma.requests.count({ where: { timestamp: { gte: timestamp_gte }, NOT: { device: null }, device: element } })
+                    if(categories[index] === 'os') amount = await prisma.requests.count({ where: { timestamp: { gte: timestamp_gte }, NOT: { os: null }, os: element } })
+                    if(categories[index] === 'browser') amount = await prisma.requests.count({ where: { timestamp: { gte: timestamp_gte }, NOT: { browser: null }, browser: element } })
+                    if(categories[index] === 'route') amount = await prisma.requests.count({ where: { timestamp: { gte: timestamp_gte }, route: element } })
+        
+                    const percentage = (amount / catgAmount * 100).toFixed(2)
+    
+                    categoryDataArray.push({
+                        name: element,
+                        requests: amount,
+                        percentage: percentage + '%'
+                    })
+                }
+            }
+    
+            categoryDataArray.sort((a, b) => parseFloat(b.requests) - parseFloat(a.requests))
+    
+            dataArray[categories[index]] = categoryDataArray
+        }
+    }
+
+    return dataArray
+}
+
+module.exports = { routesTracker, getStats }

package/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "expressjs-stats",
+  "version": "1.0.7",
+  "description": "Simple and easy statistics for your expressjs REST API",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "postinstall": "prisma generate && prisma migrate dev --name init"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/JannisMilz/expressjs-stats.git"
+  },
+  "keywords": [
+    "expressjs",
+    "statistics",
+    "middleware"
+  ],
+  "author": "AquaDev",
+  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/JannisMilz/expressjs-stats/issues"
+  },
+  "homepage": "https://github.com/JannisMilz/expressjs-stats#readme",
+  "dependencies": {
+    "@prisma/client": "^3.12.0",
+    "prisma": "^3.12.0",
+    "device-detector-js": "^3.0.3",
+    "ms": "^2.1.3"
+  },
+  "devDependencies": {
+    "@types/node": "^17.0.27",
+    "express": "^4.18.0",
+    "sqlite": "^4.1.1",
+    "ts-node": "^10.7.0",
+    "typescript": "^4.6.3"
+  }
+}

package/prisma/schema.prisma

@@ -0,0 +1,18 @@
+generator client {
+  provider = "prisma-client-js"
+}
+
+datasource db {
+  provider = "sqlite"
+  url      = "file:./requests.db"
+}
+
+model requests {
+  id        Int     @id @default(autoincrement())
+  ip        String?
+  device    String?
+  os        String?
+  browser   String?
+  route     String
+  timestamp Decimal
+}