6408184662

Committed 04 Oct 2023 02:00PM UTC coverage: 84.767%. Remained the same

Build # 6408184662

Build Type

push

github

Committed by

web-flow

Commit Message

Merge branch 'main' into Adding-frontend-backend-isUrgent-connection

Signed-off-by: mbfannan <122257080+mbfannan@users.noreply.github.com>

Run Details

10239 of 13314 branches covered (0.0%)

Branch coverage included in aggregate %.

1 of 1 new or added line in 1 file covered. (100.0%)

15 existing lines in 2 files now uncovered.

22614 of 25443 relevant lines covered (88.88%)

3240.74 hits per line

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

88.46

/src/routes/index.js

'use strict';

const nconf = require('nconf');
const winston = require('winston');
const path = require('path');
const express = require('express');
const chalk = require('chalk');

const meta = require('../meta');
const controllers = require('../controllers');
const controllerHelpers = require('../controllers/helpers');
const plugins = require('../plugins');

const authRoutes = require('./authentication');
const writeRoutes = require('./write');
const helpers = require('./helpers');

const { setupPageRoute } = helpers;

const _mounts = {
    user: require('./user'),
    meta: require('./meta'),
    api: require('./api'),
    admin: require('./admin'),
    feed: require('./feeds'),
};

_mounts.main = (app, middleware, controllers) => {
    const loginRegisterMiddleware = [middleware.redirectToAccountIfLoggedIn];

    setupPageRoute(app, '/login', loginRegisterMiddleware, controllers.login);
    setupPageRoute(app, '/register', loginRegisterMiddleware, controllers.register);
    setupPageRoute(app, '/register/complete', [], controllers.registerInterstitial);
    setupPageRoute(app, '/compose', [], controllers.composer.get);
    setupPageRoute(app, '/confirm/:code', [], controllers.confirmEmail);
    setupPageRoute(app, '/outgoing', [], controllers.outgoing);
    setupPageRoute(app, '/search', [], controllers.search.search);
    setupPageRoute(app, '/reset/:code?', [middleware.delayLoading], controllers.reset);
    setupPageRoute(app, '/tos', [], controllers.termsOfUse);

    setupPageRoute(app, '/email/unsubscribe/:token', [], controllers.accounts.settings.unsubscribe);
    app.post('/email/unsubscribe/:token', controllers.accounts.settings.unsubscribePost);
};

_mounts.mod = (app, middleware, controllers) => {
    setupPageRoute(app, '/flags', [], controllers.mods.flags.list);
    setupPageRoute(app, '/flags/:flagId', [], controllers.mods.flags.detail);
    setupPageRoute(app, '/post-queue/:id?', [], controllers.mods.postQueue);
};

_mounts.globalMod = (app, middleware, controllers) => {
    setupPageRoute(app, '/ip-blacklist', [], controllers.globalMods.ipBlacklist);
    setupPageRoute(app, '/registration-queue', [], controllers.globalMods.registrationQueue);
};

_mounts.topic = (app, name, middleware, controllers) => {
    setupPageRoute(app, `/${name}/:topic_id/:slug/:post_index?`, [], controllers.topics.get);
    // a means to get the isPrivate attribute of a given topic
    // this is only for testing purposes
    setupPageRoute(app, `/${name}/:topic_id/:slug/:post_index?/isPrivate`, [], controllers.topics.getIsPrivate);
    // this is the addition of a post route to ensure isPrivate boolean is handeled correctly upon
    // state change by the user
    app.post(`/${name}/:topic_id/:slug/:post_index?/post/isPrivate`, controllers.topics.updateIsPrivate);
    setupPageRoute(app, `/${name}/:topic_id/:slug?`, [], controllers.topics.get);
    setupPageRoute(app, `/${name}/:topic_id/:slug/isResolved`, [], controllers.topics.setTopicAsResolved);
};

