Jetpack_Sync_Queue::get_checkout_option_name() - Code Metrics - Inspection of "Fix remaining test failures." - Automattic/jetpack - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — add/sync-rest-2 ( b696cb...bb3b5b )

unknown

created 2016-04-17 19:20 UTC

Jetpack_Sync_Queue::get_checkout_option_name() A

↳ Parent: Jetpack_Sync_Queue

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	1	Features	0

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

<?php

/** 
 * A buffer of items from the queue that can be checked out
 */
class Jetpack_Sync_Queue_Buffer {
	public $id;
	public $items_with_ids;
	
	public function __construct( $items_with_ids ) {
		$this->id = uniqid();
		$this->items_with_ids = $items_with_ids;
	}

	public function get_items() {
		return array_map( function( $item ) { return $item->value; }, $this->items_with_ids );
// Bad
$a = 5; $b = 6; $c = 7;

// Good
$a = 5;
$b = 6;
$c = 7;
	}

	public function get_item_ids() {
		return array_map( function( $item ) { return $item->id; }, $this->items_with_ids );
// Bad
$a = 5; $b = 6; $c = 7;

// Good
$a = 5;
$b = 6;
$c = 7;
	}
}

/**
 * A persistent queue that can be flushed in increments of N items,
 * and which blocks reads until checked-out buffers are checked in or
 * closed. This uses raw SQL for two reasons: speed, and not triggering 
 * tons of added_option callbacks.
 */
class Jetpack_Sync_Queue {

	public $id;
	private $checkout_size;

	function __construct( $id, $checkout_size = 10 ) {
		$this->id = str_replace( '-', '_', $id); // necessary to ensure we don't have ID collisions in the SQL
		$this->checkout_size = $checkout_size;
	}

	function add( $item ) {
		global $wpdb;
		$added = false;
		// this basically tries to add the option until enough time has elapsed that
		// it has a unique (microtime-based) option key
		while(!$added) {
			$rows_added = $wpdb->query( $wpdb->prepare( 
				"INSERT INTO $wpdb->options (option_name, option_value) VALUES (%s, %s)", 
				$this->get_next_data_row_option_name(), 
				serialize($item)
			) );
			$added = ( $rows_added !== 0 );
		}
	}

	// Attempts to insert all the items in a single SQL query. May be subject to query size limits!
	function add_all( $items ) {
		global $wpdb;
		$base_option_name = $this->get_next_data_row_option_name();

		$query = "INSERT INTO $wpdb->options (option_name, option_value) VALUES ";
		
		$rows = array();

		for ( $i=0; $i < count( $items ); $i += 1 ) {
for ($i=0; $i<count($array); $i++) { // calls count() on each iteration
}

// Better
for ($i=0, $c=count($array); $i<$c; $i++) { // calls count() just once
}
			$option_name = esc_sql( $base_option_name.'-'.$i );
			$option_value = esc_sql( serialize( $items[ $i ] ) );
			$rows[] = "('$option_name', '$option_value')";
		}

		$rows_added = $wpdb->query( $query . join( ',', $rows ) );

		if ( $rows_added !== count( $items ) ) {
			return new WP_Error( 'row_count_mismatch', "The number of rows inserted didn't match the size of the input array" );
		}
	}

	function reset() {
		global $wpdb;
		$this->delete_checkout_id();
		$wpdb->query( $wpdb->prepare( 
			"DELETE FROM $wpdb->options WHERE option_name LIKE %s", "jetpack_sync_queue_{$this->id}-%" 
		) );
	}

	function size() {
		global $wpdb;
		return $wpdb->get_var( $wpdb->prepare( 
			"SELECT count(*) FROM $wpdb->options WHERE option_name LIKE %s", "jetpack_sync_queue_{$this->id}-%" 
		) );
	}

	function checkout() {
		if ( $this->get_checkout_id() ) {
			return new WP_Error( 'unclosed_buffer', 'There is an unclosed buffer' );
		}

		$items = $this->fetch_items( $this->checkout_size );
		
		if ( count( $items ) === 0 ) {
			return false;
		}

		$buffer = new Jetpack_Sync_Queue_Buffer( array_slice( $items, 0, $this->checkout_size ) );
		
		$result = $this->set_checkout_id( $buffer->id );

		if ( !$result || is_wp_error( $result ) ) {
			error_log("badness setting checkout ID (this should not happen)");
			return $result;
		}
		
		return $buffer;
	}

	function checkin( $buffer ) {
		$is_valid = $this->validate_checkout( $buffer );

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

		$this->delete_checkout_id();

		return true;
	}

