@scandipwa/magento-scripts 1.16.1 → 2.0.0-alpha.2

package/lib/tasks/php/working_health_check.php

@@ -0,0 +1,85 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+use Magento\Framework\Config\ConfigOptionsListConstants;
+
+register_shutdown_function("fatalErrorHandler");
+
+try {
+    // phpcs:ignore Magento2.Security.IncludeFile
+    require __DIR__ . '/../app/bootstrap.php';
+    /** @var \Magento\Framework\App\ObjectManagerFactory $objectManagerFactory */
+    $objectManagerFactory = \Magento\Framework\App\Bootstrap::createObjectManagerFactory(BP, []);
+    /** @var \Magento\Framework\ObjectManagerInterface $objectManager */
+    $objectManager = $objectManagerFactory->create([]);
+    /** @var \Magento\Framework\App\DeploymentConfig $deploymentConfig */
+    $deploymentConfig = $objectManager->get(\Magento\Framework\App\DeploymentConfig::class);
+    /** @var \Psr\Log\LoggerInterface $logger */
+    $logger = $objectManager->get(\Psr\Log\LoggerInterface::class);
+} catch (\Exception $e) {
+    http_response_code(500);
+    // phpcs:ignore Magento2.Security.LanguageConstruct
+    exit(1);
+}
+
+// check mysql connectivity
+foreach ($deploymentConfig->get(ConfigOptionsListConstants::CONFIG_PATH_DB_CONNECTIONS) as $connectionData) {
+    try {
+        /** @var \Magento\Framework\DB\Adapter\Pdo\Mysql $dbAdapter */
+        $dbAdapter = $objectManager->create(
+            \Magento\Framework\DB\Adapter\Pdo\Mysql::class,
+            ['config' => $connectionData]
+        );
+        $dbAdapter->getConnection();
+    } catch (\Exception $e) {
+        http_response_code(500);
+        $logger->error("MySQL connection failed: " . $e->getMessage());
+        // phpcs:ignore Magento2.Security.LanguageConstruct
+        exit(1);
+    }
+}
+// check cache storage availability
+$cacheConfigs = $deploymentConfig->get(ConfigOptionsListConstants::KEY_CACHE_FRONTEND);
+if ($cacheConfigs) {
+    foreach ($cacheConfigs as $cacheConfig) {
+        // allow config if only available "id_prefix"
+        if (count($cacheConfig) === 1 && isset($cacheConfig['id_prefix'])) {
+            continue;
+        } elseif (!isset($cacheConfig[ConfigOptionsListConstants::CONFIG_PATH_BACKEND]) ||
+            !isset($cacheConfig[ConfigOptionsListConstants::CONFIG_PATH_BACKEND_OPTIONS])) {
+            http_response_code(500);
+            $logger->error("Cache configuration is invalid");
+            // phpcs:ignore Magento2.Security.LanguageConstruct
+            exit(1);
+        }
+        $cacheBackendClass = $cacheConfig[ConfigOptionsListConstants::CONFIG_PATH_BACKEND];
+        try {
+            /** @var \Magento\Framework\App\Cache\Frontend\Factory $cacheFrontendFactory */
+            $cacheFrontendFactory = $objectManager->get(Magento\Framework\App\Cache\Frontend\Factory::class);
+            /** @var \Zend_Cache_Backend_Interface $backend */
+            $backend = $cacheFrontendFactory->create($cacheConfig);
+            $backend->test('test_cache_id');
+        } catch (\Exception $e) {
+            http_response_code(500);
+            $logger->error("Cache storage is not accessible");
+            // phpcs:ignore Magento2.Security.LanguageConstruct
+            exit(1);
+        }
+    }
+}
+
+/**
+ * Handle any fatal errors
+ *
+ * @return void
+ */
+function fatalErrorHandler()
+{
+    $error = error_get_last();
+    if ($error !== null && $error['type'] === E_ERROR) {
+        http_response_code(500);
+    }
+}

package/lib/tasks/requirements/{composer.js → composer-credentials.js}

