ホーム 全セッション S06

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

16 / 20 目安 1分

ページ一覧

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

別の人が new Date() を戻しても型検査は通るため、課題1〜3の解決を守る仕組みは Linter のルールとテストの2つです。変更を選んで、2つの仕組みの結果を比較してください。比較のテストは模範の4件です。harness は、テスト用の deps と、保存されたイベント、store と clock を呼んだ回数をまとめたオブジェクトです。

変更を選ぶ

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

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

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

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

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

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

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

const createEventContext = (deps: EventContextDependencies): EventContext => ({
  eventId: deps.eventIdGenerator.generate(),
  occurredAt: deps.clock.now(),
  occurredAt: new Date().toISOString(),
});

時刻は string のままであるため、型検査は通ります。new Date() の形を検査する Linter のルールと、clock を取得した回数を検証するテストが検出します。

const createEventContext = (deps: EventContextDependencies): EventContext => ({
  eventId: deps.eventIdGenerator.generate(),
  occurredAt: deps.clock.now(),
  occurredAt: new Date(Date.now()).toISOString(),
});

new Date() のルールだけではこの実装を検出できないため、Date.now の形のルールを別に追加します。

// import に EventId を追加する
const createEventContext = (deps: EventContextDependencies): EventContext => ({
  eventId: deps.eventIdGenerator.generate(),
  eventId: EventId.parse(crypto.randomUUID()),
  occurredAt: deps.clock.now(),
});

ID の型は変わらないため、型検査は通ります。randomUUID の呼び出しを検査するルールと、固定の ID と比較するテストが検出します。

      .map(startExaminationEvent(deps, input.veterinarianId))
      .andThrough(deps.examinationStartedStore.store)
      .andThrough(deps.examinationStartedStore.store)
      .map((event) => event.aggregateState);

同じ関数を2回呼ぶ実装はルールの形に当てはまりません。呼び出した回数を検証するテストだけが検出します。

      .map(startExaminationEvent(deps, input.veterinarianId))
      .map((event) => ({ ...event, occurredAt: deps.clock.now() }))
      .andThrough(deps.examinationStartedStore.store)
      .map((event) => event.aggregateState);

deps.clock.now() は許可された実装であるため、ルールは検出しません。この変更では、状態と監査記録の時刻が食い違います。clock を取得した回数を検証するテストだけが検出します。

  (appointment: AppointmentState | undefined) =>
    ensureAppointmentFound(appointment, appointmentId);
  (appointment: AppointmentState | undefined) => {
    if (appointment === undefined) console.warn(new Date());
    return ensureAppointmentFound(appointment, appointmentId);
  };

テストは予約が見つからない経路を実行しないため、この変更を検出しません。Linter のルールは、分岐の中の new Date() も検出します。

const createEventContext = (deps: EventContextDependencies): EventContext => ({
  eventId: deps.eventIdGenerator.generate(),
  occurredAt: deps.clock.now(),
  occurredAt: new Date(deps.clock.now()).toISOString(),
});

正しいコードの別の例です。引数のある new Date(...) は clock が返した時刻から計算するだけで、現在時刻を取得しません。検出すると誤検知(正しいコードを誤った変更として検出すること)になるため、ルールは条件を引数なしに絞ります。

  1. Linter のルール […] に範囲を絞る条件を記述する。引数の個数は [arguments.length=…]
    ✓ 検出 ✓ 検出 ✓ 検出 ▲ 未検出 ▲ 未検出 ✓ 検出 ✓ 誤検知なし
    // selector: 検出するコードの形
    selector: "NewExpression[callee.name='Date'][…]",
    // selector: 検出するコードの形
    selector: "CallExpression[callee.object.name='Date'][…]",
    // selector: 検出するコードの形
    selector: "CallExpression[callee.object.name='crypto'][callee.property.name='randomUUID']",
    // selector: 検出するコードの形
    selector: "NewExpression[callee.name='Date'][…]",
    // selector: 検出するコードの形
    selector: "NewExpression[callee.name='Date'][…]",
    // selector: 検出するコードの形
    selector: "NewExpression[callee.name='Date'][…]",
    // selector: 検出するコードの形
    selector: "NewExpression[callee.name='Date'][…]",
    no-restricted-syntax: 現在時刻を直接読まず、clock から受け取ります。 no-restricted-syntax: 現在時刻を直接読まず、clock から受け取ります。 no-restricted-syntax: ID を直接作らず、ID generator から受け取ります。 エラーなし エラーなし no-restricted-syntax: 現在時刻を直接読まず、clock から受け取ります。 エラーなし
  2. テスト fake の store と clock で検証する
    ✓ 検出 ✓ 検出 ✓ 検出 ✓ 検出 ✓ 検出 ▲ 未検出 ✓ 誤検知なし
    expect(harness.clockReads).toBe(1);
    expect(harness.clockReads).toBe(1);
    expect(harness.recordedEvents.map(…)).toEqual([…]);
    expect(harness.storeCalls).toBe(1);
    expect(harness.clockReads).toBe(1);
    expect(harness.storeCalls).toBe(1);
    expect(harness.storeCalls).toBe(1);
    テスト4件のうち2件失敗: expected +0 to be 1 テスト4件のうち2件失敗: expected +0 to be 1 テスト4件のうち1件失敗: expected [ { …(2) } ] to deeply equal [ { …(2) } ] テスト4件のうち2件失敗: expected 2 to be 1 テスト4件のうち1件失敗: expected 2 to be 1 テスト4件のうち4件成功 テスト4件のうち4件成功

Linter のルールは、コードを実行せずに全体を検査するため、テストが実行しない分岐の中の記述も検出します。判定できるのはコードの形だけです。テストは、実行した経路の結果を検証するため、コードの形に現れない誤りも検出します。ルールの検査対象は、診察開始のファイルだけです。

eslint.config.mjs の rules に追加する設定の形([…] の部分は自分で指定します)

no-restricted-syntax は、selector に一致するコードを禁止する Linter のルールです。NewExpression は、new の式を表す構文の名前です。S04 で ThrowStatement に使った書き方と同じです。引数なしの new Date() だけを検出するのは、new Date(deps.clock.now()) のように port の値を使う記述を検出しないためです。

"no-restricted-syntax": ["error", {
selector: "CallExpression[callee.object.name='crypto'][callee.property.name='randomUUID']",
message: "ID を直接作らず、ID generator から受け取ります。",
}, {
selector: "NewExpression[callee.name='Date'][…]",
message: "…",
}]