パースせよ、検証するな – あなたが望まない言語で
Parse, Don't Validate – In a Language That Doesn't Want You To (cekrem.github.io)
要約
この記事では、TypeScriptのような言語において「パースせよ、検証するな」という原則をどのように適用するかについて考察しています。通常のバリデーションでは型情報が失われるのに対し、パーシングではより厳密な型を導入することで、プログラム全体での安全性を高めることができます。TypeScriptの構造的型付けの特性を克服するために、ブランド型を使った具体的な実装例が示されています。
全文翻訳
Parse, Don't Validate — TypeScriptがそれを望まない言語で
更新: この投稿が気に入ったら、続編である Effect Without Effect-TS: Algebraic Thinking in Plain TypeScript をご覧ください。これは、ここで中断したところから始まり、アイデアをさらに発展させています。
Alexis King の Parse, don’t validate について、再び考えています。実際、これはかなり定期的に行っています。通常、TypeScriptのコードベースを眺めていて、静かに if (user.email) のチェックがフジツボのように蓄積されているのを見た後です。この投稿は2019年のもので、そのアドバイス(あるいは原則)はそれよりもはるかに古いものです。それにもかかわらず、私が読むほとんどのTypeScript — 恥ずかしながら、私が書いたものもたくさん含まれます — は、パースするのではなく、依然として検証しています。
もし読んでいないなら(読むべきです):バリデーターは「このものは大丈夫です、続けてください」と言います。パーサーは「私にブロブをください、そうすればより正確な型を返すか、なぜそれができないのかを教えてくれます」と言います。この違いは学術的に聞こえるかもしれませんが、そうではありません。バリデーターは実行が完了した瞬間に学習したことを捨て去りますが、パーサーはそれを型にエンコードすることによって保持します。一度文字列を EmailAddress にパースしたら、プログラムの残りの部分は二度と疑問に思う必要はありません。心の平穏と、楽しいことのためのより多くの精神的容量が得られます。
HaskellやElm、F#では、コードはこうやって書くものです。言語があなたをそれに引き寄せます。TypeScriptでは…そうはなりません。TypeScriptは正しいことをするのを喜んで許容しますが、それを強制せず、優しく促すことさえしません。むしろ、構造的型付けがゲーム全体を積極的に損ないます。
どういう意味か示しましょう。
私たちが皆書いたバリデーター
これは、私が絶えず見かける(そして書く)コードの種類です:
interface User {
id: number;
email: string;
age: number;
}
// 実際のバリデーションは素朴で単純ですが、要点は伝わるはずです:
function isValidUser(user: User): boolean {
if (!user.email.includes("@")) return false;
if (user.age < 0 || user.age > 150) return false;
return true;
}
function sendWelcome(user: User) {
if (!isValidUser(user)) {
throw new Error("invalid user");
}
// ...後で、コールスタックのさらに奥深くで:
emailService.send(user.email, `Welcome, age ${user.age}`);
}
嘘を見抜けますか? User.email は単なる string です。User.age は単なる number です。バリデーションは行われました — おめでとうございます — しかし、isValidUser が返された瞬間に型システムはそれを忘れてしまいました。3つの関数呼び出しの後、誰かが user.email に触れたとき、それを実際のメールを期待する関数に渡すことを止める何もありません。TypeScriptにとっては、それは単なる文字列だからです。"" と同じ、"hello" と同じ、"definitely not an email" と同じです。
では、どうすればよいでしょうか?どこかで再度検証し、別の if を追加し、単体テストを書き、最善を願います。(King は元の投稿でこれを「ショットガン・パーシング」と呼んでいます — 至る所に散らばったバリデーションで、どれも記憶されていません。)
私たちが本当に欲しいもの
私たちはこれを望んでいます:
function sendWelcome(user: ValidUser) {
emailService.send(user.email, `Welcome, age ${user.age}`);
}
そして、パーサーを通過していないものと sendWelcome を呼び出すことが不可能であることを望んでいます。再チェックや「防御的プログラミング」は不要です。ValidUser はただ一つの場所からしか来られず、コンパイラはそれを知っています。
Elm なら、不透明な型とスマートコンストラクタを使えば、約4行で完了できます。TypeScriptでは、まあ、少なくとも可能です。ただ、あまり快適ではありません。
ブランド型、または:意図的に構造的型システムに嘘をつく
TypeScriptは構造的に型付けされているため、同じ形状を持つ2つの型は同じ型です。string は string であり string です。newtype はありません。Haskellのように、真に異なる型を生成する type EmailAddress = String のようなものはありません。
コミュニティが落ち着いた回避策はブランディングです — タグ付けとも呼ばれ、交差による名目型付けとも呼ばれます。簡単なバージョンは文字列リテラルのファントム({ readonly __brand: "Email" })で、どこにでも見られます。少し高価なバージョンは、モジュールからエクスポートしない unique symbol を使用するため、外部の誰もブランド名をスペルすることさえできず、偽造できません:
declare const EmailBrand: unique symbol;
declare const AgeBrand: unique symbol;
type Email = string & { readonly [EmailBrand]: true };
type Age = number & { readonly [AgeBrand]: true };
実行時にはブランドフィールドはありません。それは「ファントム」 — コンパイル時に Email と string を互換性のないものにする型レベルのマーカーです。Email を取得する唯一の方法は、それを知っている関数を経由することです。なぜなら、このモジュールの外部からは、偽造するためにシンボルを名前付けすることさえできないからです。(TS5では、テンプレートリテラル型 — type Email = `${string}@${string}` — を使用して、デモには楽しいですが、それだけでは十分ではありません。)これが、言語を離れることなく不正な状態を表現不可能にする方法です。
ちなみに、ブランドは一方向です:Email は依然として string に代入可能なので、ドメインへの入り口では名目上のチェックが得られ、出口では通常の構造的な動作が得られます。これは、あなたが望むものとほぼ同じです。
その関数があなたのパーサーです:
type ParseError = { kind: "ParseError"; message: string };
type Parsed<T> = { kind: "ok"; value: T } | { kind: "err"; error: ParseError };
function parseEmail(raw: string): Parsed<Email> {
if (!raw.includes("@")) {
return { kind: "err", error: { kind: "ParseError", message: "missing @" } };
}
// チェックしました、これで意図的に型システムに嘘をつきます
return { kind: "ok", value: raw as Email };
}
function parseAge(raw: unknown): Parsed<Age> {
if (
typeof raw !== "number" ||
!Number.isInteger(raw) ||
raw < 0 ||
raw > 150
) {
return { kind: "err", error: { kind: "ParseError", message: "bad age" } };
}
return { kind: "ok", value: raw as Age };
}
(parseEmail の述語は非常に薄っぺらいです — 実際のものはトリムし、小文字にし、少なくともドメイン部分を検証するように見せかけるでしょう。しかし、ブログ投稿でメールパーサーを書いているわけではありません(!))。as Email は少し痛みます、そしてそうあるべきです。これは、ルールを破ることが許される唯一の場所です — パーサーは信頼された境界です。コードベースの他のどこでも、string から Email を作り出すことはできません。parseEmail を呼び出し、両方のブランチを処理する必要があります。(私は意図的に success: boolean の判別子ではなく kind: "ok" | "err" を使用しています。ブーリアンは常に2つのケースしか保持できないため、3番目のケース — 例えば `