Przejdź do treści

Magazyn plików cookie

Wyświetl jako Markdown Edytuj w GitHub Dokumentacja: 5b53f69

Domyślnie Phasis's fetch() ignoruje Set-Cookie z odpowiedzi i nie wysyła nagłówka Cookie w żądaniach. To właściwe ustawienie dla osadzenia po stronie serwera — zwykle nie chcesz, by odpowiedź jednego użytkownika wpływała na żądanie innego.

Jeśli potrzebujesz plików cookie — do obsługi przepływu zależnego od stanu sesji, pobierania danych zza logowania lub odtwarzania zachowania przeglądarki w testach — podłącz magazyn za pomocą $engine->setCookieJar($jar).

Interfejs

Magazynem może być dowolny obiekt obsługujący dwie metody:

Kod
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

Działają zarówno obiekty PHP, jak i elementy JS-stronnego JsObject z pasującymi składowymi. Przekazanie null czyści magazyn.

Phasis wywołuje get(url) raz dla każdego przeskoku żądania (więc przekierowania na inny host otrzymują świeże pliki cookie), a set(url, line) raz dla każdego nagłówka Set-Cookie w odpowiedzi. Za politykę plików cookie — dopasowywanie domen, zakres ścieżek, wygasanie, SameSite, Secure — odpowiada magazyn, a nie Phasis.

Magazyn w pamięci (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 wystarczy jako konfiguracja testowa dla poprawnej ścieżki, ale pomija Domain=, Path=, Expires= oraz atrybuty Secure/HttpOnly/SameSite. Nie używaj tego rozwiązania przy przekraczaniu granicy zaufania.

Symfony BrowserKit

Jeśli masz już zainstalowane biblioteki HTTP od Symfony, BrowserKit\CookieJar prawidłowo obsługuje politykę.

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

Magazyn po stronie JS

Jeśli magazyn znajduje się po stronie JS — na przykład chcesz go sprawdzić lub wypełnić z poziomu JavaScript — powiąż go za pomocą obiektu 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'));

Te same metody get/set są wywoływane niezależnie od tego, czy odbiorcą jest obiekt PHP, czy JsObject.

Zakres pojedynczego żądania

Magazyn działa w obrębie realm — zachowuje dane we wszystkich fetch(), dopóki nie zostanie wyczyszczony przez setCookieJar(null). Aby ograniczyć go do jednego przepływu żądań, zrób to jawnie:

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

Sprawdzanie z poziomu PHP

$engine->getCookieJar() zwraca przekazany obiekt — przydatne w asercjach testowych.

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

Zobacz także

  • Transport fetch — magazyn plików cookie działa wewnątrz pętli przekierowań Phasis, jako warstwa nałożona na zainstalowany transport.
  • Interfejsy API sieci (WPT) — testy Fetch Pack obejmujące obsługę plików cookie.