Shramba piškotkov

Prikaži kot Markdown Uredi na GitHub Dokumentacija za 5b53f69

Privzeto Phasis fetch() prezre Set-Cookie iz odgovorov in v zahtevah ne pošilja glave Cookie. To je prava privzeta nastavitev za vdelavo na strežniški strani — običajno ne želite, da odgovor enega uporabnika vpliva na zahtevo drugega.

Če potrebujete piškotke — za potek, odvisen od stanja seje, brskanje po vsebini za prijavo ali posnemanje vedenja brskalnika v testih — dodajte shrambo z $engine->setCookieJar($jar).

Vmesnik

Shramba je lahko kateri koli objekt, ki podpira dve metodi:

Koda

get(url: string): string         // returns a "Cookie:" header value, e.g. "sid=abc; pref=dark"
set(url: string, header: string): void   // receives one Set-Cookie line

Delujejo tako objekti PHP kot tudi JS-stranski JsObject z ustreznimi člani. Če posredujete null, se shramba počisti.

Phasis pokliče get(url) ob vsakem koraku zahteve (zato preusmeritve na drug gostitelj prejmejo sveže piškotke), set(url, line) pa ob vsaki glavi Set-Cookie v odgovoru. Za pravilnike glede piškotkov — ujemanje domen, omejitve poti, potek veljavnosti, SameSite, Secure — je odgovorna shramba, ne Phasis.

Shramba v pomnilniku (testi)

PHP

final class MemoryJar
{
    /** @var array<string, array<string, string>> host → name → "name=value" */
    private array $store = [];

    public function get(string $url): string
    {
        $host = parse_url($url, PHP_URL_HOST) ?? '';
        return implode('; ', $this->store[$host] ?? []);
    }

    public function set(string $url, string $header): void
    {
        $host = parse_url($url, PHP_URL_HOST) ?? '';
        [$nv] = explode(';', $header, 2);
        [$name, $value] = explode('=', trim($nv), 2) + ['', ''];
        if ($name !== '') {
            $this->store[$host][$name] = "$name=$value";
        }
    }
}

$engine->setCookieJar(new MemoryJar());

To zadostuje za preizkus uspešne poti, vendar prezre Domain=, Path=, Expires= ter atribute Secure/HttpOnly/SameSite. Ne uporabljajte je za nič, kar prečka mejo zaupanja.

Symfony BrowserKit

Če imate že nameščene knjižnice Symfony HTTP, BrowserKit\CookieJar pravilno obravnava pravilnike.

PHP

use Symfony\Component\BrowserKit\CookieJar as BrowserCookieJar;
use Symfony\Component\BrowserKit\Cookie;

final class SymfonyJarAdapter
{
    public function __construct(private BrowserCookieJar $jar) {}

    public function get(string $url): string
    {
        $cookies = $this->jar->allValues($url);
        return implode('; ', array_map(
            fn ($n, $v) => "$n=$v",
            array_keys($cookies),
            array_values($cookies),
        ));
    }

    public function set(string $url, string $header): void
    {
        $cookie = Cookie::fromString($header, $url);
        $this->jar->set($cookie);
    }
}

$engine->setCookieJar(new SymfonyJarAdapter(new BrowserCookieJar()));

Shramba na strani JS

Če je vaša shramba na strani JS — denimo, ker jo želite pregledati ali napolniti iz JavaScript — jo povežite z objektom JS:

JavaScript

const jar = new Map();
$jar.get = (url) => Array.from(jar.entries()).map(([k, v]) => `${k}=${v}`).join('; ');
$jar.set = (url, header) => {
  const [nv] = header.split(';');
  const [name, value] = nv.split('=');
  jar.set(name.trim(), value.trim());
};

PHP

$engine->eval($script);
$engine->setCookieJar($engine->eval('$jar'));

Pokličeta se isti metodi get/set, ne glede na to, ali je prejemnik objekt PHP ali JsObject.

Obseg posamezne zahteve

Shramba je vezana na okolje — velja za vsak fetch(), dokler je ne počistite z setCookieJar(null). Če želite shrambo omejiti na en sam tok zahtev, to določite izrecno:

PHP

$engine->setCookieJar($jar);
$engine->eval('await runLoginFlow()');
$engine->setCookieJar(null);

Pregled iz PHP

$engine->getCookieJar() vrne posredovano vrednost — uporabno za preverjanja v testih.

PHP

$jar = new MemoryJar();
$engine->setCookieJar($jar);
$engine->eval('await fetch("https://api.example.com/login", { method: "POST" })');

assertNotEmpty($engine->getCookieJar()->get('https://api.example.com/'));

Glejte tudi

Prenos Fetch — shramba piškotkov deluje znotraj preusmeritvene zanke Phasis in je dodana izbranemu prenosu.
Spletni API-ji (WPT) — testi Fetch Pack, ki pokrivajo vedenje piškotkov.