Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 5 additions & 6 deletions .github/workflows/CI.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -63,12 +63,11 @@ jobs:
steps:
- name: "Git: checkout"
uses: actions/checkout@v4
- name: "PHP: setup ${{ matrix.php-version }}"
- name: "PHP: setup 8.3"
uses: shivammathur/setup-php@v2
with:
php-version: '8.3'
coverage: none
tools: phpstan
- name: "Composer: cache config"
id: composer-cache
run: echo "dir=$(composer config cache-files-dir)" >> $GITHUB_OUTPUT
Expand All @@ -80,12 +79,12 @@ jobs:
restore-keys: ${{ runner.os }}-composer-
- name: "Composer: validate"
run: composer validate --strict
- name: "Composer: install"
run: composer install --prefer-dist --no-progress --no-suggest
- name: "Composer: update"
run: composer update --prefer-dist --no-progress
- name: "PHPStan: version"
run: phpstan --version
run: vendor/bin/phpstan --version
- name: "PHPStan: analyse"
run: phpstan analyse src/
run: vendor/bin/phpstan analyse

tests:
name: "Tests (PHP ${{ matrix.php-version }}, ${{ matrix.dependency-versions }} deps)"
Expand Down
4 changes: 3 additions & 1 deletion composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,9 @@
},
"require-dev": {
"friendsofphp/php-cs-fixer": "^3.56",
"phpunit/phpunit": "^11.2"
"phpunit/phpunit": "^11.2",
"phpstan/phpstan": "^2.1",
"phpstan/phpstan-webmozart-assert": "^2.0"
},
"minimum-stability": "dev",
"prefer-stable": true,
Expand Down
5 changes: 4 additions & 1 deletion phpstan.dist.neon
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
includes:
- vendor/phpstan/phpstan-webmozart-assert/extension.neon

parameters:
level: 9
level: max
paths:
- src/
- tests/
4 changes: 3 additions & 1 deletion src/Analysis.php
Original file line number Diff line number Diff line change
Expand Up @@ -40,13 +40,15 @@ public static function create(array $values): self
$values['loadingExperience'] ??= null;
if (is_array($values['loadingExperience'])) {
if (array_key_exists('id', $values['loadingExperience'])) {
Assert::isMap($values['loadingExperience']);
$loadingExperience = LoadingExperience::create($values['loadingExperience']);
}
}

$values['originLoadingExperience'] ??= null;
if (is_array($values['originLoadingExperience'])) {
if (array_key_exists('id', $values['originLoadingExperience'])) {
Assert::isMap($values['originLoadingExperience']);
$originLoadingExperience = LoadingExperience::create($values['originLoadingExperience']);
}
}
Expand All @@ -55,7 +57,7 @@ public static function create(array $values): self
Assert::string($values['analysisUTCTimestamp']);

Assert::keyExists($values, 'lighthouseResult');
Assert::isArray($values['lighthouseResult']);
Assert::isMap($values['lighthouseResult']);

