humid 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 961eafadcfe1132cdd132c096a28aba48155c740b224c3cbc32b4fd9731c10a6
-  data.tar.gz: 8a3635e896a4915c508a096c3b9f60e7d51265b39c6c448150fb89a627a3ab06
+  metadata.gz: 4c7f343b4b1518296d59917fb37ce2f8a60ee6b1a57b71f3fd378ce2ad55a4d4
+  data.tar.gz: e11384d2812e0de2cb7e676fa237957d44fbe63cf788e73adf997c9a14b2015e
 SHA512:
-  metadata.gz: 7f9f13d45e1b4023cccdc88300c151024dbb08a5bcc73c24b1a81e089f1ad1d2a4ec1faea12feb81e13949e2c423a8e8a392d73bf45b547ecdcd20a6462b74b6
-  data.tar.gz: fba2e9ea74fdeab8a90f5503a0b34cf977ddb0006dcaf234ceff8b1d06548079461e0e5d17466cace1c68937b7fa290a5823ef0fe01352886b545b0fe87c9cc2
+  metadata.gz: d5ca07bdd2c64b97f51c45dd14de734ab37e608704414a494461cce0645a10d4fcfb3c1e414152066c16b9be3f98c2f55fdcb6cd1cb6e3e7464e3ebb64e7ed8f
+  data.tar.gz: 52923317087b7439e80c347022acc55e102435367f3f0d54d52079f9e40129271aae60cba245bfe4d5d4352441988abd30882429f04d817e2528c029564a8cc3

data/README.md

@@ -43,25 +43,25 @@ Add an initializer to configure the default options for `Humid.render`. These
 are overridable on `Humid.render`.
 
 ```ruby
-# app/initializers/humid.rb
+# config/initializers/humid.rb
 
 Humid.configure do |config|
   # Path to your build file located in `app/assets/builds/`. You should use a
   # separate build apart from your `application.js`.
   #
   # Required
-  config.application_path = Rails.root.join('app', 'assets', 'builds', 'server_rendering.js')
+  config.application_path = Rails.root.join("app/assets/builds/server_rendering.js")
 
   # Path to your source map file
   #
   # Optional
-  config.source_map_path = Rails.root.join('app', 'assets', 'builds', 'server_rendering.js.map')
+  config.source_map_path = Rails.root.join("app/assets/builds/server_rendering.js.map")
 
   # Raise errors if JS rendering failed. If false, the error will be
-  # logged out to Rails log and Humid.render will return an empty string
+  # logged and Humid.render will return an empty string.
   #
   # Defaults to true.
-  config.raise_render_errors = Rails.env.development? || Rails.env.test?
+  config.raise_render_errors = Rails.env.local?
 
   # The logger instance.
   # `console.log` and friends (`warn`, `error`) are delegated to
@@ -74,8 +74,18 @@ end
 if Rails.env.local?
   # Use single_threaded mode for Spring and other forked envs.
   MiniRacer::Platform.set_flags! :single_threaded
-  ctx = MiniRacer::Context.new(timeout: 100, ensure_gc_after_idle: 2000)
-  MINI_RACER_CONTEXT = Humid.prepare(ctx)
+  MINI_RACER_SSR = { context: MiniRacer::Context.new(timeout: 1000, ensure_gc_after_idle: 2000) }
+
+  # Reload the context when the SSR bundle changes
+  ssr_checker = ActiveSupport::FileUpdateChecker.new([Humid.config.application_path.to_s]) do
+    MINI_RACER_SSR[:context].dispose
+    MINI_RACER_SSR[:context] = MiniRacer::Context.new(timeout: 1000, ensure_gc_after_idle: 2000)
+  end
+
+  Rails.application.reloaders << ssr_checker
+  Rails.application.reloader.to_run do
+    ssr_checker.execute_if_updated
+  end
 end
 ```
 
