Merge pull request #1 from comwrap/initial

Initial commit

Author: wassuupp

Model/Config.php

@@ -0,0 +1,51 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Comwrap\WebapiAsyncObjectValidation\Model;
+
+use Magento\Framework\App\Request\Http as HttpRequest;
+
+class Config
+{
+    public const BULK_PROCESSOR_PATH_REGEXP = "/\/async\/bulk(\\/V.+)/";
+    public const ARRAY_MODE_HEADER_KEY = 'disable-object-validation';
+
+    /** @var HttpRequest */
+    private HttpRequest $request;
+
+    /** @var null|bool */
+    private ?bool $isArrayMode = null;
+
+    /**
+     * @param HttpRequest $request
+     */
+    public function __construct(HttpRequest $request)
+    {
+        $this->request = $request;
+    }
+
+    /**
+     * Check if is bulk api request and header is set
+     *
+     * @return bool
+     */
+    public function isPublishingArrayMode(): bool
+    {
+        if ($this->isArrayMode === null) {
+            $this->isArrayMode =
+                $this->isBulkApiRequest() && $this->request->getHeader(self::ARRAY_MODE_HEADER_KEY);
+        }
+        return $this->isArrayMode;
+    }
+
+    /**
+     * Check if current request is bulk
+     *
+     * @return bool
+     */
+    public function isBulkApiRequest(): bool
+    {
+        return (bool)preg_match(self::BULK_PROCESSOR_PATH_REGEXP, $this->request->getPathInfo());
+    }
+}

Plugin/Magento/Framework/MessageQueue/MessageValidator.php

@@ -0,0 +1,39 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Comwrap\WebapiAsyncObjectValidation\Plugin\Magento\Framework\MessageQueue;
+
+use Comwrap\WebapiAsyncObjectValidation\Model\Config;
+use Magento\Framework\MessageQueue\MessageValidator as OriginMessageValidator;
+
+class MessageValidator
+{
+    /** @var Config */
+    private Config $config;
+
+    /**
+     * @param Config $config
+     */
+    public function __construct(Config $config)
+    {
+        $this->config = $config;
+    }
+
+    /**
+     * Skip validation if array mode is set
+     *
+     * @param OriginMessageValidator $subject
+     * @param \Closure $proceed
+     * @param mixed ...$args
+     * @return void
+     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
+     */
+    public function aroundValidate(OriginMessageValidator $subject, \Closure $proceed, ...$args): void
+    {
+        if ($this->config->isPublishingArrayMode()) {
+            return;
+        }
+        $proceed(...$args);
+    }
+}

Plugin/Magento/Framework/Webapi/ServiceInputProcessor.php

@@ -0,0 +1,46 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Comwrap\WebapiAsyncObjectValidation\Plugin\Magento\Framework\Webapi;
+
+use Comwrap\WebapiAsyncObjectValidation\Model\Config;
+use Magento\Framework\Webapi\ServiceInputProcessor as OriginServiceInputProcessor;
+
+class ServiceInputProcessor
+{
+    /** @var Config */
+    private Config $config;
+
+    /**
+     * @param Config $config
+     */
+    public function __construct(Config $config)
+    {
+        $this->config = $config;
+    }
+
+    /**
+     * Return array if array mode is set
+     *
+     * @param OriginServiceInputProcessor $subject
+     * @param \Closure $proceed
+     * @param string $serviceClassName
+     * @param string $serviceMethodName
+     * @param array $inputArray
+     * @return array
+     */
+    public function aroundProcess(
+        OriginServiceInputProcessor $subject,
+        \Closure $proceed,
+        string $serviceClassName,
+        string $serviceMethodName,
+        array $inputArray
+    ): array
+    {
+        if ($this->config->isPublishingArrayMode()) {
+            return [];
+        }
+        return $proceed($serviceClassName, $serviceMethodName, $inputArray);
+    }
+}

README.md

@@ -1 +1,9 @@
-# Comwrap_WebapiAsyncObjectValidation
+# Comwrap_WebapiAsyncObjectValidation
+
+Increase Bulk API performance, using direct entity publishing as array without creating objects for validation.
+
+## How to use
+
+Extension works for API request to the Bulk API endpoints. Set the custom request header with name 'disable-object-validation'. 
+Value for a header could be any, even empty. If header is set, the extension skips objects creation and validation. 
+These operations take quite long time among the request duration.

composer.json

@@ -0,0 +1,20 @@
+{
+  "name": "comwrap/module-webapi-async-object-validation",
+  "version": "0.1.0",
+  "description": "Increase Bulk API performance, using direct entity publishing as array without creating objects for validation",
+  "type": "magento2-module",
+  "require": {
+    "magento/framework": "^103"
+  },
+  "license": [
+    "Proprietary"
+  ],
+  "autoload": {
+    "files": [
+      "registration.php"
+    ],
+    "psr-4": {
+      "Comwrap\\WebapiAsyncObjectValidation\\": ""
+    }
+  }
+}

etc/module.xml

@@ -0,0 +1,9 @@
+<?xml version="1.0" ?>
+<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xsi:noNamespaceSchemaLocation="urn:magento:framework:Module/etc/module.xsd">
+    <module name="Comwrap_WebapiAsyncObjectValidation">
+        <sequence>
+            <module name="Magento_WebapiAsync"/>
+        </sequence>
+    </module>
+</config>

etc/webapi_rest/di.xml

@@ -0,0 +1,12 @@
+<?xml version="1.0"?>
+<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xsi:noNamespaceSchemaLocation="urn:magento:framework:ObjectManager/etc/config.xsd">
+    <type name="Magento\Framework\MessageQueue\MessageValidator">
+        <plugin name="comwrapWebapiAsyncObjectValidationPluginMagentoFrameworkMessageQueueMessageValidator"
+                type="Comwrap\WebapiAsyncObjectValidation\Plugin\Magento\Framework\MessageQueue\MessageValidator"/>
+    </type>
+    <type name="Magento\Framework\Webapi\ServiceInputProcessor">
+        <plugin name="comwrapWebapiAsyncObjectValidationPluginMagentoFrameworkWebapiServiceInputProcessor"
+                type="Comwrap\WebapiAsyncObjectValidation\Plugin\Magento\Framework\Webapi\ServiceInputProcessor"/>
+    </type>
+</config>

registration.php

@@ -0,0 +1,7 @@
+<?php
+
+declare(strict_types=1);
+
+use Magento\Framework\Component\ComponentRegistrar;
+
+ComponentRegistrar::register(ComponentRegistrar::MODULE, 'Comwrap_WebapiAsyncObjectValidation', __DIR__);