Use constructor property promotion in module Sales Rule #37228

leonhelmus · 2023-03-16T14:52:03Z

Description (*)

Replace allmost all properties with constructor property promotion in module Sales rule: https://stitcher.io/blog/constructor-promotion-in-php-8

Readable code
Make Magento less complex by removing properties which take up a lot of lines.
Imported all classes to make code more readable.

I think the code would be a lot cleaner if all modules start using constructor promotions, since of 2.4.6 php 7.4 is dropped we can now make use of it. So let's start on it right now.

Related Pull Requests

Fixed Issues (if relevant)

Fixes magento/magento2#<issue_number>

Manual testing scenarios (*)

...
...

Questions or comments

Contribution checklist (*)

Pull request has a meaningful description of its purpose
All commits are accompanied by meaningful commit messages
All new or changed code is covered with unit/integration tests (if applicable)
README.md files for modified modules are updated and included in the pull request if any README.md predefined sections require an update
All automated tests passed successfully (all builds are green)

Replace allmost all properties with constructor property promotion in module Sales rule: https://stitcher.io/blog/constructor-promotion-in-php-8 * Readable code * Make Magento less complex by removing properties which take up a lot of lines. * Imported all classes to make code more readable. I think the code would be a lot cleaner if all modules start using constructor promotions, since of 2.4.6 php 7.4 is dropped we can now make use of it. So let's start on it right now.

m2-assistant · 2023-03-16T14:52:07Z

Hi @leonhelmus. Thank you for your contribution!
Here are some useful tips on how you can test your changes using Magento test environment.

Add the comment under your pull request to deploy test or vanilla Magento instance:

@magento give me test instance - deploy test instance based on PR changes
@magento give me 2.4-develop instance - deploy vanilla Magento instance

❗ Automated tests can be triggered manually with an appropriate comment:

@magento run all tests - run or re-run all required tests against the PR changes
@magento run <test-build(s)> - run or re-run specific test build(s)
For example: @magento run Unit Tests

<test-build(s)> is a comma-separated list of build names.

Allowed build names are:

Database Compare
Functional Tests CE
Functional Tests EE
Functional Tests B2B
Integration Tests
Magento Health Index
Sample Data Tests CE
Sample Data Tests EE
Sample Data Tests B2B
Static Tests
Unit Tests
WebAPI Tests
Semantic Version Checker

You can find more information about the builds here
ℹ️ Run only required test builds during development. Run all test builds before sending your pull request for review.

For more details, review the Code Contributions documentation.
Join Magento Community Engineering Slack and ask your questions in #github channel.

leonhelmus · 2023-03-16T14:52:34Z

@magento run all tests

magento-automated-testing · 2023-03-16T14:52:44Z

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.

fredden

I didn't make it through all the changed files in this pull request. Please apply the recurring comments to all affected files.

fredden · 2023-05-01T10:26:15Z

