Jetpack_Sync_Sender::get_next_sync_time() - Code Metrics - Inspection of "Sync: Don't call items on do_sync on shutdown" - Automattic/jetpack - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — fix/remove-do-sync-actions ( 190871 )

unknown

created 2016-08-10 00:06 UTC

Jetpack_Sync_Sender::get_next_sync_time() A

↳ Parent: Jetpack_Sync_Sender

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
nc	1
nop	0
dl	0
loc	3
rs	10
c	0
b	0
f	0

<?php

require_once dirname( __FILE__ ) . '/class.jetpack-sync-queue.php';
require_once dirname( __FILE__ ) . '/class.jetpack-sync-defaults.php';
require_once dirname( __FILE__ ) . '/class.jetpack-sync-json-deflate-codec.php';
require_once dirname( __FILE__ ) . '/class.jetpack-sync-modules.php';
require_once dirname( __FILE__ ) . '/class.jetpack-sync-settings.php';

/**
 * This class grabs pending actions from the queue and sends them
 */
class Jetpack_Sync_Sender {

	const SYNC_THROTTLE_OPTION_NAME = 'jetpack_sync_min_wait';
	const NEXT_SYNC_TIME_OPTION_NAME = 'jetpack_next_sync_time';
	const WPCOM_ERROR_SYNC_DELAY = 60;

	private $dequeue_max_bytes;
	private $upload_max_bytes;
	private $upload_max_rows;
	private $sync_wait_time;
	private $sync_wait_threshold;
	private $sync_queue;
	private $full_sync_queue;
	private $codec;

	// singleton functions
	private static $instance;

	public static function get_instance() {
		if ( null === self::$instance ) {
			self::$instance = new self();
		}

		return self::$instance;
	}

	// this is necessary because you can't use "new" when you declare instance properties >:(
	protected function __construct() {
		$this->set_defaults();
		$this->init();
	}

	private function init() {
		foreach ( Jetpack_Sync_Modules::get_modules() as $module ) {
			$module->init_before_send();
		}
	}

	public function get_next_sync_time() {
		return (double) get_option( self::NEXT_SYNC_TIME_OPTION_NAME, 0 );
	}

	public function set_next_sync_time( $time ) {
		return update_option( self::NEXT_SYNC_TIME_OPTION_NAME, $time, true );
	}

	public function do_sync() {
		// don't sync if importing
		if ( defined( 'WP_IMPORTING' ) && WP_IMPORTING ) {
			return false;
		}

		// don't sync if we are throttled
		if ( $this->get_next_sync_time() > microtime( true ) ) {
			return false;
		}

		$start_time = microtime( true );
		
		$full_sync_result = $this->do_sync_for_queue( $this->full_sync_queue );
		$sync_result      = $this->do_sync_for_queue( $this->sync_queue );

		$exceeded_sync_wait_threshold = ( microtime( true ) - $start_time ) > (double) $this->get_sync_wait_threshold();

		if ( is_wp_error( $full_sync_result ) || is_wp_error( $sync_result ) ) {
			$this->set_next_sync_time( time() + self::WPCOM_ERROR_SYNC_DELAY );
			$full_sync_result = false;
			$sync_result      = false;
		} elseif ( $exceeded_sync_wait_threshold ) {
			// if we actually sent data and it took a while, wait before sending again
			$this->set_next_sync_time( time() + $this->get_sync_wait_time() );
		}

		// This insures that do_sync doesn't get called on shutdown again.
		if ( has_action( 'shutdown', array( __CLASS__, 'do_sync' ) ) ) {
			remove_action( 'shutdown', array( __CLASS__, 'do_sync' ) );

			// Remove any action that are attached to _sync_before_send_queue since they should only be called once.
			remove_action( 'jetpack_sync_before_send_queue_' . $this->full_sync_queue );
			remove_action( 'jetpack_sync_before_send_queue_' . $this->sync_queue );
		}

		// we use OR here because if either one returns true then the caller should
		// be allowed to call do_sync again, as there may be more items
		return $full_sync_result || $sync_result;
	}

