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

Add IDs for filter groups and filter definitions

Browse Source 
[MAILPOET-5257]
This commit is contained in:
Jan Jakes
2023-04-21 14:39:58 +02:00
committed by Aschepikov
parent 34ca96d007
commit f75620a7c1
10 changed files with 43 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -5,6 +5,7 @@ export type NextStep = {
};
export type Filter = {
id: string;
field_type: string;
field_key: string;
condition: string;
@@ -12,6 +13,7 @@ export type Filter = {
};
export type FilterGroup = {
id: string;
operator: 'and' | 'or';
filters: Filter[];
};

2
mailpoet/assets/js/src/automation/editor/components/filters/list.tsx
View File

@@ -55,7 +55,7 @@ export function FiltersList(): JSX.Element | null {
{groups.map((group) =>
group.filters.map((filter) => (
<div
key={filter.field_key}
key={filter.id}
className="mailpoet-automation-filters-list-item"
>
<div className="mailpoet-automation-filters-list-item-content">

11
mailpoet/lib/Automation/Engine/Data/Filter.php
View File

@@ -3,6 +3,9 @@
namespace MailPoet\Automation\Engine\Data;
class Filter {
/** @var string */
private $id;
/** @var string */
private $fieldType;
@@ -16,17 +19,23 @@ class Filter {
private $args;
public function __construct(
string $id,
string $fieldType,
string $fieldKey,
string $condition,
array $args
) {
$this->id = $id;
$this->fieldType = $fieldType;
$this->fieldKey = $fieldKey;
$this->condition = $condition;
$this->args = $args;
}
public function getId(): string {
return $this->id;
}
public function getFieldType(): string {
return $this->fieldType;
}
@@ -45,6 +54,7 @@ class Filter {
public function toArray(): array {
return [
'id' => $this->id,
'field_type' => $this->fieldType,
'field_key' => $this->fieldKey,
'condition' => $this->condition,
@@ -54,6 +64,7 @@ class Filter {
public static function fromArray(array $data): self {
return new self(
$data['id'],
$data['field_type'],
$data['field_key'],
$data['condition'],

11
mailpoet/lib/Automation/Engine/Data/FilterGroup.php
View File

@@ -6,6 +6,9 @@ class FilterGroup {
public const OPERATOR_AND = 'and';
public const OPERATOR_OR = 'or';
/** @var string */
private $id;
/** @var string */
private $operator;
@@ -13,13 +16,19 @@ class FilterGroup {
private $filters;
public function __construct(
string $id,
string $operator,
array $filters
) {
$this->id = $id;
$this->operator = $operator;
$this->filters = $filters;
}
public function getId(): string {
return $this->id;
}
public function getOperator(): string {
return $this->operator;
}
@@ -30,6 +39,7 @@ class FilterGroup {
public function toArray(): array {
return [
'id' => $this->id,
'operator' => $this->operator,
'filters' => array_map(function (Filter $filter): array {
return $filter->toArray();
@@ -39,6 +49,7 @@ class FilterGroup {
public static function fromArray(array $data): self {
return new self(
$data['id'],
$data['operator'],
array_map(function (array $filter) {
return Filter::fromArray($filter);

2
mailpoet/lib/Automation/Engine/Validation/AutomationSchema.php
View File

@@ -55,6 +55,7 @@ class AutomationSchema {
$operatorSchema = Builder::string()->pattern('^and|or$')->required();
$filterSchema = Builder::object([
'id' => Builder::string()->required(),
'field_type' => Builder::string()->required(),
'field_key' => Builder::string()->required(),
'condition' => Builder::string()->required(),
@@ -62,6 +63,7 @@ class AutomationSchema {
]);
$filterGroupSchema = Builder::object([
'id' => Builder::string()->required(),
'operator' => $operatorSchema,
'filters' => Builder::array($filterSchema)->minItems(1)->required(),
]);

8
mailpoet/tests/integration/Automation/Engine/Control/TriggerHandlerTest.php
View File

@@ -173,8 +173,8 @@ class TriggerHandlerTest extends \MailPoetTest {
// automation that doesn't match segments filter
$unknownId = $segment->getId() + 1;
$filter = new Filter('enum_array', 'mailpoet:subscriber:segments', 'matches-any-of', ['value' => [$unknownId]]);
$filters = new Filters('and', [new FilterGroup('and', [$filter])]);
$filter = new Filter('f1', 'enum_array', 'mailpoet:subscriber:segments', 'matches-any-of', ['value' => [$unknownId]]);
$filters = new Filters('and', [new FilterGroup('g1', 'and', [$filter])]);
$automation = $this->tester->createAutomation(
'Will not run',
new Step('trigger', Step::TYPE_TRIGGER, $trigger->getKey(), [], [], $filters)
@@ -185,8 +185,8 @@ class TriggerHandlerTest extends \MailPoetTest {
$this->assertCount(0, $this->automationRunStorage->getAutomationRunsForAutomation($automation));
// matches segments filter
$filter = new Filter('enum_array', 'mailpoet:subscriber:segments', 'matches-any-of', ['value' => [$segment->getId()]]);
$filters = new Filters('and', [new FilterGroup('and', [$filter])]);
$filter = new Filter('f1', 'enum_array', 'mailpoet:subscriber:segments', 'matches-any-of', ['value' => [$segment->getId()]]);
$filters = new Filters('and', [new FilterGroup('g1', 'and', [$filter])]);
$automation = $this->tester->createAutomation(
'Will run',
new Step('trigger', Step::TYPE_TRIGGER, $trigger->getKey(), [], [], $filters)

14
mailpoet/tests/unit/Automation/Engine/Control/FilterHandlerTest.php
View File

@@ -25,7 +25,7 @@ use MailPoetUnitTest;
class FilterHandlerTest extends MailPoetUnitTest {
/** @dataProvider dataForTestItFilters */
public function testItFilters(array $stepFilters, bool $expectation): void {
$filters = new Filters('and', [new FilterGroup('and', $stepFilters)]);
$filters = new Filters('and', [new FilterGroup('g1', 'and', $stepFilters)]);
$step = new Step('step', Step::TYPE_TRIGGER, 'test:step', [], [], $filters);
$subject = $this->createSubject('subject', [
new Field('test:field-string', Field::TYPE_STRING, 'Test field string', function () {
@@ -70,8 +70,8 @@ class FilterHandlerTest extends MailPoetUnitTest {
// matching
[
[
new FilterData(Field::TYPE_STRING, 'test:field-string', '', ['value' => 'abc']),
new FilterData(Field::TYPE_INTEGER, 'test:field-integer', '', ['value' => 123]),
new FilterData('f1', Field::TYPE_STRING, 'test:field-string', '', ['value' => 'abc']),
new FilterData('f2', Field::TYPE_INTEGER, 'test:field-integer', '', ['value' => 123]),
],
true,
],
@@ -79,15 +79,15 @@ class FilterHandlerTest extends MailPoetUnitTest {
// not matching
[
[
new FilterData(Field::TYPE_INTEGER, 'test:field-integer', '', ['value' => 999]),
new FilterData('f1', Field::TYPE_INTEGER, 'test:field-integer', '', ['value' => 999]),
],
false,
],
[
[
new FilterData(Field::TYPE_STRING, 'test:field-string', '', ['value' => 'abc']),
new FilterData(Field::TYPE_INTEGER, 'test:field-integer', '', ['value' => 999]),
new FilterData(Field::TYPE_BOOLEAN, 'test:field-boolean', '', ['value' => true]),
new FilterData('f1', Field::TYPE_STRING, 'test:field-string', '', ['value' => 'abc']),
new FilterData('f2', Field::TYPE_INTEGER, 'test:field-integer', '', ['value' => 999]),
new FilterData('f3', Field::TYPE_BOOLEAN, 'test:field-boolean', '', ['value' => true]),
],
false,
],

6
mailpoet/tests/unit/Automation/Engine/Validation/AutomationRules/ValidStepFiltersRuleTest.php
View File

@@ -31,7 +31,7 @@ class ValidStepFiltersRuleTest extends AutomationRuleTest {
'validate' => Expected::once(),
]);
$filters = [new FilterData('string', 'test:key', 'is', ['value' => 'test'])];
$filters = [new FilterData('f1', 'string', 'test:key', 'is', ['value' => 'test'])];
$rule = new ValidStepFiltersRule($registry, $validator);
$automation = $this->getAutomation($filters);
(new AutomationWalker())->walk($automation, [$rule]);
@@ -43,14 +43,14 @@ class ValidStepFiltersRuleTest extends AutomationRuleTest {
'validate' => Expected::never(),
]);
$filters = [new FilterData('string', 'test:key', 'is', ['value' => 'test'])];
$filters = [new FilterData('f1', 'string', 'test:key', 'is', ['value' => 'test'])];
$rule = new ValidStepFiltersRule($registry, $validator);
$automation = $this->getAutomation($filters);
(new AutomationWalker())->walk($automation, [$rule]);
}
private function getAutomation(array $filters): Automation {
$filters = new Filters('and', [new FilterGroup('and', $filters)]);
$filters = new Filters('and', [new FilterGroup('g1', 'and', $filters)]);
return $this->make(Automation::class, [
'getSteps' => [
'root' => new Step('root', 'root', 'core:root', [], [], $filters),

2
mailpoet/tests/unit/Automation/Integration/Core/Filters/EnumArrayFilterTest.php
View File

@@ -102,6 +102,6 @@ class EnumArrayFilterTest extends MailPoetUnitTest {
private function matchesFilter(string $condition, $filterValue, $value): bool {
$filter = new EnumArrayFilter();
return $filter->matches(new Filter('string', '', $condition, ['value' => $filterValue]), $value);
return $filter->matches(new Filter('f1', 'string', '', $condition, ['value' => $filterValue]), $value);
}
}

2
mailpoet/tests/unit/Automation/Integration/Core/Filters/StringFilterTest.php
View File

@@ -166,6 +166,6 @@ class StringFilterTest extends MailPoetUnitTest {
private function matchesFilter(string $condition, $filterValue, $value): bool {
$filter = new StringFilter();
return $filter->matches(new Filter('string', '', $condition, ['value' => $filterValue]), $value);
return $filter->matches(new Filter('f1', 'string', '', $condition, ['value' => $filterValue]), $value);
}
}