rack-spa 0.10.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f987e16a684d7095a44f36c3aa3c829d16f13a6d6eff194b3275a2a546941afc
-  data.tar.gz: dc4df61474e03ef8c60d80f72a3dace7c32b17105a3466dbaede1e95d9bfc62b
+  metadata.gz: df310728de6bc267ad3d202364d7500429e18cdc2d9e14f96de887b6bbeae47d
+  data.tar.gz: 8347024dc1cf3a84b1b880687680e14f1299915a0ec60c83af466e1c7f2fc86c
 SHA512:
-  metadata.gz: 8a31ce6bd3909f435824c945dce2f99037fa9acac5aca3dbd916bcbe61999c6bf93d2b0e47833217d37015980d50990cd88039ca85d0bd15074e535d1a1ea358
-  data.tar.gz: e62de5586131f91df9f0d5f52bcea43cc1cf525597448a8dd3f4904f342e82cddb3001094ddc13dea481022f89928f42fbb59ff6103cc34492bc4de45d6b3516
+  metadata.gz: 1393398e04629cd0f7af9d17c2b351340f223312c75dc6fb73286e1a91c21ab83dac8ed986a8f41a3f0513caa664fa511186c5b1cb17992969fa55b995b7a7f5
+  data.tar.gz: 78d5aeb76e1d48a8ab1d1ad0b136c38a0c3da61fe1865a2ff8e6eb47d0751b4610609a1983a0fb0e431ef997f7a09eff5fd91bfdc9c33f6aac4ebf109d21be9b

data/lib/rack/dynamic_config_writer.rb

@@ -30,27 +30,42 @@ module Rack
       global_assign: GLOBAL_ASSIGN,
       backup_suffix: BACKUP_SUFFIX
     )
-      @index_html_path = index_html_path
+      @index_html_path = index_html_path.to_s
       @global_assign = global_assign
-      @index_html_backup = index_html_path + backup_suffix
+      @index_html_backup = @index_html_path + backup_suffix
     end
 
+    # Copy +index_html_path+ to index.html.original (see +BACKUP_SUFFIX+),
+    # and add the dynamic config to +index_html_path+.
+    # Use +as_string+ to avoid file writes.
     def emplace(keys_and_values)
-      self.prepare
-      json = JSON.generate(keys_and_values)
-      script = "#{@global_assign}=#{json}"
+      self.ensure_unmodified_html_backup
       ::File.open(@index_html_backup) do |f|
-        doc = Nokogiri::HTML5(f)
-        doc.at("head").prepend_child("<script>#{script}</script>")
-        ::File.write(@index_html_path, doc.serialize)
+        new_html = self.serialize(f, keys_and_values)
+        ::File.write(@index_html_path, new_html)
       end
     end
 
-    protected def prepare
+    protected def ensure_unmodified_html_backup
       return if ::File.exist?(@index_html_backup)
       ::FileUtils.move(@index_html_path, @index_html_backup)
     end
 
+    # Return the new index.html with dynamic config as a string.
+    def as_string(keys_and_values)
+      ::File.open(@index_html_path) do |f|
+        return self.serialize(f, keys_and_values)
+      end
+    end
+
+    protected def serialize(f, keys_and_values)
+      json = JSON.generate(keys_and_values)
+      script = "#{@global_assign}=#{json}"
+      doc = Nokogiri::HTML5(f)
+      doc.at("head").prepend_child("<script>#{script}</script>")
+      return doc.serialize
+    end
+
     def self.pick_env(regex_or_prefix)
       return ENV.to_a.select { |(k, _v)| k.start_with?(regex_or_prefix) }.to_h if regex_or_prefix.is_a?(String)
       return ENV.to_a.select { |(k, _v)| regex_or_prefix.match?(k) }.to_h

data/lib/rack/spa_app.rb

@@ -7,16 +7,31 @@ require "rack/spa_rewrite"
 
 module Rack
   class SpaApp