	function close( $buffer ) {
		$is_valid = $this->validate_checkout( $buffer );

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

		$this->delete_checkout_id();

		global $wpdb;

		// all this fanciness is basically so we can prepare a statement with an IN(id1, id2, id3) clause
		$ids_to_remove = $buffer->get_item_ids();
		if ( count( $ids_to_remove ) > 0 ) {
			$sql = "DELETE FROM $wpdb->options WHERE option_name IN (".implode(', ', array_fill(0, count($ids_to_remove), '%s')).')';
			$query = call_user_func_array( array( $wpdb, 'prepare' ), array_merge( array( $sql ), $ids_to_remove ) );
			$wpdb->query( $query );
		}

		return true;
	}

	function flush_all() {
		$items = array_map( function( $item ) { return $item->value; }, $this->fetch_items() );
// Bad
$a = 5; $b = 6; $c = 7;

// Good
$a = 5;
$b = 6;
$c = 7;
		$this->reset();
		return $items;
	}

	function get_all() {
		return $this->fetch_items();
	}

	function set_checkout_size( $new_size ) {
		$this->checkout_size = $new_size;
	}

	private function get_checkout_id() {
		return get_option( $this->get_checkout_option_name(), false );
	}

	private function set_checkout_id( $checkout_id ) {
		$added = add_option( $this->get_checkout_option_name(), $checkout_id, null, true ); // this one we should autoload
		if ( ! $added )
			return new WP_Error( 'buffer_mismatch', 'Another buffer is already checked out: '.$this->get_checkout_id() );
		else
			return true;
	}

	private function delete_checkout_id() {
		delete_option( $this->get_checkout_option_name() );
	}

	private function get_checkout_option_name() {
		return "jetpack_sync_queue_{$this->id}-checkout";
	}

	private function get_next_data_row_option_name() {
		// this option is specifically chosen to, as much as possible, preserve time order
		// and minimise the possibility of collisions between multiple processes working 
		// at the same time
		// TODO: confirm we only need to support PHP5 (otherwise we'll need to emulate microtime as float)

		// @see: http://php.net/manual/en/function.microtime.php
		$timestamp = sprintf( '%.9f', microtime(true) );
		return 'jetpack_sync_queue_'.$this->id.'-'.$timestamp.'-'.getmypid();
	}

	private function fetch_items( $limit = null ) {
		global $wpdb;

		if ( $limit ) {
			$query_sql = $wpdb->prepare( "SELECT option_name AS id, option_value AS value FROM $wpdb->options WHERE option_name LIKE %s ORDER BY option_name ASC LIMIT %d", "jetpack_sync_queue_{$this->id}-%", $limit );
		} else {
			$query_sql = $wpdb->prepare( "SELECT option_name AS id, option_value AS value FROM $wpdb->options WHERE option_name LIKE %s ORDER BY option_name ASC", "jetpack_sync_queue_{$this->id}-%" );
		}

		$items = $wpdb->get_results( $query_sql );
		foreach( $items as $item ) {
			$item->value = maybe_unserialize( $item->value );
		} 

		return $items;
	}

	private function validate_checkout( $buffer ) {
		if ( ! $buffer instanceof Jetpack_Sync_Queue_Buffer ) {
			return new WP_Error( 'not_a_buffer', 'You must checkin an instance of Jetpack_Sync_Queue_Buffer' );
		}

		$checkout_id = $this->get_checkout_id();

		if ( !$checkout_id ) {
			return new WP_Error( 'buffer_not_checked_out', 'There are no checked out buffers' );
		}

		if ( $checkout_id != $buffer->id ) {
			return new WP_Error( 'buffer_mismatch', 'The buffer you checked in was not checked out' );
		}

		return true;
	}
}

