Přejít k obsahu

Úložiště cookies

Zobrazit jako Markdown Upravit na GitHub Dokumentace na 5b53f69

Ve výchozím nastavení Phasis a jeho fetch() ignoruje Set-Cookie z odpovědí a v požadavcích neposílá hlavičku Cookie. Pro vkládání na straně serveru je to správné výchozí nastavení — obvykle nechcete, aby odpověď jednoho uživatele ovlivnila požadavek jiného.

Pokud cookies potřebujete — třeba pro práci s tokem závislým na stavu relace, procházení stránek za přihlášením nebo napodobení chování prohlížeče v testech — připojte úložiště pomocí $engine->setCookieJar($jar).

Rozhraní

Úložiště může být jakýkoli objekt se dvěma metodami:

Kód
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

Fungují objekty PHP i objekty JsObject na straně JS se stejnými členy. Předáním null úložiště vymažete.

Phasis volá get(url) při každém kroku požadavku (přesměrování na jiný server tak získá aktuální cookies) a set(url, line) pro každou hlavičku Set-Cookie v odpovědi. Za zásady práce s cookies — shodu domén, omezení cestou, dobu platnosti, SameSite a Secure — odpovídá úložiště, nikoli Phasis.

Úložiště v paměti (testy)

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 stačí pro jednoduchý test, ale neřeší Domain=, Path=, Expires= ani atributy Secure/HttpOnly/SameSite. Nepoužívejte ho v situacích, které překračují hranici důvěry.

Symfony BrowserKit

Pokud už máte nainstalované knihovny HTTP pro Symfony, BrowserKit\CookieJar se o zásady postará správně.

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

Jar na straně JS

Pokud je vaše úložiště na straně JS — například protože ho chcete zkontrolovat nebo naplnit z JavaScript — zpřístupněte ho přes objekt 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'));

Volají se stejné metody get/set bez ohledu na to, zda je příjemcem objekt PHP, nebo JsObject.

Rozsah jednoho požadavku

Úložiště patří k realm a přetrvává napříč všemi požadavky fetch(), dokud ho nevymažete pomocí setCookieJar(null). Chcete-li ho omezit na jeden tok požadavků, udělejte to výslovně:

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

Kontrola z PHP

$engine->getCookieJar() vrací předanou hodnotu — užitečné pro ověřování v testech.

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/'));

Viz také

  • Fetch transport — úložiště cookies funguje uvnitř přesměrovací smyčky Phasis a používá transport, který jste nainstalovali.
  • Webová API (WPT) — testy Fetch Pack ověřující práci s cookies.