PII(Personally Identifiable Information)は、氏名やメールアドレスのように、個人を識別できる情報です。Sensitive は、連絡先の値を包み、ログと JSON では [REDACTED] に置き換える(マスクする)型です。マスクは、値を別の文字列に置き換えて隠すことです。連絡先の schema は、.transform(検査を通った値を別の値に変換する Zod のメソッド)で Sensitive.of を呼んで包みます。
入力と出力の両方に境界があります。次の図の帯は出力側で、内側の値がログなどの外側へ出る順に並べています。
ownerEmail: "owner@example.com" Sensitive // 中に owner@example.com を持つ [REDACTED] {"ownerName":"[REDACTED]","ownerEmail":"[REDACTED]","ownerPhone":"[REDACTED]"} owner@example.com src/adaptor/primary/web/ownerContact.tsimport { z } from "zod";
import { schemaResult } from "../../../domain/shared/schemaResult.js";
import { Sensitive } from "../../../domain/shared/sensitive.js";
const OwnerContactSchema = z
.object({
ownerName: z.string().min(1).brand<"OwnerName">().transform(Sensitive.of),
ownerEmail: z.string().email().brand<"OwnerEmail">().transform(Sensitive.of),
ownerPhone: z.string().min(1).brand<"OwnerPhone">().transform(Sensitive.of),
})
.readonly();
export type OwnerContact = z.infer<typeof OwnerContactSchema>;
export const OwnerContact = {
schema: OwnerContactSchema,
parse: schemaResult(OwnerContactSchema),
} as const; src/domain/shared/sensitive.tsimport { inspect } from "node:util";
export type Sensitive<T> = Readonly<{
unwrap: () => T;
toJSON: () => string;
toString: () => string;
[inspect.custom]: () => string;
}>;
export const Sensitive = {
of: <T>(value: T): Sensitive<T> => ({
unwrap: () => value,
toJSON: () => "[REDACTED]",
toString: () => "[REDACTED]",
[inspect.custom]: () => "[REDACTED]",
}),
} as const; メールアドレスをログに出力する(console.log(contact.ownerEmail))
-
境界: 境界で形を検査したあと、transformでSensitive.ofに包みます。ブランドは他の値との取り違えを防ぐためのもので、ログには影響しません。
src/adaptor/primary/web/ownerContact.ts(parse に渡すメールアドレス(説明用の値))ownerEmail: "owner@example.com" -
内側: 内側の値は平文のstringではなくなります。平文を取り出す方法はunwrapだけです。
src/domain/shared/sensitive.ts(contact.ownerEmail)Sensitive // 中に owner@example.com を持つ -
外側(ログなど): inspect.customは、Node.jsがconsole.logで値を文字にするときに呼ぶ関数を指定する名前です。console.logはその結果を出力するので、ログには[REDACTED]が出力されます。
src/domain/shared/sensitive.ts(console.log(contact.ownerEmail))[REDACTED]
連絡先全体を JSON にして出力する(JSON.stringify(contact))
-
境界: 境界で形を検査したあと、transformでSensitive.ofに包みます。ブランドは他の値との取り違えを防ぐためのもので、ログには影響しません。
src/adaptor/primary/web/ownerContact.ts(parse に渡すメールアドレス(説明用の値))ownerEmail: "owner@example.com" -
内側: 内側の値は平文のstringではなくなります。平文を取り出す方法はunwrapだけです。
src/domain/shared/sensitive.ts(contact.ownerEmail)Sensitive // 中に owner@example.com を持つ -
外側(ログなど): toJSONは、JSON.stringifyが値を文字列にするときに呼ぶメソッドの名前です。JSON.stringifyはその結果を使うので、3項目とも[REDACTED]になります。
src/domain/shared/sensitive.ts(JSON.stringify(contact)){"ownerName":"[REDACTED]","ownerEmail":"[REDACTED]","ownerPhone":"[REDACTED]"}
中身が必要な処理で平文を取り出す(contact.ownerEmail.unwrap())
-
境界: 境界で形を検査したあと、transformでSensitive.ofに包みます。ブランドは他の値との取り違えを防ぐためのもので、ログには影響しません。
src/adaptor/primary/web/ownerContact.ts(parse に渡すメールアドレス(説明用の値))ownerEmail: "owner@example.com" -
内側: 内側の値は平文のstringではなくなります。平文を取り出す方法はunwrapだけです。
src/domain/shared/sensitive.ts(contact.ownerEmail)Sensitive // 中に owner@example.com を持つ -
外側(ログなど): unwrapと明示した箇所だけ平文が出力されます。unwrapで検索すれば、平文を取り出している箇所を調査できます。
src/domain/shared/sensitive.ts(contact.ownerEmail.unwrap())owner@example.com
マスクを守るテストは、あとで読むページ「Sensitive の値の性質のテスト」にあります。