10658778914

Committed 02 Sep 2024 12:43AM UTC coverage: 82.673% (+0.002%) from 82.671%

Build # 10658778914

Build Type

Pull #353

github

Committed by

web-flow

Commit Message

Merge afcc95f14 into e7cfda55c

Pull Request Pull Request #353: Refactored code in src/notifications.js to reduce its Cognitive Complexity

Run Details

9965 of 13474 branches covered (73.96%)

Branch coverage included in aggregate %.

3 of 5 new or added lines in 2 files covered. (60.0%)

6 existing lines in 1 file now uncovered.

22323 of 25581 relevant lines covered (87.26%)

1632.86 hits per line

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

81.58

/src/meta/tags.js

'use strict';

const nconf = require('nconf');
const winston = require('winston');

const plugins = require('../plugins');
const Meta = require('./index');
const utils = require('../utils');

const Tags = module.exports;

const url = nconf.get('url');
const relative_path = nconf.get('relative_path');
const upload_url = nconf.get('upload_url');

Tags.parse = async (req, data, meta, link) => {
        const isAPI = req.res && req.res.locals && req.res.locals.isAPI;

        // Meta tags
        const defaultTags = isAPI ? [] : [{
                name: 'viewport',
                content: 'width=device-width, initial-scale=1.0',
        }, {
                name: 'content-type',
                content: 'text/html; charset=UTF-8',
                noEscape: true,
        }, {
                name: 'apple-mobile-web-app-capable',
                content: 'yes',
        }, {
                name: 'mobile-web-app-capable',
                content: 'yes',
        }, {
                property: 'og:site_name',
                content: Meta.config.title || 'NodeBB',
        }, {
                name: 'msapplication-badge',
                content: `frequency=30; polling-uri=${url}/sitemap.xml`,
                noEscape: true,
        }, {
                name: 'theme-color',
                content: Meta.config.themeColor || '#ffffff',
        }];

        if (Meta.config.keywords && !isAPI) {
                defaultTags.push({
                        name: 'keywords',
                        content: Meta.config.keywords,
                });
        }

        if (Meta.config['brand:logo'] && !isAPI) {
                defaultTags.push({
                        name: 'msapplication-square150x150logo',
                        content: Meta.config['brand:logo'],
                        noEscape: true,
                });
        }

        const faviconPath = `${relative_path}/assets/uploads/system/favicon.ico`;
        const cacheBuster = `${Meta.config['cache-buster'] ? `?${Meta.config['cache-buster']}` : ''}`;

        // Link Tags
        const defaultLinks = isAPI ? [] : [{
                rel: 'icon',
                type: 'image/x-icon',
                href: `${faviconPath}${cacheBuster}`,
        }, {
                rel: 'manifest',
                href: `${relative_path}/manifest.webmanifest`,
                crossorigin: `use-credentials`,
        }];

        if (plugins.hooks.hasListeners('filter:search.query') && !isAPI) {
                defaultLinks.push({
                        rel: 'search',
                        type: 'application/opensearchdescription+xml',
                        title: utils.escapeHTML(String(Meta.config.title || Meta.config.browserTitle || 'NodeBB')),
                        href: `${relative_path}/osd.xml`,
                });
        }

        if (!isAPI) {
                addTouchIcons(defaultLinks);
        }

        const results = await utils.promiseParallel({
                tags: plugins.hooks.fire('filter:meta.getMetaTags', { req: req, data: data, tags: defaultTags }),
                links: plugins.hooks.fire('filter:meta.getLinkTags', { req: req, data: data, links: defaultLinks }),
        });

        meta = results.tags.tags.concat(meta || []).map((tag) => {
                if (!tag || typeof tag.content !== 'string') {
                        winston.warn('Invalid meta tag. ', tag);
                        return tag;
                }

                if (!tag.noEscape) {
                        const attributes = Object.keys(tag);
                        attributes.forEach((attr) => {
                                tag[attr] = utils.escapeHTML(String(tag[attr]));
                        });
                }

                return tag;
        });

        await addSiteOGImage(meta);

        addIfNotExists(meta, 'property', 'og:title', Meta.config.title || 'NodeBB');
        const ogUrl = url + (req.originalUrl !== '/' ? stripRelativePath(req.originalUrl) : '');
        addIfNotExists(meta, 'property', 'og:url', ogUrl);
        addIfNotExists(meta, 'name', 'description', Meta.config.description);
        addIfNotExists(meta, 'property', 'og:description', Meta.config.description);

        link = results.links.links.concat(link || []);
        if (isAPI) {
                const whitelist = ['canonical', 'alternate', 'up'];
                link = link.filter(link => whitelist.some(val => val === link.rel));
        }
        link = link.map((tag) => {
                if (!tag.noEscape) {
                        const attributes = Object.keys(tag);
                        attributes.forEach((attr) => {
                                tag[attr] = utils.escapeHTML(String(tag[attr]));
                        });
                }

                return tag;
        });

        return { meta, link };
};

