NodeBB/src/meta/errors.js

'use strict';

const nconf = require('nconf');
const winston = require('winston');
const validator = require('validator');
const cronJob = require('cron').CronJob;
const { setTimeout } = require('timers/promises');

const db = require('../database');
const analytics = require('../analytics');
const pubsub = require('../pubsub');
const utils = require('../utils');

const Errors = module.exports;

const runJobs = nconf.get('runJobs');

let counters = {};
let total = {};

Errors.init = async function () {
	new cronJob('0 * * * * *', async () => {
		publishLocalErrors();
		if (runJobs) {
			await setTimeout(2000);
			await Errors.writeData();
		}
	}, null, true);

	if (runJobs) {
		pubsub.on('errors:publish', (data) => {
			for (const [key, value] of Object.entries(data.local)) {
				if (utils.isNumber(value)) {
					total[key] = total[key] || 0;
					total[key] += value;
				}
			}
		});
	}
};

function publishLocalErrors() {
	pubsub.publish('errors:publish', {
		local: counters,
	});
	counters = {};
}

Errors.writeData = async function () {
	try {
		const _counters = { ...total };
		total = {};
		const keys = Object.keys(_counters);
		if (!keys.length) {
			return;
		}

		const bulkIncrement = [];
		for (const key of keys) {
			bulkIncrement.push(['errors:404', _counters[key], key ]);
		}
		await db.sortedSetIncrByBulk(bulkIncrement);
	} catch (err) {
		winston.error(err.stack);
	}
};

Errors.log404 = function (route) {
	if (!route) {
		return;
	}
	route = route.slice(0, 512).replace(/\/$/, ''); // remove trailing slashes
	analytics.increment('errors:404');
	counters[route] = counters[route] || 0;
	counters[route] += 1;
};

Errors.get = async function (escape) {
	const data = await db.getSortedSetRevRangeWithScores('errors:404', 0, 199);
	data.forEach((nfObject) => {
		nfObject.value = escape ? validator.escape(String(nfObject.value || '')) : nfObject.value;
	});
	return data;
};

Errors.clear = async function () {
	await db.delete('errors:404');
};