Merge pull request #1 from boazpoolman/develop

Develop

Author: boazpoolman

README.md

@@ -6,9 +6,7 @@ That's where this plugin comes in to play. It allows you to export these configs
 
 Importing, exporting and keeping track of config changes is done in the admin page of the plugin.
 
-*Currently only the core_store changes are being tracked.*
-
-**THIS PLUGIN IS STILL IN DEVELOPMENT**
+**THIS PLUGIN IS NOT STABLE**
 
 **PLEASE USE WITH CARE**
 
@@ -45,20 +43,40 @@ PLEASE USE WITH CARE.
 
 > `required:` NO | `type:` bool | `default:` false
 
+#### `include`
+
+Configs you want to include. Allowed values: `core-store`, `role-permissions`, `webhooks`. By default these are all enabled.
+
+> `required:` NO | `type:` array | `default:` ["core-store", "role-permissions", "webhooks"]
+
 #### `exclude`
 
 You might not want all your database config exported and managed in git. This settings allows you to add an array of config names which should not be tracked by the config-sync plugin.
 
-For now only the `core_store` table is being tracked. Add the `key` value of a `core_store` item to the array to exclude it from being tracked.
+*Currently not working*
 
 > `required:` NO | `type:` array | `default:` []
 
+## Naming convention
+All the config files written in the file destination have the same naming convention. It goes as follows:
+
+	[config-type].[config-name].json
+
+- `config-type` - Corresponds to the value in from the config.include setting.
+- `config-name` - The unique identifier of the config. 
+	- 	For `core-store` config this is the `key` value.
+	-  	For `role-permissions` config this is the `type` value.
+	-  	For `webhooks` config this is the `id` value
+  
+
 ## TODOs
-- Exporting of user roles & permissions
-- Exporting of webhooks
-- Specify which tables you want to track in the plugin configurations
+- ~~Exporting of user roles & permissions~~
+- ~~Exporting of webhooks~~
+- ~~Specify which tables you want to track in the plugin configurations~~
+- Exporting of EE roles & permissions
 - Add partial import/export functionality
 - Add CLI commands for importing/exporting
+- Track config deletions
 
 ## Resources
 

admin/src/components/ActionButtons/index.js

@@ -23,8 +23,8 @@ const ActionButtons = ({ diff }) => {
 
   return (
     <ActionButtonsStyling>
-      <Button disabled={isEmpty(diff)} color="primary" label="Import" onClick={() => openModal('import')} />
-      <Button disabled={isEmpty(diff)} color="primary" label="Export" onClick={() => openModal('export')} />
+      <Button disabled={isEmpty(diff.diff)} color="primary" label="Import" onClick={() => openModal('import')} />
+      <Button disabled={isEmpty(diff.diff)} color="primary" label="Export" onClick={() => openModal('export')} />
       <ConfirmModal
         isOpen={modalIsOpen}
         onClose={closeModal}

admin/src/components/ConfigList/index.js

@@ -1,5 +1,6 @@
 import React, { useState, useEffect } from 'react';
 import { Table } from '@buffetjs/core';
+import { isEmpty } from 'lodash';
 import ConfigDiff from '../ConfigDiff';
 
 const headers = [
@@ -8,32 +9,40 @@ const headers = [
     value: 'config_name',
   },
   {
-    name: 'Database table',
-    value: 'table_name',
+    name: 'Config type',
+    value: 'config_type',
   },
   {
     name: 'Change',
     value: 'change_type',
   },
 ];
 
-const ConfigList = ({ fileConfig, databaseConfig, diff, isLoading }) => {
+const ConfigList = ({ diff, isLoading }) => {
   const [openModal, setOpenModal] = useState(false);
   const [originalConfig, setOriginalConfig] = useState({});
   const [newConfig, setNewConfig] = useState({});
   const [configName, setConfigName] = useState('');
   const [rows, setRows] = useState([]);
 
   useEffect(() => {
+    if (isEmpty(diff)) {
+      setRows([]);
+      return;
+    }
+
     let formattedRows = [];
-    Object.keys(diff).map((config) => {
-      // @TODO implement different config types, roles/permissions e.g.
+    Object.keys(diff.fileConfig).map((configName) => {
+      const type = configName.split('.')[0]; // Grab the first part of the filename.
+      const name = configName.split(/\.(.+)/)[1].split('.')[0] // Grab the rest of the filename minus the file extension.
+
       formattedRows.push({ 
-        config_name: config,
-        table_name: 'core_store',
+        config_name: name,
+        config_type: type,
         change_type: ''
       });
     });
+
     setRows(formattedRows);
   }, [diff]);
 
@@ -56,10 +65,10 @@ const ConfigList = ({ fileConfig, databaseConfig, diff, isLoading }) => {
       />
       <Table
         headers={headers}
-        onClickRow={(e, data) => {
-          setOriginalConfig(fileConfig.get(data.config_name));
-          setNewConfig(databaseConfig.get(data.config_name));
-          setConfigName(data.config_name);
+        onClickRow={(e, { config_type, config_name }) => {
+          setOriginalConfig(diff.fileConfig[`${config_type}.${config_name}`]);
+          setNewConfig(diff.databaseConfig[`${config_type}.${config_name}`]);
+          setConfigName(`${config_type}.${config_name}`);
           setOpenModal(true);
         }}
         rows={!isLoading ? rows : []}

admin/src/containers/ConfigPage/index.js

@@ -2,27 +2,23 @@ import React, { useEffect } from 'react';
 import { useDispatch, useSelector } from 'react-redux';
 import { Map } from 'immutable';
 
-import { getAllConfig } from '../../state/actions/Config';
+import { getAllConfigDiff } from '../../state/actions/Config';
 import ConfigList from '../../components/ConfigList';
 import ActionButtons from '../../components/ActionButtons';
-import difference from '../../helpers/getObjectDiff';
 
 const ConfigPage = () => {
   const dispatch = useDispatch();
   const isLoading = useSelector((state) => state.getIn(['config', 'isLoading']), Map());
-  const fileConfig = useSelector((state) => state.getIn(['config', 'fileConfig']), Map());
-  const databaseConfig = useSelector((state) => state.getIn(['config', 'databaseConfig']), Map());
+  const configDiff = useSelector((state) => state.getIn(['config', 'configDiff']), Map());
 
   useEffect(() => {
-    dispatch(getAllConfig());
+    dispatch(getAllConfigDiff());
   }, []);
 
-  const diff = difference(fileConfig.toJS(), databaseConfig.toJS());
-
   return (
     <div>
-      <ActionButtons diff={diff} />
-      <ConfigList fileConfig={fileConfig} databaseConfig={databaseConfig} isLoading={isLoading} diff={diff} />
+      <ActionButtons diff={configDiff.toJS()} />
+      <ConfigList isLoading={isLoading} diff={configDiff.toJS()} />
     </div>
   );
 }

admin/src/state/actions/Config.js

@@ -7,14 +7,12 @@
 import { request } from 'strapi-helper-plugin';
 import { Map } from 'immutable';
 
-export function getAllConfig() {
+export function getAllConfigDiff() {
   return async function(dispatch) {
     dispatch(setLoadingState(true));
     try {
-      const databaseConfig = await request('/config-sync/all/from-database', { method: 'GET' });
-      const fileConfig = await request('/config-sync/all/from-files', { method: 'GET' });
-      dispatch(setFileConfigInState(fileConfig));
-      dispatch(setDatabaseConfigInState(databaseConfig));
+      const configDiff = await request('/config-sync/diff', { method: 'GET' });
+      dispatch(setConfigDiffInState(configDiff));
       dispatch(setLoadingState(false));
     } catch(err) {
       strapi.notification.error('notification.error');
@@ -23,18 +21,10 @@ export function getAllConfig() {
   }
 }
 
-export const SET_DATABASE_CONFIG_IN_STATE = 'SET_DATABASE_CONFIG_IN_STATE';
-export function setDatabaseConfigInState(config) {
+export const SET_CONFIG_DIFF_IN_STATE = 'SET_CONFIG_DIFF_IN_STATE';
+export function setConfigDiffInState(config) {
   return {
-    type: SET_DATABASE_CONFIG_IN_STATE,
-    config,
-  };
-}
-
-export const SET_FILE_CONFIG_IN_STATE = 'SET_FILE_CONFIG_IN_STATE';
-export function setFileConfigInState(config) {
-  return {
-    type: SET_FILE_CONFIG_IN_STATE,
+    type: SET_CONFIG_DIFF_IN_STATE,
     config,
   };
 }
@@ -44,8 +34,7 @@ export function exportAllConfig() {
     dispatch(setLoadingState(true));
     try {
       const { message } = await request('/config-sync/export', { method: 'GET' });
-      dispatch(setFileConfigInState(Map({})));
-      dispatch(setDatabaseConfigInState(Map({})));
+      dispatch(setConfigDiffInState(Map({})));
 
       strapi.notification.success(message);
       dispatch(setLoadingState(false));
@@ -61,8 +50,7 @@ export function importAllConfig() {
     dispatch(setLoadingState(true));
     try {
       const { message } = await request('/config-sync/import', { method: 'GET' });
-      dispatch(setFileConfigInState(Map({})));
-      dispatch(setDatabaseConfigInState(Map({})));
+      dispatch(setConfigDiffInState(Map({})));
 
       strapi.notification.success(message);
       dispatch(setLoadingState(false));

admin/src/state/reducers/Config/index.js

@@ -5,22 +5,18 @@
  */
 
 import { fromJS, Map } from 'immutable';
-import { SET_DATABASE_CONFIG_IN_STATE, SET_FILE_CONFIG_IN_STATE, SET_LOADING_STATE } from '../../actions/Config';
+import { SET_CONFIG_DIFF_IN_STATE, SET_LOADING_STATE } from '../../actions/Config';
 
 const initialState = fromJS({
-  databaseConfig: Map({}),
-  fileConfig: Map({}),
+  configDiff: Map({}),
   isLoading: false,
 });
 
 export default function configReducer(state = initialState, action) {
   switch (action.type) {
-    case SET_DATABASE_CONFIG_IN_STATE:
+    case SET_CONFIG_DIFF_IN_STATE:
       return state
-        .update('databaseConfig', () => fromJS(action.config))
-    case SET_FILE_CONFIG_IN_STATE:
-      return state
-        .update('fileConfig', () => fromJS(action.config))
+        .update('configDiff', () => fromJS(action.config))
     case SET_LOADING_STATE:
       return state
         .update('isLoading', () => fromJS(action.value))

config/config.json

@@ -2,5 +2,10 @@
   "destination": "extensions/config-sync/files/",
   "minify": false,
   "importOnBootstrap": false,
+  "include": [
+    "core-store",
+    "role-permissions",
+    "webhooks"
+  ],
   "exclude": []
 }

config/functions/bootstrap.js

@@ -12,14 +12,10 @@ const fs = require('fs');
  * See more details here: https://strapi.io/documentation/v3.x/concepts/configurations.html#bootstrap
  */
 
-module.exports = () => {
+module.exports = async () => {
   if (strapi.plugins['config-sync'].config.importOnBootstrap) {
     if (fs.existsSync(strapi.plugins['config-sync'].config.destination)) {
-      const configFiles = fs.readdirSync(strapi.plugins['config-sync'].config.destination);
-
-      configFiles.map((file) => {
-        strapi.plugins['config-sync'].services.config.importFromFile(file.slice(0, -5));
-      });
+      await strapi.plugins['config-sync'].services.main.importAllConfig();
     }
   }
 };

config/routes.json

@@ -3,31 +3,23 @@
     {
       "method": "GET",
       "path": "/export",
-      "handler": "config.export",
+      "handler": "config.exportAll",
       "config": {
         "policies": []
       }
     },
     {
       "method": "GET",
       "path": "/import",
-      "handler": "config.import",
+      "handler": "config.importAll",
       "config": {
         "policies": []
       }
     },
     {
       "method": "GET",
-      "path": "/all/from-files",
-      "handler": "config.getConfigsFromFiles",
-      "config": {
-        "policies": []
-      }
-    },
-    {
-      "method": "GET",
-      "path": "/all/from-database",
-      "handler": "config.getConfigsFromDatabase",
+      "path": "/diff",
+      "handler": "config.getDiff",
       "config": {
         "policies": []
       }