_mounts.post = (app, name, middleware, controllers) => {
    const middlewares = [
        middleware.maintenanceMode,
        middleware.authenticateRequest,
        middleware.registrationComplete,
        middleware.pluginHooks,
    ];
    app.get(`/${name}/:pid`, middleware.busyCheck, middlewares, controllers.posts.redirectToPost);
    app.get(`/api/${name}/:pid`, middlewares, controllers.posts.redirectToPost);
};

_mounts.tags = (app, name, middleware, controllers) => {
    setupPageRoute(app, `/${name}/:tag`, [middleware.privateTagListing], controllers.tags.getTag);
    setupPageRoute(app, `/${name}`, [middleware.privateTagListing], controllers.tags.getTags);
};

_mounts.category = (app, name, middleware, controllers) => {
    setupPageRoute(app, '/categories', [], controllers.categories.list);
    setupPageRoute(app, '/popular', [], controllers.popular.get);
    setupPageRoute(app, '/recent', [], controllers.recent.get);
    setupPageRoute(app, '/top', [], controllers.top.get);
    setupPageRoute(app, '/unread', [middleware.ensureLoggedIn], controllers.unread.get);

    setupPageRoute(app, `/${name}/:category_id/:slug/:topic_index`, [], controllers.category.get);
    setupPageRoute(app, `/${name}/:category_id/:slug?`, [], controllers.category.get);
};

_mounts.career = (app, name, middleware, controllers) => {
    const middlewares = [middleware.ensureLoggedIn];

    setupPageRoute(app, `/${name}`, middlewares, controllers.career.get);
};

_mounts.users = (app, name, middleware, controllers) => {
    const middlewares = [middleware.canViewUsers];

    setupPageRoute(app, `/${name}`, middlewares, controllers.users.index);
};

_mounts.groups = (app, name, middleware, controllers) => {
    const middlewares = [middleware.canViewGroups];

    setupPageRoute(app, `/${name}`, middlewares, controllers.groups.list);
    setupPageRoute(app, `/${name}/:slug`, middlewares, controllers.groups.details);
    setupPageRoute(app, `/${name}/:slug/members`, middlewares, controllers.groups.members);
};



