create-eigen-game 0.16.2 → 0.17.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-eigen-game",
-  "version": "0.16.2",
+  "version": "0.17.0",
   "license": "MIT",
   "description": "Scaffold an EigenInteractive game Worker and Flutter app without cloning the engine repositories.",
   "type": "module",

package/templates/app-overlay/web/firebase-messaging-sw.js.template

@@ -1,7 +1,7 @@
 // Keep this version aligned with the Firebase JS SDK supported by the
 // firebase_core_web version resolved by the Flutter app.
-importScripts("https://www.gstatic.com/firebasejs/12.15.0/firebase-app-compat.js");
-importScripts("https://www.gstatic.com/firebasejs/12.15.0/firebase-messaging-compat.js");
+importScripts("https://www.gstatic.com/firebasejs/12.19.0/firebase-app-compat.js");
+importScripts("https://www.gstatic.com/firebasejs/12.19.0/firebase-messaging-compat.js");
 importScripts("firebase-config.js");
 
 // `firebase:configure` generates this public configuration from the Web app

package/templates/app-overlay/web/flutter_bootstrap.js.template

@@ -1,30 +1,43 @@
 {{flutter_js}}
 {{flutter_build_config}}
 
-(async () => {
-  if ("serviceWorker" in navigator) {
-    await navigator.serviceWorker
-      .register("firebase-messaging-sw.js", {
-        scope: "/firebase-cloud-messaging-push-scope",
-      })
-      .catch((error) => {
-        console.warn(
-          "Firebase Messaging service worker registration failed",
-          error,
-        );
-      });
-  }
+// Flutter starts at once. Neither worker below is anything this page waits on,
+// so they register beside it rather than ahead of it.
+_flutter.loader.load();
 
-  if ("serviceWorker" in navigator) {
-    // The app shell's own cache, registered at the root scope so it can answer
-    // a cold start with no network. Separate from the messaging worker above,
-    // which owns only its push scope.
-    await navigator.serviceWorker
-      .register("eigen_offline_sw.js", { scope: "/" })
-      .catch((error) => {
-        console.warn("Offline shell service worker registration failed", error);
-      });
-  }
+if ("serviceWorker" in navigator) {
+  // The app's own worker, generated by Workbox (workbox-config.cjs): the
+  // precached build, which is what lets the app open with no network.
+  navigator.serviceWorker.register("sw.js").catch((error) => {
+    console.warn("App service worker registration failed", error);
+  });
+  // Firebase Messaging's worker, which owns only its push scope.
+  navigator.serviceWorker.register("firebase-messaging-sw.js", { scope: "/firebase-cloud-messaging-push-scope" }).catch((error) => {
+    console.warn("Firebase Messaging service worker registration failed", error);
+  });
+}
 
-  _flutter.loader.load();
-})();
+// CanvasKit and the Firebase JS SDK load from Google's CDN, which the app's
+// worker caches as they pass through it. A first visit fetches them before that
+// worker controls the page, so the page copies what it loaded into the same
+// cache ("eigen-cdn" in workbox-config.cjs), and drops versions of each it no
+// longer loads. Without this, the first visit would not open offline.
+if ("caches" in self && "PerformanceObserver" in self) {
+  const cdn = /^https:\/\/www\.gstatic\.com\/(flutter-canvaskit|firebasejs)\/[^/]+\//;
+  new PerformanceObserver(async (entries) => {
+    for (const { name } of entries.getEntries()) {
+      const loaded = cdn.exec(name);
+      if (!loaded) continue;
+      try {
+        const cache = await caches.open("eigen-cdn");
+        if (!(await cache.match(name))) await cache.add(name);
+        for (const request of await cache.keys()) {
+          const cached = cdn.exec(request.url);
+          if (cached && cached[1] === loaded[1] && cached[0] !== loaded[0]) await cache.delete(request);
+        }
+      } catch {
+        // Only a later offline start is at stake, and the next load tries again.
+      }
+    }
+  }).observe({ type: "resource", buffered: true });
+}

package/templates/ci/.github/workflows/checks.yml.template

@@ -109,17 +109,19 @@ jobs:
         run: flutter test
 
       # A VM widget test can pass while a dependency still imports dart:io or
-      # calls an unsupported plugin. Compiling the real web entrypoint is
-      # what actually proves it ships, mirroring eigen-flutter's own `example`
-      # job, which does the same for the RPS reference app.
+      # calls an unsupported plugin. Building the real web app is what actually
+      # proves it ships, mirroring eigen-flutter's own `example` job, which does
+      # the same for the RPS reference app. `build:web` is the deploy's own
+      # build: Flutter, then the service worker Workbox generates from it, so
+      # the root's Node tools are installed first.
       #
       # No Android SDK step in this job, for the same reason
       # `create-eigen-game`'s own `scaffold-e2e.mjs` check skips one:
       # `flutter analyze`/`test`/`build web` don't need it, and it would
       # roughly double this job for no extra coverage. The Android build is
       # verified for real, with a real signing config, in `release.yml`.
+      - name: Install root dependencies
+        run: {{PACKAGE_MANAGER}} install
+
       - name: Build web
