10709878166

Committed 04 Sep 2024 09:34PM UTC coverage: 82.671%. Remained the same

Build # 10709878166

Build Type

Pull #411

github

Committed by

web-flow

Commit Message

Merge b3d408e31 into e7cfda55c

Pull Request Pull Request #411: Refactoring code in src/controllers/category.js to reduce cognitive complexity

Run Details

9965 of 13474 branches covered (73.96%)

Branch coverage included in aggregate %.

4 of 5 new or added lines in 1 file covered. (80.0%)

1 existing line in 1 file now uncovered.

22324 of 25583 relevant lines covered (87.26%)

1632.74 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

95.93

/src/controllers/category.js

'use strict';

const nconf = require('nconf');
const validator = require('validator');
const qs = require('querystring');

const db = require('../database');
const privileges = require('../privileges');
const user = require('../user');
const categories = require('../categories');
const meta = require('../meta');
const pagination = require('../pagination');
const helpers = require('./helpers');
const utils = require('../utils');
const translator = require('../translator');
const analytics = require('../analytics');

const categoryController = module.exports;

const url = nconf.get('url');
const relative_path = nconf.get('relative_path');
const validSorts = [
        'recently_replied', 'recently_created', 'most_posts', 'most_votes', 'most_views',
];


categoryController.get = async function (req, res, next) {
        console.log('Abdulaziz');
        const cid = req.params.category_id;

        let currentPage = parseInt(req.query.page, 10) || 1;
        let topicIndex = utils.isNumber(req.params.topic_index) ? parseInt(req.params.topic_index, 10) - 1 : 0;
        if ((req.params.topic_index && !utils.isNumber(req.params.topic_index)) || !utils.isNumber(cid)) {
                return next();
        }

        const [categoryFields, userPrivileges, tagData, userSettings, rssToken] = await Promise.all([
                categories.getCategoryFields(cid, ['slug', 'disabled', 'link']),
                privileges.categories.get(cid, req.uid),
                helpers.getSelectedTag(req.query.tag),
                user.getSettings(req.uid),
                user.auth.getFeedToken(req.uid),
        ]);

        // If the category doesn't exist or is disabled, return 404
        if (!categoryFields || categoryFields.disabled) {
                return res.status(404).render('404', { url: req.url });
        }

        // Additional validation for missing slugs or invalid pagination
        if (!categoryFields.slug || (userSettings.usePagination && currentPage < 1)) {
                return next();
        }

        // Redirect if the topicIndex is invalid
        if (topicIndex < 0) {
                return helpers.redirect(res, `/category/${categoryFields.slug}?${qs.stringify(req.query)}`);
        }

        // If user lacks privileges, deny access
        if (!userPrivileges.read) {
                return helpers.notAllowed(req, res);
        }

        // Handle slug mismatch and redirect
        if (!res.locals.isAPI && !req.params.slug && (categoryFields.slug && categoryFields.slug !== `${cid}/`)) {
                return helpers.redirect(res, `/category/${categoryFields.slug}?${qs.stringify(req.query)}`, true);
        }

        // If category is a link, increase click count and redirect
        if (categoryFields.link) {
                await db.incrObjectField(`category:${cid}`, 'timesClicked');
                return helpers.redirect(res, validator.unescape(categoryFields.link));
        }

        // Handle pagination
        if (!userSettings.usePagination) {
                topicIndex = Math.max(0, topicIndex - (Math.ceil(userSettings.topicsPerPage / 2) - 1));
        } else if (!req.query.page) {
                const index = Math.max(parseInt((topicIndex || 0), 10), 0);
                currentPage = Math.ceil((index + 1) / userSettings.topicsPerPage);
                topicIndex = 0;
        }

        // Fetch category data
        const targetUid = await user.getUidByUserslug(req.query.author);
        const start = ((currentPage - 1) * userSettings.topicsPerPage) + topicIndex;
        const stop = start + userSettings.topicsPerPage - 1;

        const sort = validSorts.includes(req.query.sort) ? req.query.sort : userSettings.categoryTopicSort;

        const categoryData = await categories.getCategoryById({
                uid: req.uid,
                cid: cid,
                start: start,
                stop: stop,
                sort: sort,
                settings: userSettings,
                query: req.query,
                tag: req.query.tag,
                targetUid: targetUid,
        });

        // If no category data found, return 404
        if (!categoryData) {
                return res.status(404).render('404', { url: req.url });
        }

        // Ensure topic index is within bounds
        const pageCount = Math.max(1, Math.ceil(categoryData.topic_count / userSettings.topicsPerPage));
        if (userSettings.usePagination && currentPage > pageCount) {
                return next();
        }

        // Apply privileges and filter tags
        categories.modifyTopicsByPrivilege(categoryData.topics, userPrivileges);
        categoryData.tagWhitelist = categories.filterTagWhitelist(categoryData.tagWhitelist, userPrivileges.isAdminOrMod);

        // Process subcategories
        const allCategories = [];
        categories.flattenCategories(allCategories, categoryData.children);

        await Promise.all([
                buildBreadcrumbs(req, categoryData),
                categories.setUnread([categoryData], allCategories.map(c => c.cid).concat(cid), req.uid),
        ]);

        if (categoryData.children.length) {
                await categories.getRecentTopicReplies(allCategories, req.uid, req.query);
                categoryData.subCategoriesLeft = Math.max(0, categoryData.children.length - categoryData.subCategoriesPerPage);
                categoryData.hasMoreSubCategories = categoryData.children.length > categoryData.subCategoriesPerPage;
                categoryData.nextSubCategoryStart = categoryData.subCategoriesPerPage;
                categoryData.children = categoryData.children.slice(0, categoryData.subCategoriesPerPage);
                categoryData.children.forEach((child) => {
                        if (child) {
                                helpers.trimChildren(child);
                                helpers.setCategoryTeaser(child);
                        }
                });
        }

        // Prepare category data for rendering
        categoryData.title = translator.escape(categoryData.name);
        categoryData.selectCategoryLabel = '[[category:subcategories]]';
        categoryData.description = translator.escape(categoryData.description);
        categoryData.privileges = userPrivileges;
        categoryData.showSelect = userPrivileges.editable;
        categoryData.showTopicTools = userPrivileges.editable;
        categoryData.topicIndex = topicIndex;
        categoryData.selectedTag = tagData.selectedTag;
        categoryData.selectedTags = tagData.selectedTags;
        categoryData.sortOptionLabel = `[[topic:${validator.escape(String(sort)).replace(/_/g, '-')}]]`;

        // Handle RSS feed
        if (!meta.config['feeds:disableRSS']) {
                categoryData.rssFeedUrl = `${url}/category/${categoryData.cid}.rss`;
                if (req.loggedIn) {
                        categoryData.rssFeedUrl += `?uid=${req.uid}&token=${rssToken}`;
                }
        }

        // Add tags for SEO purposes
        addTags(categoryData, res, currentPage);

        categoryData['feeds:disableRSS'] = meta.config['feeds:disableRSS'] || 0;
        categoryData['reputation:disabled'] = meta.config['reputation:disabled'];
        categoryData.pagination = pagination.create(currentPage, pageCount, req.query);
        categoryData.pagination.rel.forEach((rel) => {
                rel.href = `${url}/category/${categoryData.slug}${rel.href}`;
                res.locals.linkTags.push(rel);
        });

        analytics.increment([`pageviews:byCid:${categoryData.cid}`]);

        // Render the category page
        res.render('category', categoryData);
};

