From fbf6ec223f809ed19de1da73a6593c6b4321a398 Mon Sep 17 00:00:00 2001
From: rxu <rxu@mail.ru>
Date: Sun, 26 May 2024 20:45:55 +0700
Subject: [PATCH] New approach to check webpush worker update on all pages. See
 https://developer.mozilla.org/en-US/docs/Web/API/ServiceWorkerRegistration/update

---
 event/listener.php                            |  9 +++++++
 notification/method/webpush.php               |  2 +-
 styles/all/template/update_worker.js          | 27 +++++++++++++++++++
 styles/all/template/webpush.js                |  3 +--
 .../template/event/overall_footer_after.html  |  4 +++
 tests/event/listener_test.php                 |  1 +
 6 files changed, 43 insertions(+), 3 deletions(-)
 create mode 100644 styles/all/template/update_worker.js
 create mode 100644 styles/prosilver/template/event/overall_footer_after.html

diff --git a/event/listener.php b/event/listener.php
index 203d58e..eb2e4f1 100644
--- a/event/listener.php
+++ b/event/listener.php
@@ -30,6 +30,7 @@ public static function getSubscribedEvents()
 			'core.ucp_notifications_output_notification_types_modify_template_vars'	=> 'load_template_data',
 			'core.ucp_display_module_before'	=> 'load_language',
 			'core.acp_main_notice'				=> 'compatibility_notice',
+			'core.page_header_after'			=> 'service_worker_url',
 		];
 	}
 
@@ -90,4 +91,12 @@ public function compatibility_notice()
 	{
 		$this->template->assign_var('S_WPN_COMPATIBILITY_NOTICE', phpbb_version_compare(PHPBB_VERSION, '4.0.0-dev', '>='));
 	}
+
+	/**
+	 * Generate service worker URL globally for update
+	 */
+	public function service_worker_url()
+	{
+		$this->template->assign_var('U_WEBPUSH_WORKER_URL', $this->controller_helper->route('phpbb_webpushnotifications_ucp_push_worker_controller'));
+	}
 }
diff --git a/notification/method/webpush.php b/notification/method/webpush.php
index 26c9d78..8e74fbb 100644
--- a/notification/method/webpush.php
+++ b/notification/method/webpush.php
@@ -445,7 +445,7 @@ protected function clean_expired_subscriptions(array $user_subscription_map, arr
 	 * into https://myboard.url/path/to/avatar=123456789.gif
 	 *
 	 * @param string $avatar
-	 * @return string Absolute path to avatar image
+	 * @return array 'src' => Absolute path to avatar image
 	 */
 	protected function prepare_avatar($avatar)
 	{
diff --git a/styles/all/template/update_worker.js b/styles/all/template/update_worker.js
new file mode 100644
index 0000000..3d81103
--- /dev/null
+++ b/styles/all/template/update_worker.js
@@ -0,0 +1,27 @@
+'use strict';
+
+function webpushWorkerUpdate() {
+	if ('serviceWorker' in navigator) {
+		navigator.serviceWorker.register(serviceWorkerUrl)
+			.then((registration) => {
+				registration.update();
+			})
+			.catch(error => {
+				// Service worker could not be updated
+				console.info(error);
+			});
+	}
+}
+
+function domReady(callBack) {
+	if (document.readyState === 'loading') {
+		document.addEventListener('DOMContentLoaded', callBack);
+	} else {
+		callBack();
+	}
+}
+
+domReady(() => {
+	/* global serviceWorkerUrl */
+	webpushWorkerUpdate();
+});
diff --git a/styles/all/template/webpush.js b/styles/all/template/webpush.js
index 120b1ef..c326fe1 100644
--- a/styles/all/template/webpush.js
+++ b/styles/all/template/webpush.js
@@ -57,10 +57,9 @@ function PhpbbWebpush() {
 
 		if ('serviceWorker' in navigator && 'PushManager' in window) {
 			navigator.serviceWorker.register(serviceWorkerUrl)
-				.then((registration) => {
+				.then(() => {
 					subscribeButton.addEventListener('click', subscribeButtonHandler);
 					unsubscribeButton.addEventListener('click', unsubscribeButtonHandler);
-					registration.update();
 
 					updateButtonState();
 				})
diff --git a/styles/prosilver/template/event/overall_footer_after.html b/styles/prosilver/template/event/overall_footer_after.html
new file mode 100644
index 0000000..c5d818c
--- /dev/null
+++ b/styles/prosilver/template/event/overall_footer_after.html
@@ -0,0 +1,4 @@
+<script>
+	var serviceWorkerUrl = '{{ U_WEBPUSH_WORKER_URL }}';
+</script>
+{% INCLUDEJS('@phpbb_webpushnotifications/update_worker.js') %}
diff --git a/tests/event/listener_test.php b/tests/event/listener_test.php
index 3045ad6..b226de9 100644
--- a/tests/event/listener_test.php
+++ b/tests/event/listener_test.php
@@ -117,6 +117,7 @@ public function test_getSubscribedEvents()
 			'core.ucp_notifications_output_notification_types_modify_template_vars',
 			'core.ucp_display_module_before',
 			'core.acp_main_notice',
+			'core.page_header_after',
 		], array_keys(\phpbb\webpushnotifications\event\listener::getSubscribedEvents()));
 	}