Web バックグラウンド同期

5.1. 許可

注: Background sync は既定で有効にされるべきである。 許可が拒否されていることは例外的な場合と見なされる。

5.2. 位置トラッキング

5.3. 履歴漏えい

6.1. ServiceWorkerRegistration インターフェイスへの拡張

partial interface ServiceWorkerRegistration {
  readonly attribute SyncManager sync;
};

sync 属性は、SyncManager を公開する。 これは、その属性が公開されている ServiceWorkerRegistration によって表される、関連付けられた service worker registration を持つ。

6.2. SyncManager インターフェイス

[Exposed=(Window,Worker)]
interface SyncManager {
  Promise<undefined> register(DOMString tag);
  Promise<sequence<DOMString>> getTags();
};

register(tag) メソッドは、呼び出されたとき、 新しい promise promise を返し、次の手順を 並列で実行しなければならない：

1. serviceWorkerRegistration を、SyncManager の 関連付けられた service worker registration とする。
2. serviceWorkerRegistration の active worker が null の場合、promise を InvalidStateError で reject し、これらの手順を中止する。
3. ユーザーが background sync を無効にしている場合、promise を NotAllowedError で reject し、これらの手順を中止する。
4. isBackground を true とする。
5. serviceWorkerRegistration の origin に対する service worker clients 内の client それぞれについて：
   1. client の frame type が top-level または auxiliary である場合、isBackground を false に設定する。
6. isBackground が true の場合、promise を InvalidAccessError で reject し、これらの手順を中止する。
7. currentRegistration を、存在する場合は serviceWorkerRegistration の sync registrations のリスト内の、 tag が tag に等しい registration とし、そうでなければ null とする。
8. currentRegistration が null でない場合：
   1. currentRegistration の registration state が waiting である場合、 currentRegistration の registration state を pending に設定する。
   2. currentRegistration の registration state が firing である場合、 currentRegistration の registration state を reregisteredWhileFiring に設定する。
   3. promise を Resolve する。
   4. ユーザーエージェントが現在 online であり、かつ currentRegistration の registration state が pending である場合、 currentRegistration に対して sync event を発火する。
9. そうでない場合：
   1. newRegistration を新しい sync registration とする。
   2. newRegistration の関連付けられた tag を tag に設定する。
   3. newRegistration の関連付けられた service worker registration を serviceWorkerRegistration に設定する。
   4. newRegistration を serviceWorkerRegistration の sync registrations のリストに追加する。
   5. promise を Resolve する。
   6. ユーザーエージェントが現在 online である場合、 newRegistration に対して sync event を発火する。

getTags() メソッドは、呼び出されたとき、新しい promise promise を返し、次の手順を 並列で実行しなければならない：

1. serviceWorkerRegistration を、SyncManager の 関連付けられた service worker registration とする。
2. currentTags を新しい sequence とする。
3. serviceWorkerRegistration の sync registrations のリスト内の registration それぞれについて、registration の関連付けられた tag を currentTags に追加する。
4. promise を currentTags で Resolve する。

6.3. sync イベント

partial interface ServiceWorkerGlobalScope {
  attribute EventHandler onsync;
};

[Exposed=ServiceWorker]
interface SyncEvent : ExtendableEvent {
  constructor(DOMString type, SyncEventInit init);
  readonly attribute DOMString tag;
  readonly attribute boolean lastChance;
};

dictionary SyncEventInit : ExtendableEventInit {
  required DOMString tag;
  boolean lastChance = false;
};

注: SyncEvent インターフェイスは、発火中の sync registration を表す。イベントを登録したページ（または worker）が 実行中である場合、ユーザーエージェントはネットワーク接続が利用可能になり次第 sync イベントを発火する。 そうでない場合、ユーザーエージェントは都合がつき次第イベントを実行するべきである。sync イベントが失敗した場合、 ユーザーエージェントは任意の時点で再試行することを決定してもよい。lastChance 属性は、ユーザーエージェントが現在の試行後にこの sync のさらなる試行を行わない場合に true である。

