パフォーマンスタイムライン

これは [HR-TIME-3] の Performance インターフェースを拡張し、 パフォーマンスタイムラインからパフォーマンス指標データを取得するための属性やメソッドを提供します。

WebIDLpartial interface Performance {
  PerformanceEntryList getEntries ();
  PerformanceEntryList getEntriesByType (DOMString type);
  PerformanceEntryList getEntriesByName (DOMString name, optional DOMString type);
};
typedef sequence<PerformanceEntry> PerformanceEntryList;

PerformanceEntryListは PerformanceEntry のシーケンスを表し、開発者にJavaScript配列で使える便利なメソッドを提供します。

WebIDLdictionary PerformanceObserverCallbackOptions {
  unsigned long long droppedEntriesCount;
};

droppedEntriesCount

オブザーバーが監視しているエントリタイプのドロップされたエントリ数を表す整数値（ PerformanceObserver の requires dropped entries が設定されている場合）。

observe() メソッドはユーザーエージェントにオブザーバー登録を指示し、以下の手順を実行します：

1. relevantGlobal を this の 関連グローバルオブジェクトとする。
2. options の entryTypes および type の両方が省略された場合、throw "TypeError" を発生させる。
3. options の entryTypes が存在し、他のメンバーも存在する場合、throw "TypeError" を発生させる。
4. this の observer type を更新または確認するため、以下の手順を実行：
   1. this の observer type が "undefined" の場合：
      1. options の entryTypes が存在する場合、this の observer type を "multiple" に設定する。
      2. options の type が存在する場合、this の observer type を "single" に設定する。
   2. this の observer type が "single" かつ options の entryTypes が存在する場合、throw "InvalidModificationError" を発生させる。
   3. this の observer type が "multiple" かつ options の type が存在する場合、throw "InvalidModificationError" を発生させる。
5. this の requires dropped entries を true に設定する。
6. this の observer type が "multiple" の場合、以下の手順を実行：
   1. entry types を options の entryTypes シーケンスとする。
   2. entry types から relevantGlobal の 対応エントリタイプの凍結配列 に含まれないタイプを全て除去する。ユーザーエージェントは推奨として、 entry types が変更された場合、開発者に通知するべきです。たとえば、除外されたタイプを列挙したコンソール警告などが適切です。
   3. 結果の entry types シーケンスが空であれば、これらの手順を中止する。ユーザーエージェントは手順が中止された際に登録が中止された旨を通知することが推奨されます。例としてコンソール警告など。
   4. relevantGlobal の 登録済みパフォーマンスオブザーバーオブジェクトのリスト に 登録済みパフォーマンスオブザーバー で、その observer が this であるものが含まれている場合、 その options list を options だけを含むリストに置き換える。
   5. そうでなければ、登録済みパフォーマンスオブザーバー オブジェクトを作成し、relevantGlobal の 登録済みパフォーマンスオブザーバーオブジェクトのリスト に追加する。 observer を this とし、options list を options だけを含むリストにする。
7. それ以外の場合は以下の手順を実行：
   1. this の observer type が "single" であることを確認する。
   2. options の type が relevantGlobal の 対応エントリタイプの凍結配列 に含まれていない場合、これらの手順を中止する。ユーザーエージェントはこの際に開発者へ通知することが推奨されます。例としてコンソール警告など。
   3. relevantGlobal の 登録済みパフォーマンスオブザーバーオブジェクトのリスト に 登録済みパフォーマンスオブザーバー obs で、その observer が this であるものが含まれている場合：
      1. obs の options list に PerformanceObserverInit の currentOptions で、type が options の type と等しいものが含まれている場合、 obs の options list で currentOptions を options に置き換える。
      2. そうでなければ、options を obs の options list に追加する。
   4. そうでなければ、登録済みパフォーマンスオブザーバー オブジェクトを作成し、relevantGlobal の 登録済みパフォーマンスオブザーバーオブジェクトのリスト に追加する。 observer を this とし、options list を options だけを含むリストにする。
   5. options の buffered フラグが設定されている場合：
      1. tuple を 関連パフォーマンスエントリタプル（options の type および relevantGlobal）とする。

      2. tuple の パフォーマンスエントリバッファ の各 entry について：

         1. should add entry に entry と options を渡して true を返す場合、append で entry を オブザーバーバッファ に追加する。
      3. PerformanceObserver タスクのキューイング（relevantGlobal を入力）を行う。

