Cavemanon/piratepoet
7
Fork 0
Code Pull Requests Actions Releases 16 Activity

Make name a property of Step.args instead of Step

Browse Source 
[MAILPOET-4445]
This commit is contained in:
David Remer
2022-08-12 11:50:45 +03:00
committed by Veljko V
parent 2a09646e8d
commit 24849afb7a
16 changed files with 35 additions and 80 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
mailpoet/assets/js/src/automation/editor/components/panel/step-name.tsx
View File

@ -1,21 +1,18 @@
import { Dropdown, TextControl } from '@wordpress/components';
import { edit, Icon } from '@wordpress/icons';
import { dispatch, useSelect } from '@wordpress/data';
import { PlainBodyTitle } from './plain-body-title';
import { TitleActionButton } from './title-action-button';
import { store } from '../../store';
import { Step } from '../workflow/types';
type Props = {
step: Step;
currentName: string;
defaultName: string;
update: (value: string) => void;
};
export function StepName({ step }: Props): JSX.Element {
const { stepType } = useSelect(
(select) => ({
stepType: select(store).getStepType(step.key),
}),
[],
);
export function StepName({
currentName,
defaultName,
update,
}: Props): JSX.Element {
return (
<Dropdown
className="mailpoet-step-name-dropdown"
@ -23,7 +20,7 @@ export function StepName({ step }: Props): JSX.Element {
position="bottom left"
renderToggle={({ isOpen, onToggle }) => (
<PlainBodyTitle
title={step.name && step.name.length > 0 ? step.name : stepType.title}
title={currentName.length > 0 ? currentName : defaultName}
>
<TitleActionButton
onClick={onToggle}
@ -38,11 +35,9 @@ export function StepName({ step }: Props): JSX.Element {
<TextControl
label="Step name"
className="mailpoet-step-name-input"
placeholder={stepType.title}
value={step.name}
onChange={(value) => {
dispatch(store).updateStepName(step.id, value);
}}
placeholder={defaultName}
value={currentName}
onChange={update}
help="Give the automation step a name that indicates its purpose. E.g
“Abandoned cart recovery”. This name will be displayed only to you and not to the clients."
/>

5
mailpoet/assets/js/src/automation/editor/components/workflow/step.tsx
View File

@ -36,11 +36,8 @@ function getTitle(step: StepData): string {
if (step.type === 'trigger') {
return 'Trigger';
}
if (step.name) {
return step.name;
}
const selectedStepType = select(store).getStepType(step.key);
return selectedStepType.title;
return selectedStepType ? selectedStepType.title : '';
}
function getSubtitle(step: StepData): JSX.Element | string {

1
mailpoet/assets/js/src/automation/editor/components/workflow/types.ts
View File

@ -1,7 +1,6 @@
export type Step = {
id: string;
type: 'trigger' | 'action';
name: string | null;
key: string;
next_step_id?: string;
args: Record<string, unknown>;

8
mailpoet/assets/js/src/automation/editor/store/actions.ts
View File

@ -95,11 +95,3 @@ export function updateStepArgs(stepId, name, value) {
value,
};
}
export function updateStepName(stepId, name) {
return {
type: 'UPDATE_STEP_NAME',
stepId,
name,
};
}

18
mailpoet/assets/js/src/automation/editor/store/reducer.ts
View File

@ -50,24 +50,6 @@ export function reducer(state: State, action: Action): State {
[action.stepType.key]: action.stepType,
},
};
case 'UPDATE_STEP_NAME': {
const step = {
...state.workflowData.steps[action.stepId],
name: action.name,
};
return {
...state,
workflowData: {
...state.workflowData,
steps: {
...state.workflowData.steps,
[action.stepId]: step,
},
},
workflowSaved: false,
selectedStep: step,
};
}
case 'UPDATE_STEP_ARGS': {
const prevArgs = state.workflowData.steps[action.stepId].args ?? {};

11
mailpoet/assets/js/src/automation/integrations/mailpoet/steps/send_email/edit/email_panel.tsx
View File

@ -31,16 +31,23 @@ function SingleLineTextareaControl(
}
export function EmailPanel(): JSX.Element {
const { selectedStep } = useSelect(
const { selectedStep, selectedStepType } = useSelect(
(select) => ({
selectedStep: select(store).getSelectedStep(),
selectedStepType: select(store).getSelectedStepType(),
}),
[],
);
return (
<PanelBody opened>
<StepName step={selectedStep} />
<StepName
currentName={(selectedStep.args.name as string) ?? ''}
defaultName={selectedStepType.title}
update={(value) => {
dispatch(store).updateStepArgs(selectedStep.id, 'name', value);
}}
/>
<TextControl
label="“From” name"
placeholder="John Doe"

2
mailpoet/assets/js/src/automation/integrations/mailpoet/steps/send_email/index.tsx
View File

@ -7,7 +7,7 @@ export const step: StepType = {
group: 'actions',
title: 'Send email',
description: 'An email will be sent to subscriber',
subtitle: (data) => `Email ID ${data.args.email_id as string}`,
subtitle: (data) => (data.args.name as string) ?? 'Send email',
foreground: '#996800',
background: '#FCF9E8',
icon: Icon,

1
mailpoet/lib/AdminPages/Pages/AutomationEditor.php
View File

@ -64,7 +64,6 @@ class AutomationEditor {
'steps' => array_map(function (Step $step) {
return [
'id' => $step->getId(),
'name' => $step->getName(),
'type' => $step->getType(),
'key' => $step->getKey(),
'next_step_id' => $step->getNextStepId(),

1
mailpoet/lib/Automation/Engine/Builder/UpdateStepsController.php
View File

@ -36,7 +36,6 @@ class UpdateStepsController {
return new Step(
$data['id'],
$data['name'] ?? null,
$data['type'],
$data['key'],
$data['next_step_id'] ?? null,

10
mailpoet/lib/Automation/Engine/Data/Step.php
View File

@ -9,9 +9,6 @@ class Step {
/** @var string */
private $id;
/** @var ?string */
private $name;
/** @var string */
private $type;
@ -26,14 +23,12 @@ class Step {
public function __construct(
string $id,
?string $name,
string $type,
string $key,
?string $nextStepId = null,
array $args = []
) {
$this->id = $id;
$this->name = $name;
$this->type = $type;
$this->key = $key;
$this->nextStepId = $nextStepId;
@ -44,10 +39,6 @@ class Step {
return $this->id;
}
public function getName(): ?string {
return $this->name;
}
public function getType(): string {
return $this->type;
}
@ -71,7 +62,6 @@ class Step {
public function toArray(): array {
return [
'id' => $this->id,
'name' => $this->name,
'type' => $this->type,
'key' => $this->key,
'next_step_id' => $this->nextStepId,

1
mailpoet/lib/Automation/Engine/Data/Workflow.php
View File

@ -170,7 +170,6 @@ class Workflow {
foreach ($data as $step) {
$steps[] = new Step(
$step['id'],
$step['name'] ?? null,
$step['type'],
$step['key'],
$step['next_step_id'] ?? null,

2
mailpoet/lib/Automation/Engine/Endpoints/Workflows/WorkflowsPutEndpoint.php
View File

@ -31,7 +31,6 @@ class WorkflowsPutEndpoint extends Endpoint {
public static function getRequestSchema(): array {
$step = Builder::object([
'id' => Builder::string()->required(),
'name' => Builder::string()->nullable(),
'type' => Builder::string()->required(),
'key' => Builder::string()->required(),
'args' => Builder::object(),
@ -56,7 +55,6 @@ class WorkflowsPutEndpoint extends Endpoint {
'steps' => array_map(function (Step $step) {
return [
'id' => $step->getId(),
'name' => $step->getName(),
'type' => $step->getType(),
'key' => $step->getKey(),
'next_step_id' => $step->getNextStepId(),

1
mailpoet/lib/Automation/Integrations/MailPoet/Actions/SendEmailAction.php
View File

@ -68,6 +68,7 @@ class SendEmailAction implements Action {
'reply_to_name' => Builder::string()->default($this->settings->get('reply_to.name')),
'reply_to_address' => Builder::string()->default($this->settings->get('reply_to.address')),
'ga_campaign' => Builder::string(),
'name' => Builder::string()->default(__('Send email', 'mailpoet')),
]);
}

3
mailpoet/lib/Automation/Integrations/MailPoet/Templates/WorkflowBuilder.php
View File

@ -78,7 +78,6 @@ class WorkflowBuilder {
private function delayStep(?int $delay, string $delayType): Step {
return new Step(
$this->uniqueId(),
null,
Step::TYPE_ACTION,
$this->delayAction->getKey(),
null,
@ -92,7 +91,6 @@ class WorkflowBuilder {
private function segmentSubscribedTriggerStep(?int $segmentId = null): Step {
return new Step(
$this->uniqueId(),
null,
Step::TYPE_TRIGGER,
$this->segmentSubscribedTrigger->getKey(),
null,
@ -105,7 +103,6 @@ class WorkflowBuilder {
private function sendEmailActionStep(): Step {
return new Step(
$this->uniqueId(),
__('Send email', 'mailpoet'),
Step::TYPE_ACTION,
$this->sendEmailAction->getKey(),
null,

4
mailpoet/tests/integration/Automation/Integrations/Core/Actions/DelayActionTest.php
View File

@ -16,7 +16,7 @@ class DelayActionTest extends \MailPoetTest {
*/
public function testItCalculatesDelayTypesCorrectly(int $delay, string $type, int $expectation) {
$step = new Step("1", null, 'core:delay', 'core:delay', 'next-step', [
$step = new Step("1", 'core:delay', 'core:delay', 'next-step', [
'delay' => $delay,
'delay_type' => $type,
]);
@ -81,7 +81,7 @@ class DelayActionTest extends \MailPoetTest {
*/
public function testDelayActionInvalidatesOutsideOfBoundaries(int $delay, bool $expectation) {
$step = new Step("1", null, 'core:delay', 'core:delay', 'next-step', [
$step = new Step("1", 'core:delay', 'core:delay', 'next-step', [
'delay' => $delay,
'delay_type' => "HOURS",
]);

18
mailpoet/tests/integration/Automation/Integrations/MailPoet/Actions/SendEmailActionTest.php
View File

@ -60,7 +60,7 @@ class SendEmailActionTest extends \MailPoetTest {
$this->segmentSubject = $this->diContainer->get(SegmentSubject::class);
$this->email = (new Newsletter())->withAutomationType()->create();
$this->step = new Step('step-id', null, Step::TYPE_ACTION, 'step-key', null, ['email_id' => $this->email->getId()]);
$this->step = new Step('step-id', Step::TYPE_ACTION, 'step-key', null, ['email_id' => $this->email->getId()]);
$this->workflow = new Workflow('test-workflow', []);
}
@ -78,13 +78,13 @@ class SendEmailActionTest extends \MailPoetTest {
}
public function testItIsNotValidIfStepHasNoEmail(): void {
$step = new Step('step-id', null, Step::TYPE_ACTION, 'step-key', null, []);
$step = new Step('step-id', Step::TYPE_ACTION, 'step-key', null, []);
expect($this->action->isValid($this->getSubjects(), $step, $this->workflow))->false();
}
public function testItRequiresAutomationEmailType(): void {
$newsletter = (new Newsletter())->withPostNotificationsType()->create();
$step = new Step('step-id', null, Step::TYPE_ACTION, 'step-key', null, ['email_id' => $newsletter->getId()]);
$step = new Step('step-id', Step::TYPE_ACTION, 'step-key', null, ['email_id' => $newsletter->getId()]);
expect($this->action->isValid($this->getSubjects(), $step, $this->workflow))->false();
}
@ -97,7 +97,7 @@ class SendEmailActionTest extends \MailPoetTest {
$subjects = $this->getLoadedSubjects($subscriber, $segment);
$email = (new Newsletter())->withAutomationType()->create();
$step = new Step('step-id', null, Step::TYPE_ACTION, 'step-key', null, ['email_id' => $email->getId()]);
$step = new Step('step-id', Step::TYPE_ACTION, 'step-key', null, ['email_id' => $email->getId()]);
$workflow = new Workflow('some-workflow', [$step]);
$run = new WorkflowRun(1, 1, 'trigger-key', $subjects);
@ -119,7 +119,7 @@ class SendEmailActionTest extends \MailPoetTest {
$subjects = $this->getLoadedSubjects($subscriber, $segment);
$email = (new Newsletter())->withAutomationType()->create();
$step = new Step('step-id', null, Step::TYPE_ACTION, 'step-key', null, ['email_id' => $email->getId()]);
$step = new Step('step-id', Step::TYPE_ACTION, 'step-key', null, ['email_id' => $email->getId()]);
$workflow = new Workflow('some-workflow', [$step]);
$run = new WorkflowRun(1, 1, 'trigger-key', $subjects);
@ -151,7 +151,7 @@ class SendEmailActionTest extends \MailPoetTest {
$subjects = $this->getLoadedSubjects($subscriber, $segment);
$email = (new Newsletter())->withAutomationType()->create();
$step = new Step('step-id', null, Step::TYPE_ACTION, 'step-key', null, ['email_id' => $email->getId()]);
$step = new Step('step-id', Step::TYPE_ACTION, 'step-key', null, ['email_id' => $email->getId()]);
$workflow = new Workflow('some-workflow', [$step]);
$run = new WorkflowRun(1, 1, 'trigger-key', $subjects);
@ -180,7 +180,7 @@ class SendEmailActionTest extends \MailPoetTest {
$subjects = $this->getLoadedSubjects($subscriber, $segment);
$email = (new Newsletter())->withAutomationType()->create();
$step = new Step('step-id', null, Step::TYPE_ACTION, 'step-key', null, ['email_id' => $email->getId()]);
$step = new Step('step-id', Step::TYPE_ACTION, 'step-key', null, ['email_id' => $email->getId()]);
$workflow = new Workflow('some-workflow', [$step]);
$run = new WorkflowRun(1, 1, 'trigger-key', $subjects);
@ -218,7 +218,7 @@ class SendEmailActionTest extends \MailPoetTest {
$subjects = $this->getLoadedSubjects($subscriber, $segment);
$email = (new Newsletter())->withAutomationType()->create();
$step = new Step('step-id', null, Step::TYPE_ACTION, 'step-key', null, ['email_id' => $email->getId()]);
$step = new Step('step-id', Step::TYPE_ACTION, 'step-key', null, ['email_id' => $email->getId()]);
$workflow = new Workflow('some-workflow', [$step]);
$run = new WorkflowRun(1, 1, 'trigger-key', $subjects);
@ -247,7 +247,7 @@ class SendEmailActionTest extends \MailPoetTest {
$subjects = $this->getLoadedSubjects($subscriber, $segment);
$email = (new Newsletter())->withAutomationType()->create();
$step = new Step('step-id', null, Step::TYPE_ACTION, 'step-key', null, ['email_id' => $email->getId()]);
$step = new Step('step-id', Step::TYPE_ACTION, 'step-key', null, ['email_id' => $email->getId()]);
$workflow = new Workflow('some-workflow', [$step]);
$run = new WorkflowRun(1, 1, 'trigger-key', $subjects);