diff options
| -rw-r--r-- | .github/workflows/reusable-test-local-docker-environment-v1.yml | 2 | ||||
| -rw-r--r-- | docker-compose.yml | 4 | ||||
| -rw-r--r-- | package.json | 2 | ||||
| -rw-r--r-- | src/js/_enqueues/admin/user-profile.js | 10 | ||||
| -rw-r--r-- | src/wp-admin/includes/file.php | 2 | ||||
| -rw-r--r-- | src/wp-includes/class-wp-oembed.php | 14 | ||||
| -rw-r--r-- | src/wp-includes/embed.php | 16 | ||||
| -rw-r--r-- | tools/local-env/scripts/docker.js | 33 | ||||
| -rw-r--r-- | tools/local-env/scripts/install.js | 34 | ||||
| -rw-r--r-- | tools/local-env/scripts/start.js | 61 | ||||
| -rw-r--r-- | tools/local-env/scripts/utils.js | 10 |
11 files changed, 137 insertions, 51 deletions
diff --git a/.github/workflows/reusable-test-local-docker-environment-v1.yml b/.github/workflows/reusable-test-local-docker-environment-v1.yml index 83ed4d1ac7..c4bbfae729 100644 --- a/.github/workflows/reusable-test-local-docker-environment-v1.yml +++ b/.github/workflows/reusable-test-local-docker-environment-v1.yml @@ -155,7 +155,7 @@ jobs: run: npm run env:restart - name: Test a CLI command - run: npm run env:cli wp option get siteurl + run: npm run env:cli option get siteurl - name: Test logs command run: npm run env:logs diff --git a/docker-compose.yml b/docker-compose.yml index 48f3abc607..863cbd2ea9 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -106,10 +106,14 @@ services: PHP_FPM_UID: ${PHP_FPM_UID-1000} PHP_FPM_GID: ${PHP_FPM_GID-1000} HOST_PATH: ${PWD-}/${LOCAL_DIR-src} + WP_CONFIG_PATH: /var/www/wp-config.php volumes: - ./:/var/www + # Keeps the service alive. + command: 'sleep infinity' + # The init directive ensures the command runs with a PID > 1, so Ctrl+C works correctly. init: true diff --git a/package.json b/package.json index aeef7640f4..77c2b2d68c 100644 --- a/package.json +++ b/package.json @@ -184,7 +184,7 @@ "env:clean": "node ./tools/local-env/scripts/docker.js down -v --remove-orphans", "env:reset": "node ./tools/local-env/scripts/docker.js down --rmi all -v --remove-orphans", "env:install": "node ./tools/local-env/scripts/install.js", - "env:cli": "node ./tools/local-env/scripts/docker.js run --rm cli", + "env:cli": "node ./tools/local-env/scripts/docker.js exec cli wp --allow-root", "env:logs": "node ./tools/local-env/scripts/docker.js logs", "env:pull": "node ./tools/local-env/scripts/docker.js pull", "test:performance": "wp-scripts test-playwright --config tests/performance/playwright.config.js", diff --git a/src/js/_enqueues/admin/user-profile.js b/src/js/_enqueues/admin/user-profile.js index ad808d3131..ce680ef4c4 100644 --- a/src/js/_enqueues/admin/user-profile.js +++ b/src/js/_enqueues/admin/user-profile.js @@ -101,6 +101,8 @@ return; } $toggleButton = $pass1Row.find('.wp-hide-pw'); + + // Toggle between showing and hiding the password. $toggleButton.show().on( 'click', function () { if ( 'password' === $pass1.attr( 'type' ) ) { $pass1.attr( 'type', 'text' ); @@ -110,6 +112,14 @@ resetToggle( true ); } }); + + // Ensure the password input type is set to password when the form is submitted. + $pass1Row.closest( 'form' ).on( 'submit', function() { + if ( $pass1.attr( 'type' ) === 'text' ) { + $pass1.attr( 'type', 'password' ); + resetToggle( true ); + } + } ); } /** diff --git a/src/wp-admin/includes/file.php b/src/wp-admin/includes/file.php index 40059273ba..0658662126 100644 --- a/src/wp-admin/includes/file.php +++ b/src/wp-admin/includes/file.php @@ -2622,7 +2622,7 @@ function request_filesystem_credentials( $form_post, $type = '', $error = false, <?php if ( isset( $types['ssh'] ) ) { $hidden_class = ''; - if ( 'ssh' !== $connection_type || empty( $connection_type ) ) { + if ( 'ssh' !== $connection_type ) { $hidden_class = ' class="hidden"'; } ?> diff --git a/src/wp-includes/class-wp-oembed.php b/src/wp-includes/class-wp-oembed.php index 2d59c2217d..43f95ed150 100644 --- a/src/wp-includes/class-wp-oembed.php +++ b/src/wp-includes/class-wp-oembed.php @@ -739,9 +739,9 @@ class WP_oEmbed { * * @since 2.9.0 * - * @param string $return The returned oEmbed HTML. - * @param object $data A data object result from an oEmbed provider. - * @param string $url The URL of the content to be embedded. + * @param string|false $return The returned oEmbed HTML, or false on failure. + * @param object $data A data object result from an oEmbed provider. + * @param string $url The URL of the content to be embedded. */ return apply_filters( 'oembed_dataparse', $return, $data, $url ); } @@ -752,10 +752,10 @@ class WP_oEmbed { * @since 2.9.0 as strip_scribd_newlines() * @since 3.0.0 * - * @param string $html Existing HTML. - * @param object $data Data object from WP_oEmbed::data2html() - * @param string $url The original URL passed to oEmbed. - * @return string Possibly modified $html + * @param string|false $html Existing HTML. + * @param object $data Data object from WP_oEmbed::data2html() + * @param string $url The original URL passed to oEmbed. + * @return string|false Possibly modified $html. */ public function _strip_newlines( $html, $data, $url ) { if ( ! str_contains( $html, "\n" ) ) { diff --git a/src/wp-includes/embed.php b/src/wp-includes/embed.php index b5b30acead..a3c23be931 100644 --- a/src/wp-includes/embed.php +++ b/src/wp-includes/embed.php @@ -843,10 +843,10 @@ function _oembed_create_xml( $data, $node = null ) { * * @since 5.2.0 * - * @param string $result The oEmbed HTML result. - * @param object $data A data object result from an oEmbed provider. - * @param string $url The URL of the content to be embedded. - * @return string The filtered oEmbed result. + * @param string|false $result The oEmbed HTML result. + * @param object $data A data object result from an oEmbed provider. + * @param string $url The URL of the content to be embedded. + * @return string|false The filtered oEmbed result. */ function wp_filter_oembed_iframe_title_attribute( $result, $data, $url ) { if ( false === $result || ! in_array( $data->type, array( 'rich', 'video' ), true ) ) { @@ -910,10 +910,10 @@ function wp_filter_oembed_iframe_title_attribute( $result, $data, $url ) { * * @since 4.4.0 * - * @param string $result The oEmbed HTML result. - * @param object $data A data object result from an oEmbed provider. - * @param string $url The URL of the content to be embedded. - * @return string The filtered and sanitized oEmbed result. + * @param string|false $result The oEmbed HTML result. + * @param object $data A data object result from an oEmbed provider. + * @param string $url The URL of the content to be embedded. + * @return string|false The filtered and sanitized oEmbed result. */ function wp_filter_oembed_result( $result, $data, $url ) { if ( false === $result || ! in_array( $data->type, array( 'rich', 'video' ), true ) ) { diff --git a/tools/local-env/scripts/docker.js b/tools/local-env/scripts/docker.js index c1dc2b27e1..e39b42a812 100644 --- a/tools/local-env/scripts/docker.js +++ b/tools/local-env/scripts/docker.js @@ -1,21 +1,36 @@ -const dotenv = require( 'dotenv' ); +/* jshint node:true */ + +const dotenv = require( 'dotenv' ); const dotenvExpand = require( 'dotenv-expand' ); -const { execSync } = require( 'child_process' ); +const { spawnSync } = require( 'child_process' ); const local_env_utils = require( './utils' ); dotenvExpand.expand( dotenv.config() ); const composeFiles = local_env_utils.get_compose_files(); -if (process.argv.includes('--coverage-html')) { +if ( process.argv.includes( '--coverage-html' ) ) { process.env.LOCAL_PHP_XDEBUG = 'true'; process.env.LOCAL_PHP_XDEBUG_MODE = 'coverage'; } -// This try-catch prevents the superfluous Node.js debugging information from being shown if the command fails. -try { - // Execute any Docker compose command passed to this script. - execSync( 'docker compose ' + composeFiles + ' ' + process.argv.slice( 2 ).join( ' ' ), { stdio: 'inherit' } ); -} catch ( error ) { - process.exit( 1 ); +// Add --no-TTY (-T) arg after exec and run commands when STDIN is not a TTY. +const dockerCommand = process.argv.slice( 2 ); +if ( [ 'exec', 'run' ].includes( dockerCommand[0] ) && ! process.stdin.isTTY ) { + dockerCommand.splice( 1, 0, '--no-TTY' ); } + +// Execute any Docker compose command passed to this script. +const returns = spawnSync( + 'docker', + [ + 'compose', + ...composeFiles + .map( ( composeFile ) => [ '-f', composeFile ] ) + .flat(), + ...dockerCommand, + ], + { stdio: 'inherit' } +); + +process.exit( returns.status ); diff --git a/tools/local-env/scripts/install.js b/tools/local-env/scripts/install.js index 3bbc30d4d8..19a0f46e08 100644 --- a/tools/local-env/scripts/install.js +++ b/tools/local-env/scripts/install.js @@ -1,8 +1,10 @@ +/* jshint node:true */ + const dotenv = require( 'dotenv' ); const dotenvExpand = require( 'dotenv-expand' ); const wait_on = require( 'wait-on' ); const { execSync } = require( 'child_process' ); -const { renameSync, readFileSync, writeFileSync } = require( 'fs' ); +const { readFileSync, writeFileSync } = require( 'fs' ); const local_env_utils = require( './utils' ); dotenvExpand.expand( dotenv.config() ); @@ -11,7 +13,10 @@ dotenvExpand.expand( dotenv.config() ); local_env_utils.determine_auth_option(); // Create wp-config.php. -wp_cli( 'config create --dbname=wordpress_develop --dbuser=root --dbpass=password --dbhost=mysql --force' ); +wp_cli( `config create --dbname=wordpress_develop --dbuser=root --dbpass=password --dbhost=mysql --force --config-file="wp-config.php"` ); + +// Since WP-CLI runs as root, the wp-config.php created above will be read-only. This needs to be writable for the sake of E2E tests. +execSync( 'node ./tools/local-env/scripts/docker.js exec cli chmod 666 wp-config.php' ); // Add the debug settings to wp-config.php. // Windows requires this to be done as an additional step, rather than using the --extra-php option in the previous step. @@ -22,26 +27,35 @@ wp_cli( `config set SCRIPT_DEBUG ${process.env.LOCAL_SCRIPT_DEBUG} --raw --type= wp_cli( `config set WP_ENVIRONMENT_TYPE ${process.env.LOCAL_WP_ENVIRONMENT_TYPE} --type=constant` ); wp_cli( `config set WP_DEVELOPMENT_MODE ${process.env.LOCAL_WP_DEVELOPMENT_MODE} --type=constant` ); -// Move wp-config.php to the base directory, so it doesn't get mixed up in the src or build directories. -renameSync( `${process.env.LOCAL_DIR}/wp-config.php`, 'wp-config.php' ); - // Read in wp-tests-config-sample.php, edit it to work with our config, then write it to wp-tests-config.php. const testConfig = readFileSync( 'wp-tests-config-sample.php', 'utf8' ) .replace( 'youremptytestdbnamehere', 'wordpress_develop_tests' ) .replace( 'yourusernamehere', 'root' ) .replace( 'yourpasswordhere', 'password' ) .replace( 'localhost', 'mysql' ) - .replace( "'WP_TESTS_DOMAIN', 'example.org'", `'WP_TESTS_DOMAIN', '${process.env.LOCAL_WP_TESTS_DOMAIN}'` ) - .concat( "\ndefine( 'FS_METHOD', 'direct' );\n" ); + .replace( `'WP_TESTS_DOMAIN', 'example.org'`, `'WP_TESTS_DOMAIN', '${process.env.LOCAL_WP_TESTS_DOMAIN}'` ) + .concat( `\ndefine( 'FS_METHOD', 'direct' );\n` ); writeFileSync( 'wp-tests-config.php', testConfig ); // Once the site is available, install WordPress! -wait_on( { resources: [ `tcp:localhost:${process.env.LOCAL_PORT}`] } ) +wait_on( { + resources: [ `tcp:localhost:${process.env.LOCAL_PORT}`], + timeout: 3000, +} ) + .catch( err => { + console.error( `Error: It appears the development environment has not been started. Message: ${ err.message }` ); + console.error( `Did you forget to do 'npm run env:start'?` ); + process.exit( 1 ); + } ) .then( () => { wp_cli( 'db reset --yes' ); const installCommand = process.env.LOCAL_MULTISITE === 'true' ? 'multisite-install' : 'install'; wp_cli( `core ${ installCommand } --title="WordPress Develop" --admin_user=admin --admin_password=password --admin_email=test@example.com --skip-email --url=http://localhost:${process.env.LOCAL_PORT}` ); + } ) + .catch( err => { + console.error( `Error: Unable to reset DB and install WordPress. Message: ${ err.message }` ); + process.exit( 1 ); } ); /** @@ -50,7 +64,5 @@ wait_on( { resources: [ `tcp:localhost:${process.env.LOCAL_PORT}`] } ) * @param {string} cmd The WP-CLI command to run. */ function wp_cli( cmd ) { - const composeFiles = local_env_utils.get_compose_files(); - - execSync( `docker compose ${composeFiles} run --quiet-pull --rm cli ${cmd} --path=/var/www/${process.env.LOCAL_DIR}`, { stdio: 'inherit' } ); + execSync( `npm --silent run env:cli -- ${cmd} --path=/var/www/${process.env.LOCAL_DIR}`, { stdio: 'inherit' } ); } diff --git a/tools/local-env/scripts/start.js b/tools/local-env/scripts/start.js index 0dc8b95700..b0389b2fb0 100644 --- a/tools/local-env/scripts/start.js +++ b/tools/local-env/scripts/start.js @@ -1,11 +1,13 @@ +/* jshint node:true */ + const dotenv = require( 'dotenv' ); const dotenvExpand = require( 'dotenv-expand' ); -const { execSync } = require( 'child_process' ); +const { execSync, spawnSync } = require( 'child_process' ); const local_env_utils = require( './utils' ); const { constants, copyFile } = require( 'node:fs' ); // Copy the default .env file when one is not present. -copyFile( '.env.example', '.env', constants.COPYFILE_EXCL, (e) => { +copyFile( '.env.example', '.env', constants.COPYFILE_EXCL, () => { console.log( '.env file already exists. .env.example was not copied.' ); }); @@ -28,18 +30,38 @@ try { } // Start the local-env containers. -const containers = ( process.env.LOCAL_PHP_MEMCACHED === 'true' ) - ? 'wordpress-develop memcached' - : 'wordpress-develop'; -execSync( `docker compose ${composeFiles} up --quiet-pull -d ${containers}`, { stdio: 'inherit' } ); +const containers = [ 'wordpress-develop', 'cli' ]; +if ( process.env.LOCAL_PHP_MEMCACHED === 'true' ) { + containers.push( 'memcached' ); +} + +spawnSync( + 'docker', + [ + 'compose', + ...composeFiles.map( ( composeFile ) => [ '-f', composeFile ] ).flat(), + 'up', + '--quiet-pull', + '-d', + ...containers, + ], + { stdio: 'inherit' } +); // If Docker Toolbox is being used, we need to manually forward LOCAL_PORT to the Docker VM. if ( process.env.DOCKER_TOOLBOX_INSTALL_PATH ) { // VBoxManage is added to the PATH on every platform except Windows. - const vboxmanage = process.env.VBOX_MSI_INSTALL_PATH ? `${ process.env.VBOX_MSI_INSTALL_PATH }/VBoxManage` : 'VBoxManage' + const vboxmanage = process.env.VBOX_MSI_INSTALL_PATH ? `${ process.env.VBOX_MSI_INSTALL_PATH }/VBoxManage` : 'VBoxManage'; // Check if the port forwarding is already configured for this port. - const vminfoBuffer = execSync( `"${ vboxmanage }" showvminfo "${ process.env.DOCKER_MACHINE_NAME }" --machinereadable` ); + const vminfoBuffer = spawnSync( + vboxmanage, + [ + 'showvminfo', + process.env.DOCKER_MACHINE_NAME, + '--machinereadable' + ] + ).stdout; const vminfo = vminfoBuffer.toString().split( /[\r\n]+/ ); vminfo.forEach( ( info ) => { @@ -53,10 +75,29 @@ if ( process.env.DOCKER_TOOLBOX_INSTALL_PATH ) { // Delete rules that are using the port we need. if ( rule[ 3 ] === process.env.LOCAL_PORT || rule[ 5 ] === process.env.LOCAL_PORT ) { - execSync( `"${ vboxmanage }" controlvm "${ process.env.DOCKER_MACHINE_NAME }" natpf1 delete ${ rule[ 0 ] }`, { stdio: 'inherit' } ); + spawnSync( + vboxmanage, + [ + 'controlvm', + process.env.DOCKER_MACHINE_NAME, + 'natpf1', + 'delete', + rule[ 0 ] + ], + { stdio: 'inherit' } + ); } } ); // Add our port forwarding rule. - execSync( `"${ vboxmanage }" controlvm "${ process.env.DOCKER_MACHINE_NAME }" natpf1 "tcp-port${ process.env.LOCAL_PORT },tcp,127.0.0.1,${ process.env.LOCAL_PORT },,${ process.env.LOCAL_PORT }"`, { stdio: 'inherit' } ); + spawnSync( + vboxmanage, + [ + 'controlvm', + process.env.DOCKER_MACHINE_NAME, + 'natpf1', + `tcp-port${ process.env.LOCAL_PORT },tcp,127.0.0.1,${ process.env.LOCAL_PORT },,${ process.env.LOCAL_PORT }` + ], + { stdio: 'inherit' } + ); } diff --git a/tools/local-env/scripts/utils.js b/tools/local-env/scripts/utils.js index d76f3068a5..3f3e601db2 100644 --- a/tools/local-env/scripts/utils.js +++ b/tools/local-env/scripts/utils.js @@ -1,3 +1,5 @@ +/* jshint node:true */ + const { existsSync } = require( 'node:fs' ); const local_env_utils = { @@ -10,12 +12,14 @@ const local_env_utils = { * * When PHP 7.2 or 7.3 is used in combination with MySQL 8.4, an override file will also be returned to ensure * that the mysql_native_password plugin authentication plugin is on and available for use. + * + * @return {string[]} Compose files. */ get_compose_files: function() { - var composeFiles = '-f docker-compose.yml'; + const composeFiles = [ 'docker-compose.yml' ]; if ( existsSync( 'docker-compose.override.yml' ) ) { - composeFiles = composeFiles + ' -f docker-compose.override.yml'; + composeFiles.push( 'docker-compose.override.yml' ); } if ( process.env.LOCAL_DB_TYPE !== 'mysql' ) { @@ -28,7 +32,7 @@ const local_env_utils = { // PHP 7.2/7.3 in combination with MySQL 8.4 requires additional configuration to function properly. if ( process.env.LOCAL_DB_VERSION === '8.4' ) { - composeFiles = composeFiles + ' -f tools/local-env/old-php-mysql-84.override.yml'; + composeFiles.push( 'tools/local-env/old-php-mysql-84.override.yml' ); } return composeFiles; |