1. 動機
このセクションは規範的ではありません。
Webアプリケーションは従来、ネットワークが到達可能であることを前提としています。この前提はプラットフォーム全体に浸透しています。HTML文書はHTTP経由で読み込まれ、従来はすべてのサブリソースも後続のHTTPリクエストで取得されます。このため、Webコンテンツは他の技術スタックと比べて不利な立場に置かれます。
サービスワーカーは、Web Workerコンテキストを提供することで、このバランスを是正するために設計されました。これは、ナビゲーションが発生する際にランタイムによって起動できるイベント駆動型ワーカーです。ワーカーは、オリジンとパス(またはパターン)に対して登録されるため、その場所へのナビゲーションが発生したときに参照されます。ネットワークリクエストに対応するイベントがワーカーに配送され、ワーカーが生成するレスポンスはデフォルトのネットワークスタックの動作を上書きする場合があります。これにより、サービスワーカーは概念的にネットワークとドキュメントレンダラーの間に位置し、オフライン時でもドキュメントにコンテンツを提供することができます。
以前のオフライン問題の解決策に慣れたWeb開発者からは、それらの解決策には柔軟性が欠如していると指摘されています。その結果、サービスワーカーは非常に手続き型となり、柔軟性を最大限に高める代わりに開発者により多くの複雑さをもたらします。この複雑さの一部は、サービスワーカーを単一スレッド実行モデルでも応答性を保つ必要から生じています。そのため、サービスワーカーが公開するAPIはほぼすべて非同期であり、他のJavaScriptコンテキストにも見られるパターンですが、ここではドキュメントやリソースの読み込みをブロックしない必要性から強調されています。
HTML5アプリケーションキャッシュを利用している開発者たちは、その設計のいくつかの属性が重大な問題を引き起こし、復旧不可能なエラーにつながると報告しています。Service Workerの主要な設計原則の一つは、エラーが常に回復可能であるべきだということです。Service Workerの更新処理の多くの詳細は、これらの問題を回避するために設計されています。
Service Workerはドキュメントではなくイベントとの関係によって起動および維持されます。この設計は、Shared WorkerやChrome Background Pagesに関する開発者やベンダーの経験を大いに参考にしています。これらのシステムから得られた重要な教訓は、リソースの節約およびバックグラウンドコンテキストの損失や再起動を開発者が意識できるようにするため、バックグラウンド処理コンテキストの実行時間を制限する必要があるということです。そのため、Service WorkerはChrome Event Pages(Background Pagesの後継)と非常によく似ています。Service Workerはドキュメントが結びついていなくてもユーザーエージェントによって起動されることがあり、ほぼいつでもユーザーエージェントによって終了される可能性があります。概念的には、Service Workerは、ドキュメントからのメッセージを一度も処理せずに開始・イベント処理・終了することができるShared Workerと捉えることができます。開発者は、Service Workerが1秒間に何度も起動や終了される可能性があることを忘れないよう注意してください。
Service Workerは、オリジンで実行される汎用的かつイベント駆動で時間制限のあるスクリプトコンテキストです。これらの特徴により、特定のドキュメントのコンテキストを超えて動作する実行時サービス(例:プッシュ通知の処理、バックグラウンドデータ同期、他オリジンからのリソース要求への応答、高コストなデータの一元的な更新受信(例:位置情報やジャイロスコープ)など)の受け口として自然に活用できます。
2. モデル
2.1. サービスワーカー
サービスワーカーは、Web Workerの一種です。サービスワーカーは、登録元のサービスワークラクライアントのオリジンで実行されます。
サービスワーカーは、"parsed"、"installing"、"installed"、"activating"、"activated"、"redundant"のいずれかの状態を持ちます。初期状態は"parsed"です。
サービスワーカーは、"classic"または"module"のいずれかの型を持ちます。特に明記されていない限り、"classic"です。
サービスワーカーは、含有サービスワーカー登録(サービスワーカー登録)を持ち、自身を含みます。
サービスワーカーは、グローバルオブジェクト(ServiceWorkerGlobalScopeオブジェクトまたはnull)を持ちます。
サービスワーカーは、スクリプトリソース(スクリプト)を持ち、自身のスクリプトリソースを表します。初期値はnullです。
スクリプトリソースは、評価済みフラグを持ちます。初期状態は未設定です。
スクリプトリソースは、ポリシーコンテナ(ポリシーコンテナ)を持ちます。初期値は新規ポリシーコンテナです。
サービスワーカーは、スクリプトリソースマップ(順序付きマップ)を持ち、キーはURL、値はレスポンスです。
サービスワーカーは、使用済みスクリプト集合(集合)を持ち、要素はURLです。初期値は新規集合です。
注: 使用済みスクリプト集合は、新しいワーカーのインストール後に未使用リソースをマップから削除するためだけに利用され、アップデートチェック時に古いワーカーのマップを元に構築されます。
サービスワーカーは、skip waitingフラグを持ち、特に明記されていない限り未設定です。
サービスワーカーは、クラシックスクリプトインポート済みフラグを持ち、初期状態は未設定です。
サービスワーカーは、処理対象イベントタイプ集合(集合)を持ち、要素はイベントリスナーのイベントタイプです。初期値は新規集合です。
サービスワーカーは、拡張イベント集合(集合)を持ち、要素はExtendableEventです。初期値は新規集合です。
サービスワーカーは、nullまたはCompletionとなる開始状態を持ちます。初期値はnullです。
サービスワーカーは、全fetchリスナー空フラグを持ちます。初期状態は未設定です。
サービスワーカーは、ルーター規則リスト(リスト、RouterRuleのリスト)を持ち、初期値は空リストです。
サービスワーカーは、実行中であると言い、これはイベントループが稼働している状態です。
サービスワーカーは、[[service worker queue]](並列キュー)を持ちます。
2.1.1. ライフタイム
サービスワーカーのライフタイムはイベントの実行時間に紐付いており、サービスワークラクライアントがServiceWorkerオブジェクトを保持しているかどうかには依存しません。
ユーザーエージェントは、以下の場合いつでもサービスワーカーを終了することがあります:
-
処理するイベントが存在しない場合。
-
異常な動作(例:イベント処理中の無限ループや課せられた時間制限(存在する場合)を超えるタスク)を検出した場合。
2.1.2. イベント
Service Workers仕様は、サービスワーカーイベント(すべてイベント)を定義しており、以下を含みます(一覧参照):
2.2. サービスワーカーのタイミング
Service Workerは、後でNavigation Timing APIやResource Timing APIによって公開される、特定の時点を記録します。
Service Workerタイミング情報は構造体です。以下の項目を持ちます:
- 開始時刻
-
DOMHighResTimeStamp、初期値は0。 - fetchイベントディスパッチ時刻
-
DOMHighResTimeStamp、初期値は0。 - Workerルーター評価開始時刻
-
DOMHighResTimeStamp、初期値は0。 - Workerキャッシュ参照開始時刻
-
DOMHighResTimeStamp、初期値は0。 - Worker一致ルーターソース
-
DOMString、初期値は空文字列。 - Worker最終ルーターソース
-
DOMString、初期値は空文字列。
2.3. サービスワーカーの登録
サービスワーカー登録は、スコープURL、ストレージキー、およびサービスワーカーのセット、インストール中ワーカー、待機ワーカー、アクティブワーカーからなるタプルです。ユーザーエージェントは、スコープURLが異なる限り、1つのオリジンで複数のサービスワーカー登録を有効にすることができます。ユーザーエージェント内ですでに存在するスコープURLと同一のサービスワーカー登録が新たに作成された場合、既存のサービスワーカー登録は置き換えられます。
サービスワーカー登録には、関連付けられたストレージキー(ストレージキー)があります。
サービスワーカー登録には、関連付けられたスコープURL(URL)があります。
サービスワーカー登録には、関連付けられたインストール中ワーカー(サービスワーカーまたはnull)があり、その状態は"installing"です。初期値はnullです。
サービスワーカー登録には、関連付けられた待機ワーカー(サービスワーカーまたはnull)があり、その状態は"installed"です。初期値はnullです。
サービスワーカー登録には、関連付けられたアクティブワーカー(サービスワーカーまたはnull)があり、その状態は"activating"または"activated"です。初期値はnullです。
サービスワーカー登録には、関連付けられた最終更新確認時刻があります。初期値はnullです。
サービスワーカー登録は、登録の最終更新確認時刻がnullでなく、現在時刻から登録の最終更新確認時刻を引いた秒数が86400より大きい場合、古くなっているとされます。
サービスワーカー登録には、関連付けられたキャッシュ経由での更新モードがあり、"imports"、"all"、または"none"のいずれかです。初期値は"imports"です。
サービスワーカー登録には、1つ以上のタスクキューがあり、タスクをアクティブワーカーのイベントループに対応するタスクキューからバックアップします。(このバックアップ操作のターゲットタスクソースは、fetch処理タスクソースおよび機能イベント処理タスクソースです。)ユーザーエージェントは、アクティブワーカーが終了されたとき、アクティブワーカーのタスクをサービスワーカー登録のタスクキューにダンプし、アクティブワーカーが再起動されたときにそれらのタスクを再度キューイングします。イベントループが所有するタスクキューとは異なり、サービスワーカー登録のタスクキュー自体は、いかなるイベントループによっても処理されません。
サービスワーカー登録には、関連付けられたNavigationPreloadManagerオブジェクトがあります。
サービスワーカー登録には、関連付けられたナビゲーションプリロード有効フラグがあります。初期状態は未設定です。
サービスワーカー登録には、関連付けられたナビゲーションプリロードヘッダー値(バイト列)があります。初期値はtrueです。
サービスワーカー登録は、登録マップ[このストレージキー、シリアライズされたスコープURL]がこのサービスワーカー登録でない場合、登録解除済みとされます。
2.3.1. ライフタイム
ユーザーエージェントは、明示的に未登録されない限り、登録済みサービスワーカー登録のリストを永続的に保持しなければなりません。ユーザーエージェントは、サービスワーカー登録の(ストレージキー, 直列化された スコープURL)のタプルと、それに対応するサービスワーカー登録を格納するregistration mapを持ちます。サービスワーカー登録のライフタイムは、対応するサービスワークラクライアントのライフタイム内でそれを表すServiceWorkerRegistrationオブジェクトのライフタイムよりも長いです。
2.4. サービスワークラクライアント
サービスワークラクライアントは、環境です。
サービスワークラクライアントは、破棄フラグを持ちます。初期状態は未設定です。
各サービスワークラクライアントは、以下の環境破棄手順を持ちます:
-
clientの破棄フラグを設定する。
注: 実装は、破棄フラグが設定されたクライアントを破棄することができます。
サービスワークラクライアントは、originとして定義されるアルゴリズムを持ち、サービスワークラクライアントが環境設定オブジェクトの場合は、そのoriginを返し、それ以外の場合はサービスワークラクライアントの作成URLのoriginを返します。
ウィンドウクライアントは、サービスワークラクライアントであり、そのグローバルオブジェクトがWindowオブジェクトです。
専用ワークラクライアントは、サービスワークラクライアントであり、そのグローバルオブジェクトがDedicatedWorkerGlobalScopeオブジェクトです。
共有ワークラクライアントは、サービスワークラクライアントであり、そのグローバルオブジェクトがSharedWorkerGlobalScopeオブジェクトです。
ワークラクライアントは、専用ワークラクライアントまたは共有ワークラクライアントのいずれかです。
2.5. 制御と利用
サービスワークラクライアントは、自身の読み込みやサブリソースのためのアクティブサービスワーカーを持ちます。サービスワークラクライアントが非nullのアクティブサービスワーカーを持つ場合、そのクライアントはそのアクティブサービスワーカーによって制御されていると言います。また、サービスワークラクライアントがサービスワーカーに利用されている場合、そのクライアントは含有サービスワーカー登録を利用していると言います。 サービスワークラクライアントのアクティブサービスワーカーは以下のサブセクションで説明する通りに決定されます。
このセクションの残り部分は規範的ではありません。
このセクションの挙動はまだ完全には規定されておらず、HTML標準で規定される予定です。作業はissueおよびpull requestで追跡されています。
2.5.1. ウィンドウクライアントの場合
ウィンドウクライアントは、作成されるとき、ブラウジングコンテキストが作成されたときや、ナビゲーション時に作成されます。
ウィンドウクライアントが作成され、ブラウジングコンテキストの作成過程にある場合:
そのブラウジングコンテキストの初期アクティブドキュメントのoriginが不透明なoriginの場合、ウィンドウクライアントのアクティブサービスワーカーはnullになります。 それ以外の場合は、作成元ドキュメントのサービスワークラクライアントのアクティブサービスワーカーに設定されます。
ウィンドウクライアントが作成され、ブラウジングコンテキストのナビゲーション過程にある場合:
fetchがHTTP fetchを経由する場合、ウィンドウクライアントのアクティブサービスワーカーはサービスワーカー登録一致の結果になります。 それ以外の場合、新たに作成されたドキュメントのoriginが不透明なoriginであるか、作成元ドキュメントのoriginと同一でない場合、ウィンドウクライアントのアクティブサービスワーカーはnullになります。 それ以外の場合は、作成元ドキュメントのサービスワークラクライアントのアクティブサービスワーカーに設定されます。
注: 初回置換ナビゲーションの場合、ウィンドウクライアントは作成時にブラウジングコンテキストが作成されたものが再利用されますが、アクティブサービスワーカーの決定は上記と同じ動作に従います。
注: sandboxediframeでsandbox属性にallow-same-originおよびallow-scriptsが指定されていない場合は、アクティブサービスワーカー値がnullになります。これはoriginが不透明なoriginとなるためです。
2.5.2. ワークラクライアントの場合
ワークラクライアントは、ユーザーエージェントが作成し、ワーカーを実行したときに作成されます。
ワークラクライアントが作成されたとき:
fetchがHTTP fetchを経由する場合、ワークラクライアントのアクティブサービスワーカーはサービスワーカー登録一致の結果になります。 それ以外の場合、ワークラクライアントのoriginが不透明なoriginである場合や、リクエストのURLがblob URLで、そのワークラクライアントのoriginが同一でない場合、最後の項目のワークラクライアントのグローバルオブジェクトのowner setのoriginと一致しない場合、ワークラクライアントのアクティブサービスワーカーはnullになります。 それ以外の場合は、最後の項目のワークラクライアントのグローバルオブジェクトのowner setの環境設定オブジェクトのアクティブサービスワーカーに設定されます。
注: ウィンドウクライアントやワークラクライアントがdata: URLを持つ場合、アクティブサービスワーカー値はnullとなります。これはoriginが不透明なoriginとなるためです。ウィンドウクライアントやワークラクライアントがblob URLを持つ場合は、作成元ドキュメントや所有者のアクティブサービスワーカーを継承できますが、リクエストのoriginが、作成元ドキュメントや所有者のoriginと同一でない場合、アクティブサービスワーカーはnullになります。
2.6. タスクソース
2.7. ユーザーエージェントのシャットダウン
ユーザーエージェントは、保存されたサービスワーカー登録の状態を再起動時にも維持しなければなりません。ただし、以下のルールに従います:
-
installing workerは永続化されず、破棄されます。もしinstalling workerがそのサービスワーカー登録にとって唯一のサービスワーカーだった場合、そのサービスワーカー登録も破棄されます。
-
waiting workerはactive workerに昇格します。
これを実現するため、ユーザーエージェントは終了時にユーザーエージェントのシャットダウン処理を呼び出す必要があります。
3. クライアントコンテキスト
// スコープはデフォルトでスクリプトが存在するパスになります // この例では "/" です navigator. serviceWorker. register( "/serviceworker.js" ). then( registration=> { console. log( "success!" ); if ( registration. installing) { registration. installing. postMessage( "インストール中のページからこんにちは" ); } }, err=> { console. error( "ワーカーのインストールに失敗しました!" , err); });
3.1.
ServiceWorker
[SecureContext ,Exposed =(Window ,Worker )]interface :ServiceWorker EventTarget {readonly attribute USVString scriptURL ;readonly attribute ServiceWorkerState state ;undefined postMessage (any ,message sequence <object >);transfer undefined postMessage (any ,message optional StructuredSerializeOptions = {}); // eventoptions attribute EventHandler onstatechange ; };ServiceWorker includes AbstractWorker ;enum {ServiceWorkerState ,"parsed" ,"installing" ,"installed" ,"activating" ,"activated" };"redundant"
ServiceWorker
オブジェクトは サービスワーカーを表します。各 ServiceWorker
オブジェクトは サービスワーカー に関連付けられます。複数のドキュメントやワーカーで ServiceWorker
インターフェースを実装する個別のオブジェクトが、同じ サービスワーカー に同時に関連付けられることができます。
ServiceWorker
オブジェクトは ServiceWorkerState
オブジェクトを持ち、これは サービスワーカー の state に関連付けられています。
3.1.1. ServiceWorker
インスタンスの取得
環境設定オブジェクトは サービスワーカーオブジェクトマップ(マップ)を持ち、キーは サービスワーカー、値は ServiceWorker
オブジェクトです。
-
objectMap を environment の サービスワーカーオブジェクトマップとする。
-
objectMap[serviceWorker] が 存在しない場合:
-
serviceWorkerObj を environment の Realm で新規作成した
ServiceWorkerとし、serviceWorker に関連付ける。 -
objectMap[serviceWorker] に serviceWorkerObj を設定する。
-
-
objectMap[serviceWorker] を返す。
3.1.2.
scriptURL
scriptURL ゲッター手順は、サービスワーカーの 直列化された script url を返す。
3.1.3.
state
state 属性は、(ServiceWorkerState列挙)で最後に設定された値を返さなければなりません。
3.1.4. postMessage(message, transfer)
postMessage(message, transfer)
メソッド手順:
-
options を «[ "transfer" → transfer ]» とする。
-
message と options を引数に
postMessage(message, options)を呼び出す。
3.1.5. postMessage(message, options)
postMessage(message, options)
メソッド手順:
-
incumbentSettings を 現職設定オブジェクトとする。
-
incumbentGlobal を incumbentSettings の グローバルオブジェクトとする。
-
serializeWithTransferResult を StructuredSerializeWithTransfer(message, options["
transfer"]) の結果とする。例外は再スローする。 -
"message" と serviceWorkerで イベントスキップ判定アルゴリズムの結果が true なら return。
-
以下のサブステップを 並列で実行:
-
serviceWorker で サービスワーカーの実行アルゴリズムの結果が failure なら return。
-
DOM操作タスクソースで以下を実行:
-
incumbentGlobal の型に応じて source を決定:
ServiceWorkerGlobalScope- incumbentGlobal の service worker を serviceWorker の 関連設定オブジェクトで表すサービスワーカーオブジェクト取得の結果
Window- incumbentGlobal の 関連設定オブジェクトを表す新しい
WindowClientオブジェクト - その他
- incumbentGlobal の関連ワーカーを表す新しい
Clientオブジェクト
-
destination を serviceWorker に関連付けられた
ServiceWorkerGlobalScopeオブジェクトとする。 -
deserializeRecord を StructuredDeserializeWithTransfer(serializeWithTransferResult, destination の Realm) とする。
例外が発生した場合は、originを初期化した
messageerrorイベントをExtendableMessageEventを使い作成し、sourceを初期化する。 -
それ以外:
-
messageClone を deserializeRecord.[[Deserialized]] とする。
-
newPorts を deserializeRecord.[[TransferredValues]] 内のすべての
MessagePortオブジェクトから作成した新しい frozen array(順序維持)とする。 -
e を origin、source、messageClone、newPortsを初期化した
messageイベントとしてExtendableMessageEventを使い作成する。
-
-
Dispatch e を destination で実行。
-
サービスワーカー拡張イベントセットの更新 を serviceWorker と e で呼び出す。
-
-
3.1.6. イベントハンドラー
以下は イベントハンドラー(および対応する イベントハンドラーイベントタイプ)であり、すべての ServiceWorker
インターフェース実装オブジェクトで イベントハンドラーIDL属性としてサポートしなければなりません:
| event handler | event handler event type |
|---|---|
onstatechange
| statechange
|
3.2. ServiceWorkerRegistration
[SecureContext ,Exposed =(Window ,Worker )]interface :ServiceWorkerRegistration EventTarget {readonly attribute ServiceWorker ?installing ;readonly attribute ServiceWorker ?waiting ;readonly attribute ServiceWorker ?active ; [SameObject ]readonly attribute NavigationPreloadManager navigationPreload ;readonly attribute USVString scope ;readonly attribute ServiceWorkerUpdateViaCache updateViaCache ; [NewObject ]Promise <ServiceWorkerRegistration >update (); [NewObject ]Promise <boolean >unregister (); // eventattribute EventHandler onupdatefound ; };enum {ServiceWorkerUpdateViaCache ,"imports" ,"all" };"none"
ServiceWorkerRegistrationは、サービスワーカー登録(サービスワーカー登録)を持ちます。
3.2.1. ServiceWorkerRegistrationインスタンスの取得
環境設定オブジェクトは、サービスワーカー登録オブジェクトマップを持ちます。これは、マップであり、キーがサービスワーカー登録、値がServiceWorkerRegistrationオブジェクトです。
-
objectMapをenvironmentのサービスワーカー登録オブジェクトマップとする。
-
objectMap[registration]が存在しない場合:
-
registrationObjectをenvironmentのRealmで新規作成した
ServiceWorkerRegistrationとする。 -
registrationObjectのサービスワーカー登録をregistrationに設定する。
-
registrationObjectの
installing属性をnullに設定する。 -
registrationObjectの
waiting属性をnullに設定する。 -
registrationObjectの
active属性をnullに設定する。 -
registrationのinstalling workerがnullでない場合、registrationObjectの
installing属性をregistrationのinstalling workerをenvironmentで表すサービスワーカーオブジェクト取得の結果に設定する。 -
registrationのwaiting workerがnullでない場合、registrationObjectの
waiting属性をregistrationのwaiting workerをenvironmentで表すサービスワーカーオブジェクト取得の結果に設定する。 -
registrationのactive workerがnullでない場合、registrationObjectの
active属性をregistrationのactive workerをenvironmentで表すサービスワーカーオブジェクト取得の結果に設定する。 -
objectMap[registration]にregistrationObjectを設定する。
-
-
objectMap[registration]を返す。
3.2.2. installing
installing属性は、最後に設定された値を返さなければなりません。
注: Realm内では、関連付けられたサービスワーカーごとに1つのServiceWorkerオブジェクトのみ存在します。
3.2.3. waiting
waiting属性は、最後に設定された値を返さなければなりません。
注: Realm内では、関連付けられたサービスワーカーごとに1つのServiceWorkerオブジェクトのみ存在します。
3.2.4. active
active属性は、最後に設定された値を返さなければなりません。
注: Realm内では、関連付けられたサービスワーカーごとに1つのServiceWorkerオブジェクトのみ存在します。
3.2.5. navigationPreload
navigationPreloadゲッター手順は、サービスワーカー登録のNavigationPreloadManagerオブジェクトを返すこと。
3.2.6. scope
scopeゲッター手順は、サービスワーカー登録の直列化されたscope urlを返すこと。
registration.scope(例えばnavigator.serviceWorker.ready.then(registration => console.log(registration.scope))で取得)は"https://example.com/"となります。
3.2.7. updateViaCache
updateViaCacheゲッター手順は、サービスワーカー登録のupdate
via cacheモードを返すこと。
3.2.8. update()
update()メソッド手順:
-
registrationをサービスワーカー登録とする。
-
newestWorkerを最新ワーカー取得アルゴリズムでregistrationを引数に実行した結果にする。
-
newestWorkerがnullの場合、失敗したpromise("
InvalidStateError"DOMException)を返して中断。 -
thisの関連グローバルオブジェクトglobalObjectが
ServiceWorkerGlobalScopeオブジェクトであり、globalObjectの関連サービスワーカーのstateが"installing"の場合、失敗したpromise("InvalidStateError"DOMException)を返して中断。 -
promiseをpromiseとする。
-
jobをジョブ作成アルゴリズムで、update、registrationのstorage key、registrationのscope url、newestWorkerのscript url、promise、thisの関連設定オブジェクトを引数に実行した結果にする。
-
jobのworker typeをnewestWorkerのtypeに設定する。
-
ジョブスケジュールをjobで呼び出す。
-
promiseを返す。
3.2.9. unregister()
注: unregister()メソッドはサービスワーカー登録を解除します。現在制御されているサービスワークラクライアントのアクティブサービスワーカーの含有サービスワーカー登録は、そのサービスワーカー登録を利用するすべてのサービスワークラクライアント(自身を含む)がアンロードされるまで有効です。つまり、unregister()メソッドは、以降のナビゲーションにのみ影響します。
unregister()メソッド手順:
-
registrationをサービスワーカー登録とする。
-
promiseを新規promiseとする。
-
jobをジョブ作成アルゴリズムで、unregister、registrationのstorage key、registrationのscope url、null、promise、thisの関連設定オブジェクトを引数に実行した結果にする。
-
ジョブスケジュールをjobで呼び出す。
-
promiseを返す。
3.2.10. イベントハンドラー
以下はイベントハンドラー(および対応するイベントハンドラーイベントタイプ)であり、すべてのServiceWorkerRegistrationインターフェース実装オブジェクトでイベントハンドラーIDL属性としてサポートしなければなりません:
| event handler | event handler event type |
|---|---|
onupdatefound
| updatefound
|
3.3.
navigator.serviceWorker
partial interface Navigator { [SecureContext ,SameObject ]readonly attribute ServiceWorkerContainer serviceWorker ; };partial interface WorkerNavigator { [SecureContext ,SameObject ]readonly attribute ServiceWorkerContainer serviceWorker ; };
serviceWorker
ゲッターの手順は、ServiceWorkerContainer
オブジェクトをthisに関連付けて返すことです。
3.4. ServiceWorkerContainer
[SecureContext ,Exposed =(Window ,Worker )]interface :ServiceWorkerContainer EventTarget {readonly attribute ServiceWorker ?controller ;readonly attribute Promise <ServiceWorkerRegistration >ready ; [NewObject ]Promise <ServiceWorkerRegistration >register ((TrustedScriptURL or USVString ),scriptURL optional RegistrationOptions = {}); [options NewObject ]Promise <(ServiceWorkerRegistration or undefined )>getRegistration (optional USVString = ""); [clientURL NewObject ]Promise <FrozenArray <ServiceWorkerRegistration >>getRegistrations ();undefined startMessages (); // eventsattribute EventHandler oncontrollerchange ;attribute EventHandler onmessage ; // event.source of message events is ServiceWorker objectattribute EventHandler onmessageerror ; };
dictionary {RegistrationOptions USVString ;scope WorkerType = "classic";type ServiceWorkerUpdateViaCache = "imports"; };updateViaCache
ユーザーエージェントは、ServiceWorkerContainer
オブジェクトをNavigator
オブジェクトまたはWorkerNavigator
オブジェクト作成時に生成し、それらのオブジェクトに関連付けなければなりません。
ServiceWorkerContainer
は、サービスワーカー登録の登録・解除・更新の機能を提供し、サービスワーカー登録およびそれに関連するサービスワーカーの状態へのアクセスを提供します。
ServiceWorkerContainer
は、関連するサービスワークラクライアントを持ちます。これは、サービスワークラクライアントであり、そのグローバルオブジェクトがNavigator
またはWorkerNavigator
オブジェクトに関連付けられています。
ServiceWorkerContainer
オブジェクトは、関連するready promise
(promiseまたはnull)を持ちます。初期値はnullです。
ServiceWorkerContainer
オブジェクトは、タスクソースとしてクライアントメッセージキュー(初期値は空)を持ちます。クライアントメッセージキューは有効・無効にでき、初期状態は無効です。ServiceWorkerContainer
オブジェクトのクライアントメッセージキューが有効な場合、イベントループはそれをタスクソースの一つとして使用しなければなりません。ServiceWorkerContainer
オブジェクトの関連グローバルオブジェクトがWindow
オブジェクトの場合、すべてのタスクはキューされる際、クライアントメッセージキューに関連付けられ、その関連設定オブジェクトの関連ドキュメントに紐付けられます。
3.4.1. controller
controller
属性の手順は以下の通り実行しなければなりません:
-
clientをthisのサービスワークラクライアントとする。
-
clientのアクティブサービスワーカー がnullの場合、nullを返す。
-
clientのアクティブサービスワーカーをサービスワーカーオブジェクト取得で、thisの関連設定オブジェクトで表現した結果を返す。
注: navigator.serviceWorker.controller
はリクエストが強制リフレッシュ(shift+refresh)の場合、nullを返します。
3.4.2. ready
ready属性は以下の手順で実行しなければなりません:
-
thisのready promiseがnullの場合、thisのready promiseに新規promiseを設定する。
-
readyPromiseをthisのready promiseとする。
-
readyPromiseがpendingの場合、以下のサブステップを並列で実行:
-
clientをthisの サービスワークラクライアントとする。
-
storage keyをストレージキー取得でclientを引数に実行した結果とする。
-
registrationをサービスワーカー登録一致でstorage keyとclientの作成URLを引数に実行した結果とする。
-
registrationがnullでなく、registrationのactive workerがnullでない場合、DOM操作タスクソースでreadyPromiseの関連設定オブジェクトの責任イベントループにタスクをキューし、readyPromiseをregistrationを表すサービスワーカー登録オブジェクト取得の結果で解決する。
-
-
readyPromiseを返す。
注: 返されるready promiseはrejectされません。このアルゴリズムでresolveされない場合でも、該当するサービスワーカー登録が登録され、active workerが設定されると必ずresolveされます。(該当するActivateアルゴリズム参照)
3.4.3. register(scriptURL, options)
注: register(scriptURL, options)
メソッドは、指定されたscope
urlのサービスワーカー登録を新規作成または更新します。成功すると、提供されたscriptURLがscope
urlに関連付けられ、以後ナビゲーションマッチング(navigation matching)で使用されます。
register(scriptURL, options)
メソッド手順:
-
pをプロミスとする。
-
scriptURLに、
TrustedScriptURL、 thisの関連グローバルオブジェクト、 scriptURL、"ServiceWorkerContainer register"、および"script"を引数に、Get Trusted Type compliant stringを呼び出した結果を設定する。 -
clientに、thisのservice workerクライアントを設定する。
-
scriptURLに、thisの関連設定オブジェクトのAPI基準URLでscriptURLを構文解析した結果を設定する。
-
scopeURLをnullにする。
-
もしoptions["
scope"] が存在する場合、options["scope"] をthisの関連設定オブジェクトの API基準URLで構文解析した結果をscopeURLに設定する。 -
Start Registerを、 scopeURL、scriptURL、p、client、 clientの作成URL、 options["
type"], およびoptions["updateViaCache"] を引数として呼び出す。 -
pを返す。
3.4.4. getRegistration(clientURL)
getRegistration(clientURL)
メソッド手順:
-
clientを、thisのservice worker クライアントとする。
-
storage keyを、clientを与えてストレージキーを取得するの結果とする。
-
clientURLを、thisの関連設定オブジェクトのAPI 基準 URLでclientURLを構文解析した結果とする。
-
もしclientURLが failure なら、
TypeErrorで拒否されたpromiseを返す。 -
clientURLのフラグメントを null に設定する。
-
もしclientURLのオリジンがclientのオリジンと異なる場合、"
SecurityError"DOMExceptionで拒否されたpromiseを返す。 -
promiseを新しいpromiseとする。
-
次のサブステップを並列で実行する:
-
registrationを、storage keyおよびclientURLを与えてService Worker 登録のマッチを実行した結果とする。
-
もしregistrationが null なら、promiseを undefined で解決し、これらのステップを中止する。
-
promiseの関連設定オブジェクト内で registration を表すservice worker registration オブジェクトを取得するの結果で promiseを解決する。
-
-
promiseを返す。
3.4.5. getRegistrations()
getRegistrations()
メソッド手順:
-
clientをthisのサービスワークラクライアントとする。
-
client storage keyをストレージキー取得でclientを引数に実行した結果とする。
-
promiseを新規promiseとする。
-
以下の手順を並列で実行:
-
registrationsを新規リストとする。
-
各 (storage key, scope) → registration をregistration mapから反復:
-
DOM操作タスクソースでpromiseの関連設定オブジェクトの責任イベントループにタスクをキューして、以下を実行:
-
registrationObjectsを新規リストとする。
-
各 registrationをregistrationsで反復:
-
registrationObjをregistrationを表すサービスワーカー登録オブジェクト取得の結果とする。
-
append registrationObjをregistrationObjectsに追加。
-
-
promiseを新規frozen arrayでregistrationObjectsをpromiseの関連Realmで解決する。
-
-
-
promiseを返す。
3.4.6. startMessages()
startMessages()メソッドの手順は、thisのクライアントメッセージキューが有効でなければ有効化すること。
3.4.7. イベントハンドラー
以下はイベントハンドラー(および対応するイベントハンドラーイベントタイプ)であり、すべてのServiceWorkerContainer
インターフェース実装オブジェクトでイベントハンドラーIDL属性としてサポートしなければなりません:
| event handler | event handler event type |
|---|---|
oncontrollerchange
| controllerchange
|
onmessage
| message
|
onmessageerror
| messageerror
|
初めてonmessage
セッター手順が実行された時、thisのクライアントメッセージキューを有効化します。
3.5. イベント
以下のイベントは ServiceWorker
オブジェクト上で配送されます:
| イベント名 | インターフェース | 配送タイミング |
|---|---|---|
statechange
| Event
| state
属性が ServiceWorker
オブジェクトで変更されたとき。
|
以下のイベントは ServiceWorkerRegistration
オブジェクト上で配送されます:
| イベント名 | インターフェース | 配送タイミング |
|---|---|---|
updatefound
| Event
| サービスワーカー登録の installing worker が変更されたとき(Installアルゴリズムのステップ8参照)。 |
以下のイベントは ServiceWorkerContainer
オブジェクト上で配送されます:
| イベント名 | インターフェース | 配送タイミング |
|---|---|---|
controllerchange
| Event
| サービスワークラクライアントのアクティブサービスワーカーが変更されたとき(Activateアルゴリズムのステップ9.2参照。skip
waitingフラグ付きのサービスワーカーはactivationをサービスワーカー登録がサービスワークラクライアントに利用されている間に発生させ、navigator.serviceWorker.controller
は即座に active worker を、そのサービスワーカーが制御するサービスワークラクライアントとして即座に反映します。)
|
message
| Event
| サービスワークラクライアントがサービスワーカーからメッセージを受信したとき。postMessage(message, options)参照。
|
messageerror
| Event
| サービスワークラクライアントがサービスワーカーからデシリアライズできないメッセージを受信したとき。postMessage(message, options)参照。
|
3.6.
NavigationPreloadManager
[SecureContext ,Exposed =(Window ,Worker )]interface {NavigationPreloadManager Promise <undefined >enable ();Promise <undefined >disable ();Promise <undefined >setHeaderValue (ByteString );value Promise <NavigationPreloadState >getState (); };dictionary {NavigationPreloadState boolean =enabled false ;ByteString ; };headerValue
3.6.1. enable()
enable() メソッドの手順:
-
promiseを新規promiseとする。
-
以下の手順を並列で実行:
-
registrationをthisの関連付けられたサービスワーカー登録とする。
-
registrationのactive workerがnullの場合、promiseを "
InvalidStateError"DOMExceptionでrejectし、この手順を中断。 -
registrationのnavigation preload enabled flagを設定する。
-
promiseをundefinedでresolveする。
-
-
promiseを返す。
3.6.2. disable()
disable() メソッドの手順:
-
promiseを新規promiseとする。
-
以下の手順を並列で実行:
-
registrationをthisの関連付けられたサービスワーカー登録とする。
-
registrationのactive workerがnullの場合、promiseを "
InvalidStateError"DOMExceptionでrejectし、この手順を中断。 -
registrationのnavigation preload enabled flagを解除する。
-
promiseをundefinedでresolveする。
-
-
promiseを返す。
3.6.3. setHeaderValue(value)
setHeaderValue(value)
メソッドの手順:
-
promiseを新規promiseとする。
-
以下の手順を並列で実行:
-
registrationをthisの関連付けられたサービスワーカー登録とする。
-
registrationのactive workerがnullの場合、promiseを "
InvalidStateError"DOMExceptionでrejectし、この手順を中断。 -
registrationのnavigation preload header valueをvalueに設定する。
-
promiseをundefinedでresolveする。
-
-
promiseを返す。
3.6.4. getState()
getState() メソッドの手順:
-
promiseを新規promiseとする。
-
以下の手順を並列で実行:
-
registrationをthisの関連付けられたサービスワーカー登録とする。
-
stateを新規
NavigationPreloadState辞書とする。 -
registrationのnavigation preload enabled flagが設定されている場合、state["
enabled"]をtrueに設定する。 -
state["
headerValue"]をregistrationのnavigation preload header valueに設定する。 -
promiseをstateでresolveする。
-
-
promiseを返す。
4. 実行コンテキスト
// caching.js self. addEventListener( "install" , event=> { event. waitUntil( // リソースのキャッシュを開く。 caches. open( "shell-v1" ). then( cache=> { // それらの取得処理を開始する。全てのリソースが保存された場合のみ成功。 // 一つでも失敗すると、全体の操作は失敗となる。 return cache. addAll([ "/app.html" , "/assets/v1/base.css" , "/assets/v1/app.js" , "/assets/v1/logo.png" , "/assets/v1/intro_video.webm" ]); }) ); }); self. addEventListener( "fetch" , event=> { // Service Workerが正常にインストール・アクティベートされるまで、"fetch"イベントはディスパッチされない。 // キャッシュ操作は全て非同期で行われるため、URL照合を含めPromiseを多用する。e.respondWith()もPromiseを受け付ける: event. respondWith( caches. match( e. request). then( response=> { return response|| fetch( e. request); }). catch (() => { return caches. match( "/fallback.html" ); }) ); });
4.1. ServiceWorkerGlobalScope
[Global =(Worker ,ServiceWorker ),Exposed =ServiceWorker ,SecureContext ]interface :ServiceWorkerGlobalScope WorkerGlobalScope { [SameObject ]readonly attribute Clients clients ; [SameObject ]readonly attribute ServiceWorkerRegistration registration ; [SameObject ]readonly attribute ServiceWorker serviceWorker ; [NewObject ]Promise <undefined >skipWaiting ();attribute EventHandler oninstall ;attribute EventHandler onactivate ;attribute EventHandler onfetch ;attribute EventHandler onmessage ;attribute EventHandler onmessageerror ; };
ServiceWorkerGlobalScope
オブジェクトは、Service
Worker のグローバルな実行コンテキストを表します。
ServiceWorkerGlobalScope
オブジェクトは、関連付けられた service worker
(Service
Worker)を持ちます。
ServiceWorkerGlobalScope
オブジェクトには、import
scripts用キャッシュ強制バイパスフラグ が関連付けられています。初期状態では未設定です。
ServiceWorkerGlobalScope
オブジェクトには、race response
map が関連付けられています。これは 順序付きマップ であり、キー は リクエスト で、
値 は race response です。
race response
は、構造体
であり、"race-network-and-fetch-handler"
が実行された際のネットワークレスポンスを保持するために使われます。これは value(response、"pending" または null)を持ちます。
注: ServiceWorkerGlobalScope
オブジェクトは、オリジンで実行される汎用的なイベント駆動型・時間制限付きスクリプトの実行コンテキストを提供します。
正常に 登録 されると、
Service
Worker が起動し、
イベントとの関係によって存続・終了されます。 Service Workerクライアント との直接的な関係では存続しません。
Service Worker内で同期リクエストは開始しないでください。
4.1.1. clients
4.1.2. registration
registration のgetterは、
サービスワーカー登録オブジェクトの取得 の結果を返します。
これは this の
service worker の
含まれるService Worker登録 を
該当設定オブジェクト内で表します。
4.1.3. serviceWorker
serviceWorker のgetterは、
Service Workerオブジェクトの取得 の結果を返します。
これは this の
service worker を、
該当設定オブジェクト内で表します。
4.1.4. skipWaiting()
注: skipWaiting()
メソッドは、この Service Worker を、
登録 の waiting 状態から
active
状態へと進めることができます。
Service Workerクライアント
がその 登録 を
利用している最中でも実行可能です。
skipWaiting()
メソッドの手順:
-
promise を新しい Promise とする。
-
以下のサブステップを 並行して実行する:
-
service worker の skip waitingフラグ を設定する。
-
Try Activate を service worker の 含まれるService Worker登録 に対して呼び出す。
-
promise を undefined で解決する。
-
-
promise を返す。
4.1.5. イベントハンドラ
以下は、イベントハンドラ
(対応する イベント型)であり、
ServiceWorkerGlobalScope
インターフェースを実装する全てのオブジェクトで 必ず サポートされるべき
イベントハンドラIDL属性 です:
| イベントハンドラ | イベント型 |
|---|---|
oninstall
| install
|
onactivate
| activate
|
onfetch
| fetch
|
onmessage
| message
|
onmessageerror
| messageerror
|
4.2. Client
[Exposed =ServiceWorker ]interface {Client readonly attribute USVString url ;readonly attribute FrameType frameType ;readonly attribute DOMString id ;readonly attribute ClientType type ;undefined postMessage (any ,message sequence <object >);transfer undefined postMessage (any ,message optional StructuredSerializeOptions = {}); }; [options Exposed =ServiceWorker ]interface :WindowClient Client {readonly attribute VisibilityState visibilityState ;readonly attribute boolean focused ; [SameObject ]readonly attribute FrozenArray <USVString >ancestorOrigins ; [NewObject ]Promise <WindowClient >focus (); [NewObject ]Promise <WindowClient ?>navigate (USVString ); };url enum {FrameType ,"auxiliary" ,"top-level" ,"nested" };"none"
Client
オブジェクトには、関連付けられた service worker client
(service worker client)があります。
Client
オブジェクトには、関連付けられた frame
type(フレームタイプ)があり、"auxiliary"、"top-level"、"nested"、"none"
のいずれかです。特に記載がなければ "none" となります。
WindowClient
オブジェクトには、関連付けられた 閲覧コンテキスト(browsing
context)があり、これはその service worker client の グローバルオブジェクト の 閲覧コンテキストです。
WindowClient
オブジェクトは、visibility state(可視性状態)を持ちます。これはvisibilityState
属性値のいずれかです。
WindowClient
オブジェクトには、関連付けられた フォーカス状態(focus state)があり、true または false(初期値は
false)です。
WindowClient
オブジェクトには、関連付けられた 先祖オリジン配列(ancestor origins
array)があります。
4.2.1.
url
url のgetter手順は、this に関連付けられた service worker client の 直列化された 作成URL を返します。
4.2.2.
frameType
frameType のgetter手順は、this の frame type を返します。
4.2.3.
id
id のgetter手順は、this に関連付けられた service worker client の id を返します。
4.2.4.
type
type のgetter手順:
-
client を this の service worker client とする。
-
client が environment settings object なら:
-
client が window client なら
"window"を返す。 -
そうでなく、client が dedicated worker client なら
"worker"を返す。 -
さらにそうでなく、client が shared worker client なら
"sharedworker"を返す。
-
-
それ以外の場合:
-
"window"を返す。
-
4.2.5.
postMessage(message, transfer)
postMessage(message, transfer)
メソッドの手順:
-
options を «[ "transfer" → transfer ]» とする。
-
postMessage(message, options)を message と options を引数として呼び出す。
4.2.6. postMessage(message, options)
postMessage(message, options)
メソッドの手順:
-
contextObject を this とする。
-
sourceSettings を contextObject の 該当設定オブジェクト とする。
-
serializeWithTransferResult を StructuredSerializeWithTransfer(message, options["
transfer"]) とする。例外は再スローする。 -
以下の手順を 並行して実行する:
-
targetClient を null とする。
-
各 service worker client client について:
-
client が contextObject の service worker client であれば、targetClient に client を設定し、break する。
-
-
targetClient が null なら return。
-
destination を、関連する service worker client が targetClient である
ServiceWorkerContainerオブジェクトとする。 -
destination の client message queue に、次の手順を実行するタスクを追加する:
-
source を、service workerオブジェクトの取得の結果とし、これは contextObject の 該当グローバルオブジェクト の service worker を targetClient で表す。
-
deserializeRecord を StructuredDeserializeWithTransfer(serializeWithTransferResult, destination の 該当Realm) とする。
例外が発生した場合、それをキャッチし、
messageerrorイベントを destination でMessageEventを使って発火し、origin属性を origin で、source属性を source で初期化し、その後これらの手順を中止する。 -
messageClone を deserializeRecord.[[Deserialized]] とする。
-
newPorts を、deserializeRecord.[[TransferredValues]] 内の全ての
MessagePortオブジェクトからなる新しい frozen array とする(もしあれば)。 -
messageイベントを destination でMessageEventを使って発火し、origin属性を origin で、source属性を source で、data属性を messageClone で、ports属性を newPorts で初期化する。
-
4.2.7. visibilityState
4.2.8.
focused
4.2.9. ancestorOrigins
4.2.10.
focus()
focus() メソッド手順:
-
この オリジン に
Windowが一つも 一時的なアクティベーション を持たない場合、"InvalidAccessError"DOMExceptionで拒否された promise を返す。 -
promise を新しい promise とする。
-
タスクをキューに入れる。次の手順を this に関連付けられた service worker client の 責任イベントループ上で ユーザー操作タスクソース を使って実行する:
-
frameType を Get Frame Type を this の 閲覧コンテキスト で実行した結果とする。
-
visibilityStateを、thisの ブラウジングコンテキストの アクティブドキュメントの
visibilityState属性値とする。 -
focusState を has focus手順 を this の 閲覧コンテキスト の アクティブドキュメント に対して実行した結果とする。
-
ancestorOriginsList を this の 閲覧コンテキスト の アクティブドキュメント の 該当グローバルオブジェクト の
Locationオブジェクトの 先祖オリジンリスト の関連リストとする。 -
タスクをキューに入れる。次の手順を serviceWorkerEventLoop 上で DOM操作タスクソース を使って実行する:
-
windowClient を Create Window Client に this に関連付けられた service worker client、frameType、visibilityState、focusState、ancestorOriginsList を渡して実行した結果とする。
-
windowClient の フォーカス状態 が true なら、promise を windowClient で解決する。
-
そうでなければ、promise を
TypeErrorで拒否する。
-
-
promise を返す。
4.2.11.
navigate(url)
navigate(url) メソッド手順:
-
url を パース した結果とし、this の 該当設定オブジェクト の APIベースURL を使う。
-
url が失敗の場合、
TypeErrorで拒否された promise を返す。 -
url が
about:blankの場合、TypeErrorで拒否された promise を返す。 -
this に関連付けられた service worker client の active service worker が this の 該当グローバルオブジェクト の service worker でない場合、
TypeErrorで拒否された promise を返す。 -
serviceWorkerEventLoop を 現在のグローバルオブジェクト の イベントループ とする。
-
promise を新しい promise とする。
-
タスクをキューに入れる。次の手順を this に関連付けられた service worker client の 責任イベントループ上で ユーザー操作タスクソース を使って実行する:
-
browsingContext の 関連ドキュメント が 完全アクティブ でない場合、タスクをキューに入れる。promise を
TypeErrorで serviceWorkerEventLoop 上の DOM操作タスクソース で拒否し、これらの手順を中止する。 -
HandleNavigate: ナビゲート browsingContext を url へ、browsingContext の 関連ドキュメント を使い、例外有効 を true とする。
-
HandleNavigate ラベル付きのアルゴリズム手順が 例外 を投げた場合、タスクをキューに入れる。promise を例外で serviceWorkerEventLoop 上の DOM操作タスクソース で拒否し、これらの手順を中止する。
-
frameType を Get Frame Type を browsingContext で実行した結果とする。
-
visibilityStateをbrowsingContextのアクティブドキュメントの
visibilityState属性値とする。 -
focusStateを、has focus 手順を browsingContextのアクティブドキュメントで実行した結果とする。
-
ancestorOriginsListをbrowsingContextのアクティブドキュメントの関連グローバルオブジェクトの
Locationオブジェクトのancestor origins listに関連付けられたリストとする。 -
タスクをキューに入れる。次の手順を serviceWorkerEventLoop 上で DOM操作タスクソース を使って実行する:
-
browsingContext の
Windowオブジェクトの environment settings object の 作成URL の origin が 同一 でない場合、service worker の origin と、promise を null で解決し、これらの手順を中止する。 -
windowClient を Create Window Client に this の service worker client、frameType、visibilityState、focusState、ancestorOriginsList を渡して実行した結果とする。
-
promise を windowClient で解決する。
-
-
promise を返す。
4.3.
Clients
[Exposed =ServiceWorker ]interface { // The objects returned will be new instances every time [Clients NewObject ]Promise <(Client or undefined )>get (DOMString ); [id NewObject ]Promise <FrozenArray <Client >>matchAll (optional ClientQueryOptions = {}); [options NewObject ]Promise <WindowClient ?>openWindow (USVString ); [url NewObject ]Promise <undefined >claim (); };
dictionary {ClientQueryOptions boolean =includeUncontrolled false ;ClientType = "window"; };type
enum {ClientType ,"window" ,"worker" ,"sharedworker" };"all"
ユーザーエージェントは ServiceWorkerGlobalScope
オブジェクトが作成されるとき、必ず Clients
オブジェクトを作成し、そのオブジェクトに関連付けなければならない。
4.3.1.
get(id)
get(id) メソッドの手順:
-
promise を新しい promise とする。
-
以下のサブステップを 並行して実行する:
-
各 service worker client client について、ストレージキーの取得 の結果が、関連する service worker の 含まれるService Worker登録 の ストレージキー と等しい場合:
-
promise を undefined で解決する。
-
-
promise を返す。
4.3.2.
matchAll(options)
matchAll(options) メソッドの手順:
-
promise を 新しいpromise とする。
-
以下の手順を 並行して実行する:
-
targetClients を新しい リスト とする。
-
各 service worker client client について、ストレージキーの取得 の結果が、関連する service worker の 含まれるService Worker登録 の ストレージキー と等しい場合:
-
client の 実行準備フラグ が未設定、または client の 破棄フラグ が設定されている場合、continue。
-
client が セキュアコンテキスト でない場合、continue。
-
options["
includeUncontrolled"] が false であり、かつ client の active service worker が関連 service worker でない場合、continue。 -
client を targetClients に追加する。
-
-
matchedWindowData を新しい リスト とする。
-
matchedClients を新しい リスト とする。
-
targetClients 内の各 service worker client client について:
-
options["
type"] が"window"または"all"であり、 client が environment settings object でない、または window client である場合:-
windowData を «[ "client" → client, "ancestorOriginsList" → 新しい リスト ]» とする。
-
browsingContext を null とする。
-
isClientEnumerable を true とする。
-
client が environment settings object なら、browsingContext を client の グローバルオブジェクト の 閲覧コンテキスト とする。
-
そうでなければ、browsingContext を client の ターゲット閲覧コンテキスト とする。
-
タスクをキューに入れる。以下のサブステップを browsingContext の イベントループ で ユーザー操作タスクソース を使って実行する:
-
browsingContext が 破棄済み なら、isClientEnumerable を false にしてこれらの手順を中止する。
-
client がwindow clientかつ client の 関連ドキュメント が browsingContext の アクティブドキュメント でない場合、isClientEnumerable を false にしてこれらの手順を中止する。
-
windowData["
frameType"] に Get Frame Type を browsingContext で実行した結果を設定する。 -
windowData["
visibilityState"] に browsingContext の アクティブドキュメント のvisibilityState属性値を設定する。 -
windowData["
focusState"] に has focus手順 を browsingContext の アクティブドキュメント に対して実行した結果を設定する。 -
client が window client なら、 windowData["
ancestorOriginsList"] に browsingContext の アクティブドキュメント の 該当グローバルオブジェクト のLocationオブジェクトの 先祖オリジンリスト の関連リストを設定する。
-
-
task が実行されるまで待つ。
注: 待機はブロッキングだが、実装者は状態が壊れない限り並行して反復処理できる。
-
isClientEnumerable が true なら:
-
windowData を matchedWindowData に追加する。
-
-
-
そうでなく options["
type"] が"worker"または"all"かつ client が dedicated worker client の場合、あるいは options["type"] が"sharedworker"または"all"かつ client が shared worker client の場合:-
client を matchedClients に追加する。
-
-
-
タスクをキューに入れる。以下の手順を promise の 該当設定オブジェクト の 責任イベントループ で DOM操作タスクソース を使って実行する:
-
clientObjects を新しい リスト とする。
-
各 windowData について、matchedWindowData 内で:
-
windowClient を Create Window Client アルゴリズムを windowData["
client"], windowData["frameType"], windowData["visibilityState"], windowData["focusState"], windowData["ancestorOriginsList"] で実行した結果とする。 -
windowClient を clientObjects に追加する。
-
-
各 client について、matchedClients 内で:
-
clientObject を Create Client アルゴリズムを client で実行した結果とする。
-
clientObject を clientObjects に追加する。
-
-
clientObjects を以下のようにソートする:
-
WindowClientオブジェクトでその 閲覧コンテキスト が フォーカスされたものは先頭に、最新の フォーカス順で並ぶ。 -
WindowClientオブジェクトでその 閲覧コンテキスト が一度も フォーカスされていないものは次に、service worker client の生成順で並ぶ。 -
Clientオブジェクトで関連する service worker client が worker client のものはその後、service worker client の生成順で並ぶ。
注: window client は常に worker client より先に配置される。
-
-
promise を clientObjectsの新しいFrozenArray で promise の 該当Realm で解決する。
-
-
-
promise を返す。
4.3.3.
openWindow(url)
openWindow(url) メソッドの手順:
-
url を パースした結果とし、this の 該当設定オブジェクト の APIベースURL を使う。
-
url が失敗の場合、
TypeErrorで拒否された promise を返す。 -
url が
about:blankの場合、TypeErrorで拒否された promise を返す。 -
この オリジン に
Windowが一つも 一時的なアクティベーション を持たない場合、"InvalidAccessError"DOMExceptionで拒否された promise を返す。 -
serviceWorkerEventLoop を 現在のグローバルオブジェクト の イベントループ とする。
-
promise を新しい promise とする。
-
以下のサブステップを 並行して実行する:
-
newContext を新しい トップレベル閲覧コンテキスト とする。
-
タスクをキューに入れる。以下の手順を newContext の
Windowオブジェクトの environment settings object の 責任イベントループ で ユーザー操作タスクソース を使って実行する:-
HandleNavigate: ナビゲート newContext を url へ、例外有効 を true、historyHandling を "
replace" とする。 -
HandleNavigate ラベル付きのアルゴリズム手順が 例外 を投げた場合、タスクをキューに入れる。promise を例外で serviceWorkerEventLoop 上の DOM操作タスクソース で拒否し、これらの手順を中止する。
-
frameType を Get Frame Type を newContext で実行した結果とする。
-
visibilityStateをnewContextのアクティブドキュメントの
visibilityState属性値とする。 -
focusStateを、has focus 手順をnewContextのアクティブドキュメントを引数として実行した結果とする。
-
ancestorOriginsListを、newContextのアクティブドキュメントの関連グローバルオブジェクトの
Locationオブジェクトのancestor origins listに関連付けられたリストとする。 -
タスクをキューに入れる。以下の手順を serviceWorkerEventLoop 上で DOM操作タスクソース を使って実行する:
-
newContext の
Windowオブジェクトの environment settings object の ストレージキーの取得 の結果が、equal でない場合、service worker の 含まれるService Worker登録 の ストレージキー と、promise を null で解決し、これらの手順を中止する。 -
client を Create Window Client に newContext の
Windowオブジェクトの environment settings object、frameType、visibilityState、focusState、ancestorOriginsList を渡して実行した結果とする。 -
promise を client で解決する。
-
-
-
-
promise を返す。
4.3.4.
claim()
claim() メソッドの手順:
-
service worker が アクティブワーカー でない場合、"
InvalidStateError"DOMExceptionで拒否された promise を返す。 -
promise を新しい promise とする。
-
以下のサブステップを 並行して実行する:
-
各 service worker client client について、ストレージキーの取得 の結果が、equal である場合、service worker の 含まれるService Worker登録 の ストレージキー と等しい場合:
-
client の 実行準備フラグ が未設定、または client の 破棄フラグ が設定されている場合、continue。
-
client が セキュアコンテキスト でない場合、continue。
-
storage key を ストレージキーの取得 を client で実行した結果とする。
-
registration を Match Service Worker Registration を storage key と client の 作成URL で実行した結果とする。
-
registration が service worker の 含まれるService Worker登録 でない場合、continue。
注: registration は、service worker の 含まれるService Worker登録 が 登録解除済み の場合、null になる。
-
client の active service worker が service worker でない場合、以下を実行する:
-
Handle Service Worker Client Unload を client で呼び出す。
-
client の active service worker を service worker に設定する。
-
Notify Controller Change アルゴリズムを client で呼び出す。
-
-
-
promise を undefined で解決する。
-
-
promise を返す。
4.4.
ExtendableEvent
[Exposed =ServiceWorker ]interface :ExtendableEvent Event {(constructor DOMString ,type optional ExtendableEventInit = {});eventInitDict undefined waitUntil (Promise <any >); };f
dictionary :ExtendableEventInit EventInit { // Defined for the forward compatibility across the derived events };
ExtendableEvent
オブジェクトは、関連付けられた extend lifetime
promises(存続期間拡張promise群)(promiseの配列)を持ちます。初期値は空配列です。
ExtendableEvent
オブジェクトは、関連付けられた pending promises
count(保留中promise数)(extend lifetime
promisesの中で保留中のpromise数)を持ちます。初期値は0です。
ExtendableEvent
オブジェクトは、関連付けられた timed out flag(タイムアウトフラグ)
を持ちます。これは初期状態では未設定であり、pending promises count
が0より大きい場合、ユーザーエージェントが任意で遅延をかけた後に設定されます。
ExtendableEvent
オブジェクトは、timed out flag が未設定であり、かつpending promises count が0より大きい、またはdispatch flag が設定されている場合、active(有効)であると言います。
Service
Worker には2つのライフサイクルイベント(install
と activate)があります。
Service
Worker は、ExtendableEvent
インターフェースを install
および activate
イベントで利用します。
Service Worker拡張でイベントハンドラを定義するものも、ExtendableEvent
インターフェースを利用または拡張することができます。
4.4.1.
event.waitUntil(f)
注: waitUntil()
メソッドはイベントの存続期間を延長します。
waitUntil(f)
メソッドの手順は、lifetime promiseの追加 f を this に対して行うことです。
ExtendableEvent)に対して行う手順:
-
event の
isTrusted属性がfalseの場合、"InvalidStateError"DOMExceptionをthrowする。 -
event が active でない場合、"
InvalidStateError"DOMExceptionをthrowする。注: イベントハンドラを呼び出したタスク内でlifetime extension promiseが追加されていない場合、後続の非同期タスクで
waitUntil()を呼ぶと例外となります。 -
promise を event の extend lifetime promises に追加する。
-
event の pending promises count を1増加させる。
注: 渡されたpromiseが既に解決済みでもpending promises countは加算されます。減算はpromiseのreactionでマイクロタスクがキューされる際に行われます。
-
fulfillment または rejection が発生したら、マイクロタスクをキューして以下のサブステップを実行する:
-
event の pending promises count を1減らす。
-
event の pending promises count が0なら:
-
registration を 現在のグローバルオブジェクト の関連 service worker の 含まれるService Worker登録 とする。
-
registration が 登録解除済み なら、Try Clear Registration を registration で呼ぶ。
-
registration が null でない場合、Try Activate を registration で呼ぶ。
-
-
ユーザーエージェントは、Service Worker Has No Pending Events がその service worker に対してfalseを返す場合、service workerの終了 をすべきではないです。
Service Workerや、拡張でイベントハンドラを定義するものは、独自の挙動を定義してもよいです。これにより、extend lifetime promisesによって処理時間を示唆したり、extend lifetime promises内のいずれかのPromiseがrejected状態であれば処理失敗を示唆できます。
注: Service Workerは、installing workerを「installed」として扱うのを、installイベントのextend lifetime promises内のすべてのPromiseが正常に解決されるまで遅延します。(該当のInstallアルゴリズム手順を参照。)Promiseのいずれかがrejectされた場合、インストールは失敗します。これは主に、Service
Workerが依存するコアキャッシュがすべて準備されるまで「installed」と見なされないようにするために使われます。同様に、Service
Workerは、active workerを「activated」として扱うのを、activateイベントのextend lifetime promises内のすべてのPromiseが決着(resolveまたはreject)するまで遅延します。(該当のActivateアルゴリズム手順を参照。)これは主に、ファンクショナルイベントがService
Workerへ送信される前に、データベーススキーマのアップグレードや古いキャッシュエントリの削除が完了することを保証するために利用されます。
4.5.
InstallEvent
[Exposed =ServiceWorker ]interface :InstallEvent ExtendableEvent {(constructor DOMString ,type optional ExtendableEventInit = {});eventInitDict Promise <undefined >addRoutes ((RouterRule or sequence <RouterRule >)); };rules dictionary {RouterRule required RouterCondition ;condition required RouterSource ; };source dictionary {RouterCondition URLPatternCompatible ;urlPattern ByteString ;requestMethod RequestMode ;requestMode RequestDestination ;requestDestination RunningStatus ;runningStatus sequence <RouterCondition >;_or RouterCondition ; };not typedef (RouterSourceDict or RouterSourceEnum );RouterSource dictionary {RouterSourceDict DOMString ; };cacheName enum {RunningStatus ,"running" };"not-running" enum {RouterSourceEnum ,"cache" ,"fetch-event" ,"network" };"race-network-and-fetch-handler"
count router condition result(ルーター条件結果のカウント)は、次からなる構造体です:
-
condition count(条件数)(数値)。
-
quota exceeded(クォータ超過)(真偽値)。
4.5.1. event.addRoutes(rules)
注: addRoutes(rules)
は、このサービスワーカーでfetchイベントハンドラが通常行う単純なタスクを分担するためのルールを登録します。
addRoutes(rules)
メソッドの手順:
-
rules が
RouterRule辞書のときは、rules を « rules » に設定する。 -
serviceWorker を 現在のグローバルオブジェクト の関連 service worker とする。
-
rules の各 rule について:
-
Verify Router Condition アルゴリズムを rule["
condition"] と serviceWorker で実行して false なら、promiseで拒否し、TypeErrorを返す。 -
rule["
source"] が "fetch-event" または "race-network-and-fetch-handler" のいずれかで、 serviceWorker の 処理するイベント型の集合 が fetch イベントを含んでいなければ、 promiseで拒否し、TypeErrorを返す。
-
-
lifetimePromise を新しい promise とする。
-
lifetime promiseの追加 lifetimePromise を this に対して行う。
注:
event.addRoutes(rules)はevent.waitUntil(promise)が呼ばれるのと同様に、デフォルトでイベントの存続期間を延長します。 -
promise を新しい promise とする。
-
fulfillment または rejection が promise で発生したら、 lifetimePromise を undefined で解決する。
注: このステップは install イベント失敗を避けるため、lifetimePromise を必ずfulfilledにします。
-
以下の手順をエンキューして [[service worker queue]] で実行する:
-
allRules を serviceWorker の ルーター規則リスト のコピーとする。
-
rules の各 rule について:
-
rule を allRules に追加する。
-
-
Check Router Registration Limit を allRules に対して実行して false なら、promise を
TypeErrorで拒否する。 -
serviceWorker の ルーター規則リスト を allRules に設定する。
-
serviceWorkerEventLoop を 現在のグローバルオブジェクト の イベントループ とする。
-
タスクをキューに入れる。以下の手順を serviceWorkerEventLoop 上で DOM操作タスクソース を使って実行する:
-
promise を undefined で解決する。
-
-
-
promise を返す。
4.6.
FetchEvent
[Exposed =ServiceWorker ]interface :FetchEvent ExtendableEvent {(constructor DOMString ,type FetchEventInit ); [eventInitDict SameObject ]readonly attribute Request request ;readonly attribute Promise <any >preloadResponse ;readonly attribute DOMString clientId ;readonly attribute DOMString resultingClientId ;readonly attribute DOMString replacesClientId ;readonly attribute Promise <undefined >handled ;undefined respondWith (Promise <Response >); };r
dictionary :FetchEventInit ExtendableEventInit {required Request ;request Promise <any >;preloadResponse DOMString = "";clientId DOMString = "";resultingClientId DOMString = "";replacesClientId Promise <undefined >; };handled
ServiceWorker には重要な機能的イベント fetch
があります。
fetch
イベントでは、ServiceWorker は FetchEvent
インターフェースを利用し、これは ExtendableEvent
インターフェースを拡張します。
FetchEvent
インターフェースを使用する各イベントには、関連付けられた potential response(潜在的レスポンス)(response)があり、初期値はnullです。また、初期状態で未設定の以下のフラグを持ちます:
-
wait to respond flag(応答待ちフラグ)
-
respond-with entered flag(respondWith実行済みフラグ)
-
respond-with error flag(respondWithエラーフラグ)
4.6.1.
event.request
request 属性は、初期化時に設定された値を返すべきです。
4.6.2. event.preloadResponse
preloadResponse
属性は、初期化時に設定された値を返すべきです。イベントが作成されたとき、この属性は undefinedで解決されたpromise に初期化すべきです。
4.6.3.
event.clientId
clientId
属性は、初期化時に設定された値を返すべきです。イベントが作成されたとき、この属性は空文字列に初期化すべきです。
4.6.4. event.resultingClientId
resultingClientId
属性は、初期化時に設定された値を返すべきです。イベントが作成されたとき、この属性は空文字列に初期化すべきです。
4.6.5. event.replacesClientId
replacesClientId
属性は、初期化時に設定された値を返すべきです。イベントが作成されたとき、この属性は空文字列に初期化すべきです。
4.6.6.
event.handled
handled
属性は、初期化時に設定された値を返すべきです。イベントが作成されたとき、この属性はpendingな promise で初期化すべきです。
4.6.7. event.respondWith(r)
注: 開発者は引数 r に promise(Response
オブジェクトで解決される)または Response
オブジェクト(自動的にpromiseへ変換)を指定できます。それ以外の場合は ネットワークエラー が Fetch
に返されます。
レンダラー側のクロスオリジンコンテンツの汚染に関するセキュリティチェックは、filtered response の型に依存します。
respondWith(r) メソッドの手順:
-
event を this とする。
-
event の dispatch flag が未設定なら、"
InvalidStateError"DOMExceptionをthrowする。 -
event の respond-with entered flag が 設定済みなら、"
InvalidStateError"DOMExceptionをthrowする。 -
lifetime promiseの追加 r を event に対して行う。
注:
event.respondWith(r)はevent.waitUntil(r)を呼ぶのと同様に、デフォルトでイベントの存続期間を延長します。 -
event の stop propagation flag および stop immediate propagation flag を設定する。
-
event の respond-with entered flag を設定する。
-
event の wait to respond flag を設定する。
-
targetRealm を event の relevant Realm とする。
-
-
event の respond-with error flag を設定する。
-
event の wait to respond flag を解除する。
-
-
rのfulfillment時、response で:
-
response が
Responseオブジェクトでない場合、respond-with error flag を設定する。注: respond-with error flag が設定された場合、 ネットワークエラー が Fetch の Handle Fetch アルゴリズムを通じて返されます(ステップ21.1参照)。そうでなければ、値 response が Fetch の Handle Fetch アルゴリズムを通じて返されます(ステップ22.1参照)。
-
それ以外の場合:
-
bytes を空のバイト列とする。
-
end-of-body をfalseとする。
-
done をfalseとする。
-
potentialResponse を response の関連付けられた response のコピーとし、body を除く。
-
response の body がnullでない場合、以下のサブステップを実行:
-
pullAlgorithm を以下を行うactionとする:
-
readRequest を新しい read request とし、以下の item を持つ:
- chunk steps(chunkを受け取る)
-
-
アサート:chunk は
Uint8Arrayである。 -
chunk で表されるバイトを bytes に追加する。
-
potentialResponse の body info の encoded size を bytes の byte length だけ増加させる。
-
potentialResponse の body info の decoded size を bytes の byte length だけ増加させる。
-
! DetachArrayBuffer(chunk.[[ViewedArrayBuffer]]) を実行する。
-
- close steps
-
-
end-of-body をtrueにする。
-
- error steps
-
read a chunk を reader に readRequest を与えて実行する。
-
-
cancelAlgorithm を readerのキャンセルアクションとする。
-
highWaterMark を非負・非NaNな数値(ユーザーエージェントが決定)とする。
-
sizeAlgorithm を chunk オブジェクトを受け取り、非負・非NaN・無限大でない値を返すアルゴリズム(ユーザーエージェントが決定)とする。
-
newStream を新しい
ReadableStreamとし、set up で pullAlgorithm pullAlgorithm、cancelAlgorithm cancelAlgorithm、highWaterMark highWaterMark、sizeAlgorithm sizeAlgorithm を targetRealm でセットアップする。 -
potentialResponse の body を新しい body とし、その stream を newStream にする。
-
以下を 並行して done がfalseの間繰り返す:
-
newStream が errored なら、done をtrueにする。
-
それ以外で bytes が空かつ end-of-body がtrueなら、close newStream、done をtrueにする。
-
それ以外で bytes が空でない場合、以下のサブサブサブステップを実行:
-
chunk を bytes の先頭からの部分列とする。
-
chunk を bytes から除去する。
-
buffer を targetRealm で作られた
ArrayBufferオブジェクトで、chunk を含むものとする。 -
enqueue を targetRealm で作られた
Uint8Arrayオブジェクトで buffer をラップし、newStream に追加する。
-
-
注: これらのサブステップは response の body の stream を potentialResponse に「パイプ」する観測可能な同等物を生成するためのものです。
注: ServiceWorkerがチャンクで書き込んだデータは、受け取ったクライアントが必ずしも同じチャンクで読むとは限りません。つまり、クライアントは同じ内容を読むが、ブラウザによってチャンク分割方法が異なる場合があります。
-
event の potential response を potentialResponse に設定する。
-
-
event の wait to respond flag を解除する。
-
4.7. ExtendableMessageEvent
[Exposed =ServiceWorker ]interface :ExtendableMessageEvent ExtendableEvent {(constructor DOMString ,type optional ExtendableMessageEventInit = {});eventInitDict readonly attribute any data ;readonly attribute USVString origin ;readonly attribute DOMString lastEventId ; [SameObject ]readonly attribute (Client or ServiceWorker or MessagePort )?source ;readonly attribute FrozenArray <MessagePort >ports ; };
dictionary :ExtendableMessageEventInit ExtendableEventInit {any =data null ;USVString = "";origin DOMString = ""; (lastEventId Client or ServiceWorker or MessagePort )?=source null ;sequence <MessagePort >= []; };ports
ServiceWorker は extendable
message
イベントを定義し、イベントの存続期間を延長できるようにします。message
イベントでは、ServiceWorker は ExtendableMessageEvent
インターフェースを利用し、これは ExtendableEvent
インターフェースを拡張します。
4.7.1. event.data
data
属性は、初期化時に設定された値を返すべきです。オブジェクト生成時にはこの属性はnullで初期化すべきです。送信されるメッセージを表します。
4.7.2. event.origin
origin
属性は、初期化時に設定された値を返すべきです。オブジェクト生成時にはこの属性は空文字列で初期化すべきです。これはメッセージを送信したオリジンを表します。
4.7.3. event.lastEventId
lastEventId
属性は、初期化時に設定された値を返すべきです。オブジェクト生成時にはこの属性は空文字列で初期化すべきです。
4.7.4. event.source
source
属性は、初期化時に設定された値を返すべきです。オブジェクト生成時にはこの属性はnullで初期化すべきです。これはメッセージを送信した Client
オブジェクトを表します。
4.7.5. event.ports
ports
属性は、初期化時に設定された値を返すべきです。オブジェクト生成時にはこの属性は空配列で初期化すべきです。これは送信される MessagePort
配列を表します。
4.8. イベント
以下のイベントは ServiceWorkerイベント と呼ばれ、ServiceWorkerGlobalScope
オブジェクト上でdispatchされます:
| イベント名 | インターフェイス | カテゴリ | 発火タイミング |
|---|---|---|---|
install
| InstallEvent
| ライフサイクル | Service Workerの 所属する Service Worker 登録の installing workerが変化したときに発火します。 (Installアルゴリズム ステップ11.2参照) |
activate
| ExtendableEvent
| ライフサイクル | Service Workerの 所属する Service Worker 登録の active workerが変化したときに発火します。 (Activateアルゴリズム ステップ12.2参照) |
fetch
| FetchEvent
| ファンクショナル | HTTP フェッチが
Handle
Fetch(request付き)を呼び出した際に発火します。
Handle
Fetchの実行後、Service WorkerはレスポンスをHTTP フェッチへ返します。その
レスポンス(Response
オブジェクトで表現)は、Cacheオブジェクトや、
self.fetch(input, init)
を利用してネットワークから直接取得できます。(カスタムResponseも指定可能です。)
|
| push | PushEvent
| ファンクショナル | (pushイベント発火処理参照) |
| notificationclick | NotificationEvent
| ファンクショナル | (通知アクティベート処理参照) |
| notificationclose | NotificationEvent
| ファンクショナル | (通知クローズ処理参照) |
| sync | SyncEvent
| ファンクショナル | (syncイベント発火処理参照) |
| canmakepayment | CanMakePaymentEvent | ファンクショナル | (CanMakePaymentEventハンドリング参照) |
| paymentrequest | PaymentRequestEvent | ファンクショナル | (PaymentRequestEventハンドリング参照) |
message
| ExtendableMessageEvent
| レガシー | メッセージ受信時 |
messageerror
| MessageEvent
| レガシー | デシリアライズできないメッセージを受信した時 |
5. キャッシュ
著者がオフライン利用のためにコンテンツキャッシュを完全に管理できるよう、Window
および WorkerGlobalScope
は、Cache
オブジェクトを開いて操作できる非同期キャッシュメソッドを提供します。オリジンごとに複数の名前付き Cache
オブジェクトを持つことができ、その内容は完全にスクリプトで制御できます。キャッシュは オリジン間で共有されず、ブラウザのHTTPキャッシュとも完全に分離されています。
5.1. 構成要素
リクエスト・レスポンスリストは、リストであり、タプル(リクエストとレスポンス)で構成されます。
関連リクエスト・レスポンスリストは、thisが表すインスタンスです。
名前 → キャッシュマップは、順序付きマップであり、エントリーは キー (リクエスト・レスポンスリストの名前を表す文字列)と 値 (リクエスト・レスポンスリスト)で構成されます。
CacheStorage
オブジェクトの 該当する name to cache map とは、
そのオブジェクトの 関連設定オブジェクト と "caches" を使って
ローカルストレージボトルマップを取得 を実行した結果に紐付けられた
name to
cache map である。
5.2. キャッシュの寿命の理解
Cache
インスタンスはブラウザのHTTPキャッシュとは無関係です。Cache
オブジェクトは著者が自ら管理するものです。Cache
オブジェクトは、著者が明示的に更新を要求しない限り更新されません。Cache
オブジェクトは、著者がエントリーを削除しない限り期限切れになりません。Cache
オブジェクトは、ServiceWorkerスクリプトが更新されても消えません。つまり、キャッシュは自動で更新されません。更新は手動で管理する必要があります。したがって、著者はキャッシュ名でバージョン管理し、ServiceWorkerの安全に操作できるバージョンのキャッシュのみ利用するようにしてください。
5.3. self.caches
partial interface mixin WindowOrWorkerGlobalScope { [SecureContext ,SameObject ]readonly attribute CacheStorage caches ; };
5.3.1.
caches
caches
のgetter手順は、thisの関連付けられたCacheStorageオブジェクトを返します。
5.4. Cache
[SecureContext ,Exposed =(Window ,Worker )]interface { [Cache NewObject ]Promise <(Response or undefined )>match (RequestInfo ,request optional CacheQueryOptions = {}); [options NewObject ]Promise <FrozenArray <Response >>matchAll (optional RequestInfo ,request optional CacheQueryOptions = {}); [options NewObject ]Promise <undefined >add (RequestInfo ); [request NewObject ]Promise <undefined >addAll (sequence <RequestInfo >); [requests NewObject ]Promise <undefined >put (RequestInfo ,request Response ); [response NewObject ]Promise <boolean >delete (RequestInfo ,request optional CacheQueryOptions = {}); [options NewObject ]Promise <FrozenArray <Request >>keys (optional RequestInfo ,request optional CacheQueryOptions = {}); };options
dictionary {CacheQueryOptions boolean =ignoreSearch false ;boolean =ignoreMethod false ;boolean =ignoreVary false ; };
Cache
オブジェクトは、リクエスト・レスポンスリストを表します。複数のドキュメントやワーカー間で Cache
インターフェースを実装する別々のオブジェクトが、同じ リクエスト・レスポンスリスト に関連付けられる場合もあります。
キャッシュバッチ操作は、構造体であり、次の要素からなります:
-
type(種類)("
delete" または "put")。 -
request(リクエスト)(リクエスト)。
-
response(レスポンス)(レスポンス)。
-
options(オプション)(
CacheQueryOptions)。
5.4.1.
match(request, options)
match(request, options)
メソッドの手順:
-
promise を 新しいpromise とする。
-
以下のサブステップを 並行して実行する:
-
p を
matchAll(request, options)メソッド(requestとoptionsを渡す)で実行したアルゴリズムの結果とする。 -
p がsettleするまで待つ。
-
p が例外でrejectされたら:
-
promise をその例外でrejectする。
-
-
p が配列responsesでresolveされた場合:
-
responses が空配列の場合:
-
promise をundefinedでresolveする。
-
-
それ以外の場合:
-
promise をresponsesの最初の要素でresolveする。
-
-
-
-
promise を返す。
5.4.2.
matchAll(request, options)
matchAll(request, options)
メソッドの手順:
-
r をnullとする。
-
オプション引数requestが省略されていない場合:
-
request が
Requestオブジェクトなら:-
r を request の request とする。
-
r の method が `
GET` でなく、かつ options.ignoreMethod がfalseなら、空配列でresolveされたpromise を返す。
-
-
そうでなくrequestが文字列なら:
-
r を request を引数として
Requestのコンストラクタを呼び出した結果の関連 request とする。例外が発生したら その例外でrejectされたpromise を返す。
-
-
-
promise を 新しいpromise とする。
-
以下のサブステップを 並行して実行する:
-
responses を空の リスト とする。
-
オプション引数requestが省略されている場合:
-
各 requestResponse について、関連リクエスト・レスポンスリスト内で:
-
requestResponse のレスポンスのコピーを responses に追加する。
-
-
-
そうでない場合:
-
requestResponses を Query Cache を r と options で実行した結果とする。
-
各 requestResponse について、requestResponses内で:
-
requestResponse のレスポンスのコピーを responses に追加する。
-
-
-
各 response について、responses内で:
-
response の type が "
opaque" かつ cross-origin resource policy check(promise の 関連設定オブジェクト の origin、promise の 関連設定オブジェクト、空文字列、response の internal response で実行)がblockedを返した場合、promise をTypeErrorでrejectし、これらの手順を中止する。
-
-
タスクをキューに入れる。promise の 関連設定オブジェクト の 責任イベントループ で DOM操作タスクソース を使い、以下の手順を実行する:
-
responseList を リストとする。
-
各 response について、responses内で:
-
promise を frozen array(responseListから生成、realmで)でresolveする。
-
-
-
promise を返す。
5.4.3.
add(request)
add(request) メソッドの手順:
-
requests を request だけを含む配列とする。
-
responseArrayPromise を
addAll(requests)のアルゴリズム(requestsを引数に)で実行した結果とする。 -
responseArrayPromise のsettle後にundefinedを返すfulfillmentハンドラで reactする結果を返す。
5.4.4.
addAll(requests)
addAll(requests) メソッドの手順:
-
responsePromises を空の リストとする。
-
requestList を空の リストとする。
-
requests 内の
Request型の各 request について:-
r を request の request とする。
-
r の url の scheme が "
http" または "https" 以外の場合、もしくは r の method が `GET` でない場合、TypeErrorでrejectされたpromise を返す。
-
-
fetchControllers を リスト(fetch controller)とする。
-
requests の各 request について:
-
r を request を引数に
Requestのコンストラクタを呼び出した結果の関連 request とする。例外が発生したら 例外でrejectされたpromise を返す。 -
r の url の scheme が "
http" または "https" 以外の場合: -
r の client の global object が
ServiceWorkerGlobalScopeオブジェクトなら、request の service-workers mode を "none" に設定する。 -
r の initiator を "
fetch"、destination を "subresource" に設定する。 -
requestList に r を追加する。
-
responsePromise を 新しいpromiseとする。
-
以下のサブステップを 並行して実行する:
-
fetching r の結果を追加する。
-
processResponse を response に対して実行:
-
processResponseEndOfBody を response に対して実行:
-
response の aborted flag が設定されている場合、"
AbortError"DOMExceptionで responsePromise をrejectし、これらの手順を中止する。 -
responsePromise を response でresolveする。
注: レスポンスのbodyが完全に受信されたときにキャッシュコミットが許可されます。
-
-
-
responsePromise を responsePromises に追加する。
-
-
p を responsePromises全部がsettleするpromiseの結果とする。
-
p のsettle後、引数 responses を受け取るfulfillmentハンドラで reactし、以下のサブステップを実行:
-
operations を空の リストとする。
-
index をゼロとする。
-
responses の各 response について:
-
operation を キャッシュバッチ操作とする。
-
operation の type を "
put" に設定する。 -
operation の request を requestList[index] に設定する。
-
operation の response を response に設定する。
-
operation を operations に追加する。
-
index を1増やす。
-
-
cacheJobPromise を 新しいpromiseとする。
-
以下のサブステップを 並行して実行する:
-
errorData をnullとする。
-
Batch Cache Operations を operations で呼び出す。例外が発生したら errorData にその例外を設定する。
-
タスクをキューに入れる。cacheJobPromise の 関連設定オブジェクト の 責任イベントループ で DOM操作タスクソース を使い、以下のサブステップを実行:
-
-
cacheJobPromise を返す。
-
5.4.5.
put(request, response)
put(request, response) メソッドの手順:
-
innerRequestをnullとする。
-
もしrequestが
Requestオブジェクトであれば、innerRequestにrequestのrequestを設定する。 -
それ以外の場合:
-
requestObjを、
Requestのコンストラクタにrequestを渡して生成した結果とする。このとき、例外exceptionが投げられた場合は、exceptionでリジェクトされたプロミスを返す。 -
innerRequestに、requestObjのrequestを設定する。
-
-
もしinnerRequestのurlのschemeが"
http"または"https"でない、あるいはinnerRequestのmethodがGETでない場合は、TypeErrorでリジェクトされたプロミスを返す。 -
innerResponseをresponseのresponseとする。
-
もしinnerResponseのstatusが
206の場合、TypeErrorでリジェクトされたプロミスを返す。 -
もしinnerResponseのheader listに、headerで名前が
Varyのものが含まれている場合:-
fieldValuesを、そのVaryヘッダーのfield-valuesに対応するリスト内の項目を含むリストとする。
-
各fieldValueについてfieldValues内を反復する:
-
もしfieldValueが"
*"と一致したら、TypeErrorでリジェクトされたプロミスを返す。
-
-
-
もしinnerResponseのbodyがdisturbedまたはlockedの場合、TypeErrorでリジェクトされたプロミスを返す。
-
clonedResponseをinnerResponseのクローンとする。
-
bodyReadPromiseをundefinedで解決されたプロミスとする。
-
もしinnerResponseのbodyがnullでなければ、次のサブステップを行う:
-
readerをstreamのreaderを取得した結果とする。
-
bodyReadPromiseに、readerから全バイト読み取りの結果を設定する。
注: これによりinnerResponseのbodyがlockedとなり、clonedResponse内で本体のフルバッファコピーが得られる。実装によっては、メモリではなく直接ディスクへストリーミングで最適化可能。
-
operationsを空のリストとする。
-
operationをキャッシュバッチ操作の新規インスタンスとする。
-
operationのtypeを"
put"に設定する。 -
operationのrequestにinnerRequestを設定する。
-
operationのresponseにclonedResponseを設定する。
-
bodyReadPromiseのfulfillmentの結果を返す:
-
cacheJobPromiseを新しいプロミスとする。
-
cacheJobPromiseを返し、次の処理を並列で実行する:
-
errorDataをnullとする。
-
Batch Cache Operationsをoperationsで呼び出す。ここで例外が発生した場合、errorDataにその例外を設定する。
-
タスクをキューし、cacheJobPromiseの関連設定オブジェクトの責任イベントループ上でDOM操作タスクソースを使用し、次のサブステップを実行する:
-
-
5.4.6.
delete(request, options)
delete(request, options)
メソッドの手順:
-
r を null とする。
-
request が
Requestオブジェクトの場合:-
r を request の request に設定する。
-
r の method が `
GET` でなく、かつ options.ignoreMethod が false なら falseでresolveされたpromise を返す。
-
-
そうでなくrequestが文字列の場合:
-
r を request を引数として
Requestのコンストラクタを呼び出した結果の関連 request とする。例外が発生した場合は その例外でrejectされたpromise を返す。
-
-
operations を空の リストとする。
-
operation を キャッシュバッチ操作とする。
-
operation の type を "
delete" に設定する。 -
operation の request を r に設定する。
-
operation の options を options に設定する。
-
operation を operations に追加する。
-
cacheJobPromise を 新しいpromiseとする。
-
以下のサブステップを 並行して実行:
-
errorData を null とする。
-
requestResponses を Batch Cache Operations を operations で呼び出した結果とする。例外が発生したら errorData にその例外を設定する。
-
タスクをキューに入れる。cacheJobPromise の 関連設定オブジェクト の 責任イベントループ で DOM操作タスクソース を使い、以下のサブステップを実行:
-
-
cacheJobPromise を返す。
5.4.7.
keys(request, options)
keys(request, options) メソッドの手順:
-
r を null とする。
-
オプション引数requestが省略されていない場合:
-
request が
Requestオブジェクトの場合:-
r を request の request に設定する。
-
r の method が `
GET` でなく、かつ options.ignoreMethod がfalseなら、空配列でresolveされたpromise を返す。
-
-
そうでなくrequestが文字列の場合:
-
r を request を引数に
Requestのコンストラクタを呼び出した結果の関連 request とする。例外が発生した場合は その例外でrejectされたpromise を返す。
-
-
-
promise を 新しいpromiseとする。
-
以下のサブステップを 並行して実行:
-
requests を空の リストとする。
-
オプション引数requestが省略されている場合:
-
各 requestResponse について、関連リクエスト・レスポンスリスト内で:
-
requestResponse のリクエストを requests に追加する。
-
-
-
そうでない場合:
-
requestResponses を Query Cache を r と options で実行した結果とする。
-
各 requestResponse について、requestResponses内で:
-
requestResponse のリクエストを requests に追加する。
-
-
-
タスクをキューに入れる。promise の 関連設定オブジェクト の 責任イベントループ で DOM操作タスクソース を使い、以下の手順を実行:
-
requestList を リストとする。
-
各 request について、requests内で:
-
promise を frozen array(requestListから生成、realmで)でresolveする。
-
-
-
promise を返す。
5.5.
CacheStorage
[SecureContext ,Exposed =(Window ,Worker )]interface { [CacheStorage NewObject ]Promise <(Response or undefined )>match (RequestInfo ,request optional MultiCacheQueryOptions = {}); [options NewObject ]Promise <boolean >has (DOMString ); [cacheName NewObject ]Promise <Cache >open (DOMString ); [cacheName NewObject ]Promise <boolean >delete (DOMString ); [cacheName NewObject ]Promise <sequence <DOMString >>keys (); };dictionary :MultiCacheQueryOptions CacheQueryOptions {DOMString ; };cacheName
注: CacheStorage
インターフェースは主にECMAScript
6のMapオブジェクトに準拠するよう設計されていますが、すべて非同期であり、さらに便利なメソッドも備えています。clear、forEach、entries、valuesの各メソッドは、TC39による非同期イテレーションについての議論が継続中であるため、初版の範囲からは意図的に除外されています。
ユーザーエージェントは、CacheStorage
オブジェクトをWindow
オブジェクトまたはWorkerGlobalScope
オブジェクトが作成された際に必ず作成しなければなりません。
CacheStorage
オブジェクトは、そのname to cache mapを、自身の関連設定オブジェクトと"caches"を使ってローカルストレージボトルマップを取得した結果に紐付けて表現します。ドキュメントやワーカーをまたいでCacheStorage
インターフェースの複数の独立したオブジェクトが、同じname to cache mapに同時に紐付くことができます。
5.5.1.
match(request, options)
match(request, options)
メソッドの手順:
-
もしoptions["
cacheName"] が存在する場合、次を実行:-
新しいPromise promise を返し、以下のサブステップを並列で実行する:
-
各 cacheName → cache について、relevant name to cache map を反復する:
-
もしoptions["
cacheName"] と cacheName が一致する場合:-
promise を、
Cacheインターフェースのmatch(request, options)メソッド(thisArgumentに cache を与えて\[[Call]]内部メソッドを呼び出し)をrequestとoptionsで実行した結果でresolveする。 -
これらの手順を中止する。
-
-
-
promiseをundefinedでresolveする。
-
-
-
それ以外の場合:
-
promise に undefinedでresolveされたpromise を設定する。
-
各 cacheName → cache について、relevant name to cache map を反復する:
-
promise を自身の決着に反応する形で、 fulfillment handlerとして以下のサブステップを実行する形に設定する。引数はresponseとする:
-
もしresponseがundefinedでなければ、そのresponseを返す。
-
Cacheインターフェースのmatch(request, options)メソッド(thisArgumentに cache を与えて\[[Call]]内部メソッドを呼び出し)をrequestとoptionsで実行した結果を返す。
-
-
-
promiseを返す。
-
5.5.2.
has(cacheName)
has(cacheName) メソッドの手順:
-
promiseを新しいPromiseとする。
-
次のサブステップを並列で実行する:
-
各 key → value について、relevant name to cache map を反復する:
-
もしcacheNameがkeyと一致したら、promiseをtrueで解決し、これらの手順を中止する。
-
-
promiseをfalseで解決する。
-
-
promiseを返す。
5.5.3.
open(cacheName)
open(cacheName)メソッドの手順は次の通り:
-
promiseを新しいPromiseとする。
-
次のサブステップを並列で実行する:
-
各key→valueについて、relevant name to cache mapを反復する:
-
もしcacheNameがkeyと一致するなら:
-
promiseを、valueを表す新しい
Cacheオブジェクトでresolveする。 -
これらの手順を中止する。
-
-
-
cacheを新しいrequest response listとする。
-
Setを使い、relevant name to cache map[cacheName]にcacheを設定する。このキャッシュ書き込み操作が割り当てられたクォータ制限超過で失敗した場合、promiseを
QuotaExceededErrorでrejectし、これらの手順を中止する。 -
promiseをcacheを表す新しい
Cacheオブジェクトでresolveする。
-
-
promiseを返す。
5.5.4.
delete(cacheName)
delete(cacheName)メソッドの手順は次の通り:
-
promiseを
has(cacheName)メソッドのアルゴリズムをcacheNameで実行した結果とする。 -
promiseの決着に反応する形で、 fulfillment handlerを以下の通り実行した結果を返す。引数はcacheExistsとする:
-
もしcacheExistsがfalseなら:
-
falseを返す。
-
-
cacheJobPromiseを新しいPromiseとする。
-
次のサブステップを並列で実行する:
-
Removeを使い、relevant name to cache map[cacheName]を削除する。
-
cacheJobPromiseをtrueでresolveする。
注: このステップの後でも、既存のDOMオブジェクト(つまり参照されているCache、Request、Responseオブジェクト)は引き続き有効であるべきです。
-
-
cacheJobPromiseを返す。
-
5.5.5.
keys()
keys()メソッドの手順は次の通り:
-
promiseを新しいPromiseとする。
-
次のサブステップを並列で実行する:
-
cacheKeysをrelevant name to cache mapのキー取得の結果とする。
注: 結果の順序付き集合内の各項目は、name to cache mapに追加された順序となる。
-
promiseをcacheKeysでresolveする。
-
-
promiseを返す。
6. セキュリティに関する考慮事項
6.1. セキュアコンテキスト
ServiceWorker は 必ず セキュアコンテキスト で実行されなければなりません。ServiceWorkerクライアント も 必ず セキュアコンテキスト で、ServiceWorker登録の登録や、ServiceWorker登録・ServiceWorkerへのアクセス、ServiceWorkerとのメッセージ送受信、ServiceWorkerによる操作ができる必要があります。
注: これは ServiceWorker および ServiceWorkerクライアント
がHTTPSでホストされる必要があることを意味します。ユーザーエージェントは開発目的で localhost(要件参照)、127.0.0.0/8、::1/128
を許可できます。この制限の主な理由は、非セキュアコンテキストに関連するリスクからユーザーを保護するためです。
6.2. Content Security Policy(CSP)
ユーザーエージェントが Run Service Worker アルゴリズムを ServiceWorker serviceWorker で呼び出す際:
-
serviceWorker の スクリプトリソース が
Content-Security-PolicyHTTPヘッダー値 policy で配信された場合、ユーザーエージェントは 必ず policyを強制 しなければなりません。 -
serviceWorker の スクリプトリソース が
Content-Security-Policy-Report-OnlyHTTPヘッダー値 policy で配信された場合、ユーザーエージェントは 必ず policyを監視 しなければなりません。
この制限の主な理由は、クロスサイトスクリプティング(XSS)などの幅広いコンテンツ注入脆弱性を緩和するためです。
6.3. オリジン依存性
6.3.1. オリジン制限
この節は規範的ではありません。
ServiceWorker は登録した ServiceWorkerクライアント の オリジン で実行されます。大規模なアプリケーションで課題となるのはCDNからのホスト可否ですが、CDNは定義上他の場所や他の オリジン です。したがって、ServiceWorkerはCDNでホストできません。ただし importScripts() 経由でリソースを含めることは可能です。この制限理由は、ServiceWorkerが悪意ある者によって永続的な被害をもたらす可能性があるためです。
6.3.2.
importScripts(urls)
importScripts(urls)
メソッドが ServiceWorkerGlobalScope
オブジェクトで呼ばれると、ユーザーエージェントは 必ず workerグローバルスコープへスクリプトをimportします(この
ServiceWorkerGlobalScope
オブジェクトと urls を渡す)。さらに fetchフック手順(リクエスト request
に対し)を以下の通り実行します:
-
serviceWorker を request の client の グローバルオブジェクト の ServiceWorker とする。
-
map を serviceWorker の スクリプトリソースマップ とする。
-
url を request の url とする。
-
serviceWorker の state が "
parsed" または "installing" でない場合: -
map[url] が存在する場合:
-
urlを serviceWorker の 使用済みスクリプト集合 に追加する。
-
map[url] を返す。
-
-
registration を serviceWorker の ServiceWorker登録 とする。
-
request の service-workers mode を "
none" に設定する。 -
次のいずれかに該当する場合 request の cache mode を "
no-cache" に設定する:-
registration の update via cache mode が "
none" の場合。 -
現在のグローバルオブジェクト の importScripts用キャッシュバイパスフラグ が設定されている場合。
-
registration が stale の場合。
-
-
response を requestのfetch結果とする。
-
response の cache state が "
local" でない場合、registration の last update check time を現在時刻に設定する。 -
response の unsafe response が bad import script response なら ネットワークエラー を返す。
-
map[url] に response を設定する。
-
urlを serviceWorker の 使用済みスクリプト集合 に追加する。
-
serviceWorker の クラシックスクリプトimport済みフラグ を設定する。
-
response を返す。
6.4. クロスオリジンリソースとCORS
この節は規範的ではありません。
アプリケーションは、CDNなどのオリジンから来るアイテムをキャッシュする傾向があります。これらの多くを<script>、<img>、<video>、<link>要素で直接リクエストすることが可能です。このようなランタイムでの協調処理がオフライン時に壊れてしまうのは大きな制約となります。同様に、適切なCORSヘッダーが設定されていれば、多くの種類のオフオリジンリソースもfetchできます。
Service
Workerは、Cachesがオフオリジンのアイテムをフェッチしてキャッシュできるようにすることで、これを実現します。ただし、いくつかの制約があります。まず、Cache内で管理される同一オリジンリソースと異なり、対応するレスポンスがbasic filtered responseであるResponseオブジェクトとは違い、保存されるオブジェクトは、対応するレスポンスがCORSフィルタされたレスポンスまたはopaque filtered responseとなるResponseオブジェクトです。これらは、対応するレスポンスがbasic filtered responseとなるResponseオブジェクトと同じ方法でevent.respondWith(r)
メソッドに渡すことができますが、プログラム的に意味のある方法で生成することはできません。これらの制限はプラットフォームのセキュリティ不変条件を維持するために必要です。Caches
がこれらを保存可能なことにより、多くの場合アプリケーション側での大きな設計変更を避けることができます。
6.5. パス制限
この節は規範的ではありません。
オリジン制限に加え、ServiceWorkerはスクリプトの パス
でも制限されます。例えば https://www.example.com/~bob/sw.js の ServiceWorkerは scope url
https://www.example.com/~bob/ では登録できますが、https://www.example.com/ や
https://www.example.com/~alice/
ではできません。これは同一オリジンでユーザーごとに分離されるディレクトリ構成のサイトの保護に役立ちます。ただしパス制限は厳密なセキュリティ境界ではなく、オリジンのみが厳密な境界です。サイトは必要に応じて異なるオリジンを用いて安全な分離を推奨します。
サーバーは ServiceWorker スクリプトに Service-Worker-Allowed ヘッダーを設定することでパス制限を解除できます。
6.6. ServiceWorkerスクリプトリクエスト
この節は規範的ではありません。
悪意あるServiceWorker登録への対策として、本仕様は以下を要求します:
-
ServiceWorkerスクリプトリクエストには Service-Worker ヘッダーが存在すること
-
ServiceWorkerスクリプトは JavaScript MIMEタイプ で配信されること
6.7. 実装者向け注意事項
この節は規範的ではありません。
実装者は以下に留意してください:
-
プラグインは ServiceWorker 経由ではロードすべきではありません。プラグインは自身のURLからセキュリティオリジンを取得する場合があり、埋め込んだ ServiceWorker では扱えません。このため Handle Fetch アルゴリズムは
<embed>および<object>リクエストをfetchイベントdispatchせず即座にネットワークへフォールバックします。 -
レガシーネットワークスタックの一部コードは ServiceWorker との相互作用の影響を理解するため、慎重な監査が必要な場合があります。
6.8. プライバシー
Service Workerは、新しい永続ストレージ機能を導入します。これには、registration map(Service Workerの登録やそのService Worker用)、request response listやname to cache map(キャッシュ用)、そしてscript resource map(スクリプトリソース用)が含まれます。ユーザーを許可されていないトラッキングの脅威から守るため、これらの永続ストレージは、ユーザーが消去しようと意図したとき消去されるべきであり、また、既存のユーザーコントロール(例:全ての永続ストレージの消去)と整合し、相互運用すべきです。
7. 拡張性
Service Workers仕様は他の仕様から拡張可能です。
7.1. ServiceWorkerRegistrationに結びつけたAPI定義
仕様は、Service Worker 登録に紐付いたAPIを、partial interface定義を用いてServiceWorkerRegistrationインターフェイスに属性やメソッドを仕様ごとに定義してもよい。
partial interface ServiceWorkerRegistration { // 例: API名前空間の定義readonly attribute APISpaceType APISpace ; // 例: メソッドの定義Promise <T >methodName (/* 引数リスト */); };
7.2. 機能的イベントの定義
仕様は、ExtendableEvent
インターフェースを拡張して機能的イベントを定義してもよいです:
// 例: FunctionalEventインターフェース定義interface FunctionalEvent :ExtendableEvent { // 機能的イベント固有の属性・メソッドを追加 };
7.3. イベントハンドラの定義
仕様は、対応する機能的イベントのイベントハンドラ属性を、ServiceWorkerGlobalScope
インターフェースへの partial interface 定義で定義してもよいです:
partial interface ServiceWorkerGlobalScope {attribute EventHandler onfunctionalevent ; };
7.4. 機能的イベントの発火
機能的イベントをServiceWorker登録のactive workerにdispatch要求するには、 仕様はFire Functional Eventを呼び出すべきです。
付録A:アルゴリズム
以下の定義は、現行標準仕様全体で使われるユーザーエージェントの内部データ構造です。
登録マップは、(順序付きマップ)であり、キーは(ストレージキー、シリアライズされたscope url)、値はServiceWorker登録です。
ジョブは、ServiceWorker登録に対するregister、update、unregisterリクエストの抽象化です。
ジョブはワーカータイプ("classic" または "module")を持ちます。
ジョブはupdate
via cache mode("imports"、"all"、"none")を持ちます。
ジョブはclient(ServiceWorkerクライアント)を持ちます。初期値はnullです。
ジョブはreferrer(URLまたはnull)を持ちます。
ジョブはジョブpromise(promise)。初期値はnullです。
ジョブは所属ジョブキュー(ジョブキューまたはnull)。初期値はnullです。
ジョブは等価ジョブリスト(ジョブのリスト)。初期値は空リストです。
ジョブはforce bypass cache flagを持ちます。初期値は未設定です。
2つのジョブが等価とは、ジョブタイプが同じで、以下がすべて同じ場合です:
-
registerおよびupdateのジョブの場合、scope url、script url、worker type、update via cache modeが同じ。
ジョブキューは、同時実行されるジョブ群を同期させるためのスレッドセーフなキューです。ジョブキューはジョブをitemとして含みます。ジョブキューの初期値は空です。
scope→ジョブキュー マップは、順序付きマップで、キーはシリアライズされたscope url、値はジョブキューです。
bad import script responseは、responseで、以下のいずれかの条件を満たすものです:
-
response の type が "
error" -
response の header list からMIME type抽出した結果がJavaScript MIME typeでない
注: この定義はクラシックworker-importedスクリプトのfetchと同期させてください。
race resultは、タプルであり、routed responseとused routeから構成されます。
race resultは、関連付けられたrouted response(response)を持ちます。
race
resultは、関連付けられたused route(RouterSourceEnum)を持ちます。
ジョブの作成
- 入力
-
jobType:ジョブタイプ
storage key:ストレージキー
scopeURL:URL
scriptURL:URL
promise:promise
client:ServiceWorkerクライアント
- 出力
-
job:ジョブ
-
job を新規 ジョブとする。
-
job の ジョブタイプ を jobType に設定する。
-
job の ストレージキー を storage key に設定する。
-
job の scope url を scopeURL に設定する。
-
job の script url を scriptURL に設定する。
-
job の ジョブpromise を promise に設定する。
-
job の client を client に設定する。
-
job を返す。
ジョブのスケジュール
- 入力
-
job:ジョブ
- 出力
-
なし
-
jobQueue を null とする。
-
scope→ジョブキューマップ[jobScope] が 存在しない場合、scope→ジョブキューマップ[jobScope] を新しい ジョブキュー に設定する。
-
jobQueue を scope→ジョブキューマップ[jobScope] に設定する。
-
jobQueue が空なら:
-
そうでない場合:
-
lastJob を jobQueue の末尾要素とする。
-
job が lastJobと等価 かつ lastJob の ジョブpromise がsettleしていなければ、job を lastJob の 等価ジョブリストに追加する。
-
それ以外なら、job の 所属ジョブキュー を jobQueue に設定し、jobQueue に job をenqueueする。
-
ジョブの実行
- 入力
-
jobQueue:ジョブキュー
- 出力
-
なし
-
アサート:jobQueue が 空ではない。
-
タスクをキューに入れる。以下の手順を実行:
ジョブの完了
- 入力
-
job:ジョブ
- 出力
-
なし
ジョブpromiseの解決
- 入力
-
job:ジョブ
value:任意
- 出力
-
なし
-
job の client が null でなければ、タスクをキューに入れる。job の client の 責任イベントループ で DOM操作タスクソース を使い、以下の手順を実行:
-
convertedValue を null とする。
-
job の ジョブタイプ が register または update なら、convertedValue に valueを表すServiceWorkerRegistrationオブジェクト(job の client)を設定する。
-
job の ジョブpromise を convertedValue でresolveする。
-
-
job の 等価ジョブリスト の各 equivalentJob について:
-
equivalentJob の client が null なら、次のループへ。
-
タスクをキューに入れる。equivalentJob の client の 責任イベントループ で DOM操作タスクソース を使い、以下の手順を実行:
-
convertedValue を null とする。
-
equivalentJob の ジョブタイプ が register または update なら、convertedValue に valueを表すServiceWorkerRegistrationオブジェクト(equivalentJob の client)を設定する。
-
それ以外なら、convertedValue を equivalentJob の client の Realm で value に設定する。
-
equivalentJob の ジョブpromise を convertedValue でresolveする。
-
-
ジョブpromiseの拒否
- 入力
-
job:ジョブ
errorData:例外生成に必要な情報
- 出力
-
なし
-
job の client が null でなければ、タスクをキューに入れる。job の client の 責任イベントループ で DOM操作タスクソース を使い、job の ジョブpromise を 新規例外(exception、errorData、job の client の Realm)でrejectする。
-
job の 等価ジョブリスト の各 equivalentJob について:
-
タスクをキューに入れる。equivalentJob の client の 責任イベントループ で DOM操作タスクソース を使い、equivalentJob の ジョブpromise を 新規例外(exception、errorData、equivalentJob の client の Realm)でrejectする。
登録開始
- 入力
-
scopeURL:URL/失敗/null
scriptURL:URL/失敗
promise:promise
client:ServiceWorkerクライアント
referrer:URL
workerType:ワーカータイプ
updateViaCache:update via cache mode
- 出力
-
なし
-
scriptURL が失敗なら、promise を
TypeErrorでrejectし、これらの手順を中止する。 -
scriptURL の fragment を null に設定する。
注: ユーザーエージェントはスクリプトurlの fragment を保存しません。つまりfragmentはServiceWorkerの識別には影響しません。
-
scriptURL の scheme が "
http"/"https" 以外なら、promise をTypeErrorでrejectし、これらの手順を中止する。 -
scriptURL の path 内のいずれかに ASCII大文字小文字無視 "
%2f" または ASCII大文字小文字無視 "%5c" が含まれるなら、promise をTypeErrorでrejectし、これらの手順を中止する。 -
scopeURL が null なら、scopeURL を "./" を scriptURL でパースした結果に設定する。
注: 登録のscope urlはデフォルトでServiceWorkerスクリプトの場所になります。
-
scopeURL が失敗なら、promise を
TypeErrorでrejectし、これらの手順を中止する。 -
scopeURL の fragment を null に設定する。
注: ユーザーエージェントはscope urlの fragment を保存しません。つまりfragmentはServiceWorker登録の識別には影響しません。
-
scopeURL の scheme が "
http"/"https" 以外なら、promise をTypeErrorでrejectし、これらの手順を中止する。 -
scopeURL の path 内のいずれかに ASCII大文字小文字無視 "
%2f" または ASCII大文字小文字無視 "%5c" が含まれるなら、promise をTypeErrorでrejectし、これらの手順を中止する。 -
storage key を clientからストレージキー取得 の結果とする。
-
job を Create Job(register、storage key、scopeURL、scriptURL、promise、client)の結果とする。
-
job の worker type を workerType に設定する。
-
job の update via cache mode を updateViaCache に設定する。
-
job の referrer を referrer に設定する。
-
ジョブのスケジュール(job)を呼び出す。
登録
- 入力
-
job:ジョブ
- 出力
-
なし
-
potentially trustworthy origin(job の script urlのorigin)の結果が
Not Trustedなら:-
ジョブpromiseの拒否(job、"
SecurityError"DOMException)を呼び出す。 -
ジョブの完了(job)を呼び出し、これらの手順を中止する。
-
-
job の script url の origin と job の referrer の origin が 同一オリジンでなければ:
-
ジョブpromiseの拒否(job、"
SecurityError"DOMException)を呼び出す。 -
ジョブの完了(job)を呼び出し、これらの手順を中止する。
-
-
job の scope url の origin と job の referrer の origin が 同一オリジンでなければ:
-
ジョブpromiseの拒否(job、"
SecurityError"DOMException)を呼び出す。 -
ジョブの完了(job)を呼び出し、これらの手順を中止する。
-
-
registration を Get Registration(job の ストレージキー、job の scope url)の結果とする。
-
registration が null でなければ:
-
newestWorker を Get Newest Worker(registration)の結果とする。
-
newestWorker が null でなく、job の script url が newestWorkerのscript urlと一致、job の worker type が newestWorkerのtypeと一致、job の update via cache mode が registrationのupdate via cache modeと一致するなら:
-
ジョブpromiseの解決(job、registration)を呼び出す。
-
ジョブの完了(job)を呼び出し、これらの手順を中止する。
-
-
-
それ以外:
-
Set Registration(job の ストレージキー、job の scope url、job の update via cache mode)アルゴリズムを呼び出す。
-
-
Update(job)アルゴリズムを呼び出す。
更新
- 入力
-
job:ジョブ
- 出力
-
なし
-
registration を Get Registration(job の ストレージキー、job の scope url)の結果とする。
-
registration が null なら:
-
ジョブpromiseの拒否(job、
TypeError)を呼び出す。 -
ジョブの完了(job)を呼び出し、これらの手順を中止する。
-
-
newestWorker を Get Newest Worker(registration)の結果とする。
-
job の ジョブタイプ が update かつ newestWorker が null でなく、かつ newestWorker の script url が jobのscript urlと一致しないなら:
-
ジョブpromiseの拒否(job、
TypeError)を呼び出す。 -
ジョブの完了(job)を呼び出し、これらの手順を中止する。
-
-
hasUpdatedResources を false とする。
-
job の worker type に応じて以下のオプションでサブステップを実行:
- "
classic" -
クラシックワーカースクリプトのfetch(job の シリアライズ済み script url、job の client、"
serviceworker"、このServiceWorker用の生成予定environment settings object)を呼び出す。 - "
module" -
モジュールワーカースクリプトグラフのfetch(job の シリアライズ済み script url、job の client、"
serviceworker"、"omit"、このServiceWorker用の生成予定environment settings object)を呼び出す。
具体的な環境設定オブジェクトではなく、生成予定の環境設定オブジェクトを利用しています。これは、Service Workerが他のWeb Workerと比べて独自の処理モデルを持つためです。HTML標準で他のWeb Worker向けに設計されたスクリプト取得アルゴリズムでは、実行環境の環境設定オブジェクトが必要ですが、Service Workerでは、Updateアルゴリズムでスクリプトを個別に取得し、その後Run Service Workerアルゴリズムを通じてスクリプトが複数回実行される前処理が行われます。
HTMLのクラシック/モジュールワーカースクリプトfetchアルゴリズムはjob の clientを引数に取るが、job の clientはSoft Updateアルゴリズムから呼ぶときnull。
fetchフック(request)の実行手順:
-
`
Service-Worker`/`script` を request の ヘッダーリストに追加する。注: Service-Workerヘッダーの定義は付録B: 拡張HTTPヘッダーを参照。
-
下記のいずれかが真であれば、request の cache mode を "
no-cache" に設定する:-
registration の update via cache mode が "
all" でない。 -
job の force bypass cache flag がセットされている。
-
newestWorker が null でなく、かつ registration が stale である。
注: cache mode が "
no-cache" でなくても、ユーザーエージェントはネットワーク層でCache-Controlヘッダーのmax-age値に従い、ブラウザキャッシュをバイパスすべきかを判断する。 -
-
request の service-workers mode を "
none" に設定する。 -
もし isTopLevel フラグが未設定なら、fetch で request を取得した結果を返す。
-
request の redirect mode を "
error" に設定する。 -
Fetch で request を取得し、fetch の processResponse の一部として、残りのステップを非同期に待つ。response は response。
-
response の ヘッダーリスト から MIME type を抽出。このMIMEタイプ(パラメータを無視)が JavaScript MIME type でなければ:
-
Reject Job Promise を job と "
SecurityError"DOMExceptionで呼び出す。 -
非同期でこれらのステップをnetwork errorとして完了する。
-
-
serviceWorkerAllowed を `
Service-Worker-Allowed` および response の ヘッダーリスト から ヘッダーリスト値を抽出した結果とする。注: Service-Worker-Allowed ヘッダーの定義は付録B: 拡張HTTPヘッダー参照。
-
policyContainer を fetch response からのポリシーコンテナ作成の response での実行結果とする。
-
serviceWorkerAllowed が failure なら:
-
非同期でこれらのステップをnetwork errorとして完了する。
-
-
scopeURL を registration の scope url とする。
-
maxScopeString を null とする。
-
もし serviceWorkerAllowed が null なら:
-
resolvedScope を、job の script url を base URL として、"
./" を 構文解析した結果とする。 -
maxScopeString を "
/" で始め、resolvedScope の path(空文字列を含む)の各文字列を "/" 区切りで連結したものとする。注: resolvedScope の path の末尾要素は必ず空文字列なので maxScopeString は末尾に "
/" を含む。
-
-
それ以外の場合:
-
maxScope を、job の script url を base URL として serviceWorkerAllowed を 構文解析した結果とする。
-
もし maxScope の origin が job の script url の origin と等しいなら:
-
maxScopeString を "
/" で始め、maxScope の path(空文字列を含む)の各文字列を "/" 区切りで連結したものに設定する。
-
-
-
scopeString を "
/" で始め、scopeURL の path(空文字列を含む)の各文字列を "/" 区切りで連結したものとする。 -
もし maxScopeString が null、又は scopeString が maxScopeString で始まらないなら:
-
Reject Job Promise を job と "
SecurityError"DOMExceptionで呼び出す。 -
非同期でこれらのステップをnetwork errorとして完了する。
-
-
url を request の url とする。
-
updatedResourceMap[url] に response を設定する。
-
もし response の cache state が "
local" でなければ、 registration の last update check time を現在時刻に設定する。 -
下記いずれかが真なら hasUpdatedResources を true に設定する:
-
newestWorker が null。
-
newestWorker の script url が url でない、 または newestWorker の type が job の worker type でない。
-
newestWorker の script resource map[url] の body が response の body とバイト単位で一致しない。
-
-
もし hasUpdatedResources が false かつ newestWorker の classic scripts imported flag がセットされていれば:
注: 以下でインポートされたスクリプトの更新有無を検査する(メインスクリプトが変更されていない場合)。
-
各 importUrl → storedResponse について newestWorker の script resource map を反復する:
-
もし importUrl が url なら continue。
-
importRequest を、requestで、urlはimportUrl、clientはjobのclient、destinationは "
script"、 parser metadataは "not parser-inserted"、 use-URL-credentials flag がセットされた新しい request とする。 -
以下のいずれかが真なら importRequest の cache mode を "
no-cache" に設定する:-
registration の update via cache mode が "
none"。 -
job の force bypass cache flag がセットされている。
-
registration が stale である。
-
-
fetchedResponse を fetch で importRequest を取得した結果とする。
-
updatedResourceMap[importRequest の url] に fetchedResponse を設定する。
-
fetchedResponse を unsafe response に置き換える。
-
もし fetchedResponse の cache state が "
local" でなければ、 registration の last update check time を現在時刻に設定する。 -
もし fetchedResponse が bad import script response なら continue。
注: importScripts() の異常レスポンスはバイト比較のチェックから除外される。正常なレスポンスのみ考慮。詳しくは issue #1374 を参照。
-
もし fetchedResponse の body が storedResponse の unsafe response の body とバイト単位で一致しなければ、hasUpdatedResources を true に設定する。
注: このチェックでループを抜けず、キャッシュ構築のため全てのimportスクリプトで継続する。
-
-
-
非同期でこれらのステップを response で完了する。
アルゴリズムが非同期完了したら、残りの手順をscript(非同期完了値)で続行。
- "
-
もし script が null または Is Async Module を script の record、script の base URL、および « » を与えて実行した結果が true なら:
-
Reject Job Promise を job と
TypeErrorで呼び出す。注: すでに Reject Job Promise が "
SecurityErrorDOMException" で呼び出されていた場合、ここでは何もしない。 -
もし newestWorker が null なら、registration map[(registration の storage key、serialized scopeURL)] を削除する。
-
Finish Job を job で呼び出し、これらの手順を中止する。
-
-
もし hasUpdatedResources が false なら:
-
registration の update via cache mode に job の update via cache mode を設定する。
-
Resolve Job Promise を job と registration で呼び出す。
-
Finish Job を job で呼び出し、これらの手順を中止する。
-
-
worker を新しい service worker とする。
-
worker の script url に job の script url、worker の script resource に script、worker の type に job の worker type、および worker の script resource map に updatedResourceMap を設定する。
-
url を worker の set of used scripts に追加する。
-
worker の script resource の policy container に policyContainer を設定する。
-
forceBypassCache に、job の force bypass cache flag がセットされていれば true、そうでなければ false を設定する。
-
runResult を Run Service Worker アルゴリズムに worker と forceBypassCache を与えて実行した結果とする。
-
もし runResult が failure または abrupt completion なら:
-
Reject Job Promise を job と
TypeErrorで呼び出す。 -
もし newestWorker が null なら、registration map[(registration の storage key、serialized scopeURL)] を削除する。
-
Finish Job を job で呼び出す。
-
-
それ以外の場合は、Install アルゴリズムを job、worker、registration で実行する。
ソフトアップデート
ユーザーエージェントは好きな頻度で呼び出してアップデートを確認してもよい。
- 入力
-
registration:ServiceWorker登録
forceBypassCache:オプションのboolean。デフォルトはfalse。
注: 実装者はforceBypassCacheをデバッグ用途(開発者ツールなど)や、ServiceWorker拡張仕様で任意に利用してもよい。
- 出力
-
なし
-
newestWorker を Get Newest Worker(registration)の結果とする。
-
newestWorker が null なら、これらの手順を中止する。
-
job を Create Job(update、registration の ストレージキー、registration の scope url、newestWorker の script url、null、null)で生成。
-
job の worker type を newestWorker の type に設定する。
-
forceBypassCache が true なら job の force bypass cache flag を設定する。
-
ジョブのスケジュール(job)を呼び出す。
インストール
- 入力
-
job:ジョブ
worker:ServiceWorker
registration:ServiceWorker登録
- 出力
-
なし
-
installFailed を false とする。
-
newestWorker を、registration を引数として Get Newest Worker アルゴリズムを実行した結果とする。
-
registration の update via cache mode に job の update via cache mode を設定する。
-
registration、"
installing"、worker を引数として Update Registration State アルゴリズムを実行する。 -
registration の installing worker と "
installing" を引数として Update Worker State アルゴリズムを実行する。 -
アサート: job の job promise は null ではない。
-
Resolve Job Promise を job と registration で呼び出す。
-
settingsObjects を、環境設定オブジェクト で、その origin が registration の scope url の origin であるものすべてとする。
-
settingsObjects の各 settingsObject について、settingsObject の 責任イベントループ の DOM操作タスクソース で次の手順をキューする:
-
settingsObject の realm 内の
ServiceWorkerRegistrationオブジェクトのうち、その service worker registration が registration であるものすべてを registrationObjects とする。 -
registrationObjects の各 registrationObject について、
updatefoundという名前のイベントを registrationObject に 発火する。
-
-
installingWorker を registration の installing worker とする。
-
Should Skip Event アルゴリズムを installingWorker と "install" で実行した結果が false なら:
-
job の force bypass cache flag がセットされていれば true, そうでなければ false を forceBypassCache とする。
-
Run Service Worker アルゴリズムを installingWorker と forceBypassCache で実行した結果が failure なら:
-
installFailed を true に設定する。
-
-
それ以外の場合:
-
installingWorker の イベントループ の DOM操作タスクソース で task をキューし、次のステップを実行:
-
InstallEventで イベントを作成 し e とする。 -
e を installingWorker の グローバルオブジェクト へ 配送する。
-
WaitForAsynchronousExtensions: 次のサブステップを並列で実行する:
-
e が active でなくなるまで待つ。
-
もし e の timed out flag がセットされていれば、installFailed を true にする。
-
e の extend lifetime promises 全体に 待ちプロミス化した結果 p を得る。
-
p の rejection(拒否) 時に installFailed を true にする。
-
もし task が破棄された場合、installFailed を true にする。
-
-
task が実行されるか破棄されるのを待つ。
-
WaitForAsynchronousExtensions とラベルされたステップの完了を待つ。
-
-
-
もし installFailed が true なら:
-
registration の installing worker と "
redundant" を引数として Update Worker State アルゴリズムを実行する。 -
registration、"
installing"、null を引数として Update Registration State アルゴリズムを実行する。 -
もし newestWorker が null なら、registration map[(registration の storage key、serialized registration の scope url)] を削除する。
-
Finish Job を job で呼び出し、これらの手順を中止する。
-
-
map を registration の installing worker の script resource map とする。
-
usedSet を registration の installing worker の set of used scripts とする。
-
map の各 url について:
-
もし usedSet が url を含まなければ、map からその url エントリを削除する。
-
-
registration の waiting worker が null でなければ:
-
Terminate で registration の waiting worker を停止する。
-
registration の waiting worker と "
redundant" を引数に Update Worker Stateアルゴリズムを実行する。
-
-
registration、"
waiting"、registration の installing worker を引数に Update Registration State アルゴリズムを実行する。 -
registration、"
installing"、null を引数に Update Registration State アルゴリズムを実行する。 -
registration の waiting worker と "
installed" を引数に Update Worker State アルゴリズムを実行する。 -
Finish Job を job で呼び出す。
-
このアルゴリズムで呼ばれた Update Worker State により キューされたすべてのタスクが実行されたことを待つ。
-
Try Activate を registration で呼び出す。
注: ここで Try Activate が Activate を発火しなかった場合、Activate は、既存の active worker が最後のクライアントで unload された時や、
skipWaiting()が非同期で呼ばれた場合、あるいは既存 active worker の extend lifetime promises が解決したときに再度試みられる。
アクティベート
- 入力
-
registration:ServiceWorker登録
- 出力
-
なし
-
registration の waiting worker が null なら、これらの手順を中止する。
-
registration の active worker が null でなければ:
-
Terminate(registration の active worker)。
-
Update Worker State(registration の active worker、"
redundant")を実行。
-
-
Update Registration State(registration、"
active"、registration の waiting worker)を実行。 -
Update Registration State(registration、"
waiting"、null)を実行。 -
Update Worker State(registration の active worker、"
activating")を実行。注: active workerがactivating中は、ランタイムスクリプトエラーや強制終了があってもactive workerのアクティベートは妨げられない。
注: アクティベートハンドラは非本質的な作業(クリーンアップなど)を行うよう設計すること。ブラウザ終了等で完了しないこともあり得るので、ServiceWorkerはアクティベートハンドラが完了しなくても正常動作するよう設計すべき。
-
matchedClients を リスト(ServiceWorkerクライアントで、creation URLがregistration の ストレージキーおよびregistration の scope urlと一致するもの)とする。
-
各 client について matchedClients内で、タスクをキューに入れる(client の 責任イベントループ、DOM操作タスクソース)で以下を実行:
-
readyPromise を client の global object の
ServiceWorkerContainerの ready promise とする。 -
readyPromise が null なら次へ。
-
readyPromiseがpendingなら、registrationを表すServiceWorkerRegistrationオブジェクト(readyPromise の relevant settings objectで)でresolve。
-
-
ServiceWorkerクライアント client(registrationをuseしているもの)について:
-
client の active worker を registration の active worker に設定。
-
Notify Controller Change(client)アルゴリズムを呼び出す。
-
-
activeWorker を registration の active worker に設定。
-
Should Skip Event(activeWorker、"activate")の結果がfalseなら:
-
Run Service Worker(activeWorker)の結果が失敗でなければ:
-
タスクtaskをキューに入れる(activeWorker の event loop、DOM操作タスクソース)で以下を実行:
-
e を ExtendableEventイベント生成結果とする。
-
Dispatch(e、activeWorker の グローバルオブジェクト)。
-
-
task が実行または破棄されるまで待つ。
-
WaitForAsynchronousExtensionsラベルのステップが完了するまで待つ。
-
-
-
Update Worker State(registration の active worker、"
activated")を実行。
アクティベート試行
- 入力
-
registration:ServiceWorker登録
- 出力
-
なし
-
registration の waiting worker が null なら return。
-
registration の active worker が null でなく、かつ registration の active worker の state が "
activating" なら return。注: 既存active workerがまだactivating状態なら、waiting workerのアクティベートは遅延される。
-
以下のいずれかが真なら Activate(registration)を呼び出す:
-
registration の active worker が null。
-
Service Worker Has No Pending Events(registration の active worker)がtrue、かつ ServiceWorkerクライアントがregistrationをuseしていない、またはregistration の waiting worker の skip waiting flag が設定済み。
-
ServiceWorkerGlobalScopeのセットアップ
- 入力
-
serviceWorker:ServiceWorker
- 出力
-
ServiceWorkerGlobalScopeオブジェクトまたはnull
注: このアルゴリズムはCSPチェック等で使えるServiceWorkerGlobalScope
またはnullを返す。serviceWorkerがactiveなServiceWorkerGlobalScopeを持つ場合はそれを返し、そうでなければ新規生成。
仕様において、そのようなセキュリティチェックには、ServiceWorkerGlobalScope、
関連設定オブジェクト、
realm、
agent
の作成が必要です。実装では、必要な作業量はこれより少ない可能性があります。したがって、実装はこのアルゴリズムに相当する処理でより少ない作業を行い、必要ならRun Service
Workerでより多くの作業を実施しても構いません。ただし、その結果が観察可能な範囲で等価であること(特に、すべてのセキュリティチェックが同じ結果となること)が前提です。
-
unsafeCreationTime を unsafe shared current time とする。
-
もし serviceWorker が 実行中 であれば、serviceWorker の global object を返す。
-
もし serviceWorker の state が "
redundant" であれば、null を返す。 -
もし serviceWorker の global object が null でなければ、serviceWorker の global object を返す。
-
アサート: serviceWorker の start status は null である。
-
setupFailed を false にする。
-
globalObject を null にする。
-
agent を Service Worker エージェントを取得した結果とし、そのコンテキストで次を実行する:
-
realmExecutionContext を 新しいrealmの生成(agentおよび次のカスタマイズ指定)で得る:
-
グローバルオブジェクトとして、新しい
ServiceWorkerGlobalScopeオブジェクトを作成し、workerGlobalScopeとする。
-
-
settingsObject を、次のアルゴリズムで定義される 環境設定オブジェクト の新しいインスタンスとする:
- realm execution context
-
realmExecutionContext を返す。
- module map
-
workerGlobalScope の module map を返す。
- API base URL
-
serviceWorker の script url を返す。
- origin
-
登録している service worker client の origin を返す。
- has cross-site ancestor
-
登録している service worker client の has cross-site ancestor を返す。
- policy container
-
workerGlobalScope の policy container を返す。
- time origin
-
workerGlobalScope の cross-origin isolated capability と unsafeCreationTime を coarsening した結果を返す。
-
settingsObject の id に新しいユニークな不透明文字列を設定し、creation URL に serviceWorker の script url、top-level creation URL に null、top-level origin に 実装依存 の値、target browsing context に null、active service worker に null を設定する。
-
workerGlobalScope の url に serviceWorker の script url を設定する。
-
workerGlobalScope の policy container に serviceWorker の script resource の policy container を設定する。
-
新しい
WorkerLocationオブジェクトを作成し、workerGlobalScope に関連付ける。 -
もし グローバルオブジェクトのCSP初期化 アルゴリズムを workerGlobalScope で実行した結果が "
Blocked" であれば、setupFailed を true にし、これらの手順を中止する。 -
globalObject に workerGlobalScope を設定する。
-
-
globalObject が null でなくなるか、setupFailed が true になるまで待つ。
-
もし setupFailed が true であれば、null を返す。
-
globalObject を返す。
ServiceWorkerの実行
- 入力
-
serviceWorker:ServiceWorker
forceBypassCache:オプションのboolean。デフォルトはfalse
- 出力
-
Completionまたは失敗
注: このアルゴリズムはServiceWorkerがrunning状態になるか起動失敗するまでブロックする。
-
serviceWorker が running なら、serviceWorker の start status を返す。
-
serviceWorker の state が "
redundant" なら 失敗 を返す。 -
アサート:serviceWorker の start status は null。
-
script を serviceWorker の script resource に設定。
-
アサート:script は null でない。
-
startFailed を false とする。
-
workerGlobalScope を serviceWorker の global object に設定。
-
workerGlobalScope が null なら:
-
workerGlobalScope を ServiceWorkerGlobalScopeのセットアップ(serviceWorker)の結果に設定。
-
workerGlobalScope が null なら 失敗 を返す。
-
serviceWorker の global object を workerGlobalScope に設定。
-
-
workerGlobalScope の realm execution context用エージェント取得し、そのコンテキストで以下を実行:
-
forceBypassCache が true なら workerGlobalScope の importScripts用キャッシュバイパスフラグ を設定。
-
serviceWorker が active worker かつ serviceWorker の 登録の task queues にタスクがあれば、それらをserviceWorker の event loopの task queuesに元のtask source順でキューに入れる。
-
evaluationStatus を null とする。
-
script が クラシックスクリプトなら:
-
evaluationStatus を クラシックスクリプトの実行(script)の結果に設定。
-
evaluationStatus.[[Value]]が空なら(スクリプト未評価)、startFailed を true にし手順中止。
-
-
それ以外で script が モジュールスクリプトなら:
-
evaluationPromise を モジュールスクリプトの実行(script、report errors: false)の結果に設定。
-
アサート:evaluationPromise.[[PromiseState]] は "pending" でない。
-
evaluationPromise.[[PromiseState]] が "rejected" なら:
-
evaluationStatus を ThrowCompletion(evaluationPromise.[[PromiseResult]])に設定。
-
-
それ以外なら:
-
evaluationStatus を NormalCompletion(undefined)に設定。
-
-
-
スクリプトがTerminate Service Workerアルゴリズムで中断されたら、startFailed を true にし手順中止。
-
serviceWorker の start status を evaluationStatus に設定。
-
script の has ever been evaluated flag が未設定なら:
-
settingsObject の global object の関連付けられたevent listenersのevent typeごとに:
-
eventType を workerGlobalScope の関連service worker の set of event types to handleに追加。
注: この時点でevent listenerがなければ、service workerのset of event types to handleは空集合。
-
-
script の has ever been evaluated flag をセット。
-
serviceWorker の all fetch listeners are empty flag を未設定に。
-
ユーザーエージェントは、All Fetch Listeners Are Empty(workerGlobalScope)がtrueならserviceWorker の all fetch listeners are empty flag を設定してもよい。
-
-
responsible event loop(settingsObject指定)を破棄されるまで実行。
-
Clear(workerGlobalScope の map of active timers)。
-
-
serviceWorker が running になるか startFailed がtrueになるまで待つ。
-
startFailed がtrueなら 失敗 を返す。
-
serviceWorker の start status を返す。
fetchリスナーが全て空である
- 入力
-
workerGlobalScope:global object
- 出力
-
boolean
-
workerGlobalScope の set of event types to handle が fetch を含まなければ true を返す。
-
eventHandler を workerGlobalScope の event handler map["onfetch"]の値に設定。
-
eventListenerCallbacks を legacy-obtain service worker fetch event listener callbacks(workerGlobalScope)の結果に設定。
-
各 eventListenerCallback について eventListenerCallbacks内で:
-
callback を null とする。
-
もし eventHandler が null でなく、eventListenerCallback が eventHandler の listener の callback と等しい場合、callback に ECMAScript値へ変換した eventHandler の value の結果を設定する。
-
そうでなければ、callback に ECMAScript値へ変換した eventListenerCallback の結果を設定する。
-
もし IsCallable(callback) が false なら、false を返す。
注: Callback オブジェクトが
handleEvent(event)を使っている場合、非空と見なされます。これは、handleEvent(event)のgetterを呼び出すことで、このチェック中にイベントリスナーが変更される可能性を避けるためです。
注:
() => {}のようなfetchリスナーを検出。一部サイトはPWA認定目的で空bodyのfetchリスナーを持つ。 -
-
true を返す。
注: ユーザーエージェントは空fetchリスナーが不要で性能低下の可能性ある旨警告表示を推奨。
ServiceWorkerの終了
- 入力
-
serviceWorker:ServiceWorker
- 出力
-
なし
-
serviceWorker のメインループと並行して以下を実行:
-
serviceWorkerGlobalScope を serviceWorker の global object に設定。
-
serviceWorkerGlobalScope の closing フラグをtrueに。
-
serviceWorker の set of extended events から全itemを削除。
-
serviceWorkerGlobalScope の event loop の task queues に「handle fetch task source」か「handle functional event task source」のtask sourceを持つタスクがあれば、それらをserviceWorker の 登録の対応する task queues に元のtask source順でキューに入れ、他のタスク(messageイベント等)は全て破棄する。
注: fetchイベントやpush等他の機能的イベントはregistrationのtask queuesに退避され、他のtask(message等)は破棄される。
-
実行中スクリプトの中断(serviceWorker)。
-
serviceWorker の start status を null に。
-
Fetch処理
Fetch処理アルゴリズムはfetch処理をServiceWorkerコンテキストへ委譲するエントリポイントです。
- 入力
-
request、リクエスト
fetchController、フェッチコントローラー
useHighResPerformanceTimers、ブール値
- 出力
-
registrationをnullとする。
-
clientをrequestのクライアントとする。
-
reservedClientをrequestのリザーブドクライアントとする。
-
preloadResponseを新しいプロミスとする。
-
workerRealmをnullとする。
-
timingInfoを新しいサービスワーカータイミング情報とする。
-
アサート:requestのdestinationは "
serviceworker" ではない。 -
もしrequestのdestinationが"
embed"または"object"のいずれかであれば:-
nullを返す。
-
-
それ以外で、requestが非サブリソースリクエストの場合、次を実行:
-
もしreservedClientがnullでなく、かつ環境設定オブジェクトである場合:
-
もしreservedClientがセキュアコンテキストでなければ、nullを返す。
-
-
それ以外の場合:
-
もしrequestのurlが信頼できる可能性のあるURLでなければ、nullを返す。
-
-
もしrequestがナビゲーションリクエストで、発火のトリガーとなったナビゲーションがshift+リロードもしくは同等の操作で開始された場合、nullを返す。
-
アサートreservedClientはnullでない。
-
storage keyをストレージキー取得アルゴリズムに reservedClientを渡して実行した結果とする。
-
registrationをMatch Service Worker Registrationを storage keyとrequestのurlで実行した結果とする。
-
もしregistrationがnull、またはregistrationのアクティブワーカーがnullなら、nullを返す。
-
もしrequestのdestinationが
"report"でなければ、 reservedClientのアクティブサービスワーカーに registrationのアクティブワーカーを設定する。
注: ここから、サービスワーカークライアントは自身の利用するアクティブサービスワーカーの含まれるサービスワーカー登録を使い始める。
-
-
それ以外で、requestがサブリソースリクエストの場合、次を実行:
-
もしclientのアクティブサービスワーカーがnullでなければ、 registrationにclientのアクティブサービスワーカーの含まれるサービスワーカー登録をセットする。
-
それ以外はnullを返す。
-
-
activeWorkerをregistrationのアクティブワーカーとする。
-
shouldSoftUpdateを次のいずれかがtrueならtrue、そうでなければfalseとする:
-
requestが非サブリソースリクエストである場合。
-
requestがサブリソースリクエストで、かつ registrationがstaleな場合。
-
-
もしactiveWorkerのルータールールのリストが空でなければ:
-
timingInfoのworker router evaluation start にcoarsened shared current time (引数useHighResPerformanceTimers)をセットする。
-
sourceをGet Router Sourceアルゴリズムを registrationのアクティブワーカーと requestで実行した結果とする。
-
もしsourceがnullでなければ、次を実施:
-
timingInfoのworker matched router source をsourceに設定し、worker final router source を
"network"にセットする。 -
もしsourceが
"network"なら:-
もしshouldSoftUpdateがtrueなら、並列で Soft Updateアルゴリズムを registrationに対して実行する。
-
timingInfoを返す。
-
-
それ以外で、sourceが
"cache"、または source["cacheName"] 存在する場合、次を実施:-
もしshouldSoftUpdateがtrueなら、並列で Soft Updateアルゴリズムを registrationに対して実行する。
-
timingInfoのworker cache lookup start にcoarsened shared current time (引数useHighResPerformanceTimers)をセットする。
-
environmentをnullとする。
-
もしrequestが非サブリソースリクエストであれば:
-
environmentにreservedClientを設定する。
-
-
それ以外:
-
environmentにclientを設定する。
-
-
cachesをローカルストレージボトルマップを取得 (environmentと"
caches")の結果とする。 -
各 cacheName → cacheについてcachesを反復する。
-
もしsource["
cacheName"] 存在し、かつ source["cacheName"] が cacheNameでなければ continue。 -
requestResponsesをQuery Cacheの 引数request、新しい
CacheQueryOptions、cacheで実行した結果とする。 -
もしrequestResponsesが空のリストの場合、timingInfoを返す。
-
それ以外:
-
requestResponseをrequestResponsesの最初の要素とする。
-
responseをrequestResponseのresponseとする。
-
globalObjectをactiveWorkerのグローバルオブジェクトとする。
-
もしglobalObjectがnullなら:
-
globalObjectをSetup ServiceWorkerGlobalScopeに activeWorkerを渡して実行した結果とする。
-
-
もしglobalObjectがnullなら、timingInfoを返す。
注: これはCORSチェックのためにServiceWorkerGlobalScopeを作成するだけであり、実装では実際に作成されることは想定されていません。
-
もしresponseのtypeが"
opaque"であり、 cross-origin resource policy checkを globalObjectのorigin、 globalObject、""、responseのinternal responseで実行した結果がblockedなら timingInfoを返す。 -
timingInfoのworker final router sourceを
"cache"に設定する。 -
resultのサービスワーカータイミング情報を timingInfoに設定する。
-
responseを返す。
-
-
-
timingInfoを返す。
-
-
それ以外で、sourceが
"race-network-and-fetch-handler"であり、requestのmethodが`GET`の場合、次を実行:-
もしshouldSoftUpdateがtrueなら、並列で Soft Updateアルゴリズムを registrationに対して実行する。
-
queueを空のキューとする(要素はrace result型)。
-
raceFetchControllerをnullとする。
-
raceResponseをrace response型で valueが"
pending"のものとする。 -
次のサブステップを並列で実行:
-
もしfetchControllerのstateが"
terminated"または"aborted"なら、 raceResponseをrace response型(valueがnullのもの)とし、 これ以降の手順を中止する。 -
raceFetchControllerをfetchを requestと、processResponseを以下の手順にセットして呼び出した結果とする。
-
この手順を実行。ただし、abort whenで fetchControllerのstate が"
terminated"または"aborted"の場合に中断。-
raceResponseのvalue をraceNetworkRequestResponseに設定する。
-
もしraceNetworkRequestResponseのstatus がok statusなら、
-
raceNetworkResultをrace result型で routed response にraceNetworkRequestResponse、used route に
"network"を持つものとする。 -
Enqueue raceNetworkResultをqueueに追加。
-
-
-
If abortedで、 raceFetchControllerがnullでなければ:
-
Abort raceFetchController。
-
raceResponseをrace response型(valueがnullのもの)とする。
-
-
-
-
preloadResponseをundefinedで解決する。
-
以下のサブステップを並列で実行する:
-
fetchHandlerResponseをCreate Fetch Event and Dispatchで request、registration、 useHighResPerformanceTimers、timingInfo、 workerRealm、reservedClient、preloadResponse、 raceResponseを引数にして実行した結果とする。
-
もしfetchHandlerResponseがnullでなく、かつネットワークエラーでなければ、raceFetchControllerがnullでない場合は abort raceFetchController。
-
raceFetchHandlerResultをrace result型で routed response にfetchHandlerResponse、used route に
"fetch-event"を持つものとする。 -
Enqueue raceFetchHandlerResultを queueに追加。
-
-
queueが空でなくなるまで待機する。
-
resultをdequeue queueの結果とする。
-
routedResponseをresultのrouted responseとする。
-
もしroutedResponseがnullの場合:
-
timingInfoを返す。
-
-
もしresultのused routeが
"network"なら:-
routedResponseのサービスワーカータイミング情報を timingInfoに設定する。
-
-
routedResponseのサービスワーカータイミング情報の worker final router source をresultのused routeに設定する。
-
routedResponseを返す。
-
-
アサート:sourceは"
fetch-event"である
-
-
-
responseForAutoPreloadをnullとする。
-
もしrequestがナビゲーションリクエストで、 requestのmethodが`
GET`であり、 registrationのアクティブワーカーの ハンドルすべきイベント型の集合が fetchを含み、かつ registrationのアクティブワーカーの all fetch listeners are empty flagがセットされていない場合:-
もしregistrationのnavigation preload enabled flag がセットされている場合:
注: 上記が真であるが、 registrationのアクティブワーカーのハンドルすべきイベント型の集合 が
fetchを含まない場合、開発者の意図が不明確であるため、ユーザーエージェントはコンソール警告を表示してもよい。-
preloadRequestをクローンしたrequestの結果とする。
-
preloadRequestHeadersをpreloadRequestのヘッダーリストとする。
-
preloadResponseObjectを新しい
Responseオブジェクトに、新しいHeadersオブジェクト(guardが "immutable")を紐づけて作成する。 -
appendでpreloadRequestHeadersに 新たなヘッダー(nameが`
Service-Worker-Navigation-Preload`、 valueが registrationのnavigation preload header value)を追加。 -
preloadRequestのservice-workers modeを "
none"に設定。 -
preloadFetchControllerをnullとする。
-
次のサブステップを並列で実行。ただし abort whenで fetchControllerのstate が"
terminated"または"aborted"のとき中断:-
preloadFetchControllerをfetchでpreloadRequestを実行したものとする。
引数navigationPreloadResponseを processResponse(以下のサブステップ):
-
もしnavigationPreloadResponseのtypeが "
error"であれば、preloadResponseをTypeErrorでrejectし、手順終了。 -
preloadResponseObjectを navigationPreloadResponseに紐づける。
-
preloadResponseを preloadResponseObjectでresolveする。
-
-
-
If abortedの場合は:
-
deserializedErrorをdeserialize a serialized abort reason (引数nullおよびworkerRealm)の結果とする。
-
Abort preloadFetchControllerをdeserializedErrorで。
-
-
-
それ以外で、timingInfoのworker matched router source が"
fetch-event"でなければ、 ユーザーエージェントが次のサブステップを実行してもよい:注: ユーザーエージェントはfetchイベントを作成するのと並行して投機的にネットワークリクエストを発行することで、ブートストラップコストを最小限に抑えることができる。
-
アサート:timingInfoのworker matched router sourceはnull
-
autoPreloadFetchControllerをnullとする。
-
responseForAutoPreloadをrace response型で valueが"
pending"のものとする。 -
以下のサブステップを並列で実行。ただし abort whenで fetchControllerのstate が"
terminated"または"aborted"のとき中断:-
autoPreloadFetchControllerをfetchでrequestを実行し、processResponseを下記とする。 response autoPreloadRequestResponse
-
responseForAutoPreloadのvalueを autoPreloadRequestResponseに設定する。
-
-
-
If abortedで autoPreloadFetchControllerがnullでなければ:
-
Abort autoPreloadFetchController。
-
responseForAutoPreloadをrace response型(valueがnullのもの)とする。
-
-
preloadResponseをundefinedで解決する。
-
-
-
それ以外はpreloadResponseをundefinedで解決する。
-
fetchResultをCreate Fetch Event and Dispatchで request、registration、useHighResPerformanceTimers、timingInfo、workerRealm、reservedClient、preloadResponse、responseForAutoPreload を引数にして実行した結果とする。
-
もしtimingInfoのworker final router sourceが空文字列でなければ:
-
アサート:timingInfoのworker final router source は
"network"である。 -
もしfetchResultがnullであれば、timingInfoを返す。
-
それ以外:
-
アサート:fetchResultのサービスワーカータイミング情報のworker final router sourceは
"network"である。 -
fetchResultのサービスワーカータイミング情報のworker final router sourceを
"fetch-event"に設定する。
-
-
-
fetchResultを返す。
Fetchイベント生成・dispatch
- 入力
-
request、リクエスト
registration、サービスワーカー登録
useHighResPerformanceTimers、ブール値
timingInfo、サービスワーカータイミング情報
workerRealm、関連realm(グローバルオブジェクトのもの)
reservedClient、リザーブドクライアント
preloadResponse、プロミス
raceResponse、レースレスポンスまたはnull
- 出力
-
レスポンスまたはnull
-
responseをnullとする。
-
eventCanceledをfalseとする。
-
clientをrequestのクライアントとする。
-
activeWorkerをregistrationのアクティブワーカーとする。
-
eventHandledをnullとする。
-
handleFetchFailedをfalseとする。
-
respondWithEnteredをfalseとする。
-
networkErrorをネットワークエラーとする。
-
もしraceResponseがnullでなければ:
-
networkErrorのサービスワーカータイミング情報 をtimingInfoに設定する。
-
-
shouldSoftUpdateを以下のいずれかがtrueならtrue、そうでなければfalseとする:
-
requestが非サブリソースリクエストの場合。
-
requestがサブリソースリクエストで、 registrationが古い場合。
-
-
Should Skip Eventアルゴリズムに"fetch"および activeWorkerを渡してtrueの場合:
-
もしshouldSoftUpdateがtrueなら、並列で Soft Updateアルゴリズムを registrationに対して実行する。
-
nullを返す。
-
-
もしactiveWorkerの全てのfetchリスナーが空のフラグがセットされていれば:
-
並列で:
-
もしactiveWorkerのstateが"activating"なら activeWorkerのstateが"activated"になるまで待つ。
-
Run Service Workerアルゴリズムに activeWorkerを渡して実行する。
-
もしshouldSoftUpdateがtrueなら、 Soft Update アルゴリズムをregistrationで実行する。
-
-
nullを返す。
-
-
もしuseHighResPerformanceTimersがtrueであれば、 useHighResPerformanceTimersをactiveWorkerのグローバルオブジェクトの クロスオリジン分離能力 に設定する。
-
timingInfoの開始時刻にcoarsened shared current time (引数useHighResPerformanceTimers)をセットする。
-
もしactiveWorkerのstateが"
activating"なら activeWorkerのstateが"activated"になるまで待つ。 -
Run Service WorkerアルゴリズムにactiveWorkerを渡して failureなら、handleFetchFailedをtrueにする。
-
それ以外の場合:
-
workerRealmを 関連realm (activeWorkerのグローバルオブジェクトのもの)に設定する。
-
eventHandledをworkerRealm内の 新しいプロミスに設定する。
-
もしraceResponseがnullでなければ、set activeWorkerのグローバルオブジェクトの race response map[request] を raceResponseに設定する。
-
タスクをキューに追加し、次のサブステップを実行:
-
eを
FetchEventイベントを 作成したものとする。 -
abortControllerをworkerRealmの 新しい
AbortControllerオブジェクトとする。 -
requestObjectをリクエストオブジェクト作成( request、新しい
Headersオブジェクトのguardが"immutable"、 abortControllerのsignal、 workerRealm)の結果とする。 -
eの
cancelable属性をtrueで初期化する。 -
eの
request属性を requestObjectで初期化する。 -
eの
preloadResponseを preloadResponseで初期化する。 -
もしrequestが非サブリソースリクエスト、かつ requestのdestinationが
"report"でなければ、 eのresultingClientId属性をreservedClientのidに初期化し、 そうでなければ空文字列とする。 -
もしrequestがナビゲーションリクエストなら、 eの
replacesClientId属性にrequestのreplaces client idを設定し、 そうでなければ空文字列とする。 -
eの
handledを eventHandledで初期化する。 -
timingInfoのfetch event dispatch time をcoarsened shared current time (引数useHighResPerformanceTimers)に設定する。
-
dispatchで eをactiveWorkerのグローバルオブジェクトにディスパッチする。
-
Update Service Worker Extended Events Setに activeWorkerとeを渡して実行する。
-
もしeのrespond-with entered flagがセットされていれば respondWithEnteredをtrueにする。
-
もしeのwait to respond flagがセットされていれば:
-
eのwait to respond flagが解除されるまで待つ。
-
もしeのrespond-with error flagがセットされていれば handleFetchFailedをtrueにする。
-
それ以外はresponseをeのpotential responseに設定する。
-
-
もしresponseがnullであり、requestのbodyがnullでなく、 requestのbodyのsourceがnullなら:
-
もしresponseがnullでなければresponseのサービスワーカータイミング情報を timingInfoに設定する。
-
もしeのキャンセルフラグがセットされていれば、 eventCanceledをtrueにする。
-
もしfetchControllerのstateが "
terminated"または"aborted"なら:-
deserializedErrorをdeserialize a serialized abort reasonに fetchControllerのserialized abort reason とworkerRealmを渡した結果とする。
-
タスクをキューし、 abort signal をabortControllerにdeserializedErrorを使って発火する。
-
もしtaskが破棄された場合、handleFetchFailedをtrueにする。
taskは activeWorkerのイベントループと handle fetch task sourceを必ず使うこと。
-
-
-
taskが実行された、またはhandleFetchFailedがtrueになるまで待つ。
-
もしshouldSoftUpdateがtrueなら 並列で Soft Updateアルゴリズムを registrationで実行する。
-
もしactiveWorkerのグローバルオブジェクトの race response map[request]が 存在すれば remove activeWorkerのグローバルオブジェクトの race response map[request]を実行する。
-
もしrespondWithEnteredがfalseなら:
-
もしeventCanceledがtrueなら:
-
もしeventHandledがnullでなければ reject eventHandledを
NetworkErrorDOMExceptionでworkerRealm内でrejectする。 -
networkErrorを返す。
-
-
もしeventHandledがnullでなければ resolve eventHandledを解決する。
-
もしraceResponseがnullでなく、かつ raceResponseのvalueがnullでなければ:
-
nullを返す。
-
-
もしhandleFetchFailedがtrueなら:
-
もしeventHandledがnullでなければ reject eventHandledを
NetworkErrorDOMExceptionでworkerRealm内でrejectする。 -
networkErrorを返す。
-
-
もしeventHandledがnullでなければ resolve eventHandledを解決する。
-
responseを返す。
URLパターンの解析
- 入力
-
rawPattern、
URLPatternCompatibleserviceWorker、サービスワーカー
- 出力
-
baseURLをserviceWorkerのスクリプトURLとする。
-
rawPatternおよびbaseURLを与えて、Web IDL値からURLパターンを構築する結果を返す。
ルーター条件の検証
- 入力
-
condition、
RouterConditionserviceWorker、サービスワーカー
- 出力
-
真偽値
-
hasConditionをfalseにする。
-
condition["
urlPattern"] が存在する場合:-
rawPatternをcondition["
urlPattern"]とする。 -
rawPatternとserviceWorkerを渡してURLパターンの解析アルゴリズムを実行した結果をpatternとする。これが例外を投げた場合はcatchし、falseを返す。
-
patternが正規表現グループを持つ場合、falseを返す。
注:ユーザー定義正規表現の実行はセキュリティ上の懸念があるため、禁止されている。
-
hasConditionをtrueにする。
-
-
condition["
requestMethod"] が存在する場合:-
methodをcondition["
requestMethod"]とする。 -
methodがメソッドでなければ、falseを返す。
-
methodが禁止メソッドならば、falseを返す。
-
hasConditionをtrueにする。
-
-
condition["
requestMode"] が存在する場合、hasConditionをtrueにする。 -
condition["
requestDestination"] が存在する場合、hasConditionをtrueにする。 -
condition["
runningStatus"] が存在する場合、hasConditionをtrueにする。 -
hasConditionを返す。
ルーター条件のマッチング
- 入力
-
condition、
RouterConditionserviceWorker、サービスワーカー
request、リクエスト
- 出力
-
真偽値
注:複数の条件(例:urlPattern、runningStatus、requestMethodが設定されている場合)は、すべての条件が一致した場合にtrueが返される。
-
-
orConditionsをcondition["
or"]とする。 -
orConditionsの各orConditionについて:
-
orCondition、serviceWorker、requestを使ってルーター条件のマッチングアルゴリズムを実行し、trueが返った場合はtrueを返す。
-
-
falseを返す。
-
-
-
condition["
not"]、serviceWorker、requestを使ってルーター条件のマッチングアルゴリズムを実行し、trueが返った場合はfalseを返す。 -
trueを返す。
-
-
それ以外:
注:ルーター条件の検証アルゴリズムは、
or、notと他の条件が排他されていることを保証する。-
condition["
urlPattern"] が存在する場合:-
rawPatternをcondition["
urlPattern"]とする。 -
rawPatternとserviceWorkerを渡してURLパターンの解析アルゴリズムを実行した結果をpatternとする。
-
-
condition["
requestMethod"] が存在する場合:-
methodをcondition["
requestMethod"]とする。 -
methodを正規化する。
-
requestのメソッドがmethodでなければ、falseを返す。
-
-
condition["
requestMode"] が存在する場合:-
modeをcondition["
requestMode"]とする。 -
requestのモードがmodeでなければ、falseを返す。
-
-
condition["
requestDestination"] が存在する場合:-
destinationをcondition["
requestDestination"]とする。 -
requestの宛先がdestinationでなければ、falseを返す。
-
-
condition["
runningStatus"] が存在する場合:-
runningStatusをcondition["
runningStatus"]とする。 -
runningStatusが
"not-running"であり、serviceWorkerが稼働中ならば、falseを返す。
-
-
trueを返す。
-
ルーター登録制限の確認
- 入力
-
routerRules、ルーター規則のリスト
- 出力
-
真偽値
注: ルーター条件は_orやnotを用いて複雑かつネスト可能です。過度な処理を防ぐため、このアルゴリズムでは2つの制限を設けます。第一に、すべてのネストされた条件を含む合計条件数は1024を超えてはなりません。第二に、ネストの深さは10レベルまでに制限され、指数的計算を回避します。
-
resultをルーター条件カウント結果とする。
-
resultの条件数を1024に設定する。
-
resultのクォータ超過をfalseに設定する。
-
各ruleをrouterRulesから取り出して:
-
resultを、Count Router Inner Conditionsアルゴリズムの rule["
condition"], result、10を渡した結果で更新する。 -
resultのクォータ超過がtrueなら、falseを返す。
-
-
trueを返す。
ルーター内条件数のカウント
- 入力
-
condition、
RouterConditionresult、ルーター条件カウント結果
depth、数値
- 出力
-
result、ルーター条件カウント結果
-
resultの条件数を1減らす。
-
resultの条件数が0、またはdepthが0なら:
-
resultのクォータ超過をtrueに設定する。
-
resultを返す。
-
-
-
depthを1減らす。
-
condition["
_or"]の各orConditionについて:-
resultを、ルーター内条件数のカウントをorCondition、result、depthで実行した結果で更新する。
-
resultのクォータ超過がtrueなら、resultを返す。
-
-
-
それ以外でcondition["
not"] が存在する場合:-
depthを1減らす。
-
resultを、ルーター内条件数のカウントを condition["
not"]、result、depthで実行した結果で更新する。 -
resultのクォータ超過がtrueなら、resultを返す。
-
-
resultを返す。
ルーターソースの取得
- 入力
-
serviceWorker、サービスワーカー
request、リクエスト
- 出力
-
RouterSourceまたはnull
-
各ruleをserviceWorkerのルーター規則のリストから取り出して:
-
rule["
condition"]、serviceWorker、requestを使ってルーター条件のマッチングアルゴリズムを実行し、trueなら rule["source"]を返す。
-
-
nullを返す。
イベントをスキップすべきか
- 入力
-
eventName、文字列
serviceWorker、サービスワーカー
- 出力
-
真偽値
注: 不要な遅延を避けるため、この仕様ではサービスワーカーのグローバルにイベントリスナーが初回スクリプト実行時に決定的に追加されていない場合、イベントのdispatchをスキップすることを許可します。
-
serviceWorkerの処理するイベント型の集合がeventNameを含まない場合、ユーザーエージェントはスキップ可能としてtrueを返すことができる。
-
falseを返す。
ファンクショナルイベントを発火
- 入力
-
eventName、文字列
eventConstructor、
ExtendableEventを拡張するイベントコンストラクタregistration、service worker registration
initialization、任意。event(eventConstructor から構築される)のプロパティ初期化
postDispatchSteps、任意。active worker のイベントループ上で実行するステップ群。ここで dispatchedEvent は eventConstructor のインスタンスで、dispatch されたものとする。
- 出力
-
なし
-
断言: registration の active worker は null でない。
-
activeWorker を registration の active worker とする。
-
もし eventName と activeWorker を使って Should Skip Event を実行した結果が true なら、次を行う:
-
もし registration が stale なら、並列で Soft Update アルゴリズムを registration で実行する。
-
返す。
-
-
もし activeWorker の state が "
activating" なら、activeWorker の state が "activated" になるのを待つ。 -
もし Run Service Worker アルゴリズムを activeWorker で実行した結果が failure なら、次を行う:
-
もし registration が stale なら、並列で Soft Update アルゴリズムを registration で実行する。
-
返す。
-
-
タスクをキューし、次のサブステップを実行する task を登録する:
-
event を、eventConstructor と activeWorker の relevant realm(activeWorker の global object)を用いて イベントを作成した結果とする。
-
もし initialization が null でなければ、initialization を使って event を初期化する。
-
Dispatch を activeWorker の global object 上で行い、event を送出する。
-
Update Service Worker Extended Events Set を activeWorker と event で呼び出す。
-
もし postDispatchSteps が null でなければ、postDispatchSteps を実行し、引数として event を dispatchedEvent に渡す。
この task は activeWorker の イベントループ と handle functional event task source を使用しなければならない。
-
-
task が実行されるか破棄されるのを待つ。
-
もし registration が stale なら、並列で Soft Update アルゴリズムを registration で実行する。
amazingthing" イベント(型は
AmazingThingEvent)を発火し、イベントオブジェクトのプロパティを初期化する例の説明は次のようになる:
-
Fire Functional Event "
amazingthing" をAmazingThingEventを使って serviceWorkerRegistration 上で実行し、次のプロパティで初期化する:- propertyName
-
value
- anotherPropertyName
-
anotherValue
その後、dispatchedEvent を使って次のステップを実行する:
-
サービスワーカーのイベントループ上で dispatchedEvent を使って必要な処理を行う。
初期化ステップとポストディスパッチステップは省略可能である。必要ない場合の記述は次のようになる:
-
Fire Functional Event "
whatever" をExtendableEventを使って serviceWorkerRegistration 上で実行する。
Service Worker クライアントのアンロード処理
ユーザーエージェントは、service worker client が unloading document cleanup steps または termination によりアンロードされる際に、次のステップを必ず実行しなければならない。
- 入力
-
client、service worker client
- 出力
-
なし
-
次のステップを原子的に実行する。
-
registration を client が使用している service worker registration とする。
-
もし registration が null なら、これらのステップを中止する。
-
もし他の任意の service worker client が registration を 使用している 場合、これらのステップを中止する。
-
もし registration が unregistered なら、 Try Clear Registration を registration で呼び出す。
-
Try Activate を registration で呼び出す。
ユーザーエージェントのシャットダウン処理
- 入力
-
なし
- 出力
-
なし
-
各 registration を registration map の values から反復する:
-
もし registration の installing worker が null でなければ:
-
もし registration の waiting worker が null で、かつ registration の active worker が null なら、Clear Registration を registration で呼び出し、ループの次の反復に進む。
-
それ以外なら、registration の installing worker を null に設定する。
-
-
もし registration の waiting worker が null でなければ、並列で 次を行う:
-
Activate を registration で呼び出す。
-
-
Service Worker の拡張イベント集合を更新
- 入力
-
worker、service worker
event、event
- 出力
-
なし
-
断言: event の dispatch flag はセットされていない。
-
各 item について、worker の set of extended events を走査する:
-
もし item が active でなければ、remove して worker の set of extended events から取り除く。
-
-
もし event が active なら、append して worker の set of extended events に追加する。
登録解除 (Unregister)
- 入力
-
job、job
- 出力
-
なし
-
もし job の origin が job の client の origin と異なる場合、次を行う:
-
Reject Job Promise を job と "
SecurityError"DOMExceptionで呼び出す。 -
Finish Job を job で呼び出し、これらのステップを中止する。
-
-
registration を、Get Registration を job の storage key と job の scope url で実行した結果とする。
-
もし registration が null なら、次を行う:
-
Resolve Job Promise を job と false で呼び出す。
-
Finish Job を job で呼び出し、これらのステップを中止する。
-
-
Remove registration map[(registration の storage key, job の scope url)] を削除する。
-
Resolve Job Promise を job と true で呼び出す。
-
Try Clear Registration を registration で呼び出す。
注意: もし Try Clear Registration がここで Clear Registration を発火させない場合、最後のクライアントが 使用している 登録をアンロードするか、登録のサービスワーカーの extend lifetime promises が解決されるときに再度 Clear Registration が試行されることに注意。
-
Finish Job を job で呼び出す。
登録を設定 (Set Registration)
- 入力
-
storage key、storage key
scope、URL
updateViaCache、update via cache mode
- 出力
-
registration、service worker registration
-
次のステップを原子的に実行する。
-
scopeString を、serialize した scope(exclude fragment flag を設定)とする。
-
registration を新しい service worker registration とし、その storage key を storage key、scope url を scope、および update via cache mode を updateViaCache に設定する。
-
Set registration map[(storage key, scopeString)] を registration に設定する。
-
返す registration。
登録をクリア (Clear Registration)
- 入力
-
registration、service worker registration
- 出力
-
なし
-
次のステップを原子的に実行する。
-
もし registration の installing worker が null でなければ、次を行う:
-
Terminate を registration の installing worker に対して実行する。
-
Update Worker State を呼び出し、registration の installing worker と "
redundant" を引数として渡す。 -
Update Registration State を呼び出し、registration、"
installing"、および null を引数として渡す。
-
-
もし registration の waiting worker が null でなければ、次を行う:
-
Terminate を registration の waiting worker に対して実行する。
-
Update Worker State を呼び出し、registration の waiting worker と "
redundant" を引数として渡す。 -
Update Registration State を呼び出し、registration、"
waiting"、および null を引数として渡す。
-
-
もし registration の active worker が null でなければ、次を行う:
-
Terminate を registration の active worker に対して実行する。
-
Update Worker State を呼び出し、registration の active worker と "
redundant" を引数として渡す。 -
Update Registration State を呼び出し、registration、"
active"、および null を引数として渡す。
-
Try Clear Registration
- 入力
-
registration、service worker registration
- 出力
-
なし
-
もしどの service worker client も 使用しておらず、かつ次のすべての条件が真であれば、Clear Registration を registration で呼び出す:
-
registration の installing worker が null であるか、または Service Worker Has No Pending Events を registration の installing worker に対して実行した結果が true である。
-
registration の waiting worker が null であるか、または Service Worker Has No Pending Events を registration の waiting worker に対して実行した結果が true である。
-
registration の active worker が null であるか、または Service Worker Has No Pending Events を registration の active worker に対して実行した結果が true である。
-
登録状態を更新 (Update Registration State)
- 入力
-
registration、service worker registration
target、文字列("
installing"、"waiting"、"active" のいずれか)source、service worker または null
- 出力
-
なし
-
registrationObjects を registration に関連付けられたすべての
ServiceWorkerRegistrationオブジェクトを含む配列とする。 -
もし target が "
installing" なら:-
registration の installing worker を source に設定する。
-
各 registrationObject について:
-
タスクをキューして、もし registration の installing worker が null なら registrationObject の属性
installingを null にセットし、そうでなければ registration の installing worker を表すサービスワーカーオブジェクトを registrationObject の relevant settings object に取得して設定する。
-
-
-
それ以外で target が "
waiting" なら:-
registration の waiting worker を source に設定する。
-
各 registrationObject について:
-
タスクをキューして、もし registration の waiting worker が null なら registrationObject の属性
waitingを null にセットし、そうでなければ registration の waiting worker を表すサービスワーカーオブジェクトを registrationObject の relevant settings object に取得して設定する。
-
-
-
それ以外で target が "
active" なら:-
registration の active worker を source に設定する。
-
各 registrationObject について:
-
タスクをキューして、もし registration の active worker が null なら registrationObject の属性
activeを null にセットし、そうでなければ registration の active worker を表すサービスワーカーオブジェクトを registrationObject の relevant settings object に取得して設定する。
-
このタスクは task であり、registrationObject の relevant settings object の responsible event loop と DOM manipulation task source を使わなければならない。
-
ワーカー状態を更新 (Update Worker State)
- 入力
-
worker、service worker
state、サービスワーカーの state
- 出力
-
なし
-
断言: state は "
parsed" ではない。注意: "
parsed" は初期状態であり、サービスワーカーがこの状態に戻されることはない。 -
worker の state を state に設定する。
-
settingsObjects を、environment settings objects のうち、worker の script url の起点となる origin と一致するものすべてとする。
-
各 settingsObject について、タスクをキューし、settingsObject の responsible event loop の DOM manipulation task source を用いて次のステップを実行する:
-
objectMap を settingsObject の service worker object map とする。
-
もし objectMap[worker] が存在しなければ、これらのステップを中止する。
-
workerObj を objectMap[worker] とする。
-
workerObj の
stateを state に設定する。 -
"statechange" という名のイベントを発火 し、workerObj に対して送出する。
-
コントローラ変更の通知 (Notify Controller Change)
- 入力
-
client、service worker client
- 出力
-
なし
-
断言: client は null でない。
-
もし client が environment settings object であれば、タスクをキューして、
controllerchangeというイベントをその client に関連付けられたServiceWorkerContainerオブジェクトで発火させる。
このタスクは task であり、client の responsible event loop と DOM manipulation task source を使用しなければならない。
サービスワーカー登録を照合 (Match Service Worker Registration)
- 入力
-
storage key、storage key
clientURL、URL
- 出力
-
service worker registration または null
-
次のステップを原子的に実行する。
-
clientURLString を clientURL の serialize 結果とする。
-
matchingScopeString を空文字列にする。
-
scopeStringSet を空のリストにする。
-
各 (entry storage key, entry scope) を registration map の keys から反復する:
-
matchingScopeString を、scopeStringSet の中で clientURLString が先頭に持つ最長の値に設定する(存在する場合)。
注意: このステップの URL 文字列の照合はパス構造ベースではなくプレフィックスベースである。例えばクライアント URL 文字列 "https://example.com/prefix-of/resource.html" はスコープ "https://example.com/prefix" に一致する。HTTP(S) の URL は常に起点部分に末尾スラッシュが付いてシリアライズされるため、同一オリジンの安全性が保たれる。
-
matchingScope を null にする。
-
もし matchingScopeString が空文字列でないなら:
-
Get Registration を storage key と matchingScope で実行した結果を返す。
登録を取得 (Get Registration)
- 入力
-
storage key、storage key
scope、URL
- 出力
-
service worker registration または null
-
次のステップを原子的に実行する。
-
scopeString を空文字列にする。
-
もし scope が null でなければ、scopeString を scope の serialize(exclude fragment flag を設定)した結果に設定する。
-
各 (entry storage key, entry scope) → registration を registration map から反復する:
-
もし storage key が entry storage key と 等しく、かつ scopeString が entry scope と一致するなら、registration を返す。
-
-
null を返す。
最新のワーカーを取得 (Get Newest Worker)
- 入力
-
registration、service worker registration
- 出力
-
newestWorker、service worker または null
-
次のステップを原子的に実行する。
-
newestWorker を null にする。
-
もし registration の installing worker が null でなければ、registration の installing worker を newestWorker に設定する。
-
そうでなくてもし registration の waiting worker が null でなければ、registration の waiting worker を newestWorker に設定する。
-
さらにそうでなくてもし registration の active worker が null でなければ、registration の active worker を newestWorker に設定する。
-
newestWorker を返す。
サービスワーカーに保留中イベントがないか (Service Worker Has No Pending Events)
- 入力
-
worker、service worker
- 出力
-
真または偽、ブール値
-
worker の set of extended events の各 event について:
-
もし event が active なら、false を返す。
-
-
true を返す。
クライアントを作成 (Create Client)
- 入力
-
client、service worker client
- 出力
-
clientObject、
Clientオブジェクト
-
clientObject を新しい
Clientオブジェクトとする。 -
clientObject の service worker client を client に設定する。
-
clientObject を返す。
Window Client を作成 (Create Window Client)
- 入力
-
client、service worker client
frameType、文字列
visibilityState、文字列
focusState、ブール値
ancestorOriginsList、リスト
- 出力
-
windowClient、
WindowClientオブジェクト
-
windowClient を新しい
WindowClientオブジェクトとする。 -
windowClient の service worker client を client に設定する。
-
windowClient の frame type を frameType に設定する。
-
windowClient の visibility state を visibilityState に設定する。
-
windowClient の focus state を focusState に設定する。
-
windowClient の ancestor origins array を、ancestorOriginsList から作成した frozen array に設定する。
-
windowClient を返す。
フレームタイプを取得 (Get Frame Type)
- 入力
-
navigable、navigable
- 出力
-
frameType、文字列
-
もし navigable の parent が null でなければ、"
nested" を返す。 -
もし navigable の active browsing context が auxiliary browsing context なら、"
auxiliary" を返す。 -
"
top-level" を返す。
Get Client Promise を解決 (Resolve Get Client Promise)
- 入力
-
client、service worker client
promise、promise
- 出力
-
なし
-
もし client が environment settings object であれば、次を行う:
-
もし client が secure context でなければ、タスクをキューして promise を "
SecurityError"DOMExceptionで拒否し、promise の relevant settings object の responsible event loop を使い、DOM manipulation task source を使用して処理し、このステップを中止する。
-
-
それ以外:
-
もし client の creation URL が potentially trustworthy URL でないなら、タスクをキューして promise を "
SecurityError"DOMExceptionで拒否し、promise の relevant settings object の responsible event loop を使い、DOM manipulation task source を使用して処理し、このステップを中止する。
-
-
もし client が environment settings object であり、かつ window client でないなら:
-
clientObject を Create Client を client で実行した結果とする。
-
タスクをキューして promise を clientObject で解決し、promise の relevant settings object の responsible event loop を使い、DOM manipulation task source を使用して処理し、このステップを中止する。
-
-
それ以外:
-
browsingContext を null にする。
-
もし client が environment settings object であれば、browsingContext を client の global object の browsing context に設定する。
-
それ以外なら、browsingContext を client の target browsing context に設定する。
-
navigable を、browsingContext の navigable(その active browsing context を持つもの)に設定する。
-
タスクをキューして、browsingContext の イベントループ 上で次のステップを user interaction task source を用いて実行する:
-
frameType を Get Frame Type を navigable で実行した結果に設定する。
-
visibilityState を browsingContext の active document の
visibilityState属性値に設定する。 -
focusState を、has focus steps を browsingContext の active document を引数にして実行した結果に設定する。
-
ancestorOriginsList を空のリストに設定する。
-
もし client が window client であれば、ancestorOriginsList を browsingContext の active document の relevant global object の
Locationオブジェクトの ancestor origins list に関連付けられたリストで設定する。 -
タスクをキューして、次のステップを promise の relevant settings object の responsible event loop を使い、DOM manipulation task source を用いて実行する:
-
もし client の discarded flag がセットされていれば、promise を undefined で解決し、これらのステップを中止する。
-
windowClient を Create Window Client を client、frameType、visibilityState、focusState、および ancestorOriginsList で実行した結果に設定する。
-
promise を windowClient で解決する。
-
-
-
キャッシュを照会 (Query Cache)
- 入力
-
requestQuery、request
options、
CacheQueryOptionsオブジェクト、任意targetStorage、request response list、任意
- 出力
-
resultList、request response list
-
resultList を空の リスト とする。
-
storage を null にする。
-
もし オプション引数 targetStorage が省略されていれば、storage を relevant request response list に設定する。
-
そうでなければ、storage を targetStorage に設定する。
-
各 requestResponse を storage から反復する:
-
cachedRequest を requestResponse の request にする。
-
cachedResponse を requestResponse の response にする。
-
もし Request Matches Cached Item を requestQuery、cachedRequest、cachedResponse、options で実行した結果が true なら:
-
requestCopy を cachedRequest のコピーとする。
-
responseCopy を cachedResponse のコピーとする。
-
requestCopy/responseCopy を resultList に追加する。
-
-
-
resultList を返す。
リクエストがキャッシュ項目に一致するか (Request Matches Cached Item)
- 入力
-
requestQuery、request
request、request
response、response または null、任意(デフォルト null)
options、
CacheQueryOptionsオブジェクト、任意 - 出力
-
ブール値
-
もし options["
ignoreMethod"] が false で、かつ request の method が `GET` でなければ、false を返す。 -
queryURL を requestQuery の url とする。
-
cachedURL を request の url とする。
-
もし options["
ignoreSearch"] が true なら: -
もし queryURL が cachedURL と exclude fragment flag を設定して 等しく なければ、false を返す。
-
もし response が null、または options["
ignoreVary"] が true、または response の header list が `Vary` を含まないなら、true を返す。 -
各 fieldValue について:
-
もし fieldValue が "
*" とマッチするか、または fieldValue に対する request の header list と組み合わせた combined value が、同じ fieldValue に対する requestQuery のヘッダーと組み合わせた値に一致しない場合、false を返す。
-
-
true を返す。
バッチキャッシュ操作 (Batch Cache Operations)
- 入力
-
operations、リスト。各要素は cache batch operation オブジェクト。
- 出力
-
resultList、request response list
-
cache を relevant request response list とする。
-
backupCache を cache のコピーである新しい request response list とする。
-
addedItems を空の リスト とする。
-
次のサブステップを原子的に実行してみる:
-
resultList を空の リスト とする。
-
各 operation を operations から反復する:
-
もし operation の type が "
delete" でも "put" でもなければ、throw でTypeErrorを投げる。 -
もし operation の type が "
delete" で、かつ operation の response が null でなければ、throw でTypeErrorを投げる。 -
もし Query Cache を operation の request、operation の options、および addedItems で実行した結果が空でなければ、throw で "
InvalidStateError"DOMExceptionを投げる。 -
requestResponses を空の リスト とする。
-
もし operation の type が "
delete" なら:-
requestResponses を Query Cache を operation の request と operation の options で実行した結果に設定する。
-
各 requestResponse を requestResponses から反復する:
-
Remove して、cache から requestResponse に一致するアイテムを削除する。
-
-
-
それ以外で、もし operation の type が "
put" なら:-
もし r の url の scheme が "
http" または "https" のいずれでもなければ、throw でTypeErrorを投げる。 -
requestResponses を Query Cache を operation の request で実行した結果に設定する。
-
各 requestResponse を requestResponses から反復する:
-
Remove して、cache から requestResponse に一致するアイテムを削除する。
-
-
append して operation の request/operation の response を cache に追加する。
-
もし 前の 2 ステップ のキャッシュ書き込みが許可されたクォータを超えて失敗した場合、throw で
QuotaExceededErrorを投げる。 -
append して operation の request/operation の response を addedItems に追加する。
-
append して operation の request/operation の response を resultList に追加する。
-
-
resultList を返す。
-
-
もし例外が 投げられた 場合、次を行う:
-
Remove して、items をすべて relevant request response list から取り除く。
-
各 requestResponse を backupCache から反復する:
-
append して requestResponse を relevant request response list に戻す。
-
-
throw してその例外を再度投げる。
注意: 例外が 投げられた 場合、実装はバッチ操作ジョブ中に行われたキャッシュストレージへの変更を元に戻す(ロールバックする)。
-
非同期モジュールか (Is Async Module)
- 入力
-
record、Module Record
moduleMap、module map
base、URL
- 出力
-
ブール値
-
もし record が Cyclic Module Record でなければ、false を返す。
-
もし record.[[Async]] が true なら、true を返す。
-
各 文字列 requested を record.[[RequestedModules]] から反復する:
-
url を resolve a module specifier を base と requested で行った結果とする。
-
断言: url は失敗にならない。なぜならこの二つの引数でのモジュールスペシファイア解決は以前に成功しているはずだからである。
-
もし seen が url を含まないなら:
-
append して url を seen に追加する。
-
もし moduleMap[url] がレコードを持たないなら、false を返す。
-
もし Is Async Module を moduleMap[url] のレコード、moduleMap、base、および seen で実行した結果が true なら、true を返す。
-
-
-
false を返す。
レースレスポンスを検索
-
registration を null とする。
-
もし request が 非サブリソースリクエスト であれば、次を実行:
-
もし request の reserved client が null の場合、null を返す。
-
storage key を、obtain a storage key を request の reserved client で実行した結果とする。
-
registration を、Match Service Worker Registration を storage key および request の url で実行した結果とする。
-
-
そうでなく、request が サブリソースリクエスト であれば、次を実行:
-
client を request の client とする。
-
もし client の active service worker が null なら、null を返す。
-
registration を client の active service worker の containing service worker registration に設定する。
-
-
それ以外の場合、null を返す。
-
activeWorker を registration の active worker とする。
-
map を activeWorker の グローバルオブジェクト の race response map とする。
-
もし map[request] が 存在 すれば、次を実行:
-
null を返す。
付録B: 拡張HTTPヘッダー
サービスワーカーのスクリプトリクエスト
サービスワーカーのスクリプトレスポンス
サービスワーカーのスクリプトリソースリクエストへのHTTPレスポンスには、次のヘッダーを含めることができる:
- `
Service-Worker-Allowed` -
ユーザーエージェントがパス制限(スクリプトが制御できる最大のスコープURLを制限)の上限を、指定された値に上書きすることを示す。
注: 値はURLである。相対URLが指定された場合は、スクリプトのURLを基準にパースされる。
// 許容される最大スコープのデフォルトはスクリプトのパス(この例では "/js/") // "/js/" の場合 navigator. serviceWorker. register( "/js/sw.js" ). then(() => { console. log( "デフォルトスコープ'/js/'でインストールに成功しました。" ); });
// スクリプトより上位パスへスコープを指定 // レスポンスにService-Worker-Allowedヘッダーなし navigator. serviceWorker. register( "/js/sw.js" , { scope: "/" }). catch (() => { console. error( "パス制限違反でインストールに失敗しました。" ); });
構文
ABNFによる、サービスワーカーのスクリプトリソースリクエストとレスポンスで使われるヘッダー値の構文定義:
Service-Worker = %x73.63.72.69.70.74 ; "script", case-sensitive
注: Service-Worker-Allowedヘッダー値の検証はABNFではなくURLパースアルゴリズム(Updateアルゴリズム)で行われる。
8. 謝辞
Andrew Betts氏には、Jake Archibald氏、Jackson Gabbard氏、Tobie Langel氏、Robin Berjon氏、Patrick Lauke氏、Christian Heilmann氏など志を同じくする方々を集めて小さなワークショップを主催してくれたことに深く感謝します。その日の議論の明快さと、そこで示されたユースケースから多くの可能性が生まれました。さらに、オフライン問題への意識向上にも感謝します。彼のEdgeConfの運営と、オフラインを継続的なテーマにしたことで、この作業が前進する多くの機会とつながりが生まれました。
Anne van Kesteren氏には、Webプラットフォームの専門知識と標準化経験を惜しみなく提供いただき、サービスワーカーの開発を通じて助けていただきました。彼のURL、HTTP Fetch、Promises、DOMの実際の挙動についての先行研究がなければ、この仕様は不完全だったでしょう。同様に、Ian Hickson氏のWeb Worker仕様の厳密さにも多大な感謝を捧げます。
順不同ですが、設計指針や議論に深く感謝する方々:Jungkee Song氏、Alec Flett氏、David Barrett-Kahn氏、Aaron Boodman氏、Michael Nordman氏、Tom Ashworth氏、Kinuko Yasuda氏、Darin Fisher氏、Jonas Sicking氏、Jesús Leganés Combarro氏、Mark Christian氏、Dave Hermann氏、Yehuda Katz氏、François Remy氏、Ilya Grigorik氏、Will Chan氏、Domenic Denicola氏、Nikhil Marathe氏、Yves Lafon氏、Adam Barth氏、Greg Simon氏、Devdatta Akhawe氏、Dominic Cooney氏、Jeffrey Yasskin氏、Joshua Bell氏、Boris Zbarsky氏、Matt Falkenhagen氏、Tobie Langel氏、Gavin Peters氏、Ben Kelly氏、Hiroki Nakagawa氏、Jake Archibald氏、Josh Soref氏、Jinho Bang氏、Yutaka Hirano氏、Michael(tm) Smith氏、isonmad氏、Ali Alabbas氏、Philip Jägenstedt氏、Mike Pennisi氏、Eric Willigers氏。
Jason Weber氏、Chris Wilson氏、Paul Kinlan氏、Ehsan Akhgari氏、Daniel Austin氏にも、要件や標準化プロセスに関して貴重かつ的確なフィードバックをいただきました。
著者らは、Dimitri Glazkov氏にも感謝します。彼のスクリプトやフォーマットツールは、この仕様書の作成に不可欠でした。また、彼の多大なガイダンスにも感謝します。
Vivian Cromwell氏、Greg Simon氏、Alex Komoroske氏、Wonsuk Lee氏、Seojin Kim氏にも、その専門的な支援に感謝します。