StatusManager::configureEventDispatcher() - Code Metrics - Inspection of "ignore service and mux subscriptions, fixes #3, fi..." - Jalle19/tvheadend-status-manager - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 6a09d7...558842 )

by Sam

created 2016-02-18 08:02 UTC

StatusManager::configureEventDispatcher() A

↳ Parent: StatusManager

Complexity

Conditions	2
Paths	2

Size

Total Lines	17
Code Lines	12

Duplication

Lines	0
Ratio	0 %

Importance

Changes	3
Bugs	1	Features	0

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

<?php

namespace Jalle19\StatusManager;

use Jalle19\StatusManager\Database;
use Jalle19\StatusManager\Event\ConnectionSeenEvent;
use Jalle19\StatusManager\Event\Events;
use Jalle19\StatusManager\Event\InputSeenEvent;
use Jalle19\StatusManager\Event\InstanceSeenEvent;
use Jalle19\StatusManager\Event\InstanceStatusUpdatesEvent;
use Jalle19\StatusManager\Event\SubscriptionSeenEvent;
use Jalle19\StatusManager\Event\SubscriptionStateChangeEvent;
use Jalle19\StatusManager\Subscription\StateChangeParser;
use Psr\Log\LoggerInterface;
use Ratchet\Http\HttpServer;
use Ratchet\Server\IoServer;
use Ratchet\WebSocket\WsServer;
use Symfony\Component\EventDispatcher\EventDispatcher;

/**
 * Class StatusManager
 * @package   Jalle19\StatusManager
 * @copyright Copyright &copy; Sam Stenvall 2015-
 * @license   https://www.gnu.org/licenses/gpl.html The GNU General Public License v2.0
 */
class StatusManager
{

	/**
	 * The number of cycles to wait until retrying an unreachable instance
	 */
	const UNREACHABLE_CYCLES_UNTIL_RETRY = 10;

	/**
	 * @var Configuration the configuration
	 */
	private $_configuration;

	/**
	 * @var \SplObjectStorage the instances to connect to and their individual state
	 */
	private $_instances;

	/**
	 * @var LoggerInterface the logger
	 */
	private $_logger;

	/**
	 * @var IoServer the Websocket server
	 */
	private $_websocket;

	/**
	 * @var WebSocketManager
	 */
	private $_WebSocketManager;

	/**
	 * @var EventDispatcher
	 */
	private $_eventDispatcher;

	/**
	 * @var PersistenceManager the persistence manager
	 */
	private $_persistenceManager;


	/**
	 * StatusManager constructor.
	 *
	 * @param Configuration   $configuration
	 * @param LoggerInterface $logger
	 */
	public function __construct(Configuration $configuration, LoggerInterface $logger)
	{
		$this->_configuration = $configuration;
		$this->_logger        = $logger;
		$this->_instances     = new \SplObjectStorage();

		// Attach a state to each instance
		foreach ($this->_configuration->getInstances() as $instance)
			$this->_instances->attach($instance, new InstanceState());

		// Create manager instances
		$this->_persistenceManager = new PersistenceManager($logger);
		$this->_WebSocketManager   = new WebSocketManager($logger);

		// Configure the event dispatcher
		$this->configureEventDispatcher();
	}


	/**
	 * Configures the event dispatcher and attaches event listeners to it
	 */
	private function configureEventDispatcher()
	{
		$this->_eventDispatcher = new EventDispatcher();

		$eventDefinitions = [
			[Events::MAIN_LOOP_STARTING, $this->_persistenceManager, 'onMainLoopStarted'],
			[Events::INSTANCE_STATUS_UPDATES, $this->_WebSocketManager, 'onInstanceStatusUpdates'],
			[Events::INSTANCE_SEEN, $this->_persistenceManager, 'onInstanceSeen'],
			[Events::CONNECTION_SEEN, $this->_persistenceManager, 'onConnectionSeen'],
			[Events::INPUT_SEEN, $this->_persistenceManager, 'onInputSeen'],
			[Events::SUBSCRIPTION_SEEN, $this->_persistenceManager, 'onSubscriptionSeen'],
			[Events::SUBSCRIPTION_STATE_CHANGE, $this->_persistenceManager, 'onSubscriptionStateChange'],
		];

		foreach ($eventDefinitions as $eventDefinition)
			$this->_eventDispatcher->addListener($eventDefinition[0], [$eventDefinition[1], $eventDefinition[2]]);
	}


