Implementation of Composition Instead of Inhertance in Controllers Magento 2

TheRealHunzik commented 2 years ago

Summary (*)

I am trying to implement Magneto 2 Coding Standard so I found an Article Here -> https://community.magento.com/t5/Magento-DevBlog/Decomposition-of-Magento-Controllers/ba-p/430883

I have changed my frontend And backend Controllers in the same way

Examples (*)

Frontend Controller:


use Magento\Framework\App\Action\HttpGetActionInterface;
use Magento\Framework\Controller\Result\RedirectFactory;

class HomeRedirect implements HttpGetActionInterface
{
    private RedirectFactory $redirectFactory;

    /**
     * @param RedirectFactory $redirectFactory
     */
    public function __construct(
        RedirectFactory $redirectFactory
    ) {
        $this->redirectFactory = $redirectFactory;
    }

    /**
     * Check is Allowed
     * @return bool
     */
    protected function _isAllowed()
    {
        return true;
    }

    public function execute()
    {
        $this->redirectFactory->create()->setPath('dashboard');
    }
}

, in the same way, I am have implemented an admin controller


use Magento\Backend\Model\View\Result\Forward;
use Magento\Framework\App\Action\HttpGetActionInterface;
use Magento\Backend\Model\View\Result\ForwardFactory;

class NewAction implements HttpGetActionInterface
{
    private ForwardFactory $forwardFactory;

    /**
     * @param ForwardFactory $forwardFactory
     */
    public function __construct(
        ForwardFactory $forwardFactory
    ) {
        $this->forwardFactory = $forwardFactory;
    }

    /**
     * @return Forward
     */
    public function execute()
    {
        return $this->forwardFactory->create()->forward('edit');
    }
}

is this the right way to do so

Proposed solution

anyone, please suggest to me any Module in which the composition is implemented on controllers properly, My concern is that, is there any security issue if I implement this of Backend Controllers

Please provide Severity assessment for the Issue as a Reporter. This information will help during the Confirmation and Issue triage processes.

[ ] Severity: S0 - Affects critical data or functionality and leaves users with no workaround.
[ ] Severity: S1 - Affects critical data or functionality and forces users to employ a workaround.
[ ] Severity: S2 - Affects non-critical data or functionality and forces users to employ a workaround.
[ ] Severity: S3 - Affects non-critical data or functionality and does not force users to employ a workaround.
[ ] Severity: S4 - Affects aesthetics, professional look and feel, “quality” or “usability”.

m2-assistant[bot] commented 2 years ago

Hi @TheRealHunzik. Thank you for your report. To speed up processing of this issue, make sure that you provided the following information:

Summary of the issue
Information on your environment
Steps to reproduce
Expected and actual results

Make sure that the issue is reproducible on the vanilla Magento instance following Steps to reproduce. To deploy vanilla Magento instance on our environment, Add a comment to the issue:

@magento give me 2.4-develop instance - upcoming 2.4.x release

For more details, review the Magento Contributor Assistant documentation.

Add a comment to assign the issue: @magento I am working on this

To learn more about issue processing workflow, refer to the Code Contributions.

Join Magento Community Engineering Slack and ask your questions in #github channel.

:warning: According to the Magento Contribution requirements, all issues must go through the Community Contributions Triage process. Community Contributions Triage is a public meeting.

:clock10: You can find the schedule on the Magento Community Calendar page.

:telephone_receiver: The triage of issues happens in the queue order. If you want to speed up the delivery of your contribution, join the Community Contributions Triage session to discuss the appropriate ticket.

:movie_camera: You can find the recording of the previous Community Contributions Triage on the Magento Youtube Channel

:pencil2: Feel free to post questions/proposals/feedback related to the Community Contributions Triage process to the corresponding Slack Channel

ihor-sviziev commented 2 years ago

@lbajsarowicz, maybe you can explain? :)

TheRealHunzik commented 2 years ago

@lbajsarowicz can you please help us to understand?

lbajsarowicz commented 2 years ago

We never had enough time and resources to finish decomposition for Admin Panel. That is why it does not work for Admin

m2-assistant[bot] commented 2 years ago

Hi @engcom-Hotel. Thank you for working on this issue. In order to make sure that issue has enough information and ready for development, please read and check the following instruction: :point_down:

[ ] 1. Verify that issue has all the required information. (Preconditions, Steps to reproduce, Expected result, Actual result).
Details
If the issue has a valid description, the label Issue: Format is valid will be added to the issue automatically. Please, edit issue description if needed, until label Issue: Format is valid appears.
[ ] 2. Verify that issue has a meaningful description and provides enough information to reproduce the issue. If the report is valid, add Issue: Clear Description label to the issue by yourself.
[ ] 3. Add Component: XXXXX label(s) to the ticket, indicating the components it may be related to.
[ ] 4. Verify that the issue is reproducible on 2.4-develop branch
Details
- Add the comment @magento give me 2.4-develop instance to deploy test instance on Magento infrastructure.
- If the issue is reproducible on 2.4-develop branch, please, add the label Reproduced on 2.4.x.
- If the issue is not reproducible, add your comment that issue is not reproducible and close the issue and stop verification process here!
[ ] 5. Add label Issue: Confirmed once verification is complete.
[ ] 6. Make sure that automatic system confirms that report has been added to the backlog.

engcom-Hotel commented 2 years ago

Hi @TheRealHunzik,

Thank you for reporting the issue.

Hope you got the answer to your question. I think you can wait until it is implemented or Documented in Magento.

As of now since there is no action required from our side, we are closing this issue. You can re-open this issue or raise a new one if you still need assistance on this. Similar questions can be raised on various Magento Forums like Magento Community(https://community.magento.com/) or Magento Stack Exchange(https://magento.stackexchange.com/) also.

Thanks

markshust commented 2 years ago

@lbajsarowicz I think the "deprecated" flags should be removed from the admin controller parent classes, since they aren't really deprecated (there is no alternative, and I don't think there are plans for any moving forward at this time).

ihor-sviziev commented 2 years ago

I think it's better to mark this issue as a feature request rather than just close it. What do you think?

markshust commented 2 years ago

@ihor-sviziev if you'd like to build in the ability for backend controllers to be created using composition, yes 👍

markshust commented 2 years ago

@ihor-sviziev I just noticed this issue is still closed, it should have been re-opened as a feature request?

magento / magento2