Merge branch 'develop' into 2002.1

Author: oshmyheliuk

.travis.yml

@@ -54,6 +54,7 @@ install:
   - composer config github-oauth.github.com ${GITHUB_TOKEN}
   - if [ -n "${MCC_VERSION}" ]; then composer config repositories.mcc git [email protected]:magento/magento-cloud-components.git && composer require "magento/magento-cloud-components:${MCC_VERSION}" --no-update; fi;
   - if [ -n "${MCD_VERSION}" ]; then composer config repositories.mcd git [email protected]:magento/magento-cloud-docker.git && composer require "magento/magento-cloud-docker:${MCD_VERSION}" --no-update; fi;
+  - if [ -n "${MCD_VERSION_71}" ] && [ $TRAVIS_PHP_VERSION == "7.1" ]; then composer config repositories.mcd git [email protected]:magento/magento-cloud-docker.git && composer require "magento/magento-cloud-docker:${MCD_VERSION_71}" --no-update; fi;
   - if [ -n "${MCP_VERSION}" ]; then composer config repositories.mcp git [email protected]:magento/magento-cloud-patches.git && composer require "magento/magento-cloud-patches:${MCP_VERSION}" --no-update; fi;
   - if [ -n "${MQP_VERSION}" ]; then composer config repositories.mqp git [email protected]:magento/quality-patches.git && composer require "magento/quality-patches:${MQP_VERSION}" --no-update; fi;
   - composer update -n --no-suggest

config/schema.yaml

@@ -668,6 +668,23 @@ variables:
               - MC-31387
               - MDVA-4567
               - MC-45634
+  REMOTE_STORAGE:
+    description: Configures remote storage credentials.
+    magento_version: '>=2.4.2'
+    type: array
+    stages:
+      - deploy
+    default:
+      deploy: []
+    examples:
+      - stage:
+          deploy:
+            REMOTE_STORAGE:
+              adater: aws_s3
+              prefix: test-prefix
+              config:
+                region: us-east-1
+                bucket: test-bucket
 
   # Environment variables
   ENV_RELATIONSHIPS:

dist/error-codes.md

@@ -150,6 +150,7 @@ Warning errors indicate a problem with the Magento Commerce Cloud project config
 | 2025 | install-update:split-db | Slave connection not set. |  |
 | 2026 | pre-deploy:restore-writable-dirs | Failed to restore some data generated during the build phase to the mounted directories | Check the `cloud.log` for more information. |
 | 2027 | validate-config:mage-mode-variable | Mode value for MAGE_MODE environment variable not supported | Remove the MAGE_MODE environment variable, or change its value to "production". Magento Cloud supports "production" mode only. |
+| 2028 | remote-storage | Remote storage could not be enabled. | Verify remote storage credentials |
 
 ### Post-deploy stage
 

scenario/deploy.xml

@@ -1,5 +1,6 @@
 <?xml version="1.0"?>
 <scenario xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:ece-tools:config/scenario.xsd">
+    <step name="php-opcache-reset" type="Magento\MagentoCloud\Step\Deploy\PhpOpcacheReset" priority="50"/>
     <step name="remove-deploy-failed-flag" type="Magento\MagentoCloud\Step\Deploy\RemoveDeployFailedFlag" priority="100"/>
     <step name="pre-deploy" type="Magento\MagentoCloud\Step\Deploy\PreDeploy" priority="200">
         <arguments>
@@ -126,6 +127,7 @@
             </argument>
         </arguments>
     </step>
+    <step name="remote-storage" type="Magento\MagentoCloud\Step\Deploy\RemoteStorage" priority="1250"/>
     <step name="disable-maintenance-mode" type="Magento\MagentoCloud\Step\DisableMaintenanceMode" priority="1300"/>
     <onFail>
         <action name="create-deploy-failed-flag" type="Magento\MagentoCloud\OnFail\Action\CreateDeployFailedFlag" priority="100"/>

src/App/Error.php

@@ -132,6 +132,7 @@ class Error
     public const WARN_SLAVE_CONNECTION_NOT_SET = 2025;
     public const WARN_COPY_MOUNTED_DIRS_FAILED = 2026;
     public const WARN_NOT_SUPPORTED_MAGE_MODE = 2027;
+    public const WARN_REMOTE_STORAGE_CANNOT_BE_ENABLED = 2028;
 
     /**
      * Post-deploy

src/Config/RemoteStorage.php

@@ -0,0 +1,53 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\MagentoCloud\Config;
+
+use Magento\MagentoCloud\Config\Stage\DeployInterface;
+
+/**
+ * Config for remote storage.
+ */
+class RemoteStorage
+{
+    /**
+     * @var DeployInterface
+     */
+    private $deployConfig;
+
+    /**
+     * @param DeployInterface $deployConfig
+     */
+    public function __construct(DeployInterface $deployConfig)
+    {
+        $this->deployConfig = $deployConfig;
+    }
+
+    /**
+     * @return string
+     */
+    public function getDriver(): string
+    {
+        return (string)($this->deployConfig->get(DeployInterface::VAR_REMOTE_STORAGE)['driver'] ?? '');
+    }
+
+    /**
+     * @return string
+     */
+    public function getPrefix(): string
+    {
+        return (string)($this->deployConfig->get(DeployInterface::VAR_REMOTE_STORAGE)['prefix'] ?? '');
+    }
+
+    /**
+     * @return string[]
+     */
+    public function getConfig(): array
+    {
+        return (array)($this->deployConfig->get(DeployInterface::VAR_REMOTE_STORAGE)['config'] ?? []);
+    }
+}

src/Config/Stage/DeployInterface.php