	/**
	 * Runs the application
	 */
	public function run()
	{
		// Configure the WebSocket server
		$address = $this->_configuration->getListenAddress();
		$port    = $this->_configuration->getListenPort();

		$this->_websocket = IoServer::factory(
			new HttpServer(new WsServer($this->_WebSocketManager)),
			$port,
			$address
		);

		// Add the instance polling mechanism to the event loop
		$this->_websocket->loop->addPeriodicTimer($this->_configuration->getUpdateInterval(),
			[$this, 'handleInstanceUpdates']);

		// Log information about the database
		$this->_logger->debug('Using database at {databasePath}', [
			'databasePath' => $this->_configuration->getDatabasePath(),
		]);

		// Log information about the configured instances
		$instances = $this->_configuration->getInstances();

		$this->_logger->info('Managing {instances} instances:', [
			'instances' => count($instances),
		]);

		foreach ($instances as $configuredInstance)
		{
			$instance = $configuredInstance->getInstance();

			$this->_logger->info('  {address}:{port}', [
				'address' => $instance->getHostname(),
				'port'    => $instance->getPort(),
			]);

			$this->_eventDispatcher->dispatch(Events::INSTANCE_SEEN, new InstanceSeenEvent($instance));
		}

		$this->_eventDispatcher->dispatch(Events::MAIN_LOOP_STARTING);

		// Start the main loop
		$this->_logger->info('Starting the Websocket server on {address}:{port}', [
			'address' => $address,
			'port'    => $port,
		]);

		$this->_websocket->run();
	}


	/**
	 * Handles the updates polled from the instances
	 */
	public function handleInstanceUpdates()
	{
		$statusCollection = $this->getStatusMessages();

		foreach ($statusCollection->getInstanceStatuses() as $instanceStatus)
		{
			$instanceName = $instanceStatus->getInstanceName();

			$this->_logger->debug('Got status updates from {instanceName}', [
				'instanceName' => $instanceName,
			]);

			// Persist connections
			foreach ($instanceStatus->getConnections() as $connection)
			{
				$this->_eventDispatcher->dispatch(Events::CONNECTION_SEEN,
					new ConnectionSeenEvent($instanceName, $connection));
			}

			// Persist inputs
			foreach ($instanceStatus->getInputs() as $input)
				$this->_eventDispatcher->dispatch(Events::INPUT_SEEN, new InputSeenEvent($instanceName, $input));

			// Persist running subscriptions
			foreach ($instanceStatus->getSubscriptions() as $subscription)
			{
				$this->_eventDispatcher->dispatch(Events::SUBSCRIPTION_SEEN,
					new SubscriptionSeenEvent($instanceName, $subscription));
			}

			// Handle subscription state changes
			foreach ($instanceStatus->getSubscriptionStateChanges() as $subscriptionStateChange)
			{
				$this->_eventDispatcher->dispatch(Events::SUBSCRIPTION_STATE_CHANGE,
					new SubscriptionStateChangeEvent($instanceName, $subscriptionStateChange));
			}
		}

		$this->_eventDispatcher->dispatch(Events::INSTANCE_STATUS_UPDATES,
			new InstanceStatusUpdatesEvent($statusCollection));
	}