function addTouchIcons(defaultLinks) {
        if (Meta.config['brand:touchIcon']) {
                defaultLinks.push({
                        rel: 'apple-touch-icon',
                        href: `${relative_path + upload_url}/system/touchicon-orig.png`,
                }, {
                        rel: 'icon',
                        sizes: '36x36',
                        href: `${relative_path + upload_url}/system/touchicon-36.png`,
                }, {
                        rel: 'icon',
                        sizes: '48x48',
                        href: `${relative_path + upload_url}/system/touchicon-48.png`,
                }, {
                        rel: 'icon',
                        sizes: '72x72',
                        href: `${relative_path + upload_url}/system/touchicon-72.png`,
                }, {
                        rel: 'icon',
                        sizes: '96x96',
                        href: `${relative_path + upload_url}/system/touchicon-96.png`,
                }, {
                        rel: 'icon',
                        sizes: '144x144',
                        href: `${relative_path + upload_url}/system/touchicon-144.png`,
                }, {
                        rel: 'icon',
                        sizes: '192x192',
                        href: `${relative_path + upload_url}/system/touchicon-192.png`,
                });
        } else {
                defaultLinks.push({
                        rel: 'apple-touch-icon',
                        href: `${relative_path}/assets/images/touch/512.png`,
                }, {
                        rel: 'icon',
                        sizes: '36x36',
                        href: `${relative_path}/assets/images/touch/36.png`,
                }, {
                        rel: 'icon',
                        sizes: '48x48',
                        href: `${relative_path}/assets/images/touch/48.png`,
                }, {
                        rel: 'icon',
                        sizes: '72x72',
                        href: `${relative_path}/assets/images/touch/72.png`,
                }, {
                        rel: 'icon',
                        sizes: '96x96',
                        href: `${relative_path}/assets/images/touch/96.png`,
                }, {
                        rel: 'icon',
                        sizes: '144x144',
                        href: `${relative_path}/assets/images/touch/144.png`,
                }, {
                        rel: 'icon',
                        sizes: '192x192',
                        href: `${relative_path}/assets/images/touch/192.png`,
                }, {
                        rel: 'icon',
                        sizes: '512x512',
                        href: `${relative_path}/assets/images/touch/512.png`,
                });
        }
}

function addIfNotExists(meta, keyName, tagName, value) {
        const exists = meta.some(tag => tag[keyName] === tagName);

        if (!exists && value) {
                meta.push({
                        content: utils.escapeHTML(String(value)),
                        [keyName]: tagName,
                });
        }
}

function stripRelativePath(url) {
        if (url.startsWith(relative_path)) {
                return url.slice(relative_path.length);
        }

        return url;
}

async function addSiteOGImage(meta) {
        const key = Meta.config['og:image'] ? 'og:image' : 'brand:logo';
        let ogImage = stripRelativePath(Meta.config[key] || '');
        if (ogImage && !ogImage.startsWith('http')) {
                ogImage = url + ogImage;
        }

        const { images } = await plugins.hooks.fire('filter:meta.addSiteOGImage', {
                images: [{
                        url: ogImage || `${url}/assets/images/logo@3x.png`,
                        width: ogImage ? Meta.config[`${key}:width`] : 963,
                        height: ogImage ? Meta.config[`${key}:height`] : 225,
                }],
        });

        const properties = ['url', 'secure_url', 'type', 'width', 'height', 'alt'];
        images.forEach((image) => {
                for (const property of properties) {
                        if (image.hasOwnProperty(property)) {
                                switch (property) {
                                        case 'url': {
                                                meta.push({
                                                        property: 'og:image',
                                                        content: image.url,
                                                        noEscape: true,
                                                }, {
                                                        property: 'og:image:url',
                                                        content: image.url,
                                                        noEscape: true,
                                                });
                                                break;
                                        }

                                        case 'secure_url': {
                                                meta.push({
                                                        property: `og:${property}`,
                                                        content: image[property],
                                                        noEscape: true,
                                                });
                                                break;
                                        }

                                        case 'type':
                                        case 'alt':
                                        case 'width':
                                        case 'height': {
                                                meta.push({
                                                        property: `og:image:${property}`,
                                                        content: String(image[property]),
                                                });
                                        }
                                }
                        }
                }
        });
}

