Jetpack_Sync_Module_Full_Sync::name() - Code Metrics - Inspection of "Ensure sync status options don’t autoload" - Automattic/jetpack - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — fix/race-condition-for-sync-st... ( cc3a01...54a08b )

unknown

created 2016-07-26 16:34 UTC

Jetpack_Sync_Module_Full_Sync::name() A

↳ Parent: Jetpack_Sync_Module_Full_Sync

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

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

		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->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;
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

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

	private function set_status_queuing_started() {
		$this->clear_status();
		$prefix = self::STATUS_OPTION_PREFIX;
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
		$this->update_status_option( "started", time() );
	}

	private function set_status_queuing_finished() {
		$prefix = self::STATUS_OPTION_PREFIX;
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
		$this->update_status_option( "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" );
		}
	}

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


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

Automattic / jetpack

Push — fix/race-condition-for-sync-st... ( cc3a01...54a08b )

Jetpack_Sync_Module_Full_Sync::name() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like