	/**
	 * Retrieves and returns all status messages for the configured
	 * instances
	 * @return InstanceStatusCollection
	 */
	private function getStatusMessages()
	{
		$collection = new InstanceStatusCollection();

		foreach ($this->_instances as $instance)
		{
			/* @var Instance $instance */
			$tvheadend    = $instance->getInstance();
			$instanceName = $instance->getName();

			/* @var InstanceState $instanceState */
			$instanceState = $this->_instances[$instance];

			// Collect statuses from currently reachable instances
			if ($instanceState->isReachable())
			{
				try
				{
					$collection->add(new InstanceStatus(
						$instanceName,
						$tvheadend->getInputStatus(),
						$tvheadend->getSubscriptionStatus(),
						$tvheadend->getConnectionStatus(),
						StateChangeParser::parseStateChanges($tvheadend->getLogMessages())));

					// Update reachability state now that we know the instance is reachable
					if ($instanceState->getReachability() === InstanceState::MAYBE_REACHABLE)
					{
						$this->_logger->info('Instance {instanceName} is now reachable, will start polling for updates',
							[
								'instanceName' => $instanceName,
							]);

						$instanceState->setReachability(InstanceState::REACHABLE);
					}
				}
				catch (\Exception $e)
				{
					// Mark the instance as unreachable
					$message = 'Instance {instanceName} not reachable, will wait for {cycles} cycles before retrying.
								The exception was: {exception}';

					$this->_logger->alert($message, [
						'instanceName' => $instanceName,
						'cycles'       => self::UNREACHABLE_CYCLES_UNTIL_RETRY,
						'exception'    => $e->getMessage(),
					]);

					$instanceState->setReachability(InstanceState::UNREACHABLE);
				}
			}
			else
			{
				// Wait for some cycles and then mark unreachable instances as maybe reachable
				if ($instanceState->getRetryCount() === self::UNREACHABLE_CYCLES_UNTIL_RETRY - 1)
				{
					$instanceState->setReachability(InstanceState::MAYBE_REACHABLE);
					$instanceState->resetRetryCount();

					$this->_logger->info('Retrying instance {instanceName} during next cycle', [
						'instanceName' => $instanceName,
					]);
				}
				else
					$instanceState->incrementRetryCount();
			}
		}

		return $collection;
	}

}