self.addEventListener('sync', event => {
  if (event.tag == 'important-thing') {
    event.waitUntil(
      doImportantThing().catch(err => {
        if (event.lastChance) {
          self.registration.showNotification("Important thing failed");
        }
        throw err;
      })
    );
  }
});

ユーザーエージェントが online に変わるたびに、ユーザーエージェントは sync event を発火するべきである。 これは、sync registration のうち、その registration state が pending であるものそれぞれについて行う。 イベントは任意の順序で発火されてもよい。

sync registration registration に対して sync event を発火するには、ユーザーエージェントは次の手順を実行しなければならない：

1. Assert: registration の registration state は pending である。
2. serviceWorkerRegistration を、registration に関連付けられた service worker registration とする。
3. Assert: registration は serviceWorkerRegistration に関連付けられた sync registrations のリスト内に存在する。
4. registration の registration state を firing に設定する。

5. serviceWorkerRegistration 上で、次のプロパティを持つ SyncEvent を使用して、"sync" Fire Functional Event する：

   ⚠MDN

   SyncEvent/tag

   現在のエンジン 1 つだけで利用可能。

   FirefoxなしSafariなしChrome49+

   ---

   Opera?Edge79+

   ---

   Edge (Legacy)なしIEなし

   ---

   Firefox for AndroidなしiOS SafariなしChrome for Android49+Android WebViewなしSamsung Internet5.0+Opera Mobile?

   tag

   registration に関連付けられた tag

   ⚠MDN

   SyncEvent/lastChance

   現在のエンジン 1 つだけで利用可能。

   FirefoxなしSafariなしChrome49+

   ---

   Opera?Edge79+

   ---

   Edge (Legacy)なしIEなし

   ---

   Firefox for AndroidなしiOS SafariなしChrome for Android49+Android WebViewなしSamsung Internet5.0+Opera Mobile?

   lastChance

   この sync event が失敗した場合にユーザーエージェントが 再試行するなら false、現在の試行後に さらなる試行が行われないなら true。

   その後、dispatchedEvent で次の手順を実行する：

   1. waitUntilPromise を、dispatchedEvent の extended lifetime promises の すべてを待機する結果とする。
   2. waitUntilPromise の 充足時に、次の手順をアトミックに実行する：
      1. registration の state が reregisteredWhileFiring である場合：
         1. registration の state を pending に設定する。
         2. ユーザーエージェントが現在 online である場合、registration に対して sync event を発火する。
         3. これらの手順の残りを中止する。
      2. Assert: registration の registration state は firing である。
      3. registration を serviceWorkerRegistration の sync registration のリストから削除する。
   3. waitUntilPromise の 拒否時、または service worker の 終了によってスクリプトが中止された場合、 次の手順をアトミックに実行する：
      1. registration の state が reregisteredWhileFiring である場合：
         1. registration の state を pending に設定する。
         2. ユーザーエージェントが現在 online である場合、registration に対して sync event を発火する。
         3. これらの手順の残りを中止する。
      2. dispatchedEvent の lastChance 属性が false の場合、registration の registration state を waiting に設定し、 次の手順を 並列で実行する：
         1. ユーザーエージェント定義の時間だけ待つ。
         2. registration の registration state が waiting でない場合、これらの下位手順を中止する。
         3. registration の registration state を pending に設定する。
         4. ユーザーエージェントが現在 online である場合、registration に対して sync event を発火する。
      3. そうでない場合、registration を serviceWorkerRegistration の sync registrations のリストから削除する。

ユーザーエージェントは、SyncEvent の lifetime extension および実行時間に対して、一般の ExtendableEvent に 課される時間制限よりも厳しい時間制限を課してもよい。特に、 lastChance が true であるイベントは、大幅に短縮された時間制限を持ってもよい。

ユーザーエージェントは、何らかのユーザーエージェント定義のヒューリスティックに基づき、 sync event を 再試行する。