module.exports = async function (app, middleware) {
    const router = express.Router();
    router.render = function (...args) {
        app.render(...args);
    };

    // Allow plugins/themes to mount some routes elsewhere
    const remountable = ['admin', 'category', 'topic', 'post', 'users', 'user', 'groups', 'tags', 'career'];
    const { mounts } = await plugins.hooks.fire('filter:router.add', {
        mounts: remountable.reduce((memo, mount) => {
            memo[mount] = mount;
            return memo;
        }, {}),
    });
    // Guard against plugins sending back missing/extra mounts
    Object.keys(mounts).forEach((mount) => {
        if (!remountable.includes(mount)) {
            delete mounts[mount];
        } else if (typeof mount !== 'string') {
            mounts[mount] = mount;
        }
    });
    remountable.forEach((mount) => {
        if (!mounts.hasOwnProperty(mount)) {
            mounts[mount] = mount;
        }
    });

    router.all('(/+api|/+api/*?)', middleware.prepareAPI);
    router.all(`(/+api/admin|/+api/admin/*?${mounts.admin !== 'admin' ? `|/+api/${mounts.admin}|/+api/${mounts.admin}/*?` : ''})`, middleware.authenticateRequest, middleware.ensureLoggedIn, middleware.admin.checkPrivileges);
    router.all(`(/+admin|/+admin/*?${mounts.admin !== 'admin' ? `|/+${mounts.admin}|/+${mounts.admin}/*?` : ''})`, middleware.ensureLoggedIn, middleware.applyCSRF, middleware.admin.checkPrivileges);

    app.use(middleware.stripLeadingSlashes);

    // handle custom homepage routes
    router.use('/', controllers.home.rewrite);

    // homepage handled by `action:homepage.get:[route]`
    setupPageRoute(router, '/', [], controllers.home.pluginHook);

    await plugins.reloadRoutes({ router: router });
    await authRoutes.reloadRoutes({ router: router });
    await writeRoutes.reload({ router: router });
    addCoreRoutes(app, router, middleware, mounts);

    winston.info('[router] Routes added');
};

function addCoreRoutes(app, router, middleware, mounts) {
    _mounts.meta(router, middleware, controllers);
    _mounts.api(router, middleware, controllers);
    _mounts.feed(router, middleware, controllers);

    _mounts.main(router, middleware, controllers);
    _mounts.mod(router, middleware, controllers);
    _mounts.globalMod(router, middleware, controllers);

    addRemountableRoutes(app, router, middleware, mounts);

    const relativePath = nconf.get('relative_path');
    app.use(relativePath || '/', router);

    if (process.env.NODE_ENV === 'development') {
        require('./debug')(app, middleware, controllers);
    }

    app.use(middleware.privateUploads);

    const statics = [
        { route: '/assets', path: path.join(__dirname, '../../build/public') },
        { route: '/assets', path: path.join(__dirname, '../../public') },
    ];
    const staticOptions = {
        maxAge: app.enabled('cache') ? 5184000000 : 0,
    };

    if (path.resolve(__dirname, '../../public/uploads') !== nconf.get('upload_path')) {
        statics.unshift({ route: '/assets/uploads', path: nconf.get('upload_path') });
    }

    statics.forEach((obj) => {
        app.use(relativePath + obj.route, middleware.addUploadHeaders, express.static(obj.path, staticOptions));
    });
    app.use(`${relativePath}/uploads`, (req, res) => {
        res.redirect(`${relativePath}/assets/uploads${req.path}?${meta.config['cache-buster']}`);
    });
    app.use(`${relativePath}/plugins`, (req, res) => {
        winston.warn(`${chalk.bold.red('[deprecation]')} The \`/plugins\` shorthand prefix is deprecated, prefix with \`/assets/plugins\` instead (path: ${req.path})`);
        res.redirect(`${relativePath}/assets/plugins${req.path}${req._parsedUrl.search || ''}`);
    });

    // Skins
    meta.css.supportedSkins.forEach((skin) => {
        app.use(`${relativePath}/assets/client-${skin}.css`, middleware.buildSkinAsset);
    });

    app.use(controllers['404'].handle404);
    app.use(controllers.errors.handleURIErrors);
    app.use(controllers.errors.handleErrors);
}

function addRemountableRoutes(app, router, middleware, mounts) {
    Object.keys(mounts).map(async (mount) => {
        const original = mount;
        mount = mounts[original];

        if (!mount) { // do not mount at all
            winston.warn(`[router] Not mounting /${original}`);
            return;
        }

        if (mount !== original) {
            // Set up redirect for fallback handling (some js/tpls may still refer to the traditional mount point)
            winston.info(`[router] /${original} prefix re-mounted to /${mount}. Requests to /${original}/* will now redirect to /${mount}`);
            router.use(new RegExp(`/(api/)?${original}`), (req, res) => {
                controllerHelpers.redirect(res, `${nconf.get('relative_path')}/${mount}${req.path}`);
            });
        }

        _mounts[original](router, mount, middleware, controllers);
    });
}
// added code

1	'use strict';
2
3	const nconf = require('nconf');	4✔
4	const winston = require('winston');	4✔
5	const path = require('path');	4✔
6	const express = require('express');	4✔
7	const chalk = require('chalk');	4✔
8
9	const meta = require('../meta');	4✔
10	const controllers = require('../controllers');	4✔
11	const controllerHelpers = require('../controllers/helpers');	4✔
12	const plugins = require('../plugins');	4✔
13
14	const authRoutes = require('./authentication');	4✔
15	const writeRoutes = require('./write');	4✔
16	const helpers = require('./helpers');	4✔
17
18	const { setupPageRoute } = helpers;	4✔
19
20	const _mounts = {	4✔
21	user: require('./user'),
22	meta: require('./meta'),
23	api: require('./api'),
24	admin: require('./admin'),
25	feed: require('./feeds'),
26	};
27
28	_mounts.main = (app, middleware, controllers) => {	4✔
29	const loginRegisterMiddleware = [middleware.redirectToAccountIfLoggedIn];	4✔
30
31	setupPageRoute(app, '/login', loginRegisterMiddleware, controllers.login);	4✔
32	setupPageRoute(app, '/register', loginRegisterMiddleware, controllers.register);	4✔
33	setupPageRoute(app, '/register/complete', [], controllers.registerInterstitial);	4✔
34	setupPageRoute(app, '/compose', [], controllers.composer.get);	4✔
35	setupPageRoute(app, '/confirm/:code', [], controllers.confirmEmail);	4✔
36	setupPageRoute(app, '/outgoing', [], controllers.outgoing);	4✔
37	setupPageRoute(app, '/search', [], controllers.search.search);	4✔
38	setupPageRoute(app, '/reset/:code?', [middleware.delayLoading], controllers.reset);	4✔
39	setupPageRoute(app, '/tos', [], controllers.termsOfUse);	4✔
40
41	setupPageRoute(app, '/email/unsubscribe/:token', [], controllers.accounts.settings.unsubscribe);	4✔
42	app.post('/email/unsubscribe/:token', controllers.accounts.settings.unsubscribePost);	4✔
43	};
44
45	_mounts.mod = (app, middleware, controllers) => {	4✔
46	setupPageRoute(app, '/flags', [], controllers.mods.flags.list);	4✔
47	setupPageRoute(app, '/flags/:flagId', [], controllers.mods.flags.detail);	4✔
48	setupPageRoute(app, '/post-queue/:id?', [], controllers.mods.postQueue);	4✔
49	};
50
51	_mounts.globalMod = (app, middleware, controllers) => {	4✔
52	setupPageRoute(app, '/ip-blacklist', [], controllers.globalMods.ipBlacklist);	4✔
53	setupPageRoute(app, '/registration-queue', [], controllers.globalMods.registrationQueue);	4✔
54	};
55
56	_mounts.topic = (app, name, middleware, controllers) => {	4✔
57	setupPageRoute(app, `/${name}/:topic_id/:slug/:post_index?`, [], controllers.topics.get);	4✔
58	// a means to get the isPrivate attribute of a given topic
59	// this is only for testing purposes
60	setupPageRoute(app, `/${name}/:topic_id/:slug/:post_index?/isPrivate`, [], controllers.topics.getIsPrivate);	4✔
61	// this is the addition of a post route to ensure isPrivate boolean is handeled correctly upon
62	// state change by the user
63	app.post(`/${name}/:topic_id/:slug/:post_index?/post/isPrivate`, controllers.topics.updateIsPrivate);	4✔
64	setupPageRoute(app, `/${name}/:topic_id/:slug?`, [], controllers.topics.get);	4✔
65	setupPageRoute(app, `/${name}/:topic_id/:slug/isResolved`, [], controllers.topics.setTopicAsResolved);	4✔
66	};
67
68	_mounts.post = (app, name, middleware, controllers) => {	4✔
69	const middlewares = [	4✔
70	middleware.maintenanceMode,
71	middleware.authenticateRequest,
72	middleware.registrationComplete,
73	middleware.pluginHooks,
74	];
75	app.get(`/${name}/:pid`, middleware.busyCheck, middlewares, controllers.posts.redirectToPost);	4✔
76	app.get(`/api/${name}/:pid`, middlewares, controllers.posts.redirectToPost);	4✔
77	};
78
79	_mounts.tags = (app, name, middleware, controllers) => {	4✔
80	setupPageRoute(app, `/${name}/:tag`, [middleware.privateTagListing], controllers.tags.getTag);	4✔
81	setupPageRoute(app, `/${name}`, [middleware.privateTagListing], controllers.tags.getTags);	4✔
82	};
83
84	_mounts.category = (app, name, middleware, controllers) => {	4✔
85	setupPageRoute(app, '/categories', [], controllers.categories.list);	4✔
86	setupPageRoute(app, '/popular', [], controllers.popular.get);	4✔
87	setupPageRoute(app, '/recent', [], controllers.recent.get);	4✔
88	setupPageRoute(app, '/top', [], controllers.top.get);	4✔
89	setupPageRoute(app, '/unread', [middleware.ensureLoggedIn], controllers.unread.get);	4✔
90
91	setupPageRoute(app, `/${name}/:category_id/:slug/:topic_index`, [], controllers.category.get);	4✔
92	setupPageRoute(app, `/${name}/:category_id/:slug?`, [], controllers.category.get);	4✔
93	};
94
95	_mounts.career = (app, name, middleware, controllers) => {	4✔
96	const middlewares = [middleware.ensureLoggedIn];	4✔
97
98	setupPageRoute(app, `/${name}`, middlewares, controllers.career.get);	4✔
99	};
100
101	_mounts.users = (app, name, middleware, controllers) => {	4✔
102	const middlewares = [middleware.canViewUsers];	4✔
103
104	setupPageRoute(app, `/${name}`, middlewares, controllers.users.index);	4✔
105	};
106
107	_mounts.groups = (app, name, middleware, controllers) => {	4✔
108	const middlewares = [middleware.canViewGroups];	4✔
109
110	setupPageRoute(app, `/${name}`, middlewares, controllers.groups.list);	4✔
111	setupPageRoute(app, `/${name}/:slug`, middlewares, controllers.groups.details);	4✔
112	setupPageRoute(app, `/${name}/:slug/members`, middlewares, controllers.groups.members);	4✔
113	};
114
115
116
117	module.exports = async function (app, middleware) {	4✔
118	const router = express.Router();	4✔
119	router.render = function (...args) {	4✔
UNCOV 120	app.render(...args);	×
121	};
122
123	// Allow plugins/themes to mount some routes elsewhere
124	const remountable = ['admin', 'category', 'topic', 'post', 'users', 'user', 'groups', 'tags', 'career'];	4✔
125	const { mounts } = await plugins.hooks.fire('filter:router.add', {	4✔
126	mounts: remountable.reduce((memo, mount) => {
127	memo[mount] = mount;	36✔
128	return memo;	36✔
129	}, {}),
130	});
131	// Guard against plugins sending back missing/extra mounts
132	Object.keys(mounts).forEach((mount) => {	4✔
133	if (!remountable.includes(mount)) {	36!
UNCOV 134	delete mounts[mount];	×
135	} else if (typeof mount !== 'string') {	36!
UNCOV 136	mounts[mount] = mount;	×
137	}
138	});
139	remountable.forEach((mount) => {	4✔
140	if (!mounts.hasOwnProperty(mount)) {	36!
UNCOV 141	mounts[mount] = mount;	×
142	}
143	});
144
145	router.all('(/+api\|/+api/*?)', middleware.prepareAPI);	4✔
146	router.all(`(/+api/admin\|/+api/admin/?${mounts.admin !== 'admin' ? `\|/+api/${mounts.admin}\|/+api/${mounts.admin}/?` : ''})`, middleware.authenticateRequest, middleware.ensureLoggedIn, middleware.admin.checkPrivileges);	4!
147	router.all(`(/+admin\|/+admin/?${mounts.admin !== 'admin' ? `\|/+${mounts.admin}\|/+${mounts.admin}/?` : ''})`, middleware.ensureLoggedIn, middleware.applyCSRF, middleware.admin.checkPrivileges);	4!
148
149	app.use(middleware.stripLeadingSlashes);	4✔
150
151	// handle custom homepage routes
152	router.use('/', controllers.home.rewrite);	4✔
153
154	// homepage handled by `action:homepage.get:[route]`
155	setupPageRoute(router, '/', [], controllers.home.pluginHook);	4✔
156
157	await plugins.reloadRoutes({ router: router });	4✔
158	await authRoutes.reloadRoutes({ router: router });	4✔
159	await writeRoutes.reload({ router: router });	4✔
160	addCoreRoutes(app, router, middleware, mounts);	4✔
161
162	winston.info('[router] Routes added');	4✔
163	};
164
165	function addCoreRoutes(app, router, middleware, mounts) {
166	_mounts.meta(router, middleware, controllers);	4✔
167	_mounts.api(router, middleware, controllers);	4✔
168	_mounts.feed(router, middleware, controllers);	4✔
169
170	_mounts.main(router, middleware, controllers);	4✔
171	_mounts.mod(router, middleware, controllers);	4✔
172	_mounts.globalMod(router, middleware, controllers);	4✔
173
174	addRemountableRoutes(app, router, middleware, mounts);	4✔
175
176	const relativePath = nconf.get('relative_path');	4✔
177	app.use(relativePath \|\| '/', router);	4✔
178
179	if (process.env.NODE_ENV === 'development') {	4✔
180	require('./debug')(app, middleware, controllers);	1✔
181	}
182
183	app.use(middleware.privateUploads);	4✔
184
185	const statics = [	4✔
186	{ route: '/assets', path: path.join(__dirname, '../../build/public') },
187	{ route: '/assets', path: path.join(__dirname, '../../public') },
188	];
189	const staticOptions = {	4✔
190	maxAge: app.enabled('cache') ? 5184000000 : 0,	4✔
191	};
192
193	if (path.resolve(__dirname, '../../public/uploads') !== nconf.get('upload_path')) {	4!
194	statics.unshift({ route: '/assets/uploads', path: nconf.get('upload_path') });	4✔
195	}
196
197	statics.forEach((obj) => {	4✔
198	app.use(relativePath + obj.route, middleware.addUploadHeaders, express.static(obj.path, staticOptions));	12✔
199	});
200	app.use(`${relativePath}/uploads`, (req, res) => {	4✔
UNCOV 201	res.redirect(`${relativePath}/assets/uploads${req.path}?${meta.config['cache-buster']}`);	×
202	});
203	app.use(`${relativePath}/plugins`, (req, res) => {	4✔
204	winston.warn(`${chalk.bold.red('[deprecation]')} The \`/plugins\` shorthand prefix is deprecated, prefix with \`/assets/plugins\` instead (path: ${req.path})`);	8✔
205	res.redirect(`${relativePath}/assets/plugins${req.path}${req._parsedUrl.search \|\| ''}`);	8✔
206	});
207
208	// Skins
209	meta.css.supportedSkins.forEach((skin) => {	4✔
210	app.use(`${relativePath}/assets/client-${skin}.css`, middleware.buildSkinAsset);	64✔
211	});
212
213	app.use(controllers['404'].handle404);	4✔
214	app.use(controllers.errors.handleURIErrors);	4✔
215	app.use(controllers.errors.handleErrors);	4✔
216	}
217
218	function addRemountableRoutes(app, router, middleware, mounts) {
219	Object.keys(mounts).map(async (mount) => {	4✔
220	const original = mount;	36✔
221	mount = mounts[original];	36✔
222
223	if (!mount) { // do not mount at all	36!
UNCOV 224	winston.warn(`[router] Not mounting /${original}`);	×
225	return;	×
226	}
227
228	if (mount !== original) {	36!
229	// Set up redirect for fallback handling (some js/tpls may still refer to the traditional mount point)
UNCOV 230	winston.info(`[router] /${original} prefix re-mounted to /${mount}. Requests to /${original}/* will now redirect to /${mount}`);	×
231	router.use(new RegExp(`/(api/)?${original}`), (req, res) => {	×
232	controllerHelpers.redirect(res, `${nconf.get('relative_path')}/${mount}${req.path}`);	×
233	});
234	}
235
236	_mounts[original](router, mount, middleware, controllers);	36✔
237	});
238	}
239	// added code

CMU-17313Q / fall23-nodebb-inshallah-a / 6408184662

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