refactor(bootstrap): move build and lifecycle setup to separate files

refactor(settingsService): add clear distinction between model types

Author: ComfortablyCoding

server/bootstrap.js

@@ -0,0 +1,17 @@
+const { getPluginService } = require('../utils/getPluginService');
+const buildSettings = async () => {
+	const settingsService = getPluginService('settingsService');
+	const settings = await settingsService.get();
+
+	// build settings structure
+	const normalizedSettings = settingsService.build(settings);
+
+	// reset plugin settings
+	await settingsService.set(normalizedSettings);
+
+	return normalizedSettings;
+};
+
+module.exports = {
+	buildSettings,
+};

server/bootstrap/buildSettings.js

@@ -0,0 +1,9 @@
+'use strict';
+
+const { buildSettings } = require('./buildSettings');
+const { setupLifecycles } = require('./setupLifecycles');
+
+module.exports = async ({ strapi }) => {
+	const settings = await buildSettings(strapi);
+	setupLifecycles(settings);
+};

server/bootstrap/index.js

@@ -0,0 +1,18 @@
+const _ = require('lodash');
+const { getPluginService } = require('../utils/getPluginService');
+const setupLifecycles = (settings) => {
+	// set up lifecycles
+	const subscribe = {
+		models: _.map(settings.modelsByUID, (model) => model.uid),
+	};
+
+	['beforeCreate', 'afterCreate', 'beforeUpdate'].forEach((lifecycle) => {
+		subscribe[lifecycle] = (ctx) => getPluginService('slugService').slugify(ctx);
+	});
+
+	strapi.db.lifecycles.subscribe(subscribe);
+};
+
+module.exports = {
+	setupLifecycles,
+};

server/bootstrap/setupLifecycles.js

@@ -10,17 +10,17 @@ const { hasRequiredModelScopes } = require('../utils/hasRequiredModelScopes');
 
 module.exports = ({ strapi }) => ({
 	async findSlug(ctx) {
-		const { models } = getPluginService('settingsService').get();
+		const { modelsByName } = getPluginService('settingsService').get();
 		const { modelName, slug } = ctx.request.params;
 		const { auth } = ctx.state;
 
 		isValidFindSlugParams({
 			modelName,
 			slug,
-			models,
+			modelsByName,
 		});
 
-		const { uid, field, contentType } = models[modelName];
+		const { uid, field, contentType } = modelsByName[modelName];
 
 		await hasRequiredModelScopes(strapi, uid, auth);
 

server/controllers/slug-controller.js

@@ -7,16 +7,16 @@ const { sanitizeOutput } = require('../utils/sanitizeOutput');
 const getCustomTypes = (strapi, nexus) => {
 	const { naming } = getPluginService('utils', 'graphql');
 	const { toEntityResponse } = getPluginService('format', 'graphql').returnTypes;
-	const { models } = getPluginService('settingsService').get();
+	const { modelsByUID } = getPluginService('settingsService').get();
 	const { getEntityResponseName } = naming;
 
 	// get all types required for findSlug query
 	let findSlugTypes = {
 		response: [],
 	};
-	_.forEach(strapi.contentTypes, (value, key) => {
-		if (models[key]) {
-			findSlugTypes.response.push(getEntityResponseName(value));
+	_.forEach(strapi.contentTypes, (contentType, uid) => {
+		if (modelsByUID[uid]) {
+			findSlugTypes.response.push(getEntityResponseName(contentType));
 		}
 	});
 
@@ -33,7 +33,7 @@ const getCustomTypes = (strapi, nexus) => {
 			t.members(...findSlugTypes.response);
 		},
 		resolveType: (ctx) => {
-			return getEntityResponseName(models[ctx.info.resourceUID].contentType);
+			return getEntityResponseName(modelsByUID[ctx.info.resourceUID].contentType);
 		},
 	});
 
@@ -50,18 +50,18 @@ const getCustomTypes = (strapi, nexus) => {
 						publicationState: nexus.stringArg('The publication state of the entry'),
 					},
 					resolve: async (_parent, args, ctx) => {
-						const { models } = getPluginService('settingsService').get();
+						const { modelsByName } = getPluginService('settingsService').get();
 						const { modelName, slug, publicationState } = args;
 						const { auth } = ctx.state;
 
 						isValidFindSlugParams({
 							modelName,
 							slug,
-							models,
+							modelsByName,
 							publicationState,
 						});
 
-						const { uid, field, contentType } = models[modelName];
+						const { uid, field, contentType } = modelsByName[modelName];
 
 						await hasRequiredModelScopes(strapi, uid, auth);
 

server/graphql/types.js

@@ -13,7 +13,8 @@ module.exports = ({ strapi }) => ({
 	},
 	build(settings) {
 		// build models
-		settings.models = {};
+		settings.modelsByUID = {};
+		settings.modelsByName = {};
 		_.each(strapi.contentTypes, (contentType, uid) => {
 			const model = settings.contentTypes[contentType.modelName];
 			if (!model) {
@@ -30,7 +31,9 @@ module.exports = ({ strapi }) => ({
 			}
 
 			let references = _.isArray(model.references) ? model.references : [model.references];
-			const hasReferences = references.every((r) => isValidModelField(contentType, r));
+			const hasReferences = references.every((referenceField) =>
+				isValidModelField(contentType, referenceField)
+			);
 			if (!hasReferences) {
 				strapi.log.warn(
 					`[slugify] skipping ${contentType.info.singularName} registration, invalid reference field provided.`
@@ -44,8 +47,8 @@ module.exports = ({ strapi }) => ({
 				contentType,
 				references,
 			};
-			settings.models[uid] = data;
-			settings.models[contentType.modelName] = data;
+			settings.modelsByUID[uid] = data;
+			settings.modelsByName[contentType.modelName] = data;
 		});
 
 		_.omit(settings, ['contentTypes']);

server/services/settings-service.js

@@ -6,8 +6,8 @@ const isValidFindSlugParams = (params) => {
 		throw new ValidationError('A model and slug must be provided.');
 	}
 
-	const { modelName, slug, models, publicationState } = params;
-	const model = models[modelName];
+	const { modelName, slug, modelsByName, publicationState } = params;
+	const model = modelsByName[modelName];
 
 	if (!modelName) {
 		throw new ValidationError('A model name path variable is required.');