universal_renderer 0.3.0 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 855568dc398e2ac6878a59fa2ff428e89f9a838a9a12097241116826df44bc37
-  data.tar.gz: d22887db777b6fef7183a95be0e17a72867824d7fc43b7871796acdaa663fd0f
+  metadata.gz: 6806088bc3c54db5b3579f8d7b828c1b4e93e7d0a90c9b8bed79435c784b7e7a
+  data.tar.gz: 5bc8d3ecb5846bdcd8b353bb1174aaf46fdef5e0ba83d7cf5a792a01117ac8b4
 SHA512:
-  metadata.gz: 8c4c485a5e7a04cb80a8a8bd03701429eced4e7abc55eb72dea7e979d09b3bda1f524a68e40b73407c2c5f3ca21c5cd96ca1df966b36ab8bf99cac7edde98996
-  data.tar.gz: 4ce4705bec4c0ee0505b901ca5319d5f0958e122f0849278c746a7fbc62342b8849709bb695dc1083e25ddc1fa077ac5384f4dcc770768b8420af8f4ca844b4c
+  metadata.gz: 6eff6034910021a6c6e110ef1a13e0d855e5539670fc61f1da09b08bc7af63d36c032f63c5af36f766808bee1a522b6fa2b5cb6eb0158d54d8d41d598eadf73f
+  data.tar.gz: 66a6282ee8c5e340a128ffaf706d1493206e4d21955a1a4a8ce68ee7cabeee80b974a95d23227f98c9978509a4aeaa67c73857fa25bacafb06925fb9a03cf611

data/README.md

@@ -1,5 +1,7 @@
 # UniversalRenderer
 
