@caweb/cli 1.13.6 → 1.14.0

package/commands/env/shell.js

@@ -1,7 +1,7 @@
 /**
  * External dependencies
  */
-import run from '@wordpress/env/lib/commands/run.js';
+import {default as run} from '@wordpress/env';
 
 /**
  * Internal dependencies

package/commands/env/start.js

@@ -4,17 +4,17 @@
 import path from 'path';
 import fs from 'fs';
 import * as dockerCompose from 'docker-compose';
-
+import os from 'os';
+import deepmerge from 'deepmerge';
 /**
  * WordPress dependencies
  */
-import { default as wpEnvStart} from '@wordpress/env/lib/commands/start.js';
-import loadConfig from '@wordpress/env/lib/config/load-config.js';
-import retry from '@wordpress/env/lib/retry.js';
-import { didCacheChange, getCache } from '@wordpress/env/lib/cache.js';
-import { canAccessWPORG } from '@wordpress/env/lib/wordpress.js';
+import WPEnv from '@wordpress/env';
+import { md5} from '../../lib/helpers.js';
+// import { canAccessWPORG } from '../../lib/wordpress/index.js';
 
 const CONFIG_CACHE_KEY = 'config_checksum';
+const CACHE_FILE_NAME = 'wp-env-cache.json';
 
 /**
  * Internal dependencies
@@ -22,8 +22,8 @@ const CONFIG_CACHE_KEY = 'config_checksum';
 import { 
 	appPath,
 	projectPath,
+	currentPath,
 	configureCAWeb,
-	downloadSources,
 	configureWordPress,
 	runCmd,
 	runCLICmds
@@ -32,6 +32,38 @@ import {
 import { wpEnvConfig, wpEnvOverrideConfig } from '../../configs/wp-env.js';
 import {default as SyncProcess} from '../sync/index.js';
 
+/**
+ * Gets the directory in which generated files are created.
+ *
+ * By default: '~/.wp-env/'. On Linux with snap packages: '~/wp-env/'. Can be
+ * overridden with the WP_ENV_HOME environment variable.
+ *
+ * @return {Promise<string>} The absolute path to the `wp-env` home directory.
+ */
+async function getCacheDirectory() {
+	// Allow user to override download location.
+	if ( process.env.WP_ENV_HOME ) {
+		return path.resolve( process.env.WP_ENV_HOME );
+	}
+
+	/**
+	 * Installing docker with Snap Packages on Linux is common, but does not
+	 * support hidden directories. Therefore we use a public directory when
+	 * snap packages exist.
+	 *
+	 * @see https://github.com/WordPress/gutenberg/issues/20180#issuecomment-587046325
+	 */
+	let usesSnap;
+	try {
+		fs.statSync( '/snap' );
+		usesSnap = true;
+	} catch {
+		usesSnap = false;
+	}
+
+	return path.resolve( os.homedir(), usesSnap ? 'wp-env' : '.wp-env' );
+}
+
 /**
  * Starts the development server.
  * 
@@ -55,6 +87,7 @@ export default async function start({
 	xdebug,
 	scripts,
 	debug,
+	spx,
 	sync,
 	bare,
 	plugin,
@@ -62,122 +95,85 @@ export default async function start({
 	multisite,
 	subdomain
 }) {
+	let configFilePath = path.resolve( appPath, '.wp-env.json' );
+	let configOverrideFilePath = path.resolve( appPath, '.wp-env.override.json' );
 
-	
-	
+	const workDirectoryPath = path.resolve(
+		await getCacheDirectory(),
+		md5( configFilePath )
+	);
+
+	// Keys should not be saved in the repository so we store them in the override.json file.
 	// Write CAWeb .wp-env.override.json file.
-	if( ! fs.existsSync( path.join(appPath, '.wp-env.override.json')) ){
+	if( ! fs.existsSync( configOverrideFilePath ) ){
 		spinner.stop()
 	
-		// Keys should not be saved in the repository so we store them in the override.json file.
 		fs.writeFileSync(
-			path.join(appPath, '.wp-env.override.json'),
-			JSON.stringify( await wpEnvOverrideConfig(bare, multisite, subdomain, plugin, theme), null, 4 )
+			configOverrideFilePath,
+			JSON.stringify( await wpEnvOverrideConfig({workDirectoryPath,bare, multisite, subdomain, plugin, theme}), null, 4 )
 		);
 
 		spinner.start('Writing .wp-env.override.json file...');
 
+	}else {
+		let overrideConfig = JSON.parse( fs.readFileSync( configOverrideFilePath ) );
+
+		// if the override file doesn't have Divi credentials prompt for them again.
+		if( ! overrideConfig.config.ET_USERNAME || ! overrideConfig.config.ET_API_KEY ){
+			spinner.stop()
+
+			let diviConfig = await wpEnvOverrideConfig({workDirectoryPath,bare, multisite, subdomain, plugin, theme});
+
+			fs.writeFileSync(
+				configOverrideFilePath,
+				JSON.stringify( deepmerge( overrideConfig, diviConfig ), null, 4 )
+			);
+
+			spinner.start('Writing .wp-env.override.json file...');
+		} 
 	}
 	
 	// Write CAWeb .wp-env.json file.
-	if( ! fs.existsSync( path.join(appPath, '.wp-env.json')) || update ){
+	if( ! fs.existsSync( configFilePath ) || update ){
 		spinner.stop()
 		
 		fs.writeFileSync(
-			path.join(appPath, '.wp-env.json'),
-			JSON.stringify( wpEnvConfig(bare, multisite, subdomain, plugin, theme), null, 4 )
+			configFilePath,
+			JSON.stringify( await wpEnvConfig({workDirectoryPath,bare, multisite, subdomain, plugin, theme}), null, 4 )
 		);
 
 		spinner.start('Writing .wp-env.json file...');
 	}
 
-	// Get current wp-env cache key
-	const config = await loadConfig(path.resolve('.'));
-	const { workDirectoryPath } = config;
-	const cacheKey = await getCache(CONFIG_CACHE_KEY, {workDirectoryPath});
-
 	// Set extra configuration for WordPress.
 	// Increase max execution time to 300 seconds.
 	process.env.WORDPRESS_CONFIG_EXTRA = 'set_time_limit(300);';
 
-	// we can enable phpMyAdmin since @wordpress/env:10.14.0
-	if( config.env.development.config.WP_ENV_PHPMYADMIN_PORT ){
-		process.env.WP_ENV_PHPMYADMIN_PORT = config.env.development.config.WP_ENV_PHPMYADMIN_PORT;	
-	}
-	if( config.env.tests.config.WP_ENV_TESTS_PHPMYADMIN_PORT ){
-		process.env.WP_ENV_TESTS_PHPMYADMIN_PORT = config.env.tests.config.WP_ENV_TESTS_PHPMYADMIN_PORT;	
-	}
-
 	// wp-env launch.
-	await wpEnvStart({
+	await WPEnv.start({
 		spinner,
 		update,
 		xdebug,
+		spx,
 		scripts,
 		debug,
 	})
 
-	// Save pretext from wp-env if it exists for later.
-	let preText = undefined !== spinner.prefixText ? spinner.prefixText.slice(0, -1) : '';
-
-	// We aren't done lets clear the default WordPress text.			
-	spinner.prefixText = '';
-	spinner.text = '';
-
-	// Check if we should configure settings.
-	const shouldConfigureWp = ( update || 
-		( await didCacheChange( CONFIG_CACHE_KEY, cacheKey, {
-			workDirectoryPath,
-		} ) )) &&
-		// Don't reconfigure everything when we can't connect to the internet because
-		// the majority of update tasks involve connecting to the internet. (Such
-		// as downloading sources and pulling docker images.)
-		( await canAccessWPORG() );
-
-	// Only run configurations when config has changed.
-	if( shouldConfigureWp ){
-		// Download any resources required for CAWeb.
-		if( ! bare ){
-			spinner.text = 'Downloading CAWeb resources...';
-			// Download sources for development and tests.
-			await Promise.all( [
-				downloadSources('development', {spinner, config}),
-				downloadSources('tests', {spinner, config})
-			] );
-		}
-
-		// Make additional WordPress Configurations.
-		await Promise.all( [
-			retry( () => configureWordPress( 'development', config, spinner, multisite, subdomain ), {
-				times: 2,
-			} ),
-			retry( () => configureWordPress( 'tests', config, spinner, multisite, subdomain ), {
-				times: 2,
-			} )
-		] );
-		
-		// Make CAWeb WordPress Configurations.
-		await Promise.all( [
-			retry( () => configureCAWeb( 'development', config, spinner ), {
-				times: 2,
-			} ),
-			retry( () => configureCAWeb( 'tests', config, spinner ), {
-				times: 2,
-			} ),
-		] );
+	if( sync ){
+		// Save pretext from wp-env if it exists for later.
+		let preText = undefined !== spinner.prefixText ? spinner.prefixText.slice(0, -1) : '';
 
+		// We aren't done lets clear the default WordPress text.			
+		spinner.prefixText = '';
 		
-		if( sync ){
-			// sync any static information.
-			spinner.text = `Syncing CAWebPublishing development Environment...`;
-			// Sync the static site to the local WordPress instance.
-			await SyncProcess({spinner, debug, target: 'static', dest: 'local'})
-		}
-		
-	}
-
-	spinner.prefixText = preText;
+		// sync any static information.
+		spinner.text = `Syncing CAWebPublishing development Environment...`;
+		// Sync the static site to the local WordPress instance.
+		await SyncProcess({spinner, debug, target: 'static', dest: 'local'})
 
+		// Restore pretext.
+		spinner.prefixText = preText;
+	}
 
 	spinner.text = 'Done!';
 };

package/commands/index.js

@@ -2,12 +2,15 @@
  * External dependencies
  */
 // These are default wp-env commands. No need to overwrite these commands
