strapi-plugin-config-sync/server/services/main.js

284 lines
9.5 KiB
JavaScript
Raw Normal View History

'use strict';
const fs = require('fs');
const util = require('util');
const types = require('../config/types');
2021-03-27 17:14:56 +01:00
const difference = require('../utils/getObjectDiff');
/**
* Main services for config import/export.
*/
2021-10-14 16:37:32 +02:00
module.exports = () => ({
/**
* Write a single config file.
*
* @param {string} configType - The type of the config.
* @param {string} configName - The name of the config file.
* @param {string} fileContents - The JSON content of the config file.
* @returns {void}
*/
writeConfigFile: async (configType, configName, fileContents) => {
// Check if the config should be excluded.
2021-10-14 16:37:32 +02:00
const shouldExclude = strapi.config.get('plugin.config-sync.exclude').includes(`${configType}.${configName}`);
if (shouldExclude) return;
2021-11-21 21:16:42 +01:00
// Replace ':' with '#' in filenames for Windows support.
configName = configName.replace(/:/g, "#");
// Check if the JSON content should be minified.
2021-10-14 16:37:32 +02:00
const json = !strapi.config.get('plugin.config-sync').minify
2021-10-14 14:37:00 +02:00
? JSON.stringify(fileContents, null, 2)
: JSON.stringify(fileContents);
2021-10-14 17:33:21 +02:00
if (!fs.existsSync(strapi.config.get('plugin.config-sync.destination'))) {
fs.mkdirSync(strapi.config.get('plugin.config-sync.destination'), { recursive: true });
}
const writeFile = util.promisify(fs.writeFile);
2021-10-14 17:33:21 +02:00
await writeFile(`${strapi.config.get('plugin.config-sync.destination')}${configType}.${configName}.json`, json)
.then(() => {
// @TODO:
// Add logging for successfull config export.
})
.catch(() => {
// @TODO:
// Add logging for failed config export.
});
},
2021-03-27 18:20:51 +01:00
/**
* Delete config file.
*
* @param {string} configName - The name of the config file.
* @returns {void}
*/
deleteConfigFile: async (configName) => {
// Check if the config should be excluded.
2021-10-14 16:37:32 +02:00
const shouldExclude = strapi.config.get('plugin.config-sync.exclude').includes(`${configName}`);
2021-03-27 18:20:51 +01:00
if (shouldExclude) return;
2021-11-21 21:16:42 +01:00
// Replace ':' with '#' in filenames for Windows support.
configName = configName.replace(/:/g, "#");
2021-10-14 17:33:21 +02:00
fs.unlinkSync(`${strapi.config.get('plugin.config-sync.destination')}${configName}.json`);
2021-03-27 18:20:51 +01:00
},
/**
* Read from a config file.
*
* @param {string} configType - The type of config.
* @param {string} configName - The name of the config file.
* @returns {object} The JSON content of the config file.
*/
readConfigFile: async (configType, configName) => {
2021-11-21 21:16:42 +01:00
// Replace ':' with '#' in filenames for Windows support.
configName = configName.replace(/:/g, "#");
const readFile = util.promisify(fs.readFile);
2021-10-14 17:33:21 +02:00
return readFile(`${strapi.config.get('plugin.config-sync.destination')}${configType}.${configName}.json`)
.then((data) => {
return JSON.parse(data);
})
.catch(() => {
return null;
});
},
2021-03-24 18:37:14 +01:00
/**
* Get all the config JSON from the filesystem.
*
2021-10-14 14:37:00 +02:00
* @param {string} configType - Type of config to gather. Leave empty to get all config.
2021-03-24 18:37:14 +01:00
* @returns {object} Object with key value pairs of configs.
*/
2021-03-27 18:20:51 +01:00
getAllConfigFromFiles: async (configType = null) => {
2021-10-14 17:33:21 +02:00
if (!fs.existsSync(strapi.config.get('plugin.config-sync.destination'))) {
return {};
}
2021-10-14 17:33:21 +02:00
const configFiles = fs.readdirSync(strapi.config.get('plugin.config-sync.destination'));
2021-03-24 18:37:14 +01:00
const getConfigs = async () => {
2021-10-14 14:37:00 +02:00
const fileConfigs = {};
2021-03-24 18:37:14 +01:00
await Promise.all(configFiles.map(async (file) => {
2021-10-15 14:54:58 +02:00
const type = file.split('.')[0]; // Grab the first part of the filename.
const name = file.split(/\.(.+)/)[1].split('.').slice(0, -1).join('.'); // Grab the rest of the filename minus the file extension.
2021-03-27 18:20:51 +01:00
2021-11-21 21:16:42 +01:00
// Replace ':' with '#' in filenames for Windows support.
const formattedName = name.replace(/#/g, ":");
if (
2021-10-14 14:37:00 +02:00
configType && configType !== type
2021-10-14 16:37:32 +02:00
|| !strapi.config.get('plugin.config-sync.include').includes(type)
|| !types(strapi)[type]
2021-10-14 16:37:32 +02:00
|| strapi.config.get('plugin.config-sync.exclude').includes(`${type}.${name}`)
) {
2021-03-27 18:20:51 +01:00
return;
}
2021-10-14 16:37:32 +02:00
const fileContents = await strapi.plugin('config-sync').service('main').readConfigFile(type, name);
2021-11-21 21:16:42 +01:00
fileConfigs[`${type}.${formattedName}`] = fileContents;
2021-03-24 18:37:14 +01:00
}));
return fileConfigs;
};
2021-10-14 14:37:00 +02:00
return getConfigs();
2021-03-24 18:37:14 +01:00
},
/**
* Get all the config JSON from the database.
*
2021-10-14 14:37:00 +02:00
* @param {string} configType - Type of config to gather. Leave empty to get all config.
2021-03-24 18:37:14 +01:00
* @returns {object} Object with key value pairs of configs.
*/
getAllConfigFromDatabase: async (configType = null) => {
const getConfigs = async () => {
let databaseConfigs = {};
2021-10-14 14:37:00 +02:00
2021-10-14 16:37:32 +02:00
await Promise.all(strapi.config.get('plugin.config-sync.include').map(async (type) => {
if (configType && configType !== type || !types(strapi)[type]) {
2021-03-24 18:37:14 +01:00
return;
}
const config = await types(strapi)[type].getAllFromDatabase();
2021-03-24 18:37:14 +01:00
databaseConfigs = Object.assign(config, databaseConfigs);
}));
return databaseConfigs;
2021-10-14 14:37:00 +02:00
};
2021-03-24 18:37:14 +01:00
2021-10-14 14:37:00 +02:00
return getConfigs();
2021-03-24 18:37:14 +01:00
},
/**
* Import all config files into the db.
*
2021-10-14 14:37:00 +02:00
* @param {string} configType - Type of config to impor. Leave empty to import all config.
2021-11-10 16:22:52 +01:00
* @param {object} onSuccess - Success callback to run on each single successfull import.
* @returns {void}
*/
2021-11-10 16:22:52 +01:00
importAllConfig: async (configType = null, onSuccess) => {
2021-10-14 16:37:32 +02:00
const fileConfig = await strapi.plugin('config-sync').service('main').getAllConfigFromFiles();
const databaseConfig = await strapi.plugin('config-sync').service('main').getAllConfigFromDatabase();
2021-03-27 17:14:56 +01:00
const diff = difference(databaseConfig, fileConfig);
await Promise.all(Object.keys(diff).map(async (file) => {
const type = file.split('.')[0]; // Grab the first part of the filename.
2021-03-27 17:14:56 +01:00
const name = file.split(/\.(.+)/)[1]; // Grab the rest of the filename minus the file extension.
if (configType && configType !== type) {
return;
}
2021-11-18 22:45:20 +01:00
await strapi.plugin('config-sync').service('main').importSingleConfig(`${type}.${name}`, onSuccess);
}));
},
/**
* Export all config files.
*
2021-10-14 14:37:00 +02:00
* @param {string} configType - Type of config to export. Leave empty to export all config.
2021-11-20 14:28:17 +01:00
* @param {object} onSuccess - Success callback to run on each single successfull import.
* @returns {void}
*/
2021-11-20 14:28:17 +01:00
exportAllConfig: async (configType = null, onSuccess) => {
const fileConfig = await strapi.plugin('config-sync').service('main').getAllConfigFromFiles();
const databaseConfig = await strapi.plugin('config-sync').service('main').getAllConfigFromDatabase();
const diff = difference(databaseConfig, fileConfig);
await Promise.all(Object.keys(diff).map(async (file) => {
const type = file.split('.')[0]; // Grab the first part of the filename.
const name = file.split(/\.(.+)/)[1]; // Grab the rest of the filename minus the file extension.
if (configType && configType !== type) {
return;
}
2021-11-20 14:28:17 +01:00
await strapi.plugin('config-sync').service('main').exportSingleConfig(`${type}.${name}`, onSuccess);
}));
},
/**
* Import a single config file into the db.
*
* @param {string} configName - The name of the config file.
2021-11-18 22:45:20 +01:00
* @param {object} onSuccess - Success callback to run on each single successfull import.
* @returns {void}
*/
2021-11-18 22:45:20 +01:00
importSingleConfig: async (configName, onSuccess) => {
// Check if the config should be excluded.
2021-11-18 22:45:20 +01:00
const shouldExclude = strapi.config.get('plugin.config-sync.exclude').includes(configName);
if (shouldExclude) return;
2021-11-18 22:45:20 +01:00
const [type, name] = configName.split('.'); // Split the configName.
const fileContents = await strapi.plugin('config-sync').service('main').readConfigFile(type, name);
2021-11-18 22:45:20 +01:00
try {
await types(strapi)[type].importSingle(name, fileContents);
2021-11-18 22:45:20 +01:00
if (onSuccess) {
onSuccess(`${type}.${name}`);
}
} catch (e) {
throw new Error(e);
}
},
/**
* Export a single config file.
*
* @param {string} configName - The name of the config file.
2021-11-20 14:28:17 +01:00
* @param {object} onSuccess - Success callback to run on each single successfull import.
* @returns {void}
*/
2021-11-20 14:28:17 +01:00
exportSingleConfig: async (configName, onSuccess) => {
// Check if the config should be excluded.
const shouldExclude = strapi.config.get('plugin.config-sync.exclude').includes(configName);
if (shouldExclude) return;
const [type, name] = configName.split('.'); // Split the configName.
2021-10-14 14:37:00 +02:00
2021-11-20 14:28:17 +01:00
try {
await types(strapi)[type].exportSingle(configName);
2021-11-20 14:28:17 +01:00
if (onSuccess) {
onSuccess(`${type}.${name}`);
}
} catch (e) {
throw new Error(e);
}
},
2021-11-10 16:22:52 +01:00
/**
* Get the formatted diff.
*
* @param {string} configType - Type of config to get the diff of. Leave empty to get the diff of all config.
*
* @returns {object} - the formatted diff.
*/
getFormattedDiff: async (configType = null) => {
const formattedDiff = {
fileConfig: {},
databaseConfig: {},
diff: {},
};
const fileConfig = await strapi.plugin('config-sync').service('main').getAllConfigFromFiles(configType);
const databaseConfig = await strapi.plugin('config-sync').service('main').getAllConfigFromDatabase(configType);
const diff = difference(databaseConfig, fileConfig);
formattedDiff.diff = diff;
Object.keys(diff).map((changedConfigName) => {
formattedDiff.fileConfig[changedConfigName] = fileConfig[changedConfigName];
formattedDiff.databaseConfig[changedConfigName] = databaseConfig[changedConfigName];
});
return formattedDiff;
},
2021-10-14 16:37:32 +02:00
});