Jetpack_Sync_Sender::do_sync_and_set_delays() - Code Metrics - Inspection of "Wait 10 seconds if queue is locked by another proc..." - Automattic/jetpack - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — add/wait-if-queue-locked-by-ot... ( 80914f )

unknown

created 2016-10-01 02:11 UTC

Jetpack_Sync_Sender::do_sync_and_set_delays() C

↳ Parent: Jetpack_Sync_Sender

Complexity

Conditions	7
Paths	6

Size

Total Lines	31
Code Lines	17

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	7
eloc	17
nc	6
nop	1
dl	0
loc	31
rs	6.7272
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-array-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 NEXT_SYNC_TIME_OPTION_NAME = 'jetpack_next_sync_time';
	const WPCOM_ERROR_SYNC_DELAY = 60;
	const QUEUE_LOCKED_SYNC_DELAY = 10;

	private $dequeue_max_bytes;
	private $upload_max_bytes;
	private $upload_max_rows;
	private $max_dequeue_time;
	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( $queue_name ) {
		return (double) get_option( self::NEXT_SYNC_TIME_OPTION_NAME . '_' . $queue_name, 0 );
	}

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

	public function do_full_sync() {
		return $this->do_sync_and_set_delays( $this->full_sync_queue );
	}

	public function do_sync() {
		return $this->do_sync_and_set_delays( $this->sync_queue );
	}

	public function do_sync_and_set_delays( $queue ) {
		// 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( $queue->id ) > microtime( true ) ) {
			return false;
		}

		$start_time = microtime( true );

		$sync_result = $this->do_sync_for_queue( $queue );

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

		if ( is_wp_error( $sync_result ) ) {
			if ( 'unclosed_buffer' === $sync_result->get_error_code() ) {
				$this->set_next_sync_time( time() + self::QUEUE_LOCKED_SYNC_DELAY, $queue->id );
			} else {
				$this->set_next_sync_time( time() + self::WPCOM_ERROR_SYNC_DELAY, $queue->id );
			}
			$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(), $queue->id );
		}

		return $sync_result;
	}

	public function do_sync_for_queue( $queue ) {

		// track how long we've been processing so we can avoid request timeouts
		$start_time = microtime( true );

		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 ) ) {
			return $buffer;
		}

		$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 ) {
			// Suspending cache addition help prevent overloading in memory cache of large sites.
			wp_suspend_cache_addition( true );
			/**
			 * 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] );
			wp_suspend_cache_addition( false );
			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;

			if ( microtime(true) - $start_time > $this->max_dequeue_time ) {
				break;
			}
		}

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

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

			$processed_items = array_intersect_key( $items, array_flip( $processed_item_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;
	}

	// in seconds
	function set_max_dequeue_time( $seconds ) {
		$this->max_dequeue_time = $seconds;
	}

	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_Array_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'] );
		$this->set_max_dequeue_time( Jetpack_Sync_Defaults::get_max_sync_execution_time() );
	}

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

		foreach ( Jetpack_Sync_Modules::get_modules() as $module ) {
			$module->reset_data();
		}
		
		foreach ( array( 'sync', 'full_sync' ) as $queue_name ) {
			delete_option( self::NEXT_SYNC_TIME_OPTION_NAME . '_' . $queue_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' );
	}
}


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-array-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 NEXT_SYNC_TIME_OPTION_NAME = 'jetpack_next_sync_time';
15			const WPCOM_ERROR_SYNC_DELAY = 60;
16			const QUEUE_LOCKED_SYNC_DELAY = 10;
17
18			private $dequeue_max_bytes;
19			private $upload_max_bytes;
20			private $upload_max_rows;
21			private $max_dequeue_time;
22			private $sync_wait_time;
23			private $sync_wait_threshold;
24			private $sync_queue;
25			private $full_sync_queue;
26			private $codec;
27
28			// singleton functions
29			private static $instance;
30
31			public static function get_instance() {
32			if ( null === self::$instance ) {
33			self::$instance = new self();
34			}
35
36			return self::$instance;
37			}
38
39			// this is necessary because you can't use "new" when you declare instance properties >:(
40			protected function __construct() {
41			$this->set_defaults();
42			$this->init();
43			}
44
45			private function init() {
46			foreach ( Jetpack_Sync_Modules::get_modules() as $module ) {
47			$module->init_before_send();
48			}
49			}
50
51			public function get_next_sync_time( $queue_name ) {
52			return (double) get_option( self::NEXT_SYNC_TIME_OPTION_NAME . '_' . $queue_name, 0 );
53			}
54
55			public function set_next_sync_time( $time, $queue_name ) {
56			return update_option( self::NEXT_SYNC_TIME_OPTION_NAME . '_' . $queue_name, $time, true );
57			}
58
59			public function do_full_sync() {
60			return $this->do_sync_and_set_delays( $this->full_sync_queue );
61			}
62
63			public function do_sync() {
64			return $this->do_sync_and_set_delays( $this->sync_queue );
65			}
66
67			public function do_sync_and_set_delays( $queue ) {
68			// don't sync if importing
69			if ( defined( 'WP_IMPORTING' ) && WP_IMPORTING ) {
70			return false;
71			}
72
73			// don't sync if we are throttled
74			if ( $this->get_next_sync_time( $queue->id ) > microtime( true ) ) {
75			return false;
76			}
77
78			$start_time = microtime( true );
79
80			$sync_result = $this->do_sync_for_queue( $queue );
81
82			$exceeded_sync_wait_threshold = ( microtime( true ) - $start_time ) > (double) $this->get_sync_wait_threshold();
83
84			if ( is_wp_error( $sync_result ) ) {
85			if ( 'unclosed_buffer' === $sync_result->get_error_code() ) {
86			$this->set_next_sync_time( time() + self::QUEUE_LOCKED_SYNC_DELAY, $queue->id );
87			} else {
88			$this->set_next_sync_time( time() + self::WPCOM_ERROR_SYNC_DELAY, $queue->id );
89			}
90			$sync_result = false;
91			} elseif ( $exceeded_sync_wait_threshold ) {
92			// if we actually sent data and it took a while, wait before sending again
93			$this->set_next_sync_time( time() + $this->get_sync_wait_time(), $queue->id );
94			}
95
96			return $sync_result;
97			}
98
99			public function do_sync_for_queue( $queue ) {
100
101			// track how long we've been processing so we can avoid request timeouts
102			$start_time = microtime( true );
103
104			do_action( 'jetpack_sync_before_send_queue_' . $queue->id );
105
106			if ( $queue->size() === 0 ) {
107			return false;
108			}
109
110			// now that we're sure we are about to sync, try to
111			// ignore user abort so we can avoid getting into a
112			// bad state
113			if ( function_exists( 'ignore_user_abort' ) ) {
114			ignore_user_abort( true );
115			}
116
117			$buffer = $queue->checkout_with_memory_limit( $this->dequeue_max_bytes, $this->upload_max_rows );
118
119			if ( ! $buffer ) {
120			// buffer has no items
121			return false;
122			}
123
124			if ( is_wp_error( $buffer ) ) {
125			return $buffer;
126			}
127
128			$upload_size = 0;
129			$items_to_send = array();
130			$items = $buffer->get_items();
131
132			// set up current screen to avoid errors rendering content
133			require_once( ABSPATH . 'wp-admin/includes/class-wp-screen.php' );
134			require_once( ABSPATH . 'wp-admin/includes/screen.php' );
135			set_current_screen( 'sync' );
136
137			$skipped_items_ids = array();
138
139			// we estimate the total encoded size as we go by encoding each item individually
140			// this is expensive, but the only way to really know :/
141			foreach ( $items as $key => $item ) {
142			// Suspending cache addition help prevent overloading in memory cache of large sites.
143			wp_suspend_cache_addition( true );
144			/**
145			* Modify the data within an action before it is serialized and sent to the server
146			* For example, during full sync this expands Post ID's into full Post objects,
147			* so that we don't have to serialize the whole object into the queue.
148			*
149			* @since 4.2.0
150			*
151			* @param array The action parameters
152			* @param int The ID of the user who triggered the action
153			*/
154			$item[1] = apply_filters( 'jetpack_sync_before_send_' . $item[0], $item[1], $item[2] );
155			wp_suspend_cache_addition( false );
156			if ( $item[1] === false ) {
157			$skipped_items_ids[] = $key;
158			continue;
159			}
160
161			$encoded_item = $this->codec->encode( $item );
162
163			$upload_size += strlen( $encoded_item );
164
165			if ( $upload_size > $this->upload_max_bytes && count( $items_to_send ) > 0 ) {
166			break;
167			}
168
169			$items_to_send[ $key ] = $encoded_item;
170
171			if ( microtime(true) - $start_time > $this->max_dequeue_time ) {
172			break;
173			}
174			}
175
176			/**
177			* Fires when data is ready to send to the server.
178			* Return false or WP_Error to abort the sync (e.g. if there's an error)
179			* The items will be automatically re-sent later
180			*
181			* @since 4.2.0
182			*
183			* @param array $data The action buffer
184			* @param string $codec The codec name used to encode the data
185			* @param double $time The current time
186			* @param string $queue The queue used to send ('sync' or 'full_sync')
187			*/
188			$processed_item_ids = apply_filters( 'jetpack_sync_send_data', $items_to_send, $this->codec->name(), microtime( true ), $queue->id );
189
190			if ( ! $processed_item_ids \|\| is_wp_error( $processed_item_ids ) ) {
191			$checked_in_item_ids = $queue->checkin( $buffer );
192
193			if ( is_wp_error( $checked_in_item_ids ) ) {
194			error_log( 'Error checking in buffer: ' . $checked_in_item_ids->get_error_message() );
195			$queue->force_checkin();
196			}
197
198			if ( is_wp_error( $processed_item_ids ) ) {
199			return $processed_item_ids;
200			}
201
202			// returning a WP_Error is a sign to the caller that we should wait a while
203			// before syncing again
204			return new WP_Error( 'server_error' );
205
206			} else {
207
208			// detect if the last item ID was an error
209			$had_wp_error = is_wp_error( end( $processed_item_ids ) );
210
211			if ( $had_wp_error ) {
212			$wp_error = array_pop( $processed_item_ids );
213			}
214
215			// also checkin any items that were skipped
216			if ( count( $skipped_items_ids ) > 0 ) {
217			$processed_item_ids = array_merge( $processed_item_ids, $skipped_items_ids );
218			}
219
220			$processed_items = array_intersect_key( $items, array_flip( $processed_item_ids ) );
221
222			/**
223			* Allows us to keep track of all the actions that have been sent.
224			* Allows us to calculate the progress of specific actions.
225			*
226			* @since 4.2.0
227			*
228			* @param array $processed_actions The actions that we send successfully.
229			*/
230			do_action( 'jetpack_sync_processed_actions', $processed_items );
231
232			$queue->close( $buffer, $processed_item_ids );
233
234			// returning a WP_Error is a sign to the caller that we should wait a while
235			// before syncing again
236			if ( $had_wp_error ) {
237			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...
238			}
239			}
240
241			return true;
242			}
243
244			function get_sync_queue() {
245			return $this->sync_queue;
246			}
247
248			function get_full_sync_queue() {
249			return $this->full_sync_queue;
250			}
251
252			function get_codec() {
253			return $this->codec;
254			}
255
256			function send_checksum() {
257			require_once 'class.jetpack-sync-wp-replicastore.php';
258			$store = new Jetpack_Sync_WP_Replicastore();
259			do_action( 'jetpack_sync_checksum', $store->checksum_all() );
260			}
261
262			function reset_sync_queue() {
263			$this->sync_queue->reset();
264			}
265
266			function set_dequeue_max_bytes( $size ) {
267			$this->dequeue_max_bytes = $size;
268			}
269
270			// in bytes
271			function set_upload_max_bytes( $max_bytes ) {
272			$this->upload_max_bytes = $max_bytes;
273			}
274
275			// in rows
276			function set_upload_max_rows( $max_rows ) {
277			$this->upload_max_rows = $max_rows;
278			}
279
280			// in seconds
281			function set_sync_wait_time( $seconds ) {
282			$this->sync_wait_time = $seconds;
283			}
284
285			function get_sync_wait_time() {
286			return $this->sync_wait_time;
287			}
288
289			// in seconds
290			function set_sync_wait_threshold( $seconds ) {
291			$this->sync_wait_threshold = $seconds;
292			}
293
294			function get_sync_wait_threshold() {
295			return $this->sync_wait_threshold;
296			}
297
298			// in seconds
299			function set_max_dequeue_time( $seconds ) {
300			$this->max_dequeue_time = $seconds;
301			}
302
303			function set_defaults() {
304			$this->sync_queue = new Jetpack_Sync_Queue( 'sync' );
305			$this->full_sync_queue = new Jetpack_Sync_Queue( 'full_sync' );
306			$this->codec = new Jetpack_Sync_JSON_Deflate_Array_Codec();
307
308			// saved settings
309			Jetpack_Sync_Settings::set_importing( null );
310			$settings = Jetpack_Sync_Settings::get_settings();
311			$this->set_dequeue_max_bytes( $settings['dequeue_max_bytes'] );
312			$this->set_upload_max_bytes( $settings['upload_max_bytes'] );
313			$this->set_upload_max_rows( $settings['upload_max_rows'] );
314			$this->set_sync_wait_time( $settings['sync_wait_time'] );
315			$this->set_sync_wait_threshold( $settings['sync_wait_threshold'] );
316			$this->set_max_dequeue_time( Jetpack_Sync_Defaults::get_max_sync_execution_time() );
317			}
318
319			function reset_data() {
320			$this->reset_sync_queue();
321
322			foreach ( Jetpack_Sync_Modules::get_modules() as $module ) {
323			$module->reset_data();
324			}
325
326			foreach ( array( 'sync', 'full_sync' ) as $queue_name ) {
327			delete_option( self::NEXT_SYNC_TIME_OPTION_NAME . '_' . $queue_name );
328			}
329
330			Jetpack_Sync_Settings::reset_data();
331			}
332
333			function uninstall() {
334			// Lets delete all the other fun stuff like transient and option and the sync queue
335			$this->reset_data();
336
337			// delete the full sync status
338			delete_option( 'jetpack_full_sync_status' );
339
340			// clear the sync cron.
341			wp_clear_scheduled_hook( 'jetpack_sync_cron' );
342			}
343			}
344

Automattic / jetpack

Push — add/wait-if-queue-locked-by-ot... ( 80914f )

Jetpack_Sync_Sender::do_sync_and_set_delays() C

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like