WebIDLdictionary PerformanceObserverInit {
  sequence<DOMString> entryTypes;
  DOMString type;
  boolean buffered;
};

WebIDL[Exposed=(Window,Worker)]
interface PerformanceObserverEntryList {
  PerformanceEntryList getEntries();
  PerformanceEntryList getEntriesByType (DOMString type);
  PerformanceEntryList getEntriesByName (DOMString name, optional DOMString type);
};

takeRecords() メソッドは this の オブザーバーバッファ のコピーを返し、さらに this の オブザーバーバッファ を空にします。

disconnect() メソッドは以下を実行します：

1. this を 登録済みパフォーマンスオブザーバーオブジェクトのリスト から削除する（関連グローバルオブジェクト）。
2. this の オブザーバーバッファ を空にする。
3. this の options list を空にする。

各 グローバルオブジェクト には サポートされているエントリタイプの凍結配列 が関連付けられており、これは FrozenArray に 作成された、レジストリ内のグローバルオブジェクトに対応するサポート済み文字列をアルファベット順に並べたシーケンスから初期化されます。

supportedEntryTypes 属性のgetterが呼ばれたとき、次の手順を実行します：

1. globalObject を 環境設定オブジェクトのグローバルオブジェクト とする。
2. globalObject の サポートされているエントリタイプの凍結配列 を返す。

PerformanceEntry をキューイングする (newEntry) には、以下の手順を実行します：

1. newEntry の id が未設定の場合：
   1. id を IDの生成 を newEntry に対して実行した結果とする。
   2. newEntry の id を id に設定する。
2. interested observers を最初は空の PerformanceObserver オブジェクト集合とする。
3. entryType を newEntry の entryType 値とする。
4. relevantGlobal を newEntry の 関連グローバルオブジェクト とする。
5. relevantGlobal が 関連付けられたドキュメント を持つ場合：
   1. newEntry の navigationId を relevantGlobal の 関連付けられたドキュメント の 最新ナビゲーション の id の値に設定する。
6. そうでなければ、newEntry の navigationId を null に設定する。
7. relevantGlobal の 登録済みパフォーマンスオブザーバーオブジェクトのリスト の各 登録済みパフォーマンスオブザーバー regObs について：

   1. regObs の options list に PerformanceObserverInit options で、entryTypes メンバーに entryType が含まれるか、type メンバーが entryType と等しいものがあれば：

      1. should add entry に newEntry と options を渡して true の場合、regObs の observer を interested observers に追加する。
8. interested observers の各 observer について：
   1. newEntry を observer の オブザーバーバッファ に追加する。
9. tuple を entryType と relevantGlobal の 関連パフォーマンスエントリタプル とする。
10. isBufferFull を パフォーマンスエントリバッファが満杯かどうかの判定 アルゴリズムを tuple で実行した結果とする。
11. shouldAdd を should add entry に newEntry を渡した結果とする。
12. isBufferFull が false かつ shouldAdd が true の場合、append で newEntry を tuple の パフォーマンスエントリバッファ に追加する。
13. PerformanceObserver タスクのキューイング（relevantGlobalを入力）を行う。

ナビゲーション PerformanceEntry をキューイングする (newEntry) には、以下の手順を実行します：

1. id を IDの生成 を newEntry に対して実行した結果とする。
2. relevantGlobal を newEntry の 関連グローバルオブジェクト とする。
3. newEntry の id を id に設定する。
4. newEntry の navigationId を id に設定する。
5. relevantGlobal が 関連付けられたドキュメント を持つ場合：
   1. relevantGlobal の 関連付けられたドキュメント の 最新ナビゲーション を newEntry に設定する。
6. PerformanceEntry のキューイング（newEntryを入力）を行う。

PerformanceObserver タスクのキューイング では、relevantGlobal を入力として、以下の手順を実行します：

