Initial commit

vpodorozh · vpodorozh · commit 5f8b3ea96ef9 · 2022-11-02T10:27:57.000+01:00
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,4 @@
+.idea
+.env
+.editorconfig
+
diff --git a/LICENSE.txt b/LICENSE.txt
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Vladyslav Podorozhnyi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.md b/README.md
@@ -0,0 +1,73 @@
+---
+title: Magento CLI Constructor Arg Auto Proxy  
+keywords: Magento, CLI, Proxy, ObjectManager  
+author: Vlad Podorozhnyi  
+send_questions_to: vpodorozh@gmail.com | vlad.podorozhnyi@run-as-root.sh  
+category: System
+---
+![Magento 2](https://img.shields.io/badge/Magento-2.4.*-orange)
+![PHP](https://img.shields.io/badge/php-7.4-blue)
+![composer](https://shields.io/badge/composer-v2-darkgreen)
+![packagist](https://img.shields.io/badge/packagist-f28d1a)
+
+<br />
+<div align="center">
+  <img src="images/logo.png" alt="Logo" width="100" height="80">
+
+<h3 align="center">Magento 2 - Auto Proxy to CLI class arguments</h3>
+
+  <p align="center">
+    Automatically injects Proxy for any argument defined in CLI command class constructor.
+    <br />
+  </p>
+</div>
+
+## About The Project
+
+### Purpose:
+* speed up `php bin/magento` command execution;
+* eliminate `.flag table not found` issues while installation of your project with fresh database (usually used with integration tests) - caused by not using Proxy in CLI of 3rd parties.
+
+## Getting Started
+
+### Prerequisites
+* Magento v2.4.* and upper
+* composer v2 and upper
+
+### Structure
+* magento2-component - see [README.md](component/README.md)
+* library - see [README.md](lib/README.md)
+
+### Installation
+
+```bash
+composer req vpodorozh/magento-cli-auto-proxy:*
+```
+
+## Roadmap
+
+- [x] MVP release
+- [x] Documentation
+- [ ] PHP 8 support (mostl likely supported already :suspect: )
+- [ ] Unit tests coverage
+- [ ] Static tests coverage
+  - [ ] php linting
+  - [ ] phpcs
+  - [ ] phpmd
+  - [ ] phpstan
+- [ ] Integration tests coverage
+- [ ] Pipelines tests automation
+    - [ ] Static tests
+    - [ ] Unit tests
+    - [ ] Integration tests
+    - [ ] Magento multiversions tests
+
+## License
+
+Distributed under the MIT License. See `LICENSE.txt` for more information.
+
+## Contact
+
+_Vlad Podorozhnyi_  
+Twitter: [![@vpodorozh](https://img.shields.io/twitter/url?style=social&url=https%3A%2F%2Ftwitter.com%2Fvpodorozh)](https://twitter.com/vpodorozh)  
+Email: `vpodorozh@gmail.com` | `vlad.podorozhnyi@run-as-root.sh`
diff --git a/component/README.md b/component/README.md
@@ -0,0 +1,15 @@
+---
+title: [component] CLI Constructor Arg Auto Proxy  
+keywords: CLI, Proxy, ObjectManager  
+author: Vlad Podorozhnyi  
+send_questions_to: vpodorozh@gmail.com | vlad.podorozhnyi@run-as-root.sh  
+category: System  
+---
+![Magento 2](https://img.shields.io/badge/Magento-2.4.*-orange)
+![composer](https://shields.io/badge/composer-v2-darkgreen)
+![packagist](https://img.shields.io/badge/packagist-f28d1a)
+
+## \[magento2-component\] Cli Constructor Arg Auto Proxy Component
+
+
+Magneto 2 component that provides global DI config via `app/etc/di.xml` to create entry point for configuration enrichment.
diff --git a/component/app/etc/cli_arg_auto_proxy_di.xml b/component/app/etc/cli_arg_auto_proxy_di.xml
@@ -0,0 +1,5 @@
+<?xml version="1.0"?>
+<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:ObjectManager/etc/config.xsd">
+    <preference for="Magento\Framework\ObjectManager\Config\Reader\Dom"
+                type="Vpodorozh\CliConstructorArgAutoProxy\Preference\Framework\ObjectManager\Config\Reader\Dom\Interceptor" />
+</config>
diff --git a/composer.json b/composer.json
@@ -0,0 +1,24 @@
+{
+  "name": "vpodorozh/magento-cli-auto-proxy",
+  "description": "Makes all Magento CLI commands construct dependencies be injected as Proxy.",
+  "type": "magento2-component",
+  "require": {
+    "magento/framework": "*"
+  },
+  "require-dev": {
+    "roave/security-advisories": "dev-latest"
+  },
+  "autoload": {
+    "psr-4": {
+      "Vpodorozh\\CliConstructorArgAutoProxy\\": "lib"
+    }
+  },
+  "extra": {
+    "map": [
+      [
+        "component/app/etc/cli_arg_auto_proxy_di.xml",
+        "app/etc/cli_arg_auto_proxy_di.xml"
+      ]
+    ]
+  }
+}
diff --git a/images/logo.png b/images/logo.png
diff --git a/lib/Enum/ProxyClassEntityInterfaceEnum.php b/lib/Enum/ProxyClassEntityInterfaceEnum.php
@@ -0,0 +1,9 @@
+<?php
+declare(strict_types=1);
+
+namespace Vpodorozh\CliConstructorArgAutoProxy\Enum;
+
+interface ProxyClassEntityInterfaceEnum
+{
+    public const PROXY_CLASS_SUFFIX = '\Proxy';
+}
diff --git a/lib/Exception/ClassIsNotEligibleForProxyException.php b/lib/Exception/ClassIsNotEligibleForProxyException.php
@@ -0,0 +1,9 @@
+<?php
+declare(strict_types=1);
+
+namespace Vpodorozh\CliConstructorArgAutoProxy\Exception;
+
+use Exception;
+
+class ClassIsNotEligibleForProxyException extends Exception
+{}
diff --git a/lib/Mapper/ProxiedConstructArgsToDiConfigMapper.php b/lib/Mapper/ProxiedConstructArgsToDiConfigMapper.php
@@ -0,0 +1,18 @@
+<?php
+declare(strict_types=1);
+
+namespace Vpodorozh\CliConstructorArgAutoProxy\Mapper;
+
+class ProxiedConstructArgsToDiConfigMapper
+{
+    public function map(array $diConfig, string $instanceClassName, array $proxiedConstructArgsConfig): array
+    {
+        $cliInstanceConfig = $diConfig[$instanceClassName] ?? [];
+        $cliInstanceConfig['arguments'] = isset($cliInstanceConfig['arguments']) ?
+            array_merge($cliInstanceConfig['arguments'], $proxiedConstructArgsConfig) : $proxiedConstructArgsConfig;
+
+        $diConfig[$instanceClassName] = $cliInstanceConfig;
+
+        return $diConfig;
+    }
+}
diff --git a/lib/Plugin/Dom/EnrichCliConfigWithProxyPlugin.php b/lib/Plugin/Dom/EnrichCliConfigWithProxyPlugin.php
@@ -0,0 +1,39 @@
+<?php
+declare(strict_types=1);
+
+namespace Vpodorozh\CliConstructorArgAutoProxy\Plugin\Dom;
+
+use Psr\Log\LoggerInterface;
+use ReflectionException;
+use Vpodorozh\CliConstructorArgAutoProxy\Service\EnrichCliConfigWithProxyService;
+
+class EnrichCliConfigWithProxyPlugin
+{
+    private EnrichCliConfigWithProxyService $enrichCliConfigWithProxyService;
+    private LoggerInterface $logger;
+
+    public function __construct(
+        EnrichCliConfigWithProxyService $enrichCliConfigWithProxyService,
+        LoggerInterface $logger
+    ) {
+        $this->enrichCliConfigWithProxyService = $enrichCliConfigWithProxyService;
+        $this->logger = $logger;
+    }
+
+    /**
+     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
+     */
+    public function afterRead($subject, array $result, ?string $scope): array
+    {
+        if ($scope !== 'global') {
+            return $result;
+        }
+
+        try {
+            return $this->enrichCliConfigWithProxyService->execute($result);
+        } catch (ReflectionException $exception) {
+            $this->logger->error((string) $exception);
+            return $result;
+        }
+    }
+}
diff --git a/lib/Preference/Framework/ObjectManager/Config/Reader/Dom/Interceptor.php b/lib/Preference/Framework/ObjectManager/Config/Reader/Dom/Interceptor.php
@@ -0,0 +1,29 @@
+<?php
+declare(strict_types=1);
+
+namespace Vpodorozh\CliConstructorArgAutoProxy\Preference\Framework\ObjectManager\Config\Reader\Dom;
+
+use Magento\Framework\App\ObjectManager;
+use Magento\Framework\ObjectManager\Config\Reader\Dom as OriginDom;
+use Vpodorozh\CliConstructorArgAutoProxy\Plugin\Dom\EnrichCliConfigWithProxyPlugin;
+
+class Interceptor extends OriginDom
+{
+    public function read($scope = null)
+    {
+        $result = parent::read($scope);
+
+        return $this->runPlugin($result, $scope);
+    }
+
+    /**
+     * Workaround for plugin execution.
+     * You can not define plugin over Dom config reader, as it is created before Magento plugin functionality starts.
+     */
+    private function runPlugin(array $result, ?string $scope): array
+    {
+        /** @var EnrichCliConfigWithProxyPlugin $enrichService */
+        $enrichService = ObjectManager::getInstance()->get(EnrichCliConfigWithProxyPlugin::class);
+        return $enrichService->afterRead($this, $result, $scope);
+    }
+}
diff --git a/lib/README.md b/lib/README.md
@@ -0,0 +1,62 @@
+---
+title: [library] CLI Constructor Arg Auto Proxy  
+keywords: CLI, Proxy, ObjectManager  
+author: Vlad Podorozhnyi  
+send_questions_to: vpodorozh@gmail.com | vlad.podorozhnyi@run-as-root.sh  
+category: System  
+---
+![Magento 2](https://img.shields.io/badge/Magento-2.4.*-orange)
+![PHP](https://img.shields.io/badge/php-7.4-blue)
+![composer](https://shields.io/badge/composer-v2-darkgreen)
+![packagist](https://img.shields.io/badge/packagist-f28d1a)
+
+## **\[library\] Cli Constructor Arg Auto Proxy**
+
+## Features
+
+### Auto add proxies as arguments to CLI command classes
+
+Automatically injects Proxy for any argument defined in CLI command class constructor.  
+Entry point of functionality is based on DI config reader that is used in both cases - developer and production modes.
+
+## Technical Specification
+
+### Plugins
+
+#### `\Vpodorozh\CliConstructorArgAutoProxy\Plugin\Dom\EnrichCliConfigWithProxyPlugin`
+* responsible for enriching DI config with Proxies for CLI command constructor arguments;
+* executed after DI config reading;
+* plugin is executed in not trivial way - via preference on DOM config reader of DI (see section bellow for more details) 
+* Caller class: `\Vpodorozh\CliConstructorArgAutoProxy\Preference\Framework\ObjectManager\Config\Reader\Dom\Interceptor`
+
+### Preferences
+
+| source-class                                       | custom-class                                                          |
+|----------------------------------------------------|-----------------------------------------------------------------------|
+| Magento\Framework\ObjectManager\Config\Reader\Dom  | ...\Preference\Framework\ObjectManager\Config\Reader\Dom\Interceptor  |
+
+
+#### `\Vpodorozh\CliConstructorArgAutoProxy\Preference\Framework\ObjectManager\Config\Reader\Dom\Interceptor`
+Workaround for plugin execution.  
+This override has the same purpose as regular Magento 2 Interceptors - hook for calling plugins.  
+It is not possible to define plugin over DOM config reader, as it is created before Magento plugin functionality starts. 
+Preference is the only way to hook in.
+
+### Services
+
+#### `\Vpodorozh\CliConstructorArgAutoProxy\Service\EnrichCliConfigWithProxyService`
+Enrich provided DI config with proxies for CLI class commands only.
+
+#### `\Vpodorozh\CliConstructorArgAutoProxy\Service\GetProxiedConstructArgsConfigService`
+Receives CLI command constructor arguments types and reformat them to Proxy types.  
+Using `IsClassEligibleForProxyValidator` to determine is class eligible to be Proxied.
+
+### Validator
+
+#### `\Vpodorozh\CliConstructorArgAutoProxy\Validator\IsClassEligibleForProxyValidator`
+Check is Proxy applicable for this specific class.  
+
+### Mapper
+
+#### `\Vpodorozh\CliConstructorArgAutoProxy\Mapper\ProxiedConstructArgsToDiConfigMapper`
+Adds Proxy DI configs for specific CLI class command to DI configs pool.
diff --git a/lib/Service/EnrichCliConfigWithProxyService.php b/lib/Service/EnrichCliConfigWithProxyService.php
@@ -0,0 +1,56 @@
+<?php
+declare(strict_types=1);
+
+namespace Vpodorozh\CliConstructorArgAutoProxy\Service;
+
+use Magento\Framework\Code\Reader\ClassReaderInterface;
+use Magento\Framework\Console\CommandListInterface;
+use ReflectionException;
+use Vpodorozh\CliConstructorArgAutoProxy\Mapper\ProxiedConstructArgsToDiConfigMapper;
+
+class EnrichCliConfigWithProxyService
+{
+    private ClassReaderInterface $classReader;
+    private GetProxiedConstructArgsConfigService $argsConfigService;
+    private ProxiedConstructArgsToDiConfigMapper $diConfigMapper;
+
+    public function __construct(
+        GetProxiedConstructArgsConfigService $argsConfigService,
+        ClassReaderInterface $classReader,
+        ProxiedConstructArgsToDiConfigMapper $diConfigMapper
+    ) {
+        $this->classReader = $classReader;
+        $this->argsConfigService = $argsConfigService;
+        $this->diConfigMapper = $diConfigMapper;
+    }
+
+    /**
+     * @throws ReflectionException
+     */
+    public function execute(array $diConfig): array
+    {
+        $cliCommandsList = $diConfig[CommandListInterface::class]['arguments']['commands'] ?? null;
+
+        if ($cliCommandsList === null) {
+            return $diConfig;
+        }
+
+        foreach ($cliCommandsList as $cliCommandConfig) {
+
+            $cliInstanceClassName = $cliCommandConfig['instance'] ?? null;
+            if ($cliInstanceClassName === null) {
+                continue;
+            }
+
+            $constructConfig = $this->classReader->getConstructor($cliInstanceClassName);
+            if ($constructConfig === null) {
+                continue;
+            }
+
+            $proxiedConstructArgsConfig = $this->argsConfigService->get($constructConfig);
+            $diConfig = $this->diConfigMapper->map($diConfig, $cliInstanceClassName, $proxiedConstructArgsConfig);
+        }
+
+        return $diConfig;
+    }
+}
diff --git a/lib/Service/GetProxiedConstructArgsConfigService.php b/lib/Service/GetProxiedConstructArgsConfigService.php
diff --git a/lib/Validator/IsClassEligibleForProxyValidator.php b/lib/Validator/IsClassEligibleForProxyValidator.php

-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +.idea
 +.env
 +.editorconfig
++