Liigu sisu juurde

Päringutransport

Vaata Markdownina Muuda teenuses GitHub Dokumentatsioon: 5b53f69

Vaikimisi kasutab fetch() Phasis-s PHP ext-curl-it — CURLOPT_FOLLOWLOCATION=false-i (spetsifikatsioonikohane ümbersuunamistsükkel töötab Phasis keskkonnas) ning CURLOPT_PROGRESSFUNCTION kontrollib AbortSignal. Enamiku manustamisjuhtude jaoks sobib see hästi.

Kõige muu jaoks — puhverserverid, kohandatud DNS, hostrakenduse olemasolev HTTP klient, võrgukeskkonna piiramine ja testides matkimine — on transport vahetatav.

Liides

PHP
public function setFetchTransport(callable $transport): void

Teie väljakutsutav funktsioon saab järgmise:

PHP
function (array $request, ?\Phasis\Value\JsObject $signal): array

$request on assotsiatiivne massiiv:

Võti Tüüp Märkused
method string Juba suurtähtedeks teisendatud (GET, POST, …)
url string Lahendatud absoluutne URL pärast URL parserit ja ümbersuunamisahelat
headers list<list<string>> [name, value] paarid; spetsifikatsiooni normaliseeritud kuju; mitme väärtusega kirjed on eraldi paarid (nt Set-Cookie)
body string Toorbaidid. Keha puuduvate meetodite korral tühi string.
redirect string "follow" / "error" / "manual" (teie transport EI TOHI neid järgida — ümbersuunamistsükkel töötab Phasis-s)
timeout int Seinakella järgi mõõdetud ajapiirang millisekundites. 0 = piirang puudub.
credentials string "omit" / "same-origin" / "include" — ainult teavitav; küpsised seadistatakse eraldi setCookieJar() kaudu.

$signal on null, kui päringule signaali ei antud; muidu on see JsObject, millel on aborted ja reason. Kontrollige seda pikkade edastuste ajal perioodiliselt.

Tagastatav struktuur:

PHP
return [
    'status'     => 200,                          // int
    'statusText' => 'OK',                         // string
    'headers'    => [['content-type', 'text/plain'], ['x-custom', '1']],
    'body'       => '...response bytes...',       // string
];

Kui transport vea viskab, püüab Phasis selle kinni ja teisendab:

  • $e->kind === "aborted"-iga Phasis\BuiltIn\Fetch\TransportException → fetch lükatakse tagasi veaga AbortError DOMException.
  • kind === "timeout" → TypeError, mis sisaldab veateadet.
  • kind === "network-error" (vaikimisi) → TypeError.
  • Kõik muu → TypeError koos erandi veateatega.

Läbitöötatud näited

Guzzle

PHP
use GuzzleHttp\Client;
use GuzzleHttp\Exception\GuzzleException;

$client = new Client(['allow_redirects' => false]);

$engine->setFetchTransport(function (array $req, $signal) use ($client) {
    try {
        $r = $client->request($req['method'], $req['url'], [
            'headers'     => collect($req['headers'])->groupBy(0)->map->pluck(1)->all(),
            'body'        => $req['body'],
            'timeout'     => max(1, $req['timeout'] / 1000.0),
            'http_errors' => false,
        ]);
    } catch (GuzzleException $e) {
        throw new \Phasis\BuiltIn\Fetch\TransportException($e->getMessage(), 'network-error');
    }
    $headers = [];
    foreach ($r->getHeaders() as $name => $values) {
        foreach ($values as $v) {
            $headers[] = [$name, $v];
        }
    }
    return [
        'status'     => $r->getStatusCode(),
        'statusText' => $r->getReasonPhrase(),
        'headers'    => $headers,
        'body'       => (string) $r->getBody(),
    ];
});

Symfony HttpClient

PHP
use Symfony\Component\HttpClient\HttpClient;

$client = HttpClient::create(['max_redirects' => 0]);

