fix(slugification): do not update slug once generated (#68)

Attempting to update the slug on updates was causing issues with `slugifyWithCount` increasing the number when it should not. Once a slug is generated it should never be auto updated as it can cause unintended side effects.

Author: selected-pixel-jameson

README.md

@@ -71,6 +71,7 @@ Per [#35](https://github.com/ComfortablyCoding/strapi-plugin-slugify/issues/35)
 | contentTypes[modelName]field | The name of the field to add the slug  | String | N/A | Yes |
 | contentTypes[modelName]references | The name(s) of the field(s) used to build the slug. If an array of fields is set it will result in a compound slug | String or Array | N/A | Yes |
 | slugifyWithCount | Duplicate strings will have their occurrence appended to the end of the slug | Boolean | false | No |
+| shouldUpdateSlug | Allow the slug to be updated after initial generation. | Boolean | false | No |
 | skipUndefinedReferences | Skip reference fields that have no data. Mostly applicable to compound slug | Boolean | false | No |
 | slugifyOptions | The options to pass the the slugify function. All options can be found in the [slugify docs](https://github.com/sindresorhus/slugify#api) | Object | {} | No |
 

server/bootstrap.js

@@ -20,8 +20,8 @@ module.exports = ({ strapi }) => {
 	};
 
 	SUPPORTED_LIFECYCLES.forEach((lifecycle) => {
-		subscribe[lifecycle] = (ctx) => {
-			getPluginService(strapi, 'slugService').slugify(ctx);
+		subscribe[lifecycle] = async (ctx) => {
+			await getPluginService(strapi, 'slugService').slugify(ctx);
 		};
 	});
 

server/config/index.js

@@ -8,6 +8,7 @@ module.exports = {
 			contentTypes: {},
 			slugifyOptions: {},
 			slugifyWithCount: false,
+			shouldUpdateSlug: false,
 			skipUndefinedReferences: false,
 		};
 	},

server/config/schema.js

@@ -18,6 +18,7 @@ const pluginConfigSchema = yup.object().shape({
 		return yup.object().shape(shape);
 	}),
 	slugifyWithCount: yup.bool(),
+	shouldUpdateSlug: yup.bool(),
 	skipUndefinedReferences: yup.bool(),
 });
 

server/services/slug-service.js

@@ -5,13 +5,25 @@ const { getPluginService } = require('../utils/getPluginService');
 const { toSlug, toSlugWithCount } = require('../utils/slugification');
 
 module.exports = ({ strapi }) => ({
-	slugify(ctx) {
+	async slugify(ctx) {
+
+		const { params, model: entityModel } = ctx;
+
+		// Check to see if we have an existing reference and if it matches.
+		let current = null;
+		if (params.where && params.where.id) {
+			current = await strapi.entityService.findOne(entityModel.uid, params.where.id)
+		}
+		this.update(ctx, current)
+	},
+
+	update(ctx, current) {
+
 		const settings = getPluginService(strapi, 'settingsService').get();
 		const { params, model: entityModel } = ctx;
 		const { data } = params;
 
 		const model = settings.models[entityModel.uid];
-
 		if (!data) {
 			return;
 		}
@@ -23,18 +35,35 @@ module.exports = ({ strapi }) => ({
 			.filter((r) => typeof data[r] !== 'undefined' && data[r].length)
 			.map((r) => data[r]);
 
-		const hasUndefinedFields = referenceFieldValues.length < references.length;
-		if ((!settings.skipUndefinedReferences && hasUndefinedFields) || !referenceFieldValues.length) {
-			return;
+
+		let shouldUpdate = true
+		if (current) {
+			let currentReferenceFieldValues = references
+				.filter((r) => typeof current[r] !== 'undefined' && current[r].length)
+				.map((r) => current[r]);
+
+			if (JSON.stringify(referenceFieldValues) == JSON.stringify(currentReferenceFieldValues)) {
+				shouldUpdate = false
+			}
 		}
 
-		referenceFieldValues = referenceFieldValues.join(' ');
-		if (settings.slugifyWithCount) {
-			data[field] = toSlugWithCount(referenceFieldValues, settings.slugifyOptions);
-			return;
+		// Reference the updateSlugs settings to determine if user wants slugs to be updated.
+		// If there isn't a current reference then proceed.
+		if ((shouldUpdate && settings.shouldUpdateSlug) || !current || !data[field]) {
+			const hasUndefinedFields = referenceFieldValues.length < references.length;
+			if ((!settings.skipUndefinedReferences && hasUndefinedFields) || !referenceFieldValues.length) {
+				return;
+			}
+
+			referenceFieldValues = referenceFieldValues.join(' ');
+			if (settings.slugifyWithCount) {
+				data[field] = toSlugWithCount(referenceFieldValues, settings.slugifyOptions);
+				return
+			}
+
+			data[field] = toSlug(referenceFieldValues, settings.slugifyOptions);
 		}
 
-		data[field] = toSlug(referenceFieldValues, settings.slugifyOptions);
 	},
 
 	async findOne(uid, query) {