1. relevantGlobal の performance observer タスクキュー済みフラグ が設定されている場合、これらの手順を終了する。
2. relevantGlobal の performance observer タスクキュー済みフラグ を設定する。
3. タスクをキューイングし、次のサブステップを実行する。 キューイングしたタスクの タスクソース は パフォーマンスタイムラインタスクソース とする。
   1. relevantGlobal の performance observer タスクキュー済みフラグ を解除する。
   2. notifyList を relevantGlobal の 登録済みパフォーマンスオブザーバーオブジェクトのリスト のコピーとする。
   3. notifyList の各 登録済みパフォーマンスオブザーバー オブジェクト registeredObserver について、次の手順を実行する：
      1. po を registeredObserver の observer とする。
      2. entries を po の オブザーバーバッファ のコピーとする。
      3. entries が空の場合、return。
      4. po の オブザーバーバッファ を空にする。
      5. observerEntryList を新しい PerformanceObserverEntryList とし、 その entry list を entries に設定する。
      6. droppedEntriesCount を null とする。
      7. po の requires dropped entries が設定されていれば、以下の手順を実行する：
         1. droppedEntriesCount を 0 に設定する。
         2. registeredObserver の options list の各 PerformanceObserverInit item について：
            1. item の type または entryTypes に登場する各 DOMString entryType について：
               1. map を relevantGlobal の パフォーマンスエントリバッファマップ とする。
               2. tuple を map の entryType キーで 値の取得 をした結果とする。
               3. droppedEntriesCount を tuple の ドロップ済みエントリ数 分増やす。
         3. po の requires dropped entries を false に設定する。
      8. callbackOptions を PerformanceObserverCallbackOptions とし、 その droppedEntriesCount を droppedEntriesCount が null でなければその値、そうでなければ未設定とする。
      9. コールバック関数の呼び出しで po の オブザーバーコールバック に « observerEntryList, po, callbackOptions »、"report"、po を渡す。

パフォーマンスタイムライン タスクキュー は低優先度のキューで、パフォーマンス監視コードの影響を最小限にするため、可能な限りアイドル期間に処理されるべきです。

バッファマップを名前と型でフィルタ アルゴリズムを optional name と type で実行する場合、以下の手順を実行します：

1. result を最初は空の リストとする。
2. map を パフォーマンスエントリバッファマップ （関連グローバルオブジェクトに関連付けられている）とする。
3. tuple list を空の リストとする。
4. type が null でなければ、map の type キーで エントリ値を取得した結果を tuple list に追加する。そうでなければ map の 値リスト取得結果を tuple list に代入する。
5. tuple list の各 tuple について、以下の手順を実行する：
   1. buffer を tuple の パフォーマンスエントリバッファ とする。
   2. tuple の availableFromTimeline が false なら、次の tuple へ進む。
   3. entries を バッファを名前と型でフィルタで buffer、name、type を渡して実行した結果とする。
   4. entries の各 entry について append で entry を result に追加する。
6. results のエントリを startTime を基準に時系列順にソートする。
7. result を返す。

バッファを名前と型でフィルタ アルゴリズムを buffer、name、type で実行する場合、以下の手順を実行します：

1. result を最初は空の リストとする。
2. buffer の各 PerformanceEntry entry について、以下の手順を実行する：
   1. type が null でなく、かつ type が entry の entryType 属性と 一致しない場合、次の entry へ進む。
   2. name が null でなく、かつ name が entry の name 属性と 一致しない場合、次の entry へ進む。
   3. append で entry を result に追加する。
3. results のエントリを startTime を基準に時系列順にソートする。
4. result を返す。

パフォーマンスエントリバッファが満杯かどうかの判定 は tuple を入力として、以下の手順を実行します：

1. num current entries を tuple の パフォーマンスエントリバッファ のサイズとする。
2. num current entries が tuples の maxBufferSize より小さければ false を返す。
3. tuple の ドロップ済みエントリ数 を 1 増やす。
4. true を返す。

IDの生成 を PerformanceEntry entry に対して実行する場合、以下の手順を実行します：

1. relevantGlobal を entry の 関連グローバルオブジェクト とする。
2. relevantGlobal の last performance entry id をユーザーエージェントが選んだ少しの数値だけ増加させる。
3. relevantGlobal の last performance entry id を返す。

ユーザーエージェントは last performance entry id を毎回少しの乱数で増加させてもよい。ユーザーエージェントは全グローバルオブジェクトの last performance entry id を同じ値でまとめて増やしてはならない（クロスオリジン漏洩の原因となるため）。