1			<?php
2
3			/**
4			* A buffer of items from the queue that can be checked out
5			*/
6			class Jetpack_Sync_Queue_Buffer {
7			public $id;
8			public $items_with_ids;
9
10			public function __construct( $items_with_ids ) {
11			$this->id = uniqid();
12			$this->items_with_ids = $items_with_ids;
13			}
14
15			public function get_items() {
16			return array_map( function( $item ) { return $item->value; }, $this->items_with_ids );
			0 ignored issues – show Coding Style introduced 2016-04-15 23:27 UTC by Report Bug Copy Issue Report It is generally recommended to place each PHP statement on a line by itself. Let’s take a look at an example: // Bad $a = 5; $b = 6; $c = 7; // Good $a = 5; $b = 6; $c = 7; Loading history...
17			}
18
19			public function get_item_ids() {
20			return array_map( function( $item ) { return $item->id; }, $this->items_with_ids );
			0 ignored issues – show Coding Style introduced 2016-04-15 23:27 UTC by Report Bug Copy Issue Report It is generally recommended to place each PHP statement on a line by itself. Let’s take a look at an example: // Bad $a = 5; $b = 6; $c = 7; // Good $a = 5; $b = 6; $c = 7; Loading history...
21			}
22			}
23
24			/**
25			* A persistent queue that can be flushed in increments of N items,
26			* and which blocks reads until checked-out buffers are checked in or
27			* closed. This uses raw SQL for two reasons: speed, and not triggering
28			* tons of added_option callbacks.
29			*/
30			class Jetpack_Sync_Queue {
			0 ignored issues – show Coding Style Compatibility introduced 2016-04-14 21:57 UTC by Report Bug Copy Issue Report PSR1 recommends that each class should be in its own file to aid autoloaders. Having each class in a dedicated file usually plays nice with PSR autoloaders and is therefore a well established practice. If you use other autoloaders, you might not want to follow this rule. Loading history...
31			public $id;
32			private $checkout_size;
33
34			function __construct( $id, $checkout_size = 10 ) {
35			$this->id = str_replace( '-', '_', $id); // necessary to ensure we don't have ID collisions in the SQL
36			$this->checkout_size = $checkout_size;
37			}
38
39			function add( $item ) {
40			global $wpdb;
41			$added = false;
42			// this basically tries to add the option until enough time has elapsed that
43			// it has a unique (microtime-based) option key
44			while(!$added) {
45			$rows_added = $wpdb->query( $wpdb->prepare(
46			"INSERT INTO $wpdb->options (option_name, option_value) VALUES (%s, %s)",
47			$this->get_next_data_row_option_name(),
48			serialize($item)
49			) );
50			$added = ( $rows_added !== 0 );
51			}
52			}
53
54			// Attempts to insert all the items in a single SQL query. May be subject to query size limits!
55			function add_all( $items ) {
56			global $wpdb;
57			$base_option_name = $this->get_next_data_row_option_name();
58
59			$query = "INSERT INTO $wpdb->options (option_name, option_value) VALUES ";
60
61			$rows = array();
62
63			for ( $i=0; $i < count( $items ); $i += 1 ) {
			0 ignored issues – show Performance Best Practice introduced 2016-04-17 19:11 UTC by Report Bug Copy Issue Report It seems like you are calling the size function `count()` as part of the test condition. You might want to compute the size beforehand, and not on each iteration. If the size of the collection does not change during the iteration, it is generally a good practice to compute it beforehand, and not on each iteration: for ($i=0; $i<count($array); $i++) { // calls count() on each iteration } // Better for ($i=0, $c=count($array); $i<$c; $i++) { // calls count() just once } Loading history...
64			$option_name = esc_sql( $base_option_name.'-'.$i );
65			$option_value = esc_sql( serialize( $items[ $i ] ) );
66			$rows[] = "('$option_name', '$option_value')";
67			}
68
69			$rows_added = $wpdb->query( $query . join( ',', $rows ) );
70
71			if ( $rows_added !== count( $items ) ) {
72			return new WP_Error( 'row_count_mismatch', "The number of rows inserted didn't match the size of the input array" );
73			}
74			}
75
76			function reset() {
77			global $wpdb;
78			$this->delete_checkout_id();
79			$wpdb->query( $wpdb->prepare(
80			"DELETE FROM $wpdb->options WHERE option_name LIKE %s", "jetpack_sync_queue_{$this->id}-%"
81			) );
82			}
83
84			function size() {
85			global $wpdb;
86			return $wpdb->get_var( $wpdb->prepare(
87			"SELECT count(*) FROM $wpdb->options WHERE option_name LIKE %s", "jetpack_sync_queue_{$this->id}-%"
88			) );
89			}
90
91			function checkout() {
92			if ( $this->get_checkout_id() ) {
93			return new WP_Error( 'unclosed_buffer', 'There is an unclosed buffer' );
94			}
95
96			$items = $this->fetch_items( $this->checkout_size );
97
98			if ( count( $items ) === 0 ) {
99			return false;
100			}
101
102			$buffer = new Jetpack_Sync_Queue_Buffer( array_slice( $items, 0, $this->checkout_size ) );
103
104			$result = $this->set_checkout_id( $buffer->id );
105
106			if ( !$result \|\| is_wp_error( $result ) ) {
107			error_log("badness setting checkout ID (this should not happen)");
108			return $result;
109			}
110
111			return $buffer;
112			}
113
114			function checkin( $buffer ) {
115			$is_valid = $this->validate_checkout( $buffer );
116
117			if ( is_wp_error( $is_valid ) ) {
118			return $is_valid;
119			}
120
121			$this->delete_checkout_id();
122
123			return true;
124			}
125
126			function close( $buffer ) {
127			$is_valid = $this->validate_checkout( $buffer );
128
129			if ( is_wp_error( $is_valid ) ) {
130			return $is_valid;
131			}
132
133			$this->delete_checkout_id();
134
135			global $wpdb;
136
137			// all this fanciness is basically so we can prepare a statement with an IN(id1, id2, id3) clause
138			$ids_to_remove = $buffer->get_item_ids();
139			if ( count( $ids_to_remove ) > 0 ) {
140			$sql = "DELETE FROM $wpdb->options WHERE option_name IN (".implode(', ', array_fill(0, count($ids_to_remove), '%s')).')';
141			$query = call_user_func_array( array( $wpdb, 'prepare' ), array_merge( array( $sql ), $ids_to_remove ) );
142			$wpdb->query( $query );
143			}
144
145			return true;
146			}
147
148			function flush_all() {
149			$items = array_map( function( $item ) { return $item->value; }, $this->fetch_items() );
			0 ignored issues – show Coding Style introduced 2016-04-15 23:27 UTC by Report Bug Copy Issue Report It is generally recommended to place each PHP statement on a line by itself. Let’s take a look at an example: // Bad $a = 5; $b = 6; $c = 7; // Good $a = 5; $b = 6; $c = 7; Loading history...
150			$this->reset();
151			return $items;
152			}
153
154			function get_all() {
155			return $this->fetch_items();
156			}
157
158			function set_checkout_size( $new_size ) {
159			$this->checkout_size = $new_size;
160			}
161
162			private function get_checkout_id() {
163			return get_option( $this->get_checkout_option_name(), false );
164			}
165
166			private function set_checkout_id( $checkout_id ) {
167			$added = add_option( $this->get_checkout_option_name(), $checkout_id, null, true ); // this one we should autoload
168			if ( ! $added )
169			return new WP_Error( 'buffer_mismatch', 'Another buffer is already checked out: '.$this->get_checkout_id() );
170			else
171			return true;
172			}
173
174			private function delete_checkout_id() {
175			delete_option( $this->get_checkout_option_name() );
176			}
177
178			private function get_checkout_option_name() {
179			return "jetpack_sync_queue_{$this->id}-checkout";
180			}
181
182			private function get_next_data_row_option_name() {
183			// this option is specifically chosen to, as much as possible, preserve time order
184			// and minimise the possibility of collisions between multiple processes working
185			// at the same time
186			// TODO: confirm we only need to support PHP5 (otherwise we'll need to emulate microtime as float)
			0 ignored issues – show Coding Style Best Practice introduced 2016-04-15 23:27 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...
187			// @see: http://php.net/manual/en/function.microtime.php
188			$timestamp = sprintf( '%.9f', microtime(true) );
189			return 'jetpack_sync_queue_'.$this->id.'-'.$timestamp.'-'.getmypid();
190			}
191
192			private function fetch_items( $limit = null ) {
193			global $wpdb;
194
195			if ( $limit ) {
196			$query_sql = $wpdb->prepare( "SELECT option_name AS id, option_value AS value FROM $wpdb->options WHERE option_name LIKE %s ORDER BY option_name ASC LIMIT %d", "jetpack_sync_queue_{$this->id}-%", $limit );
197			} else {
198			$query_sql = $wpdb->prepare( "SELECT option_name AS id, option_value AS value FROM $wpdb->options WHERE option_name LIKE %s ORDER BY option_name ASC", "jetpack_sync_queue_{$this->id}-%" );
199			}
200
201			$items = $wpdb->get_results( $query_sql );
202			foreach( $items as $item ) {
203			$item->value = maybe_unserialize( $item->value );
204			}
205
206			return $items;
207			}
208
209			private function validate_checkout( $buffer ) {
210			if ( ! $buffer instanceof Jetpack_Sync_Queue_Buffer ) {
211			return new WP_Error( 'not_a_buffer', 'You must checkin an instance of Jetpack_Sync_Queue_Buffer' );
212			}
213
214			$checkout_id = $this->get_checkout_id();
215
216			if ( !$checkout_id ) {
217			return new WP_Error( 'buffer_not_checked_out', 'There are no checked out buffers' );
218			}
219
220			if ( $checkout_id != $buffer->id ) {
221			return new WP_Error( 'buffer_mismatch', 'The buffer you checked in was not checked out' );
222			}
223
224			return true;
225			}
226			}

Automattic / jetpack

Push — add/sync-rest-2 ( b696cb...bb3b5b )

Jetpack_Sync_Queue::get_checkout_option_name() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like