async function buildBreadcrumbs(req, categoryData) {
        const breadcrumbs = [
                {
                        text: categoryData.name,
                        url: `${url}/category/${categoryData.slug}`,
                        cid: categoryData.cid,
                },
        ];
        const crumbs = await helpers.buildCategoryBreadcrumbs(categoryData.parentCid);
        if (req.originalUrl.startsWith(`${relative_path}/api/category`) || req.originalUrl.startsWith(`${relative_path}/category`)) {
                categoryData.breadcrumbs = crumbs.concat(breadcrumbs);
        }
}

function addTags(categoryData, res, currentPage) {
        res.locals.metaTags = [
                {
                        name: 'title',
                        content: categoryData.name,
                        noEscape: true,
                },
                {
                        property: 'og:title',
                        content: categoryData.name,
                        noEscape: true,
                },
                {
                        name: 'description',
                        content: categoryData.description,
                        noEscape: true,
                },
                {
                        property: 'og:type',
                        content: 'website',
                },
        ];

        if (categoryData.backgroundImage) {
                if (!categoryData.backgroundImage.startsWith('http')) {
                        categoryData.backgroundImage = url + categoryData.backgroundImage;
                }
                res.locals.metaTags.push({
                        property: 'og:image',
                        content: categoryData.backgroundImage,
                        noEscape: true,
                });
        }

        const page = currentPage > 1 ? `?page=${currentPage}` : '';
        res.locals.linkTags = [
                {
                        rel: 'up',
                        href: url,
                },
                {
                        rel: 'canonical',
                        href: `${url}/category/${categoryData.slug}${page}`,
                        noEscape: true,
                },
        ];

        if (!categoryData['feeds:disableRSS']) {
                res.locals.linkTags.push({
                        rel: 'alternate',
                        type: 'application/rss+xml',
                        href: categoryData.rssFeedUrl,
                });
        }
}

