ホーム 全セッション S01

誤った変更を仕組みで検出する

7 / 10 目安 1分

ページ一覧

解決策: 直したコードも、次の変更で元に戻ることがあります。守る仕組みが必要です。

もう1つの課題があります。直したコードも、次の変更で元に戻ることがあります。この課題は、直した状態を維持することです。誤った変更を機械で見つけるツールを仕組みと呼びます。仕組みが誤った変更を見つけて報告することを検出、報告しないことを未検出と呼びます。

次の3件の誤った変更を選択すると、3つの仕組みの結果が表示されます。演習の表では、検出に使わない仕組みの列を「対象外」と表示し、合否に数えません。演習の必須の3件は、ここで見た変更とは別の変更です。ここで見た3件は、演習の任意の課題です。

変更を選ぶ

正しいコードからの変更(recordPaymentFor の部分) − 削除した行 + 追加した行

正しいコードからの変更(startExamination の部分) − 削除した行 + 追加した行

正しいコードからの変更(recordPayment の部分) − 削除した行 + 追加した行

// import に type AwaitingPayment を追加する
export const recordPaymentFor = (
  // 引数は同じ
): Paid => {
  if (current.kind !== "AwaitingPayment") throw new Error("Invalid appointment state");
  return recordPayment(current, input, paidAt);
};
): Paid => recordPayment(current as unknown as AwaitingPayment, input, paidAt);

recordPaymentFor は、routes.ts の会計の kind の検証を関数に切り出したものです。recordPayment の引数の型は変わらないため、型のテストは通ります。unknown を経由した as を、Linter のルールが検出します。テストが検出する理由は、kind の検証を削除したことであり、as を書いたことではありません。

export const startExamination = (
  // 引数と、examinationStartedAt 以外の項目は同じ
    veterinarianId,
    examinationStartedAt,
    examinationStartedAt: appointment.checkedInAt,
  }) as const satisfies InExamination;

examinationStartedAt と checkedInAt はどちらも文字列であるため、型検査と Linter のルールは通ります。診察開始の時刻が格納されたかどうかは、来院と診察開始に異なる時刻を渡すテストだけが検証します。

// import に Appointment を追加する
export const recordPayment = (
  appointment: AwaitingPayment,
  appointment: Appointment,
  // input と paidAt は同じ
): Paid =>
  ({ ...appointment, ...input, kind: "Paid", paidAt }) as const satisfies Paid;
): Paid => {
  if (appointment.kind !== "AwaitingPayment") throw new Error("Invalid appointment state");
  return { ...appointment, ...input, kind: "Paid", paidAt } as const satisfies Paid;
};

広げた引数には Scheduled も渡せるため、型エラーが消え、// @ts-expect-error が未使用になります。実行時の検証を追加したため、テストと Linter のルールは通ります。

  1. 型のテスト 型エラーになることを検証する
    ▲ 未検出 ▲ 未検出 ✓ 検出
    // @ts-expect-error ← 次の行が型エラーでなければエラー
    recordPayment(scheduled, { … }, "…");
    // @ts-expect-error ← 次の行が型エラーでなければエラー
    recordPayment(scheduled, { … }, "…");
    // @ts-expect-error ← 次の行が型エラーでなければエラー
    recordPayment(scheduled, { … }, "…");
    エラーなし エラーなし TS2578: Unused '@ts-expect-error' directive.
  2. Linter のルール コードの書き方を検査する
    ✓ 検出 ▲ 未検出 ▲ 未検出
    // selector: 検出するコードの形(TSAsExpression は as の式、TSUnknownKeyword は unknown)
    selector: "TSAsExpression > TSUnknownKeyword",
    // selector: 検出するコードの形(TSAsExpression は as の式、TSUnknownKeyword は unknown)
    selector: "TSAsExpression > TSUnknownKeyword",
    // selector: 検出するコードの形(TSAsExpression は as の式、TSUnknownKeyword は unknown)
    selector: "TSAsExpression > TSUnknownKeyword",
    no-restricted-syntax: unknown を経由した型アサーションで、型検査を回避しません。 エラーなし エラーなし
  3. テスト 実行して値を検証する
    ✓ 検出 ✓ 検出 ▲ 未検出
    expect(startExamination(checkedIn, veterinarianId, startedAt))
      .toMatchObject({ examinationStartedAt: startedAt, … });
    expect(startExamination(checkedIn, veterinarianId, startedAt))
      .toMatchObject({ examinationStartedAt: startedAt, … });
    expect(startExamination(checkedIn, veterinarianId, startedAt))
      .toMatchObject({ examinationStartedAt: startedAt, … });
    callers.test.ts の 5 件失敗: expected [Function] to throw an error transitions.test.ts の 1 件失敗: expected { kind: 'InExamination', …(8) } to match object { kind: 'InExamination', …(4) } transitions.test.ts の 2 件すべて成功