Jetpack_Sync_Module_Full_Sync::get_status_option() - Code Metrics - Inspection of "everything should be an int" - Automattic/jetpack - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — fix/race-condition-for-sync-st... ( 1e6f9b...cc3a01 )

unknown

created 2016-07-26 14:17 UTC

Jetpack_Sync_Module_Full_Sync::get_status_option() A

↳ Parent: Jetpack_Sync_Module_Full_Sync

Complexity

Conditions	2
Paths	2

Size

Total Lines	8
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	2
eloc	6
c	1
b	0
f	0
nc	2
nop	1
dl	0
loc	8
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_listeners( $callable ) {
		// synthetic actions for full sync
		add_action( 'jetpack_full_sync_start', $callable );
		add_action( 'jetpack_full_sync_end', $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 ) {
		if ( ! $this->should_start_full_sync() ) {
			return false;
		}

		// 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();

		/**
		 * 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->set_status_queuing_started();

		$prefix = self::STATUS_OPTION_PREFIX;

		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?

				update_option( "{$prefix}_{$module->name()}_queued", $items_enqueued );
			}
		}

		$this->set_status_queuing_finished();

		$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;
	}

	private function should_start_full_sync() {

		// We should try sync if we haven't started it yet or if we have finished it.
		if ( ! $this->is_started() || $this->is_finished() ) {
			return true;
		}

		// allow enqueuing if last full sync was started more than FULL_SYNC_TIMEOUT seconds ago
		$prefix = self::STATUS_OPTION_PREFIX;
		$started_at = get_option( "{$prefix}_started", 0 );
		if ( intval( $started_at ) + self::FULL_SYNC_TIMEOUT < time() ) {
			return true;
		}

		return false;
	}

	function update_sent_progress_action( $actions ) {
		$prefix = self::STATUS_OPTION_PREFIX;

		// 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'] ) ) {
			update_option( "{$prefix}_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 ) {
				update_option( "{$prefix}_{$module->name()}_sent", $items_sent );
			}	
		}

		if ( isset( $actions_with_counts['jetpack_full_sync_end'] ) ) {
			update_option( "{$prefix}_finished", time() );
		}
	}

	private function set_status_queuing_started() {
		$this->clear_status();
		$prefix = self::STATUS_OPTION_PREFIX;
		update_option( "{$prefix}_started", time() );
	}

	private function set_status_queuing_finished() {
		$prefix = self::STATUS_OPTION_PREFIX;
		update_option( "{$prefix}_queue_finished", time() );
	}

	private function get_status_option( $option ) {
		$prefix = self::STATUS_OPTION_PREFIX;
		$status = get_option( "{$prefix}_{$option}", null );
		if ( is_null( $status ) ) {
			return $status;
		}
		return intval( $status );
	}

	private function is_started() {
		$prefix = self::STATUS_OPTION_PREFIX;
		return ! is_null( get_option( "{$prefix}_started", null ) );
	}

	private function is_finished() {
		$prefix = self::STATUS_OPTION_PREFIX;
		return !! get_option( "{$prefix}_finished", null );
	}

	public function get_status() {
		$prefix = self::STATUS_OPTION_PREFIX;
		$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 = get_option( "{$prefix}_{$module->name()}_queued", null );
			$sent = get_option( "{$prefix}_{$module->name()}_sent", null );

			if ( ! is_null( $queued ) ) {
				$status[ 'queue' ][ $module->name() ] = $queued;
			}
			
			if ( ! is_null( $sent ) ) {
				$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" );
		}
	}
}


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_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			}
30
31			function init_before_send() {
32			// this is triggered after actions have been processed on the server
33			add_action( 'jetpack_sync_processed_actions', array( $this, 'update_sent_progress_action' ) );
34			}
35
36			function start( $modules = null ) {
37			if ( ! $this->should_start_full_sync() ) {
38			return false;
39			}
40
41			// ensure listener is loaded so we can guarantee full sync actions are enqueued
42			require_once dirname( __FILE__ ) . '/class.jetpack-sync-listener.php';
43			Jetpack_Sync_Listener::get_instance();
44
45			/**
46			* Fires when a full sync begins. This action is serialized
47			* and sent to the server so that it knows a full sync is coming.
48			*
49			* @since 4.2.0
50			*/
51			do_action( 'jetpack_full_sync_start' );
52			$this->set_status_queuing_started();
53
54			$prefix = self::STATUS_OPTION_PREFIX;
55
56			foreach ( Jetpack_Sync_Modules::get_modules() as $module ) {
57			$module_name = $module->name();
58			if ( is_array( $modules ) && ! in_array( $module_name, $modules ) ) {
59			continue;
60			}
61
62			$items_enqueued = $module->enqueue_full_sync_actions();
63			if ( ! is_null( $items_enqueued ) && $items_enqueued > 0 ) {
64			// 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...
65			update_option( "{$prefix}_{$module->name()}_queued", $items_enqueued );
66			}
67			}
68
69			$this->set_status_queuing_finished();
70
71			$store = new Jetpack_Sync_WP_Replicastore();
72
73			/**
74			* Fires when a full sync ends. This action is serialized
75			* and sent to the server with checksums so that we can confirm the
76			* sync was successful.
77			*
78			* @since 4.2.0
79			*/
80			do_action( 'jetpack_full_sync_end', $store->checksum_all() );
81
82			return true;
83			}
84
85			private function should_start_full_sync() {
86
87			// We should try sync if we haven't started it yet or if we have finished it.
88			if ( ! $this->is_started() \|\| $this->is_finished() ) {
89			return true;
90			}
91
92			// allow enqueuing if last full sync was started more than FULL_SYNC_TIMEOUT seconds ago
93			$prefix = self::STATUS_OPTION_PREFIX;
94			$started_at = get_option( "{$prefix}_started", 0 );
95			if ( intval( $started_at ) + self::FULL_SYNC_TIMEOUT < time() ) {
96			return true;
97			}
98
99			return false;
100			}
101
102			function update_sent_progress_action( $actions ) {
103			$prefix = self::STATUS_OPTION_PREFIX;
104
105			// quick way to map to first items with an array of arrays
106			$actions_with_counts = array_count_values( array_map( 'reset', $actions ) );
107
108			if ( ! $this->is_started() \|\| $this->is_finished() ) {
109			return;
110			}
111
112			if ( isset( $actions_with_counts['jetpack_full_sync_start'] ) ) {
113			update_option( "{$prefix}_sent_started", time() );
114			}
115
116			foreach ( Jetpack_Sync_Modules::get_modules() as $module ) {
117			$module_actions = $module->get_full_sync_actions();
118			$items_sent = 0;
119			foreach ( $module_actions as $module_action ) {
120			if ( isset( $actions_with_counts[ $module_action ] ) ) {
121			$items_sent += $actions_with_counts[ $module_action ];
122			}
123			}
124
125			if ( $items_sent > 0 ) {
126			update_option( "{$prefix}_{$module->name()}_sent", $items_sent );
127			}
128			}
129
130			if ( isset( $actions_with_counts['jetpack_full_sync_end'] ) ) {
131			update_option( "{$prefix}_finished", time() );
132			}
133			}
134
135			private function set_status_queuing_started() {
136			$this->clear_status();
137			$prefix = self::STATUS_OPTION_PREFIX;
138			update_option( "{$prefix}_started", time() );
139			}
140
141			private function set_status_queuing_finished() {
142			$prefix = self::STATUS_OPTION_PREFIX;
143			update_option( "{$prefix}_queue_finished", time() );
144			}
145
146			private function get_status_option( $option ) {
147			$prefix = self::STATUS_OPTION_PREFIX;
148			$status = get_option( "{$prefix}_{$option}", null );
149			if ( is_null( $status ) ) {
150			return $status;
151			}
152			return intval( $status );
153			}
154
155			private function is_started() {
156			$prefix = self::STATUS_OPTION_PREFIX;
157			return ! is_null( get_option( "{$prefix}_started", null ) );
158			}
159
160			private function is_finished() {
161			$prefix = self::STATUS_OPTION_PREFIX;
162			return !! get_option( "{$prefix}_finished", null );
163			}
164
165			public function get_status() {
166			$prefix = self::STATUS_OPTION_PREFIX;
167			$status = array(
168			'started' => $this->get_status_option( 'started' ),
169			'queue_finished' => $this->get_status_option( 'queue_finished' ),
170			'sent_started' => $this->get_status_option( 'sent_started' ),
171			'finished' => $this->get_status_option( 'finished' ),
172			'sent' => array(),
173			'queue' => array(),
174			);
175
176			foreach ( Jetpack_Sync_Modules::get_modules() as $module ) {
177			$queued = get_option( "{$prefix}_{$module->name()}_queued", null );
178			$sent = get_option( "{$prefix}_{$module->name()}_sent", null );
179
180			if ( ! is_null( $queued ) ) {
181			$status[ 'queue' ][ $module->name() ] = $queued;
182			}
183
184			if ( ! is_null( $sent ) ) {
185			$status[ 'sent' ][ $module->name() ] = $sent;
186			}
187			}
188
189			return $status;
190			}
191
192			public function clear_status() {
193			$prefix = self::STATUS_OPTION_PREFIX;
194			delete_option( "{$prefix}_started" );
195			delete_option( "{$prefix}_queue_finished" );
196			delete_option( "{$prefix}_sent_started" );
197			delete_option( "{$prefix}_finished" );
198
199			foreach ( Jetpack_Sync_Modules::get_modules() as $module ) {
200			delete_option( "{$prefix}_{$module->name()}_queued" );
201			delete_option( "{$prefix}_{$module->name()}_sent" );
202			}
203			}
204			}
205

Automattic / jetpack

Push — fix/race-condition-for-sync-st... ( 1e6f9b...cc3a01 )

Jetpack_Sync_Module_Full_Sync::get_status_option() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like