-        working-directory: app
-        run: >
-          flutter build web --release
-          --dart-define-from-file=app-config.json
+        run: {{PACKAGE_MANAGER}} run build:web

package/templates/project/README.md

@@ -88,8 +88,9 @@ values in `app/app-config.json`, then deploy both halves together:
 {{PACKAGE_MANAGER}} run deploy
 ```
 
-That builds Flutter into `server/public/` and deploys one Worker containing the
-SPA and API. The app is `/`; invite and game URLs open the installed native app
+That builds Flutter into `server/public/`, generates the service worker that lets
+the web app open offline (`workbox-config.cjs`), and deploys one Worker
+containing the SPA and API. The app is `/`; invite and game URLs open the installed native app
 or the browser SPA; the native install landing page is `/download`.
 
 Configure Android, Flutter Web, and the messaging service worker together:

package/templates/project/package.json

@@ -3,7 +3,7 @@
   "private": true,
   "scripts": {
     "build:android": "cd app && flutter build appbundle --release --dart-define-from-file=app-config.json",
-    "build:web": "cd app && flutter build web --release --output ../server/public --dart-define-from-file=app-config.json",
+    "build:web": "cd app && flutter build web --release --output ../server/public --dart-define-from-file=app-config.json && cd .. && workbox generateSW workbox-config.cjs",
     "contract": "cd server && {{PACKAGE_MANAGER}} run contract && cd ../app && dart run eigen_codegen:generate_payloads --contract ../server/game-contract.json --output lib/game/generated/payloads.dart --fixtures-output test/fixtures",
     "contract:check": "cd server && {{PACKAGE_MANAGER}} run contract:check && cd ../app && dart run eigen_codegen:generate_payloads --contract ../server/game-contract.json --output lib/game/generated/payloads.dart --fixtures-output test/fixtures --check",
     "deploy": "{{PACKAGE_MANAGER}} run build:web && cd server && {{PACKAGE_MANAGER}} run deploy",
@@ -12,6 +12,7 @@
     "lint": "biome check ."
   },
   "devDependencies": {
-    "@biomejs/biome": "2.5.12"
+    "@biomejs/biome": "2.5.12",
+    "workbox-cli": "7.4.1"
   }
 }

package/templates/project/workbox-config.cjs

@@ -0,0 +1,45 @@
+// The web app's service worker, generated by Workbox from the Flutter build
+// (decision 0014). `build:web` runs it after building
+// Flutter into `server/public/`.
+//
+// Every file the app is built from is precached when the worker installs, so
+// the app opens with no network from the first visit on, and always from one
+// consistent build. A deploy reaches a player as a new worker that precaches
+// the new build beside the old one and takes over once no tab still runs the
+// old build, or at once when the app asks it to because the engine requires the
+// update.
+
+// Paths the game Worker answers itself rather than the app shell: its
+// `run_worker_first` routes in wrangler.jsonc, less `/join/*` and `/game/*`,
+// which render the app. A navigation to any other path opens the app.
+const workerRoutes = [/^\/api\//, /^\/avatars\//, /^\/\.well-known\//, /^\/(health|download|terms|privacy|delete-account|robots\.txt|sitemap\.xml|site\.webmanifest)$/];
+
+module.exports = {
+  globDirectory: "server/public",
+  swDest: "server/public/sw.js",
+  globPatterns: ["index.html", "flutter_bootstrap.js", "main.dart.*", "manifest.json", "favicon.png", "icons/**", "assets/**"],
+  globIgnores: ["**/*.map", "**/*.symbols"],
+  // `main.dart.js` alone is several megabytes, and a game's assets may be too.
+  // A file over the limit would be left out with only a warning, and the app
+  // would then fail offline, so the limit is set well above anything expected.
+  maximumFileSizeToCacheInBytes: 32 * 1024 * 1024,
+  navigateFallback: "index.html",
+  navigateFallbackDenylist: workerRoutes,
+  runtimeCaching: [
+    {
+      // CanvasKit and the Firebase JS SDK load from Google's CDN at URLs that
+      // name their version, so a cached copy is never stale. The page adds what
+      // a first visit loaded before this worker controlled it (see
+      // web/flutter_bootstrap.js), under the same cache name.
+      urlPattern: /^https:\/\/www\.gstatic\.com\/(flutter-canvaskit|firebasejs)\//,
+      handler: "CacheFirst",
+      options: { cacheName: "eigen-cdn", cacheableResponse: { statuses: [200] } },
+    },
+  ],
+  skipWaiting: false,
+  clientsClaim: true,
+  cleanupOutdatedCaches: true,
+  inlineWorkboxRuntime: true,
+  sourcemap: false,
+  mode: "production",
+};

package/templates/app-overlay/web/README.md

@@ -1,11 +0,0 @@
-# Web assets
-
-`sqlite3.wasm` and `drift_worker.js` are drift's web runtime, taken verbatim
-from the [drift 2.35.0
-release](https://github.com/simolus3/drift/releases/tag/drift-2.35.0). They are
-served from the app's own origin because that is where `LocalDatabase` looks for
-them, and they are what gives a browser the storage offline play needs.
-
-Replace both together whenever the `drift` constraint in `eigen_flutter`'s
-pubspec moves, and take them from the matching release: the worker and the
-module are one pair.