診察開始の識別子を型で区別する

コードを読み、失敗を再現する

最初に、AppointmentIdとVeterinarianIdを実際に逆の用途へ渡しているコードを読みます。そのうえで、2つの識別子にbrandがなく、予約状態とstartExaminationにもstringが残っていることを確認します。

編集する範囲は examples/session-03/src/domain、変更するファイル数は最大 5ファイル・約34行です。

1. 予約IDと担当獣医師IDを逆の用途へ渡している

   const appointmentId = AppointmentId.parse(clinicFixture.appointmentId);
   const veterinarianId = VeterinarianId.parse(clinicFixture.veterinarianId);
   const acceptAppointmentId = (_id: AppointmentId): void => undefined;
   const acceptVeterinarianId = (_id: VeterinarianId): void => undefined;
   
   acceptAppointmentId(veterinarianId);
   acceptVeterinarianId(appointmentId);

   AppointmentIdを必要とする関数へVeterinarianIdを、VeterinarianIdを必要とする関数へAppointmentIdを渡しています。 どちらの型も実体はstringなので、この2行があっても型検査は成功します。

2. UUIDを検査しても、型検査では予約IDと担当獣医師IDを区別できない

   const schema = z.string().uuid();
   
   export type AppointmentId = z.infer<typeof schema>;
   export const AppointmentId = { schema, parse: schema.parse } as const;

   AppointmentIdとVeterinarianIdはuuid検査だけで、用途を表すbrandがありません。PetId、OwnerId、ExamIdにはbrandがあります。 予約IDを担当獣医師IDの位置へ渡しても、どちらもstringなのでコンパイルは通ります。

3. 予約状態とstartExaminationがstringを受け取っている

     kind: "Scheduled";
     appointmentId: string;
     petId: PetId;
     ownerId: OwnerId;
     scheduledAt: string;
     reason: string;
   }>;

   予約のappointmentIdと、startExaminationのveterinarianIdがstringで宣言されています。 予約IDと担当獣医師IDを入れ替えても検出できません。

取り違えたまま型検査する

acceptAppointmentId と acceptVeterinarianId の呼び出しは、渡す値が逆です。この状態で型検査を実行します。

pnpm --filter @fp-with-ts/clinic-session-03 typecheck

型検査が成功したこと自体が失敗の再現です。現在の AppointmentId と VeterinarianId は、どちらもUUID検査済みの string なので、TypeScriptには用途の違いが見えません。

修正前の失敗を確認する

修正前は、次の3件に対応する演習テストが失敗します。

• 予約IDと担当獣医師IDを取り違えても、型検査が通る。
• 予約状態とstartExaminationが、用途を区別しないstringを受け取る。
• 取り違えた2行が、型エラーにならないままコンパイルされる。

pnpm exercise:03

ブラウザ内の変更はローカルへ反映されません。

exercises/semantic-identifiers.test.tsimport { describe, expect, expectTypeOf, it } from "vitest";import { startExamination } from "../src/domain/appointment/index.js";import { AppointmentId } from "../src/domain/appointment/index.js";import type { AppointmentId as AppointmentIdValue } from "../src/domain/appointment/index.js";import type { VeterinarianId } from "../src/domain/appointment/index.js";describe("Step 1", () => {  it("AppointmentId を VeterinarianId の用途へ渡せない", () => {    expectTypeOf<AppointmentIdValue>().not.toMatchTypeOf<VeterinarianId>(); // 要件: AppointmentId を VeterinarianId の用途へ渡せない型にしてください。  });});describe("Step 2", () => {  it("診察開始には VeterinarianId が必要", () => {    expectTypeOf<AppointmentIdValue>().not.toMatchTypeOf<Parameters<typeof startExamination>[1]>(); // 要件: 診察開始の担当獣医師に AppointmentId を渡せない型にしてください。  });});describe("Step 3", () => {  it("VeterinarianId を AppointmentId の用途へ渡せない", () => {    expectTypeOf<VeterinarianId>().not.toMatchTypeOf<AppointmentIdValue>(); // 要件: VeterinarianId を AppointmentId の用途へ渡せない型にしてください。  });});describe("回帰条件: 識別子は形式検査を通った値からしか作れない", () => {  it("UUIDでない文字列からAppointmentIdを作れない", () => {    expect(() => AppointmentId.parse("not-a-uuid")).toThrow();  });});