1			<?php
2
3			namespace Jalle19\StatusManager;
4
5			use Jalle19\StatusManager\Database;
6			use Jalle19\StatusManager\Event\ConnectionSeenEvent;
7			use Jalle19\StatusManager\Event\Events;
8			use Jalle19\StatusManager\Event\InputSeenEvent;
9			use Jalle19\StatusManager\Event\InstanceSeenEvent;
10			use Jalle19\StatusManager\Event\InstanceStatusUpdatesEvent;
11			use Jalle19\StatusManager\Event\SubscriptionSeenEvent;
12			use Jalle19\StatusManager\Event\SubscriptionStateChangeEvent;
13			use Jalle19\StatusManager\Subscription\StateChangeParser;
14			use Psr\Log\LoggerInterface;
15			use Ratchet\Http\HttpServer;
16			use Ratchet\Server\IoServer;
17			use Ratchet\WebSocket\WsServer;
18			use Symfony\Component\EventDispatcher\EventDispatcher;
19
20			/**
21			* Class StatusManager
22			* @package Jalle19\StatusManager
23			* @copyright Copyright © Sam Stenvall 2015-
24			* @license https://www.gnu.org/licenses/gpl.html The GNU General Public License v2.0
25			*/
26			class StatusManager
27			{
28
29			/**
30			* The number of cycles to wait until retrying an unreachable instance
31			*/
32			const UNREACHABLE_CYCLES_UNTIL_RETRY = 10;
33
34			/**
35			* @var Configuration the configuration
36			*/
37			private $_configuration;
38
39			/**
40			* @var \SplObjectStorage the instances to connect to and their individual state
41			*/
42			private $_instances;
43
44			/**
45			* @var LoggerInterface the logger
46			*/
47			private $_logger;
48
49			/**
50			* @var IoServer the Websocket server
51			*/
52			private $_websocket;
53
54			/**
55			* @var WebSocketManager
56			*/
57			private $_WebSocketManager;
58
59			/**
60			* @var EventDispatcher
61			*/
62			private $_eventDispatcher;
63
64			/**
65			* @var PersistenceManager the persistence manager
66			*/
67			private $_persistenceManager;
68
69
70			/**
71			* StatusManager constructor.
72			*
73			* @param Configuration $configuration
74			* @param LoggerInterface $logger
75			*/
76			public function __construct(Configuration $configuration, LoggerInterface $logger)
77			{
78			$this->_configuration = $configuration;
79			$this->_logger = $logger;
80			$this->_instances = new \SplObjectStorage();
81
82			// Attach a state to each instance
83			foreach ($this->_configuration->getInstances() as $instance)
84			$this->_instances->attach($instance, new InstanceState());
85
86			// Create manager instances
87			$this->_persistenceManager = new PersistenceManager($logger);
88			$this->_WebSocketManager = new WebSocketManager($logger);
89
90			// Configure the event dispatcher
91			$this->configureEventDispatcher();
92			}
93
94
95			/**
96			* Configures the event dispatcher and attaches event listeners to it
97			*/
98			private function configureEventDispatcher()
99			{
100			$this->_eventDispatcher = new EventDispatcher();
101
102			$eventDefinitions = [
103			[Events::MAIN_LOOP_STARTING, $this->_persistenceManager, 'onMainLoopStarted'],
104			[Events::INSTANCE_STATUS_UPDATES, $this->_WebSocketManager, 'onInstanceStatusUpdates'],
105			[Events::INSTANCE_SEEN, $this->_persistenceManager, 'onInstanceSeen'],
106			[Events::CONNECTION_SEEN, $this->_persistenceManager, 'onConnectionSeen'],
107			[Events::INPUT_SEEN, $this->_persistenceManager, 'onInputSeen'],
108			[Events::SUBSCRIPTION_SEEN, $this->_persistenceManager, 'onSubscriptionSeen'],
109			[Events::SUBSCRIPTION_STATE_CHANGE, $this->_persistenceManager, 'onSubscriptionStateChange'],
110			];
111
112			foreach ($eventDefinitions as $eventDefinition)
113			$this->_eventDispatcher->addListener($eventDefinition[0], [$eventDefinition[1], $eventDefinition[2]]);
114			}
115
116
117			/**
118			* Runs the application
119			*/
120			public function run()
121			{
122			// Configure the WebSocket server
123			$address = $this->_configuration->getListenAddress();
124			$port = $this->_configuration->getListenPort();
125
126			$this->_websocket = IoServer::factory(
127			new HttpServer(new WsServer($this->_WebSocketManager)),
128			$port,
129			$address
130			);
131
132			// Add the instance polling mechanism to the event loop
133			$this->_websocket->loop->addPeriodicTimer($this->_configuration->getUpdateInterval(),
134			[$this, 'handleInstanceUpdates']);
135
136			// Log information about the database
137			$this->_logger->debug('Using database at {databasePath}', [
138			'databasePath' => $this->_configuration->getDatabasePath(),
139			]);
140
141			// Log information about the configured instances
142			$instances = $this->_configuration->getInstances();
143
144			$this->_logger->info('Managing {instances} instances:', [
145			'instances' => count($instances),
146			]);
147
148			foreach ($instances as $configuredInstance)
149			{
150			$instance = $configuredInstance->getInstance();
151
152			$this->_logger->info(' {address}:{port}', [
153			'address' => $instance->getHostname(),
154			'port' => $instance->getPort(),
155			]);
156
157			$this->_eventDispatcher->dispatch(Events::INSTANCE_SEEN, new InstanceSeenEvent($instance));
158			}
159
160			$this->_eventDispatcher->dispatch(Events::MAIN_LOOP_STARTING);
161
162			// Start the main loop
163			$this->_logger->info('Starting the Websocket server on {address}:{port}', [
164			'address' => $address,
165			'port' => $port,
166			]);
167
168			$this->_websocket->run();
169			}
170
171
172			/**
173			* Handles the updates polled from the instances
174			*/
175			public function handleInstanceUpdates()
176			{
177			$statusCollection = $this->getStatusMessages();
178
179			foreach ($statusCollection->getInstanceStatuses() as $instanceStatus)
180			{
181			$instanceName = $instanceStatus->getInstanceName();
182
183			$this->_logger->debug('Got status updates from {instanceName}', [
184			'instanceName' => $instanceName,
185			]);
186
187			// Persist connections
188			foreach ($instanceStatus->getConnections() as $connection)
189			{
190			$this->_eventDispatcher->dispatch(Events::CONNECTION_SEEN,
191			new ConnectionSeenEvent($instanceName, $connection));
192			}
193
194			// Persist inputs
195			foreach ($instanceStatus->getInputs() as $input)
196			$this->_eventDispatcher->dispatch(Events::INPUT_SEEN, new InputSeenEvent($instanceName, $input));
197
198			// Persist running subscriptions
199			foreach ($instanceStatus->getSubscriptions() as $subscription)
200			{
201			$this->_eventDispatcher->dispatch(Events::SUBSCRIPTION_SEEN,
202			new SubscriptionSeenEvent($instanceName, $subscription));
203			}
204
205			// Handle subscription state changes
206			foreach ($instanceStatus->getSubscriptionStateChanges() as $subscriptionStateChange)
207			{
208			$this->_eventDispatcher->dispatch(Events::SUBSCRIPTION_STATE_CHANGE,
209			new SubscriptionStateChangeEvent($instanceName, $subscriptionStateChange));
210			}
211			}
212
213			$this->_eventDispatcher->dispatch(Events::INSTANCE_STATUS_UPDATES,
214			new InstanceStatusUpdatesEvent($statusCollection));
215			}
216
217
218			/**
219			* Retrieves and returns all status messages for the configured
220			* instances
221			* @return InstanceStatusCollection
222			*/
223			private function getStatusMessages()
224			{
225			$collection = new InstanceStatusCollection();
226
227			foreach ($this->_instances as $instance)
228			{
229			/* @var Instance $instance */
230			$tvheadend = $instance->getInstance();
231			$instanceName = $instance->getName();
232
233			/* @var InstanceState $instanceState */
234			$instanceState = $this->_instances[$instance];
235
236			// Collect statuses from currently reachable instances
237			if ($instanceState->isReachable())
238			{
239			try
240			{
241			$collection->add(new InstanceStatus(
242			$instanceName,
243			$tvheadend->getInputStatus(),
244			$tvheadend->getSubscriptionStatus(),
245			$tvheadend->getConnectionStatus(),
246			StateChangeParser::parseStateChanges($tvheadend->getLogMessages())));
247
248			// Update reachability state now that we know the instance is reachable
249			if ($instanceState->getReachability() === InstanceState::MAYBE_REACHABLE)
250			{
251			$this->_logger->info('Instance {instanceName} is now reachable, will start polling for updates',
252			[
253			'instanceName' => $instanceName,
254			]);
255
256			$instanceState->setReachability(InstanceState::REACHABLE);
257			}
258			}
259			catch (\Exception $e)
260			{
261			// Mark the instance as unreachable
262			$message = 'Instance {instanceName} not reachable, will wait for {cycles} cycles before retrying.
263			The exception was: {exception}';
264
265			$this->_logger->alert($message, [
266			'instanceName' => $instanceName,
267			'cycles' => self::UNREACHABLE_CYCLES_UNTIL_RETRY,
268			'exception' => $e->getMessage(),
269			]);
270
271			$instanceState->setReachability(InstanceState::UNREACHABLE);
272			}
273			}
274			else
275			{
276			// Wait for some cycles and then mark unreachable instances as maybe reachable
277			if ($instanceState->getRetryCount() === self::UNREACHABLE_CYCLES_UNTIL_RETRY - 1)
278			{
279			$instanceState->setReachability(InstanceState::MAYBE_REACHABLE);
280			$instanceState->resetRetryCount();
281
282			$this->_logger->info('Retrying instance {instanceName} during next cycle', [
283			'instanceName' => $instanceName,
284			]);
285			}
286			else
287			$instanceState->incrementRetryCount();
288			}
289			}
290
291			return $collection;
292			}
293
294			}
295

Jalle19 / tvheadend-status-manager

Push — master ( 6a09d7...558842 )

StatusManager::configureEventDispatcher() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like