@@ -29,6 +29,7 @@ interface DeployInterface extends StageConfigInterface
     public const VAR_CLEAN_STATIC_FILES = 'CLEAN_STATIC_FILES';
     public const VAR_UPDATE_URLS = 'UPDATE_URLS';
     public const VAR_FORCE_UPDATE_URLS = 'FORCE_UPDATE_URLS';
+    public const VAR_REMOTE_STORAGE = 'REMOTE_STORAGE';
 
     /**
      * The variable responsible to set lock provider for Magento 2.2.5 and higher.

src/Service/Php.php

@@ -31,4 +31,24 @@ public function getVersion(): string
     {
         return $this->getConfiguration()['version'];
     }
+
+    /**
+     * Checks if opcache is enabled for PHP CLI
+     *
+     * @return bool
+     */
+    public function isOpcacheCliEnabled(): bool
+    {
+        return (bool)ini_get('opcache.enable_cli');
+    }
+
+    /**
+     * Resets the contents of the opcache
+     *
+     * @return bool
+     */
+    public function resetOpcache(): bool
+    {
+        return opcache_reset();
+    }
 }

src/Step/Deploy/InstallUpdate/Install/Setup/InstallCommandFactory.php

@@ -21,6 +21,7 @@
 use Magento\MagentoCloud\Service\ServiceException;
 use Magento\MagentoCloud\Util\UrlManager;
 use Magento\MagentoCloud\Util\PasswordGenerator;
+use Magento\MagentoCloud\Config\RemoteStorage;
 
 /**
  * Generates command for magento installation
@@ -78,6 +79,11 @@ class InstallCommandFactory
      */
     private $elasticSearch;
 
+    /**
+     * @var RemoteStorage
+     */
+    private $remoteStorage;
+
     /**
      * @param UrlManager $urlManager
      * @param AdminDataInterface $adminData
@@ -88,6 +94,9 @@ class InstallCommandFactory
      * @param DbConfig $dbConfig
      * @param MagentoVersion $magentoVersion
      * @param ElasticSearch $elasticSearch
+     * @param RemoteStorage $remoteStorage
+     *
+     * @SuppressWarnings(PHPMD.ExcessiveParameterList)
      */
     public function __construct(
         UrlManager $urlManager,
@@ -98,7 +107,8 @@ public function __construct(
         ElasticSuite $elasticSuite,
         DbConfig $dbConfig,
         MagentoVersion $magentoVersion,
-        ElasticSearch $elasticSearch
+        ElasticSearch $elasticSearch,
+        RemoteStorage $remoteStorage
     ) {
         $this->urlManager = $urlManager;
         $this->adminData = $adminData;
@@ -109,6 +119,7 @@ public function __construct(
         $this->dbConfig = $dbConfig;
         $this->magentoVersion = $magentoVersion;
         $this->elasticSearch = $elasticSearch;
+        $this->remoteStorage = $remoteStorage;
     }
 
     /**
@@ -127,7 +138,8 @@ public function create(): string
             $options = array_replace(
                 $this->getBaseOptions(),
                 $this->getAdminOptions(),
-                $this->getEsOptions()
+                $this->getEsOptions(),
+                $this->getRemoteStorageOptions()
             );
         } catch (GenericException $exception) {
             throw new ConfigException($exception->getMessage(), $exception->getCode(), $exception);
@@ -237,6 +249,39 @@ private function getEsOptions(): array
         return $options;
     }
 
+    /**
+     * Provides install options for remote storage.
+     *
+     * @return array
+     * @throws UndefinedPackageException
+     * @throws ConfigException
+     */
+    private function getRemoteStorageOptions(): array
+    {
+        $options = [];
+
+        if ($this->magentoVersion->isGreaterOrEqual('2.4.2') && $this->remoteStorage->getDriver()) {
+            $config = $this->remoteStorage->getConfig();
+
+            $options['--remote-storage-driver'] = $this->remoteStorage->getDriver();
+            $options['--remote-storage-prefix'] = $this->remoteStorage->getPrefix();
+
+            if (empty($config['bucket']) || empty($config['region'])) {
+                throw new ConfigException('Bucket and region are required configurations');
+            }
+
+            $options['--remote-storage-bucket'] = $config['bucket'];
+            $options['--remote-storage-region'] = $config['region'];
+
+            if (isset($config['key'], $config['secret'])) {
+                $options['--remote-storage-key'] = $config['key'];
+                $options['--remote-storage-secret'] = $config['secret'];
+            }
+        }
+
+        return $options;
+    }
+
     /**
      * Returns instance of ConnectionInterface
      *

src/Step/Deploy/PhpOpcacheReset.php

@@ -0,0 +1,51 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\MagentoCloud\Step\Deploy;
+
+use Magento\MagentoCloud\Service\Php;
+use Magento\MagentoCloud\Step\StepInterface;
+use Psr\Log\LoggerInterface;
+
+/**
+ * Flushes the contents of the opcache if the PHP CLI opcache is enabled
+ */
+class PhpOpcacheReset implements StepInterface
+{
+    /**
+     * @var LoggerInterface
+     */
+    private $logger;
+
+    /**
+     * @var Php
+     */
+    private $php;
+
+    /**
+     * @param LoggerInterface $logger
+     * @param Php $php
+     */
+    public function __construct(
+        LoggerInterface $logger,
+        Php $php
+    ) {
+        $this->logger = $logger;
+        $this->php = $php;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function execute()
+    {
+        if ($this->php->isOpcacheCliEnabled()) {
+            $this->logger->notice('Reset the contents of the opcache');
+            $this->php->resetOpcache();
+        }
+    }
+}