check that fetched JSON is array with certain required fields

Author: mtmail

phpstan.neon

@@ -1,5 +1,5 @@
 parameters:
-    level: 8
+    level: 10
     paths:
         - src
         - tests

src/Geocoder.php

@@ -67,9 +67,9 @@ public function setHost(string $host): void
 
     /**
      * @param array<string, string> $optParams
-     * @return ?array<string, mixed>
+     * @return array{status: array{code: int, message: string}, results: list<mixed>, total_results: int, ...}
      */
-    public function geocode(string $query, array $optParams = []): ?array
+    public function geocode(string $query, array $optParams = []): array
     {
         $url = $this->url . 'q=' . urlencode($query);
 
@@ -85,6 +85,10 @@ public function geocode(string $query, array $optParams = []): ?array
         $url .= '&key=' . urlencode($this->key);
 
         $ret = json_decode($this->getJSON($url), true);
+        if (!is_array($ret)) {
+            throw new \Exception('Failed to decode API response');
+        }
+        /** @var array{status: array{code: int, message: string}, results: list<mixed>, total_results: int, ...} */
         return $ret;
     }
 

tests/GeocoderTest.php

@@ -23,7 +23,6 @@ public function testInvalidKey(): void
         $geocoder = new Geocoder('invalid-APIKEY');
         $result = $geocoder->geocode('Johannesburg');
         // print_r($result);
-        $this->assertNotNull($result);
         $this->assertEquals(401, $result['status']['code']);
         $this->assertEquals('invalid API key', $result['status']['message']);
     }
@@ -49,7 +48,6 @@ public function testNetworkRequestError(): void
         $result = $geocoder->geocode('London');
         // print_r($result);
 
-        $this->assertNotNull($result);
         $this->assertEquals(498, $result['status']['code']);
         $this->assertStringContainsString('network issue', $result['status']['message']);
         $this->assertStringContainsString('doesnotexist.opencagedata.com', $result['status']['message']);
@@ -60,7 +58,6 @@ public function testOverQuota(): void
         // https://opencagedata.com/api#testingkeys
         $geocoder = new Geocoder('4372eff77b8343cebfc843eb4da4ddc4');
         $result = $geocoder->geocode('Johannesburg');
-        $this->assertNotNull($result);
         $this->assertEquals(402, $result['status']['code']);
         $this->assertEquals('quota exceeded', $result['status']['message']);
     }
@@ -74,7 +71,6 @@ public function testLondon(): void
 
         // print_r($result);
 
-        $this->assertNotNull($result);
         $this->assertEquals(200, $result['status']['code']);
         $this->assertEquals('OK', $result['status']['message']);
     }
@@ -94,7 +90,6 @@ public function testProxy(): void
         }
 
         $result = $geocoder->geocode("82 Clerkenwell Road, London");
-        $this->assertNotNull($result);
         $this->assertEquals(200, $result['status']['code']);
         $this->assertEquals('OK', $result['status']['message']);
     }