イベントストリームに追加の issue メタデータを含める

イベントストリームのスキーマバージョン 6.5 で、issue イベントに新しいフィールドを追加し、いくつかの既存フィールドの扱いを見直します。これにより、ツールは issue の種類を機械的に判別し、失敗の詳細を構造化された形で受け取れるようになります。

issue に追加される新しいフィールド

issue の内容に応じて、次のフィールドが追加されます。

• error: エラーが throw されたときに、そのエラーの情報（code / domain / description と型情報）を格納します。
• confirmationMiscount: confirmation が期待した回数と異なる回数だけ確認されたときの、実際の回数（actual）と期待した回数（expected）を格納します。expected は単一の値のほか、範囲（min / max）でも表現できます。
• exceededTimeLimit: テストが time limit を超過したときに、超過した制限値を秒単位で格納します。
• expression: issue に紐づく式。主に失敗した expectation（#expect）の式そのものを、ソースコード・評価値・型情報・部分式とともに捉えます。

たとえばエラーが throw された場合は、次のように error フィールドが含まれます。

"issue": {
  "error": {
    "code": 1,
    "description": "SampleError()",
    "domain": "SampleTests...SampleError",
    "type": {
      "fullyQualifiedName": "SampleTests.SampleError",
      "unqualifiedName": "SampleError"
    }
  },
  "isFailure": true,
  "severity": "error"
}

confirmation(expectedCount: 1...5) に対して 10 回確認された、といった miscount は次のように表現されます。

"issue": {
  "confirmationMiscount": {
    "actual": 10,
    "expected": { "min": 1, "max": 5 }
  },
  "isFailure": true,
  "severity": "error"
}

これらのフィールドの有無から、ツールは issue の種類を導けます（たとえば confirmationMiscount があれば confirmation の回数不一致だとわかります）。

既存フィールドの変更

• isKnown: これまで必須の真偽値でしたが、任意のフィールドになり、既定では false として扱われます。withKnownIssue に人間向けのコメントを渡していた場合は、真偽値の代わりにそのコメント文字列が入ります。

  "issue": {
    "isFailure": false,
    "isKnown": "This matches and doesn't fail",
    "severity": "error"
  }
  

• messages: これまで issue の人間向け説明を格納していましたが、今回追加されるフィールドからツール側で説明を再構成できるため、冗長になります。そこで任意のフィールドになり、既定では出力されなくなります（生成とシリアライズのコストを避けるためです）。従来どおり messages を受け取りたいツールは、環境変数 SWIFT_TESTING_EVENT_STREAM_MESSAGES_FIELD_ENABLED を設定します。

すべてのイベント共通のフィールド

• comments: テストの作者が指定したコメントを格納する、イベント共通のフィールドです。Issue.record("A comment") や #expect(a == b, "A comment") のように渡したコメントがここに入ります。なお withKnownIssue に渡したコメントはここには含まれず、前述の isKnown に入ります。
• sourceLocation: これまで issue の中にあったソース位置は、値の添付やスキップされたテストケースなど他の種類のイベントでも使えるよう、イベント（<event>）の最上位に移動します。

ツール側での対応

6.4 スキーマからの主な非互換は次の 3 点です。それ以外のフィールドはすべて追加のみで、既存の解釈に影響しません。

• isKnown が必須の真偽値ではなく、任意の真偽値または文字列になる。
• messages が任意になる（既定で出力されない）。
• sourceLocation が個々のイベント構造から <event> の最上位へ移動する。

Swift Testing と連携している既存ツールは、これらの新しいフィールドを読むように連携コードを更新する必要があります。