Cookie
表示密度のような好みをCookieに置く定義と、ブラウザが書くCookieの属性がわかります。Cookieはリクエストのたびにサーバーへ送られます。
このページの内容
Cookieの状態の定義
src/state.tsimport { defineCookieState } from '@k8ordo/state';
import * as z from 'zod';
export const density = defineCookieState(
'density',
z.object({
density: z
.enum(['comfortable', 'compact'])
.default('comfortable'),
}),
);defineCookieStateにキーとスキーマを渡します。書き方はdefineLocalStateと同じで、スキーマの決まりはストレージとメモリのページにあります。
値はk8ordo-state.densityという1つのCookieに、スキーマに書いたフィールドのJSONとして保存されます。この名前は、定義のcookieNameで読めます。
Cookieの名前はHTTPのtokenなので、キーに使えるのは英数字と一部の記号だけです。空白や:、;を含むキーは、モジュールの読み込み時にcannot name a cookieを含むTypeErrorになります。
ブラウザの書き込み
update()は、Cookie Store APIでCookieを書きます。属性は次の4つで、書き込むたびに付け直します。
Path=/:サイトのどのパスへのリクエストにも付きます。SameSite=Lax:ほかのサイトのリンクから来た最初のリクエストにも付きます。APIの既定のStrictでは、そのリクエストでサーバーが既定値を描画します。Max-Age:400日です。ブラウザがCookieを保てる上限で、書くたびに延びます。Secure:APIが必ず付けるので、ページはHTTPSで配信します。ChromiumとFirefoxはhttp://localhostでも保存しますが、Safariは保存しません。Safariで確かめるなら、開発中もHTTPSで配信してください。
読み取りは、document.cookieから同期的に行います。描画の途中ではAPIのPromiseを待てないからです。ほかのタブの書き込みと、サーバーの応答が設定したCookieは、APIのchangeイベントで受け取ります。
Cookieはリクエストのたびに送られるので、小さく保ってください。名前と値を合わせて4KBを超えると、ブラウザが書き込みを拒みます。update()のハンドルはAPIのTypeErrorでrejectされ、描画した値はそのまま残ります。
秘密の扱い
ブラウザが書くCookieは、HttpOnlyにできません。ページ上のどのスクリプトもこのCookieを読み書きでき、訪問者もURLと同じように書き換えられます。
落とし穴
セッションやトークンのように、漏れたり偽造されたりすると困るものは置かないでください。そうしたCookieはサーバーがHttpOnlyで書きます。このパッケージはそのCookieを読みません。