Sync_Service::sync_many() - Code Metrics - Inspection of "1187 improve speed of sync" - insideout10/wordlift-plugin - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — develop (#1282)

by David

created 2021-02-05 09:26 UTC

Sync_Service::sync_many() B

↳ Parent: Sync_Service

Complexity

Conditions	8
Paths	16

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	8
nc	16
nop	2
dl	0
loc	49
rs	7.8682
c	0
b	0
f	0

<?php

namespace Wordlift\Dataset;

use Exception;
use Wordlift\Api\Api_Service;
use Wordlift\Jsonld\Jsonld_Service;

class Sync_Service {
	const JSONLD_HASH = '_wl_jsonld_hash';
	const SYNCED_GMT = '_wl_synced_gmt';

	/**
	 * @var \Wordlift_Log_Service
	 */
	private $log;

	/**
	 * @var Api_Service
	 */
	private $api_service;

	/**
	 * @var Jsonld_Service
	 */
	private $jsonld_service;

	/**
	 * @var Sync_Background_Process
	 */
	private $sync_background_process;

	/**
	 * The number of posts processed in one call.
	 *
	 * @var int The batch size.
	 */
	private $batch_size;

	/**
	 * @var Sync_Object_Adapter_Factory
	 */
	private $sync_object_adapter_factory;

	/**
	 * @var Sync_Service
	 */
	private static $instance;
	private $entity_service;

	/**
	 * Constructor.
	 *
	 * @param Api_Service $api_service The {@link Api_Service} used to communicate with the remote APIs.
	 * @param Sync_Object_Adapter_Factory $sync_object_adapter_factory
	 * @param Jsonld_Service $jsonld_service
	 * @param \Wordlift_Entity_Service $entity_service
	 */
	public function __construct( $api_service, $sync_object_adapter_factory, $jsonld_service, $entity_service ) {

		$this->log = \Wordlift_Log_Service::get_logger( get_class() );

		$this->api_service                 = $api_service;
		$this->sync_object_adapter_factory = $sync_object_adapter_factory;
		$this->jsonld_service              = $jsonld_service;
		$this->entity_service              = $entity_service;
		$this->batch_size                  = 10;

		// You need to initialize this early, otherwise the Background Process isn't registered in AJAX calls.
//		$this->sync_background_process = new Sync_Background_Process( $this );;

		// Exclude the JSONLD_HASH meta key from those that require a resync.
		add_filter( 'wl_dataset__sync_hooks__ignored_meta_keys', function ( $args ) {
			$args[] = Sync_Service::JSONLD_HASH;
			$args[] = Sync_Service::SYNCED_GMT;

			return $args;
		} );

		self::$instance = $this;
	}

	public static function get_instance() {
		return self::$instance;
	}

	/**
	 * @param int $type
	 * @param int $object_id
	 *
	 * @return array|false
	 * @throws Exception
	 */
	public function sync_one( $type, $object_id ) {

		$object = $this->sync_object_adapter_factory->create( $type, $object_id );

		return $this->sync_many( array( $object ) );
	}

	public function delete_one( $type, $object_id ) {
		$object = $this->sync_object_adapter_factory->create( $type, $object_id );
		$uri    = $object->get_meta( 'entity_url', true );

		// Entity URL isn't set, bail out.
		if ( empty( $uri ) ) {
			return false;
		}

		$response = $this->api_service->request(
			'DELETE', sprintf( '/middleware/dataset?uri=%s', rawurlencode( $uri ) ) );

		// Update the sync date in case of success, otherwise log an error.
		if ( ! $response->is_success() ) {
			return false;
		}

		return true;
	}

	/**
	 * @param Sync_Object_Adapter[] $objects
	 * @param bool $force Force synchronization even if the json-ld hash hasn't changed.
	 *
	 * @return bool
	 * @throws Exception
	 */
	public function sync_many( $objects, $force = false ) {

		$hashes   = array();
		$payloads = array();
		foreach ( $objects as $object ) {
			// Bail out if no payload.
			$payload_as_string = $this->get_payload_as_string( $object );
			if ( empty( $payload_as_string ) ) {
				continue;
			}

			$new_hash = sha1( $payload_as_string );
			$old_hash = $object->get_meta( self::JSONLD_HASH, true );
			// JSON-LD hasn't changed, bail out.
			if ( ! $force && $new_hash === $old_hash ) {
				continue;
			}

			// Collect the hashes and the payloads.
			$hashes[]   = array( $object, $new_hash );
			$payloads[] = $payload_as_string;
		}

		// Bail out if payloads are empty.
		if ( empty( $payloads ) ) {
			return false;
		}

		$response = $this->api_service->request(
			'POST', '/middleware/dataset/batch',
			array( 'Content-Type' => 'application/json', ),
			// Put the payload in a JSON array w/o decoding/encoding again.
			'[ ' . implode( ', ', $payloads ) . ' ]' );

		// Update the sync date in case of success, otherwise log an error.
		if ( ! $response->is_success() ) {
			return false;
		}

		// If successful update the hashes and sync'ed datetime.
		foreach ( $hashes as $hash ) {
			$object   = $hash[0];
			$new_hash = $hash[1];
			$object->update_meta( self::JSONLD_HASH, $new_hash );
			$object->update_meta( self::SYNCED_GMT, current_time( 'mysql', true ) );
		}

		return true;
	}

	/**
	 * @param Sync_Object_Adapter $object
	 *
	 * @return false|string
	 * @throws Exception
	 */
	private function get_payload_as_string( $object ) {
		$type      = $object->get_type();
		$object_id = $object->get_object_id();

		$jsonld_as_string = wp_json_encode( apply_filters( 'wl_dataset__sync_service__sync_item__jsonld',
			$this->jsonld_service->get( $type, $object_id ), $type, $object_id ) );
		$uri              = $this->entity_service->get_uri( $object_id, $type );

		// Entity URL isn't set, bail out.
		if ( empty( $uri ) ) {
			return false;
		}

		return wp_json_encode( array(
			'uri'     => $uri,
			'model'   => $jsonld_as_string,
			'private' => ! $object->is_public(),
		) );
	}

	/**
	 * @param $post_id
	 *
	 * @todo Complete the delete item.
	 */
	public function delete_item( $post_id ) {
		$uri = get_post_meta( $post_id, 'entity_url', true );
		// Make a request to the remote endpoint.
		$response = $this->api_service->request(
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
			'DELETE', '/middleware/dataset?uri=' . rawurlencode( $uri ),
			array( 'Content-Type' => 'application/ld+json', ) );
	}

	public function get_batch_size() {

		return $this->batch_size;
	}

	public function delete_all() {
		$this->api_service->request( 'DELETE', '/middleware/dataset/all' );
	}

}


1			<?php
2
3			namespace Wordlift\Dataset;
4
5			use Exception;
6			use Wordlift\Api\Api_Service;
7			use Wordlift\Jsonld\Jsonld_Service;
8
9			class Sync_Service {
10			const JSONLD_HASH = '_wl_jsonld_hash';
11			const SYNCED_GMT = '_wl_synced_gmt';
12
13			/**
14			* @var \Wordlift_Log_Service
15			*/
16			private $log;
17
18			/**
19			* @var Api_Service
20			*/
21			private $api_service;
22
23			/**
24			* @var Jsonld_Service
25			*/
26			private $jsonld_service;
27
28			/**
29			* @var Sync_Background_Process
30			*/
31			private $sync_background_process;
32
33			/**
34			* The number of posts processed in one call.
35			*
36			* @var int The batch size.
37			*/
38			private $batch_size;
39
40			/**
41			* @var Sync_Object_Adapter_Factory
42			*/
43			private $sync_object_adapter_factory;
44
45			/**
46			* @var Sync_Service
47			*/
48			private static $instance;
49			private $entity_service;
50
51			/**
52			* Constructor.
53			*
54			* @param Api_Service $api_service The {@link Api_Service} used to communicate with the remote APIs.
55			* @param Sync_Object_Adapter_Factory $sync_object_adapter_factory
56			* @param Jsonld_Service $jsonld_service
57			* @param \Wordlift_Entity_Service $entity_service
58			*/
59			public function __construct( $api_service, $sync_object_adapter_factory, $jsonld_service, $entity_service ) {
60
61			$this->log = \Wordlift_Log_Service::get_logger( get_class() );
62
63			$this->api_service = $api_service;
64			$this->sync_object_adapter_factory = $sync_object_adapter_factory;
65			$this->jsonld_service = $jsonld_service;
66			$this->entity_service = $entity_service;
67			$this->batch_size = 10;
68
69			// You need to initialize this early, otherwise the Background Process isn't registered in AJAX calls.
70			// $this->sync_background_process = new Sync_Background_Process( $this );;
71
72			// Exclude the JSONLD_HASH meta key from those that require a resync.
73			add_filter( 'wl_dataset__sync_hooks__ignored_meta_keys', function ( $args ) {
74			$args[] = Sync_Service::JSONLD_HASH;
75			$args[] = Sync_Service::SYNCED_GMT;
76
77			return $args;
78			} );
79
80			self::$instance = $this;
81			}
82
83			public static function get_instance() {
84			return self::$instance;
85			}
86
87			/**
88			* @param int $type
89			* @param int $object_id
90			*
91			* @return array\|false
92			* @throws Exception
93			*/
94			public function sync_one( $type, $object_id ) {
95
96			$object = $this->sync_object_adapter_factory->create( $type, $object_id );
97
98			return $this->sync_many( array( $object ) );
99			}
100
101			public function delete_one( $type, $object_id ) {
102			$object = $this->sync_object_adapter_factory->create( $type, $object_id );
103			$uri = $object->get_meta( 'entity_url', true );
104
105			// Entity URL isn't set, bail out.
106			if ( empty( $uri ) ) {
107			return false;
108			}
109
110			$response = $this->api_service->request(
111			'DELETE', sprintf( '/middleware/dataset?uri=%s', rawurlencode( $uri ) ) );
112
113			// Update the sync date in case of success, otherwise log an error.
114			if ( ! $response->is_success() ) {
115			return false;
116			}
117
118			return true;
119			}
120
121			/**
122			* @param Sync_Object_Adapter[] $objects
123			* @param bool $force Force synchronization even if the json-ld hash hasn't changed.
124			*
125			* @return bool
126			* @throws Exception
127			*/
128			public function sync_many( $objects, $force = false ) {
129
130			$hashes = array();
131			$payloads = array();
132			foreach ( $objects as $object ) {
133			// Bail out if no payload.
134			$payload_as_string = $this->get_payload_as_string( $object );
135			if ( empty( $payload_as_string ) ) {
136			continue;
137			}
138
139			$new_hash = sha1( $payload_as_string );
140			$old_hash = $object->get_meta( self::JSONLD_HASH, true );
141			// JSON-LD hasn't changed, bail out.
142			if ( ! $force && $new_hash === $old_hash ) {
143			continue;
144			}
145
146			// Collect the hashes and the payloads.
147			$hashes[] = array( $object, $new_hash );
148			$payloads[] = $payload_as_string;
149			}
150
151			// Bail out if payloads are empty.
152			if ( empty( $payloads ) ) {
153			return false;
154			}
155
156			$response = $this->api_service->request(
157			'POST', '/middleware/dataset/batch',
158			array( 'Content-Type' => 'application/json', ),
159			// Put the payload in a JSON array w/o decoding/encoding again.
160			'[ ' . implode( ', ', $payloads ) . ' ]' );
161
162			// Update the sync date in case of success, otherwise log an error.
163			if ( ! $response->is_success() ) {
164			return false;
165			}
166
167			// If successful update the hashes and sync'ed datetime.
168			foreach ( $hashes as $hash ) {
169			$object = $hash[0];
170			$new_hash = $hash[1];
171			$object->update_meta( self::JSONLD_HASH, $new_hash );
172			$object->update_meta( self::SYNCED_GMT, current_time( 'mysql', true ) );
173			}
174
175			return true;
176			}
177
178			/**
179			* @param Sync_Object_Adapter $object
180			*
181			* @return false\|string
182			* @throws Exception
183			*/
184			private function get_payload_as_string( $object ) {
185			$type = $object->get_type();
186			$object_id = $object->get_object_id();
187
188			$jsonld_as_string = wp_json_encode( apply_filters( 'wl_dataset__sync_service__sync_item__jsonld',
189			$this->jsonld_service->get( $type, $object_id ), $type, $object_id ) );
190			$uri = $this->entity_service->get_uri( $object_id, $type );
191
192			// Entity URL isn't set, bail out.
193			if ( empty( $uri ) ) {
194			return false;
195			}
196
197			return wp_json_encode( array(
198			'uri' => $uri,
199			'model' => $jsonld_as_string,
200			'private' => ! $object->is_public(),
201			) );
202			}
203
204			/**
205			* @param $post_id
206			*
207			* @todo Complete the delete item.
208			*/
209			public function delete_item( $post_id ) {
210			$uri = get_post_meta( $post_id, 'entity_url', true );
211			// Make a request to the remote endpoint.
212			$response = $this->api_service->request(
			0 ignored issues – show Unused Code introduced 2020-11-17 13:20 UTC by Report Bug Copy Issue Report `$response` 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...
213			'DELETE', '/middleware/dataset?uri=' . rawurlencode( $uri ),
214			array( 'Content-Type' => 'application/ld+json', ) );
215			}
216
217			public function get_batch_size() {
218
219			return $this->batch_size;
220			}
221
222			public function delete_all() {
223			$this->api_service->request( 'DELETE', '/middleware/dataset/all' );
224			}
225
226			}
227

insideout10 / wordlift-plugin

Pull Request — develop (#1282)

Sync_Service::sync_many() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like