Siirry sisältöön

Fetch-siirtotapa

Näytä Markdown-muodossa Muokkaa palvelussa GitHub Dokumentaatio: 5b53f69

Kohteen Phasis oletusarvoinen fetch() toimii kohteen PHP ext-curl-toiminnon kautta: CURLOPT_FOLLOWLOCATION=false (määrittelyn mukainen uudelleenohjaussilmukka toimii kohteen Phasis puolella), ja CURLOPT_PROGRESSFUNCTION tarkistaa kohteen AbortSignal. Tämä riittää useimpiin upotuksiin.

Kaikissa muissa tapauksissa — välityspalvelimet, mukautettu DNS, isäntäsovelluksen nykyinen HTTP-asiakas, verkkoympäristön eristys ja testien valeversiot — siirtotapa on vaihdettavissa.

Rajapinta

PHP
public function setFetchTransport(callable $transport): void

Kutsuttava funktio saa seuraavat:

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

$request on assosiatiivinen taulukko:

Avain Tyyppi Huomautukset
method string Muunnettu jo isoiksi kirjaimiksi (GET, POST, …)
url string Selvitetty absoluuttinen URL URL-jäsentimen ja uudelleenohjausketjun jälkeen
headers list<list<string>> [name, value]-parit; kirjainkoko normalisoidaan määrityksen mukaan; moniarvoiset merkinnät ovat erillisiä pareja (Set-Cookie jne.)
body string Raakatavuja. Tyhjä merkkijono rungottomille metodeille.
redirect string "follow" / "error" / "manual" (kuljetuksen EI pidä seurata niitä — uudelleenohjaussilmukka suoritetaan kohteessa Phasis)
timeout int Seinäaikabudjetti millisekunteina. 0 = ei aikarajaa.
credentials string "omit" / "same-origin" / "include" — vain tiedoksi; evästeet kytketään erikseen setCookieJar()-määrityksellä.

$signal on null, jos pyynnölle ei annettu signaalia; muussa tapauksessa se on JsObject, joka tarjoaa aborted ja reason. Kysele sen tilaa pitkien siirtojen aikana.

Palautteen muoto:

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

Jos kuljetus heittää poikkeuksen, Phasis sieppaa sen ja muuntaa sen:

  • Phasis\BuiltIn\Fetch\TransportException, jolla on $e->kind === "aborted" → fetch hylätään virheellä AbortError DOMException.
  • kind === "timeout" → TypeError, joka sisältää viestin.
  • kind === "network-error" (oletus) → TypeError.
  • Kaikki muut → TypeError poikkeuksen viestillä.

Käytännön esimerkkejä

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),
    ];
});

Estä kaikki

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

Tämä saa kaikki fetch()-kutsut hylkäämään TypeError-virheellä. Hyödyllinen käyttäjän antaman JS-sisällön eristämiseen.

Testimock

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'],
    ];
});

Käytäntökoukku

Kuljetus suorittaa pyynnön; käytäntökoukku päättää, suoritetaanko se ylipäätään. Käytä tätä vain HTTPS-valvontaan, otsakkeiden lisäykseen, URL-osoitteiden uudelleenkirjoitukseen, sallittujen listauksiin tai vuokralaisten tunnistetietojen sidontaan.

PHP
public function setFetchPolicy(callable $hook): void

Koukun allekirjoitus: function (JsObject $request): ?JsObject. Palautus null sallii pyynnön sellaisenaan. Requestin palautus kirjoittaa pyynnön uudelleen. Heittäminen hylkää haun heitetyllä virheellä.

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;
});

Käytäntökoukku suoritetaan ennen kuljetusta, joten edes viallinen tai epäluotettava kuljetus ei voi ohittaa sitä.

Oletustoiminnan yhteenveto

Huomio Oletus
Kuljetus CurlTransport (PHP ext-curl)
Uudelleenohjaukset Seurataan määrityksen mukaan enintään 20 uudelleenohjausta. redirect: "manual" palauttaa uudelleenohjauksen Response-olion, jolla on type: "opaqueredirect".
Aikaraja 30 s seinäkelloaikaa, 10 s yhteyden muodostamiseen
TLS-varmennus CURLOPT_SSL_VERIFYPEER = true (ei poistettavissa käytöstä — ohita vaihtamalla kuljetus)
User-Agent Phasis/0.1 lisätään vain, jos sitä ei ole asetettu
Evästeet Ei tallenneta. Ota ne käyttöön setCookieJar()-määrityksellä.
Käytäntökoukku Ei ole. Kaikki pyynnöt sallitaan, ellei niitä erikseen estetä.
AbortSignal Huomioidaan siirron aikana curlin edistymisen takaisinkutsun kyselyllä.

Katso myös