ofco/medicalalert-web-reloaded
4
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

auto-patch 638-dev-dev01-2024-05-14T20_44_36

Browse Source
This commit is contained in:
root
2024-05-14 20:44:36 +00:00
parent a941559057
commit 5dbb0b284e
1812 changed files with 29671 additions and 14588 deletions
Download Patch File Download Diff File Expand all files Collapse all files

235
wp/wp-content/plugins/woocommerce/src/Database/Migrations/CustomOrderTable/CLIRunner.php
View File

@@ -58,16 +58,26 @@ class CLIRunner {
* Registers commands for CLI.
*/
public function register_commands() {
WP_CLI::add_command( 'wc cot count_unmigrated', array( $this, 'count_unmigrated' ) );
WP_CLI::add_command( 'wc cot migrate', array( $this, 'migrate' ) );
WP_CLI::add_command( 'wc cot sync', array( $this, 'sync' ) );
WP_CLI::add_command( 'wc cot verify_cot_data', array( $this, 'verify_cot_data' ) );
WP_CLI::add_command( 'wc cot enable', array( $this, 'enable' ) );
WP_CLI::add_command( 'wc cot disable', array( $this, 'disable' ) );
$legacy_commands = array( 'count_unmigrated', 'sync', 'verify_cot_data', 'enable', 'disable' );
foreach ( $legacy_commands as $cmd ) {
$new_cmd_name = 'verify_cot_data' === $cmd ? 'verify_data' : $cmd;
WP_CLI::add_command( "wc hpos {$new_cmd_name}", array( $this, $cmd ) );
WP_CLI::add_command(
"wc cot {$cmd}",
function ( array $args = array(), array $assoc_args = array() ) use ( $cmd, $new_cmd_name ) {
WP_CLI::warning( "Command `wc cot {$cmd}` is deprecated since 8.9.0. Please use `wc hpos {$new_cmd_name}` instead." );
return call_user_func( array( $this, $cmd ), $args, $assoc_args );
}
);
}
WP_CLI::add_command( 'wc hpos cleanup', array( $this, 'cleanup_post_data' ) );
WP_CLI::add_command( 'wc hpos status', array( $this, 'status' ) );
WP_CLI::add_command( 'wc hpos diff', array( $this, 'diff' ) );
WP_CLI::add_command( 'wc hpos backfill', array( $this, 'backfill' ) );
WP_CLI::add_command( 'wc cot migrate', array( $this, 'migrate' ) ); // Fully deprecated. No longer works.
}
/**
@@ -77,7 +87,7 @@ class CLIRunner {
*
* @return bool Whether the COT feature is enabled.
*/
private function is_enabled( $log = true ) : bool {
private function is_enabled( $log = true ): bool {
if ( ! $this->controller->custom_orders_table_usage_is_enabled() ) {
if ( $log ) {
WP_CLI::log(
@@ -98,7 +108,7 @@ class CLIRunner {
*
* ## EXAMPLES
*
* wp wc cot count_unmigrated
* wp wc hpos count_unmigrated
*
* @param array $args Positional arguments passed to the command.
*
@@ -106,7 +116,7 @@ class CLIRunner {
*
* @return int The number of orders to be migrated.*
*/
public function count_unmigrated( $args = array(), $assoc_args = array() ) : int {
public function count_unmigrated( $args = array(), $assoc_args = array() ): int {
// phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
$order_count = $this->synchronizer->get_current_orders_pending_sync_count();
@@ -147,7 +157,7 @@ class CLIRunner {
*
* ## EXAMPLES
*
* wp wc cot sync --batch-size=500
* wp wc hpos sync --batch-size=500
*
* @param array $args Positional arguments passed to the command.
* @param array $assoc_args Associative arguments (options) passed to the command.
@@ -212,13 +222,19 @@ class CLIRunner {
)
);
$batch_count ++;
++$batch_count;
$total_time += $batch_total_time;
$progress->tick();
$orders_remaining = count( $this->synchronizer->get_next_batch_to_process( 1 ) ) > 0;
$order_count = $remaining_count - $batch_size;
if ( function_exists( 'wp_cache_supports' ) && wp_cache_supports( 'flush_runtime' ) ) {
wp_cache_flush_runtime();
}
$GLOBALS['wpdb']->flush();
}
$progress->finish();
@@ -246,7 +262,7 @@ class CLIRunner {
}
/**
* [Deprecated] Use `wp wc cot sync` instead.
* [Deprecated] Use `wp wc hpos sync` instead.
* Copy order data into the postmeta table.
*
* Note that this could dramatically increase the size of your postmeta table, but is recommended
@@ -268,7 +284,7 @@ class CLIRunner {
* @param array $args Positional arguments passed to the command.
* @param array $assoc_args Associative arguments (options) passed to the command.
*/
public function migrate( $args = array(), $assoc_args = array() ) {
public function migrate( array $args = array(), array $assoc_args = array() ) { // phpcs:ignore Generic.CodeAnalysis.UnusedFunctionParameter.FoundAfterLastUsed -- for backwards compat.
WP_CLI::log( __( 'Migrate command is deprecated. Please use `sync` instead.', 'woocommerce' ) );
}
@@ -308,13 +324,12 @@ class CLIRunner {
*
* [--re-migrate]
* : Attempt to re-migrate orders that failed verification. You should only use this option when you have never run the site with HPOS as authoritative source of order data yet, or you have manually checked the reported errors, otherwise, you risk stale data overwriting the more recent data.
* This option can only be enabled when --verbose flag is also set.
* default: false
*
* ## EXAMPLES
*
* # Verify migrated order data, 500 orders at a time.
* wp wc cot verify_cot_data --batch-size=500 --start-from=0 --end-at=10000
* wp wc hpos verify_cot_data --batch-size=500 --start-from=0 --end-at=10000
*
* @param array $args Positional arguments passed to the command.
* @param array $assoc_args Associative arguments (options) passed to the command.
@@ -371,6 +386,8 @@ class CLIRunner {
$progress = WP_CLI\Utils\make_progress_bar( 'Order Data Verification', $order_count / $batch_size );
$error_processing = false;
if ( ! $order_count ) {
return WP_CLI::warning( __( 'There are no orders to verify, aborting.', 'woocommerce' ) );
}
@@ -404,53 +421,70 @@ class CLIRunner {
$failed_ids_in_current_batch = $this->post_to_cot_migrator->verify_migrated_orders( $order_ids );
$failed_ids_in_current_batch = $this->verify_meta_data( $order_ids, $failed_ids_in_current_batch );
$failed_ids = $verbose ? array() : $failed_ids + $failed_ids_in_current_batch;
$error_processing = $error_processing || ! empty( $failed_ids_in_current_batch );
$processed += count( $order_ids );
$batch_total_time = microtime( true ) - $batch_start_time;
$batch_count ++;
++$batch_count;
$total_time += $batch_total_time;
if ( $verbose && count( $failed_ids_in_current_batch ) > 0 ) {
$errors = wp_json_encode( $failed_ids_in_current_batch, JSON_PRETTY_PRINT );
WP_CLI::warning(
sprintf(
/* Translators: %1$d is number of errors and %2$s is the formatted array of order IDs. */
_n(
'%1$d error found: %2$s. Please review the error above.',
'%1$d errors found: %2$s. Please review the errors above.',
count( $failed_ids_in_current_batch ),
'woocommerce'
),
count( $failed_ids_in_current_batch ),
$errors
)
);
if ( $remigrate ) {
if ( count( $failed_ids_in_current_batch ) > 0 ) {
if ( $verbose ) {
$errors = wp_json_encode( $failed_ids_in_current_batch, JSON_PRETTY_PRINT );
WP_CLI::warning(
sprintf(
__( 'Attempting to remigrate...', 'woocommerce' )
/* Translators: %1$d is number of errors and %2$s is the formatted array of order IDs. */
_n(
'%1$d error found: %2$s. Please review the error above.',
'%1$d errors found: %2$s. Please review the errors above.',
count( $failed_ids_in_current_batch ),
'woocommerce'
),
count( $failed_ids_in_current_batch ),
$errors
)
);
$failed_ids = array_keys( $failed_ids_in_current_batch );
$this->synchronizer->process_batch( $failed_ids );
$errors_in_remigrate_batch = $this->post_to_cot_migrator->verify_migrated_orders( $failed_ids );
$errors_in_remigrate_batch = $this->verify_meta_data( $failed_ids, $errors_in_remigrate_batch );
}
if ( $remigrate ) {
$failed_ids = $failed_ids ? array_diff_key( $failed_ids, $failed_ids_in_current_batch ) : array();
$error_processing = ( ! $verbose ) && $failed_ids;
$verbose && WP_CLI::warning( sprintf( __( 'Attempting to remigrate...', 'woocommerce' ) ) );
$failed_ids_in_current_batch_keys = array_keys( $failed_ids_in_current_batch );
$this->synchronizer->process_batch( $failed_ids_in_current_batch_keys );
$errors_in_remigrate_batch = $this->post_to_cot_migrator->verify_migrated_orders( $failed_ids_in_current_batch_keys );
$errors_in_remigrate_batch = $this->verify_meta_data( $failed_ids_in_current_batch_keys, $errors_in_remigrate_batch );
if ( count( $errors_in_remigrate_batch ) > 0 ) {
$error_processing = true;
$formatted_errors = wp_json_encode( $errors_in_remigrate_batch, JSON_PRETTY_PRINT );
WP_CLI::warning(
sprintf(
/* Translators: %1$d is number of errors and %2$s is the formatted array of order IDs. */
_n(
'%1$d error found: %2$s when re-migrating order. Please review the error above.',
'%1$d errors found: %2$s when re-migrating orders. Please review the errors above.',
if ( $verbose ) {
WP_CLI::warning(
sprintf(
/* Translators: %1$d is number of errors and %2$s is the formatted array of order IDs. */
_n(
'%1$d error found: %2$s when re-migrating order. Please review the error above.',
'%1$d errors found: %2$s when re-migrating orders. Please review the errors above.',
count( $errors_in_remigrate_batch ),
'woocommerce'
),
count( $errors_in_remigrate_batch ),
'woocommerce'
),
count( $errors_in_remigrate_batch ),
$formatted_errors
)
);
$formatted_errors
)
);
} else {
array_walk(
$errors_in_remigrate_batch,
function ( &$errors_for_order ) {
$errors_for_order[] = array( 'remigrate_failed' => true );
}
);
$failed_ids = $failed_ids + $errors_in_remigrate_batch;
}
} else {
WP_CLI::warning( 'Re-migration successful.', 'woocommerce' );
$verbose && WP_CLI::warning( 'Re-migration successful.', 'woocommerce' );
}
}
}
@@ -478,11 +512,7 @@ class CLIRunner {
$progress->finish();
WP_CLI::log( __( 'Verification completed.', 'woocommerce' ) );
if ( $verbose ) {
return;
}
if ( 0 === count( $failed_ids ) ) {
if ( ! $error_processing ) {
return WP_CLI::success(
sprintf(
/* Translators: %1$d is the number of migrated orders and %2$d is time taken. */
@@ -497,8 +527,6 @@ class CLIRunner {
)
);
} else {
$errors = wp_json_encode( $failed_ids, JSON_PRETTY_PRINT );
return WP_CLI::error(
sprintf(
'%1$s %2$s',
@@ -513,17 +541,19 @@ class CLIRunner {
$processed,
$total_time
),
sprintf(
/* Translators: %1$d is number of errors and %2$s is the formatted array of order IDs. */
_n(
'%1$d error found: %2$s. Please review the error above.',
'%1$d errors found: %2$s. Please review the errors above.',
$failed_ids
? sprintf(
/* Translators: %1$d is number of errors and %2$s is the formatted array of order IDs. */
_n(
'%1$d error found: %2$s. Please review the error above.',
'%1$d errors found: %2$s. Please review the errors above.',
count( $failed_ids ),
'woocommerce'
),
count( $failed_ids ),
'woocommerce'
),
count( $failed_ids ),
$errors
)
wp_json_encode( $failed_ids, JSON_PRETTY_PRINT )
)
: __( 'Please review the errors above.', 'woocommerce' )
)
);
}
@@ -539,7 +569,7 @@ class CLIRunner {
*
* @return int Order count.
*/
private function get_verify_order_count( int $order_id_start, int $order_id_end, array $order_types, bool $log = true ) : int {
private function get_verify_order_count( int $order_id_start, int $order_id_end, array $order_types, bool $log = true ): int {
global $wpdb;
$order_types_placeholder = implode( ',', array_fill( 0, count( $order_types ), '%s' ) );
@@ -585,7 +615,7 @@ class CLIRunner {
*
* @return array Failed IDs with meta details.
*/
private function verify_meta_data( array $order_ids, array $failed_ids ) : array {
private function verify_meta_data( array $order_ids, array $failed_ids ): array {
$meta_keys_to_ignore = $this->synchronizer->get_ignored_order_props();
global $wpdb;
@@ -665,7 +695,7 @@ ORDER BY $meta_table.order_id ASC, $meta_table.meta_key ASC;
*
* @return array Normalized data.
*/
private function normalize_raw_meta_data( array $data ) : array {
private function normalize_raw_meta_data( array $data ): array {
$clubbed_data = array();
foreach ( $data as $row ) {
if ( ! isset( $clubbed_data[ $row['entity_id'] ] ) ) {
@@ -699,7 +729,7 @@ ORDER BY $meta_table.order_id ASC, $meta_table.meta_key ASC;
* ### EXAMPLES
*
* # Enable HPOS on new shops.
* wp wc cot enable --for-new-shop
* wp wc hpos enable --for-new-shop
*
* @param array $args Positional arguments passed to the command.
* @param array $assoc_args Associative arguments (options) passed to the command.
@@ -758,7 +788,7 @@ ORDER BY $meta_table.order_id ASC, $meta_table.meta_key ASC;
sprintf(
// translators: %s is the command to run (wp wc cot sync).
__( '[Failed] There are orders pending sync. Please run `%s` to sync pending orders.', 'woocommerce' ),
'wp wc cot sync',
'wp wc hpos sync',
)
);
$enable_hpos = false;
@@ -806,7 +836,7 @@ ORDER BY $meta_table.order_id ASC, $meta_table.meta_key ASC;
* ### EXAMPLES
*
* # Disable HPOS.
* wp wc cot disable
* wp wc hpos disable
*
* @param array $args Positional arguments passed to the command.
* @param array $assoc_args Associative arguments (options) passed to the command.
@@ -829,7 +859,7 @@ ORDER BY $meta_table.order_id ASC, $meta_table.meta_key ASC;
sprintf(
// translators: %s is the command to run (wp wc cot sync).
__( '[Failed] There are orders pending sync. Please run `%s` to sync pending orders.', 'woocommerce' ),
'wp wc cot sync',
'wp wc hpos sync',
)
);
}
@@ -918,37 +948,63 @@ ORDER BY $meta_table.order_id ASC, $meta_table.meta_key ASC;
return;
}
$progress = WP_CLI\Utils\make_progress_bar( __( 'HPOS cleanup', 'woocommerce' ), $order_count );
$count = 0;
$progress = WP_CLI\Utils\make_progress_bar( __( 'HPOS cleanup', 'woocommerce' ), $order_count );
$count = 0;
$failed_ids = array();
// translators: %d is the number of orders to clean up.
WP_CLI::log( sprintf( _n( 'Starting cleanup for %d order...', 'Starting cleanup for %d orders...', $order_count, 'woocommerce' ), $order_count ) );
do {
$order_ids = $handler->get_orders_for_cleanup( $q_order_ids, $q_limit );
$failed_ids_in_batch = array();
$order_ids = $handler->get_orders_for_cleanup( $q_order_ids, $q_limit );
if ( $failed_ids && empty( array_diff( $order_ids, $failed_ids ) ) ) {
break;
}
$order_ids = array_diff( $order_ids, $failed_ids ); // Do not reattempt IDs that have already failed.
foreach ( $order_ids as $order_id ) {
try {
$handler->cleanup_post_data( $order_id, $force );
$count++;
++$count;
// translators: %d is an order ID.
WP_CLI::debug( sprintf( __( 'Cleanup completed for order %d.', 'woocommerce' ), $order_id ) );
} catch ( \Exception $e ) {
// translators: %1$d is an order ID, %2$s is an error message.
WP_CLI::warning( sprintf( __( 'An error occurred while cleaning up order %1$d: %2$s', 'woocommerce' ), $order_id, $e->getMessage() ) );
$failed_ids_in_batch[] = $order_id;
}
$progress->tick();
}
$failed_ids = array_merge( $failed_ids, $failed_ids_in_batch );
if ( ! $all_orders ) {
break;
}
if ( $failed_ids_in_batch && ! array_diff( $order_ids, $failed_ids_in_batch ) ) {
WP_CLI::warning( __( 'Failed to clean up all orders in a batch. Aborting.', 'woocommerce' ) );
break;
}
} while ( $order_ids );
$progress->finish();
if ( $failed_ids ) {
return WP_CLI::error(
sprintf(
// translators: %d is the number of orders that were cleaned up.
_n( 'Cleanup completed for %d order. Review errors above.', 'Cleanup completed for %d orders. Review errors above.', $count, 'woocommerce' ),
$count
)
);
}
WP_CLI::success(
sprintf(
// translators: %d is the number of orders that were cleaned up.
@@ -966,7 +1022,7 @@ ORDER BY $meta_table.order_id ASC, $meta_table.meta_key ASC;
* @param array $args Positional arguments passed to the command.
* @param array $assoc_args Associative arguments (options) passed to the command.
*/
public function status( array $args = array(), array $assoc_args = array() ) {
public function status( array $args = array(), array $assoc_args = array() ) { // phpcs:ignore Generic.CodeAnalysis.UnusedFunctionParameter.FoundAfterLastUsed -- for backwards compat.
$legacy_handler = wc_get_container()->get( LegacyDataHandler::class );
// translators: %s is either 'yes' or 'no'.
@@ -1038,11 +1094,15 @@ ORDER BY $meta_table.order_id ASC, $meta_table.meta_key ASC;
// Format the diff array.
$diff = array_map(
function( $key, $hpos_value, $cpt_value ) {
function ( $key, $hpos_value, $cpt_value ) {
// Format for dates.
$hpos_value = is_a( $hpos_value, \WC_DateTime::class ) ? $hpos_value->format( DATE_ATOM ) : $hpos_value;
$cpt_value = is_a( $cpt_value, \WC_DateTime::class ) ? $cpt_value->format( DATE_ATOM ) : $cpt_value;
// Format for NULL.
$hpos_value = is_null( $hpos_value ) ? '' : $hpos_value;
$cpt_value = is_null( $cpt_value ) ? '' : $cpt_value;
return array(
'property' => $key,
'hpos' => $hpos_value,
@@ -1089,6 +1149,12 @@ ORDER BY $meta_table.order_id ASC, $meta_table.meta_key ASC;
* - posts
* ---
*
* [--meta_keys=<meta_keys>]
* : Comma separated list of meta keys to backfill.
*
* [--props=<props>]
* : Comma separated list of order properties to backfill.
*
* @since 8.6.0
*
* @param array $args Positional arguments passed to the command.
@@ -1116,8 +1182,14 @@ ORDER BY $meta_table.order_id ASC, $meta_table.meta_key ASC;
WP_CLI::error( __( 'Please use different source (--from) and destination (--to) datastores.', 'woocommerce' ) );
}
$fields = array_intersect_key( $assoc_args, array_flip( array( 'meta_keys', 'props' ) ) );
foreach ( $fields as &$field_names ) {
$field_names = is_string( $field_names ) ? array_map( 'trim', explode( ',', $field_names ) ) : $field_names;
$field_names = array_unique( array_filter( array_filter( $field_names, 'is_string' ) ) );
}
try {
$legacy_handler->backfill_order_to_datastore( $order_id, $from, $to );
$legacy_handler->backfill_order_to_datastore( $order_id, $from, $to, $fields );
} catch ( \Exception $e ) {
WP_CLI::error(
sprintf(
@@ -1141,5 +1213,4 @@ ORDER BY $meta_table.order_id ASC, $meta_table.meta_key ASC;
)
);
}
}