ホーム 全セッション S01

遷移関数の引数で、受け取れる状態を限定する

6 / 10 目安 2分

ページ一覧

解決策: 遷移関数の引数の型を絞り、許可されていない呼び出しを型検査で検出します。

遷移関数の入力は遷移前の状態で、出力は遷移後の状態です。引数の型を、遷移前に許す状態だけにすると、許されない状態の予約を渡す呼び出しは、実行前の型検査で報告されます。

  1. 修正前: S01 の開始コード

    業務イベント 獣医師が「診察を開始する」を押す

    遷移前(入力)

    来院済みCheckedIn

    関数 startExamination examples/session-01/src/domain/appointment/transitions.ts
    export const startExamination = (
      appointment: Appointment,
      veterinarianId: string,
      examinationStartedAt: string,
    ): Appointment => {
      requireKind(appointment, ["CheckedIn"]);
      return ({ ...appointment, kind: "InExamination", veterinarianId, examinationStartedAt }) as Appointment;
    };

    遷移後(出力)

    診察中InExamination

    ✓ 許される遷移

    修正前のコードは、引数の型が Appointment、返す型が Appointment です。末尾の as Appointment は、値の中身を検証せずに型を伝える書き方(型アサーション)です。来院済みの予約を渡すと、診察中の予約が返ります。

  2. 修正前: S01 の開始コード

    コードの誤り 開発者が、会計済みの予約を startExamination へ渡すコードを書く

    遷移前(入力)

    会計済みPaid

    × 許されない入力

    関数 startExamination examples/session-01/src/domain/appointment/transitions.ts
    export const startExamination = (
      appointment: Appointment,
      veterinarianId: string,
      examinationStartedAt: string,
    ): Appointment => {
      requireKind(appointment, ["CheckedIn"]);
      return ({ ...appointment, kind: "InExamination", veterinarianId, examinationStartedAt }) as Appointment;
    };

    結果

    実行時の例外Cannot transition from Paid

    型検査は報告しない

    会計済みの予約を渡しても、型検査は報告しません。実行すると requireKind が例外を投げます。誤りを検出できるのは、この呼び出しを実行した時点だけです。

  3. 修正後: S01 の完成コード

    業務イベント 獣医師が「診察を開始する」を押す

    遷移前(入力)

    来院済みCheckedIn

    関数 startExamination examples/session-01-solution/src/domain/appointment/transitions.ts
    export const startExamination = (
      appointment: CheckedIn,
      veterinarianId: string,
      examinationStartedAt: string,
    ): InExamination =>
      ({
        ...appointment,
        kind: "InExamination",
        veterinarianId,
        examinationStartedAt,
      }) as const satisfies InExamination;

    遷移後(出力)

    診察中InExamination

    ✓ 許される遷移

    修正後のコードは、引数の型が CheckedIn、返す型が InExamination で、末尾が as const satisfies InExamination です。引数を CheckedIn に絞ったため、関数の中の requireKind は不要になりました。来院済みの予約を渡すと、診察中の予約が返ります。

    as const satisfies InExamination は、2 つの指定です。as const は、"InExamination" を string に広げません。satisfies InExamination は、戻す値がその型を満たすかを、値の定義の位置で検証します。型を上書きする as とは異なり、満たさなければ型検査が報告します。戻り値の型の指定だけでも同じ誤りは報告されます。この教材は、戻り値の型を書かない箇所でも値の定義の位置で検査できるように、状態を作る値に同じ書き方を使います。

  4. 修正後: S01 の完成コード

    コードの誤り 開発者が、会計済みの予約を startExamination へ渡すコードを書く

    遷移前(入力)

    会計済みPaid

    × 許されない入力

    関数 startExamination examples/session-01-solution/src/domain/appointment/transitions.ts
    export const startExamination = (
      appointment: CheckedIn,
      veterinarianId: string,
      examinationStartedAt: string,
    ): InExamination =>
      ({
        ...appointment,
        kind: "InExamination",
        veterinarianId,
        examinationStartedAt,
      }) as const satisfies InExamination;

    結果

    型検査の報告Argument of type 'Paid' is not assignable to parameter of type 'CheckedIn'.

    実行前の型検査が報告する

    会計済みの予約を渡すコードは、実行前の型検査が報告します。このコードの誤りは、型検査の時点で判明します。

  5. 呼び出し側: S01 の完成コード

    業務イベント サーバーが、会計済みの予約に対する診察開始の依頼を受け取る

    遷移前(入力)

    会計済みPaid

    × 許されない入力

    診察開始のルート examples/session-01-solution/src/adaptor/primary/web/routes.ts
    app.post("/appointments/:appointmentId/start-examination", (context) => {
      const current = appointmentOrThrow(repository, context.req.param("appointmentId"));
      if (current.kind !== "CheckedIn") throw new Error("Invalid appointment state");
      saveAndAppendAudit(
        repository,
        startExamination(
          current,
          // …

    結果

    実行時の例外Invalid appointment state

    依頼を拒否する

    データベースから取得する予約は、どの状態の値が返るかが、実行するまで分かりません。型は Appointment であるため、routes.ts(HTTP リクエストを受けるファイル)が kind を検証し、CheckedIn でなければ依頼を拒否します。この検証は修正前からあり、この Session の修正では変わりません。検証の後は current が CheckedIn に絞り込まれ、startExamination に渡せます。演習では、同じ検証を関数に切り出した startExaminationFor を扱います。定義は演習の手順で確認できます。