結城です。
最近、Firefoxを更新されたお客さまから「LINE WORKSの通知が表示されなくなった」というお問い合わせを頂きました。 詳しく調査したところ、これはFirefox 107以降での仕様変更が影響しており、通知を表示するにはFirefoxの設定を変更する必要があると分かりました。 本記事では、調査の経緯ならびにその結果判明した設定内容について解説します。
なお、本記事で取り上げるのはLINE WORKSでの事例となりますが、他のWebサービスでも同様のトラブルが発生する可能性がありますので、参考にして頂ければ幸いです。
基本的な通知設定の確認
Webサービスは、Notification APIを用いてデスクトップ通知を表示できます。 LINE WORKSの場合、「トーク」で新たなメッセージが届いたときに、その内容を通知として表示するようになっています。
この通知を表示するためには、LINE WORKSに限らず必要な設定がありますので、まずはその範囲で設定を確認していきます。
Webサイトが自主的にデスクトップ通知を表示するためには、Webサイトに対してNotification APIの使用を明示的に許可する必要があります。 LINE WORKSの場合、ページ右上の歯車アイコンから「通知設定」を選択して、遷移先の画面で明示的にユーザーの手で許可を与えることになります。
企業で全社的にLINE WORKSを導入しているような場面では、ポリシー設定のPermissions
を使ってあらかじめLINE WORKSのWebサイトにNotification APIの使用を許可しておくこともできます。
policies.json
を使うのであれば以下の要領です。
{
"policies": {
"Permissions": {
"Notifications": {
"Allow": ["https://notify.worksmobile.com"]
}
}
}
}
グループポリシー用のポリシーテンプレートを導入済みであれば、「管理用テンプレート」→「Mozilla」→「Firefox」→「Permissions」→「Allowed Sites」を「有効」にして、値に https://notify.worksmobile.com
を登録します。
また、Windowsを使用している場合はWindowsのデスクトップ通知設定も有効にする必要があります。 Firefoxは従来は独自の通知ポップアップを表示する仕様でしたが、Firefox 111以降・Firefox ESR115以降のバージョンでは通知をWindowsのデスクトップ通知として表示する仕様になったため、Windows全体またはFirefoxの通知が無効化されていると、LINE WORKSの通知も表示されないことになります。
一般的には、これらの設定が反映されていればデスクトップ通知が表示されると期待できます。 本記事で取り上げるのは、これらの設定を行ったにもかかわらず通知が表示されない場合となります。
原因の調査
Webコンソールの確認
「通知が表示されるべき場面で表示されない」状況では、何らかのエラーが発生している可能性が疑われます。 Webサイト上で発生したエラー情報はWeb開発ツールのコンソール(Webコンソール)に出力されるため、まずはそこを確認します。 Firefoxでは、キーボードショートカット「Ctrl-Shift-K」でWebコンソールを表示することができます。
この状態で、他のユーザーからメッセージを送信して通知が表示されない結果を得られた時点でWebコンソールの内容を確認したところ、特に目立ったエラーは報告されていない様子でした。 このことから、
- Notification APIがそもそも呼び出されていない。(Webサービス側の問題)
- Notification APIは呼び出されているが、その後の表示が行われていない。(Firefox側の問題)
のどちらかの状況であると考えられます。
Notifications APIが呼び出されているかどうかの確認
Notifications APIでは、通知はnew Notification()
でインスタンスが作成された時に表示されます。
そこで、JavaScriptデバッガーを使ってコード内からそのような記述が含まれる箇所を特定し、実際に処理が行われているかどうかを確認してみます。
JavaScriptデバッガーは、キーボードショートカット「Ctrl-Shift-Z」で開くことができます。
ここで左のペイン上部の「検索」を選択し、検索欄にnew Notification
と入力して検索を実行してみたところ、まさにその文字列を含んでいる部分が1箇所だけあると分かりました。
ただ、このファイルはいわゆるminifyがなされているために、すべての行が1行につながってしまっています。 JSデバッガーは行単位で処理を追う物なので、これでは有効な調査を行えません。
このような時は、右ペイン左下の「ソースコードを整形」ボタンをクリックして、いわゆるpretty printの状態にします。
そうするとJavaScriptの文の切れ目で改行されるようになるので、改めて、new Notification
を含む行の行番号部分をクリックしてブレークポイントを設定します。
ブレークポイントを設定しておくと、この箇所まで処理が到達した瞬間にスクリプトの実行が一時停止されます。 デバッガー本来の使い方としては、そこからステップ実行して変数の状態などを調査することになりますが、今回はブレークポイントで処理が停止するかどうかだけを見れば充分です。 というのも、通知が表示されることが期待される場面において、
- この箇所で処理が停止されれば、Webページのスクリプトには大筋で問題がなく、問題はFirefoxの側にある。
- この箇所に到達せず処理が進行・完了すれば、問題はNotification APIの呼び出し前に起こっており、Webページのスクリプトの側にある。 もしくは、別の箇所で別の方法でNotification APIを使用している可能性がある。
ということが言えるからです。
ブレークポイントを設定した状態で他のユーザーからのメッセージを送信してみたところ、果たしてブレークポイントで処理が一時停止する結果となりました。 よって、現象発生時の状況は、Webサービス側はNotification APIを呼んでいるが、Firefoxがそれを無視している、もしくは通知の表示を抑制しているということになります。
Notifications APIの呼び出しテスト
ここで、そもそもNotification APIが機能する状態なのかどうかを確認するために、Webコンソールで以下のコードを実行してみます。
new Notification(
'title',
{
body: 'body',
tag: '',
}
);
すると、デスクトップ通知が指定の内容で表示される結果となりました。 このことから、FirefoxのNotifications API自体が動作していないわけではないと分かりました。
また、ここでもう一つ気が付いた点があります。
先程見つけたnew Notification
の呼び出し箇所は https://notify.worksmobile.com/bee-iframe/index-215c944c0f5f2fa7b0fd.js?779d53d248ebe3439655
というURLで参照されたファイルの中にありましたが、URLの中にiframe
という文字列が含まれていて、トップレベルのフレームではなくインラインフレーム内に読み込まれている可能性が疑われます。
実際に、Web開発ツールの「インスペクター」でbee-iframe/index-215c944c0f5f2fa7b0fd
を検索してみたところ、このファイルはhttps://notify.worksmobile.com/bee-iframe/index-3.7.0.html
というURLのインラインフレームから読み込まれた物であることが分かりました。
そこで、Web開発ツールの調査対象ドキュメントを当該インラインフレームのドキュメントに切り替えた上で、再度Webコンソールで先のコードを実行してみました。
すると、今度はデスクトップ通知が表示されず、Webコンソール内にも特にエラー等は報告されないという結果となりました。 このことから、インラインフレーム内でNotification APIを使用した場合にデスクトップ通知が表示されないという状況であることが分かりました。 「ユーザーを保護するために、ユーザーを騙すような形での通知の登録や表示を抑止していく」という昨今のFirefoxの動きを鑑みると、インラインフレーム起因の呼び出しに限定して通知をブロックするということは、いかにもありそうな話です。
FirefoxにおけるNotifications APIの実装の確認
ここから先は、Firefoxの内部を調査していくことになります。
JavaScriptのNotification
クラスに関わる処理は、Firefoxではソースコードリポジトリ中のdom/notification/Notification.cpp
というC++製のモジュールで実装されています。
例えば、new Notification()
が実行された時の処理はNotification::Constructor
が該当します。
この周辺の処理を追っていくと、dom.webnotifications.allowcrossoriginiframe
という設定の値に基づいて、特定条件下で通知をキャンセルする分岐があることが分かりました。
この条件分岐はBug 1708354 - Notifications are allowed in a non-same-origin iframe if previously granted top-levelの修正の一環としてFirefox 107時点で導入されており、変更の結果、同一オリジンでないサブフレームからの通知を拒絶するように挙動が変化していたことになります。 Firefox ESR版を使用していた場合であれば、Firefox ESR102からFirefox ESR115へ更新した際に初めて影響を受けるようになります。
- お問い合わせがあったのは、Firefox ESR102からFirefox ESR115への自動更新が始まって以後であった。
- 先の通知の出所のフレームのオリジンが
https://notify.worksmobile.com
であるのに対しトップレベルのフレームであるLINE WORKSトークのWebページのオリジンはhttps://talk.worksmobile.com
で、まさにクロスオリジンでの通知にあたる。
これらのことから、この度のお問い合わせの現象は「通知がクロスオリジンの通知としてブロックされていた」可能性が濃厚で、もしそうだったのであれば、dom.webnotifications.allowcrossoriginiframe
を初期値のfalse
からtrue
に変更することで現象が解消される可能性があります。
Service Workerの状態の影響
ただ、調査時の環境では、dom.webnotifications.allowcrossoriginiframe
の値をtrue
に変更しても、依然として通知が表示されないことが度々発生していました。
Web開発ツールの「アプリケーション」でService Workerの状態を見てみたところ、この状態が「停止中」になっていると通知が表示されない様子でした。 どうやら、極めて短い時間でService Workerが停止してしまい、その状態ではそもそも通知の受信自体ができなくなる、ということが起こっている模様です。
こちらについても調査してみたところ、Service Workerは一定時間イベントが発生していないと停止されてしまうものの、Firefoxにおいてはそのタイムアウト時間はdom.serviceWorkers.idle_timeout
という設定で制御できることが分かりました。
この設定の値の単位はミリ秒で、初期値は30000ミリ秒=30秒です。 これでは、LINE WORKSのページを開いているタブをバックグラウンドにしたままで何か作業をしていると、すぐにタイムアウトしてService Workerが停止してしまいます。
イベントが発生しなくても6時間はService Workerの状態を維持するよう、値を21600000
に変更したところ、実際に、それ以前よりは安定して通知が表示されるようになりました。
対策
以上の事を踏まえると、LINE WORKSの通知が安定して表示される状態にするための設定は、policies.json
を使うのであれば以下の通りに要約できます。
{
"policies": {
"Permissions": {
"Notifications": {
"Allow": ["https://notify.worksmobile.com"]
}
},
"Preferences": {
"dom.webnotifications.allowcrossoriginiframe": {
"Value": true,
"Status": "locked"
},
"dom.serviceWorkers.idle_timeout": {
"Value": 21600000,
"Status": "locked"
}
}
}
}
グループポリシー用のポリシーテンプレートを導入済みであれば、「管理用テンプレート」→「Mozilla」→「Firefox」で以下の通りに設定することになります。
- 「Permissions」→「Allowed Sites」を「有効」にして、値に
https://notify.worksmobile.com
を登録する。 - 「Preferences」を「有効」にして、値に以下のJSON文字列を登録する。
{ "dom.webnotifications.allowcrossoriginiframe": { "Value": true, "Status": "locked" }, "dom.serviceWorkers.idle_timeout": { "Value": 21600000, "Status": "locked" } }
ただ、この対策には以下のようなデメリットもあります。
- インラインフレームからのクロスオリジンでの通知を許容する設定は、LINE WORKSのWebサイトのみに限定して反映することができず、あらゆるWebサイトに反映される。そのため、ニュースサイトなどを閲覧した際に、そのサイトに埋め込まれたインラインフレーム型の広告やトラッキングスクリプトなどに起因するスパム的な通知が頻繁に表示されるようになる恐れがある1。
- Service Workerがタイムアウトしなくなることで、CPU資源やメモリ資源を余計に消費し続けてしまう恐れがある。
LINE WORKSのサービス側が改善されると、このような対策も必要なくなる可能性はあります。 状況に変化が見られるか、度々確認しておく必要があると言えるでしょう。
まとめ
「Firefoxの更新後にLINE WORKSのデスクトップ通知が表示されなくなった」というお問い合わせを起点とした調査の詳しい経緯と、その結果分かった対策について紹介しました。
今回判明した状況は、LINE WORKS以外のWebサービスでも発生する可能性があります。 通知の権限の許可など、一般的な範囲で通知に関する設定を行っても通知が依然として表示されない場合には、この記事を参考にFirefoxの設定を変更してみて下さい。
当社では、Firefoxの法人運用におけるトラブルの原因究明や回避方法の調査、設定のはたらきが不明な部分の詳細な調査などを有償にて承っております。 本記事の内容も、お客さま環境でのFirefox ESR115以降に際しての検証の過程で発覚したものです。 Firefoxの運用でお悩みの企業のご担当者さまで、このようなレベルでの調査・対応を必要とされている方は、お問い合わせフォームよりご相談ください。
-
通知の権限を要求された際に許可する操作を行っていなければ大丈夫なのですが、深く考えずに・よく分からないまま許可してしまっていたり、その事を忘れてしまっていたりすると、インラインフレームからのクロスオリジンの通知のブロック機能が最後の防壁となって防がれていた煩わしい通知や詐欺的な通知が、機能の無効化により一斉に表に出てくるようになる恐れがあります。 ↩