	public function do_sync_for_queue( $queue ) {

		do_action( 'jetpack_sync_before_send_queue_' . $queue->id );

		if ( $queue->size() === 0 ) {
			return false;
		}

		// now that we're sure we are about to sync, try to
		// ignore user abort so we can avoid getting into a
		// bad state
		if ( function_exists( 'ignore_user_abort' ) ) {
			ignore_user_abort( true );
		}

		$buffer = $queue->checkout_with_memory_limit( $this->dequeue_max_bytes, $this->upload_max_rows );

		if ( ! $buffer ) {
			// buffer has no items
			return false;
		}

		if ( is_wp_error( $buffer ) ) {
			// another buffer is currently sending
			return false;
		}

		$upload_size   = 0;
		$items_to_send = array();
		$items         = $buffer->get_items();

		// set up current screen to avoid errors rendering content
		require_once(ABSPATH . 'wp-admin/includes/class-wp-screen.php');
		require_once(ABSPATH . 'wp-admin/includes/screen.php');
		set_current_screen( 'sync' );

		$skipped_items_ids = array();

		// we estimate the total encoded size as we go by encoding each item individually
		// this is expensive, but the only way to really know :/
		foreach ( $items as $key => $item ) {
			/**
			 * Modify the data within an action before it is serialized and sent to the server
			 * For example, during full sync this expands Post ID's into full Post objects,
			 * so that we don't have to serialize the whole object into the queue.
			 *
			 * @since 4.2.0
			 *
			 * @param array The action parameters
			 * @param int The ID of the user who triggered the action
			 */
			$item[1] = apply_filters( 'jetpack_sync_before_send_' . $item[0], $item[1], $item[2] );

			if ( $item[1] === false ) {
				$skipped_items_ids[] = $key;
				continue;
			}

			$encoded_item = $this->codec->encode( $item );

			$upload_size += strlen( $encoded_item );

			if ( $upload_size > $this->upload_max_bytes && count( $items_to_send ) > 0 ) {
				break;
			}

			$items_to_send[ $key ] = $encoded_item;
		}

		/**
		 * Fires when data is ready to send to the server.
		 * Return false or WP_Error to abort the sync (e.g. if there's an error)
		 * The items will be automatically re-sent later
		 *
		 * @since 4.2.0
		 *
		 * @param array $data The action buffer
		 * @param string $codec The codec name used to encode the data
		 * @param double $time The current time
		 * @param string $queue The queue used to send ('sync' or 'full_sync')
		 */
		$processed_item_ids = apply_filters( 'jetpack_sync_send_data', $items_to_send, $this->codec->name(), microtime( true ), $queue->id );

		if ( ! $processed_item_ids || is_wp_error( $processed_item_ids ) ) {
			$checked_in_item_ids = $queue->checkin( $buffer );

			if ( is_wp_error( $checked_in_item_ids ) ) {
				error_log( 'Error checking in buffer: ' . $checked_in_item_ids->get_error_message() );
				$queue->force_checkin();
			}

			if ( is_wp_error( $processed_item_ids ) ) {
				return $processed_item_ids;
			}

			// returning a WP_Error is a sign to the caller that we should wait a while
			// before syncing again
			return new WP_Error( 'server_error' );
			
		} else {

			// detect if the last item ID was an error
			$had_wp_error = is_wp_error( end( $processed_item_ids ) );

			if ( $had_wp_error ) {
				$wp_error = array_pop( $processed_item_ids );
			}

			$processed_items = array_intersect_key( $items, array_flip( $processed_item_ids ) );

			// also checkin any items that were skipped
			if ( count( $skipped_items_ids ) > 0 ) {
				$processed_item_ids = $processed_item_ids + $skipped_items_ids;				
			}

			/**
			 * Allows us to keep track of all the actions that have been sent.
			 * Allows us to calculate the progress of specific actions.
			 *
			 * @since 4.2.0
			 *
			 * @param array $processed_actions The actions that we send successfully.
			 */
			do_action( 'jetpack_sync_processed_actions', $processed_items );

			$queue->close( $buffer, $processed_item_ids );

			// returning a WP_Error is a sign to the caller that we should wait a while
			// before syncing again
			if ( $had_wp_error ) {
				return $wp_error;
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
			} 
		}
		
		return true;
	}

