chore: add PHPStan and Psalm and modernize code (#4)

Author: ramsey

SentryComponent.php

@@ -22,50 +22,48 @@ class SentryComponent extends CApplicationComponent
 	 * @var string Sentry DSN.
 	 * @see https://github.com/getsentry/raven-php#configuration
 	 */
-	public $dsn;
+	public string $dsn = '';
 
 	/**
-	 * @var array Raven_Client options.
+	 * @var mixed[] Raven_Client options.
 	 * @see https://github.com/getsentry/raven-php#configuration
 	 */
-	public $options = array();
+	public array $options = [];
 
 	/**
 	 * Publish, register and configure Raven-JS.
 	 * @see https://raven-js.readthedocs.org/
-	 * @var bool
 	 */
-	public $useRavenJs = false;
+	public bool $useRavenJs = false;
 
 	/**
 	 * Raven-JS configuration options.
-	 * @var array
+	 * @var mixed[]
 	 * @see https://raven-js.readthedocs.org/en/latest/config/index.html#optional-settings
 	 */
-	public $ravenJsOptions = array();
+	public array $ravenJsOptions = [];
 
 	/**
 	 * Raven-JS plugins.
-	 * @var array
+	 * @var mixed[]
 	 * @see https://raven-js.readthedocs.org/en/latest/plugins/index.html
 	 */
-	public $ravenJsPlugins = array();
+	public array $ravenJsPlugins = [];
 
 	/**
 	 * Initialize Raven_ErrorHandler.
-	 * @var bool
 	 */
-	public $useRavenErrorHandler = false;
+	public bool $useRavenErrorHandler = false;
 
 	/**
-	 * @var ClientInterface instance.
+	 * @var ClientInterface|null instance.
 	 */
-	protected $raven;
+	protected ?ClientInterface $raven = null;
 
 	/**
 	 * @inheritdoc
 	 */
-	public function init()
+	public function init(): void
 	{
 		parent::init();
 		if ($this->useRavenJs) {
@@ -78,39 +76,38 @@ public function init()
 
 	/**
 	 * Get Raven_Client instance.
-	 * @return ClientInterface
 	 */
-	public function getRaven()
+	public function getRaven(): ClientInterface
 	{
 		if (!isset($this->raven)) {
 			$this->registerRaven();
 		}
 
+        /** @var ClientInterface */
 		return $this->raven;
 	}
 
 	/**
 	 * Register and configure Raven js.
-	 * @param array|null $options If null, then will be used $this->ravenJsOptions.
-	 * @param array|null $plugins If null, then will be used $this->ravenJsPlugins.
-	 * @param array|null $context If null, then will be used $this->getUserContext().
-	 * @return bool
+	 * @param mixed[]|null $options If null, then will be used $this->ravenJsOptions.
+	 * @param mixed[]|null $plugins If null, then will be used $this->ravenJsPlugins.
+	 * @param mixed[]|null $context If null, then will be used $this->getUserContext().
 	 * @throws CException
 	 */
-	public function registerRavenJs(array $options = null, array $plugins = null, array $context = null)
+	public function registerRavenJs(?array $options = null, ?array $plugins = null, ?array $context = null): bool
 	{
-		/** @var CAssetManager $assetManager */
+		/** @var CAssetManager|null $assetManager */
 		$assetManager = $this->getComponent('assetManager');
-		/** @var CClientScript $clientScript */
+		/** @var CClientScript|null $clientScript */
 		$clientScript = $this->getComponent('clientScript');
 
 		if (!$assetManager || !$clientScript) {
 			return false;
 		}
 
-		$jsOptions = $options !== null ? $options : $this->ravenJsOptions;
-		$jsPlugins = $plugins !== null ? $plugins : $this->ravenJsPlugins;
-		$jsContext = $context !== null ? $context : $this->getUserContext();
+		$jsOptions = $options ?? $this->ravenJsOptions;
+		$jsPlugins = $plugins ?? $this->ravenJsPlugins;
+		$jsContext = $context ?? $this->getUserContext();
 
 		$assetUrl = $assetManager->publish(__DIR__ . '/assets');
 		$clientScript
@@ -132,42 +129,43 @@ public function registerRavenJs(array $options = null, array $plugins = null, ar
 		foreach ($jsPlugins as $plugin) {
 			$clientScript->registerScriptFile($assetUrl . '/plugins/' . $plugin . '.js', CClientScript::POS_HEAD);
 		}
+
+		return true;
 	}
 
 	/**
 	 * Initialize raven client.
 	 */
-	protected function registerRaven()
+	protected function registerRaven(): void
 	{
 		$this->raven = ClientBuilder::create($this->options)->getClient();
 		SentrySdk::getCurrentHub()->bindClient($this->raven);
 
 		$userContext = $this->getUserContext();
 		SentrySdk::getCurrentHub()->configureScope(function (Scope $scope) use ($userContext) {
 			if ($userContext) {
-				$scope->setUser($userContext, true);
+				$scope->setUser($userContext);
 			}
 		});
 	}
 
 	/**
 	 * Return Dsn without security token.
-	 * @return string
 	 */
-	protected function getJsDsn()
+	protected function getJsDsn(): string
 	{
-		return preg_replace('#:\w+@#', '@', $this->dsn);
+		return (string) preg_replace('#:\w+@#', '@', $this->dsn);
 	}
 
 	/**
 	 * Get get context (id, name).
-	 * @return array|null
+	 * @return array{id: mixed, name: string}|null
 	 */
-	protected function getUserContext()
+	protected function getUserContext(): ?array
 	{
-		/** @var CWebUser $user */
+		/** @var CWebUser|null $user */
 		$user = $this->getComponent('user');
-		if ($user && !$user->isGuest) {
+		if ($user && (!property_exists($user, 'isGuest') || !$user->isGuest)) {
 			return array(
 				'id' => $user->getId(),
 				'name' => strtoupper($user->getName()),
@@ -178,16 +176,19 @@ protected function getUserContext()
 
 	/**
 	 * Get Yii component if exists and available.
-	 * @param string $component
-	 * @return IApplicationComponent|null
 	 */
-	protected function getComponent($component)
+	protected function getComponent(string $component): ?IApplicationComponent
 	{
-		if (!Yii::app() instanceof CWebApplication) {
+		$app = Yii::app();
+
+		if (!$app instanceof CWebApplication) {
 			return null;
 		}
 
-		if ($instance = Yii::app()->getComponent($component)) {
+		/** @var IApplicationComponent|null $instance */
+		$instance = $app->getComponent($component);
+
+		if ($instance !== null) {
 			return $instance;
 		}
 
@@ -196,19 +197,17 @@ protected function getComponent($component)
 
 	/**
 	 * Register Raven Error Handlers for exceptions and errors.
-	 * @return bool
 	 */
-	protected function registerRavenErrorHandler()
+	protected function registerRavenErrorHandler(): bool
 	{
-		$raven = $this->getRaven();
-		if ($raven) {
-			ErrorHandler::registerOnceExceptionHandler();
-			ErrorHandler::registerOnceErrorHandler();
-			ErrorHandler::registerOnceFatalErrorHandler();
-
-			return true;
+		if (!isset($this->raven)) {
+			$this->registerRaven();
 		}
 
-		return false;
+		ErrorHandler::registerOnceExceptionHandler();
+		ErrorHandler::registerOnceErrorHandler();
+		ErrorHandler::registerOnceFatalErrorHandler();
+
+		return true;
 	}
 }

SentryLogRoute.php

@@ -14,19 +14,17 @@ class SentryLogRoute extends CLogRoute
 	/**
 	 * @var string Component ID of the sentry client that should be used to send the logs
 	 */
-	public $sentryComponent = 'sentry';
+	public string $sentryComponent = 'sentry';
 
 	/**
 	 * @see self::getStackTrace().
-	 * @var string
 	 */
-	public $tracePattern = '/#(?<number>\d+) (?<file>[^(]+)\((?<line>\d+)\): (?<cls>[^-]+)(->|::)(?<func>[^\(]+)/m';
+	public string $tracePattern = '/#(?<number>\d+) (?<file>[^(]+)\((?<line>\d+)\): (?<cls>[^-]+)(->|::)(?<func>[^\(]+)/m';
 
 	/**
 	 * Raven_Client instance from SentryComponent->getRaven();
-	 * @var ClientInterface
 	 */
-	protected $raven;
+	protected ?ClientInterface $raven = null;
 
 	public static function getSeverityFromLogLevel(string $level): Severity
 	{
@@ -50,26 +48,32 @@ public static function getSeverityFromLogLevel(string $level): Severity
 	}
 
 	/**
+	 * @param array{string, string, string, float} $logs
+	 *
 	 * @inheritdoc
 	 */
-	protected function processLogs($logs)
+	protected function processLogs($logs): void
 	{
+		/** @phpstan-ignore-next-line */
 		if (count($logs) == 0) {
 			return;
 		}
 
-		if (!$raven = $this->getRaven()) {
+        $raven = $this->getRaven();
+
+		if ($raven === null) {
 			return;
 		}
 
 		SentrySdk::getCurrentHub()->withScope(function (Scope $scope) use ($raven, $logs) {
 			foreach ($logs as $log) {
+				/** @phpstan-ignore-next-line */
 				[$message, $level, $category, $timestamp] = $log;
 
-				$title = preg_replace('#Stack trace:.+#s', '', $message); // remove stack trace from title
+				$title = (string) preg_replace('#Stack trace:.+#s', '', $message); // remove stack trace from title
 				// ensure %'s in messages aren't interpreted as replacement
 				// characters by the vsprintf inside raven
-				$title = str_replace('%', '%%', $title);
+				$title = (string) str_replace('%', '%%', $title);
 
 				$scope->setExtras([
 					'category'  => $category,
@@ -85,15 +89,13 @@ protected function processLogs($logs)
 	 *
 	 * Example log string:
 	 * #22 /var/www/example.is74.ru/vendor/yiisoft/yii/framework/web/CWebApplication.php(282): CController->run('index')
-	 * @param string $log
-	 * @return array|string
+	 * @return array<array{file: string, line: string|int, function: string, class: string}>
 	 */
-	protected function getStackTrace($log)
+	protected function getStackTrace(string $log): array
 	{
 		$stack = array();
 		if (strpos($log, 'Stack trace:') !== false) {
 			if (preg_match_all($this->tracePattern, $log, $m, PREG_SET_ORDER)) {
-				$stack = array();
 				foreach ($m as $row) {
 					$stack[] = array(
 						'file' => $row['file'],
@@ -110,18 +112,18 @@ protected function getStackTrace($log)
 	}
 
 	/**
-	 * Return Raven_Client instance or false if error.
+	 * Return Raven_Client instance or null if error.
 	 *
-	 * @return ClientInterface|bool
+	 * @return ClientInterface|null
 	 */
-	protected function getRaven()
+	protected function getRaven(): ?ClientInterface
 	{
 		if (!isset($this->raven)) {
-			$this->raven = false;
+			$this->raven = null;
 			if (!Yii::app()->hasComponent($this->sentryComponent)) {
 				Yii::log("'$this->sentryComponent' does not exist", CLogger::LEVEL_TRACE, __CLASS__);
 			} else {
-				/** @var SentryComponent $sentry */
+				/** @var SentryComponent|null $sentry */
 				$sentry = Yii::app()->{$this->sentryComponent};
 				if (!$sentry || !$sentry->getIsInitialized()) {
 					Yii::log("'$this->sentryComponent' not initialised", CLogger::LEVEL_TRACE, __CLASS__);