@scandipwa/magento-scripts 1.14.1-alpha.0 → 1.14.1-alpha.11

package/lib/util/php-task.js

@@ -1,7 +1,10 @@
 const runPhpCode = require('./run-php');
 
 /**
- * @type {(command: string, options: { noTitle: boolean }) => import('listr2').ListrTask<import('../../typings/context').ListrContext>}
+ * @type {(
+ * command: string,
+ * options: { noTitle: boolean, env: Record<string, string> }
+ * ) => import('listr2').ListrTask<import('../../typings/context').ListrContext>}
  */
 const phpTask = (command, options = {}) => ({
     title: !options.noTitle ? `Running command 'php ${command}` : undefined,
@@ -10,7 +13,8 @@ const phpTask = (command, options = {}) => ({
             task.output = t;
         },
         throwNonZeroCode: true,
-        magentoVersion
+        magentoVersion,
+        env: options.env
     })
 });
 

package/lib/util/resolve-configuration-with-overrides.js

@@ -1,4 +1,5 @@
 const path = require('path');
+const UnknownError = require('../errors/unknown-error');
 const { configFileSchema } = require('./config-file-validator');
 const { deepmerge } = require('./deepmerge');
 const pathExists = require('./path-exists');
@@ -11,7 +12,7 @@ const resolveConfigurationWithOverrides = async (configuration, baseConfig, proj
         try {
             await configFileSchema.validateAsync(userConfiguration);
         } catch (e) {
-            throw new Error(`Configuration file validation error!\n\n${e.message}`);
+            throw new UnknownError(`Configuration file validation error!\n\n${e.message}`);
         }
 
         const overridenConfiguration = deepmerge(configuration, userConfiguration);

package/lib/util/run-composer.js

@@ -1,5 +1,6 @@
 const { execAsyncSpawn } = require('./exec-async-command');
 const { getConfigFromMagentoVersion, defaultConfiguration } = require('../config');
+const UnknownError = require('../errors/unknown-error');
 /**
  * Execute composer command
  * @param {String} command composer command
@@ -24,8 +25,8 @@ const runComposerCommand = async (command, options = {}) => {
     });
 
     if (throwNonZeroCode && code !== 0) {
-        throw new Error(`Code: ${code}
-        Response: ${result}`);
+        throw new UnknownError(`Code: ${code}
+Response: ${result}`);
     }
 
     return { code, result };

package/lib/util/run-magento.js

@@ -1,5 +1,6 @@
 const { execAsyncSpawn } = require('./exec-async-command');
 const { getConfigFromMagentoVersion, defaultConfiguration, magento } = require('../config');
+const UnknownError = require('../errors/unknown-error');
 /**
  * Execute magento command
  * @param {String} command magento command
@@ -27,8 +28,8 @@ const runMagentoCommand = async (command, options = {}) => {
     });
 
     if (throwNonZeroCode && code !== 0) {
-        throw new Error(`Code: ${code}
-        Response: ${result}`);
+        throw new UnknownError(`Code: ${code}
+Response: ${result}`);
     }
 
     return { code, result };

package/lib/util/run-php.js

@@ -1,5 +1,6 @@
 const { execAsyncSpawn } = require('./exec-async-command');
 const { getConfigFromMagentoVersion, defaultConfiguration } = require('../config');
+const UnknownError = require('../errors/unknown-error');
 /**
  * Execute PHP code
  * @param {String} command magento command
@@ -10,6 +11,7 @@ const { getConfigFromMagentoVersion, defaultConfiguration } = require('../config
  * @param {() => {}} options.callback
  * @param {Boolean} options.throwNonZeroCode Throw if command return non 0 code.
  * @param {String} options.magentoVersion Magento version for config
+ * @param {Record<string, string>} options.env Environment variables
  */
 const runPhpCode = async (command, options = {}) => {
     const {
@@ -17,14 +19,19 @@ const runPhpCode = async (command, options = {}) => {
         magentoVersion = defaultConfiguration.magentoVersion
     } = options;
     const { php } = await getConfigFromMagentoVersion(magentoVersion);
-    const { code, result } = await execAsyncSpawn(`${php.binPath} -c ${php.iniPath} ${command}`, {
+    let spawnCommand = `${php.binPath} -c ${php.iniPath} ${command}`;
+    if (options.env && Object.keys(options.env).length > 0) {
+        const env = Object.entries(options.env).map(([key, value]) => `${key}=${value}`).join(' ');
+        spawnCommand = `${env} ${spawnCommand}`;
+    }
+    const { code, result } = await execAsyncSpawn(spawnCommand, {
         ...options,
         withCode: true
     });
 
     if (throwNonZeroCode && code !== 0) {
-        throw new Error(`Code: ${code}
-        Response: ${result}`);
+        throw new UnknownError(`Code: ${code}
+Response: ${result}`);
     }
 
     return { code, result };

package/lib/util/systemctl.js

@@ -0,0 +1,46 @@
+const { execAsyncSpawn } = require('./exec-async-command');
+
+/**
+ * @param {String} cmd
+ * @param {String} serviceName
+ * @param {{ now: boolean }} options
+ */
+const run = (cmd, serviceName, options = {}) => execAsyncSpawn(
+    `systemctl ${ cmd }${ serviceName ? ` ${ serviceName }` : '' }${ options.now ? ' --now' : ''}`,
+    {
+        withCode: true
+    }
+);
+
+const daemonReload = () => run('daemon-reload');
+
+const systemctlControl = (serviceName) => ({
+    disable: () => run('disable', serviceName),
+    enable: () => run('enable', serviceName),
+    enableAndStart: () => run('enable', serviceName, { now: true }),
+    restart: () => run('restart', serviceName),
+    start: () => run('start', serviceName),
+    stop: () => run('stop', serviceName),
+    isEnabled: async () => {
+        try {
+            const { result } = await run('is-enabled', serviceName);
+            return result.includes('enabled');
+        } catch (e) {
+            return false;
+        }
+    },
+    isRunning: async () => {
+        try {
+            const { result } = await run('status', serviceName);
+
+            return result.includes('active (running)');
+        } catch (e) {
+            return false;
+        }
+    }
+});
+
+module.exports = {
+    systemctlControl,
+    daemonReload
+};

package/lib/util/wait-for-it.js

@@ -1,4 +1,5 @@
 const net = require('net');
+const UnknownError = require('../errors/unknown-error');
 const sleep = require('./sleep');
 
 const connectToHostPort = ({ host, port }) => new Promise((resolve, reject) => {
@@ -14,7 +15,7 @@ const connectToHostPort = ({ host, port }) => new Promise((resolve, reject) => {
     });
     socket.on('timeout', () => {
         socket.end();
-        reject(new Error('Connection timeout'));
+        reject(new UnknownError('Connection timeout'));
     });
 });
 
@@ -29,7 +30,7 @@ const waitForIt = async ({
             // eslint-disable-next-line no-await-in-loop
             await Promise.race([
                 sleep(300).then(() => {
-                    throw new Error('Connection timeout');
+                    throw new UnknownError('Connection timeout');
                 }),
                 connectToHostPort({ host, port })
             ]);

package/package.json

@@ -3,7 +3,7 @@
     "description": "Scripts and configuration used by CMA.",
     "homepage": "https://docs.create-magento-app.com/",
     "repository": "github:scandipwa/create-magento-app",
-    "version": "1.14.1-alpha.0",
+    "version": "1.14.1-alpha.11",
     "main": "./index.js",
     "types": "./typings/index.d.ts",
     "license": "OSL-3.0",
@@ -22,7 +22,7 @@
         "arm64"
     ],
     "dependencies": {
-        "@scandipwa/scandipwa-dev-utils": "0.1.12",
+        "@scandipwa/scandipwa-dev-utils": "0.1.13",
         "conf": "10.1.1",
         "enquirer": "2.3.6",
         "eta": "1.12.3",
@@ -35,6 +35,7 @@
         "mysql2": "2.3.2",
         "node-ssh": "12.0.0",
         "semver": "7.3.5",
+        "smol-request": "2.1.1",
         "systeminformation": "5.11.7",
         "yargs": "17.3.1"
     },
@@ -51,5 +52,5 @@
         "mysql",
         "scandipwa"
     ],
-    "gitHead": "055ef1bd01035af8eaf80dffa087e77c67938fa8"
+    "gitHead": "3e86a5870f29d0b24ac3f65ff5fdbe96ef5bd025"
 }

package/typings/context.d.ts

@@ -12,9 +12,12 @@ export interface ListrContext {
         mysql: number
         redis: number
         elasticsearch: number
+        varnish: number
+        sslTerminator: number
     }
     arch: 'arm64' | 'x64'
     isArm: boolean
+    isWsl: boolean
     platform?: NodeJS.Platform
     platformVersion?: string
     /**
@@ -51,7 +54,7 @@ export interface ListrContext {
                     o: string
                 }
             }>
-            getContainers(): Record<'nginx' | 'redis' | 'mysql' | 'elasticsearch', {
+            getContainers(): Record<'nginx' | 'redis' | 'mysql' | 'elasticsearch' | 'varnish', {
                 _: string
                 ports: string[]
                 healthCheck: {
@@ -88,4 +91,5 @@ export interface ListrContext {
         useNonOverlappingPorts: boolean
     }
     mysqlConnection: mysql2.Connection
+    isSetupUpgradeNeeded?: boolean
 }

package/typings/index.d.ts

@@ -10,7 +10,14 @@ export interface ServiceWithVersion {
     version: string
 }
 
-// export inter/
+export interface SSLTerminatorConfiguration extends ServiceWithVersion {
+    /**
+     * Configuration file location
+     *
+     * @example ./my-ssl-terminator-config.conf
+     */
+    configTemplate: string
+}
 
 export interface NginxConfiguration extends ServiceWithVersion {
     /**
@@ -21,6 +28,20 @@ export interface NginxConfiguration extends ServiceWithVersion {
     configTemplate: string
 }
 
+export interface VarnishConfiguration extends ServiceWithVersion {
+    /**
+     * Enable or disable Varnish in the project
+     */
+    enabled: boolean
+
+    /**
+     * Configuration file location
+     *
+     * @example ./my-varnish-config.vcl
+     */
+    configTemplate: string
+}
+
 export interface PHPExtension extends Record<string, unknown> {
     version?: string
     /**
@@ -175,6 +196,16 @@ export interface CMAConfiguration {
          * Composer configuration
          */
         composer: ServiceWithVersion
+
+        /**
+         * Varnish configuration
+         */
+        varnish: VarnishConfiguration
+
+        /**
+         * SSL Terminator configuration
+         */
+        sslTerminator: SSLTerminatorConfiguration
     }
     /**
      * Magento configuration

package/lib/tasks/magento/setup-magento/adjust-magento-configuration.js

@@ -1,27 +0,0 @@
-const { isTableExists } = require('../../../util/database');
-
-/**
- * @type {() => import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
- */
-const adjustMagentoConfiguration = () => ({
-    title: 'Adjusting Magento Database Configuration',
-    skip: async (ctx) => !(await isTableExists('magento', 'core_config_data', ctx)),
-    task: async (ctx) => {
-        const { mysqlConnection } = ctx;
-
-        // delete varnish configuration if exists
-        await mysqlConnection.query(`
-            DELETE FROM core_config_data WHERE path LIKE '%varnish%';
-        `);
-
-        // update cache policy to not use varnish
-        // 0 - magento cache, 2 - varnish cache
-        await mysqlConnection.query(`
-            UPDATE core_config_data
-            SET value = ?
-            WHERE path = ?;
-        `, ['0', 'system/full_page_cache/caching_application']);
-    }
-});
-
-module.exports = adjustMagentoConfiguration;

package/lib/tasks/magento/setup-magento/disable-page-cache.js

@@ -1,11 +0,0 @@
-const magentoTask = require('../../../util/magento-task');
-
-/**
- * @type {() => import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
- */
-const disablePageCache = () => ({
-    title: 'Disabling full_page cache in Magento',
-    task: (ctx, task) => task.newListr(magentoTask('cache:disable full_page'))
-});
-
-module.exports = disablePageCache;