Jetpack_Sync_Module_Full_Sync::clear_status() - Code Metrics - Inspection of "Cancel previous sync when starting a new one" - Automattic/jetpack - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — fix/reset-previous-full-sync-w... ( d1037b )

unknown

created 2016-07-28 17:14 UTC

Jetpack_Sync_Module_Full_Sync::clear_status() A

↳ Parent: Jetpack_Sync_Module_Full_Sync

Complexity

Conditions	2
Paths	2

Size

Total Lines	12
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	1	Features	0

Metric	Value
cc	2
eloc	9
c	2
b	1
f	0
nc	2
nop	0
dl	0
loc	12
rs	9.4285

<?php

/**
 * 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 Jetpack_Sync_Listener then serializes and queues.
 */

require_once 'class.jetpack-sync-wp-replicastore.php';

class Jetpack_Sync_Module_Full_Sync extends Jetpack_Sync_Module {
	const STATUS_OPTION_PREFIX = 'jetpack_sync_full_';
	const FULL_SYNC_TIMEOUT = 3600;

	public function name() {
		return 'full-sync';
	}

	function init_full_sync_listeners( $callable ) {
		// synthetic actions for full sync
		add_action( 'jetpack_full_sync_start', $callable );
		add_action( 'jetpack_full_sync_end', $callable );
		add_action( 'jetpack_full_sync_cancelled', $callable );
	}

	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' ) );
	}

	function start( $modules = null ) {
		// ensure listener is loaded so we can guarantee full sync actions are enqueued
		require_once dirname( __FILE__ ) . '/class.jetpack-sync-listener.php';
		Jetpack_Sync_Listener::get_instance();

		$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 ) {
			do_action( 'jetpack_full_sync_cancelled' );
		}

		/**
		 * 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 4.2.0
		 */
		do_action( 'jetpack_full_sync_start' );
		$this->update_status_option( "started", time() );

		foreach ( Jetpack_Sync_Modules::get_modules() as $module ) {
			$module_name = $module->name();
			if ( is_array( $modules ) && ! in_array( $module_name, $modules ) ) {
				continue;
			}

			$items_enqueued = $module->enqueue_full_sync_actions();
			if ( ! is_null( $items_enqueued ) && $items_enqueued > 0 ) {
				// TODO: only update this once every N items, then at end - why cause all that DB churn?

				$this->update_status_option( "{$module->name()}_queued", $items_enqueued );
			}
		}

		$this->update_status_option( "queue_finished", time() );

		$store = new Jetpack_Sync_WP_Replicastore();

		/**
		 * Fires when a full sync ends. This action is serialized
		 * and sent to the server with checksums so that we can confirm the
		 * sync was successful.
		 *
		 * @since 4.2.0
		 */
		do_action( 'jetpack_full_sync_end', $store->checksum_all() );

		return true;
	}

	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_map( 'reset', $actions ) );

		if ( ! $this->is_started() || $this->is_finished() ) {
			return;
		}

		if ( isset( $actions_with_counts['jetpack_full_sync_start'] ) ) {
			$this->update_status_option( "sent_started", time() );
		}

		foreach ( Jetpack_Sync_Modules::get_modules() as $module ) {
			$module_actions = $module->get_full_sync_actions();
			$items_sent     = 0;
			foreach ( $module_actions as $module_action ) {
				if ( isset( $actions_with_counts[ $module_action ] ) ) {
					$items_sent += $actions_with_counts[ $module_action ];
				}
			}

			if ( $items_sent > 0 ) {
				$this->update_status_option( "{$module->name()}_sent", $items_sent );
			}	
		}

		if ( isset( $actions_with_counts['jetpack_full_sync_end'] ) ) {
			$this->update_status_option( "finished", time() );
		}
	}

	public function is_started() {
		return !! $this->get_status_option( "started" );
	}

	public function is_finished() {
		return !! $this->get_status_option( "finished" );
	}

	public function get_status() {
		$status = array(
			'started'        => $this->get_status_option( 'started' ),
			'queue_finished' => $this->get_status_option( 'queue_finished' ),
			'sent_started'   => $this->get_status_option( 'sent_started' ),
			'finished'       => $this->get_status_option( 'finished' ),
			'sent'           => array(),
			'queue'          => array(),
		);

		foreach ( Jetpack_Sync_Modules::get_modules() as $module ) {
			$queued = $this->get_status_option( "{$module->name()}_queued" );
			$sent   = $this->get_status_option( "{$module->name()}_sent" );

			if ( $queued ) {
0   == false // true
0   == null  // true
123 == false // false
123 == null  // false

// It is often better to use strict comparison
0 === false // false
0 === null  // false
				$status[ 'queue' ][ $module->name() ] = $queued;
			}
			
			if ( $sent ) {
0   == false // true
0   == null  // true
123 == false // false
123 == null  // false

// It is often better to use strict comparison
0 === false // false
0 === null  // false
				$status[ 'sent' ][ $module->name() ] = $sent;
			}
		}

		return $status;
	}

	public function clear_status() {
		$prefix = self::STATUS_OPTION_PREFIX;
		delete_option( "{$prefix}_started" );
		delete_option( "{$prefix}_queue_finished" );
		delete_option( "{$prefix}_sent_started" );
		delete_option( "{$prefix}_finished" );

		foreach ( Jetpack_Sync_Modules::get_modules() as $module ) {
			delete_option( "{$prefix}_{$module->name()}_queued" );
			delete_option( "{$prefix}_{$module->name()}_sent" );
		}
	}

	public function reset_data() {
		$this->clear_status();
		$listener = Jetpack_Sync_Listener::get_instance();
		$listener->get_full_sync_queue()->reset();
	}

	private function get_status_option( $option ) {
		$prefix = self::STATUS_OPTION_PREFIX;

		$value = get_option( "{$prefix}_{$option}", null );
		
		if ( ! $value ) {
			return null;
		}

		return intval( $value );
	}

	private function update_status_option( $name, $value ) {
		$prefix = self::STATUS_OPTION_PREFIX;
		/**
		 * Allowing update_option to change autoload status only shipped in WordPress v4.2
		 * @link https://github.com/WordPress/WordPress/commit/305cf8b95
		 */
		if ( version_compare( $GLOBALS['wp_version'], '4.2', '>=' ) ) {
			update_option( "{$prefix}_{$name}", $value, false );
		} else {
			update_option( "{$prefix}_{$name}", $value );
		}
	}
}