-    def self.dependencies(build_folder, immutable: true, enforce_ssl: true, service_worker_allowed: nil)
+    # Return Rack middleware dependencies for the SPA app.
+    # @param build_folder [String,Pathname] Path to the build folder.
+    # @param immutable [true,false] True to use +Rack::Immutable+ middleware,
+    #   so that files that look fingerprinted (<name>.<git sha>.ext) get immutable cache headers.
+    # @param enforce_ssl [true,false] True to use +Rack::SsslEnforcer+. Requires `rack-ssl-enforcer` gem.
+    # @param service_worker_allowed [String,nil] Scope of the server worker for the Service-Worker-Allowed header.
+    # @param index_bytes [String,nil] Bytes of the app's index.html file. If not passed,
+    #   use the contents of `<build_folder>/index.html`.
+    def self.dependencies(
+      build_folder,
+      immutable: true,
+      enforce_ssl: true,
+      service_worker_allowed: nil,
+      index_bytes: nil
+    )
+      index_bytes ||= File.read("#{build_folder}/index.html")
       result = []
       result << [Rack::SslEnforcer, {redirect_html: false}] if enforce_ssl
       result << [Rack::ConditionalGet, {}]
       result << [Rack::ETag, {}]
       result << [Rack::Immutable, {match: immutable.is_a?(TrueClass) ? nil : immutable}] if immutable
-      result << [Rack::SpaRewrite, {index_path: "#{build_folder}/index.html", html_only: true}]
+      result << [Rack::SpaRewrite, {index_bytes:, html_only: true}]
       result << [Rack::ServiceWorkerAllowed, {scope: service_worker_allowed}] if service_worker_allowed
       result << [Rack::Static, {urls: [""], root: build_folder.to_s, cascade: true}]
-      result << [Rack::SpaRewrite, {index_path: "#{build_folder}/index.html", html_only: false}]
+      result << [Rack::SpaRewrite, {index_bytes:, html_only: false}]
       return result
     end
 
@@ -28,8 +43,8 @@ module Rack
       builder.run Rack::LambdaApp.new(->(_) { raise "Should not see SpaApp fallback" })
     end
 
-    def self.run_spa_app(builder, build_folder, enforce_ssl: true, immutable: true, **kw)
-      deps = self.dependencies(build_folder, enforce_ssl:, immutable:, **kw)
+    def self.run_spa_app(builder, build_folder, enforce_ssl: true, immutable: true, index_bytes: nil, **kw)
+      deps = self.dependencies(build_folder, enforce_ssl:, immutable:, index_bytes:, **kw)
       self.install(builder, deps)
       self.run(builder)
     end

data/lib/rack/spa_rewrite.rb

@@ -3,21 +3,24 @@
 require "rack"
 
 module Rack
+  # Intercept HTTP requests and serve index.html.
+  # This middleware caches the index_html file (or the bytes can be passed in).
+  # If the file contents change, new content is NOT served.
   class SpaRewrite
     ALLOWED_VERBS = ["GET", "HEAD", "OPTIONS"].freeze
     ALLOW_HEADER = ALLOWED_VERBS.join(", ")
 
-    def initialize(app, index_path:, html_only:)
+    # @param app The Rack app.
+    # @param index_bytes [String] The index.html contents to serve.
+    # @param html_only [true,false] True to only intercept html requests,
+    #   false to intercept all requests. Usually you want to setup SpaRewrite
+    #   first using html:false, then html:true as the final Rack app/middleware.
+    def initialize(app, index_bytes:, html_only:)
       @app = app
-      @index_path = index_path
+      @index_bytes = index_bytes
       @html_only = html_only
-      begin
-        @index_mtime = ::File.mtime(@index_path).httpdate
-      rescue Errno::ENOENT
-        @index_mtime = Time.at(0)
-      end
-      @index_bytes = nil
       @head = Rack::Head.new(->(env) { get env })
+      @started_at = Time.now.httpdate
     end
 
     def call(env)
@@ -37,15 +40,12 @@ module Rack
       return [200, {"Allow" => ALLOW_HEADER, Rack::CONTENT_LENGTH => "0"}, []] if
         request.options?
 
-      lastmod = ::File.mtime(@index_path)
-      lastmodhttp = lastmod.httpdate
-      return [304, {}, []] if request.get_header("HTTP_IF_MODIFIED_SINCE") == lastmodhttp
+      return [304, {}, []] if request.get_header("HTTP_IF_MODIFIED_SINCE") == @started_at
 
-      @index_bytes = ::File.read(@index_path) if @index_bytes.nil? || @index_mtime < lastmodhttp
       headers = {
         "content-length" => @index_bytes.bytesize.to_s,
         "content-type" => "text/html",
-        "last-modified" => lastmodhttp,
+        "last-modified" => @started_at,
       }
       return [200, headers, [@index_bytes]]
     end

data/lib/rack_spa.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RackSpa
-  VERSION = "0.10.0"
+  VERSION = "0.11.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rack-spa
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.11.0
 platform: ruby
 authors:
 - Lithic Tech
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-03 00:00:00.000000000 Z
+date: 2024-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri