Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add option to only include listed types and config #168

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

feat: add option to only include listed types and config #168

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7f72442
feat: add option to only include listed types and config
cekpowell Jan 29, 2025
e5b59a8
chore: update comments
cekpowell Jan 29, 2025
c7bdf8f
chore: action comments
cekpowell Jan 31, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 10 additions & 3 deletions server/bootstrap.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

import fs from 'fs';

import isEmpty from 'lodash/isEmpty';
import ConfigType from './config/type';
import defaultTypes from './config/types';
import { logMessage } from './utils';
Expand All @@ -23,21 +24,27 @@ export default async () => {

// The default types provided by the plugin.
defaultTypes(strapi).map((type) => {
if (!strapi.config.get('plugin::config-sync.excludedTypes').includes(type.configName)) {
const shouldInclude = isEmpty(strapi.config.get('plugin::config-sync.includedTypes')) || strapi.config.get('plugin::config-sync.includedTypes').includes(type.configName);
const shouldExclude = strapi.config.get('plugin::config-sync.excludedTypes').includes(type.configName);
if (shouldInclude && !shouldExclude) {
types[type.configName] = new ConfigType(type);
}
});

// The types provided by other plugins.
strapi.plugin('config-sync').pluginTypes.map((type) => {
if (!strapi.config.get('plugin::config-sync.excludedTypes').includes(type.configName)) {
const shouldInclude = isEmpty(strapi.config.get('plugin::config-sync.includedTypes')) || strapi.config.get('plugin::config-sync.includedTypes').includes(type.configName);
const shouldExclude = strapi.config.get('plugin::config-sync.excludedTypes').includes(type.configName);
if (shouldInclude && !shouldExclude) {
types[type.configName] = new ConfigType(type);
}
});

// The custom types provided by the user.
strapi.config.get('plugin::config-sync.customTypes').map((type) => {
if (!strapi.config.get('plugin::config-sync.excludedTypes').includes(type.configName)) {
const shouldInclude = isEmpty(strapi.config.get('plugin::config-sync.includedTypes')) || strapi.config.get('plugin::config-sync.includedTypes').includes(type.configName);
const shouldExclude = strapi.config.get('plugin::config-sync.excludedTypes').includes(type.configName);
if (shouldInclude && !shouldExclude) {
types[type.configName] = new ConfigType(type);
}
});
Expand Down
4 changes: 3 additions & 1 deletion server/config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
'use strict';
"use strict";

export default {
default: {
Expand All @@ -7,7 +7,9 @@ export default {
soft: false,
importOnBootstrap: false,
customTypes: [],
includedTypes: [],
excludedTypes: [],
includedConfig: [],
excludedConfig: [
"core-store.plugin_users-permissions_grant",
"core-store.plugin_upload_metrics",
Expand Down
32 changes: 20 additions & 12 deletions server/services/main.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
'use strict';

import isEmpty from 'lodash/isEmpty';
import AdmZip from 'adm-zip';
import fs from 'fs';
import isEmpty from 'lodash/isEmpty';
import util from 'util';
import AdmZip from 'adm-zip';

import difference from '../utils/getObjectDiff';
import { logMessage } from '../utils';
import difference from '../utils/getObjectDiff';

/**
* Main services for config import/export.
Expand All @@ -22,9 +22,10 @@ export default () => ({
* @returns {void}
*/
writeConfigFile: async (configType, configName, fileContents) => {
// Check if the config should be excluded.
// Check if the config should be included.
const shouldInclude = isEmpty(strapi.config.get('plugin::config-sync.includedConfig')) || !isEmpty(strapi.config.get('plugin::config-sync.includedConfig').filter((option) => `${configType}.${configName}`.startsWith(option)));
const shouldExclude = !isEmpty(strapi.config.get('plugin::config-sync.excludedConfig').filter((option) => `${configType}.${configName}`.startsWith(option)));
if (shouldExclude) return;
if (!shouldInclude || shouldExclude) return;

// Replace reserved characters in filenames.
configName = configName.replace(/:/g, "#").replace(/\//g, "$");
Expand Down Expand Up @@ -57,9 +58,10 @@ export default () => ({
* @returns {void}
*/
deleteConfigFile: async (configName) => {
// Check if the config should be excluded.
// Check if the config should be included.
const shouldInclude = isEmpty(strapi.config.get('plugin::config-sync.includedConfig')) || !isEmpty(strapi.config.get('plugin::config-sync.includedConfig').filter((option) => configName.startsWith(option)));
const shouldExclude = !isEmpty(strapi.config.get('plugin::config-sync.excludedConfig').filter((option) => configName.startsWith(option)));
if (shouldExclude) return;
if (!shouldInclude || shouldExclude) return;

// Replace reserved characters in filenames.
configName = configName.replace(/:/g, "#").replace(/\//g, "$");
Expand Down Expand Up @@ -128,10 +130,14 @@ export default () => ({
// Put back reserved characters from filenames.
const formattedName = name.replace(/#/g, ":").replace(/\$/g, "/");

const shouldInclude = isEmpty(strapi.config.get('plugin::config-sync.includedConfig')) || !isEmpty(strapi.config.get('plugin::config-sync.includedConfig').filter((option) => `${type}.${name}`.startsWith(option)));
const shouldExclude = !isEmpty(strapi.config.get('plugin::config-sync.excludedConfig').filter((option) => `${type}.${name}`.startsWith(option)));

if (
configType && configType !== type
|| !strapi.plugin('config-sync').types[type]
|| !isEmpty(strapi.config.get('plugin::config-sync.excludedConfig').filter((option) => `${type}.${name}`.startsWith(option)))
|| !shouldInclude
|| shouldExclude
) {
return;
}
Expand Down Expand Up @@ -236,9 +242,10 @@ export default () => ({
* @returns {void}
*/
importSingleConfig: async (configName, onSuccess, force) => {
// Check if the config should be excluded.
// Check if the config should be included.
const shouldInclude = isEmpty(strapi.config.get('plugin::config-sync.includedConfig')) || !isEmpty(strapi.config.get('plugin::config-sync.includedConfig').filter((option) => configName.startsWith(option)));
const shouldExclude = !isEmpty(strapi.config.get('plugin::config-sync.excludedConfig').filter((option) => configName.startsWith(option)));
if (shouldExclude) return;
if (!shouldInclude || shouldExclude) return;

const type = configName.split('.')[0]; // Grab the first part of the filename.
const name = configName.split(/\.(.+)/)[1]; // Grab the rest of the filename.
Expand All @@ -261,9 +268,10 @@ export default () => ({
* @returns {void}
*/
exportSingleConfig: async (configName, onSuccess) => {
// Check if the config should be excluded.
// Check if the config should be included.
const shouldInclude = isEmpty(strapi.config.get('plugin::config-sync.includedConfig')) || !isEmpty(strapi.config.get('plugin::config-sync.includedConfig').filter((option) => configName.startsWith(option)));
const shouldExclude = !isEmpty(strapi.config.get('plugin::config-sync.excludedConfig').filter((option) => configName.startsWith(option)));
if (shouldExclude) return;
if (!shouldInclude || shouldExclude) return;

const type = configName.split('.')[0]; // Grab the first part of the filename.
const name = configName.split(/\.(.+)/)[1]; // Grab the rest of the filename.
Expand Down
Loading