Jetpack_Sync_Module_Full_Sync::get_action_name() - Code Metrics - Inspection of "Update to return next sync time separately for ful..." - Automattic/jetpack - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — update/sync-status-endpoint-ad... ( 2994d8...5ec62d )

unknown

created 2016-09-14 16:53 UTC

Jetpack_Sync_Module_Full_Sync::get_action_name() A

↳ Parent: Jetpack_Sync_Module_Full_Sync

Complexity

Conditions	3
Paths	2

Size

Total Lines	6
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	3
eloc	4
nc	2
nop	1
dl	0
loc	6
rs	9.4285
c	0
b	0
f	0

<?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;

	private $items_added_since_last_pause;
	private $last_pause_time;
	private $queue_rate_limit;

	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 ) {
		$was_already_running = $this->is_started() && ! $this->is_finished();

		// remove all evidence of previous full sync items and status
		$this->reset_data();

		$this->enable_queue_rate_limit();

		if ( $was_already_running ) {
			/**
			 * Fires when a full sync is cancelled.
			 *
			 * @since 4.2.0
			 */
			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', $modules );
		$this->update_status_option( 'started', time() );

		// configure modules
		if ( ! is_array( $modules ) ) {
			$modules = array();
		}

		if ( isset( $modules['users'] ) && 'initial' === $modules['users'] ) {
			$user_module = Jetpack_Sync_Modules::get_module( 'users' );
			$modules['users'] = $user_module->get_initial_sync_user_config();
		}

		// by default, all modules are fully enabled
		if ( count( $modules ) === 0 ) {
			$default_module_config = true;
		} else {
			$default_module_config = false;
		}

		// set default configuration, calculate totals, and save configuration if totals > 0
		foreach ( Jetpack_Sync_Modules::get_modules() as $module ) {
			$module_name = $module->name();
			if ( ! isset( $modules[ $module_name ] ) ) {
				$modules[ $module_name ] = $default_module_config;
			}

			// check if this module is enabled
			if ( ! ( $module_config = $modules[ $module_name ] ) ) {
				continue;
			}

			$total_items = $module->estimate_full_sync_actions( $module_config );

			if ( ! is_null( $total_items ) && $total_items > 0 ) {
				$this->update_status_option( "{$module_name}_total", $total_items );
				$this->update_status_option( "{$module_name}_config", $module_config );
			}
		}

		foreach ( Jetpack_Sync_Modules::get_modules() as $module ) {
			$module_name   = $module->name();
			$module_config = $modules[ $module_name ];

			// check if this module is enabled
			if ( ! $module_config ) {
				continue;
			}

			$items_enqueued = $module->enqueue_full_sync_actions( $module_config );

			if ( ! is_null( $items_enqueued ) && $items_enqueued > 0 ) {
				$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() );

		$this->disable_queue_rate_limit();

		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_filter( array_map( array( $this, 'get_action_name' ), $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();
			$status_option_name = "{$module->name()}_sent";
			$items_sent         = $this->get_status_option( $status_option_name, 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( $status_option_name, $items_sent );
			}	
		}

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

	public function get_action_name( $queue_item ) {
		if ( is_array( $queue_item ) && isset( $queue_item[0] ) ) {
			return $queue_item[0];
		}
		return false;
	}

	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(),
			'config'         => array(),
			'total'          => array(),
		);

		foreach ( Jetpack_Sync_Modules::get_modules() as $module ) {
			$name = $module->name();

			if ( $total = $this->get_status_option( "{$name}_total" ) ) {
				$status[ 'total' ][ $name ] = $total;
			}

			if ( $queued = $this->get_status_option( "{$name}_queued" ) ) {
				$status[ 'queue' ][ $name ] = $queued;
			}
			
			if ( $sent = $this->get_status_option( "{$name}_sent" ) ) {
				$status[ 'sent' ][ $name ] = $sent;
			}

			if ( $config = $this->get_status_option( "{$name}_config" ) ) {
				$status[ 'config' ][ $name ] = $config;
			}
		}

		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()}_total" );
			delete_option( "{$prefix}_{$module->name()}_queued" );
			delete_option( "{$prefix}_{$module->name()}_sent" );
			delete_option( "{$prefix}_{$module->name()}_config" );
		}
	}

	public function reset_data() {
		$this->clear_status();
		require_once dirname( __FILE__ ) . '/class.jetpack-sync-listener.php';
		$listener = Jetpack_Sync_Listener::get_instance();
		$listener->get_full_sync_queue()->reset();
	}

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

		$value = get_option( "{$prefix}_{$option}", $default );
		
		if ( ! $value ) {
			// don't cast to int if we didn't find a value - we want to preserve null or false as sentinals
			return $default;
		}

		return is_numeric( $value ) ? intval( $value ) : $value;
	}

	private function update_status_option( $name, $value ) {
		$prefix = self::STATUS_OPTION_PREFIX;
		update_option( "{$prefix}_{$name}", $value, false );
	}

	private function enable_queue_rate_limit() {
		$this->queue_rate_limit = Jetpack_Sync_Settings::get_setting( 'queue_max_writes_sec' );
		$this->items_added_since_last_pause = 0;
		$this->last_pause_time = microtime( true );

		add_action( 'jpsq_item_added', array( $this, 'queue_item_added' ) );
		add_action( 'jpsq_items_added', array( $this, 'queue_items_added' ) );
	}

	private function disable_queue_rate_limit() {
		remove_action( 'jpsq_item_added', array( $this, 'queue_item_added' ) );
		remove_action( 'jpsq_items_added', array( $this, 'queue_items_added' ) );
	}

	public function queue_item_added() {
		$this->queue_items_added( 1 );
	}

	public function queue_items_added( $item_count ) {

		// jpsq_item_added and jpsq_items_added both exec 1 db query, 
		// so we ignore $item_count and treat it as always 1
		$this->items_added_since_last_pause += 1; 

		if ( $this->items_added_since_last_pause > $this->queue_rate_limit ) {
			// sleep for the rest of the second
			$sleep_til = $this->last_pause_time + 1.0;
			$sleep_duration = $sleep_til - microtime( true );
			if ( $sleep_duration > 0.0 ) {
				usleep( $sleep_duration * 1000000 );
				$this->last_pause_time = microtime( true );
			}
			$this->items_added_since_last_pause = 0;
		}
	}
}


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			private $items_added_since_last_pause;
22			private $last_pause_time;
23			private $queue_rate_limit;
24
25			public function name() {
26			return 'full-sync';
27			}
28
29			function init_full_sync_listeners( $callable ) {
30			// synthetic actions for full sync
31			add_action( 'jetpack_full_sync_start', $callable );
32			add_action( 'jetpack_full_sync_end', $callable );
33			add_action( 'jetpack_full_sync_cancelled', $callable );
34			}
35
36			function init_before_send() {
37			// this is triggered after actions have been processed on the server
38			add_action( 'jetpack_sync_processed_actions', array( $this, 'update_sent_progress_action' ) );
39			}
40
41			function start( $modules = null ) {
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			$this->enable_queue_rate_limit();
48
49			if ( $was_already_running ) {
50			/**
51			* Fires when a full sync is cancelled.
52			*
53			* @since 4.2.0
54			*/
55			do_action( 'jetpack_full_sync_cancelled' );
56			}
57
58			/**
59			* Fires when a full sync begins. This action is serialized
60			* and sent to the server so that it knows a full sync is coming.
61			*
62			* @since 4.2.0
63			*/
64			do_action( 'jetpack_full_sync_start', $modules );
65			$this->update_status_option( 'started', time() );
66
67			// configure modules
68			if ( ! is_array( $modules ) ) {
69			$modules = array();
70			}
71
72			if ( isset( $modules['users'] ) && 'initial' === $modules['users'] ) {
73			$user_module = Jetpack_Sync_Modules::get_module( 'users' );
74			$modules['users'] = $user_module->get_initial_sync_user_config();
75			}
76
77			// by default, all modules are fully enabled
78			if ( count( $modules ) === 0 ) {
79			$default_module_config = true;
80			} else {
81			$default_module_config = false;
82			}
83
84			// set default configuration, calculate totals, and save configuration if totals > 0
85			foreach ( Jetpack_Sync_Modules::get_modules() as $module ) {
86			$module_name = $module->name();
87			if ( ! isset( $modules[ $module_name ] ) ) {
88			$modules[ $module_name ] = $default_module_config;
89			}
90
91			// check if this module is enabled
92			if ( ! ( $module_config = $modules[ $module_name ] ) ) {
93			continue;
94			}
95
96			$total_items = $module->estimate_full_sync_actions( $module_config );
97
98			if ( ! is_null( $total_items ) && $total_items > 0 ) {
99			$this->update_status_option( "{$module_name}_total", $total_items );
100			$this->update_status_option( "{$module_name}_config", $module_config );
101			}
102			}
103
104			foreach ( Jetpack_Sync_Modules::get_modules() as $module ) {
105			$module_name = $module->name();
106			$module_config = $modules[ $module_name ];
107
108			// check if this module is enabled
109			if ( ! $module_config ) {
110			continue;
111			}
112
113			$items_enqueued = $module->enqueue_full_sync_actions( $module_config );
114
115			if ( ! is_null( $items_enqueued ) && $items_enqueued > 0 ) {
116			$this->update_status_option( "{$module_name}_queued", $items_enqueued );
117			}
118			}
119
120			$this->update_status_option( 'queue_finished', time() );
121
122			$store = new Jetpack_Sync_WP_Replicastore();
123
124			/**
125			* Fires when a full sync ends. This action is serialized
126			* and sent to the server with checksums so that we can confirm the
127			* sync was successful.
128			*
129			* @since 4.2.0
130			*/
131			do_action( 'jetpack_full_sync_end', $store->checksum_all() );
132
133			$this->disable_queue_rate_limit();
134
135			return true;
136			}
137
138			function update_sent_progress_action( $actions ) {
139
140			// quick way to map to first items with an array of arrays
141			$actions_with_counts = array_count_values( array_filter( array_map( array( $this, 'get_action_name' ), $actions ) ) );
142
143			if ( ! $this->is_started() \|\| $this->is_finished() ) {
144			return;
145			}
146
147			if ( isset( $actions_with_counts['jetpack_full_sync_start'] ) ) {
148			$this->update_status_option( 'sent_started', time() );
149			}
150
151			foreach ( Jetpack_Sync_Modules::get_modules() as $module ) {
152			$module_actions = $module->get_full_sync_actions();
153			$status_option_name = "{$module->name()}_sent";
154			$items_sent = $this->get_status_option( $status_option_name, 0 );
155
156			foreach ( $module_actions as $module_action ) {
157			if ( isset( $actions_with_counts[ $module_action ] ) ) {
158			$items_sent += $actions_with_counts[ $module_action ];
159			}
160			}
161
162			if ( $items_sent > 0 ) {
163			$this->update_status_option( $status_option_name, $items_sent );
164			}
165			}
166
167			if ( isset( $actions_with_counts['jetpack_full_sync_end'] ) ) {
168			$this->update_status_option( 'finished', time() );
169			}
170			}
171
172			public function get_action_name( $queue_item ) {
173			if ( is_array( $queue_item ) && isset( $queue_item[0] ) ) {
174			return $queue_item[0];
175			}
176			return false;
177			}
178
179			public function is_started() {
180			return !! $this->get_status_option( 'started' );
181			}
182
183			public function is_finished() {
184			return !! $this->get_status_option( 'finished' );
185			}
186
187			public function get_status() {
188			$status = array(
189			'started' => $this->get_status_option( 'started' ),
190			'queue_finished' => $this->get_status_option( 'queue_finished' ),
191			'sent_started' => $this->get_status_option( 'sent_started' ),
192			'finished' => $this->get_status_option( 'finished' ),
193			'sent' => array(),
194			'queue' => array(),
195			'config' => array(),
196			'total' => array(),
197			);
198
199			foreach ( Jetpack_Sync_Modules::get_modules() as $module ) {
200			$name = $module->name();
201
202			if ( $total = $this->get_status_option( "{$name}_total" ) ) {
203			$status[ 'total' ][ $name ] = $total;
204			}
205
206			if ( $queued = $this->get_status_option( "{$name}_queued" ) ) {
207			$status[ 'queue' ][ $name ] = $queued;
208			}
209
210			if ( $sent = $this->get_status_option( "{$name}_sent" ) ) {
211			$status[ 'sent' ][ $name ] = $sent;
212			}
213
214			if ( $config = $this->get_status_option( "{$name}_config" ) ) {
215			$status[ 'config' ][ $name ] = $config;
216			}
217			}
218
219			return $status;
220			}
221
222			public function clear_status() {
223			$prefix = self::STATUS_OPTION_PREFIX;
224			delete_option( "{$prefix}_started" );
225			delete_option( "{$prefix}_queue_finished" );
226			delete_option( "{$prefix}_sent_started" );
227			delete_option( "{$prefix}_finished" );
228
229			foreach ( Jetpack_Sync_Modules::get_modules() as $module ) {
230			delete_option( "{$prefix}_{$module->name()}_total" );
231			delete_option( "{$prefix}_{$module->name()}_queued" );
232			delete_option( "{$prefix}_{$module->name()}_sent" );
233			delete_option( "{$prefix}_{$module->name()}_config" );
234			}
235			}
236
237			public function reset_data() {
238			$this->clear_status();
239			require_once dirname( __FILE__ ) . '/class.jetpack-sync-listener.php';
240			$listener = Jetpack_Sync_Listener::get_instance();
241			$listener->get_full_sync_queue()->reset();
242			}
243
244			private function get_status_option( $option, $default = null ) {
245			$prefix = self::STATUS_OPTION_PREFIX;
246
247			$value = get_option( "{$prefix}_{$option}", $default );
248
249			if ( ! $value ) {
250			// don't cast to int if we didn't find a value - we want to preserve null or false as sentinals
251			return $default;
252			}
253
254			return is_numeric( $value ) ? intval( $value ) : $value;
255			}
256
257			private function update_status_option( $name, $value ) {
258			$prefix = self::STATUS_OPTION_PREFIX;
259			update_option( "{$prefix}_{$name}", $value, false );
260			}
261
262			private function enable_queue_rate_limit() {
263			$this->queue_rate_limit = Jetpack_Sync_Settings::get_setting( 'queue_max_writes_sec' );
264			$this->items_added_since_last_pause = 0;
265			$this->last_pause_time = microtime( true );
266
267			add_action( 'jpsq_item_added', array( $this, 'queue_item_added' ) );
268			add_action( 'jpsq_items_added', array( $this, 'queue_items_added' ) );
269			}
270
271			private function disable_queue_rate_limit() {
272			remove_action( 'jpsq_item_added', array( $this, 'queue_item_added' ) );
273			remove_action( 'jpsq_items_added', array( $this, 'queue_items_added' ) );
274			}
275
276			public function queue_item_added() {
277			$this->queue_items_added( 1 );
278			}
279
280			public function queue_items_added( $item_count ) {
			0 ignored issues – show Unused Code introduced 2016-08-11 06:04 UTC by Report Bug Copy Issue Report The parameter `$item_count` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
281			// jpsq_item_added and jpsq_items_added both exec 1 db query,
282			// so we ignore $item_count and treat it as always 1
283			$this->items_added_since_last_pause += 1;
284
285			if ( $this->items_added_since_last_pause > $this->queue_rate_limit ) {
286			// sleep for the rest of the second
287			$sleep_til = $this->last_pause_time + 1.0;
288			$sleep_duration = $sleep_til - microtime( true );
289			if ( $sleep_duration > 0.0 ) {
290			usleep( $sleep_duration * 1000000 );
291			$this->last_pause_time = microtime( true );
292			}
293			$this->items_added_since_last_pause = 0;
294			}
295			}
296			}
297

Automattic / jetpack

Push — update/sync-status-endpoint-ad... ( 2994d8...5ec62d )

Jetpack_Sync_Module_Full_Sync::get_action_name() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like