@harshankur/viewcounter 3.1.0 → 3.3.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@harshankur/viewcounter",
   "description": "A middleware backend server that registers views to my db server when requested to register a view from my other projects.",
-  "version": "3.1.0",
+  "version": "3.3.0",
   "main": "index.js",
   "engines": {
     "node": ">=24"
@@ -10,6 +10,7 @@
     "index.js",
     "constants.js",
     "admin/",
+    "tracker/",
     "config/",
     "db/",
     "middleware/",
@@ -78,8 +79,10 @@
     "express-validator": "^7.3.2",
     "geoip-country": "^5.0.202609230144",
     "helmet": "^8.3.0",
+    "isbot": "^5.2.2",
+    "maxmind": "^5.0.7",
     "mysql2": "^3.24.4",
-    "ua-parser-js": "^2.0.10",
+    "ua-parser-js": "^1.0.41",
     "url-parse": "^1.5.10"
   },
   "overrides": {

package/routes/admin.js

@@ -25,11 +25,14 @@ const {
     ADMIN_ERROR_CODE,
     ADMIN_RANGE,
     ADMIN_SORT_COLUMNS,
+    ANALYSIS,
     EDITABLE_FIELDS,
     FIELD_MAX_LENGTH,
     HTTP_STATUS,
     MODIFIED_FILTER,
+    REJECTION_REASON,
     SORT_ORDER,
+    TRACKING_OUTCOME,
     VIEW_LOG_SOURCE,
     VIEW_STATUS,
 } = require('../constants');
@@ -41,25 +44,35 @@ const {
     requireAdminSession,
     requireCsrf,
     verifyPassword,
+    requireRecentPassword,
+    sessionCsrfToken,
     cookieOptions,
     originAllowed,
     readToken,
 } = require('../middleware/adminAuth');
 const {
+    parseWhere,
     validateLogin,
     validateViewListing,
     validateAnalysis,
+    validateEventTypes,
+    validateRealtime,
     validateEdit,
     validateNote,
     validateBatch,
     validateAdminLogListing,
-    validateViewLogListing,
+    validateTrackingLogListing,
+    validateTrackingSummary,
     handleAdminValidation,
 } = require('../middleware/adminValidation');
 const { logContext, withRequestId } = require('./analytics');
+const { attributions } = require('../utils/geoCity');
+const { ACQUISITION_DIMENSIONS } = require('../db/analysis');
 
 /** The UI's static files, shipped in the package. */
 const ADMIN_UI_DIR = path.join(__dirname, '..', 'admin');
+/** Shown in the UI's header and footer, so an admin knows what they are running. */
+const PACKAGE_VERSION = require('../package.json').version;
 
 /**
  * Content Security Policy for the admin surface. Stricter than helmet's
@@ -94,6 +107,8 @@ function filterQuery(req) {
         range: req.query.range || ADMIN_RANGE.ALL,
         search: req.query.search || '',
         eventType: req.query.eventType || '',
+        // Validated already; parsed again here since Express 5 recomputes req.query.
+        where: parseWhere(req.query.where),
     };
 }
 
@@ -108,16 +123,19 @@ function adminError(req, res, error, operation) {
 
 /**
  * @param {{ config: object, adminRepo: object, logRepo: object,
- *   sessionStore?: object, isReady?: () => boolean, uiDir?: string }} deps
+ *   sessionStore?: object, isReady?: () => boolean, uiDir?: string,
+ *   geo?: { city: object|null } }} deps
+ *   `geo.city` is the optional city database, whose credit the UI shows
  * @returns {import('express').Router}
  */
 function createAdminRouter({
     config,
     adminRepo,
     logRepo,
-    sessionStore = createSessionStore(),
+    sessionStore = createSessionStore({ idleMs: config.admin.sessionIdleMs, absoluteMs: config.admin.sessionMaxAgeMs }),
     isReady = () => true,
     uiDir = ADMIN_UI_DIR,
+    geo = { city: null },
 }) {
     // The standalone server checks this when it loads its config; an app
     // embedding the router gets the same floor, not a weaker admin surface.
@@ -152,7 +170,7 @@ function createAdminRouter({
         handler: (req, res) => res.status(HTTP_STATUS.TOO_MANY_REQUESTS).json({ code: ADMIN_ERROR_CODE.RATE_LIMITED }),
     }));
 
-    router.use(ADMIN.API_PATH, createAdminApi({ config, adminRepo, logRepo, sessionStore, isReady }));
+    router.use(ADMIN.API_PATH, createAdminApi({ config, adminRepo, logRepo, sessionStore, isReady, geo }));
 
     // Relative asset URLs in the UI only resolve under a trailing slash.
     router.get('/', (req, res, next) => {
@@ -168,7 +186,7 @@ function createAdminRouter({
 /**
  * The JSON API behind the UI.
  */
-function createAdminApi({ config, adminRepo, logRepo, sessionStore, isReady }) {
+function createAdminApi({ config, adminRepo, logRepo, sessionStore, isReady, geo }) {
     const api = express.Router();
     const allowed = config.allowed;
 
@@ -196,10 +214,15 @@ function createAdminApi({ config, adminRepo, logRepo, sessionStore, isReady }) {
 
     // ---- Session ----------------------------------------------------------
 
-    api.get('/session', (req, res) => {
-        const session = sessionStore.get(readToken(req));
-        if (!session) return res.json({ authenticated: false });
-        return res.json({ authenticated: true, csrfToken: session.csrfToken });
+    api.get('/session', async (req, res) => {
+        try {
+            const token = readToken(req);
+            const session = await sessionStore.get(token);
+            if (!session) return res.json({ authenticated: false });
+            return res.json({ authenticated: true, csrfToken: sessionCsrfToken(token) });
+        } catch (error) {
+            return adminError(req, res, error, 'read session');
+        }
     });
 
     const loginLimiter = rateLimit({
@@ -232,22 +255,38 @@ function createAdminApi({ config, adminRepo, logRepo, sessionStore, isReady }) {
 
             // A fresh token on every login; any previous session in this
             // browser is ended rather than left valid alongside the new one.
-            sessionStore.destroy(readToken(req));
-            const { token, session } = sessionStore.create();
-            res.cookie(ADMIN.SESSION_COOKIE, token, cookieOptions(req));
+            await sessionStore.destroy(readToken(req));
+            const { token, session } = await sessionStore.create();
+            res.cookie(ADMIN.SESSION_COOKIE, token, cookieOptions(req, sessionStore.absoluteMs));
 
             req.adminSession = session;
             await record(req, ADMIN_ACTION.LOGIN_SUCCEEDED);
-            return res.json({ authenticated: true, csrfToken: session.csrfToken });
+            return res.json({ authenticated: true, csrfToken: sessionCsrfToken(token) });
         } catch (error) {
             return adminError(req, res, error, 'login');
         }
     });
 
+    // The password again, for actions that cannot be undone. Rate limited
+    // with sign-in, since it is the same guess.
+    api.post('/reauth', authed, loginLimiter, validateLogin(), handleAdminValidation, async (req, res) => {
+        try {
+            if (!verifyPassword(req.body.password, config.admin.password)) {
+                await record(req, ADMIN_ACTION.LOGIN_FAILED);
+                return res.status(HTTP_STATUS.UNAUTHORIZED).json({ code: ADMIN_ERROR_CODE.INVALID_PASSWORD });
+            }
+            await sessionStore.confirmPassword(req.adminToken);
+            await record(req, ADMIN_ACTION.PASSWORD_CONFIRMED);
+            return res.status(HTTP_STATUS.NO_CONTENT).end();
+        } catch (error) {
+            return adminError(req, res, error, 'confirm password');
+        }
+    });
+
     api.post('/logout', authed, async (req, res) => {
         try {
             await record(req, ADMIN_ACTION.LOGOUT);
-            sessionStore.destroy(req.adminToken);
+            await sessionStore.destroy(req.adminToken);
             res.clearCookie(ADMIN.SESSION_COOKIE, { ...cookieOptions(req), maxAge: undefined });
             return res.status(HTTP_STATUS.NO_CONTENT).end();
         } catch (error) {
@@ -259,6 +298,7 @@ function createAdminApi({ config, adminRepo, logRepo, sessionStore, isReady }) {
 
     api.get('/meta', requireSession, (req, res) => {
         res.json({
+            version: PACKAGE_VERSION,
             deviceSizes: allowed.deviceSize,
             editableFields: Object.keys(EDITABLE_FIELDS),
             sortFields: Object.keys(ADMIN_SORT_COLUMNS),
@@ -267,11 +307,21 @@ function createAdminApi({ config, adminRepo, logRepo, sessionStore, isReady }) {
             modifiedFilters: Object.values(MODIFIED_FILTER),
             actions: Object.values(ADMIN_ACTION),
             sources: Object.values(VIEW_LOG_SOURCE),
+            outcomes: Object.values(TRACKING_OUTCOME),
+            rejectionReasons: Object.values(REJECTION_REASON),
             maxBatchIds: ADMIN.MAX_BATCH_IDS,
             pageSizes: ADMIN.PAGE_SIZES,
             pageSizeDefault: ADMIN.PAGE_SIZE_DEFAULT,
             searchMaxLength: ADMIN.SEARCH_MAX_LENGTH,
             trashRetentionDays: config.admin.trashRetentionDays,
+            reauthWindowMs: ADMIN.REAUTH_WINDOW_MS,
+            // "Right now" counts visitors seen within this many minutes.
+            realtimeVisitorMinutes: ANALYSIS.REALTIME_VISITOR_MINUTES,
+            // Breakdowns of how visits arrived, which count page views only.
+            acquisitionDimensions: [...ACQUISITION_DIMENSIONS],
+            // Credits the location data's licences ask for, shown in the UI.
+            attributions: attributions(geo.city),
+            hasCityData: Boolean(geo.city),
             viewLogRetentionDays: config.admin.viewLogRetentionDays,
             maxLength: {
                 note: FIELD_MAX_LENGTH.NOTE,
@@ -347,6 +397,46 @@ function createAdminApi({ config, adminRepo, logRepo, sessionStore, isReady }) {
         }
     });
 
+    // Every event type the apps hold in a status, whatever other filter is
+    // set, for the event-type filter above a listing.
+    api.get('/apps/:appId/event-types', requireSession, validateEventTypes(allowed), handleAdminValidation,
+        async (req, res) => {
+            try {
+                const status = req.query.status || VIEW_STATUS.ACTIVE;
+                return res.json({ eventTypes: await adminRepo.eventTypes([req.params.appId], status) });
+            } catch (error) {
+                return adminError(req, res, error, 'list event types');
+            }
+        });
+
+    api.get('/event-types', requireSession, validateEventTypes(), handleAdminValidation, async (req, res) => {
+        try {
+            const apps = await adminRepo.existingTables(allowed.appId);
+            const status = req.query.status || VIEW_STATUS.ACTIVE;
+            return res.json({ eventTypes: apps.length ? await adminRepo.eventTypes(apps, status) : [] });
+        } catch (error) {
+            return adminError(req, res, error, 'list all event types');
+        }
+    });
+
+    // Right now: visitors in the last few minutes and views per minute.
+    api.get('/apps/:appId/realtime', requireSession, validateRealtime(allowed), handleAdminValidation, async (req, res) => {
+        try {
+            return res.json({ apps: [req.params.appId], ...await adminRepo.realtime([req.params.appId]) });
+        } catch (error) {
+            return adminError(req, res, error, 'read realtime');
+        }
+    });
+
+    api.get('/realtime', requireSession, async (req, res) => {
+        try {
+            const apps = await adminRepo.existingTables(allowed.appId);
+            return res.json({ apps, ...await adminRepo.realtime(apps) });
+        } catch (error) {
+            return adminError(req, res, error, 'read realtime');
+        }
+    });
+
     api.patch('/apps/:appId/views', authed, validateEdit(allowed), handleAdminValidation, async (req, res) => {
         try {
             const { appId } = req.params;
@@ -373,8 +463,8 @@ function createAdminApi({ config, adminRepo, logRepo, sessionStore, isReady }) {
     });
 
     /** delete / restore / purge share one shape: IDs in, changed IDs out. */
-    const batchRoute = (suffix, operation, action) => {
-        api.post(`/apps/:appId/views/${suffix}`, authed, validateBatch(allowed), handleAdminValidation,
+    const batchRoute = (suffix, operation, action, guards = []) => {
+        api.post(`/apps/:appId/views/${suffix}`, authed, ...guards, validateBatch(allowed), handleAdminValidation,
             async (req, res) => {
                 try {
                     const { appId } = req.params;
@@ -389,7 +479,9 @@ function createAdminApi({ config, adminRepo, logRepo, sessionStore, isReady }) {
 
     batchRoute('delete', 'softDelete', ADMIN_ACTION.VIEWS_DELETED);
     batchRoute('restore', 'restore', ADMIN_ACTION.VIEWS_RESTORED);
-    batchRoute('purge', 'purge', ADMIN_ACTION.VIEWS_PURGED);
+    // Erasing for good cannot be undone, so it wants the password from the
+    // last few minutes, not just a session that may be weeks old.
+    batchRoute('purge', 'purge', ADMIN_ACTION.VIEWS_PURGED, [requireRecentPassword()]);
 
     // ---- Logs -------------------------------------------------------------
 
@@ -408,18 +500,29 @@ function createAdminApi({ config, adminRepo, logRepo, sessionStore, isReady }) {
             }
         });
 
-    api.get('/logs/views', requireSession, validateViewLogListing(allowed), handleAdminValidation,
+    // The tracking log: every tracking request and what became of it.
+    api.get('/logs/tracking', requireSession, validateTrackingLogListing(allowed), handleAdminValidation,
         async (req, res) => {
             try {
-                const result = await logRepo.listViewLog({
+                const result = await logRepo.listTrackingLog({
                     page: intParam(req, 'page', 1),
                     pageSize: intParam(req, 'pageSize', ADMIN.PAGE_SIZE_DEFAULT),
                     appId: req.query.appId,
                     source: req.query.source,
+                    outcome: req.query.outcome,
                 });
                 return res.json(result);
             } catch (error) {
-                return adminError(req, res, error, 'list view log');
+                return adminError(req, res, error, 'list tracking log');
+            }
+        });
+
+    api.get('/logs/tracking/summary', requireSession, validateTrackingSummary(allowed), handleAdminValidation,
+        async (req, res) => {
+            try {
+                return res.json(await logRepo.trackingSummary({ hours: ADMIN.TRACKING_SUMMARY_HOURS, appId: req.query.appId }));
+            } catch (error) {
+                return adminError(req, res, error, 'summarize tracking log');
             }
         });
 
@@ -428,8 +531,13 @@ function createAdminApi({ config, adminRepo, logRepo, sessionStore, isReady }) {
     // Malformed or oversized JSON bodies, in the admin error shape.
     // eslint-disable-next-line no-unused-vars
     api.use((err, req, res, next) => {
-        logger.warn(`admin request rejected: ${err.message}`, logContext(req));
-        return res.status(HTTP_STATUS.BAD_REQUEST).json({ code: ADMIN_ERROR_CODE.VALIDATION_FAILED });
+        const status = err.status || err.statusCode;
+        if (status >= 400 && status < 500) {
+            logger.warn(`admin request rejected: ${err.message}`, logContext(req));
+            return res.status(HTTP_STATUS.BAD_REQUEST).json({ code: ADMIN_ERROR_CODE.VALIDATION_FAILED });
+        }
+        // Anything else is ours (a session store that cannot be read, say).
+        return adminError(req, res, err, 'handle request');
     });
 
     return api;