Skip to content

Commit

Permalink
NEXT-37264 - refactor flow builder action description
Browse files Browse the repository at this point in the history
  • Loading branch information
@LarsKemper
LarsKemper committed Jul 25, 2024
1 parent e1f9215 commit ce8014c
Show file tree
Hide file tree
Showing 2 changed files with 110 additions and 94 deletions.
202 changes: 109 additions & 93 deletions ...istration/Resources/app/administration/src/module/sw-flow/service/flow-builder.service.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,88 +22,112 @@ Application.addServiceProvider('flowBuilderService', () => {
export default function flowBuilderService() {
const $icon = {
addEntityTag: 'regular-tag',
removeEntityTag: 'regular-tag',
mailSend: 'regular-envelope',
grantDownloadAccess: 'regular-file-signature',
setOrderState: 'regular-shopping-bag-alt',
generateDocument: 'regular-file-text',
changeCustomerGroup: 'regular-users',
changeCustomerStatus: 'regular-user',
removeEntityTag: 'regular-tag',
stopFlow: 'regular-times-circle',
changeCustomerStatus: 'regular-user',
changeCustomerGroup: 'regular-users',
generateDocument: 'regular-file-text',
setOrderState: 'regular-shopping-bag-alt',
grantDownloadAccess: 'regular-file-signature',
setEntityCustomField: 'regular-file-signature',
addEntityAffiliateAndCampaignCode: 'regular-file-signature',
};

const $labelSnippet = {
stopFlow: 'sw-flow.actions.stopFlow',
mailSend: 'sw-flow.actions.mailSend',
addEntityTag: 'sw-flow.actions.addTag',
removeEntityTag: 'sw-flow.actions.removeTag',
mailSend: 'sw-flow.actions.mailSend',
grantDownloadAccess: 'sw-flow.actions.grantDownloadAccess',
setOrderState: 'sw-flow.actions.setOrderState',
generateDocument: 'sw-flow.actions.generateDocument',
grantDownloadAccess: 'sw-flow.actions.grantDownloadAccess',
changeCustomerGroup: 'sw-flow.actions.changeCustomerGroup',
changeCustomerStatus: 'sw-flow.actions.changeCustomerStatus',
stopFlow: 'sw-flow.actions.stopFlow',
setEntityCustomField: 'sw-flow.actions.changeCustomFieldContent',
addEntityAffiliateAndCampaignCode: 'sw-flow.actions.addAffiliateAndCampaignCode',
};

const $actionNames = { ...ACTION };

const $groups = {
GENERAL: GENERAL_GROUP,
TAG: TAG_GROUP,
CUSTOMER: CUSTOMER_GROUP,
ORDER: ORDER_GROUP,
GENERAL: GENERAL_GROUP,
CUSTOMER: CUSTOMER_GROUP,
};

const $actionGroupsMapping = { ...ACTION_GROUP };

const $descriptionCallbacks = {
[$actionNames.MAIL_SEND]: getMailSendDescription,
[$actionNames.STOP_FLOW]: getStopFlowActionDescription,
[$actionNames.SET_ORDER_STATE]: getSetOrderStateDescription,
[$actionNames.GENERATE_DOCUMENT]: getGenerateDocumentDescription,
[$actionNames.CHANGE_CUSTOMER_GROUP]: getCustomerGroupDescription,
[$actionNames.GRANT_DOWNLOAD_ACCESS]: getDownloadAccessDescription,
[$actionNames.SET_CUSTOMER_CUSTOM_FIELD]: getCustomFieldDescription,
[$actionNames.CHANGE_CUSTOMER_STATUS]: getCustomerStatusDescription,
[$actionNames.ADD_ORDER_AFFILIATE_AND_CAMPAIGN_CODE]: getAffiliateAndCampaignCodeDescription,
[$actionNames.ADD_CUSTOMER_AFFILIATE_AND_CAMPAIGN_CODE]: getAffiliateAndCampaignCodeDescription,
};

const $entityAction = {
[$actionNames.ADD_ORDER_TAG]: 'order',
[$actionNames.ADD_CUSTOMER_TAG]: 'customer',
[$actionNames.REMOVE_ORDER_TAG]: 'order',
[$actionNames.REMOVE_CUSTOMER_TAG]: 'customer',
[$actionNames.ADD_CUSTOMER_TAG]: 'customer',
[$actionNames.SET_ORDER_CUSTOM_FIELD]: 'order',
[$actionNames.REMOVE_CUSTOMER_TAG]: 'customer',
[$actionNames.SET_CUSTOMER_CUSTOM_FIELD]: 'customer',
[$actionNames.ADD_ORDER_AFFILIATE_AND_CAMPAIGN_CODE]: 'order',
[$actionNames.SET_CUSTOMER_GROUP_CUSTOM_FIELD]: 'customer_group',
[$actionNames.ADD_CUSTOMER_AFFILIATE_AND_CAMPAIGN_CODE]: 'customer',
[$actionNames.ADD_ORDER_AFFILIATE_AND_CAMPAIGN_CODE]: 'order',
};

return {
getActionTitle,
getActionModalName,
convertEntityName,
mapActionType,
getAvailableEntities,
formatValuePreview,
rearrangeArrayObjects,
getDescription,
getActionDescriptions,
getCustomerStatusDescription,
getAffiliateAndCampaignCodeDescription,
getCustomerGroupDescription,
getCustomFieldDescription,
getSetOrderStateDescription,
convertTagString,
getGenerateDocumentDescription,
getMailSendDescription,
getDownloadAccessDescription,
convertConfig,
getAppFlowActionDescription,
formatValuePreview,
convertTagString,
convertEntityName,
convertLabelPreview,
getActionName,
addActionNames,
addDescriptionCallbacks,
getDescriptionCallbacks,
addIcons,
addLabels,
getActionGroupMapping,
addGroups,
addActionGroupMapping,
getGroup,
addGroups,
getGroups,
getActionName,
getDescription,
getActionTitle,
getActionModalName,
getAvailableEntities,
getActionGroupMapping,
getActionDescriptions,
getMailSendDescription,
getCustomFieldDescription,
getAppFlowActionDescription,
getSetOrderStateDescription,
getCustomerGroupDescription,
getStopFlowActionDescription,
getDownloadAccessDescription,
getCustomerStatusDescription,
getGenerateDocumentDescription,
getAffiliateAndCampaignCodeDescription,
};

function addDescriptionCallbacks(callback) {
Object.assign($descriptionCallbacks, callback);
}

function getDescriptionCallbacks() {
return $descriptionCallbacks;
}

function addIcons(icons) {
return Object.assign($icon, icons);
}
Expand Down Expand Up @@ -173,6 +197,7 @@ export default function flowBuilderService() {

Object.entries(format).forEach(([key, value]) => {
let label = value;

if (Utils.types.isPlainObject(value)) {
label = Object.values(value).join(', ');
}
Expand Down Expand Up @@ -208,66 +233,45 @@ export default function flowBuilderService() {

function getActionDescriptions(data, sequence, translator) {
const { actionName, config } = sequence;
const {
appActions,
customerGroups,
customFieldSets,
customFields,
stateMachineState,
documentTypes,
mailTemplates,
} = data;

if (!actionName) return '';

const selectedAppAction = appActions?.find(item => item.name === actionName);
if (selectedAppAction) {
return this.getAppFlowActionDescription(appActions, config, actionName);
}

switch (actionName) {
case $actionNames.STOP_FLOW:
return translator.$tc('sw-flow.actions.textStopFlowDescription');
if (!actionName) {
return '';
}

case $actionNames.CHANGE_CUSTOMER_STATUS:
return this.getCustomerStatusDescription(config, translator);
const selectedAppAction = data.appActions?.find(item => item.name === actionName);

case $actionNames.ADD_CUSTOMER_AFFILIATE_AND_CAMPAIGN_CODE:
case $actionNames.ADD_ORDER_AFFILIATE_AND_CAMPAIGN_CODE:
return this.getAffiliateAndCampaignCodeDescription(config, translator);
if (selectedAppAction) {
return this.getAppFlowActionDescription(data, sequence);
}

case $actionNames.CHANGE_CUSTOMER_GROUP:
return this.getCustomerGroupDescription(customerGroups, config);
const callback = $descriptionCallbacks[actionName];

case $actionNames.SET_CUSTOMER_CUSTOM_FIELD:
return this.getCustomFieldDescription(customFieldSets, customFields, config, translator);
if (typeof callback === 'function') {
return callback.call(this, data, sequence, translator);
}

case $actionNames.SET_ORDER_STATE:
return this.getSetOrderStateDescription(stateMachineState, config, translator);
const convertedDescription = this.convertConfig(config, translator);

case $actionNames.GENERATE_DOCUMENT:
return this.getGenerateDocumentDescription(documentTypes, config);
return this.getDescription(convertedDescription);
}

case $actionNames.MAIL_SEND:
return this.getMailSendDescription(mailTemplates, config, translator);
function getStopFlowActionDescription(_data, _sequence, translator) {
return translator.$tc('sw-flow.actions.textStopFlowDescription');
}

case $actionNames.GRANT_DOWNLOAD_ACCESS:
return this.getDownloadAccessDescription(config, translator);
function getAppFlowActionDescription(data, sequence) {
const { actionName, config } = sequence;
const { appActions } = data;

default: {
const convertedDescription = this.convertConfig(config, translator);
return this.getDescription(convertedDescription);
}
}
}
console.log({ appActions, actionName, config });

function getAppFlowActionDescription(appActions, config, actionName) {
const cloneConfig = { ...config };
let descriptions = '';

Object.entries(cloneConfig).forEach(([fieldName]) => {
if (typeof cloneConfig[fieldName] === 'object' && cloneConfig[fieldName].length > 1) {
let html = '';

cloneConfig[fieldName].forEach((val) => {
const valPreview = this.formatValuePreview(appActions, fieldName, actionName, val);
html = `${html}- ${valPreview}<br/>`;
Expand Down Expand Up @@ -305,6 +309,7 @@ export default function flowBuilderService() {
if (['single-select', 'multi-select'].includes(config.type)) {
const value = typeof val === 'string' ? val : val[0];
const option = config.options.find((opt) => opt.value === value);

if (option === undefined) {
return val;
}
Expand Down Expand Up @@ -337,13 +342,15 @@ export default function flowBuilderService() {
return config.label[this.currentLocale] ?? config.label['en-GB'] ?? fieldName;
}

function getCustomerStatusDescription(config, translator) {
return config.active
function getCustomerStatusDescription(_data, sequence, translator) {
return sequence.config.active
? translator.$tc('sw-flow.modals.customerStatus.active')
: translator.$tc('sw-flow.modals.customerStatus.inactive');
}

function getAffiliateAndCampaignCodeDescription(config, translator) {
function getAffiliateAndCampaignCodeDescription(_data, sequence, translator) {
const { config } = sequence;

let description = translator.$tc('sw-flow.actions.labelTo', 0, {
entity: capitalizeString(config.entity),
});
Expand All @@ -363,14 +370,18 @@ export default function flowBuilderService() {
return description;
}

function getCustomerGroupDescription(customerGroups, config) {
const customerGroup = customerGroups.find(item => item.id === config.customerGroupId);
function getCustomerGroupDescription(data, sequence) {
const customerGroup = data.customerGroups.find(item => item.id === sequence.config.customerGroupId);
return customerGroup?.translated?.name;
}

function getCustomFieldDescription(customFieldSets, customFields, config, translator) {
function getCustomFieldDescription(data, sequence, translator) {
const { config } = sequence;
const { customFields, customFieldSets } = data;

const customFieldSet = customFieldSets.find(item => item.id === config.customFieldSetId);
const customField = customFields.find(item => item.id === config.customFieldId);

if (!customFieldSet || !customField) {
return '';
}
Expand All @@ -384,7 +395,10 @@ export default function flowBuilderService() {
})}`;
}

function getSetOrderStateDescription(stateMachineState, config, translator) {
function getSetOrderStateDescription(data, sequence, translator) {
const { config } = sequence;
const { stateMachineState } = data;

const description = [];
if (config.order) {
const orderStatus = stateMachineState.find(item => item.technicalName === config.order
Expand Down Expand Up @@ -422,24 +436,26 @@ export default function flowBuilderService() {
return description.join('<br>');
}

function getGenerateDocumentDescription(documentTypes, config) {
function getGenerateDocumentDescription(data, sequence) {
const { config } = sequence;

if (config.documentType) {
config = {
documentTypes: [config],
};
Object.assign(config, {
documentType: [config],
});
}

const documentType = config.documentTypes.map((type) => {
return documentTypes.find(
return data.documentTypes.find(
item => item.technicalName === type.documentType,
)?.translated?.name;
});

return this.convertTagString(documentType);
}

function getMailSendDescription(mailTemplates, config, translator) {
const mailTemplateData = mailTemplates.find(item => item.id === config.mailTemplateId);
function getMailSendDescription(data, sequence, translator) {
const mailTemplateData = data.mailTemplates.find(item => item.id === sequence.config.mailTemplateId);

let mailSendDescription = translator.$tc('sw-flow.actions.labelTemplate', 0, {
template: mailTemplateData?.mailTemplateType?.name,
Expand All @@ -461,8 +477,8 @@ export default function flowBuilderService() {
return mailSendDescription;
}

function getDownloadAccessDescription(config, translator) {
return config.value
function getDownloadAccessDescription(_data, sequence, translator) {
return sequence.config.value
? translator.$tc('sw-flow.actions.downloadAccessLabel.granted')
: translator.$tc('sw-flow.actions.downloadAccessLabel.revoked');
}
Expand Down
2 changes: 1 addition & 1 deletion ...tion/Resources/app/administration/src/module/sw-flow/service/flow-builder.service.spec.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -231,7 +231,7 @@ describe('module/sw-flow/service/flow-builder.service.js', () => {
expect(description).toBe('');
});

it('should be able to show description of app action', async () => {
it.only('should be able to show description of app action', async () => {
const sequence = {
actionName: 'telegram.send.message',
config: {
Expand Down

0 comments on commit ce8014c

Please sign in to comment.