feat: added PUT /api/v1/categories/:cid route

Deprecated admin.categories.update socket call
Showing stack trace in console for errors, when in development mode

public/src/admin/manage/categories.js

@@ -195,18 +195,18 @@ define('admin/manage/categories', [
 	};
 
 	Categories.toggle = function (cids, disabled) {
-		var payload = {};
+		var requests = cids.map(function (cid) {
-
+			return $.ajax({
-		cids.forEach(function (cid) {
+				url: config.relative_path + '/api/v1/categories/' + cid,
-			payload[cid] = {
+				method: 'put',
-				disabled: disabled ? 1 : 0,
+				data: {
-			};
+					disabled: disabled ? 1 : 0,
+				},
+			});
 		});
 
-		socket.emit('admin.categories.update', payload, function (err) {
+		$.when(requests).fail(function (ev) {
-			if (err) {
+			app.alertError(ev.responseJSON.status.message);
-				return app.alertError(err.message);
-			}
 		});
 	};
 
@@ -236,7 +236,14 @@ define('admin/manage/categories', [
 			}
 
 			newCategoryId = -1;
-			socket.emit('admin.categories.update', modified);
+
+			Object.keys(modified).forEach(function (cid) {
+				$.ajax({
+					url: config.relative_path + '/api/v1/categories/' + cid,
+					method: 'put',
+					data: modified[cid],
+				});
+			});
 		}
 	}
 

public/src/admin/manage/category.js

@@ -8,7 +8,7 @@ define('admin/manage/category', [
 	'benchpress',
 ], function (uploader, iconSelect, colorpicker, categorySelector, Benchpress) {
 	var	Category = {};
-	var modified_categories = {};
+	var updateHash = {};
 
 	Category.init = function () {
 		$('#category-settings select').each(function () {
@@ -53,24 +53,24 @@ define('admin/manage/category', [
 				return app.alertError('[[admin/manage/categories:alert.not-enough-whitelisted-tags]]');
 			}
 
-			if (Object.keys(modified_categories).length) {
+			var cid = ajaxify.data.category.cid;
-				socket.emit('admin.categories.update', modified_categories, function (err, result) {
+			$.ajax({
-					if (err) {
+				url: config.relative_path + '/api/v1/categories/' + cid,
-						return app.alertError(err.message);
+				method: 'put',
-					}
+				data: updateHash,
-
+			}).done(function (res) {
-					if (result && result.length) {
+				app.flags._unsaved = false;
-						app.flags._unsaved = false;
+				app.alert({
-						app.alert({
+					title: 'Updated Categories',
-							title: 'Updated Categories',
+					message: 'Category "' + res.response.name + '" was successfully updated.',
-							message: 'Category IDs ' + result.join(', ') + ' was successfully updated.',
+					type: 'success',
-							type: 'success',
+					timeout: 2000,
-							timeout: 2000,
-						});
-					}
 				});
-				modified_categories = {};
+				updateHash = {};
-			}
+			}).fail(function (ev) {
+				app.alertError(ev.responseJSON.status.message);
+			});
+
 			return false;
 		});
 
@@ -224,55 +224,51 @@ define('admin/manage/category', [
 
 		$('button[data-action="setParent"], button[data-action="changeParent"]').on('click', Category.launchParentSelector);
 		$('button[data-action="removeParent"]').on('click', function () {
-			var payload = {};
+			$.ajax({
-			payload[ajaxify.data.category.cid] = {
+				url: config.relative_path + '/api/v1/categories/' + ajaxify.data.category.cid,
-				parentCid: 0,
+				method: 'put',
-			};
+				data: {
-
+					parentCid: 0,
-			socket.emit('admin.categories.update', payload, function (err) {
+				},
-				if (err) {
+			}).done(function () {
-					return app.alertError(err.message);
-				}
 				$('button[data-action="removeParent"]').parent().addClass('hide');
 				$('button[data-action="changeParent"]').parent().addClass('hide');
 				$('button[data-action="setParent"]').removeClass('hide');
+			}).fail(function (ev) {
+				app.alertError(ev.responseJSON.status.message);
 			});
 		});
 		$('button[data-action="toggle"]').on('click', function () {
-			var payload = {};
 			var $this = $(this);
 			var disabled = $this.attr('data-disabled') === '1';
-			payload[ajaxify.data.category.cid] = {
+			$.ajax({
-				disabled: disabled ? 0 : 1,
+				url: config.relative_path + '/api/v1/categories/' + ajaxify.data.category.cid,
-			};
+				method: 'put',
-			socket.emit('admin.categories.update', payload, function (err) {
+				data: {
-				if (err) {
+					disabled: disabled ? 0 : 1,
-					return app.alertError(err.message);
+				},
-				}
+			}).done(function () {
 				$this.translateText(!disabled ? '[[admin/manage/categories:enable]]' : '[[admin/manage/categories:disable]]');
 				$this.toggleClass('btn-primary', !disabled).toggleClass('btn-danger', disabled);
 				$this.attr('data-disabled', disabled ? 0 : 1);
+			}).fail(function (ev) {
+				app.alertError(ev.responseJSON.status.message);
 			});
 		});
 	};
 
 	function modified(el) {
-		var cid = ajaxify.data.category.cid;
+		var value;
-
+		if ($(el).is(':checkbox')) {
-		if (cid) {
+			value = $(el).is(':checked') ? 1 : 0;
-			var value;
+		} else {
-			if ($(el).is(':checkbox')) {
+			value = $(el).val();
-				value = $(el).is(':checked') ? 1 : 0;
+		}
-			} else {
-				value = $(el).val();
-			}
 
-			modified_categories[cid] = modified_categories[cid] || {};
+		updateHash[$(el).attr('data-name')] = value;
-			modified_categories[cid][$(el).attr('data-name')] = value;
 
-			app.flags = app.flags || {};
+		app.flags = app.flags || {};
-			app.flags._unsaved = true;
+		app.flags._unsaved = true;
-		}
 	}
 
 	function handleTags() {
@@ -306,16 +302,13 @@ define('admin/manage/category', [
 			});
 
 			categorySelector.modal(categories, function (parentCid) {
-				var payload = {};
+				$.ajax({
-
+					url: config.relative_path + '/api/v1/categories/' + ajaxify.data.category.cid,
-				payload[ajaxify.data.category.cid] = {
+					method: 'put',
-					parentCid: parentCid,
+					data: {
-				};
+						parentCid: parentCid,
-
+					},
-				socket.emit('admin.categories.update', payload, function (err) {
+				}).done(function () {
-					if (err) {
-						return app.alertError(err.message);
-					}
 					var parent = allCategories.filter(function (category) {
 						return category && parseInt(category.cid, 10) === parseInt(parentCid, 10);
 					});
@@ -325,6 +318,8 @@ define('admin/manage/category', [
 					$('button[data-action="setParent"]').addClass('hide');
 					var buttonHtml = '<i class="fa ' + parent.icon + '"></i> ' + parent.name;
 					$('button[data-action="changeParent"]').html(buttonHtml).parent().removeClass('hide');
+				}).fail(function (ev) {
+					app.alertError(ev.responseJSON.status.message);
 				});
 			});
 		});

src/controllers/helpers.js

@@ -357,7 +357,11 @@ helpers.formatApiResponse = async (statusCode, res, payload) => {
 		}
 
 		const returnPayload = helpers.generateError(statusCode, message);
-		returnPayload.stack = payload.stack;
+
+		if (global.env === 'development') {
+			returnPayload.stack = payload.stack;
+			process.stdout.write(payload.stack);
+		}
 		res.status(statusCode).json(returnPayload);
 	} else if (!payload) {
 		// Non-2xx statusCode, generate predefined error

src/controllers/write/categories.js

@@ -11,3 +11,12 @@ Categories.create = async (req, res) => {
 	const categoryObjs = await categories.getCategories([response.cid]);
 	helpers.formatApiResponse(200, res, categoryObjs[0]);
 };
+
+Categories.update = async (req, res) => {
+	const payload = {};
+	payload[req.params.cid] = req.body;
+
+	await categories.update(payload);
+	const categoryObjs = await categories.getCategories([req.params.cid]);
+	helpers.formatApiResponse(200, res, categoryObjs[0]);
+};

src/routes/write/categories.js

@@ -3,7 +3,7 @@
 const router = require('express').Router();
 const middleware = require('../../middleware');
 const controllers = require('../../controllers');
-const routeHelpers = require('../../routes/helpers');
+const routeHelpers = require('../helpers');
 
 const setupApiRoute = routeHelpers.setupApiRoute;
 
@@ -11,26 +11,9 @@ module.exports = function () {
 	const middlewares = [middleware.authenticate];
 
 	setupApiRoute(router, '/', middleware, [...middlewares, middleware.checkRequired.bind(null, ['name'])], 'post', controllers.write.categories.create);
-
+	setupApiRoute(router, '/:cid', middleware, [...middlewares], 'put', controllers.write.categories.update);
-	// app.post('/', apiMiddleware.requireUser, apiMiddleware.requireAdmin, function(req, res) {
-	// 	if (!utils.checkRequired(['name'], req, res)) {
-	// 		return false;
-	// 	}
-
-	// 	Categories.create(req.body, function(err, categoryObj) {
-	// 		return errorHandler.handle(err, res, categoryObj);
-	// 	});
-	// });
 
 	// app.route('/:cid')
-	// 	.put(apiMiddleware.requireUser, apiMiddleware.requireAdmin, apiMiddleware.validateCid, function(req, res) {
-	// 		var payload = {};
-	// 		payload[req.params.cid] = req.body;
-
-	// 		Categories.update(payload, function(err) {
-	// 			return errorHandler.handle(err, res);
-	// 		});
-	// 	})
 	// 	.delete(apiMiddleware.requireUser, apiMiddleware.requireAdmin, apiMiddleware.validateCid, function(req, res) {
 	// 		Categories.purge(req.params.cid, req.user.uid, function(err) {
 	// 			return errorHandler.handle(err, res);

src/socket.io/admin/categories.js

@@ -52,6 +52,8 @@ Categories.purge = async function (socket, cid) {
 };
 
 Categories.update = async function (socket, data) {
+	sockets.warnDeprecated(socket, 'PUT /api/v1/categories/:cid');
+
 	if (!data) {
 		throw new Error('[[error:invalid-data]]');
 	}