Web 后台同步

5.1. 权限

注： 后台同步应默认启用。权限被拒绝被视为一种例外情况。

5.2. 位置跟踪

5.3. 历史泄露

6.1. 对 ServiceWorkerRegistration 接口的扩展

partial interface ServiceWorkerRegistration {
  readonly attribute SyncManager sync;
};

sync 属性暴露一个 SyncManager， 它具有关联的 service worker registration，由暴露该属性的 ServiceWorkerRegistration 表示。

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，则以 InvalidStateError 拒绝 promise， 并中止这些步骤。
3. 如果用户已禁用后台同步，则以 NotAllowedError 拒绝 promise， 并中止这些步骤。
4. 令 isBackground 为 true。
5. 对于 serviceWorkerRegistration 的源的 service worker clients 中的每个 client：
   1. 如果 client 的 frame type 为 top-level 或 auxiliary，则将 isBackground 设置为 false。
6. 如果 isBackground 为 true，则以 InvalidAccessError 拒绝 promise， 并中止这些步骤。
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。
   4. 如果用户代理当前在线，且 currentRegistration 的 registration state 为 pending，则为 currentRegistration 触发 sync 事件。
9. 否则：
   1. 令 newRegistration 为一个新的 sync registration。
   2. 将 newRegistration 的关联 tag 设置为 tag。
   3. 将 newRegistration 的关联 service worker registration 设置为 serviceWorkerRegistration。
   4. 将 newRegistration 添加到 serviceWorkerRegistration 的 sync registrations 列表。
   5. 解决 promise。
   6. 如果用户代理当前在线，则为 newRegistration 触发 sync 事件。

getTags() 方法在被调用时，必须返回 一个新 promise promise，并并行地运行以下步骤：

1. 令 serviceWorkerRegistration 为 SyncManager 的 关联 service worker registration。
2. 令 currentTags 为一个新的 sequence。
3. 对于 serviceWorkerRegistration 的 sync registrations 列表中的每个 registration，将 registration 的关联 tag 添加到 currentTags。
4. 以 currentTags 解决 promise。

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 属性为 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;
      })
    );
  }
});

每当用户代理变为在线时，用户代理应为每个其 registration state 为 pending 的 sync registration 触发 sync 事件。 这些事件可以按任意顺序触发。

要为 sync registration registration 触发 sync 事件，用户代理必须运行以下步骤：

1. 断言：registration 的 registration state 为 pending。
2. 令 serviceWorkerRegistration 为与 registration 关联的 service worker registration。
3. 断言：registration 存在于 与 serviceWorkerRegistration 关联的 sync registrations 列表中。
4. 将 registration 的 registration state 设置为 firing。

5. 使用 SyncEvent 在 serviceWorkerRegistration 上 触发功能事件 "sync"， 并具有以下属性：

   ⚠MDN

   SyncEvent/tag

   仅在一个当前引擎中可用。

   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

   仅在一个当前引擎中可用。

   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 事件失败时会重试，则为 false；如果当前尝试后不会再进行进一步尝试，则为 true。

   然后使用 dispatchedEvent 运行以下步骤：

   1. 令 waitUntilPromise 为 dispatchedEvent 的 extended lifetime promises 的 全部等待结果。
   2. 当 waitUntilPromise 兑现时，原子地执行以下步骤：
      1. 如果 registration 的 state 为 reregisteredWhileFiring：
         1. 将 registration 的 state 设置为 pending。
         2. 如果用户代理当前在线，则为 registration 触发 sync 事件。
         3. 中止这些步骤的其余部分。
      2. 断言： registration 的 registration state 为 firing。
      3. 从 serviceWorkerRegistration 的 sync registration 列表中移除 registration。
   3. 当 waitUntilPromise 被拒绝时，或者如果脚本已因 service worker 的 终止而中止，则原子地执行以下步骤：
      1. 如果 registration 的 state 为 reregisteredWhileFiring：
         1. 将 registration 的 state 设置为 pending。
         2. 如果用户代理当前在线，则为 registration 触发 sync 事件。
         3. 中止这些步骤的其余部分。
      2. 如果 dispatchedEvent 的 lastChance 属性为 false，则将 registration 的 registration state 设置为 waiting， 并并行地执行以下步骤：
         1. 等待一个用户代理定义的时间长度。
         2. 如果 registration 的 registration state 不是 waiting，则中止这些子步骤。
         3. 将 registration 的 registration state 设置为 pending。
         4. 如果用户代理当前在线，则为 registration 触发 sync 事件。
      3. 否则，从 serviceWorkerRegistration 的 sync registrations 列表中移除 registration。

用户代理可以对 SyncEvent 的生命周期扩展和执行时间施加比一般 ExtendableEvent 更严格的时间限制。特别是，对于其 lastChance 为 true 的事件，可以有显著缩短的时间限制。

用户代理将基于一些由用户代理定义的启发式规则 重试 sync 事件。