Jetpack_Sync_Module_Full_Sync::start() - Code Metrics - Inspection of "Update sync status in separate options so that wri..." - Automattic/jetpack - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — fix/race-condition-for-sync-st... ( 8e91b9 )

unknown

created 2016-07-26 04:45 UTC

Jetpack_Sync_Module_Full_Sync::start() C

↳ Parent: Jetpack_Sync_Module_Full_Sync

Complexity

Conditions	7
Paths	5

Size

Total Lines	48
Code Lines	19

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	7
eloc	19
c	1
b	0
f	0
nc	5
nop	1
dl	0
loc	48
rs	6.7272

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

		$status = $this->get_status();
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
		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_name    = $module->name();
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
			$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 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'        => get_option( "{$prefix}_started", null ),
			'queue_finished' => get_option( "{$prefix}_queue_finished", null ),
			'sent_started'   => get_option( "{$prefix}_sent_started", null ),
			'finished'       => get_option( "{$prefix}_finished", null ),
			'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			$status = $this->get_status();
			0 ignored issues – show Unused Code introduced 2016-07-26 04:55 UTC by Report Bug Copy Issue Report `$status` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
109			if ( ! $this->is_started() \|\| $this->is_finished() ) {
110			return;
111			}
112
113			if ( isset( $actions_with_counts['jetpack_full_sync_start'] ) ) {
114			update_option( "{$prefix}_sent_started", time() );
115			}
116
117			foreach ( Jetpack_Sync_Modules::get_modules() as $module ) {
118			$module_name = $module->name();
			0 ignored issues – show Unused Code introduced 2016-07-26 04:55 UTC by Report Bug Copy Issue Report `$module_name` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
119			$module_actions = $module->get_full_sync_actions();
120			$items_sent = 0;
121			foreach ( $module_actions as $module_action ) {
122			if ( isset( $actions_with_counts[ $module_action ] ) ) {
123			$items_sent += $actions_with_counts[ $module_action ];
124			}
125			}
126
127			if ( $items_sent > 0 ) {
128			update_option( "{$prefix}_{$module->name()}_sent", $items_sent );
129			}
130			}
131
132			if ( isset( $actions_with_counts['jetpack_full_sync_end'] ) ) {
133			update_option( "{$prefix}_finished", time() );
134			}
135			}
136
137			private function set_status_queuing_started() {
138			$this->clear_status();
139			$prefix = self::STATUS_OPTION_PREFIX;
140			update_option( "{$prefix}_started", time() );
141			}
142
143			private function set_status_queuing_finished() {
144			$prefix = self::STATUS_OPTION_PREFIX;
145			update_option( "{$prefix}_queue_finished", time() );
146			}
147
148			private function is_started() {
149			$prefix = self::STATUS_OPTION_PREFIX;
150			return ! is_null( get_option( "{$prefix}_started", null ) );
151			}
152
153			private function is_finished() {
154			$prefix = self::STATUS_OPTION_PREFIX;
155			return !! get_option( "{$prefix}_finished", null );
156			}
157
158			public function get_status() {
159			$prefix = self::STATUS_OPTION_PREFIX;
160			$status = array(
161			'started' => get_option( "{$prefix}_started", null ),
162			'queue_finished' => get_option( "{$prefix}_queue_finished", null ),
163			'sent_started' => get_option( "{$prefix}_sent_started", null ),
164			'finished' => get_option( "{$prefix}_finished", null ),
165			'sent' => array(),
166			'queue' => array(),
167			);
168
169			foreach ( Jetpack_Sync_Modules::get_modules() as $module ) {
170			$queued = get_option( "{$prefix}_{$module->name()}_queued", null );
171			$sent = get_option( "{$prefix}_{$module->name()}_sent", null );
172
173			if ( ! is_null( $queued ) ) {
174			$status[ 'queue' ][ $module->name() ] = $queued;
175			}
176
177			if ( ! is_null( $sent ) ) {
178			$status[ 'sent' ][ $module->name() ] = $sent;
179			}
180			}
181
182			return $status;
183			}
184
185			public function clear_status() {
186			$prefix = self::STATUS_OPTION_PREFIX;
187			delete_option( "{$prefix}_started" );
188			delete_option( "{$prefix}_queue_finished" );
189			delete_option( "{$prefix}_sent_started" );
190			delete_option( "{$prefix}_finished" );
191
192			foreach ( Jetpack_Sync_Modules::get_modules() as $module ) {
193			delete_option( "{$prefix}_{$module->name()}_queued" );
194			delete_option( "{$prefix}_{$module->name()}_sent" );
195			}
196			}
197			}
198

Automattic / jetpack

Push — fix/race-condition-for-sync-st... ( 8e91b9 )

Jetpack_Sync_Module_Full_Sync::start() C

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like