return new self(
$values['id'],
Expand Down
4 changes: 2 additions & 2 deletions src/Analysis/Audit.php
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@
final readonly class Audit
{
/**
* @param ?array<string, mixed> $details
* @param ?array<string, mixed> $warnings
* @param ?array<array-key, mixed> $details
* @param ?array<array-key, mixed> $warnings
*/
public function __construct(
public string $id,
Expand Down
1 change: 1 addition & 0 deletions src/Analysis/AuditRef.php
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ public static function create(array $values): self
$relevantAudits = $values['relevantAudits'];
if (is_array($relevantAudits)) {
$relevantAudits = array_values($relevantAudits);
Assert::allString($relevantAudits);
}

return new self(
Expand Down
1 change: 0 additions & 1 deletion src/Analysis/CategoryGroup.php
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,6 @@ public static function create(array $values): self
Assert::string($values['title']);

$values['description'] ??= null;
Assert::keyExists($values, 'description');
Assert::nullOrString($values['description']);

return new self(
Expand Down
2 changes: 1 addition & 1 deletion src/Analysis/CategoryResult.php
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ public static function create(array $values): self

Assert::keyExists($values, 'auditRefs');
Assert::isArray($values['auditRefs']);
Assert::allIsArray($values['auditRefs']);
Assert::allIsMap($values['auditRefs']);

$values['description'] ??= null;
Assert::nullOrString($values['description']);
Expand Down
14 changes: 8 additions & 6 deletions src/Analysis/LighthouseResult.php
Original file line number Diff line number Diff line change
Expand Up @@ -49,23 +49,25 @@ public static function create(array $values): self
Assert::string($values['lighthouseVersion']);

Assert::keyExists($values, 'categoryGroups');
Assert::isArray($values['categoryGroups']);
Assert::isMap($values['categoryGroups']);

Assert::keyExists($values, 'categories');
Assert::isArray($values['categories']);
Assert::isMap($values['categories']);
Assert::allIsMap($values['categories']);

Assert::keyExists($values, 'audits');
Assert::isArray($values['audits']);
Assert::isMap($values['audits']);
Assert::allIsMap($values['audits']);

Assert::keyExists($values, 'environment');
Assert::isArray($values['environment']);
Assert::isMap($values['environment']);

Assert::keyExists($values, 'configSettings');
Assert::isArray($values['configSettings']);
Assert::isMap($values['configSettings']);

$categoryGroups = [];
foreach ($values['categoryGroups'] as $id => $group) {
Assert::isArray($group);
Assert::isMap($group);
$categoryGroups[$id] = ['id' => $id, ...$group];
}

Expand Down
5 changes: 2 additions & 3 deletions src/Analysis/LoadingExperience.php
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ public static function create(array $values): self
Assert::string($values['id']);

Assert::keyExists($values, 'metrics');
Assert::isArray($values['metrics']);
Assert::isMap($values['metrics']);

Assert::keyExists($values, 'overall_category');
Assert::string($values['overall_category']);
Expand All @@ -47,12 +47,11 @@ public static function create(array $values): self
Assert::string($values['initial_url']);

$values['origin_fallback'] ??= null;
Assert::keyExists($values, 'origin_fallback');
Assert::nullOrBoolean($values['origin_fallback']);

$metrics = [];
foreach ($values['metrics'] as $id => $metric) {
Assert::isArray($metric);
Assert::isMap($metric);
$metrics[$id] = ['id' => $id, ...$metric];
}

Expand Down
2 changes: 1 addition & 1 deletion src/Analysis/Metric.php
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
final readonly class Metric
{
/**
* @param array<string, mixed> $distributions
* @param array<array-key, mixed> $distributions
*/
public function __construct(
public string $id,
Expand Down
6 changes: 5 additions & 1 deletion src/PageSpeedApi.php
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
use SensitiveParameter;
use Symfony\Component\HttpClient\HttpClient;
use Symfony\Contracts\HttpClient\HttpClientInterface;
use Webmozart\Assert\Assert;

final readonly class PageSpeedApi implements PageSpeedApiInterface
{
Expand Down Expand Up @@ -104,6 +105,9 @@ private function get(string $uri, array $parameters = []): array
throw new \RuntimeException(sprintf('Unexpected response code "%s" returned by PageSpeed Api.', $response->getStatusCode()));
}

return $response->toArray();
$data = $response->toArray();
Assert::isMap($data);

return $data;
}
}
1 change: 0 additions & 1 deletion tests/Analysis/CategoryTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@ class CategoryTest extends TestCase
public function testValues(): void
{
$values = Category::values();
self::assertIsArray($values);
self::assertContains('accessibility', $values);
self::assertContains('best-practices', $values);
self::assertContains('performance', $values);
Expand Down
1 change: 0 additions & 1 deletion tests/Analysis/StrategyTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@ class StrategyTest extends TestCase
public function testValues(): void
{
$values = Strategy::values();
self::assertIsArray($values);
self::assertContains('desktop', $values);
self::assertContains('mobile', $values);
}
Expand Down
7 changes: 6 additions & 1 deletion tests/Fixtures/Factory/AnalysisFactory.php
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@

namespace PageSpeed\Api\Tests\Fixtures\Factory;

use Webmozart\Assert\Assert;

class AnalysisFactory
{
/**
Expand All @@ -29,6 +31,9 @@ public static function createData(array $parameters): array
'lighthouseResult' => LighthouseResultFactory::createData([]),
];

return array_replace_recursive($data, $parameters);
$data = array_replace_recursive($data, $parameters);
Assert::isMap($data);

return $data;
}
}
7 changes: 6 additions & 1 deletion tests/Fixtures/Factory/ConfigSettingsFactory.php
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@

namespace PageSpeed\Api\Tests\Fixtures\Factory;

use Webmozart\Assert\Assert;

class ConfigSettingsFactory
{
/**
Expand All @@ -31,6 +33,9 @@ public static function createData(array $parameters): array
'channel' => 'foo',
];

return array_replace_recursive($data, $parameters);
$data = array_replace_recursive($data, $parameters);
Assert::isMap($data);

return $data;
}
}
7 changes: 6 additions & 1 deletion tests/Fixtures/Factory/EnvironmentFactory.php
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@

namespace PageSpeed\Api\Tests\Fixtures\Factory;

use Webmozart\Assert\Assert;

class EnvironmentFactory
{
/**
Expand All @@ -27,6 +29,9 @@ public static function createData(array $parameters): array
'benchmarkIndex' => 42,
];

return array_replace_recursive($data, $parameters);
$data = array_replace_recursive($data, $parameters);
Assert::isMap($data);

return $data;
}
}
7 changes: 6 additions & 1 deletion tests/Fixtures/Factory/LighthouseCategoryResultFactory.php
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@

namespace PageSpeed\Api\Tests\Fixtures\Factory;

use Webmozart\Assert\Assert;

class LighthouseCategoryResultFactory
{
/**
Expand Down Expand Up @@ -61,6 +63,9 @@ public static function createData(array $parameters): array
'score' => 0.9,
];

return array_replace_recursive($data, $parameters);
$data = array_replace_recursive($data, $parameters);
Assert::isMap($data);

return $data;
}
}
7 changes: 6 additions & 1 deletion tests/Fixtures/Factory/LighthouseResultFactory.php
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@

namespace PageSpeed\Api\Tests\Fixtures\Factory;

use Webmozart\Assert\Assert;

class LighthouseResultFactory
{
/**
Expand Down Expand Up @@ -40,6 +42,9 @@ public static function createData(array $parameters): array
'configSettings' => ConfigSettingsFactory::createData([]),
];

return array_replace_recursive($data, $parameters);
$data = array_replace_recursive($data, $parameters);
Assert::isMap($data);

return $data;
}
}
7 changes: 6 additions & 1 deletion tests/Fixtures/Factory/LoadingExperienceFactory.php
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@

namespace PageSpeed\Api\Tests\Fixtures\Factory;

use Webmozart\Assert\Assert;

class LoadingExperienceFactory
{
/**
Expand Down Expand Up @@ -54,6 +56,9 @@ public static function createData(array $parameters): array
'origin_fallback' => true,
];

return array_replace_recursive($data, $parameters);
$data = array_replace_recursive($data, $parameters);
Assert::isMap($data);

return $data;
}
}
7 changes: 6 additions & 1 deletion tests/Fixtures/Factory/MetricFactory.php
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@

namespace PageSpeed\Api\Tests\Fixtures\Factory;

use Webmozart\Assert\Assert;

class MetricFactory
{
/**
Expand All @@ -28,6 +30,9 @@ public static function createData(array $parameters): array
'category' => 'good',
];

return array_replace_recursive($data, $parameters);
$data = array_replace_recursive($data, $parameters);
Assert::isMap($data);

return $data;
}
}
1 change: 0 additions & 1 deletion tests/PageSpeedApiTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,6 @@ public function testAnalyseFailsWithInvalidCategory(): void
self::expectException(\InvalidArgumentException::class);
self::expectExceptionMessage('Invalid category "invalid" provided.');

/** @phpstan-ignore-next-line */
$api->analyse('https://example.com', Strategy::Desktop, 'en_US', ['invalid']);
}

Expand Down
Loading