app/code/Magento/SalesRule/Block/Widget/Form/Element/Dependence.php

    /**
-     * @param \Magento\Backend\Block\Context $context
-     * @param \Magento\Framework\Json\EncoderInterface $jsonEncoder
-     * @param \Magento\Config\Model\Config\Structure\Element\Dependency\FieldFactory $fieldFactory
+     * @param Context $context
+     * @param EncoderInterface $jsonEncoder
+     * @param FieldFactory $fieldFactory
     * @param array $data
     */
    public function __construct(


This constructor looks useless. Please can you add a code comment to explain why it should exist?

fredden · 2023-05-01T10:29:33Z

app/code/Magento/SalesRule/Cron/AggregateSalesReportCouponsData.php

+        ReportRule $reportRule,
+        ResolverInterface $localeResolver,
+        TimezoneInterface $localeDate


These all look like they should be promoted.

Suggested change

ReportRule $reportRule,

ResolverInterface $localeResolver,

TimezoneInterface $localeDate

protected readonly ReportRule $_reportRule,

protected readonly ResolverInterface $_localeResolver,

protected readonly TimezoneInterface $_localeDate,

fredden · 2023-05-01T10:30:46Z

app/code/Magento/SalesRule/Model/Converter/ToDataModel.php

+        protected readonly ConditionInterfaceFactory $conditionDataFactory,
+        protected readonly RuleLabelInterfaceFactory $ruleLabelFactory,
+        protected readonly DataObjectProcessor $dataObjectProcessor,
+        private ?Json $serializer = null,


The type of this argument has changed by mistake.

Suggested change

private ?Json $serializer = null,

private Json $serializer = null,

fredden · 2023-05-01T10:30:59Z

app/code/Magento/SalesRule/Model/Converter/ToDataModel.php

+        protected readonly RuleLabelInterfaceFactory $ruleLabelFactory,
+        protected readonly DataObjectProcessor $dataObjectProcessor,
+        private ?Json $serializer = null,
+        private ?RuleExtensionFactory $extensionFactory = null


The type of this argument has changed by mistake.

Suggested change

private ?RuleExtensionFactory $extensionFactory = null

private RuleExtensionFactory $extensionFactory = null,

fredden · 2023-05-01T10:32:20Z

app/code/Magento/SalesRule/Model/Coupon/CaptchaConfigProvider.php

+    public function __construct(
+        private readonly StoreManagerInterface $storeManager,
+        private readonly Helper $captchaData,
+        CustomerSession $session


Why not promote this property?

Suggested change

CustomerSession $session

private readonly CustomerSession $session,

fredden · 2023-05-01T10:46:17Z

app/code/Magento/SalesRule/Model/Rule/Condition/Product/Combine.php

-        \Magento\Rule\Model\Condition\Context $context,
-        \Magento\SalesRule\Model\Rule\Condition\Product $ruleConditionProduct,
+        ConditionContext $context,
+        RuleCondProduct $ruleConditionProduct,


Why not promote this property?

Suggested change

RuleCondProduct $ruleConditionProduct,

protected readonly RuleCondProduct $_ruleConditionProd,

fredden · 2023-05-01T10:47:21Z

app/code/Magento/SalesRule/Model/Rule/DataProvider.php

@@ -60,17 +55,16 @@ public function __construct(
        $primaryFieldName,
        $requestFieldName,
        CollectionFactory $collectionFactory,
-        \Magento\Framework\Registry $registry,
-        \Magento\SalesRule\Model\Rule\Metadata\ValueProvider $metadataValueProvider,
+        Registry $registry,


Why not promote this property?

Suggested change

Registry $registry,

protected readonly Registry $coreRegistry,

fredden · 2023-05-01T10:47:58Z

app/code/Magento/SalesRule/Model/Rule/DataProvider.php

        array $meta = [],
        array $data = [],
-        DataPersistorInterface $dataPersistor = null
+        private ?DataPersistorInterface $dataPersistor = null


The type of this argument seems to have changed by mistake.

Suggested change

private ?DataPersistorInterface $dataPersistor = null

private DataPersistorInterface $dataPersistor = null,

fredden · 2023-05-01T10:48:27Z

app/code/Magento/SalesRule/Model/Rule/Metadata/ValueProvider.php

+        protected readonly SearchCriteriaBuilder $searchCriteriaBuilder,
+        protected readonly DataObject $objectConverter,
+        protected readonly RuleFactory $salesRuleFactory,
+        private ?SimpleActionOptionsProvider $simpleActionOptionsProvider = null


The type of this argument seems to have changed by mistake.

Suggested change

private ?SimpleActionOptionsProvider $simpleActionOptionsProvider = null

private SimpleActionOptionsProvider $simpleActionOptionsProvider = null

fredden · 2023-05-01T10:49:10Z

app/code/Magento/SalesRule/Model/RuleRepository.php

+        protected readonly JoinProcessorInterface $extensionAttributesJoinProcessor,
+        protected readonly RuleCollectionFactory $ruleCollectionFactory,
+        protected readonly DataObjectProcessor $dataObjectProcessor,
+        private ?CollectionProcessorInterface $collectionProcessor = null


The type of this property seems to have changed by mistake.

Suggested change

private ?CollectionProcessorInterface $collectionProcessor = null

private CollectionProcessorInterface $collectionProcessor = null

m2-github-services added Partner: Youwe partners-contribution Pull Request is created by Magento Partner labels Mar 16, 2023

m2-community-project bot added the Progress: pending review label Mar 16, 2023

engcom-Bravo added the Priority: P2 A defect with this priority could have functionality issues which are not to expectations. label Mar 23, 2023

fredden reviewed May 1, 2023

View reviewed changes

m2-community-project bot assigned fredden May 1, 2023

m2-community-project bot added Progress: review and removed Progress: pending review labels May 1, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Use constructor property promotion in module Sales Rule #37228

Use constructor property promotion in module Sales Rule #37228

Uh oh!

leonhelmus commented Mar 16, 2023 •

edited

Loading

Uh oh!

m2-assistant bot commented Mar 16, 2023

Uh oh!

leonhelmus commented Mar 16, 2023

Uh oh!

magento-automated-testing bot commented Mar 16, 2023

Uh oh!

fredden left a comment

Uh oh!

fredden May 1, 2023

Uh oh!

fredden May 1, 2023

Uh oh!

fredden May 1, 2023

Uh oh!

fredden May 1, 2023

Uh oh!

fredden May 1, 2023

Uh oh!

fredden May 1, 2023

Uh oh!

fredden May 1, 2023

Uh oh!

fredden May 1, 2023

Uh oh!

fredden May 1, 2023

Uh oh!

fredden May 1, 2023

Uh oh!

Uh oh!

	private ?Json $serializer = null,
	private Json $serializer = null,

	private ?RuleExtensionFactory $extensionFactory = null
	private RuleExtensionFactory $extensionFactory = null,

	CustomerSession $session
	private readonly CustomerSession $session,

	RuleCondProduct $ruleConditionProduct,
	protected readonly RuleCondProduct $_ruleConditionProd,

	Registry $registry,
	protected readonly Registry $coreRegistry,

	private ?DataPersistorInterface $dataPersistor = null
	private DataPersistorInterface $dataPersistor = null,

	private ?SimpleActionOptionsProvider $simpleActionOptionsProvider = null
	private SimpleActionOptionsProvider $simpleActionOptionsProvider = null

	private ?CollectionProcessorInterface $collectionProcessor = null
	private CollectionProcessorInterface $collectionProcessor = null

Use constructor property promotion in module Sales Rule #37228

Are you sure you want to change the base?

Use constructor property promotion in module Sales Rule #37228

Uh oh!

Conversation

leonhelmus commented Mar 16, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description (*)

Related Pull Requests

Fixed Issues (if relevant)

Manual testing scenarios (*)

Questions or comments

Contribution checklist (*)

Uh oh!

m2-assistant bot commented Mar 16, 2023

Uh oh!

leonhelmus commented Mar 16, 2023

Uh oh!

magento-automated-testing bot commented Mar 16, 2023

Uh oh!

fredden left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

leonhelmus commented Mar 16, 2023 •

edited

Loading