async_render 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f4233e16eefe728ce0620a058495d7daecaee4a591f433b3637d01c5489896a2
-  data.tar.gz: dc2d826a7de38fd8140f696cdc2abd64080ccaa8ec0ad291a3645e68b065b62e
+  metadata.gz: 4198331a3b4cea32f2e5efb02ca0f616bca9d77796ba0e39df3bf467258cc878
+  data.tar.gz: 2e99dfe1fc5cf022f96b5df0175e1ed1c7dda1412aad4254f53cdb05b26774a7
 SHA512:
-  metadata.gz: 7bebb2d37c302a42c6af8847850cb6efab86ea40576a31673db7ca9604f19cf091cb9e59326b05fb6fe4c21aee2d1f425ec0919ecfc6e70835ea5d07b56a2450
-  data.tar.gz: 9930ca4a9f7db3225ca6fb9407ba62c673a57e70eb2b6dfcf0ed24cf90035ef6836a5f76fa924cd52729ad98e7b32d1b597c76737d7a8934be0d77cae66c0ab3
+  metadata.gz: befb63ff7447523674815182bbf5728ce0f0bf0995aeb0072f1b5d51912e05738f69a57588d47682c1b7ab2a6a6ed1ab1a5bed35cba2b1755b125c76f42b52f3
+  data.tar.gz: a54e8796393bd64f4262c555fc5245efd71ea44fe38c939bd486bf00df2b1e29ebd140622879edd2e3466a2220c7878e4cd2068109ac48ef4a5cbdbd8cb119e0

data/README.md

@@ -11,6 +11,7 @@ On my pet project and my benchmark, I've seen 5-15% improvement in response time
 - you have heavy partials
 - you have partials, with calculations inside, that can be done in background
 - your partials has none or a few dependencies on locals
+- you have 2+ partials with rendering time more than 100ms
 - you have HTML request format (see `Limitations` section)
 - you are curious about performance :)
 
@@ -19,16 +20,27 @@ On my pet project and my benchmark, I've seen 5-15% improvement in response time
 ![AsyncRender Logo](docs/idea.png)
 
 ### 🔄 Async Rendering
+
 Render multiple view partials asynchronously in background threads, reducing overall page load time by executing independent renders concurrently.
 
+Use cases:
+- heavy partials, maybe with calculations inside
+- 2+ partials with rendering time more than 100ms
+
 ### 🔥 Warmup Rendering
+
 Pre-render partials in your controller actions before the main view is processed. This allows expensive computations to start early and be ready when needed. This must be used in combination with async rendering.
 
+Use cases:
+- you are sure that some partials will be rendered
+
 ### 💾 Memoized Rendering
+
 Cache rendered partials in memory across requests within the same Ruby process, eliminating redundant rendering of static or rarely-changing content. Warning: do not use it for large amount of content, it will eat up your memory.
 
-### ⚡ Smart Thread Pool Management
-Automatically configures thread pool size based on your database connection pool and Rails configuration to prevent resource contention.
+Use cases:
+- you have static or rarely-changing content (like google analytics, modal, etc)
+- it's okay to cache it in memory, and it will be reset after next deployment
 
 ## 📦 Installation
 
@@ -160,6 +172,7 @@ For content that rarely changes, use memoized rendering to cache results in memo
 - if you use "Current" attributes, you need to pass them as locals, or pass as state to render (see `dump_state_proc` and `restore_state_proc` in the initializer)
 - warmup rendering under the hood uses simply before_action, so you need to prepare data in the controller action, not in the view.
 - for now only HTML request format is supported, but I'm working on it.
+- it will mess up your logs, because some rendering may happen after logs like "Completed 200 OK in 1761ms".
 
 ### ✅ Do
 
@@ -175,6 +188,18 @@ For content that rarely changes, use memoized rendering to cache results in memo
 - Rely on request-specific data without proper state management
 - Use excessive async rendering that could exhaust database connections
 
+## Testing in Production
+
+For example you can disable async rendering:
+
+```ruby
+class ApplicationController < ActionController::Base
+  before_action do
+    AsyncRender.enabled = params[:skip_async].blank?
+  end
+end
+```
+
 ## Performance Considerations
 
 - The gem automatically limits parallelism based on available database connections

data/lib/async_render/version.rb

@@ -1,3 +1,3 @@
 module AsyncRender
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: async_render
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Igor Kasyanchuk