universal_renderer 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 61b47ecd00a6c6401d0689b67cf9944859c43e8f1f0cbae343c7b9f0865e5dc7
-  data.tar.gz: 96221231e4c6c3293c1c3b9c36fa0c2c338967703582262113781cec2cdd1336
+  metadata.gz: a84ac507fd401a10c8d36c9b7600d02b4403d84bdcbd63a0c4ac1f707efe0a7f
+  data.tar.gz: deac3f050553555b313864a1eb06ea69ff8e8d25ed78c47a70cb0c54e562012e
 SHA512:
-  metadata.gz: 3a524d63eb673564622aa1329fc8c9ff8b47ea131f0785c79caf9a75e60f12912228f0f74dd7a44fe6a1958932f8514d214b539f3a32f7c62cf63d76b695669b
-  data.tar.gz: a423a79cc5e0d39ba58b039c7eec0d40b804625bc98e71bbeb57fe233b236f62794295daf6335efc5fd5d1ac1ae31cc19443ff10423c82b251360e5a4fa88bdf
+  metadata.gz: cda8091a0ad83367e3a0e8bcb93d560ce4b9e778cc543b7edba4084d0e7a540eda82fcd952e40b00115fef62326d15f760de905d882c607224047565d58c9c96
+  data.tar.gz: 15a2798e31d87ca6eec64e0613fedf2da515db85f3b798a792b0917d1719e970862c476c51eaebf65d8550dc0885bd5619edf662819085e3a132d877a4bdf73b

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
@@ -185,23 +187,22 @@ To set up the SSR server for your Rails application:
 4. Create an SSR entry point at `app/frontend/ssr/ssr.ts`:
 
    ```ts
-   import { renderToString } from "react-dom/server";
+   import { renderToString } from "react-dom/server.node";
    import { createSsrServer } from "universal-renderer";
-   import { createServer as createViteServer } from "vite";
-
    import setup from "@/ssr/setup";
-
-   const vite = await createViteServer({
-     server: { middlewareMode: true },
-     appType: "custom",
-   });
+   import {
+     createRenderStreamTransformer,
+     extractMeta,
+     getRequestLogger,
+     getStateElement,
+   } from "@/ssr/utils";
 
    const app = await createSsrServer({
-     vite,
+     middleware: (app) => {
+       app.use(getRequestLogger());
+     },
      callbacks: {
-       // as typeof is a little hack to get the types to resolve correctly
-       // since Vite's ssrLoadModule doesn't include the types
-       setup: (await vite.ssrLoadModule("@/ssr/setup")).default as typeof setup,
+       setup: setup,
        render: async ({ jsx, helmetContext, sheet, state }) => {
          const root = renderToString(jsx);
          const meta = extractMeta(helmetContext);
@@ -212,9 +213,16 @@ To set up the SSR server for your Rails application:
          sheet?.seal();
          queryClient?.clear();
        },
-       onError: (error, context, errorContext) => {
-         vite.ssrFixStacktrace(error);
-         console.error(error);
+       error: (error, _, errorContext) => {
+         console.error(`[SSR] ${errorContext} error:`, error);
+       },
+     },
+     streamCallbacks: {
+       getReactNode: async ({ jsx }) => jsx,
+       getMetaTags: async ({ helmetContext }) => extractMeta(helmetContext),
+       createRenderStreamTransformer,
+       onBeforeWriteClosingHtml: async (res, { state }) => {
+         res.write(getStateElement(state) + "\n");
        },
      },
    });

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

@@ -13,7 +13,7 @@ module UniversalRenderer
               Execution._handle_node_response_streaming(
                 node_res,
                 response,
-                stream_uri
+                stream_uri,
               )
 
               return true
@@ -28,18 +28,18 @@ module UniversalRenderer
               Execution._handle_streaming_for_node_error(
                 node_res,
                 response,
-                stream_uri
+                stream_uri,
               )
             end
           rescue StandardError => e
             Rails.logger.error(
-              "Error during SSR data transfer or stream writing from #{stream_uri}: #{e.class.name} - #{e.message}"
+              "Error during SSR data transfer or stream writing from #{stream_uri}: #{e.class.name} - #{e.message}",
             )
 
             Execution._write_generic_html_error(
               response.stream,
               "Streaming Error",
-              "<p>A problem occurred while loading content. Please refresh.</p>"
+              "<p>A problem occurred while loading content. Please refresh.</p>",
             )
           ensure
             response.stream.close unless response.stream.closed?
@@ -53,7 +53,7 @@ module UniversalRenderer
 
           def _handle_streaming_for_node_error(node_res, response, stream_uri)
             Rails.logger.error(
-              "SSR stream server at #{stream_uri} responded with #{node_res.code} #{node_res.message}."
+              "SSR stream server at #{stream_uri} responded with #{node_res.code} #{node_res.message}.",
             )
 
             is_potentially_viewable_error =
@@ -61,19 +61,19 @@ module UniversalRenderer
 
             if is_potentially_viewable_error
               Rails.logger.info(
-                "Attempting to stream HTML error page from Node SSR server."
+                "Attempting to stream HTML error page from Node SSR server.",
               )
               Execution._stream_response_body(node_res, response.stream)
             else
               Rails.logger.warn(
                 "Node SSR server error response Content-Type ('#{node_res["Content-Type"]}') is not text/html. " \
-                  "Injecting generic error message into the stream."
+                  "Injecting generic error message into the stream.",
               )
 
               Execution._write_generic_html_error(
                 response.stream,
                 "Application Error",
-                "<p>There was an issue rendering this page. Please try again later.</p>"
+                "<p>There was an issue rendering this page. Please try again later.</p>",
               )
             end
           end

data/lib/universal_renderer/renderable.rb

@@ -31,7 +31,7 @@ module UniversalRenderer
       @ssr =
         UniversalRenderer::Client::Base.fetch(
           request.original_url,
-          @universal_renderer_props
+          @universal_renderer_props,
         )
     end
 
@@ -39,52 +39,44 @@ module UniversalRenderer
       self.class.try(:ssr_streaming_preference)
     end
 
-    private
-
     def render(*args, **kwargs)
       return super unless self.class.enable_ssr
 
       return super unless request.format.html?
 
       if use_ssr_streaming?
-        render_ssr_stream(*args, **kwargs)
+        success = render_ssr_stream(*args, **kwargs)
+        super unless success
       else
         fetch_ssr
         super
       end
     end
 
-    def render_ssr_stream(*args, **kwargs)
-      set_streaming_headers
+    private
 
+    def render_ssr_stream(*args, **kwargs)
       full_layout = render_to_string(*args, **kwargs)
-
-      split_index = full_layout.index(SSR::Placeholders::META)
-      before_meta = full_layout[0...split_index]
-      after_meta = full_layout[split_index..]
-
-      response.stream.write(before_meta)
-
       current_props = @universal_renderer_props.dup
 
       streaming_succeeded =
         UniversalRenderer::Client::Stream.stream(
           request.original_url,
           current_props,
-          after_meta,
-          response
+          full_layout,
+          response,
         )
 
       # SSR streaming failed or was not possible (e.g. server down, config missing).
-      unless streaming_succeeded
+      if streaming_succeeded
+        response.stream.close unless response.stream.closed?
+      else
         Rails.logger.error(
           "SSR stream fallback: " \
-            "Streaming failed, proceeding with standard rendering."
+            "Streaming failed, proceeding with standard rendering.",
         )
-        response.stream.write(after_meta)
+        false
       end
-
-      response.stream.close unless response.stream.closed?
     end
 
     def initialize_props
@@ -144,19 +136,5 @@ module UniversalRenderer
         @universal_renderer_props[prop_key] << value_to_add
       end
     end
-
-    def set_streaming_headers
-      # Tell Cloudflare / proxies not to cache or buffer.
-      response.headers["Cache-Control"] = "no-cache, no-store, must-revalidate"
-      response.headers["Pragma"] = "no-cache"
-      response.headers["Expires"] = "0"
-
-      # Disable Nginx buffering per-response.
-      response.headers["X-Accel-Buffering"] = "no"
-      response.headers["Content-Type"] = "text/html"
-
-      # Remove Content-Length header to prevent buffering.
-      response.headers.delete("Content-Length")
-    end
   end
 end

data/lib/universal_renderer/version.rb

@@ -1,3 +1,3 @@
 module UniversalRenderer
-  VERSION = "0.3.1".freeze
+  VERSION = "0.4.0".freeze
 end

metadata

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