haylan
9c028aaf5e
Add professional PHPDoc (summary + @param/@return) to the remaining public methods that had none or only partial coverage: GraphController's actions, ContributionStore's accessors, SvgRenderer's render() and private helpers (with concrete array-shape annotations), ProbeTrait, ProviderHealthChecker, ProviderStatus, and the Contribution entity. Also adds the matching @return shapes on SvgRendererTest's data providers.
68 lines
2.5 KiB
PHP
68 lines
2.5 KiB
PHP
<?php
|
|
|
|
declare(strict_types=1);
|
|
|
|
namespace GitContributionGraph\Service\Provider;
|
|
|
|
use Symfony\Contracts\HttpClient\Exception\HttpExceptionInterface;
|
|
use Symfony\Contracts\HttpClient\Exception\TransportExceptionInterface;
|
|
|
|
trait ProbeTrait
|
|
{
|
|
/**
|
|
* Reports NotConfigured if credentials are missing, otherwise pings the provider
|
|
* and reports Ok or Error (with a classified error code and message).
|
|
*/
|
|
public function probe(): ProviderStatus
|
|
{
|
|
if (!$this->isConfigured()) {
|
|
return new ProviderStatus($this->getName(), ProviderStatusType::NotConfigured);
|
|
}
|
|
|
|
try {
|
|
$this->ping();
|
|
|
|
return new ProviderStatus($this->getName(), ProviderStatusType::Ok);
|
|
} catch (\Throwable $e) {
|
|
return $this->statusFromException($e);
|
|
}
|
|
}
|
|
|
|
private function statusFromException(\Throwable $e): ProviderStatus
|
|
{
|
|
[$error, $message] = $this->classifyException($e);
|
|
|
|
return new ProviderStatus($this->getName(), ProviderStatusType::Error, $error, $message);
|
|
}
|
|
|
|
/** @return array{ProviderErrorCode, string} */
|
|
private function classifyException(\Throwable $e): array
|
|
{
|
|
if ($e instanceof TransportExceptionInterface) {
|
|
return [ProviderErrorCode::UrlUnreachable, 'Could not reach the server: ' . $e->getMessage()];
|
|
}
|
|
|
|
if ($e instanceof HttpExceptionInterface) {
|
|
$code = $e->getResponse()->getStatusCode();
|
|
|
|
return match (true) {
|
|
$code === 401 => [ProviderErrorCode::AuthFailed, 'Invalid or expired token — verify your credentials'],
|
|
$code === 403 => [ProviderErrorCode::AuthFailed, 'Access denied — token lacks the required scopes'],
|
|
$code === 404 => [ProviderErrorCode::UrlUnreachable, 'Endpoint not found — check the configured URL'],
|
|
default => [ProviderErrorCode::Unknown, "HTTP {$code}: " . $e->getMessage()],
|
|
};
|
|
}
|
|
|
|
$msg = $e->getMessage();
|
|
$lower = strtolower($msg);
|
|
$error = match (true) {
|
|
str_contains($msg, 'not found') || str_contains($msg, 'Could not resolve') => ProviderErrorCode::UserNotFound,
|
|
str_contains($msg, 'GraphQL error')
|
|
&& (str_contains($lower, 'unauthorized') || str_contains($lower, 'bad credentials')) => ProviderErrorCode::AuthFailed,
|
|
default => ProviderErrorCode::Unknown,
|
|
};
|
|
|
|
return [$error, $msg];
|
|
}
|
|
}
|