Add default pwa manifest and service worker file (rails#50528)

dhh · web-flow · commit bb5e2791e08f · 2024-01-03T13:07:12.000+01:00
* Add default pwa manifest and service worker file

* Update CHANGELOG.md
diff --git a/railties/CHANGELOG.md b/railties/CHANGELOG.md
@@ -1,3 +1,7 @@
+*   Add default PWA files for manifest and service-worker that are served from `app/views/pwa` and can be dynamically rendered through erb. Mount these files explicitly at the root with default routes in the generated routes file.
+
+    *DHH*
+
 *   Updated system tests to now use headless Chrome by default for the new applications.
 
     *DHH*
diff --git a/railties/lib/rails.rb b/railties/lib/rails.rb
@@ -31,6 +31,7 @@ module Rails
   autoload :Info
   autoload :InfoController
   autoload :MailersController
+  autoload :PwaController
   autoload :WelcomeController
 
   class << self
diff --git a/railties/lib/rails/generators/rails/app/templates/app/views/layouts/application.html.erb.tt b/railties/lib/rails/generators/rails/app/templates/app/views/layouts/application.html.erb.tt
@@ -3,11 +3,13 @@
   <head>
     <title><%%= content_for(:title) || "<%= camelized %>" %></title>
     <meta name="viewport" content="width=device-width,initial-scale=1">
+    <meta name="apple-mobile-web-app-capable" content="yes">
     <%%= csrf_meta_tags %>
     <%%= csp_meta_tag %>
 
     <%%= yield :head %>
 
+    <link rel="manifest" href="/manifest.json">
     <link rel="icon" href="/icon.png" type="image/png">
     <link rel="apple-touch-icon" href="/icon.png" sizes="512x512">
     <%- if options[:skip_hotwire] || options[:skip_javascript] -%>
diff --git a/railties/lib/rails/generators/rails/app/templates/app/views/pwa/manifest.json.erb.tt b/railties/lib/rails/generators/rails/app/templates/app/views/pwa/manifest.json.erb.tt
@@ -0,0 +1,22 @@
+{
+  "name": "<%= camelized %>",
+  "icons": [
+    {
+      "src": "/icon.png",
+      "type": "image/png",
+      "sizes": "512x512"
+    },
+    {
+      "src": "/icon.png",
+      "type": "image/png",
+      "sizes": "512x512",
+      "purpose": "maskable"
+    }
+  ],
+  "start_url": "/",
+  "display": "standalone",
+  "scope": "/",
+  "description": "<%= camelized %>.",
+  "theme_color": "red",
+  "background_color": "red"
+}
diff --git a/railties/lib/rails/generators/rails/app/templates/app/views/pwa/service-worker.js b/railties/lib/rails/generators/rails/app/templates/app/views/pwa/service-worker.js
@@ -0,0 +1,26 @@
+// Add a service worker for processing Web Push notifications:
+//
+// self.addEventListener("push", async (event) => {
+//   const { title, options } = await event.data.json()
+//   event.waitUntil(self.registration.showNotification(title, options))
+// })
+// 
+// self.addEventListener("notificationclick", function(event) {
+//   event.notification.close()
+//   event.waitUntil(
+//     clients.matchAll({ type: "window" }).then((clientList) => {
+//       for (let i = 0; i < clientList.length; i++) {
+//         let client = clientList[i]
+//         let clientPath = (new URL(client.url)).pathname
+// 
+//         if (clientPath == event.notification.data.path && "focus" in client) {
+//           return client.focus()
+//         }
+//       }
+// 
+//       if (clients.openWindow) {
+//         return clients.openWindow(event.notification.data.path)
+//       }
+//     })
+//   )
+// })
diff --git a/railties/lib/rails/generators/rails/app/templates/config/routes.rb.tt b/railties/lib/rails/generators/rails/app/templates/config/routes.rb.tt
@@ -5,6 +5,10 @@ Rails.application.routes.draw do
   # Can be used by load balancers and uptime monitors to verify that the app is live.
   get "up" => "rails/health#show", as: :rails_health_check
 
+  # Render dynamic PWA files from app/views/pwa/*
+  get "service-worker" => "rails/pwa#service_worker", as: :pwa_service_worker
+  get "manifest" => "rails/pwa#manifest", as: :pwa_manifest
+
   # Defines the root path route ("/")
   # root "posts#index"
 end
diff --git a/railties/lib/rails/pwa_controller.rb b/railties/lib/rails/pwa_controller.rb
@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "rails/application_controller"
+
+class Rails::PwaController < Rails::ApplicationController # :nodoc:
+  skip_forgery_protection
+
+  def service_worker
+    render template: "pwa/service-worker", layout: false
+  end
+
+  def manifest
+    render template: "pwa/manifest", layout: false
+  end
+end

-Original file line number
+Diff line change
@@ @@ -1,3 +1,7 @@ @@
 +*   Add default PWA files for manifest and service-worker that are served from `app/views/pwa` and can be dynamically rendered through erb. Mount these files explicitly at the root with default routes in the generated routes file.
++
 +    *DHH*
++
 *   Updated system tests to now use headless Chrome by default for the new applications.
     *DHH*