clear-code/reload-on-idle

Reloads specified tabs on idle to reduce memory usage.

reload-on-idle

Download link: https://addons.mozilla.org/firefox/addon/reload-on-idle/

Reloads specified tabs on idle to reduce memory usage.

reload-on-idle's Issues

アドオンのWebExtensions対応

WebExtensionsへの移行について

MozillaのAPIリファレンスを読んでいて気がついたのですが、
このアドオンは次の3つのAPIを使えばWebExtensions化できそうです：

• Idle API
• Tabs API
• Alarms API

大きな判定処理のフローとしては、

1. 端末のアクティブ／休眠状態をIdle APIを通じて取得する
2. 判定条件「X秒間活動無し」を満たしていれば、Tabs APIを通じて各タブにリロードをかける

という流れです。この判定処理を、Alarms APIを使って背後で定期的に立ち上げれば、
今のXPCOMベースのアドオンとほぼ同等の機能性を実現できるのでは、と考えています。

実装サンプル

言葉の説明だけだと分かりにくいので、上の処理の骨組だけを実際に組み立ててみました：

background.js

function reloadTabs() {
  browser.tabs.query({})
    .then((tabs) => {
      for (let tab of tabs) {
        browser.tabs.reload(tab.id);
      }
    });
};

/**
 * Check if the computer is in idle state
 */
browser.alarms.onAlarm.addListener((alarm) => {
  browser.idle.queryState(120)  // 2 min
    .then((info) => {
      if (info === 'idle') {
        reloadTabs();
      }
    });
});

/**
 * Create a periodic alarm
 */
browser.alarms.create("idle-reload-alarm", {
  periodInMinutes: 0.5 // 30 sec
});

アドオンの外装を作って、以上のコードをFirefox実機で動かしてみましたが、
2分間なにも操作をしないと、自動的にタブのリロードが走るところまで確認できました。

対応できる範囲／制約

どこまで細かい機能性を再現できるかですが、WebExtensionsのAPI仕様を読む限り、
次の3つのオプションは問題なく対応できそうです：

• 「対象タブをURLでフィルタする」 -> tabs.Tab.urlで判定
• 「読み込み中でもリロードする」 -> tabs.Tab.statusで判定
• 「コンソールにログを出力する」 -> 可能

ただ、次の機能は対応するAPIが見つからなかったです：

• 「編集中のデータがある場合も強制的にリロードする」（document.beforeunload対策？)

また、WebExtensionsのIdle APIだと休眠判定できる最小の時間間隔が「15秒」のようです。
実際に、browsers.idle.queryState(10) を実行すると次のエラーがでます：

（ただし、数秒間隔で自動リロードするニーズがあるかはよく分かっていません）

---

@piroor 以上の方針についてどう思われますか？
大きな見落としがなさそうなら、この方向性で少し取り組んでみたいと思います。