-import clean from '@wordpress/env/lib/commands/clean.js';
-import logs from '@wordpress/env/lib/commands/logs.js';
-import run from '@wordpress/env/lib/commands/run.js';
-import stop from '@wordpress/env/lib/commands/stop.js';
-import destroy from '@wordpress/env/lib/commands/destroy.js';
-import installPath from '@wordpress/env/lib/commands/install-path.js';
+import WPEnv from '@wordpress/env';
+const {
+    clean,
+    logs,
+    run,
+    stop,
+    destroy,
+    installPath
+} = WPEnv;
 
 /**
  * Internal dependencies
@@ -36,7 +39,6 @@ import convertSite from './sites/convert-site.js';
 // we overwrite the start command so we can run additional steps.
 import start from './env/start.js';
 import shell from './env/shell.js';
-import updatePlugins from './env/update-plugins.js';
 
 // import test from './test.js';
 import genScripts from './gen-scripts.js';
@@ -55,7 +57,6 @@ export {
     stop,
     destroy,
     sync,
-    updatePlugins,
     shell,
     createBlock,
     updateBlock,

package/commands/sync/index.js

@@ -3,7 +3,6 @@
  */
 import path from 'path';
 import fs from 'fs';
-import loadConfig from '@wordpress/env/lib/config/load-config.js';
 import axios from 'axios';
 
 // since we are in a spinner,