	function get_sync_queue() {
		return $this->sync_queue;
	}

	function get_full_sync_queue() {
		return $this->full_sync_queue;
	}

	function get_codec() {
		return $this->codec;
	}

	function send_checksum() {
		require_once 'class.jetpack-sync-wp-replicastore.php';
		$store = new Jetpack_Sync_WP_Replicastore();
		do_action( 'jetpack_sync_checksum', $store->checksum_all() );
	}

	function reset_sync_queue() {
		$this->sync_queue->reset();
	}

	function set_dequeue_max_bytes( $size ) {
		$this->dequeue_max_bytes = $size;
	}

	// in bytes
	function set_upload_max_bytes( $max_bytes ) {
		$this->upload_max_bytes = $max_bytes;
	}

	// in rows
	function set_upload_max_rows( $max_rows ) {
		$this->upload_max_rows = $max_rows;
	}

	// in seconds
	function set_sync_wait_time( $seconds ) {
		$this->sync_wait_time = $seconds;
	}

	function get_sync_wait_time() {
		return $this->sync_wait_time;
	}

	// in seconds
	function set_sync_wait_threshold( $seconds ) {
		$this->sync_wait_threshold = $seconds;
	}

	function get_sync_wait_threshold() {
		return $this->sync_wait_threshold;
	}

	function set_defaults() {
		$this->sync_queue = new Jetpack_Sync_Queue( 'sync' );
		$this->full_sync_queue = new Jetpack_Sync_Queue( 'full_sync' );
		$this->codec      = new Jetpack_Sync_JSON_Deflate_Codec();

		// saved settings
		Jetpack_Sync_Settings::set_importing( null );
		$settings = Jetpack_Sync_Settings::get_settings();
		$this->set_dequeue_max_bytes( $settings['dequeue_max_bytes'] );
		$this->set_upload_max_bytes( $settings['upload_max_bytes'] );
		$this->set_upload_max_rows( $settings['upload_max_rows'] );
		$this->set_sync_wait_time( $settings['sync_wait_time'] );
		$this->set_sync_wait_threshold( $settings['sync_wait_threshold'] );
	}

	function reset_data() {
		$this->reset_sync_queue();

		foreach ( Jetpack_Sync_Modules::get_modules() as $module ) {
			$module->reset_data();
		}

		delete_option( self::SYNC_THROTTLE_OPTION_NAME );
		delete_option( self::NEXT_SYNC_TIME_OPTION_NAME );

		Jetpack_Sync_Settings::reset_data();
	}

	function uninstall() {
		// Lets delete all the other fun stuff like transient and option and the sync queue
		$this->reset_data();

		// delete the full sync status
		delete_option( 'jetpack_full_sync_status' );

		// clear the sync cron.
		wp_clear_scheduled_hook( 'jetpack_sync_cron' );

		// clear the checksum cron
		wp_clear_scheduled_hook( 'jetpack_send_db_checksum' );
	}
}


