refactor: sitemap to async/await

src/sitemap.js

@@ -1,53 +1,45 @@
 'use strict';
 
-var async = require('async');
 const { Sitemap } = require('sitemap');
-var nconf = require('nconf');
+const nconf = require('nconf');
 
-var db = require('./database');
+const db = require('./database');
-var categories = require('./categories');
+const categories = require('./categories');
-var topics = require('./topics');
+const topics = require('./topics');
-var privileges = require('./privileges');
+const privileges = require('./privileges');
-var meta = require('./meta');
+const meta = require('./meta');
-var plugins = require('./plugins');
+const plugins = require('./plugins');
-var utils = require('./utils');
+const utils = require('./utils');
 
-var sitemap = module.exports;
+const sitemap = module.exports;
 sitemap.maps = {
 	topics: [],
 };
 
-sitemap.render = function (callback) {
+sitemap.render = async function () {
-	var topicsPerPage = meta.config.sitemapTopics;
+	const topicsPerPage = meta.config.sitemapTopics;
-	var returnData = {
+	const returnData = {
 		url: nconf.get('url'),
 		topics: [],
 	};
+	const topicCount = await db.getObjectField('global', 'topicCount');
+	const numPages = Math.ceil(Math.max(0, topicCount / topicsPerPage));
+	for (var x = 1; x <= numPages; x += 1) {
+		returnData.topics.push(x);
+	}
 
-	async.waterfall([
+	return returnData;
-		function (next) {
-			db.getObjectField('global', 'topicCount', next);
-		},
-		function (topicCount, next) {
-			var numPages = Math.ceil(Math.max(0, topicCount / topicsPerPage));
-			for (var x = 1; x <= numPages; x += 1) {
-				returnData.topics.push(x);
-			}
-
-			next(null, returnData);
-		},
-	], callback);
 };
 
-sitemap.getPages = function (callback) {
+sitemap.getPages = async function () {
 	if (
 		sitemap.maps.pages &&
 		Date.now() < parseInt(sitemap.maps.pages.cacheSetTimestamp, 10) + parseInt(sitemap.maps.pages.cacheResetPeriod, 10)
 	) {
-		return callback(null, sitemap.maps.pages.toXML());
+		return sitemap.maps.pages.toXML();
 	}
 
-	var urls = [{
+	const urls = [{
 		url: '',
 		changefreq: 'weekly',
 		priority: 0.6,
@@ -65,106 +57,84 @@ sitemap.getPages = function (callback) {
 		priority: 0.4,
 	}];
 
-	plugins.fireHook('filter:sitemap.getPages', { urls: urls }, function (err, data) {
+	const data = await plugins.fireHook('filter:sitemap.getPages', { urls: urls });
-		if (err) {
+	sitemap.maps.pages = new Sitemap({
-			return callback(err);
+		hostname: nconf.get('url'),
-		}
+		cacheTime: 1000 * 60 * 60 * 24,	// Cached for 24 hours
-		sitemap.maps.pages = new Sitemap({
+		urls: data.urls,
-			hostname: nconf.get('url'),
-			cacheTime: 1000 * 60 * 60 * 24,	// Cached for 24 hours
-			urls: data.urls,
-		});
-
-		callback(null, sitemap.maps.pages.toXML());
 	});
+
+	return sitemap.maps.pages.toXML();
 };
 
-sitemap.getCategories = function (callback) {
+sitemap.getCategories = async function () {
 	if (
 		sitemap.maps.categories &&
 		Date.now() < parseInt(sitemap.maps.categories.cacheSetTimestamp, 10) + parseInt(sitemap.maps.categories.cacheResetPeriod, 10)
 	) {
-		return callback(null, sitemap.maps.categories.toXML());
+		return sitemap.maps.categories.toXML();
 	}
 
-	var categoryUrls = [];
+	const categoryUrls = [];
-	categories.getCategoriesByPrivilege('categories:cid', 0, 'find', function (err, categoriesData) {
+	const categoriesData = await categories.getCategoriesByPrivilege('categories:cid', 0, 'find');
-		if (err) {
+	categoriesData.forEach(function (category) {
-			return callback(err);
+		if (category) {
+			categoryUrls.push({
+				url: '/category/' + category.slug,
+				changefreq: 'weekly',
+				priority: 0.4,
+			});
 		}
+	});
 
-		categoriesData.forEach(function (category) {
+	sitemap.maps.categories = new Sitemap({
-			if (category) {
+		hostname: nconf.get('url'),
-				categoryUrls.push({
+		cacheTime: 1000 * 60 * 60 * 24,	// Cached for 24 hours
-					url: '/category/' + category.slug,
+		urls: categoryUrls,
-					changefreq: 'weekly',
-					priority: 0.4,
-				});
-			}
-		});
-
-		sitemap.maps.categories = new Sitemap({
-			hostname: nconf.get('url'),
-			cacheTime: 1000 * 60 * 60 * 24,	// Cached for 24 hours
-			urls: categoryUrls,
-		});
-
-		callback(null, sitemap.maps.categories.toXML());
 	});
+
+	return sitemap.maps.categories.toXML();
 };
 
-sitemap.getTopicPage = function (page, callback) {
+sitemap.getTopicPage = async function (page) {
 	if (parseInt(page, 10) <= 0) {
-		return callback();
+		return;
 	}
 
-	var numTopics = meta.config.sitemapTopics;
+	const numTopics = meta.config.sitemapTopics;
-	var min = (parseInt(page, 10) - 1) * numTopics;
+	const min = (parseInt(page, 10) - 1) * numTopics;
-	var max = min + numTopics;
+	const max = min + numTopics;
 
 	if (
 		sitemap.maps.topics[page - 1] &&
 		Date.now() < parseInt(sitemap.maps.topics[page - 1].cacheSetTimestamp, 10) + parseInt(sitemap.maps.topics[page - 1].cacheResetPeriod, 10)
 	) {
-		return callback(null, sitemap.maps.topics[page - 1].toXML());
+		return sitemap.maps.topics[page - 1].toXML();
 	}
 
-	var topicUrls = [];
+	const topicUrls = [];
-
+	let tids = await db.getSortedSetRevRange('topics:recent', min, max);
-	async.waterfall([
+	tids = await privileges.topics.filterTids('topics:read', tids, 0);
-		function (next) {
+	const topicData = await topics.getTopicsFields(tids, ['tid', 'title', 'slug', 'lastposttime']);
-			db.getSortedSetRevRange('topics:recent', min, max, next);
+
-		},
+	topicData.forEach(function (topic) {
-		function (tids, next) {
+		if (topic) {
-			privileges.topics.filterTids('topics:read', tids, 0, next);
+			topicUrls.push({
-		},
+				url: '/topic/' + topic.slug,
-		function (tids, next) {
+				lastmodISO: utils.toISOString(topic.lastposttime),
-			topics.getTopicsFields(tids, ['tid', 'title', 'slug', 'lastposttime'], next);
+				changefreq: 'daily',
-		},
+				priority: 0.6,
-	], function (err, topics) {
+			});
-		if (err) {
-			return callback(err);
 		}
+	});
 
-		topics.forEach(function (topic) {
+	sitemap.maps.topics[page - 1] = new Sitemap({
-			if (topic) {
+		hostname: nconf.get('url'),
-				topicUrls.push({
+		cacheTime: 1000 * 60 * 60,	// Cached for 1 hour
-					url: '/topic/' + topic.slug,
+		urls: topicUrls,
-					lastmodISO: utils.toISOString(topic.lastposttime),
-					changefreq: 'daily',
-					priority: 0.6,
-				});
-			}
-		});
-
-		sitemap.maps.topics[page - 1] = new Sitemap({
-			hostname: nconf.get('url'),
-			cacheTime: 1000 * 60 * 60,	// Cached for 1 hour
-			urls: topicUrls,
-		});
-
-		callback(null, sitemap.maps.topics[page - 1].toXML());
 	});
+
+	return sitemap.maps.topics[page - 1].toXML();
 };
 
 sitemap.clearCache = function () {