+[![Gem Version](https://img.shields.io/gem/v/universal_renderer)](https://rubygems.org/gems/universal_renderer) [![NPM Version](https://img.shields.io/npm/v/universal-renderer)](https://www.npmjs.com/package/universal-renderer)
+
 A streamlined solution for integrating Server-Side Rendering (SSR) into Rails applications.
 
 ## Overview
@@ -66,10 +68,18 @@ class ProductsController < ApplicationController
     # @ssr will now contain the SSR response, where the symbolized keys
     # are the same keys returned by the SSR server response.
   end
+
+  def default_render
+    # If you want to re-use the same layout across multiple actions.
+    # You can also put this in your ApplicationController.
+    render "ssr/index"
+  end
 end
 ```
 
 ```erb
+<%# "ssr/index" %>
+
 <%# Now you can use the instance variable @ssr in your layout. %>
 <%# We'll send it with keys :meta, :styles, :root, and :state below. %>
 <%# We can use the provided sanitize_ssr helper to sanitize our content %>

data/lib/generators/universal_renderer/install_generator.rb

@@ -5,13 +5,5 @@ module UniversalRenderer
     def copy_initializer
       template "initializer.rb", "config/initializers/universal_renderer.rb"
     end
-
-    def include_concern
-      application_controller = "app/controllers/application_controller.rb"
-
-      inject_into_class application_controller,
-                        "ApplicationController",
-                        "  include UniversalRenderer::Rendering\n"
-    end
   end
 end

data/lib/universal_renderer/client/stream.rb

@@ -62,7 +62,8 @@ module UniversalRenderer
              Errno::EHOSTUNREACH,
              Net::OpenTimeout,
              Net::ReadTimeout,
-             SocketError => e
+             SocketError,
+             IOError => e
         uri_str_for_conn_error =
           stream_uri_obj ? stream_uri_obj.to_s : full_ssr_url_for_log
 

data/lib/universal_renderer/engine.rb

@@ -1,7 +1,7 @@
 module UniversalRenderer
   class Engine < ::Rails::Engine
     ActiveSupport.on_load(:action_controller) do
-      include UniversalRenderer::Rendering
+      include UniversalRenderer::Renderable
     end
   end
 end

data/lib/universal_renderer/{rendering.rb → renderable.rb}

@@ -1,5 +1,5 @@
 module UniversalRenderer
-  module Rendering
+  module Renderable
     extend ActiveSupport::Concern
 
     included do
@@ -31,7 +31,7 @@ module UniversalRenderer
       @ssr =
         UniversalRenderer::Client::Base.fetch(
           request.original_url,
-          @universal_renderer_props
+          @universal_renderer_props,
         )
     end
 
@@ -39,25 +39,27 @@ module UniversalRenderer
       self.class.try(:ssr_streaming_preference)
     end
 
-    private
+    def render(*args, **kwargs)
+      return super unless self.class.enable_ssr
 
-    def default_render
-      return super unless self.class.enable_ssr && request.format.html?
+      return super unless request.format.html?
 
       if use_ssr_streaming?
-        render_ssr_stream
+        render_ssr_stream(*args, **kwargs)
       else
         fetch_ssr
         super
       end
     end
 
-    def render_ssr_stream
+    private
+
+    def render_ssr_stream(*args, **kwargs)
       set_streaming_headers
 
-      full_layout = render_to_string
+      full_layout = render_to_string(*args, **kwargs)
 
-      split_index = full_layout.index("<!-- SSR_META -->")
+      split_index = full_layout.index(SSR::Placeholders::META)
       before_meta = full_layout[0...split_index]
       after_meta = full_layout[split_index..]
 
@@ -70,10 +72,19 @@ module UniversalRenderer
           request.original_url,
           current_props,
           after_meta,
-          response
+          response,
         )
 
-      handle_ssr_stream_fallback(response) unless streaming_succeeded
+      # SSR streaming failed or was not possible (e.g. server down, config missing).
+      unless streaming_succeeded
+        Rails.logger.error(
+          "SSR stream fallback: " \
+            "Streaming failed, proceeding with standard rendering.",
+        )
+        response.stream.write(after_meta)
+      end
+
+      response.stream.close unless response.stream.closed?
     end
 
     def initialize_props
@@ -147,22 +158,5 @@ module UniversalRenderer
       # Remove Content-Length header to prevent buffering.
       response.headers.delete("Content-Length")
     end
-
-    def handle_ssr_stream_fallback(response)
-      # SSR streaming failed or was not possible (e.g. server down, config missing).
-      # Ensure response hasn\'t been touched in a way that prevents a new render.
-      return unless response.committed? || response.body.present?
-
-      Rails.logger.error(
-        "SSR stream fallback:" \
-          "Cannot render default fallback template because response was already committed or body present."
-      )
-      # Close the stream if it\'s still open to prevent client connection from hanging
-      # when we can\'t render a fallback page due to already committed response
-      response.stream.close unless response.stream.closed?
-
-      # If response not committed, no explicit render is called here,
-      # allowing Rails\' default rendering behavior to take over.
-    end
   end
 end

data/lib/universal_renderer/ssr/helpers.rb

@@ -6,7 +6,7 @@ module UniversalRenderer
       #   This placeholder is used by the rendering process to inject SSR metadata.
       #   @return [String] The HTML-safe string "<!-- SSR_META -->".
       def ssr_meta
-        "<!-- SSR_META -->".html_safe
+        Placeholders::META.html_safe
       end
 
       # @!method ssr_body
@@ -14,7 +14,7 @@ module UniversalRenderer
       #   This placeholder is used by the rendering process to inject the main SSR body.
       #   @return [String] The HTML-safe string "<!-- SSR_BODY -->".
       def ssr_body
-        "<!-- SSR_BODY -->".html_safe
+        Placeholders::BODY.html_safe
       end
 
       # @!method sanitize_ssr(html)

data/lib/universal_renderer/ssr/placeholders.rb

@@ -0,0 +1,8 @@
+module UniversalRenderer
+  module SSR
+    module Placeholders
+      META = "<!-- SSR_META -->".freeze
+      BODY = "<!-- SSR_BODY -->".freeze
+    end
+  end
+end

data/lib/universal_renderer/version.rb

@@ -1,3 +1,3 @@
 module UniversalRenderer
-  VERSION = "0.3.0".freeze
+  VERSION = "0.3.2".freeze
 end

data/lib/universal_renderer.rb

@@ -1,11 +1,15 @@
 require "universal_renderer/version"
 require "universal_renderer/engine"
 require "universal_renderer/configuration"
-require "universal_renderer/ssr/scrubber"
+
+require "universal_renderer/renderable"
+
 require "universal_renderer/client/base"
 require "universal_renderer/client/stream"
-require "universal_renderer/rendering"
+
 require "universal_renderer/ssr/helpers"
+require "universal_renderer/ssr/placeholders"
+require "universal_renderer/ssr/scrubber"
 
 module UniversalRenderer
   class << self

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: universal_renderer
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.2
 platform: ruby
 authors:
 - thaske
@@ -60,8 +60,9 @@ files:
 - lib/universal_renderer/client/stream/setup.rb
 - lib/universal_renderer/configuration.rb
 - lib/universal_renderer/engine.rb
-- lib/universal_renderer/rendering.rb
+- lib/universal_renderer/renderable.rb
 - lib/universal_renderer/ssr/helpers.rb
+- lib/universal_renderer/ssr/placeholders.rb
 - lib/universal_renderer/ssr/scrubber.rb
 - lib/universal_renderer/version.rb
 homepage: https://github.com/thaske/universal_renderer