1			<?php
2
3			require_once dirname( __FILE__ ) . '/class.jetpack-sync-queue.php';
4			require_once dirname( __FILE__ ) . '/class.jetpack-sync-defaults.php';
5			require_once dirname( __FILE__ ) . '/class.jetpack-sync-json-deflate-codec.php';
6			require_once dirname( __FILE__ ) . '/class.jetpack-sync-modules.php';
7			require_once dirname( __FILE__ ) . '/class.jetpack-sync-settings.php';
8
9			/**
10			* This class grabs pending actions from the queue and sends them
11			*/
12			class Jetpack_Sync_Sender {
13
14			const SYNC_THROTTLE_OPTION_NAME = 'jetpack_sync_min_wait';
15			const NEXT_SYNC_TIME_OPTION_NAME = 'jetpack_next_sync_time';
16			const WPCOM_ERROR_SYNC_DELAY = 60;
17
18			private $dequeue_max_bytes;
19			private $upload_max_bytes;
20			private $upload_max_rows;
21			private $sync_wait_time;
22			private $sync_wait_threshold;
23			private $sync_queue;
24			private $full_sync_queue;
25			private $codec;
26
27			// singleton functions
28			private static $instance;
29
30			public static function get_instance() {
31			if ( null === self::$instance ) {
32			self::$instance = new self();
33			}
34
35			return self::$instance;
36			}
37
38			// this is necessary because you can't use "new" when you declare instance properties >:(
39			protected function __construct() {
40			$this->set_defaults();
41			$this->init();
42			}
43
44			private function init() {
45			foreach ( Jetpack_Sync_Modules::get_modules() as $module ) {
46			$module->init_before_send();
47			}
48			}
49
50			public function get_next_sync_time() {
51			return (double) get_option( self::NEXT_SYNC_TIME_OPTION_NAME, 0 );
52			}
53
54			public function set_next_sync_time( $time ) {
55			return update_option( self::NEXT_SYNC_TIME_OPTION_NAME, $time, true );
56			}
57
58			public function do_sync() {
59			// don't sync if importing
60			if ( defined( 'WP_IMPORTING' ) && WP_IMPORTING ) {
61			return false;
62			}
63
64			// don't sync if we are throttled
65			if ( $this->get_next_sync_time() > microtime( true ) ) {
66			return false;
67			}
68
69			$start_time = microtime( true );
70
71			$full_sync_result = $this->do_sync_for_queue( $this->full_sync_queue );
72			$sync_result = $this->do_sync_for_queue( $this->sync_queue );
73
74			$exceeded_sync_wait_threshold = ( microtime( true ) - $start_time ) > (double) $this->get_sync_wait_threshold();
75
76			if ( is_wp_error( $full_sync_result ) \|\| is_wp_error( $sync_result ) ) {
77			$this->set_next_sync_time( time() + self::WPCOM_ERROR_SYNC_DELAY );
78			$full_sync_result = false;
79			$sync_result = false;
80			} elseif ( $exceeded_sync_wait_threshold ) {
81			// if we actually sent data and it took a while, wait before sending again
82			$this->set_next_sync_time( time() + $this->get_sync_wait_time() );
83			}
84
85			// This insures that do_sync doesn't get called on shutdown again.
86			if ( has_action( 'shutdown', array( __CLASS__, 'do_sync' ) ) ) {
87			remove_action( 'shutdown', array( __CLASS__, 'do_sync' ) );
88
89			// Remove any action that are attached to _sync_before_send_queue since they should only be called once.
90			remove_action( 'jetpack_sync_before_send_queue_' . $this->full_sync_queue );
91			remove_action( 'jetpack_sync_before_send_queue_' . $this->sync_queue );
92			}
93
94			// we use OR here because if either one returns true then the caller should
95			// be allowed to call do_sync again, as there may be more items
96			return $full_sync_result \|\| $sync_result;
97			}
98
99			public function do_sync_for_queue( $queue ) {
100
101			do_action( 'jetpack_sync_before_send_queue_' . $queue->id );
102
103			if ( $queue->size() === 0 ) {
104			return false;
105			}
106
107			// now that we're sure we are about to sync, try to
108			// ignore user abort so we can avoid getting into a
109			// bad state
110			if ( function_exists( 'ignore_user_abort' ) ) {
111			ignore_user_abort( true );
112			}
113
114			$buffer = $queue->checkout_with_memory_limit( $this->dequeue_max_bytes, $this->upload_max_rows );
115
116			if ( ! $buffer ) {
117			// buffer has no items
118			return false;
119			}
120
121			if ( is_wp_error( $buffer ) ) {
122			// another buffer is currently sending
123			return false;
124			}
125
126			$upload_size = 0;
127			$items_to_send = array();
128			$items = $buffer->get_items();
129
130			// set up current screen to avoid errors rendering content
131			require_once(ABSPATH . 'wp-admin/includes/class-wp-screen.php');
132			require_once(ABSPATH . 'wp-admin/includes/screen.php');
133			set_current_screen( 'sync' );
134
135			$skipped_items_ids = array();
136
137			// we estimate the total encoded size as we go by encoding each item individually
138			// this is expensive, but the only way to really know :/
139			foreach ( $items as $key => $item ) {
140			/**
141			* Modify the data within an action before it is serialized and sent to the server
142			* For example, during full sync this expands Post ID's into full Post objects,
143			* so that we don't have to serialize the whole object into the queue.
144			*
145			* @since 4.2.0
146			*
147			* @param array The action parameters
148			* @param int The ID of the user who triggered the action
149			*/
150			$item[1] = apply_filters( 'jetpack_sync_before_send_' . $item[0], $item[1], $item[2] );
151
152			if ( $item[1] === false ) {
153			$skipped_items_ids[] = $key;
154			continue;
155			}
156
157			$encoded_item = $this->codec->encode( $item );
158
159			$upload_size += strlen( $encoded_item );
160
161			if ( $upload_size > $this->upload_max_bytes && count( $items_to_send ) > 0 ) {
162			break;
163			}
164
165			$items_to_send[ $key ] = $encoded_item;
166			}
167
168			/**
169			* Fires when data is ready to send to the server.
170			* Return false or WP_Error to abort the sync (e.g. if there's an error)
171			* The items will be automatically re-sent later
172			*
173			* @since 4.2.0
174			*
175			* @param array $data The action buffer
176			* @param string $codec The codec name used to encode the data
177			* @param double $time The current time
178			* @param string $queue The queue used to send ('sync' or 'full_sync')
179			*/
180			$processed_item_ids = apply_filters( 'jetpack_sync_send_data', $items_to_send, $this->codec->name(), microtime( true ), $queue->id );
181
182			if ( ! $processed_item_ids \|\| is_wp_error( $processed_item_ids ) ) {
183			$checked_in_item_ids = $queue->checkin( $buffer );
184
185			if ( is_wp_error( $checked_in_item_ids ) ) {
186			error_log( 'Error checking in buffer: ' . $checked_in_item_ids->get_error_message() );
187			$queue->force_checkin();
188			}
189
190			if ( is_wp_error( $processed_item_ids ) ) {
191			return $processed_item_ids;
192			}
193
194			// returning a WP_Error is a sign to the caller that we should wait a while
195			// before syncing again
196			return new WP_Error( 'server_error' );
197
198			} else {
199
200			// detect if the last item ID was an error
201			$had_wp_error = is_wp_error( end( $processed_item_ids ) );
202
203			if ( $had_wp_error ) {
204			$wp_error = array_pop( $processed_item_ids );
205			}
206
207			$processed_items = array_intersect_key( $items, array_flip( $processed_item_ids ) );
208
209			// also checkin any items that were skipped
210			if ( count( $skipped_items_ids ) > 0 ) {
211			$processed_item_ids = $processed_item_ids + $skipped_items_ids;
212			}
213
214			/**
215			* Allows us to keep track of all the actions that have been sent.
216			* Allows us to calculate the progress of specific actions.
217			*
218			* @since 4.2.0
219			*
220			* @param array $processed_actions The actions that we send successfully.
221			*/
222			do_action( 'jetpack_sync_processed_actions', $processed_items );
223
224			$queue->close( $buffer, $processed_item_ids );
225
226			// returning a WP_Error is a sign to the caller that we should wait a while
227			// before syncing again
228			if ( $had_wp_error ) {
229			return $wp_error;
			0 ignored issues – show Bug introduced 2016-07-27 15:55 UTC by Report Bug Copy Issue Report The variable `$wp_error` does not seem to be defined for all execution paths leading up to this point. If you define a variable conditionally, it can happen that it is not defined for all execution paths. Let’s take a look at an example: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } // $x is potentially undefined here. echo $x; } In the above example, the variable `$x` is defined if you pass “foo” or “bar” as argument for `$a`. However, since the `switch` statement has no default case statement, if you pass any other value, the variable `$x` would be undefined. Available Fixes Check for existence of the variable explicitly: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } if (isset($x)) { // Make sure it's always set. echo $x; } } Define a default value for the variable: function myFunction($a) { $x = ''; // Set a default which gets overridden for certain paths. switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } echo $x; } Add a value for the missing path: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; // We add support for the missing case. default: $x = ''; break; } echo $x; } Loading history...
230			}
231			}
232
233			return true;
234			}
235
236			function get_sync_queue() {
237			return $this->sync_queue;
238			}
239
240			function get_full_sync_queue() {
241			return $this->full_sync_queue;
242			}
243
244			function get_codec() {
245			return $this->codec;
246			}
247
248			function send_checksum() {
249			require_once 'class.jetpack-sync-wp-replicastore.php';
250			$store = new Jetpack_Sync_WP_Replicastore();
251			do_action( 'jetpack_sync_checksum', $store->checksum_all() );
252			}
253
254			function reset_sync_queue() {
255			$this->sync_queue->reset();
256			}
257
258			function set_dequeue_max_bytes( $size ) {
259			$this->dequeue_max_bytes = $size;
260			}
261
262			// in bytes
263			function set_upload_max_bytes( $max_bytes ) {
264			$this->upload_max_bytes = $max_bytes;
265			}
266
267			// in rows
268			function set_upload_max_rows( $max_rows ) {
269			$this->upload_max_rows = $max_rows;
270			}
271
272			// in seconds
273			function set_sync_wait_time( $seconds ) {
274			$this->sync_wait_time = $seconds;
275			}
276
277			function get_sync_wait_time() {
278			return $this->sync_wait_time;
279			}
280
281			// in seconds
282			function set_sync_wait_threshold( $seconds ) {
283			$this->sync_wait_threshold = $seconds;
284			}
285
286			function get_sync_wait_threshold() {
287			return $this->sync_wait_threshold;
288			}
289
290			function set_defaults() {
291			$this->sync_queue = new Jetpack_Sync_Queue( 'sync' );
292			$this->full_sync_queue = new Jetpack_Sync_Queue( 'full_sync' );
293			$this->codec = new Jetpack_Sync_JSON_Deflate_Codec();
294
295			// saved settings
296			Jetpack_Sync_Settings::set_importing( null );
297			$settings = Jetpack_Sync_Settings::get_settings();
298			$this->set_dequeue_max_bytes( $settings['dequeue_max_bytes'] );
299			$this->set_upload_max_bytes( $settings['upload_max_bytes'] );
300			$this->set_upload_max_rows( $settings['upload_max_rows'] );
301			$this->set_sync_wait_time( $settings['sync_wait_time'] );
302			$this->set_sync_wait_threshold( $settings['sync_wait_threshold'] );
303			}
304
305			function reset_data() {
306			$this->reset_sync_queue();
307
308			foreach ( Jetpack_Sync_Modules::get_modules() as $module ) {
309			$module->reset_data();
310			}
311
312			delete_option( self::SYNC_THROTTLE_OPTION_NAME );
313			delete_option( self::NEXT_SYNC_TIME_OPTION_NAME );
314
315			Jetpack_Sync_Settings::reset_data();
316			}
317
318			function uninstall() {
319			// Lets delete all the other fun stuff like transient and option and the sync queue
320			$this->reset_data();
321
322			// delete the full sync status
323			delete_option( 'jetpack_full_sync_status' );
324
325			// clear the sync cron.
326			wp_clear_scheduled_hook( 'jetpack_sync_cron' );
327
328			// clear the checksum cron
329			wp_clear_scheduled_hook( 'jetpack_send_db_checksum' );
330			}
331			}
332

Automattic / jetpack

Push — fix/remove-do-sync-actions ( 190871 )

Jetpack_Sync_Sender::get_next_sync_time() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like