Перейти к содержимому

Хранилище cookie

Просмотреть как Markdown Редактировать на GitHub Документация по 5b53f69

По умолчанию Phasis fetch() игнорирует Set-Cookie в ответах и не отправляет заголовок Cookie в запросах. Для серверного встраивания это разумный выбор: обычно не нужно, чтобы ответ одного пользователя влиял на запрос другого.

Если cookie нужны — например, для сценария с состоянием сессии, сбора данных за страницей входа или имитации поведения браузера в тестах, — подключите хранилище через $engine->setCookieJar($jar).

Интерфейс

Хранилищем может быть любой объект с двумя методами:

Код
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

Подойдут объекты PHP и методы JsObject на стороне JS с такими же членами. Передача null очищает хранилище.

Phasis вызывает get(url) при каждом переходе запроса (поэтому при перенаправлении на другой хост используются новые cookies), а set(url, line) — для каждого заголовка Set-Cookie в ответе. За политику cookies — сопоставление доменов, область действия пути, срок действия, SameSite и Secure — отвечает хранилище, а не Phasis.

Хранилище в памяти (тесты)

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

Этого достаточно для теста с успешным сценарием, но здесь игнорируются Domain=, Path=, Expires= и атрибуты Secure/HttpOnly/SameSite. Не используйте этот вариант при пересечении границы доверия.

Symfony BrowserKit

Если библиотеки HTTP от Symfony уже установлены, BrowserKit\CookieJar правильно обрабатывает политику.

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

Хранилище на стороне JS

Если хранилище находится на стороне JS — например, чтобы проверять его или заполнять из JavaScript, — привяжите его как объект 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'));

Независимо от того, является ли получатель объектом PHP или JsObject, вызываются те же методы get/set.

Область действия запроса

Хранилище привязано к среде выполнения: оно сохраняется для всех fetch(), пока его не очистят с помощью setCookieJar(null). Чтобы ограничить его одним потоком запросов, задайте это явно:

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

Проверка из PHP

$engine->getCookieJar() возвращает переданное ему значение — удобно для проверок в тестах.

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

См. также

  • Транспорт Fetch — хранилище cookie работает внутри цикла перенаправлений Phasis, поверх любого установленного транспорта.
  • Веб-API (WPT) — тесты Fetch Pack, проверяющие поведение cookie.