1			<?php
2
3			/**
4			* This class does a full resync of the database by
5			* enqueuing an outbound action for every single object
6			* that we care about.
7			*
8			* This class, and its related class Jetpack_Sync_Module, contain a few non-obvious optimisations that should be explained:
9			* - we fire an action called jetpack_full_sync_start so that WPCOM can erase the contents of the cached database
10			* - for each object type, we page through the object IDs and enqueue them by firing some monitored actions
11			* - we load the full objects for those IDs in chunks of Jetpack_Sync_Module::ARRAY_CHUNK_SIZE (to reduce the number of MySQL calls)
12			* - we fire a trigger for the entire array which the Jetpack_Sync_Listener then serializes and queues.
13			*/
14
15			require_once 'class.jetpack-sync-wp-replicastore.php';
16
17			class Jetpack_Sync_Module_Full_Sync extends Jetpack_Sync_Module {
18			const STATUS_OPTION_PREFIX = 'jetpack_sync_full_';
19			const FULL_SYNC_TIMEOUT = 3600;
20
21			public function name() {
22			return 'full-sync';
23			}
24
25			function init_full_sync_listeners( $callable ) {
26			// synthetic actions for full sync
27			add_action( 'jetpack_full_sync_start', $callable );
28			add_action( 'jetpack_full_sync_end', $callable );
29			add_action( 'jetpack_full_sync_cancelled', $callable );
30			}
31
32			function init_before_send() {
33			// this is triggered after actions have been processed on the server
34			add_action( 'jetpack_sync_processed_actions', array( $this, 'update_sent_progress_action' ) );
35			}
36
37			function start( $modules = null ) {
38			// ensure listener is loaded so we can guarantee full sync actions are enqueued
39			require_once dirname( __FILE__ ) . '/class.jetpack-sync-listener.php';
40			Jetpack_Sync_Listener::get_instance();
41
42			$was_already_running = $this->is_started() && ! $this->is_finished();
43
44			// remove all evidence of previous full sync items and status
45			$this->reset_data();
46
47			if ( $was_already_running ) {
48			do_action( 'jetpack_full_sync_cancelled' );
49			}
50
51			/**
52			* Fires when a full sync begins. This action is serialized
53			* and sent to the server so that it knows a full sync is coming.
54			*
55			* @since 4.2.0
56			*/
57			do_action( 'jetpack_full_sync_start' );
58			$this->update_status_option( "started", time() );
59
60			foreach ( Jetpack_Sync_Modules::get_modules() as $module ) {
61			$module_name = $module->name();
62			if ( is_array( $modules ) && ! in_array( $module_name, $modules ) ) {
63			continue;
64			}
65
66			$items_enqueued = $module->enqueue_full_sync_actions();
67			if ( ! is_null( $items_enqueued ) && $items_enqueued > 0 ) {
68			// TODO: only update this once every N items, then at end - why cause all that DB churn?
			0 ignored issues – show Coding Style Best Practice introduced 2016-07-26 04:55 UTC by Report Bug Copy Issue Report Comments for TODO tasks are often forgotten in the code; it might be better to use a dedicated issue tracker. Loading history...
69			$this->update_status_option( "{$module->name()}_queued", $items_enqueued );
70			}
71			}
72
73			$this->update_status_option( "queue_finished", time() );
74
75			$store = new Jetpack_Sync_WP_Replicastore();
76
77			/**
78			* Fires when a full sync ends. This action is serialized
79			* and sent to the server with checksums so that we can confirm the
80			* sync was successful.
81			*
82			* @since 4.2.0
83			*/
84			do_action( 'jetpack_full_sync_end', $store->checksum_all() );
85
86			return true;
87			}
88
89			function update_sent_progress_action( $actions ) {
90
91			// quick way to map to first items with an array of arrays
92			$actions_with_counts = array_count_values( array_map( 'reset', $actions ) );
93
94			if ( ! $this->is_started() \|\| $this->is_finished() ) {
95			return;
96			}
97
98			if ( isset( $actions_with_counts['jetpack_full_sync_start'] ) ) {
99			$this->update_status_option( "sent_started", time() );
100			}
101
102			foreach ( Jetpack_Sync_Modules::get_modules() as $module ) {
103			$module_actions = $module->get_full_sync_actions();
104			$items_sent = 0;
105			foreach ( $module_actions as $module_action ) {
106			if ( isset( $actions_with_counts[ $module_action ] ) ) {
107			$items_sent += $actions_with_counts[ $module_action ];
108			}
109			}
110
111			if ( $items_sent > 0 ) {
112			$this->update_status_option( "{$module->name()}_sent", $items_sent );
113			}
114			}
115
116			if ( isset( $actions_with_counts['jetpack_full_sync_end'] ) ) {
117			$this->update_status_option( "finished", time() );
118			}
119			}
120
121			public function is_started() {
122			return !! $this->get_status_option( "started" );
123			}
124
125			public function is_finished() {
126			return !! $this->get_status_option( "finished" );
127			}
128
129			public function get_status() {
130			$status = array(
131			'started' => $this->get_status_option( 'started' ),
132			'queue_finished' => $this->get_status_option( 'queue_finished' ),
133			'sent_started' => $this->get_status_option( 'sent_started' ),
134			'finished' => $this->get_status_option( 'finished' ),
135			'sent' => array(),
136			'queue' => array(),
137			);
138
139			foreach ( Jetpack_Sync_Modules::get_modules() as $module ) {
140			$queued = $this->get_status_option( "{$module->name()}_queued" );
141			$sent = $this->get_status_option( "{$module->name()}_sent" );
142
143			if ( $queued ) {
			0 ignored issues – show Bug Best Practice introduced 2016-07-26 23:08 UTC by Report Bug Copy Issue Report The expression `$queued` of type `null\|integer` is loosely compared to `true`; this is ambiguous if the integer can be zero. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `integer` values, zero is a special case, in particular the following results might be unexpected: 0 == false // true 0 == null // true 123 == false // false 123 == null // false // It is often better to use strict comparison 0 === false // false 0 === null // false Loading history...
144			$status[ 'queue' ][ $module->name() ] = $queued;
145			}
146
147			if ( $sent ) {
			0 ignored issues – show Bug Best Practice introduced 2016-07-26 23:08 UTC by Report Bug Copy Issue Report The expression `$sent` of type `null\|integer` is loosely compared to `true`; this is ambiguous if the integer can be zero. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `integer` values, zero is a special case, in particular the following results might be unexpected: 0 == false // true 0 == null // true 123 == false // false 123 == null // false // It is often better to use strict comparison 0 === false // false 0 === null // false Loading history...
148			$status[ 'sent' ][ $module->name() ] = $sent;
149			}
150			}
151
152			return $status;
153			}
154
155			public function clear_status() {
156			$prefix = self::STATUS_OPTION_PREFIX;
157			delete_option( "{$prefix}_started" );
158			delete_option( "{$prefix}_queue_finished" );
159			delete_option( "{$prefix}_sent_started" );
160			delete_option( "{$prefix}_finished" );
161
162			foreach ( Jetpack_Sync_Modules::get_modules() as $module ) {
163			delete_option( "{$prefix}_{$module->name()}_queued" );
164			delete_option( "{$prefix}_{$module->name()}_sent" );
165			}
166			}
167
168			public function reset_data() {
169			$this->clear_status();
170			$listener = Jetpack_Sync_Listener::get_instance();
171			$listener->get_full_sync_queue()->reset();
172			}
173
174			private function get_status_option( $option ) {
175			$prefix = self::STATUS_OPTION_PREFIX;
176
177			$value = get_option( "{$prefix}_{$option}", null );
178
179			if ( ! $value ) {
180			return null;
181			}
182
183			return intval( $value );
184			}
185
186			private function update_status_option( $name, $value ) {
187			$prefix = self::STATUS_OPTION_PREFIX;
188			/**
189			* Allowing update_option to change autoload status only shipped in WordPress v4.2
190			* @link https://github.com/WordPress/WordPress/commit/305cf8b95
191			*/
192			if ( version_compare( $GLOBALS['wp_version'], '4.2', '>=' ) ) {
193			update_option( "{$prefix}_{$name}", $value, false );
194			} else {
195			update_option( "{$prefix}_{$name}", $value );
196			}
197			}
198			}
199

Automattic / jetpack

Push — fix/reset-previous-full-sync-w... ( d1037b )

Jetpack_Sync_Module_Full_Sync::clear_status() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like