Improve static analysis

norkunas · Sep 1, 2024 · 1f6db11 · 1f6db11
1 parent 17f3756
commit 1f6db11
Show file tree

Hide file tree

Showing 36 changed files with 410 additions and 50 deletions.
diff --git a/.php-cs-fixer.dist.php b/.php-cs-fixer.dist.php
@@ -7,6 +7,7 @@
     ]);
 
 return (new PhpCsFixer\Config())
+    ->setParallelConfig(PhpCsFixer\Runner\Parallel\ParallelConfigFactory::detect())
     ->setRiskyAllowed(true)
     ->setRules([
         '@Symfony' => true,

diff --git a/phpstan-baseline.php b/phpstan-baseline.php
@@ -0,0 +1,113 @@
+<?php declare(strict_types = 1);
+
+$ignoreErrors = [];
+$ignoreErrors[] = [
+	// identifier: missingType.iterableValue
+	'message' => '#^Method OneSignal\\\\Resolver\\\\NotificationResolver\\:\\:filterAndroidBackgroundLayout\\(\\) has parameter \\$layouts with no value type specified in iterable type array\\.$#',
+	'count' => 1,
+	'path' => __DIR__ . '/src/Resolver/NotificationResolver.php',
+];
+$ignoreErrors[] = [
+	// identifier: missingType.iterableValue
+	'message' => '#^Method OneSignal\\\\Resolver\\\\NotificationResolver\\:\\:filterIosAttachments\\(\\) has parameter \\$attachments with no value type specified in iterable type array\\.$#',
+	'count' => 1,
+	'path' => __DIR__ . '/src/Resolver/NotificationResolver.php',
+];
+$ignoreErrors[] = [
+	// identifier: missingType.iterableValue
+	'message' => '#^Method OneSignal\\\\Resolver\\\\NotificationResolver\\:\\:filterWebButtons\\(\\) has parameter \\$buttons with no value type specified in iterable type array\\.$#',
+	'count' => 1,
+	'path' => __DIR__ . '/src/Resolver/NotificationResolver.php',
+];
+$ignoreErrors[] = [
+	// identifier: missingType.iterableValue
+	'message' => '#^Method OneSignal\\\\Resolver\\\\NotificationResolver\\:\\:normalizeButtons\\(\\) has parameter \\$values with no value type specified in iterable type array\\.$#',
+	'count' => 1,
+	'path' => __DIR__ . '/src/Resolver/NotificationResolver.php',
+];
+$ignoreErrors[] = [
+	// identifier: missingType.iterableValue
+	'message' => '#^Method OneSignal\\\\Resolver\\\\NotificationResolver\\:\\:normalizeButtons\\(\\) return type has no value type specified in iterable type array\\.$#',
+	'count' => 1,
+	'path' => __DIR__ . '/src/Resolver/NotificationResolver.php',
+];
+$ignoreErrors[] = [
+	// identifier: missingType.iterableValue
+	'message' => '#^Method OneSignal\\\\Resolver\\\\NotificationResolver\\:\\:normalizeFilters\\(\\) has parameter \\$values with no value type specified in iterable type array\\.$#',
+	'count' => 1,
+	'path' => __DIR__ . '/src/Resolver/NotificationResolver.php',
+];
+$ignoreErrors[] = [
+	// identifier: missingType.iterableValue
+	'message' => '#^Method OneSignal\\\\Resolver\\\\NotificationResolver\\:\\:normalizeFilters\\(\\) return type has no value type specified in iterable type array\\.$#',
+	'count' => 1,
+	'path' => __DIR__ . '/src/Resolver/NotificationResolver.php',
+];
+$ignoreErrors[] = [
+	// identifier: missingType.iterableValue
+	'message' => '#^Method OneSignal\\\\Resolver\\\\SegmentResolver\\:\\:normalizeFilters\\(\\) has parameter \\$values with no value type specified in iterable type array\\.$#',
+	'count' => 1,
+	'path' => __DIR__ . '/src/Resolver/SegmentResolver.php',
+];
+$ignoreErrors[] = [
+	// identifier: missingType.iterableValue
+	'message' => '#^Method OneSignal\\\\Resolver\\\\SegmentResolver\\:\\:normalizeFilters\\(\\) return type has no value type specified in iterable type array\\.$#',
+	'count' => 1,
+	'path' => __DIR__ . '/src/Resolver/SegmentResolver.php',
+];
+$ignoreErrors[] = [
+	// identifier: argument.type
+	'message' => '#^Parameter \\#1 \\$success of class OneSignal\\\\Response\\\\Segment\\\\CreateSegmentResponse constructor expects bool, mixed given\\.$#',
+	'count' => 1,
+	'path' => __DIR__ . '/src/Response/Segment/CreateSegmentResponse.php',
+];
+$ignoreErrors[] = [
+	// identifier: argument.type
+	'message' => '#^Parameter \\#2 \\$id of class OneSignal\\\\Response\\\\Segment\\\\CreateSegmentResponse constructor expects non\\-empty\\-string, mixed given\\.$#',
+	'count' => 1,
+	'path' => __DIR__ . '/src/Response/Segment/CreateSegmentResponse.php',
+];
+$ignoreErrors[] = [
+	// identifier: argument.type
+	'message' => '#^Parameter \\#1 \\$success of class OneSignal\\\\Response\\\\Segment\\\\DeleteSegmentResponse constructor expects bool, mixed given\\.$#',
+	'count' => 1,
+	'path' => __DIR__ . '/src/Response/Segment/DeleteSegmentResponse.php',
+];
+$ignoreErrors[] = [
+	// identifier: argument.type
+	'message' => '#^Parameter \\#1 \\$callback of function array_map expects \\(callable\\(mixed\\)\\: mixed\\)\\|null, Closure\\(array\\)\\: OneSignal\\\\Response\\\\Segment\\\\Segment given\\.$#',
+	'count' => 1,
+	'path' => __DIR__ . '/src/Response/Segment/ListSegmentsResponse.php',
+];
+$ignoreErrors[] = [
+	// identifier: argument.type
+	'message' => '#^Parameter \\#1 \\$totalCount of class OneSignal\\\\Response\\\\Segment\\\\ListSegmentsResponse constructor expects int\\<0, max\\>, mixed given\\.$#',
+	'count' => 1,
+	'path' => __DIR__ . '/src/Response/Segment/ListSegmentsResponse.php',
+];
+$ignoreErrors[] = [
+	// identifier: argument.type
+	'message' => '#^Parameter \\#2 \\$array of function array_map expects array, mixed given\\.$#',
+	'count' => 1,
+	'path' => __DIR__ . '/src/Response/Segment/ListSegmentsResponse.php',
+];
+$ignoreErrors[] = [
+	// identifier: argument.type
+	'message' => '#^Parameter \\#2 \\$offset of class OneSignal\\\\Response\\\\Segment\\\\ListSegmentsResponse constructor expects int\\<0, 2147483648\\>, mixed given\\.$#',
+	'count' => 1,
+	'path' => __DIR__ . '/src/Response/Segment/ListSegmentsResponse.php',
+];
+$ignoreErrors[] = [
+	// identifier: argument.type
+	'message' => '#^Parameter \\#3 \\$limit of class OneSignal\\\\Response\\\\Segment\\\\ListSegmentsResponse constructor expects int\\<0, 2147483648\\>, mixed given\\.$#',
+	'count' => 1,
+	'path' => __DIR__ . '/src/Response/Segment/ListSegmentsResponse.php',
+];
+$ignoreErrors[] = [
+	// identifier: argument.type
+	'message' => '#^Parameter \\#4 \\$segments of class OneSignal\\\\Response\\\\Segment\\\\ListSegmentsResponse constructor expects list\\<OneSignal\\\\Response\\\\Segment\\\\Segment\\>, array\\<OneSignal\\\\Response\\\\Segment\\\\Segment\\> given\\.$#',
+	'count' => 1,
+	'path' => __DIR__ . '/src/Response/Segment/ListSegmentsResponse.php',
+];
+
+return ['parameters' => ['ignoreErrors' => $ignoreErrors]];
diff --git a/phpstan.neon.dist b/phpstan.neon.dist
@@ -1,5 +1,7 @@
 includes:
 	- vendor/phpstan/phpstan-phpunit/extension.neon
+	- vendor/phpstan/phpstan/conf/bleedingEdge.neon
+	- phpstan-baseline.php
 
 parameters:
 	bootstrapFiles:
@@ -10,7 +12,6 @@ parameters:
 	tmpDir: %currentWorkingDirectory%/.phpstan
 	level: 9
 	inferPrivatePropertyTypeFromConstructor: true
-	checkMissingIterableValueType: false
 	checkGenericClassInNonGenericObjectType: true
 	checkUninitializedProperties: true
 	ignoreErrors:

diff --git a/src/Apps.php b/src/Apps.php
@@ -32,6 +32,8 @@ public function __construct(OneSignal $client, ResolverFactory $resolverFactory)
      * User authentication key must be set.
      *
      * @param string $id ID of your application
+     *
+     * @return array<mixed>
      */
     public function getOne(string $id): array
     {
@@ -45,6 +47,8 @@ public function getOne(string $id): array
      * Get information about all your created applications.
      *
      * User authentication key must be set.
+     *
+     * @return array<mixed>
      */
     public function getAll(): array
     {
@@ -59,7 +63,9 @@ public function getAll(): array
      *
      * User authentication key must be set.
      *
-     * @param array $data Application data
+     * @param array<mixed> $data Application data
+     *
+     * @return array<mixed>
      */
     public function add(array $data): array
     {
@@ -78,8 +84,10 @@ public function add(array $data): array
      *
      * User authentication key must be set.
      *
-     * @param string $id   ID of your application
-     * @param array  $data New application data
+     * @param string       $id   ID of your application
+     * @param array<mixed> $data New application data
+     *
+     * @return array<mixed>
      */
     public function update(string $id, array $data): array
     {
@@ -96,10 +104,12 @@ public function update(string $id, array $data): array
     /**
      * Create a new segment for application with provided data.
      *
-     * @param string $appId ID of your application
-     * @param array  $data  Segment Data
+     * @param string       $appId ID of your application
+     * @param array<mixed> $data  Segment Data
+     *
+     * @return array<mixed>
      */
-    public function createSegment($appId, array $data): array
+    public function createSegment(string $appId, array $data): array
     {
         $resolvedData = $this->resolverFactory->createSegmentResolver()->resolve($data);
 
@@ -118,6 +128,8 @@ public function createSegment($appId, array $data): array
      *
      * @param string $appId     Application ID
      * @param string $segmentId Segment ID
+     *
+     * @return array<mixed>
      */
     public function deleteSegment(string $appId, string $segmentId): array
     {
@@ -130,8 +142,10 @@ public function deleteSegment(string $appId, string $segmentId): array
     /**
      * View the details of all the outcomes associated with your app.
      *
-     * @param string $appId Application ID
-     * @param array  $data  Outcome data filters
+     * @param string       $appId Application ID
+     * @param array<mixed> $data  Outcome data filters
+     *
+     * @return array<mixed>
      */
     public function outcomes(string $appId, array $data): array
     {

diff --git a/src/Config.php b/src/Config.php
@@ -6,10 +6,26 @@
 
 final class Config
 {
-    private $applicationId;
-    private $applicationAuthKey;
-    private $userAuthKey;
+    /**
+     * @var non-empty-string
+     */
+    private string $applicationId;
+
+    /**
+     * @var non-empty-string
+     */
+    private string $applicationAuthKey;
 
+    /**
+     * @var non-empty-string|null
+     */
+    private ?string $userAuthKey;
+
+    /**
+     * @param non-empty-string      $applicationId
+     * @param non-empty-string      $applicationAuthKey
+     * @param non-empty-string|null $userAuthKey
+     */
     public function __construct(string $applicationId, string $applicationAuthKey, ?string $userAuthKey = null)
     {
         $this->applicationId = $applicationId;
@@ -19,6 +35,8 @@ public function __construct(string $applicationId, string $applicationAuthKey, ?
 
     /**
      * Get OneSignal application id.
+     *
+     * @return non-empty-string
      */
     public function getApplicationId(): string
     {
@@ -27,6 +45,8 @@ public function getApplicationId(): string
 
     /**
      * Get OneSignal application authentication key.
+     *
+     * @return non-empty-string
      */
     public function getApplicationAuthKey(): string
     {
@@ -35,6 +55,8 @@ public function getApplicationAuthKey(): string
 
     /**
      * Get user authentication key.
+     *
+     * @return non-empty-string|null
      */
     public function getUserAuthKey(): ?string
     {