1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
|
<?php
/**
* Full sync module.
*
* @package automattic/jetpack-sync
*/
namespace Automattic\Jetpack\Sync\Modules;
use Automattic\Jetpack\Sync\Listener;
use Automattic\Jetpack\Sync\Lock;
use Automattic\Jetpack\Sync\Modules;
use Automattic\Jetpack\Sync\Queue;
use Automattic\Jetpack\Sync\Settings;
/**
* This class does a full resync of the database by
* enqueuing an outbound action for every single object
* that we care about.
*
* This class, and its related class Jetpack_Sync_Module, contain a few non-obvious optimisations that should be explained:
* - we fire an action called jetpack_full_sync_start so that WPCOM can erase the contents of the cached database
* - for each object type, we page through the object IDs and enqueue them by firing some monitored actions
* - we load the full objects for those IDs in chunks of Jetpack_Sync_Module::ARRAY_CHUNK_SIZE (to reduce the number of MySQL calls)
* - we fire a trigger for the entire array which the Automattic\Jetpack\Sync\Listener then serializes and queues.
*/
class Full_Sync extends Module {
/**
* Prefix of the full sync status option name.
*
* @var string
*/
const STATUS_OPTION_PREFIX = 'jetpack_sync_full_';
/**
* Enqueue Lock name.
*
* @var string
*/
const ENQUEUE_LOCK_NAME = 'full_sync_enqueue';
/**
* Sync module name.
*
* @access public
*
* @return string
*/
public function name() {
return 'full-sync';
}
/**
* Initialize action listeners for full sync.
*
* @access public
*
* @param callable $callable Action handler callable.
*/
public function init_full_sync_listeners( $callable ) {
// Synthetic actions for full sync.
add_action( 'jetpack_full_sync_start', $callable, 10, 3 );
add_action( 'jetpack_full_sync_end', $callable, 10, 2 );
add_action( 'jetpack_full_sync_cancelled', $callable );
}
/**
* Initialize the module in the sender.
*
* @access public
*/
public function init_before_send() {
// This is triggered after actions have been processed on the server.
add_action( 'jetpack_sync_processed_actions', array( $this, 'update_sent_progress_action' ) );
}
/**
* Start a full sync.
*
* @access public
*
* @param array $module_configs Full sync configuration for all sync modules.
* @return bool Always returns true at success.
*/
public function start( $module_configs = null ) {
$was_already_running = $this->is_started() && ! $this->is_finished();
// Remove all evidence of previous full sync items and status.
$this->reset_data();
if ( $was_already_running ) {
/**
* Fires when a full sync is cancelled.
*
* @since 1.6.3
* @since-jetpack 4.2.0
*/
do_action( 'jetpack_full_sync_cancelled' );
}
$this->update_status_option( 'started', time() );
$this->update_status_option( 'params', $module_configs );
$enqueue_status = array();
$full_sync_config = array();
$include_empty = false;
$empty = array();
// Default value is full sync.
if ( ! is_array( $module_configs ) ) {
$module_configs = array();
$include_empty = true;
foreach ( Modules::get_modules() as $module ) {
$module_configs[ $module->name() ] = true;
}
}
// Set default configuration, calculate totals, and save configuration if totals > 0.
foreach ( Modules::get_modules() as $module ) {
$module_name = $module->name();
$module_config = isset( $module_configs[ $module_name ] ) ? $module_configs[ $module_name ] : false;
if ( ! $module_config ) {
continue;
}
if ( 'users' === $module_name && 'initial' === $module_config ) {
$module_config = $module->get_initial_sync_user_config();
}
$enqueue_status[ $module_name ] = false;
$total_items = $module->estimate_full_sync_actions( $module_config );
// If there's information to process, configure this module.
if ( ! is_null( $total_items ) && $total_items > 0 ) {
$full_sync_config[ $module_name ] = $module_config;
$enqueue_status[ $module_name ] = array(
$total_items, // Total.
0, // Queued.
false, // Current state.
);
} elseif ( $include_empty && 0 === $total_items ) {
$empty[ $module_name ] = true;
}
}
$this->set_config( $full_sync_config );
$this->set_enqueue_status( $enqueue_status );
$range = $this->get_content_range( $full_sync_config );
/**
* Fires when a full sync begins. This action is serialized
* and sent to the server so that it knows a full sync is coming.
*
* @since 1.6.3
* @since-jetpack 4.2.0
* @since-jetpack 7.3.0 Added $range arg.
* @since-jetpack 7.4.0 Added $empty arg.
*
* @param array $full_sync_config Sync configuration for all sync modules.
* @param array $range Range of the sync items, containing min and max IDs for some item types.
* @param array $empty The modules with no items to sync during a full sync.
*/
do_action( 'jetpack_full_sync_start', $full_sync_config, $range, $empty );
$this->continue_enqueuing( $full_sync_config );
return true;
}
/**
* Enqueue the next items to sync.
*
* @access public
*
* @param array $configs Full sync configuration for all sync modules.
*/
public function continue_enqueuing( $configs = null ) {
// Return early if not in progress.
if ( ! $this->get_status_option( 'started' ) || $this->get_status_option( 'queue_finished' ) ) {
return;
}
// Attempt to obtain lock.
$lock = new Lock();
$lock_expiration = $lock->attempt( self::ENQUEUE_LOCK_NAME );
// Return if unable to obtain lock.
if ( false === $lock_expiration ) {
return;
}
// enqueue full sync actions.
$this->enqueue( $configs );
// Remove lock.
$lock->remove( self::ENQUEUE_LOCK_NAME, $lock_expiration );
}
/**
* Get Modules that are configured to Full Sync and haven't finished enqueuing
*
* @param array $configs Full sync configuration for all sync modules.
*
* @return array
*/
public function get_remaining_modules_to_enqueue( $configs ) {
$enqueue_status = $this->get_enqueue_status();
return array_filter(
Modules::get_modules(),
/**
* Select configured and not finished modules.
*
* @var $module Module
* @return bool
*/
function ( $module ) use ( $configs, $enqueue_status ) {
// Skip module if not configured for this sync or module is done.
if ( ! isset( $configs[ $module->name() ] ) ) {
return false;
}
if ( ! $configs[ $module->name() ] ) {
return false;
}
if ( isset( $enqueue_status[ $module->name() ][2] ) ) {
if ( true === $enqueue_status[ $module->name() ][2] ) {
return false;
}
}
return true;
}
);
}
/**
* Enqueue the next items to sync.
*
* @access public
*
* @param array $configs Full sync configuration for all sync modules.
*/
public function enqueue( $configs = null ) {
if ( ! $configs ) {
$configs = $this->get_config();
}
$enqueue_status = $this->get_enqueue_status();
$full_sync_queue = new Queue( 'full_sync' );
$available_queue_slots = Settings::get_setting( 'max_queue_size_full_sync' ) - $full_sync_queue->size();
if ( $available_queue_slots <= 0 ) {
return;
}
$remaining_items_to_enqueue = min( Settings::get_setting( 'max_enqueue_full_sync' ), $available_queue_slots );
/**
* If a module exits early (e.g. because it ran out of full sync queue slots, or we ran out of request time)
* then it should exit early
*/
foreach ( $this->get_remaining_modules_to_enqueue( $configs ) as $module ) {
list( $items_enqueued, $next_enqueue_state ) = $module->enqueue_full_sync_actions( $configs[ $module->name() ], $remaining_items_to_enqueue, $enqueue_status[ $module->name() ][2] );
$enqueue_status[ $module->name() ][2] = $next_enqueue_state;
// If items were processed, subtract them from the limit.
if ( ! is_null( $items_enqueued ) && $items_enqueued > 0 ) {
$enqueue_status[ $module->name() ][1] += $items_enqueued;
$remaining_items_to_enqueue -= $items_enqueued;
}
if ( 0 >= $remaining_items_to_enqueue || true !== $next_enqueue_state ) {
$this->set_enqueue_status( $enqueue_status );
return;
}
}
$this->queue_full_sync_end( $configs );
$this->set_enqueue_status( $enqueue_status );
}
/**
* Enqueue 'jetpack_full_sync_end' and update 'queue_finished' status.
*
* @access public
*
* @param array $configs Full sync configuration for all sync modules.
*/
public function queue_full_sync_end( $configs ) {
$range = $this->get_content_range( $configs );
/**
* Fires when a full sync ends. This action is serialized
* and sent to the server.
*
* @since 1.6.3
* @since-jetpack 4.2.0
* @since-jetpack 7.3.0 Added $range arg.
*
* @param string $checksum Deprecated since 7.3.0 - @see https://github.com/Automattic/jetpack/pull/11945/
* @param array $range Range of the sync items, containing min and max IDs for some item types.
*/
do_action( 'jetpack_full_sync_end', '', $range );
// Setting autoload to true means that it's faster to check whether we should continue enqueuing.
$this->update_status_option( 'queue_finished', time(), true );
}
/**
* Get the range (min ID, max ID and total items) of items to sync.
*
* @access public
*
* @param string $type Type of sync item to get the range for.
* @return array Array of min ID, max ID and total items in the range.
*/
public function get_range( $type ) {
global $wpdb;
if ( ! in_array( $type, array( 'comments', 'posts' ), true ) ) {
return array();
}
switch ( $type ) {
case 'posts':
$table = $wpdb->posts;
$id = 'ID';
$where_sql = Settings::get_blacklisted_post_types_sql();
break;
case 'comments':
$table = $wpdb->comments;
$id = 'comment_ID';
$where_sql = Settings::get_comments_filter_sql();
break;
}
// TODO: Call $wpdb->prepare on the following query.
// phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared
$results = $wpdb->get_results( "SELECT MAX({$id}) as max, MIN({$id}) as min, COUNT({$id}) as count FROM {$table} WHERE {$where_sql}" );
if ( isset( $results[0] ) ) {
return $results[0];
}
return array();
}
/**
* Get the range for content (posts and comments) to sync.
*
* @access private
*
* @param array $config Full sync configuration for this all sync modules.
* @return array Array of range (min ID, max ID, total items) for all content types.
*/
private function get_content_range( $config ) {
$range = array();
// Only when we are sending the whole range do we want to send also the range.
if ( true === isset( $config['posts'] ) && $config['posts'] ) {
$range['posts'] = $this->get_range( 'posts' );
}
if ( true === isset( $config['comments'] ) && $config['comments'] ) {
$range['comments'] = $this->get_range( 'comments' );
}
return $range;
}
/**
* Update the progress after sync modules actions have been processed on the server.
*
* @access public
*
* @param array $actions Actions that have been processed on the server.
*/
public function update_sent_progress_action( $actions ) {
// Quick way to map to first items with an array of arrays.
$actions_with_counts = array_count_values( array_filter( array_map( array( $this, 'get_action_name' ), $actions ) ) );
// Total item counts for each action.
$actions_with_total_counts = $this->get_actions_totals( $actions );
if ( ! $this->is_started() || $this->is_finished() ) {
return;
}
if ( isset( $actions_with_counts['jetpack_full_sync_start'] ) ) {
$this->update_status_option( 'send_started', time() );
}
foreach ( Modules::get_modules() as $module ) {
$module_actions = $module->get_full_sync_actions();
$status_option_name = "{$module->name()}_sent";
$total_option_name = "{$status_option_name}_total";
$items_sent = $this->get_status_option( $status_option_name, 0 );
$items_sent_total = $this->get_status_option( $total_option_name, 0 );
foreach ( $module_actions as $module_action ) {
if ( isset( $actions_with_counts[ $module_action ] ) ) {
$items_sent += $actions_with_counts[ $module_action ];
}
if ( ! empty( $actions_with_total_counts[ $module_action ] ) ) {
$items_sent_total += $actions_with_total_counts[ $module_action ];
}
}
if ( $items_sent > 0 ) {
$this->update_status_option( $status_option_name, $items_sent );
}
if ( 0 !== $items_sent_total ) {
$this->update_status_option( $total_option_name, $items_sent_total );
}
}
if ( isset( $actions_with_counts['jetpack_full_sync_end'] ) ) {
$this->update_status_option( 'finished', time() );
}
}
/**
* Returns the progress percentage of a full sync.
*
* @access public
*
* @return int|null
*/
public function get_sync_progress_percentage() {
if ( ! $this->is_started() || $this->is_finished() ) {
return null;
}
$status = $this->get_status();
if ( ! $status['queue'] || ! $status['sent'] || ! $status['total'] ) {
return null;
}
$queued_multiplier = 0.1;
$sent_multiplier = 0.9;
$count_queued = array_reduce(
$status['queue'],
function ( $sum, $value ) {
return $sum + $value;
},
0
);
$count_sent = array_reduce(
$status['sent'],
function ( $sum, $value ) {
return $sum + $value;
},
0
);
$count_total = array_reduce(
$status['total'],
function ( $sum, $value ) {
return $sum + $value;
},
0
);
$percent_queued = ( $count_queued / $count_total ) * $queued_multiplier * 100;
$percent_sent = ( $count_sent / $count_total ) * $sent_multiplier * 100;
return ceil( $percent_queued + $percent_sent );
}
/**
* Get the name of the action for an item in the sync queue.
*
* @access public
*
* @param array $queue_item Item of the sync queue.
* @return string|boolean Name of the action, false if queue item is invalid.
*/
public function get_action_name( $queue_item ) {
if ( is_array( $queue_item ) && isset( $queue_item[0] ) ) {
return $queue_item[0];
}
return false;
}
/**
* Retrieve the total number of items we're syncing in a particular queue item (action).
* `$queue_item[1]` is expected to contain chunks of items, and `$queue_item[1][0]`
* represents the first (and only) chunk of items to sync in that action.
*
* @access public
*
* @param array $queue_item Item of the sync queue that corresponds to a particular action.
* @return int Total number of items in the action.
*/
public function get_action_totals( $queue_item ) {
if ( is_array( $queue_item ) && isset( $queue_item[1][0] ) ) {
if ( is_array( $queue_item[1][0] ) ) {
// Let's count the items we sync in this action.
return count( $queue_item[1][0] );
}
// -1 indicates that this action syncs all items by design.
return -1;
}
return 0;
}
/**
* Retrieve the total number of items for a set of actions, grouped by action name.
*
* @access public
*
* @param array $actions An array of actions.
* @return array An array, representing the total number of items, grouped per action.
*/
public function get_actions_totals( $actions ) {
$totals = array();
foreach ( $actions as $action ) {
$name = $this->get_action_name( $action );
$action_totals = $this->get_action_totals( $action );
if ( ! isset( $totals[ $name ] ) ) {
$totals[ $name ] = 0;
}
$totals[ $name ] += $action_totals;
}
return $totals;
}
/**
* Whether full sync has started.
*
* @access public
*
* @return boolean
*/
public function is_started() {
return (bool) $this->get_status_option( 'started' );
}
/**
* Whether full sync has finished.
*
* @access public
*
* @return boolean
*/
public function is_finished() {
return (bool) $this->get_status_option( 'finished' );
}
/**
* Retrieve the status of the current full sync.
*
* @access public
*
* @return array Full sync status.
*/
public function get_status() {
$status = array(
'started' => $this->get_status_option( 'started' ),
'queue_finished' => $this->get_status_option( 'queue_finished' ),
'send_started' => $this->get_status_option( 'send_started' ),
'finished' => $this->get_status_option( 'finished' ),
'sent' => array(),
'sent_total' => array(),
'queue' => array(),
'config' => $this->get_status_option( 'params' ),
'total' => array(),
);
$enqueue_status = $this->get_enqueue_status();
foreach ( Modules::get_modules() as $module ) {
$name = $module->name();
if ( ! isset( $enqueue_status[ $name ] ) ) {
continue;
}
list( $total, $queued ) = $enqueue_status[ $name ];
if ( $total ) {
$status['total'][ $name ] = $total;
}
if ( $queued ) {
$status['queue'][ $name ] = $queued;
}
$sent = $this->get_status_option( "{$name}_sent" );
if ( $sent ) {
$status['sent'][ $name ] = $sent;
}
$sent_total = $this->get_status_option( "{$name}_sent_total" );
if ( $sent_total ) {
$status['sent_total'][ $name ] = $sent_total;
}
}
return $status;
}
/**
* Clear all the full sync status options.
*
* @access public
*/
public function clear_status() {
$prefix = self::STATUS_OPTION_PREFIX;
\Jetpack_Options::delete_raw_option( "{$prefix}_started" );
\Jetpack_Options::delete_raw_option( "{$prefix}_params" );
\Jetpack_Options::delete_raw_option( "{$prefix}_queue_finished" );
\Jetpack_Options::delete_raw_option( "{$prefix}_send_started" );
\Jetpack_Options::delete_raw_option( "{$prefix}_finished" );
$this->delete_enqueue_status();
foreach ( Modules::get_modules() as $module ) {
\Jetpack_Options::delete_raw_option( "{$prefix}_{$module->name()}_sent" );
\Jetpack_Options::delete_raw_option( "{$prefix}_{$module->name()}_sent_total" );
}
}
/**
* Clear all the full sync data.
*
* @access public
*/
public function reset_data() {
$this->clear_status();
$this->delete_config();
( new Lock() )->remove( self::ENQUEUE_LOCK_NAME, true );
$listener = Listener::get_instance();
$listener->get_full_sync_queue()->reset();
}
/**
* Get the value of a full sync status option.
*
* @access private
*
* @param string $name Name of the option.
* @param mixed $default Default value of the option.
* @return mixed Option value.
*/
private function get_status_option( $name, $default = null ) {
$value = \Jetpack_Options::get_raw_option( self::STATUS_OPTION_PREFIX . "_$name", $default );
return is_numeric( $value ) ? (int) $value : $value;
}
/**
* Update the value of a full sync status option.
*
* @access private
*
* @param string $name Name of the option.
* @param mixed $value Value of the option.
* @param boolean $autoload Whether the option should be autoloaded at the beginning of the request.
*/
private function update_status_option( $name, $value, $autoload = false ) {
\Jetpack_Options::update_raw_option( self::STATUS_OPTION_PREFIX . "_$name", $value, $autoload );
}
/**
* Set the full sync enqueue status.
*
* @access private
*
* @param array $new_status The new full sync enqueue status.
*/
private function set_enqueue_status( $new_status ) {
\Jetpack_Options::update_raw_option( 'jetpack_sync_full_enqueue_status', $new_status );
}
/**
* Delete full sync enqueue status.
*
* @access private
*
* @return boolean Whether the status was deleted.
*/
private function delete_enqueue_status() {
return \Jetpack_Options::delete_raw_option( 'jetpack_sync_full_enqueue_status' );
}
/**
* Retrieve the current full sync enqueue status.
*
* @access private
*
* @return array Full sync enqueue status.
*/
public function get_enqueue_status() {
return \Jetpack_Options::get_raw_option( 'jetpack_sync_full_enqueue_status' );
}
/**
* Set the full sync enqueue configuration.
*
* @access private
*
* @param array $config The new full sync enqueue configuration.
*/
private function set_config( $config ) {
\Jetpack_Options::update_raw_option( 'jetpack_sync_full_config', $config );
}
/**
* Delete full sync configuration.
*
* @access private
*
* @return boolean Whether the configuration was deleted.
*/
private function delete_config() {
return \Jetpack_Options::delete_raw_option( 'jetpack_sync_full_config' );
}
/**
* Retrieve the current full sync enqueue config.
*
* @access private
*
* @return array Full sync enqueue config.
*/
private function get_config() {
return \Jetpack_Options::get_raw_option( 'jetpack_sync_full_config' );
}
}
|