$engine->setFetchTransport(function (array $req, $signal) use ($client) {
    $headers = [];
    foreach ($req['headers'] as [$name, $value]) {
        $headers[$name][] = $value;
    }
    $r = $client->request($req['method'], $req['url'], [
        'headers'      => $headers,
        'body'         => $req['body'],
        'timeout'      => $req['timeout'] / 1000.0,
        'max_redirects'=> 0,
    ]);
    return [
        'status'     => $r->getStatusCode(),
        'statusText' => '',
        'headers'    => collect($r->getHeaders(false))
            ->flatMap(fn ($values, $name) => array_map(fn ($v) => [$name, $v], $values))
            ->values()->all(),
        'body'       => $r->getContent(false),
    ];
});

Keela kõik

PHP
$engine->setFetchTransport(function () {
    throw new \Phasis\BuiltIn\Fetch\TransportException(
        'network access disabled in this sandbox',
        'network-error',
    );
});

See paneb iga fetch() kutse TypeErroriga tagasi lükkama. Kasulik kasutaja antud JS eraldamiseks.

Proovitransport testide jaoks

PHP
$canned = [
    'https://api.example.com/users' => ['status' => 200, 'body' => '{"users":[]}'],
    'https://api.example.com/404'   => ['status' => 404, 'body' => 'not found'],
];

$engine->setFetchTransport(function (array $req) use ($canned) {
    $r = $canned[$req['url']] ?? ['status' => 500, 'body' => 'no mock'];
    return [
        'status'     => $r['status'],
        'statusText' => $r['status'] === 200 ? 'OK' : 'ERR',
        'headers'    => [['content-type', 'application/json']],
        'body'       => $r['body'],
    ];
});

Poliitikakonks

Transport täidab päringu; poliitikakonks otsustab, kas seda üldse teha. Kasutage seda ainult HTTPS-i jõustamiseks, päise lisamiseks, URL ümberkirjutamiseks, lubatud loendite haldamiseks või rentnikupõhiste mandaatide sidumiseks.

PHP
public function setFetchPolicy(callable $hook): void

Konksu signatuur: function (JsObject $request): ?JsObject. null tagastamisel lubatakse päring muutmata kujul. Requesti tagastamisel kirjutatakse päring ümber. Vea viskamisel lükatakse fetch visatud veaga tagasi.

PHP
$allowedHosts = ['api.example.com', 'cdn.example.com'];

$engine->setFetchPolicy(function ($req) use ($allowedHosts) {
    $url = parse_url($req->get('url')->value);
    if (!in_array($url['host'] ?? '', $allowedHosts, true)) {
        throw new \RuntimeException("host not allowed: " . ($url['host'] ?? ''));
    }
    // Inject internal-only auth header
    $req->get('headers')->call('set', 'X-Internal-Token', $secret);
    return null;
});

Poliitikakonks käivitatakse enne transporti — seega ei saa isegi vigane või ebausaldusväärne transport sellest mööda minna.

Vaikekäitumise kokkuvõte

Valdkond Vaikeseade
Transport CurlTransport (PHP ext-curl)
Ümbersuunamised Järgitakse spetsifikatsiooni järgi kuni 20 korda. redirect: "manual" tagastab ümbersuunamise Response'i koos type: "opaqueredirect"-ga.
Ajalõpp 30 s seinakella järgi, ühenduse loomisel 10 s
TLS kontroll CURLOPT_SSL_VERIFYPEER = true (väljalülitamise võimalus puudub — muutke transpordi asendamise kaudu)
Kasutajaagent Phasis/0.1 lisatakse ainult siis, kui see pole määratud
Küpsised Ei salvestata. Lubamiseks kasutage setCookieJar().
Poliitikakonks Puudub. Kõik päringud lubatakse, kui neid selgesõnaliselt ei keelata.
AbortSignal Katkestatakse keset päringut curl-i edenemise tagasihelistuse kontrolli kaudu.

Vt ka