universal_renderer 0.4.3 → 0.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 551cd8e80275fa95b8c3f66672f4a4262a25f5f0038fe4c45375b9bc852fbabe
-  data.tar.gz: bad53819a7dfdbdb10fbe1d3317e3877fcb05dc4fc2663ed5954e4975d3bd5b3
+  metadata.gz: 40fcb0b84e6de636246a3b1d47e128d511bc0246b6a871fa2250a30907463987
+  data.tar.gz: 53b3200c0b02084ee00a534cbbc22513b9d616ff32ab9fcc98075a161495b1fd
 SHA512:
-  metadata.gz: 0eecc4335c6c69929077c77db58fd22e7dbc9db04eeb78efa16826e2b8a35425c270990c96141adf842db4a5d725eacda04f277edbab60f7df41b0580a9b1252
-  data.tar.gz: 4df736ee5b781353f2543f00badc3efbdecd1eebb66a2e6405ff8136599a0f1136ef2fc52dc2d27732cbf7c84bf15a3eb904d3303e7367e1b7c8923fdf0d176c
+  metadata.gz: 5e028737cb85c1e220e26afe9491e0b8f49e922cd7bf16af335ab0016fbed1b870eebd93d36e25503a70646a1f0c895b11f3f6d4840d452f70e02912eecc09d2
+  data.tar.gz: 1c7d4b8708c07f631f7b43998a9d8083ca67737869557f4b26ef153a9911c9d2d28cab81e10824c5573912fc04507a7361080564105d0637ee217a26405bd9db

data/README.md

@@ -51,9 +51,28 @@ end
 
 After installation, you can pass data to your SSR service using `add_prop` in your controllers:
 
+### SSR Modes
+
+UniversalRenderer supports two SSR modes:
+
+1. **Standard SSR** (default): Fetches complete HTML from the SSR service before rendering
+2. **Streaming SSR**: Streams HTML content as it's generated (requires ActionController::Live)
+
+```ruby
+# Standard SSR (recommended for most use cases)
+enable_ssr
+
+# Streaming SSR (only use if you need fast TTFB)
+enable_ssr streaming: true
+```
+
 ```ruby
 class ProductsController < ApplicationController
-  enable_ssr # enables SSR controller-wide
+  # Enable basic SSR (recommended for most use cases)
+  enable_ssr
+
+  # Or enable SSR with streaming (only if you need real-time rendering)
+  # enable_ssr streaming: true
 
   def show
     @product = Product.find(params[:id])

data/lib/universal_renderer/client/stream/execution.rb

@@ -8,9 +8,13 @@ module UniversalRenderer
           response,
           stream_uri
         )
+          success = false
+
           http_client.request(http_post_request) do |node_res|
             if node_res.is_a?(Net::HTTPSuccess)
               node_res.read_body { |chunk| response.stream.write(chunk) }
+
+              success = true
             else
               Rails.logger.error(
                 "SSR stream server at #{stream_uri} responded with #{node_res.code} #{node_res.message}."
@@ -19,18 +23,18 @@ module UniversalRenderer
               # Close stream without forwarding error to allow fallback to client rendering
               response.stream.close unless response.stream.closed?
 
-              false
+              success = false
             end
           rescue StandardError => e
             Rails.logger.error(
               "Error during SSR data transfer or stream writing from #{stream_uri}: #{e.class.name} - #{e.message}"
             )
-            false
+            success = false
           ensure
             response.stream.close unless response.stream.closed?
           end
 
-          true
+          success
         end
       end
     end

data/lib/universal_renderer/renderable.rb

@@ -3,11 +3,16 @@ module UniversalRenderer
     extend ActiveSupport::Concern
 
     included do
-      include ActionController::Live
       helper UniversalRenderer::SSR::Helpers
       before_action :initialize_props
     end
 
+    module Streaming
+      extend ActiveSupport::Concern
+
+      included { include ActionController::Live }
+    end
+
     class_methods do
       def enable_ssr(options = {})
         class_attribute :enable_ssr, instance_writer: false
@@ -15,6 +20,8 @@ module UniversalRenderer
 
         class_attribute :ssr_streaming_preference, instance_writer: false
         self.ssr_streaming_preference = options[:streaming]
+
+        include UniversalRenderer::Renderable::Streaming if options[:streaming]
       end
     end
 

data/lib/universal_renderer/version.rb

@@ -1,3 +1,3 @@
 module UniversalRenderer
-  VERSION = "0.4.3".freeze
+  VERSION = "0.4.4".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: universal_renderer
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.4.4
 platform: ruby
 authors:
 - thaske