1	'use strict';
2
3	const nconf = require('nconf');	8✔
4	const winston = require('winston');	8✔
5
6	const plugins = require('../plugins');	8✔
7	const Meta = require('./index');	8✔
8	const utils = require('../utils');	8✔
9
10	const Tags = module.exports;	8✔
11
12	const url = nconf.get('url');	8✔
13	const relative_path = nconf.get('relative_path');	8✔
14	const upload_url = nconf.get('upload_url');	8✔
15
16	Tags.parse = async (req, data, meta, link) => {	8✔
17	const isAPI = req.res && req.res.locals && req.res.locals.isAPI;	331✔
18
19	// Meta tags
20	const defaultTags = isAPI ? [] : [{	331✔
21	name: 'viewport',
22	content: 'width=device-width, initial-scale=1.0',
23	}, {
24	name: 'content-type',
25	content: 'text/html; charset=UTF-8',
26	noEscape: true,
27	}, {
28	name: 'apple-mobile-web-app-capable',
29	content: 'yes',
30	}, {
31	name: 'mobile-web-app-capable',
32	content: 'yes',
33	}, {
34	property: 'og:site_name',
35	content: Meta.config.title \|\| 'NodeBB',	77!
36	}, {
37	name: 'msapplication-badge',
38	content: `frequency=30; polling-uri=${url}/sitemap.xml`,
39	noEscape: true,
40	}, {
41	name: 'theme-color',
42	content: Meta.config.themeColor \|\| '#ffffff',	154✔
43	}];
44
45	if (Meta.config.keywords && !isAPI) {	331!
NEW 46	defaultTags.push({	×
47	name: 'keywords',
48	content: Meta.config.keywords,
49	});
50	}
51
52	if (Meta.config['brand:logo'] && !isAPI) {	331!
NEW 53	defaultTags.push({	×
54	name: 'msapplication-square150x150logo',
55	content: Meta.config['brand:logo'],
56	noEscape: true,
57	});
58	}
59
60	const faviconPath = `${relative_path}/assets/uploads/system/favicon.ico`;	331✔
61	const cacheBuster = `${Meta.config['cache-buster'] ? `?${Meta.config['cache-buster']}` : ''}`;	331!
62
63	// Link Tags
64	const defaultLinks = isAPI ? [] : [{	331✔
65	rel: 'icon',
66	type: 'image/x-icon',
67	href: `${faviconPath}${cacheBuster}`,
68	}, {
69	rel: 'manifest',
70	href: `${relative_path}/manifest.webmanifest`,
71	crossorigin: `use-credentials`,
72	}];
73
74	if (plugins.hooks.hasListeners('filter:search.query') && !isAPI) {	331✔
75	defaultLinks.push({	77✔
76	rel: 'search',
77	type: 'application/opensearchdescription+xml',
78	title: utils.escapeHTML(String(Meta.config.title \|\| Meta.config.browserTitle \|\| 'NodeBB')),	77!
79	href: `${relative_path}/osd.xml`,
80	});
81	}
82
83	if (!isAPI) {	331✔
84	addTouchIcons(defaultLinks);	77✔
85	}
86
87	const results = await utils.promiseParallel({	331✔
88	tags: plugins.hooks.fire('filter:meta.getMetaTags', { req: req, data: data, tags: defaultTags }),
89	links: plugins.hooks.fire('filter:meta.getLinkTags', { req: req, data: data, links: defaultLinks }),
90	});
91
92	meta = results.tags.tags.concat(meta \|\| []).map((tag) => {	331✔
93	if (!tag \|\| typeof tag.content !== 'string') {	930!
UNCOV 94	winston.warn('Invalid meta tag. ', tag);	×
UNCOV 95	return tag;	×
96	}
97
98	if (!tag.noEscape) {	930✔
99	const attributes = Object.keys(tag);	627✔
100	attributes.forEach((attr) => {	627✔
101	tag[attr] = utils.escapeHTML(String(tag[attr]));	1,254✔
102	});
103	}
104
105	return tag;	930✔
106	});
107
108	await addSiteOGImage(meta);	331✔
109
110	addIfNotExists(meta, 'property', 'og:title', Meta.config.title \|\| 'NodeBB');	331!
111	const ogUrl = url + (req.originalUrl !== '/' ? stripRelativePath(req.originalUrl) : '');	331!
112	addIfNotExists(meta, 'property', 'og:url', ogUrl);	331✔
113	addIfNotExists(meta, 'name', 'description', Meta.config.description);	331✔
114	addIfNotExists(meta, 'property', 'og:description', Meta.config.description);	331✔
115
116	link = results.links.links.concat(link \|\| []);	331✔
117	if (isAPI) {	331✔
118	const whitelist = ['canonical', 'alternate', 'up'];	254✔
119	link = link.filter(link => whitelist.some(val => val === link.rel));	8,846✔
120	}
121	link = link.map((tag) => {	331✔
122	if (!tag.noEscape) {	1,820✔
123	const attributes = Object.keys(tag);	1,789✔
124	attributes.forEach((attr) => {	1,789✔
125	tag[attr] = utils.escapeHTML(String(tag[attr]));	4,462✔
126	});
127	}
128
129	return tag;	1,820✔
130	});
131
132	return { meta, link };	331✔
133	};
134
135	function addTouchIcons(defaultLinks) {
136	if (Meta.config['brand:touchIcon']) {	77!
UNCOV 137	defaultLinks.push({	×
138	rel: 'apple-touch-icon',
139	href: `${relative_path + upload_url}/system/touchicon-orig.png`,
140	}, {
141	rel: 'icon',
142	sizes: '36x36',
143	href: `${relative_path + upload_url}/system/touchicon-36.png`,
144	}, {
145	rel: 'icon',
146	sizes: '48x48',
147	href: `${relative_path + upload_url}/system/touchicon-48.png`,
148	}, {
149	rel: 'icon',
150	sizes: '72x72',
151	href: `${relative_path + upload_url}/system/touchicon-72.png`,
152	}, {
153	rel: 'icon',
154	sizes: '96x96',
155	href: `${relative_path + upload_url}/system/touchicon-96.png`,
156	}, {
157	rel: 'icon',
158	sizes: '144x144',
159	href: `${relative_path + upload_url}/system/touchicon-144.png`,
160	}, {
161	rel: 'icon',
162	sizes: '192x192',
163	href: `${relative_path + upload_url}/system/touchicon-192.png`,
164	});
165	} else {
166	defaultLinks.push({	77✔
167	rel: 'apple-touch-icon',
168	href: `${relative_path}/assets/images/touch/512.png`,
169	}, {
170	rel: 'icon',
171	sizes: '36x36',
172	href: `${relative_path}/assets/images/touch/36.png`,
173	}, {
174	rel: 'icon',
175	sizes: '48x48',
176	href: `${relative_path}/assets/images/touch/48.png`,
177	}, {
178	rel: 'icon',
179	sizes: '72x72',
180	href: `${relative_path}/assets/images/touch/72.png`,
181	}, {
182	rel: 'icon',
183	sizes: '96x96',
184	href: `${relative_path}/assets/images/touch/96.png`,
185	}, {
186	rel: 'icon',
187	sizes: '144x144',
188	href: `${relative_path}/assets/images/touch/144.png`,
189	}, {
190	rel: 'icon',
191	sizes: '192x192',
192	href: `${relative_path}/assets/images/touch/192.png`,
193	}, {
194	rel: 'icon',
195	sizes: '512x512',
196	href: `${relative_path}/assets/images/touch/512.png`,
197	});
198	}
199	}
200
201	function addIfNotExists(meta, keyName, tagName, value) {
202	const exists = meta.some(tag => tag[keyName] === tagName);	9,208✔
203
204	if (!exists && value) {	1,324✔
205	meta.push({	582✔
206	content: utils.escapeHTML(String(value)),
207	[keyName]: tagName,
208	});
209	}
210	}
211
212	function stripRelativePath(url) {
213	if (url.startsWith(relative_path)) {	662✔
214	return url.slice(relative_path.length);	331✔
215	}
216
217	return url;	331✔
218	}
219
220	async function addSiteOGImage(meta) {
221	const key = Meta.config['og:image'] ? 'og:image' : 'brand:logo';	331!
222	let ogImage = stripRelativePath(Meta.config[key] \|\| '');	331✔
223	if (ogImage && !ogImage.startsWith('http')) {	331!
UNCOV 224	ogImage = url + ogImage;	×
225	}
226
227	const { images } = await plugins.hooks.fire('filter:meta.addSiteOGImage', {	331✔
228	images: [{
229	url: ogImage \|\| `${url}/assets/images/logo@3x.png`,	662✔
230	width: ogImage ? Meta.config[`${key}:width`] : 963,	331!
231	height: ogImage ? Meta.config[`${key}:height`] : 225,	331!
232	}],
233	});
234
235	const properties = ['url', 'secure_url', 'type', 'width', 'height', 'alt'];	331✔
236	images.forEach((image) => {	331✔
237	for (const property of properties) {	331✔
238	if (image.hasOwnProperty(property)) {	1,986✔
239	switch (property) {	993!
240	case 'url': {
241	meta.push({	331✔
242	property: 'og:image',
243	content: image.url,
244	noEscape: true,
245	}, {
246	property: 'og:image:url',
247	content: image.url,
248	noEscape: true,
249	});
250	break;	331✔
251	}
252
253	case 'secure_url': {
UNCOV 254	meta.push({	×
255	property: `og:${property}`,
256	content: image[property],
257	noEscape: true,
258	});
UNCOV 259	break;	×
260	}
261
262	case 'type':
263	case 'alt':
264	case 'width':
265	case 'height': {
266	meta.push({	662✔
267	property: `og:image:${property}`,
268	content: String(image[property]),
269	});
270	}
271	}
272	}
273	}
274	});
275	}

CMU-313 / NodeBB / 10658778914

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