Spracovanie chýb

Chyby vyhadzujú RoundlyConsulting\GooglePlaces\Exceptions\PlacesException s typovanými metódami, podľa ktorých rozlíšite, čo zlyhalo:

use RoundlyConsulting\GooglePlaces\Exceptions\PlacesException;
use RoundlyConsulting\GooglePlaces\Facades\GooglePlaces;

try {
    $predictions = GooglePlaces::autocomplete('Coffee');
} catch (PlacesException $e) {
    if ($e->isRateLimited())      { /* back off */ }
    elseif ($e->isDenied())       { /* check key / billing / enabled APIs */ }
    elseif ($e->isInvalidRequest()) { /* fix the request */ }
    elseif ($e->isUnreachable())  { /* timeout, DNS failure, refused connection */ }

    report($e); // $e->googleStatus(), $e->googleReason(), $e->googleErrorMessage()
}

Kľúč sa do správ nedostane

API kľúč sa nikdy neobjaví v správe výnimky, v udalosti ani v kľúči cache. Každá správa sa začierni — chybový text od Google aj správa o zlyhaní prenosu, ktorá končí URL požiadavky, kde Geocoding API nesie svoj key=. Nastavený kľúč sa všade, kde sa objaví, skryje okrem posledných štyroch znakov a rovnako aj hodnota každého parametra key=, token= či signature= v URL; hodnota s ôsmimi a menej znakmi sa skryje celá. $e->response je surová HTTP odpoveď vrátane URL požiadavky — neserializujte ju do reportov.

Kontroly stavu

Kontroly zjednocujú tvary chýb všetkých troch Google API a isUnreachable() odlíši zlyhanie siete od odpovede:

Detail chyby

catch (PlacesException $e) {
    $e->getCode();              // HTTP status of the failed response (0 for local errors)
    $e->googleStatus();         // e.g. "PERMISSION_DENIED", "OVER_QUERY_LIMIT"
    $e->googleReason();         // e.g. "API_KEY_INVALID" — null for the Geocoding API
    $e->googleErrorMessage();   // Google's own error message, if any
    $e->isUnreachable();        // true for a timeout, DNS failure or refused connection
    $e->response;               // ?Illuminate\Http\Client\Response — raw, request URL included
}

Kedy sa vyhadzuje

Timeouty a opakovania

Každé volanie je ohraničené hodnotami http.timeout a http.connect_timeout. Zlyhania spojenia (timeout, DNS) sa opakujú http.retries-krát s pauzou http.retry_delay; chyby vrátené od Google sa nikdy neopakujú — okamžite sa prejavia ako PlacesException. Oba timeouty sú celé sekundy, aspoň 1: 0 (bez timeoutu) alebo nezmysel ako five vyhodí InvalidConfigurationException, namiesto toho, aby požiadavka zostala neohraničená.