feat: added option to download zip

pull/94/head
Alexander Engel 2023-06-15 16:33:56 -07:00
parent 6312517dba
commit 761024cc74
6 changed files with 93 additions and 13 deletions

View File

@ -7,7 +7,7 @@ import { Map } from 'immutable';
import { useNotification } from '@strapi/helper-plugin';
import ConfirmModal from '../ConfirmModal';
import { exportAllConfig, importAllConfig } from '../../state/actions/Config';
import { downloadZip, exportAllConfig, importAllConfig } from '../../state/actions/Config';
const ActionButtons = () => {
const dispatch = useDispatch();
@ -30,6 +30,7 @@ const ActionButtons = () => {
<ActionButtonsStyling>
<Button disabled={isEmpty(partialDiff)} onClick={() => openModal('import')}>Import</Button>
<Button disabled={isEmpty(partialDiff)} onClick={() => openModal('export')}>Export</Button>
<Button onClick={() => dispatch(downloadZip(toggleNotification))}>Download Config</Button>
{!isEmpty(partialDiff) && (
<h4 style={{ display: 'inline' }}>{Object.keys(partialDiff).length} {Object.keys(partialDiff).length === 1 ? "config change" : "config changes"}</h4>
)}

View File

@ -55,6 +55,25 @@ export function exportAllConfig(partialDiff, toggleNotification) {
};
}
export function downloadZip(toggleNotification) {
return async function (dispatch) {
dispatch(setLoadingState(true));
try {
const { message, url } = await request('/config-sync/zip', {
method: 'GET'
});
toggleNotification({ type: 'success', message });
if (url) {
window.location = url;
}
dispatch(setLoadingState(false));
} catch (err) {
toggleNotification({ type: 'warning', message: { id: 'notification.error' } });
dispatch(setLoadingState(false));
}
};
}
export function importAllConfig(partialDiff, force, toggleNotification) {
return async function (dispatch) {
dispatch(setLoadingState(true));

View File

@ -186,6 +186,17 @@ const ConfigType = class ConfigType {
}
}
/**
* Zip config files
*
* @param {string} configName - The name of the zip archive.
* @returns {void}
*/
zipConfig = async () => {
return strapi.plugin('config-sync').service('main').zipConfigFiles();
}
/**
* Get all role-permissions config from the db.
*

View File

@ -84,6 +84,19 @@ module.exports = {
return strapi.plugin('config-sync').service('main').getFormattedDiff();
},
zipConfig: async (ctx) => {
// Check for existance of the config file sync dir.
if (!fs.existsSync(strapi.config.get('plugin.config-sync.syncDir'))) {
ctx.send({
message: 'No config files were found.',
});
return;
}
return strapi.plugin('config-sync').service('main').zipConfigFiles();
},
/**
* Get the current Strapi env.
* @returns {string} The current Strapi environment.

View File

@ -27,6 +27,14 @@ module.exports = {
policies: [],
},
},
{
method: "GET",
path: "/zip",
handler: "config.zipConfig",
config: {
policies: [],
},
},
{
method: "GET",
path: "/app-env",

View File

@ -5,6 +5,7 @@ const fs = require('fs');
const util = require('util');
const difference = require('../utils/getObjectDiff');
const { logMessage } = require('../utils');
const child_process = require("child_process");
/**
* Main services for config import/export.
@ -65,6 +66,33 @@ module.exports = () => ({
fs.unlinkSync(`${strapi.config.get('plugin.config-sync.syncDir')}${configName}.json`);
},
/**
* Zip config files.
*
* @param {string} configName - The name of the config file.
* @returns {void}
*/
zipConfigFiles: async () => {
const fileName = `config-${new Date().toJSON()}.zip`
child_process.execSync(`zip -r ${fileName} *`, {
cwd: strapi.config.get('plugin.config-sync.syncDir')
});
const fullFilePath = `${strapi.config.get('plugin.config-sync.syncDir')}${fileName}`
const stats = fs.statSync(fullFilePath);
const result = await strapi.plugins.upload.services.upload.upload({
data: {}, //mandatory declare the data(can be empty), otherwise it will give you an undefined error. This parameters will be used to relate the file with a collection.
files: {
path: fullFilePath,
name: `configs/${fileName}`,
type: 'application/zip', // mime type of the file
size: stats.size,
},
});
fs.unlinkSync(fullFilePath);
return { url: result[0].url, message: 'Success' };
},
/**
* Read from a config file.
*