1	'use strict';
2
3	const nconf = require('nconf');	1✔
4	const validator = require('validator');	1✔
5	const qs = require('querystring');	1✔
6
7	const db = require('../database');	1✔
8	const privileges = require('../privileges');	1✔
9	const user = require('../user');	1✔
10	const categories = require('../categories');	1✔
11	const meta = require('../meta');	1✔
12	const pagination = require('../pagination');	1✔
13	const helpers = require('./helpers');	1✔
14	const utils = require('../utils');	1✔
15	const translator = require('../translator');	1✔
16	const analytics = require('../analytics');	1✔
17
18	const categoryController = module.exports;	1✔
19
20	const url = nconf.get('url');	1✔
21	const relative_path = nconf.get('relative_path');	1✔
22	const validSorts = [	1✔
23	'recently_replied', 'recently_created', 'most_posts', 'most_votes', 'most_views',
24	];
25
26
27	categoryController.get = async function (req, res, next) {	1✔
28	console.log('Abdulaziz');	30✔
29	const cid = req.params.category_id;	30✔
30
31	let currentPage = parseInt(req.query.page, 10) \|\| 1;	30✔
32	let topicIndex = utils.isNumber(req.params.topic_index) ? parseInt(req.params.topic_index, 10) - 1 : 0;	30✔
33	if ((req.params.topic_index && !utils.isNumber(req.params.topic_index)) \|\| !utils.isNumber(cid)) {	30✔
34	return next();	4✔
35	}
36
37	const [categoryFields, userPrivileges, tagData, userSettings, rssToken] = await Promise.all([	26✔
38	categories.getCategoryFields(cid, ['slug', 'disabled', 'link']),
39	privileges.categories.get(cid, req.uid),
40	helpers.getSelectedTag(req.query.tag),
41	user.getSettings(req.uid),
42	user.auth.getFeedToken(req.uid),
43	]);
44
45	// If the category doesn't exist or is disabled, return 404
46	if (!categoryFields \|\| categoryFields.disabled) {	26✔
47	return res.status(404).render('404', { url: req.url });	1✔
48	}
49
50	// Additional validation for missing slugs or invalid pagination
51	if (!categoryFields.slug \|\| (userSettings.usePagination && currentPage < 1)) {	25✔
52	return next();	1✔
53	}
54
55	// Redirect if the topicIndex is invalid
56	if (topicIndex < 0) {	24✔
57	return helpers.redirect(res, `/category/${categoryFields.slug}?${qs.stringify(req.query)}`);	1✔
58	}
59
60	// If user lacks privileges, deny access
61	if (!userPrivileges.read) {	23✔
62	return helpers.notAllowed(req, res);	1✔
63	}
64
65	// Handle slug mismatch and redirect
66	if (!res.locals.isAPI && !req.params.slug && (categoryFields.slug && categoryFields.slug !== `${cid}/`)) {	22✔
67	return helpers.redirect(res, `/category/${categoryFields.slug}?${qs.stringify(req.query)}`, true);	1✔
68	}
69
70	// If category is a link, increase click count and redirect
71	if (categoryFields.link) {	21✔
72	await db.incrObjectField(`category:${cid}`, 'timesClicked');	2✔
73	return helpers.redirect(res, validator.unescape(categoryFields.link));	2✔
74	}
75
76	// Handle pagination
77	if (!userSettings.usePagination) {	19✔
78	topicIndex = Math.max(0, topicIndex - (Math.ceil(userSettings.topicsPerPage / 2) - 1));	9✔
79	} else if (!req.query.page) {	10✔
80	const index = Math.max(parseInt((topicIndex \|\| 0), 10), 0);	9✔
81	currentPage = Math.ceil((index + 1) / userSettings.topicsPerPage);	9✔
82	topicIndex = 0;	9✔
83	}
84
85	// Fetch category data
86	const targetUid = await user.getUidByUserslug(req.query.author);	19✔
87	const start = ((currentPage - 1) * userSettings.topicsPerPage) + topicIndex;	19✔
88	const stop = start + userSettings.topicsPerPage - 1;	19✔
89
90	const sort = validSorts.includes(req.query.sort) ? req.query.sort : userSettings.categoryTopicSort;	19✔
91
92	const categoryData = await categories.getCategoryById({	19✔
93	uid: req.uid,
94	cid: cid,
95	start: start,
96	stop: stop,
97	sort: sort,
98	settings: userSettings,
99	query: req.query,
100	tag: req.query.tag,
101	targetUid: targetUid,
102	});
103
104	// If no category data found, return 404
105	if (!categoryData) {	19!
NEW 106	return res.status(404).render('404', { url: req.url });	×
107	}
108
109	// Ensure topic index is within bounds
110	const pageCount = Math.max(1, Math.ceil(categoryData.topic_count / userSettings.topicsPerPage));	19✔
111	if (userSettings.usePagination && currentPage > pageCount) {	19✔
112	return next();	1✔
113	}
114
115	// Apply privileges and filter tags
116	categories.modifyTopicsByPrivilege(categoryData.topics, userPrivileges);	18✔
117	categoryData.tagWhitelist = categories.filterTagWhitelist(categoryData.tagWhitelist, userPrivileges.isAdminOrMod);	18✔
118
119	// Process subcategories
120	const allCategories = [];	18✔
121	categories.flattenCategories(allCategories, categoryData.children);	18✔
122
123	await Promise.all([	18✔
124	buildBreadcrumbs(req, categoryData),
125	categories.setUnread([categoryData], allCategories.map(c => c.cid).concat(cid), req.uid),	1✔
126	]);
127
128	if (categoryData.children.length) {	18✔
129	await categories.getRecentTopicReplies(allCategories, req.uid, req.query);	1✔
130	categoryData.subCategoriesLeft = Math.max(0, categoryData.children.length - categoryData.subCategoriesPerPage);	1✔
131	categoryData.hasMoreSubCategories = categoryData.children.length > categoryData.subCategoriesPerPage;	1✔
132	categoryData.nextSubCategoryStart = categoryData.subCategoriesPerPage;	1✔
133	categoryData.children = categoryData.children.slice(0, categoryData.subCategoriesPerPage);	1✔
134	categoryData.children.forEach((child) => {	1✔
135	if (child) {	1!
136	helpers.trimChildren(child);	1✔
137	helpers.setCategoryTeaser(child);	1✔
138	}
139	});
140	}
141
142	// Prepare category data for rendering
143	categoryData.title = translator.escape(categoryData.name);	18✔
144	categoryData.selectCategoryLabel = '[[category:subcategories]]';	18✔
145	categoryData.description = translator.escape(categoryData.description);	18✔
146	categoryData.privileges = userPrivileges;	18✔
147	categoryData.showSelect = userPrivileges.editable;	18✔
148	categoryData.showTopicTools = userPrivileges.editable;	18✔
149	categoryData.topicIndex = topicIndex;	18✔
150	categoryData.selectedTag = tagData.selectedTag;	18✔
151	categoryData.selectedTags = tagData.selectedTags;	18✔
152	categoryData.sortOptionLabel = `[[topic:${validator.escape(String(sort)).replace(/_/g, '-')}]]`;	18✔
153
154	// Handle RSS feed
155	if (!meta.config['feeds:disableRSS']) {	18!
156	categoryData.rssFeedUrl = `${url}/category/${categoryData.cid}.rss`;	18✔
157	if (req.loggedIn) {	18✔
158	categoryData.rssFeedUrl += `?uid=${req.uid}&token=${rssToken}`;	11✔
159	}
160	}
161
162	// Add tags for SEO purposes
163	addTags(categoryData, res, currentPage);	18✔
164
165	categoryData['feeds:disableRSS'] = meta.config['feeds:disableRSS'] \|\| 0;	18✔
166	categoryData['reputation:disabled'] = meta.config['reputation:disabled'];	18✔
167	categoryData.pagination = pagination.create(currentPage, pageCount, req.query);	18✔
168	categoryData.pagination.rel.forEach((rel) => {	18✔
169	rel.href = `${url}/category/${categoryData.slug}${rel.href}`;	1✔
170	res.locals.linkTags.push(rel);	1✔
171	});
172
173	analytics.increment([`pageviews:byCid:${categoryData.cid}`]);	18✔
174
175	// Render the category page
176	res.render('category', categoryData);	18✔
177	};
178
179	async function buildBreadcrumbs(req, categoryData) {
180	const breadcrumbs = [	18✔
181	{
182	text: categoryData.name,
183	url: `${url}/category/${categoryData.slug}`,
184	cid: categoryData.cid,
185	},
186	];
187	const crumbs = await helpers.buildCategoryBreadcrumbs(categoryData.parentCid);	18✔
188	if (req.originalUrl.startsWith(`${relative_path}/api/category`) \|\| req.originalUrl.startsWith(`${relative_path}/category`)) {	18✔
189	categoryData.breadcrumbs = crumbs.concat(breadcrumbs);	16✔
190	}
191	}
192
193	function addTags(categoryData, res, currentPage) {
194	res.locals.metaTags = [	18✔
195	{
196	name: 'title',
197	content: categoryData.name,
198	noEscape: true,
199	},
200	{
201	property: 'og:title',
202	content: categoryData.name,
203	noEscape: true,
204	},
205	{
206	name: 'description',
207	content: categoryData.description,
208	noEscape: true,
209	},
210	{
211	property: 'og:type',
212	content: 'website',
213	},
214	];
215
216	if (categoryData.backgroundImage) {	18✔
217	if (!categoryData.backgroundImage.startsWith('http')) {	1!
218	categoryData.backgroundImage = url + categoryData.backgroundImage;	1✔
219	}
220	res.locals.metaTags.push({	1✔
221	property: 'og:image',
222	content: categoryData.backgroundImage,
223	noEscape: true,
224	});
225	}
226
227	const page = currentPage > 1 ? `?page=${currentPage}` : '';	18!
228	res.locals.linkTags = [	18✔
229	{
230	rel: 'up',
231	href: url,
232	},
233	{
234	rel: 'canonical',
235	href: `${url}/category/${categoryData.slug}${page}`,
236	noEscape: true,
237	},
238	];
239
240	if (!categoryData['feeds:disableRSS']) {	18!
241	res.locals.linkTags.push({	18✔
242	rel: 'alternate',
243	type: 'application/rss+xml',
244	href: categoryData.rssFeedUrl,
245	});
246	}
247	}

CMU-313 / NodeBB / 10709878166

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous