@scandipwa/magento-scripts 1.16.0-alpha.4 → 2.0.0-alpha.0

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,23 @@ 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
+    connectToMySQL
+    // importDumpToMySQL,
+    // fixDB,
+    // restoreThemeConfig,
+    // dumpThemeConfig
 } = require('./mysql');
+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,8 +30,9 @@ 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/volumes');
 
 /**
  * @type {() => import('listr2').ListrTask<import('../../typings/context').ListrContext>}
@@ -62,15 +63,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
     }
@@ -103,25 +97,23 @@ 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(),
         startServices(),
-        startPhpFpm(),
         connectToMySQL()
     ])
 });
@@ -133,23 +125,24 @@ 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()
+        // {
+        //     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()
     ], {
         rendererOptions: {
             collapse: false

package/lib/tasks/status/index.js

@@ -25,19 +25,16 @@ const parsePort = (port) => {
 const prettyStatus = async (ctx) => {
     const {
         config: {
-            baseConfig,
-            php,
-            composer
+            baseConfig
         },
         magentoVersion,
         dockerVersion,
-        PHPBrewVersion,
         platform,
         platformVersion,
         containers
     } = ctx;
     const projectCreatedAt = getProjectCreatedAt();
-    const composerVersion = await getComposerVersion({ composer, php });
+    const composerVersion = await getComposerVersion(ctx);
 
     const prefix = getPrefix();
 
@@ -48,7 +45,7 @@ const prettyStatus = async (ctx) => {
     block
         .addHeader(`magento-scripts version: ${ logger.style.link(packageVersion) }`)
         .addEmptyLine()
-        .addLine(`Project: ${logger.style.file(baseConfig.prefix)} ${prefix === folderName ? '(without prefix)' : '(with prefix)'}`)
+        .addLine(`Project: ${logger.style.file(baseConfig.prefix)} ${prefix === folderName ? '(without prefix)' : '(with prefix)'} (with php container)`)
         .addLine(`Project location: ${logger.style.link(process.cwd())}`);
 
     if (projectCreatedAt) {
@@ -57,12 +54,9 @@ const prettyStatus = async (ctx) => {
 
     block
         .addLine(`Magento 2 version: ${logger.style.file(magentoVersion)}`)
-        .addLine(`PHP version: ${logger.style.file(php.version)}`)
-        .addLine(`PHP location: ${logger.style.link(php.binPath)}`)
+        .addLine(`PHP version: ${logger.style.file(ctx.phpVersion)}`)
         .addLine(`Composer version: ${logger.style.file(composerVersion)}`)
-        .addLine(`Composer location: ${logger.style.link(path.relative(process.cwd(), composer.binPath))}`)
         .addLine(`Docker version: ${logger.style.file(dockerVersion)}`)
-        .addLine(`PHPBrew version: ${logger.style.file(PHPBrewVersion)}`)
         .addLine(`Platform: ${logger.style.code(platform)}`)
         .addLine(`Platform version: ${logger.style.file(platformVersion)}`)
         .addLine(`Platform architecture: ${logger.style.file(getArchSync())}`)

package/lib/tasks/stop.js

@@ -1,6 +1,5 @@
 const { stopServices } = require('./docker');
 const getMagentoVersionConfig = require('../config/get-magento-version-config');
-const { stopPhpFpm } = require('./php-fpm');
 const getProjectConfiguration = require('../config/get-project-configuration');
 const checkConfigurationFile = require('../config/check-configuration-file');
 
@@ -13,7 +12,6 @@ const stop = () => ({
         getMagentoVersionConfig(),
         checkConfigurationFile(),
         getProjectConfiguration(),
-        stopPhpFpm(),
         stopServices()
     ], {
         concurrent: false,

package/lib/tasks/theme/install-theme.js

@@ -18,7 +18,7 @@ const installTheme = (theme) => ({
         }
 
         try {
-            await runComposerCommand(`require ${theme.composerData.name}`, {
+            await runComposerCommand(ctx, `require ${theme.composerData.name}`, {
                 magentoVersion,
                 callback: !verbose ? undefined : (t) => {
                     task.output = t;

package/lib/tasks/theme/symlink-theme.js

@@ -9,7 +9,7 @@ const runComposerCommand = require('../../util/run-composer');
 const symlinkTheme = (theme) => ({
     title: 'Setting symbolic link for theme in composer.json',
     task: async (ctx, task) => {
-        const { magentoVersion, verbose = false } = ctx;
+        const { verbose = false } = ctx;
         const composerJsonData = await getJsonfileData(path.join(process.cwd(), 'composer.json'));
 
         if (!composerJsonData.repositories) {
@@ -27,8 +27,7 @@ const symlinkTheme = (theme) => ({
         }
 
         try {
-            await runComposerCommand(`config repo.scandipwa path ${theme.absoluteThemePath}`, {
-                magentoVersion,
+            await runComposerCommand(ctx, `config repo.scandipwa path ${theme.absoluteThemePath}`, {
                 callback: !verbose ? undefined : (t) => {
                     task.output = t;
                 }

package/lib/util/config-php-json.js

@@ -1,10 +1,19 @@
 const path = require('path');
 const UnknownError = require('../errors/unknown-error');
-const runPhpCode = require('./run-php');
+const { runPHPContainerCommand } = require('../tasks/php/php-container');
+const pathExists = require('./path-exists');
 
-const configPhpToJson = async (projectPath = process.cwd(), { magentoVersion }) => {
-    const { code, result } = await runPhpCode(`-r "echo json_encode(require '${path.join(projectPath, 'app', 'etc', 'config.php')}');"`, {
-        magentoVersion
+/**
+ * @param {import('../../typings/context').ListrContext} ctx
+ */
+const configPhpToJson = async (ctx) => {
+    const configPhpOnSystemPath = path.join(ctx.config.baseConfig.magentoDir, 'app', 'etc', 'config.php');
+    const configPhpInContainerPath = path.join(ctx.config.baseConfig.containerMagentoDir, 'app', 'etc', 'config.php');
+    if (!await pathExists(configPhpOnSystemPath)) {
+        return null;
+    }
+    const { code, result } = await runPHPContainerCommand(ctx, `php -r "echo json_encode(require '${configPhpInContainerPath}');"`, {
+        withCode: true
     });
 
     if (code !== 0) {

package/lib/util/dockerfile-builder/build-instructions.js

@@ -0,0 +1,197 @@
+/**
+ *
+ * @param {import('./types').DockerfileInstruction[]} instructions
+ */
+const buildInstructions = (instructions) => {
+    /**
+     * @type {string[]}
+     */
+    const dockerFileInstructions = [];
+
+    for (const instruction of instructions) {
+        switch (instruction.type) {
+        case 'COPY':
+        case 'ADD': {
+            let addInstruction = instruction.type;
+
+            if (instruction.type === 'COPY' && instruction.from) {
+                addInstruction += ` --from=${instruction.from}`;
+            }
+
+            if (instruction.chown) {
+                addInstruction += ` --chown=${instruction.chown}`;
+            }
+
+            addInstruction += ` ${instruction.src.join(' ')}`;
+            addInstruction += ` ${instruction.dest}`;
+
+            dockerFileInstructions.push(addInstruction);
+            break;
+        }
+        case 'ARG': {
+            let argInstruction = instruction.type;
+
+            argInstruction += ` ${instruction.name}`;
+
+            if (instruction.defaultValue) {
+                argInstruction += `=${instruction.defaultValue}`;
+            }
+
+            dockerFileInstructions.push(argInstruction);
+            break;
+        }
+        case 'RUN':
+        case 'ENTRYPOINT':
+        case 'CMD': {
+            let cmdInstruction = instruction.type;
+
+            if (typeof instruction.command === 'string') {
+                cmdInstruction += ` ${instruction.command}`;
+            } else if (Array.isArray(instruction.command) && instruction.command.every((c) => typeof c === 'string')) {
+                cmdInstruction += ` ["${instruction.command.join('", "')}"]`;
+            } else {
+                throw new Error(`Unknown command type, it must be string or array of strings! ${instruction.command}`);
+            }
+
+            dockerFileInstructions.push(cmdInstruction);
+            break;
+        }
+
+        case 'COMMENT': {
+            const commentInstruction = `# ${instruction.comment}`;
+
+            dockerFileInstructions.push(commentInstruction);
+            break;
+        }
+        case 'ENV': {
+            let envInstruction = instruction.type;
+
+            envInstruction += ` ${instruction.name}="${instruction.value}"`;
+
+            dockerFileInstructions.push(envInstruction);
+            break;
+        }
+        case 'EXPOSE': {
+            let exposeInstruction = instruction.type;
+
+            if (instruction.protocol) {
+                exposeInstruction += ` ${instruction.port}/${instruction.protocol}`;
+            } else {
+                exposeInstruction += ` ${instruction.port}`;
+            }
+
+            dockerFileInstructions.push(exposeInstruction);
+            break;
+        }
+        case 'FROM': {
+            let fromInstruction = instruction.type;
+
+            if (instruction.platform) {
+                fromInstruction += ` --platform=${instruction.platform}`;
+            }
+
+            fromInstruction += ` ${instruction.image}:${instruction.tag || 'latest'}`;
+
+            if (instruction.name) {
+                fromInstruction += ` AS ${instruction.name}`;
+            }
+
+            dockerFileInstructions.push(fromInstruction);
+            break;
+        }
+        case 'HEALTHCHECK': {
+            let healthCheckInstruction = instruction.type;
+
+            if (instruction.interval) {
+                healthCheckInstruction += ` --interval=${instruction.interval}`;
+            }
+
+            if (instruction.retries) {
+                healthCheckInstruction += ` --retries=${instruction.retries}`;
+            }
+
+            if (instruction.startPeriod) {
+                healthCheckInstruction += ` --start-period=${instruction.startPeriod}`;
+            }
+
+            if (instruction.timeout) {
+                healthCheckInstruction += ` --timeout=${instruction.timeout}`;
+            }
+
+            healthCheckInstruction += ` ${instruction.command}`;
+
+            dockerFileInstructions.push(healthCheckInstruction);
+            break;
+        }
+        case 'LABEL': {
+            Object.entries(instruction.labels).forEach(([name, value]) => {
+                let labelInstruction = instruction.type;
+                labelInstruction += ` "${name}"="${value}"`;
+                dockerFileInstructions.push(labelInstruction);
+            });
+            break;
+        }
+        case 'ONBUILD': {
+            let onBuildInstruction = instruction.type;
+
+            onBuildInstruction += ` ${instruction.instruction}`;
+
+            dockerFileInstructions.push(onBuildInstruction);
+            break;
+        }
+        case 'SHELL': {
+            let shellInstruction = instruction.type;
+
+            shellInstruction += ` ["${instruction.exec.join('", "')}"]`;
+
+            dockerFileInstructions.push(shellInstruction);
+            break;
+        }
+        case 'STOPSIGNAL': {
+            let stopSignalInstruction = instruction.type;
+
+            stopSignalInstruction += ` ${instruction.signal}`;
+
+            dockerFileInstructions.push(stopSignalInstruction);
+            break;
+        }
+        case 'USER': {
+            let userInstruction = instruction.type;
+
+            userInstruction += ` ${instruction.user}`;
+
+            dockerFileInstructions.push(userInstruction);
+            break;
+        }
+        case 'VOLUME': {
+            let volumeInstruction = instruction.type;
+
+            if (typeof instruction.volume === 'string') {
+                volumeInstruction += ` ${instruction.volume}`;
+            } else if (Array.isArray(instruction.volume) && instruction.volume.every((c) => typeof c === 'string')) {
+                volumeInstruction += ` ["${instruction.volume.join('", "')}"]`;
+            } else {
+                throw new Error(`Unknown volume type, it must be string or array of strings! ${instruction.volume}`);
+            }
+
+            dockerFileInstructions.push(volumeInstruction);
+            break;
+        }
+        case 'WORKDIR': {
+            const workDirInstruction = `${instruction.type} ${instruction.workdir}`;
+
+            dockerFileInstructions.push(workDirInstruction);
+            break;
+        }
+        default: {
+            throw new Error(`I don't know instruction with type ${instruction.type}`);
+        }
+        }
+    }
+
+    return dockerFileInstructions.join('\n');
+};
+
+module.exports = {
+    buildInstructions
+};