@@ -181,9 +180,6 @@ export default async function sync({
     postIds
 } ) {
 
-    // this gets the working directory path after wp-env validation
-    const {workDirectoryPath} = await loadConfig(path.resolve('.'));
-
     // read caweb configuration file.    
     let serviceConfig = fs.existsSync(configFile) ? JSON.parse( fs.readFileSync(configFile) ) : { sync: {} };
 
@@ -217,7 +213,9 @@ export default async function sync({
             process.exit(1)
         }
     }
-        
+       
+    console.log( target)
+    console.log( dest )
     /**
      * each instance has to have a url, user, pwd property
      */

package/configs/wp-env.js

@@ -13,6 +13,7 @@ import {
 } from '../lib/helpers.js';
 import { promptForDivi } from './prompts.js';
 import { config, env } from 'process';
+import { CAWEB_OPTIONS, DIVI_OPTIONS } from'../lib/wordpress/options.js';
 
 const localFile = path.join(projectPath, 'package.json');
 const pkg = JSON.parse( fs.readFileSync(localFile) );
@@ -32,25 +33,72 @@ const cawebJson = fs.existsSync( path.join(appPath, 'caweb.json') ) ?
  * 
  * @returns object
  */
-function wpEnvConfig ( bare, multisite, subdomain, plugin, theme ) {
+async function wpEnvConfig ( {workDirectoryPath: cwd , bare, multisite, subdomain, plugin, theme} ) {
     let themes = [];
     let plugins = [];
+    let args = {cwd, bare, multisite, subdomain, plugin, theme};
+    let argString = Object.entries( args ).map( ([k, v]) => `--${k} ${v}` ).join( ' ' );
+
+    let setupFile = path.join( projectPath, 'lib', 'wordpress', 'setup', 'index.js' );
     
     let envConfig = {
         core: `WordPress/WordPress#${pkg.config.WP_VER}`,
         phpVersion: `${pkg.config.PHP_VER}`,
         multisite,
+        themes: [ 
+            `CAWebPublishing/CAWeb#${pkg.config.CAWEB_VER}` 
+        ],
+        plugins: [
+            'CAWebPublishing/caweb-dev',
+            `https://downloads.wordpress.org/plugin/query-monitor.${pkg.config.QUERY_MONITOR}.zip`,
+        ],
         env: {
-            development: { port: 8888, config: {} },
-            tests: { port: 8889, config: {} }
+            development: { 
+                port: 8888, 
+                phpmyadminPort: 9998,
+                config: {} 
+        },
+            tests: { 
+                port: 8889, 
+                phpmyadminPort: 9999,
+                config: {} 
+            }
+        },
+        lifecycleScripts: {
+            afterStart: `node ${ setupFile } ${ argString }`,
+        },
+        config: {
+            ...pkg.config.DEFAULTS
         }
     }
 
-    if( multisite && subdomain ){
-        pkg.config.DEFAULTS.SUBDOMAIN_INSTALL= true;
+    if( multisite ){
+        if( ! bare ){   
+            // if multisite set default theme to CAWeb
+            // this allows for any new sites created to use CAWeb as the default theme.
+            pkg.config.DEFAULTS.WP_DEFAULT_THEME = 'CAWeb';
+        }
+        // if subdomain add the subdomain constant
+        if( subdomain ){
+            pkg.config.DEFAULTS.SUBDOMAIN_INSTALL= true;
+        }
     }
 
-    envConfig.config = pkg.config.DEFAULTS
+    // iterate over available CAWeb options.
+	Object.entries(CAWEB_OPTIONS).forEach(([k,v]) => {
+        envConfig.config[k] = v.defaultValue;
+	})
+
+    // iterate over available Divi options.
+	Object.entries(DIVI_OPTIONS).forEach(([group, options]) => {
+        // we dont want to set any automatic update options here.
+        if( 'et_automatic_updates_options' === group ) return;
+
+        // iterate over each group options.
+		Object.entries(options).forEach(([key, data]) => {
+            envConfig.config[key] = data.defaultValue;
+        })
+	})
 
     // if root directory is a theme
     if( theme ){
@@ -131,7 +179,6 @@ function wpEnvConfig ( bare, multisite, subdomain, plugin, theme ) {
     
 }
 
-
 /**
  * Build .wp-env.override.json
  * 
@@ -143,16 +190,12 @@ function wpEnvConfig ( bare, multisite, subdomain, plugin, theme ) {
  * 
  * @returns object
  */
-async function wpEnvOverrideConfig(){
-    let divi = await promptForDivi();
-     
-    let config = {
+async function wpEnvOverrideConfig({workDirectoryPath}){
+    return {
         config: {
-            ...divi
+            ...await promptForDivi()
         }
     }
-
-    return config;
 }
 
 export {

package/lib/cli.js

@@ -166,6 +166,11 @@ function addWPEnvCommands(){
 			'--xdebug <mode>',
 			'Enables Xdebug. If not passed, Xdebug is turned off. If no modes are set, uses "debug". You may set multiple Xdebug modes by passing them in a comma-separated list: `--xdebug=develop,coverage`. See https://xdebug.org/docs/all_settings#mode for information about Xdebug modes.',
 		)
+		.option( 
+			'--spx', 
+			'A simple profiling extension for PHP that provides low-overhead profiling with a built-in web UI.',
+			''
+		)
 		.option( 
 			'--scripts', 
 			'Execute any configured lifecycle scripts.',
@@ -298,15 +303,6 @@ function addWPEnvCommands(){
  * Adds commands for wp instances
  */
 function addWPInstanceCommands(){
-	// Update Plugins Command.
-	program.command('update-plugins')
-		.description('Updates all plugins in the WordPress environment.')
-		.argument('[slug]', 'Plugin slug to update.', 'all')
-		.addOption(new Option('--environment <env>', 'Which environment to use.').choices(['development', 'tests']).default('development'))
-		.allowUnknownOption(true)
-		.allowExcessArguments(true)
-		.action( withSpinner(env.updatePlugins) )
-
 	// Sync changes from one WordPress instance to another.
 	program.command('sync')
 		.description('Sync changes from one WordPress instance to another.')

package/lib/helpers.js

@@ -7,6 +7,8 @@ import spawn from 'cross-spawn';
 import { fileURLToPath } from 'url';
 import { sync as resolveBin } from 'resolve-bin';
 import * as dockerCompose from 'docker-compose';
+import { promisify } from 'util';
+import crypto from 'crypto';
 
 /**
  * Internal dependencies
@@ -73,26 +75,29 @@ async function runCmd(cmd, args,opts = { stdio: 'pipe' }){
  * 
  * @returns {Promise}
  */
-async function runCLICmds(
+async function runCLICmds({
 	environment,
 	cmds,
-	config,
-	spinner
-) {
+	cwd,
+	debug = false
+}) {
 
 	// We return the promise whether there is an output or an error.
 	return await dockerCompose.run(
 		environment === 'development' ? 'cli' : 'tests-cli',
 		[ 'bash', '-c', cmds.join( ' && ' ) ],
 		{
-			cwd: config.workDirectoryPath,
+			cwd,
 			env: process.env,
 			commandOptions: [],
-			log: config.debug,
+			log: debug,
 			callback: (buffer, result) => {
-				if( config.debug ){
-					spinner.text = buffer.toString();
+				// Remove the Container information and new lines.
+				if ( 'stdout' === result && debug ){
+					// process.stdout.write( buffer.toString().replace(/\s*Container .*Running\n/g, '') );
+					// writeLine(buffer.toString().replace(/\s*Container .*Running\n|\n/g, ''), { color: 'red' });
 				}
+
 			}
 		}
 	).then(
@@ -105,14 +110,19 @@ async function runCLICmds(
 		},
 		(error) => {
 			// Remove the Container information and new lines.
-			error.err = error.err.replace(/\s*Container .*Running\n|\n/g, '')
+			error.err = error.err.replace(/\s*Container .*Running\n/g, '')
+
+			writeError(error.err);
 
-			return error;
+			if( debug ){
+				process.exit(1);
+			}else{
+				return false;
+			}
 		}
 	);
 }
 
-
 /**
  * Write a line to the console.
  *
@@ -190,6 +200,20 @@ function clearLine(count = 1) {
 	} while (--count);
 }
 
+
+/**
+ * Hashes the given string using the MD5 algorithm.
+ *
+ * @param {any} data The data to hash. If not a string, converted with JSON.stringify.
+ * @return {string} An MD5 hash string.
+ */
+function md5( data ) {
+	const convertedData =
+		typeof data === 'string' ? data : JSON.stringify( data );
+
+	return crypto.createHash( 'md5' ).update( convertedData ).digest( 'hex' );
+}
+
 export {
 	currentPath,
 	projectPath,
@@ -199,4 +223,5 @@ export {
 	writeLine,
 	writeError,
 	clearLine,
+	md5,
 };

package/lib/index.js

@@ -16,15 +16,9 @@ import {
 
 // WordPress
 import {
-    activateCAWeb,
     configureCAWeb,
-    downloadSources,
 	configureDivi,
-	isDiviThemeActive,
 	configureWordPress,
-	isMultisite,
-	convertToMultisite,
-	generateHTAccess,
 	getTaxonomies,
     createTaxonomies,
 	CAWEB_OPTIONS,
@@ -41,15 +35,9 @@ export {
     runCmd,
     withSpinner,
     runCLICmds,
-    activateCAWeb,
     configureCAWeb,
-    downloadSources,
 	configureDivi,
-	isDiviThemeActive,
 	configureWordPress,
-	isMultisite,
-	convertToMultisite,
-	generateHTAccess,
 	getTaxonomies,
     createTaxonomies,
 	CAWEB_OPTIONS,

package/lib/wordpress/index.js

@@ -1,20 +1,16 @@
-import { activateCAWeb, configureCAWeb } from "./caweb.js";
-import { downloadSources } from "./download-sources.js";
-import { configureDivi, isDiviThemeActive } from "./divi.js";
-import { configureWordPress, isMultisite, convertToMultisite, generateHTAccess } from "./wordpress.js";
+import { isCAWebActive, configureCAWeb } from "./setup/caweb.js";
+import { configureDivi } from "./setup/divi.js";
+import { 
+	configureWordPress
+} from "./wordpress.js";
 import { getTaxonomies, createTaxonomies }  from "./api.js";
 import { CAWEB_OPTIONS, DIVI_OPTIONS } from './options.js';
 
 export {
-    activateCAWeb,
+	isCAWebActive,
     configureCAWeb,
-    downloadSources,
 	configureDivi,
-	isDiviThemeActive,
 	configureWordPress,
-	isMultisite,
-	convertToMultisite,
-	generateHTAccess,
 	getTaxonomies,
     createTaxonomies,
 	CAWEB_OPTIONS,

package/lib/wordpress/options.js

@@ -1,6 +1,18 @@
 /**
  * External dependencies
  */
+import fs from 'fs';
+import path from 'path';
+
+let SYSTEM_OPTIONS = JSON.parse( fs.readFileSync( path.resolve('', 'package.json') ) ).config.DEFAULTS;
+Object.entries( SYSTEM_OPTIONS ).forEach( ([key, value]) => {
+	SYSTEM_OPTIONS[key] = {
+		name: key.toLowerCase(),
+		defaultValue: value,
+		label: key
+	};
+
+});
 
 /**
  * Missing options.
@@ -15,7 +27,7 @@
 const caweb_general_options = {
 	CAWEB_FAV_ICON: {
 		name: 'ca_fav_ico',
-		defaultValue: '',
+		defaultValue: '/wp-content/themes/CAWeb/src/images/system/favicon.ico',
 		label: 'Fav Icon'
 	},
 	CAWEB_NAV_MENU_STYLE: {
@@ -107,12 +119,12 @@ const caweb_utility_header_options = {
 const page_header_options = {
 	CAWEB_ORG_LOGO: {
 		name: 'header_ca_branding',
-		defaultValue: '',
+		defaultValue: '/wp-content/themes/CAWeb/src/images/system/caweb-logo.png',
 		label: 'Organization Logo-Brand'
 	},
 	CAWEB_ORG_LOGO_ALT_TEXT: {
 		name: 'header_ca_branding_alt_text',
-		defaultValue: '',
+		defaultValue: 'CAWebPublishing Logo',
 		label: 'Organization Logo-Alt Text'
 	}
 };
@@ -258,5 +270,6 @@ const DIVI_OPTIONS = {
 
 export {
 	CAWEB_OPTIONS,
-	DIVI_OPTIONS
+	DIVI_OPTIONS,
+	SYSTEM_OPTIONS
 }