@@ -117,22 +127,20 @@ require("source-map-support").install({
 ### Your webserver
 
 On production, keep in mind that `mini_racer` is **thread safe, but not fork
-safe**. When using with web servers that employ forking, create a
-`MINI_RACER_CONTEXT` with options of your choosing on worker boot. **There
-should be no context created on the master process.**
+safe**. When using with web servers that employ forking, create the context
+on worker boot. **There should be no context created on the master process.**
 
 For example with puma:
 
 ```ruby
 # config/puma.rb
 on_worker_boot do
-  ctx = MiniRacer::Context.new(timeout: 100, ensure_gc_after_idle: 2000)
-  
-  MINI_RACER_CONTEXT = Humid.prepare(ctx)
+  ctx = MiniRacer::Context.new(timeout: 1000, ensure_gc_after_idle: 2000)
+  MINI_RACER_SSR = { context: Humid.prepare(ctx) }
 end
 
 on_worker_shutdown do
-  MINI_RACER_CONTEXT.dispose
+  MINI_RACER_SSR[:context].dispose
 end
 ```
 
@@ -142,13 +150,17 @@ end
 You can also override config options per-context:
 
 ```ruby
-MINI_RACER_CONTEXT = Humid.prepare(
+ctx = Humid.prepare(
   MiniRacer::Context.new(timeout: 1000),
   application_path: Rails.root.join("other_bundle.js"),
   logger: nil
 )
+MINI_RACER_SSR = { context: ctx }
 ```
 
+> [!NOTE]
+> If you pass a context that was already prepared, `prepare` will noop and return the context back to you.
+
 See the [sample server_rendering.tsx](./sample/server_rendering.tsx) to see how
 it is integrated.
 
@@ -157,7 +169,7 @@ it is integrated.
 And finally call `render` from ERB.
 
 ```ruby
-<%= Humid.render(MINI_RACER_CONTEXT, json).html_safe %>
+<%= Humid.render(MINI_RACER_SSR[:context], json).html_safe %>
 ```
 
 Instrumentation is included:
@@ -256,23 +268,19 @@ to get around these issues.
 
 ## Testing
 
-When running in test environments that also forks, you may need to set up new mini_racer
-contexts for each parallel worker. For example:
+The snippet When running in test environments that fork (e.g., parallel tests), each
+worker needs its own context since MiniRacer is not fork-safe. Using
+`MINI_RACER_SSR` as a hash makes this straightforward:
 
 ```ruby
 ActiveSupport.on_load(:action_dispatch_integration_test) do
-  include ActionView::Helpers::TranslationHelper
-  include Devise::Test::IntegrationHelpers
-
   parallelize_setup do
-    MINI_RACER_CONTEXT.dispose if defined?(MINI_RACER_CONTEXT)
-    ctx = MiniRacer::Context.new(timeout: 1000, ensure_gc_after_idle: 2000)
-    Object.send(:remove_const, :MINI_RACER_CONTEXT) if defined?(MINI_RACER_CONTEXT)
-    Object.const_set(:MINI_RACER_CONTEXT, Humid.prepare(ctx))
+    MINI_RACER_SSR[:context].dispose
+    MINI_RACER_SSR[:context] = MiniRacer::Context.new(timeout: 1000, ensure_gc_after_idle: 2000)
   end
 
   parallelize_teardown do
-    MINI_RACER_CONTEXT.dispose if defined?(MINI_RACER_CONTEXT)
+    MINI_RACER_SSR[:context].dispose
   end
 end
 ```
@@ -283,7 +291,7 @@ The `MiniRacer::Context` gives you access to V8 heap statistics for monitoring
 memory usage over time.
 
 ```ruby
-MINI_RACER_CONTEXT.heap_stats
+MINI_RACER_SSR[:context].heap_stats
 # {:total_heap_size=>3100672,
 #  :total_heap_size_executable=>4194304,
 #  :total_physical_size=>1280640,
@@ -302,7 +310,7 @@ render_histogram = meter.create_histogram("humid.render.duration", unit: "ms", d
 heap_gauge = meter.create_gauge("humid.heap.used_bytes", unit: "By", description: "V8 heap used bytes")
 
 ActiveSupport::Notifications.subscribe("render.humid") do |event|
-  stats = MINI_RACER_CONTEXT.heap_stats
+  stats = MINI_RACER_SSR[:context].heap_stats
   attributes = { "worker.pid" => Process.pid.to_s }
 
   render_histogram.record(event.duration, attributes: attributes)
@@ -338,7 +346,6 @@ We are [available for hire][hire].
 [community]: https://thoughtbot.com/community?utm_source=github
 [hire]: https://thoughtbot.com/hire-us?utm_source=github
 
-
 <!-- END /templates/footer.md -->
 
 [mini_racer]: https://github.com/rubyjs/mini_racer

data/lib/humid/version.rb

@@ -1,3 +1,3 @@
 module Humid
-  VERSION = "0.6.0".freeze
+  VERSION = "0.7.0".freeze
 end

data/lib/humid.rb

@@ -30,6 +30,8 @@ module Humid
   end
 
   def prepare(ctx, options = {})
+    return ctx if ctx.respond_to?(:humid_prepared?) && ctx.humid_prepared?
+
     effective_config = config.merge(options)
     logger = effective_config.logger
     log_formatter = effective_config.log_formatter

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: humid
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Johny Ho