docs(messaging, web): update the documentation for how to load the se…

…rvice worker in Flutter 3.22 (#12836) * doc(messaging, web): update the documentation for how to load the service worker in Flutter 3.22 * doc(messaging, web): update the documentation for how to load the service worker in Flutter 3.22
firebase · May 29, 2024 · 9659749 · 9659749
1 parent 8e0ced4
commit 9659749
Show file tree

Hide file tree

Showing 8 changed files with 68 additions and 62 deletions.
diff --git a/docs/cloud-messaging/receive.md b/docs/cloud-messaging/receive.md
@@ -185,9 +185,23 @@ messaging.onBackgroundMessage((message) => {
 
 The file must import both the app and messaging SDKs, initialize Firebase and expose the `messaging` variable.
 
-Next, the worker must be registered. Within the entry file, **after** the `main.dart.js` file has loaded, register your worker:
+Next, the worker must be registered. Within the `index.html` file, register the worker by modifying the `<script>` tag which bootstraps Flutter:
+
+```html
+<script src="flutter_bootstrap.js" async>
+  if ('serviceWorker' in navigator) {
+    window.addEventListener('load', function () {
+      navigator.serviceWorker.register('firebase-messaging-sw.js', {
+        scope: '/firebase-cloud-messaging-push-scope',
+      });
+    });
+  }
+</script>
+```
+
+If you are still using the old templating system, you can register the worker by modifying the `<script>` tag which bootstraps Flutter as follows:
 
-```js
+```html
 <html>
 <body>
   <script>
@@ -260,6 +274,7 @@ Next, the worker must be registered. Within the entry file, **after** the `main.
         loadMainDartJs();
       }
   </script>
+</body>
 ```
 
 Next restart your Flutter application. The worker will be registered and any background messages will be handled via this file.

diff --git a/packages/firebase_messaging/firebase_messaging/example/web/favicon.png b/packages/firebase_messaging/firebase_messaging/example/web/favicon.png
diff --git a/packages/firebase_messaging/firebase_messaging/example/web/icons/Icon-192.png b/packages/firebase_messaging/firebase_messaging/example/web/icons/Icon-192.png
diff --git a/packages/firebase_messaging/firebase_messaging/example/web/icons/Icon-512.png b/packages/firebase_messaging/firebase_messaging/example/web/icons/Icon-512.png
diff --git a/...s/firebase_messaging/firebase_messaging/example/web/icons/Icon-maskable-192.png b/...s/firebase_messaging/firebase_messaging/example/web/icons/Icon-maskable-192.png
diff --git a/...s/firebase_messaging/firebase_messaging/example/web/icons/Icon-maskable-512.png b/...s/firebase_messaging/firebase_messaging/example/web/icons/Icon-maskable-512.png
diff --git a/packages/firebase_messaging/firebase_messaging/example/web/index.html b/packages/firebase_messaging/firebase_messaging/example/web/index.html
@@ -1,78 +1,34 @@
 <!DOCTYPE html>
 <html>
   <head>
+    <base href="$FLUTTER_BASE_HREF" />
+
     <meta charset="UTF-8" />
+    <meta content="IE=Edge" http-equiv="X-UA-Compatible" />
+    <meta name="description" content="A new Flutter project." />
+
+    <!-- iOS meta tags & icons -->
+    <meta name="apple-mobile-web-app-capable" content="yes" />
+    <meta name="apple-mobile-web-app-status-bar-style" content="black" />
+    <meta name="apple-mobile-web-app-title" content="example" />
+    <link rel="apple-touch-icon" href="icons/Icon-192.png" />
+
+    <!-- Favicon -->
+    <link rel="icon" type="image/png" href="favicon.png" />
+
     <title>example</title>
+    <link rel="manifest" href="manifest.json" />
   </head>
   <body>
-    <script>
-      var serviceWorkerVersion = null;
-      var scriptLoaded = false;
-      function loadMainDartJs() {
-        if (scriptLoaded) {
-          return;
-        }
-        scriptLoaded = true;
-        var scriptTag = document.createElement('script');
-        scriptTag.src = 'main.dart.js';
-        scriptTag.type = 'application/javascript';
-        document.body.append(scriptTag);
-      }
-
+    <script src="flutter_bootstrap.js" async>
       if ('serviceWorker' in navigator) {
         // Service workers are supported. Use them.
         window.addEventListener('load', function () {
           // Register Firebase Messaging service worker.
           navigator.serviceWorker.register('firebase-messaging-sw.js', {
             scope: '/firebase-cloud-messaging-push-scope',
           });
-
-          // Wait for registration to finish before dropping the <script> tag.
-          // Otherwise, the browser will load the script multiple times,
-          // potentially different versions.
-          var serviceWorkerUrl =
-            'flutter_service_worker.js?v=' + serviceWorkerVersion;
-
-          navigator.serviceWorker.register(serviceWorkerUrl).then((reg) => {
-            function waitForActivation(serviceWorker) {
-              serviceWorker.addEventListener('statechange', () => {
-                if (serviceWorker.state == 'activated') {
-                  console.log('Installed new service worker.');
-                  loadMainDartJs();
-                }
-              });
-            }
-            if (!reg.active && (reg.installing || reg.waiting)) {
-              // No active web worker and we have installed or are installing
-              // one for the first time. Simply wait for it to activate.
-              waitForActivation(reg.installing ?? reg.waiting);
-            } else if (!reg.active.scriptURL.endsWith(serviceWorkerVersion)) {
-              // When the app updates the serviceWorkerVersion changes, so we
-              // need to ask the service worker to update.
-              console.log('New service worker available.');
-              reg.update();
-              waitForActivation(reg.installing);
-            } else {
-              // Existing service worker is still good.
-              console.log('Loading app from service worker.');
-              loadMainDartJs();
-            }
-          });
-
-          // If service worker doesn't succeed in a reasonable amount of time,
-          // fallback to plaint <script> tag.
-          setTimeout(() => {
-            if (!scriptLoaded) {
-              console.warn(
-                'Failed to load app from service worker. Falling back to plain <script> tag.'
-              );
-              loadMainDartJs();
-            }
-          }, 4000);
         });
-      } else {
-        // Service workers not supported. Just drop the <script> tag.
-        loadMainDartJs();
       }
     </script>
   </body>

diff --git a/packages/firebase_messaging/firebase_messaging/example/web/manifest.json b/packages/firebase_messaging/firebase_messaging/example/web/manifest.json
@@ -0,0 +1,35 @@
+{
+    "name": "example",
+    "short_name": "example",
+    "start_url": ".",
+    "display": "standalone",
+    "background_color": "#0175C2",
+    "theme_color": "#0175C2",
+    "description": "A new Flutter project.",
+    "orientation": "portrait-primary",
+    "prefer_related_applications": false,
+    "icons": [
+        {
+            "src": "icons/Icon-192.png",
+            "sizes": "192x192",
+            "type": "image/png"
+        },
+        {
+            "src": "icons/Icon-512.png",
+            "sizes": "512x512",
+            "type": "image/png"
+        },
+        {
+            "src": "icons/Icon-maskable-192.png",
+            "sizes": "192x192",
+            "type": "image/png",
+            "purpose": "maskable"
+        },
+        {
+            "src": "icons/Icon-maskable-512.png",
+            "sizes": "512x512",
+            "type": "image/png",
+            "purpose": "maskable"
+        }
+    ]
+}