@@ -279,4 +279,6 @@ Error message that we got: ${e}`
     }
 });
 
-module.exports = checkComposerCredentials;
+module.exports = {
+    checkComposerCredentials
+};

package/lib/tasks/requirements/docker/index.js

@@ -4,10 +4,21 @@ const { execAsyncSpawn } = require('../../../util/exec-async-command');
 const openBrowser = require('../../../util/open-browser');
 const installDocker = require('./install');
 const installDockerOnMac = require('./install-on-mac');
+const { checkDockerPerformance } = require('./performance');
 const { checkDockerSocketPermissions } = require('./permissions');
 const checkDockerStatus = require('./running-status');
 const getDockerVersion = require('./version');
 
+const setVersionInContextTask = (task) => ({
+    task: (ctx) => {
+        if (ctx.platform === 'darwin' && ctx.dockerServerData && ctx.dockerServerData.Platform && ctx.dockerServerData.Platform.Name) {
+            task.title = `Using ${ctx.dockerServerData.Platform.Name} for Mac`;
+        } else {
+            task.title = `Using Docker version ${ctx.dockerVersion}`;
+        }
+    }
+});
+
 const dockerInstallPromptLinux = async (task) => {
     const automaticallyInstallDocker = await task.prompt({
         type: 'Confirm',
@@ -47,7 +58,6 @@ ${ logger.style.link('https://docs.create-magento-app.com/getting-started/prereq
 };
 
 /**
- *
  * @param {import('listr2').ListrTaskWrapper} task
  */
 const dockerInstallPromptMacOS = async (task) => {
@@ -72,11 +82,7 @@ Would you like to install it automatically using brew cask or you prefer to inst
             installDockerOnMac(),
             checkDockerStatus(),
             getDockerVersion(),
-            {
-                task: (ctx) => {
-                    task.title = `Using Docker version ${ctx.dockerVersion}`;
-                }
-            }
+            setVersionInContextTask(task)
         ]);
     }
 
@@ -118,11 +124,7 @@ const checkDocker = () => ({
         return task.newListr([
             checkDockerStatus(),
             getDockerVersion(),
-            {
-                task: (ctx) => {
-                    task.title = `Using Docker version ${ctx.dockerVersion}`;
-                }
-            }
+            setVersionInContextTask(task)
         ]);
     }
 });
@@ -133,7 +135,8 @@ const checkDocker = () => ({
 module.exports = () => ({
     task: (ctx, task) => task.newListr([
         checkDockerSocketPermissions(),
-        checkDocker()
+        checkDocker(),
+        checkDockerPerformance()
     ], {
         concurrent: false
     })

package/lib/tasks/requirements/docker/performance.js

@@ -0,0 +1,54 @@
+const os = require('os');
+const path = require('path');
+const semver = require('semver');
+const getJsonfileData = require('../../../util/get-jsonfile-data');
+const pathExists = require('../../../util/path-exists');
+
+const dockerSettingsJsonPath = path.join(
+    os.homedir(),
+    'Library',
+    'Group Containers',
+    'group.com.docker',
+    'settings.json'
+);
+
+/**
+ * @type {() => import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
+ */
+const checkDockerPerformance = () => ({
+    title: 'Checking Docker Performance',
+    // eslint-disable-next-line no-return-await
+    skip: async (ctx) => ctx.platform !== 'darwin' || (ctx.platform === 'darwin' && !(await pathExists(dockerSettingsJsonPath))),
+    task: async (ctx, task) => {
+        const dockerSettings = await getJsonfileData(dockerSettingsJsonPath);
+
+        if (!dockerSettings) {
+            task.skip();
+            return;
+        }
+
+        const dockerForMacVersionMatch = ctx.dockerServerData.Platform.Name.match(/(\d+\.\d+\.\d+)/i);
+
+        const dockerForMacVersion = dockerForMacVersionMatch && dockerForMacVersionMatch[1];
+
+        if (ctx.arch === 'arm64'
+        && semver.gt('12.2.0', ctx.platformVersion)
+        && semver.gt(dockerForMacVersion, '4.6.0')) {
+            if (!dockerSettings.useVirtualizationFrameworkVirtioFS) {
+                task.title = 'Performance is not optimal. VirtioFS is not enabled.';
+            }
+        }
+
+        if (ctx.arch === 'x64'
+        && semver.gt('12.3.0', ctx.platformVersion)
+        && semver.gt(dockerForMacVersion, '4.6.0')) {
+            if (!dockerSettings.useVirtualizationFrameworkVirtioFS) {
+                task.title = 'Performance is not optimal. VirtioFS is not enabled.';
+            }
+        }
+    }
+});
+
+module.exports = {
+    checkDockerPerformance
+};

package/lib/tasks/requirements/docker/version.js

@@ -1,21 +1,21 @@
 const UnknownError = require('../../../errors/unknown-error');
-const { execAsyncSpawn } = require('../../../util/exec-async-command');
+const { version } = require('../../docker/api');
 
 /**
  * @type {() => import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
  */
 const getDockerVersion = () => ({
     task: async (ctx) => {
-        const { result, code } = await execAsyncSpawn('docker version --format {{.Server.Version}}', {
-            withCode: true
+        const dockerVersion = await version({
+            formatToJSON: true
         });
 
-        if (code === 0) {
-            const dockerVersion = result.split('').filter((c) => /[\d.]/i.test(c)).join('') || result;
-
-            ctx.dockerVersion = dockerVersion;
+        if (dockerVersion) {
+            ctx.dockerServerData = dockerVersion.Server;
+            ctx.dockerClientData = dockerVersion.Client;
+            ctx.dockerVersion = dockerVersion.Server.Version;
         } else {
-            throw new UnknownError(`Got unexpected result during Docker version retrieval!\n\n${ result }`);
+            throw new UnknownError(`Got unexpected result during Docker version retrieval!\n\n${ dockerVersion }`);
         }
     }
 });

package/lib/tasks/requirements/index.js

@@ -1,9 +1,8 @@
 const checkPlatform = require('./platform');
-const checkPHPbrew = require('./phpbrew');
-const checkComposer = require('./composer');
+const { checkComposerCredentials } = require('./composer-credentials');
+const localAuthJson = require('../composer/local-auth-json');
 const checkDocker = require('./docker');
 const checkNodeVersion = require('./node-version');
-const checkPHPVersion = require('./php-version');
 const checkRosetta = require('./rosetta');
 
 /**
@@ -20,13 +19,11 @@ const checkRequirements = () => ({
         checkDocker(),
         // check for Node.js version
         checkNodeVersion(),
-        // check the PHPBrew installation
-        checkPHPbrew(),
         // check installed PHP version
-        checkPHPVersion(),
+        // checkPHPVersion(),
         // check for COMPOSER_AUTH or auth.json
-        // localAuthJson(),
-        checkComposer()
+        localAuthJson(),
+        checkComposerCredentials()
     ], {
         concurrent: false,
         exitOnError: true,

package/lib/tasks/requirements/php-version.js

@@ -1,132 +1,24 @@
-const logger = require('@scandipwa/scandipwa-dev-utils/logger');
-const fs = require('fs');
-const path = require('path');
-const semver = require('semver');
-const phpbrewConfig = require('../../config/phpbrew');
-const KnownError = require('../../errors/known-error');
 const UnknownError = require('../../errors/unknown-error');
-const { execAsyncSpawn } = require('../../util/exec-async-command');
-const { getBrewCommandSync } = require('../../util/get-brew-bin-path');
-const pathExists = require('../../util/path-exists');
-const compileOptions = require('../php/compile-options');
-
-const latestStablePHP74 = '7.4.27';
-const phpbrewPHPName = `php-${latestStablePHP74}-phpbrew`;
-
-/**
- * @type {() => import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
- */
-const installPHPForPHPBrew = () => ({
-    title: `Installing PHP ${latestStablePHP74} for PHPBrew...`,
-    task: async (ctx, task) => {
-        const compileOptionsForPhp = {
-            linux: {
-                ...compileOptions.linux,
-                variants: [
-                    '+default'
-                ],
-                extraOptions: []
-            },
-            darwin: {
-                ...compileOptions.darwin,
-                variants: [
-                    '+default',
-                    `+openssl=$(${getBrewCommandSync({ native: false })} --prefix openssl@1.1)`
-                ],
-                extraOptions: []
-            }
-        };
-        const platformCompileOptions = compileOptionsForPhp[process.platform];
-
-        if (!await pathExists(path.join(phpbrewConfig.phpPath, `${phpbrewPHPName}`, 'bin'))) {
-            const commandEnv = Object.entries(platformCompileOptions.env || {}).map(([key, value]) => `${key}="${value}"`).join(' ');
-            // eslint-disable-next-line max-len
-            const compileCommand = ` ${commandEnv ? `${commandEnv} && ` : ''}phpbrew install -j ${platformCompileOptions.cpuCount} ${latestStablePHP74} as ${phpbrewPHPName} ${platformCompileOptions.variants.join(' ')}`;
-
-            try {
-                await execAsyncSpawn(
-                    compileCommand,
-                    {
-                        callback: (t) => {
-                            task.output = t;
-                        },
-                        useRosetta2: true
-                    }
-                );
-            } catch (e) {
-                throw new KnownError(
-                    `Failed to compile the required by PHPBrew PHP version.
-Tried compiling the PHP version ${ latestStablePHP74 }.
-Use your favorite search engine to resolve the issue.
-See error details in the output below.\n\n${e}`
-                );
-            }
-        }
-
-        try {
-            const phpbrewInitFileContent = `# DO NOT EDIT THIS FILE
-
-export PHPBREW_ROOT=${phpbrewConfig.homePath}
-export PHPBREW_HOME=${phpbrewConfig.homePath}
-export PHPBREW_PHP=${phpbrewPHPName}
-export PHPBREW_PATH=${phpbrewConfig.homePath}/php/${phpbrewPHPName}/bin
-# Run this command to configure your shell:
-# eval "$(phpbrew env)"\n`;
-
-            await fs.promises.writeFile(
-                path.join(phpbrewConfig.homePath, 'init'),
-                phpbrewInitFileContent,
-                {
-                    encoding: 'utf-8'
-                }
-            );
-        } catch (e) {
-            throw new UnknownError(`Something went wrong when trying to switch PHP to ${phpbrewPHPName}!\n\n${e}`);
-        }
-
-        throw new KnownError(`You will need to restart your terminal and run ${logger.style.command('start')} again.
-
-You can use keyboard shortcut ${logger.style.command('CTRL+D')} to close terminal.`);
-    },
-    options: {
-        bottomBar: 10
-    }
-});
+const { runContainerImage } = require('../../util/run-container-image');
 
 /**
  * @type {() => import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
  */
 const checkPHPVersion = () => ({
-    title: 'Checking system PHP version',
+    title: 'Checking container PHP version',
     task: async (ctx, task) => {
-        const phpVersionResponse = await execAsyncSpawn('php --version');
+        const { php } = ctx.config.docker.getContainers(ctx.ports);
+        const phpVersionResponse = await runContainerImage(php.image, 'php --version');
 
         const phpVersionResponseResult = phpVersionResponse.match(/PHP\s(\d+\.\d+\.\d+)/i);
 
         if (phpVersionResponseResult && phpVersionResponseResult.length > 0) {
             const phpVersion = phpVersionResponseResult[1];
 
-            if (semver.satisfies(phpVersion, '>=8.1.x')) {
-                const userConfirmation = await task.prompt({
-                    type: 'Confirm',
-                    message: `You have PHP ${phpVersion} installed in the system.
-PHPBrew can work with this version but it will have a lot of warning.
-To fix that we will build special PHP version that will be used by PHPBrew, please confirm this action.`
-                });
-
-                if (userConfirmation) {
-                    return task.newListr(
-                        installPHPForPHPBrew,
-                        {
-                            rendererOptions: {
-                                collapse: false
-                            }
-                        }
-                    );
-                }
-            }
-
-            task.title = `Using PHP version ${phpVersion} in system`;
+            ctx.phpVersion = phpVersion;
+            task.title = `Using PHP version ${phpVersion} in container`;
+        } else {
+            throw new UnknownError(`Cannot retrieve PHP Version!\n\n${phpVersionResponse}`);
         }
     }
 });

package/lib/tasks/requirements/platform.js

@@ -1,12 +1,12 @@
 const os = require('os');
-const macosVersion = require('macos-version');
+const semver = require('semver');
 const systeminformation = require('systeminformation');
 const logger = require('@scandipwa/scandipwa-dev-utils/logger');
 const { platforms, darwinMinimalVersion } = require('../../config');
-const dependencyCheck = require('./dependency');
 const { getArch } = require('../../util/arch');
 const getIsWsl = require('../../util/is-wsl');
 const KnownError = require('../../errors/known-error');
+const { getMacOSVersion } = require('../../util/macos-version');
 
 /**
  * @returns {import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
@@ -16,6 +16,15 @@ const checkPlatform = () => ({
     task: async (ctx, task) => {
         const currentPlatform = os.platform();
 
+        ctx.arch = await getArch();
+
+        ctx.isArm = ctx.arch === 'arm64';
+        ctx.isWsl = await getIsWsl();
+
+        ctx.platform = currentPlatform;
+        ctx.platformVersion = currentPlatform !== 'darwin' ? os.release() : await getMacOSVersion();
+        ctx.isArmMac = ctx.isArm && ctx.platform === 'darwin';
+
         if (!platforms.includes(currentPlatform)) {
             throw new KnownError(
                 `Your current OS platform is ${ logger.style.misc(currentPlatform) }.
@@ -23,38 +32,16 @@ const checkPlatform = () => ({
             );
         }
 
-        if (macosVersion.isMacOS && !macosVersion.isGreaterThanOrEqualTo(darwinMinimalVersion)) {
+        if (currentPlatform === 'darwin' && !semver.gt(ctx.platformVersion, semver.coerce(darwinMinimalVersion).version)) {
             throw new KnownError(
                 'Please update your system!',
                 `MacOS bellow version ${ logger.style.misc(darwinMinimalVersion) } is not supported.`
             );
         }
 
-        ctx.arch = await getArch();
-
-        ctx.isArm = ctx.arch === 'arm64';
-        ctx.isWsl = await getIsWsl();
-
-        ctx.platform = currentPlatform;
-        ctx.platformVersion = currentPlatform !== 'darwin' ? os.release() : macosVersion();
-        ctx.isArmMac = ctx.isArm && ctx.platform === 'darwin';
-
         const { manufacturer, brand, cores } = await systeminformation.cpu();
 
         task.title = `Running on ${currentPlatform} ${ctx.platformVersion} (${manufacturer} ${brand} ${cores} threads)`;
-
-        const installDependenciesTask = await dependencyCheck();
-
-        if (installDependenciesTask) {
-            return task.newListr(
-                installDependenciesTask,
-                {
-                    rendererOptions: {
-                        showTimer: false
-                    }
-                }
-            );
-        }
     }
 });
 

package/lib/tasks/start.js

@@ -3,23 +3,17 @@ const openBrowser = require('../util/open-browser');
 const getMagentoVersionConfig = require('../config/get-magento-version-config');
 const { saveConfiguration } = require('../config/save-config');
 const { getAvailablePorts, getCachedPorts } = require('../config/get-port-config');
-const { installComposer, installPrestissimo } = require('./composer');
+const { getComposerVersionTask } = require('./composer');
 const { startServices } = require('./docker');
-const { installPhp, configurePhp } = require('./php');
 const { checkRequirements } = require('./requirements');
 const { createCacheFolder } = require('./cache');
-const { startPhpFpm, stopPhpFpm } = require('./php-fpm');
 const { prepareFileSystem } = require('./file-system');
 const { installMagentoProject, setupMagento } = require('./magento');
-const { pullContainers, stopContainers } = require('./docker/containers');
+const { pullImages, stopContainers } = require('./docker/containers');
+const dockerNetwork = require('./docker/network');
 const { setPrefix } = require('./prefix');
-const {
-    connectToMySQL,
-    importDumpToMySQL,
-    fixDB,
-    restoreThemeConfig,
-    dumpThemeConfig
-} = require('./mysql');
+const { connectToDatabase } = require('./database');
+const { buildProjectImage, buildDebugProjectImage } = require('./docker/project-image-builder');
 const getProjectConfiguration = require('../config/get-project-configuration');
 const { getSystemConfigTask } = require('../config/system-config');
 const setupThemes = require('./theme/setup-themes');
@@ -30,9 +24,10 @@ const enableMagentoComposerPlugins = require('./magento/enable-magento-composer-
 const getIsWsl = require('../util/is-wsl');
 const checkForXDGOpen = require('../util/xdg-open-exists');
 const { getInstanceMetadata, constants: { WEB_LOCATION_TITLE } } = require('../util/instance-metadata');
-const validatePHPInstallation = require('./php/validate-php');
-const installSodiumExtension = require('./php/install-sodium');
 const waitingForVarnish = require('./magento/setup-magento/waiting-for-varnish');
+const checkPHPVersion = require('./requirements/php-version');
+const volumes = require('./docker/volume/tasks');
+const convertMySQLDatabaseToMariaDB = require('./docker/convert-mysql-to-mariadb');
 
 /**
  * @type {() => import('listr2').ListrTask<import('../../typings/context').ListrContext>}
@@ -44,6 +39,7 @@ const retrieveProjectConfiguration = () => ({
         checkConfigurationFile(),
         getProjectConfiguration(),
         convertLegacyVolumes(),
+        convertMySQLDatabaseToMariaDB(),
         createCacheFolder(),
         getSystemConfigTask(),
         getCachedPorts()
@@ -63,15 +59,8 @@ const retrieveProjectConfiguration = () => ({
 const stopProject = () => ({
     title: 'Stopping project',
     task: (ctx, task) => task.newListr([
-        stopContainers(),
-        stopPhpFpm()
-    ], {
-        concurrent: true,
-        rendererOptions: {
-            collapse: true,
-            showTimer: false
-        }
-    }),
+        stopContainers()
+    ]),
     options: {
         showTimer: false
     }
@@ -104,26 +93,24 @@ const retrieveFreshProjectConfiguration = () => ({
 const configureProject = () => ({
     title: 'Configuring project',
     task: (ctx, task) => task.newListr([
-        installPhp(),
-        installComposer(),
+        pullImages(),
+        dockerNetwork.tasks.createNetwork(),
+        volumes.createVolumes(),
         {
             task: (ctx, task) => task.newListr([
-                prepareFileSystem(),
-                pullContainers()
+                buildProjectImage(),
+                buildDebugProjectImage()
             ], {
-                concurrent: true,
-                exitOnError: true
+                concurrent: true
             })
         },
-        installSodiumExtension(),
-        configurePhp(),
-        validatePHPInstallation(),
-        installPrestissimo(),
+        checkPHPVersion(),
+        getComposerVersionTask(),
+        prepareFileSystem(),
         installMagentoProject(),
         enableMagentoComposerPlugins(),
-        startPhpFpm(),
         startServices(),
-        connectToMySQL()
+        connectToDatabase()
     ])
 });
 
@@ -134,22 +121,6 @@ const finishProjectConfiguration = () => ({
     title: 'Finishing project configuration',
     skip: ({ skipSetup }) => skipSetup,
     task: (ctx, task) => task.newListr([
-        {
-            skip: (ctx) => !ctx.importDb,
-            task: (ctx, task) => {
-                task.title = 'Importing database dump';
-                return task.newListr([
-                    dumpThemeConfig(),
-                    importDumpToMySQL(),
-                    fixDB(),
-                    restoreThemeConfig(),
-                    setupMagento()
-                ], {
-                    concurrent: false,
-                    exitOnError: true
-                });
-            }
-        },
         setupThemes(),
         waitingForVarnish()
     ], {