humid 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 64ab68e5648b4211e7d39b272da5f94e1aaf3bfcdf625db30ee5f6c72a7dc529
-  data.tar.gz: 251e41301a91ea534547caa84b76ffef68b463299fd012c39b2b26e4626b6d13
+  metadata.gz: a783b726d5542a0abfc94fc1918aad0212c13ac7b6db8b8efd90c5452a222b2e
+  data.tar.gz: b9c3719ace7b00d210c992b48f9c4ee02010e81d19c30aa47e8bf6fdd9e9373b
 SHA512:
-  metadata.gz: f97030ff349d70d7b4605969953194c34b8012dc12f477aa8c5f6f1ccdfee88be2ccb5c495fc880378be03c381ed88e11c8453abd1d8a92ad3621aad34a0b553
-  data.tar.gz: 23f59abc3c56fe9d11b6084e89b0c02a3b11c4e12175bcab6ea4a641630616950b6943a9948c64be270173461f383a540fd570fdb69fd439cfcd7007d6e542ea
+  metadata.gz: d29027f962022c6f8d5aeaf09c11730d572a32f8936e025fc04c3490921ac51468f6567e99f29aeb090a344150fa5edce2bbe14e83c18bfe9afc62e89fb34a87
+  data.tar.gz: 9ceb09c4bebef88f71f3b9c229c9317526a1d5cd5100dce4a270aad383334401a14baa7e108417170c5c3cad122523e9539733404d4c9a3cdf6f7bb8c2ec5dbf

data/README.md

@@ -34,20 +34,33 @@ Add an initializer to configure
 
 ```ruby
 Humid.configure do |config|
-  # name of your webpacker pack. Defaults to "server_rendering.js"
-  config.server_rendering_source = "server_rendering.js"
-
-  # name of your webpacker pack source map. Defaults to `false`
+  # Name of your webpacker pack file located in `app/javascript/packs/`. You
+  # should use a separate pack from your `application.js`.
+  #
+  # Defaults to "server_rendering.js"
+  config.server_rendering_pack = "server_rendering.js"
+
+  # Name of your webpacker pack source map.
+  #
+  # Defaults to `false`
   config.use_source_map = true
 
-  # The logger instance. Defaults to `Logger.new(STDOUT)`
+  # 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
+  #
+  # Defaults to true.
+  config.raise_render_errors = Rails.env.development? || Rails.env.test?
+
+  # The logger instance.
   # `console.log` and friends (`warn`, `error`) are delegated to
   # the respective logger levels on the ruby side.
+  #
+  # Defaults to `Logger.new(STDOUT)`
   config.logger = Rails.logger
 
-  # context_options. Options passed to mini_racer. Defaults to
-  # empty.
-  # config.context_options = {}
+  # Options passed to mini_racer.
+  #
+  # Defaults to empty `{}`.
   config.context_options = {
     timeout: 1000,
     ensure_gc_after_idle: 2000
@@ -55,11 +68,13 @@ Humid.configure do |config|
 end
 
 # Common development options
-# You may need to use single_threaded mode with Spring
-# MiniRacer::Platform.set_flags! :single_threaded
-#
-# If you're using Puma in single mode:
-# Humid.create_context
+if Rails.env.development? || Rails.env.test?
+  # Use single_threaded mode for Spring and other forked envs.
+  MiniRacer::Platform.set_flags! :single_threaded
+
+  # If you're using Puma in single mode:
+  Humid.create_context
+end
 ```
 
 If you'd like support for source map support, you will need to
@@ -95,46 +110,16 @@ The following functions are **not** available in the mini_racer environment
 `console.log` and friends (`info`, `error`, `warn`) are delegated to the
 respective methods on the configured logger.
 
-### Webpacker
-You may need webpacker to create aliases for server friendly libraries that can
-not detect the `mini_racer` environment.
-
-```diff
- // config/webpack/development.js
-
- process.env.NODE_ENV = process.env.NODE_ENV || 'development'
-
- const environment = require('./environment')
-+const path = require('path')
-+const ConfigObject = require('@rails/webpacker/package/config_types/config
-
--module.exports = environment.toWebpackConfig()
-+const webConfig = environment.toWebpackConfig()
-+const ssrConfig = new ConfigObject(webConfig.toObject())
-+
-+ssrConfig.delete('entry')
-+ssrConfig.merge({
-+  entry: {
-+    server_rendering: webConfig.entry.server_rendering
-+  },
-+  resolve: {
-+    alias: {
-+      'html-dom-parser': path.resolve(__dirname, '../../node_modules/html-dom-parser/lib/html-to-dom-server')
-+    }
-+  }
-+})
-+
-+delete webConfig.entry.server_rendering
-+module.exports = [ssrConfig, webConfig]
-```
-
 ## Usage
 
 Pass your HTML render function to `setHumidRenderer`
 
 ```javascript
+// Set a factory function that will create a new instance of our app
+// for each request.
 setHumidRenderer((json) => {
   const initialState = JSON.parse(json)
+
   return ReactDOMServer.renderToString(
     <Application initialPage={initialState}/>
   )
@@ -169,6 +154,69 @@ on_worker_shutdown do
 end
 ```
 
+### Server-side libraries that detect node.js envs.
+You may need webpacker to create aliases for server friendly libraries that can
+not detect the `mini_racer` environment.
+
+```diff
+ // config/webpack/production.js
+ // config/webpack/development.js
+ // config/webpack/test.js
+
+ process.env.NODE_ENV = process.env.NODE_ENV || 'development'
+
+ const environment = require('./environment')
++const path = require('path')
++const ConfigObject = require('@rails/webpacker/package/config_types/config
+
+-module.exports = environment.toWebpackConfig()
++const webConfig = environment.toWebpackConfig()
++const ssrConfig = new ConfigObject(webConfig.toObject())
++
++ssrConfig.delete('entry')
++ssrConfig.merge({
++  entry: {
++    server_rendering: webConfig.entry.server_rendering
++  },
++  resolve: {
++    alias: {
++      'html-dom-parser': path.resolve(__dirname, '../../node_modules/html-dom-parser/lib/html-to-dom-server')
++    }
++  }
++})
++
++delete webConfig.entry.server_rendering
++module.exports = [ssrConfig, webConfig]
+```
+
+## Writing universal code
+[Vue has an amazing resource][vue_ssr] on how to write universal code. Below
+are a few highlights that are important to keep in mind.
+
+### State
+
+Humid uses a single context across multiple request. To avoid state pollution, we
+provide a factory function to `setHumidRenderer` that builds a new app instance on
+every call.
+
+This provides better isolation, but as it is still a shared context, polluting
+`global` is still possible. Be careful of modifying `global` in your code.
+
+### Polyfills
+
+Polyfills will fail when using in the `mini_racer` environment because of missing
+browser APIs. Account for this by moving the `require` to `componentDidMount`
+in your component.
+
+```
+componentDidMount() {
+  const dialogPolyfill = require('dialog-polyfill').default
+  dialogPolyfill.registerDialog(this.dialog.current)
+  this.dialog.current.open = this.props.open
+  this.dialog.current.showModal()
+}
+```
+
 ## Contributing
 
 Please see [CONTRIBUTING.md](/CONTRIBUTING.md).
@@ -194,3 +242,4 @@ See [our other projects][community] or
 [hire]: https://thoughtbot.com?utm_source=github
 [mini_racer]: https://github.com/rubyjs/mini_racer
 [webpacker]: https://github.com/rails/webpacker
+[vue_ssr]: https://ssr.vuejs.org/

data/lib/humid.rb

@@ -14,7 +14,12 @@ module Humid
   class RenderError < StandardError
   end
 
-  config_accessor :server_rendering_file do
+  class FileNotFound < StandardError
+  end
+
+  @@context = nil
+
+  config_accessor :server_rendering_pack do
     "server_rendering.js"
   end
 
@@ -22,6 +27,10 @@ module Humid
     false
   end
 
+  config_accessor :raise_render_errors do
+    true
+  end
+
   config_accessor :logger do
     Logger.new(STDOUT)
   end
@@ -60,8 +69,8 @@ module Humid
     end
 
     public_path = Webpacker.config.public_path
-    server_rendering_file = config.server_rendering_file
-    source_path = public_path.join(Webpacker.manifest.lookup(server_rendering_file)[1..-1])
+    server_rendering_pack = config.server_rendering_pack
+    source_path = public_path.join(Webpacker.manifest.lookup(server_rendering_pack)[1..-1])
     filename = File.basename(source_path.to_s)
 
     if @@current_filename != filename
@@ -98,15 +107,19 @@ module Humid
     ctx.eval(js)
 
     public_path = Webpacker.config.public_path
-    server_rendering_file = config.server_rendering_file
-    server_rendering_map = "#{config.server_rendering_file}.map"
 
-    source_path = public_path.join(Webpacker.manifest.lookup(server_rendering_file)[1..-1])
-    map_path = public_path.join(Webpacker.manifest.lookup(server_rendering_map)[1..-1])
+    webpack_source_file = Webpacker.manifest.lookup(config.server_rendering_pack)
+    if webpack_source_file.nil?
+      raise FileNotFound.new("Humid could not find a built pack for #{config.server_rendering_pack}")
+    end
+
     if config.use_source_map
+      webpack_source_map = Webpacker.manifest.lookup("#{config.server_rendering_pack}.map")
+      map_path = public_path.join(webpack_source_map[1..-1])
       ctx.attach("readSourceMap", proc { File.read(map_path) })
     end
 
+    source_path = public_path.join(webpack_source_file[1..-1])
     filename = File.basename(source_path.to_s)
     @@current_filename = filename
     ctx.eval(File.read(source_path), filename: filename)
@@ -119,7 +132,14 @@ module Humid
       context.call("__renderer", *args)
     rescue MiniRacer::RuntimeError => e
       message = ([e.message] + e.backtrace.filter {|x| x.starts_with? "JavaScript"}).join("\n")
-      raise Humid::RenderError.new(message)
+      render_error = Humid::RenderError.new(message)
+
+      if config.raise_render_errors
+        raise render_error
+      else
+        config.logger.error(render_error.inspect)
+        ""
+      end
     end
   end
 end

data/lib/humid/version.rb

@@ -1,3 +1,3 @@
 module Humid
-  VERSION = "0.0.4".freeze
+  VERSION = "0.0.5".freeze
 end

data/spec/log_subscriber_spec.rb

@@ -45,7 +45,7 @@ RSpec.describe Humid::LogSubscriber do
   end
 
   it "is attached" do
-    allow(Humid.config).to receive("server_rendering_file") { "simple.js" }
+    allow(Humid.config).to receive("server_rendering_pack") { "simple.js" }
     Humid.create_context
     expect(Humid::LogSubscriber.runtime).to eql(0)
     Humid.render

data/spec/render_spec.rb

@@ -14,14 +14,24 @@ RSpec.describe "Humid" do
     end
 
     it "creates a context with initial js" do
-      allow(Humid.config).to receive("server_rendering_file") { "simple.js" }
+      allow(Humid.config).to receive("server_rendering_pack") { "simple.js" }
       Humid.create_context
 
       expect(Humid.context).to be_kind_of(MiniRacer::Context)
     end
 
+    context "When the file can not be found" do
+      it "raises" do
+        allow(Humid.config).to receive("server_rendering_pack") { "does_not_exist.js" }
+
+        expect {
+          Humid.create_context
+        }.to raise_error(Humid::FileNotFound, "Humid could not find a built pack for does_not_exist.js")
+      end
+    end
+
     it "does not have timeouts, immediates, and intervals" do
-      allow(Humid.config).to receive("server_rendering_file") { "simple.js" }
+      allow(Humid.config).to receive("server_rendering_pack") { "simple.js" }
 
       Humid.create_context
 
@@ -43,7 +53,7 @@ RSpec.describe "Humid" do
     end
 
     it "proxies to Rails logger" do
-      allow(Humid.config).to receive("server_rendering_file") { "simple.js" }
+      allow(Humid.config).to receive("server_rendering_pack") { "simple.js" }
       Humid.create_context
       expect(Humid.logger).to receive(:info).with("hello")
 
@@ -53,7 +63,7 @@ RSpec.describe "Humid" do
 
   describe "context" do
     it "returns the created context" do
-      allow(Humid.config).to receive("server_rendering_file") { "simple.js" }
+      allow(Humid.config).to receive("server_rendering_pack") { "simple.js" }
 
       Humid.create_context
 
@@ -64,7 +74,7 @@ RSpec.describe "Humid" do
       it "does not recompile the JS" do
         allow(Webpacker).to receive_message_chain("env.development?") { false }
         allow(Webpacker).to receive_message_chain("compiler.stale?") { true }
-        allow(Humid.config).to receive("server_rendering_file") { "simple.js" }
+        allow(Humid.config).to receive("server_rendering_pack") { "simple.js" }
 
         Humid.create_context
         prev_context = Humid.context
@@ -84,7 +94,7 @@ RSpec.describe "Humid" do
         allow(Webpacker).to receive_message_chain("env.development?") { true }
         allow(Webpacker).to receive_message_chain("compiler.stale?") { true }
         allow(Webpacker).to receive_message_chain("compiler.compile")
-        allow(Humid.config).to receive("server_rendering_file") { "simple.js" }
+        allow(Humid.config).to receive("server_rendering_pack") { "simple.js" }
 
         Humid.create_context
         prev_context = Humid.context
@@ -92,7 +102,7 @@ RSpec.describe "Humid" do
 
         allow(Webpacker).to receive_message_chain("compiler.stale?") { true }
         # This simulates a changing file
-        allow(Humid.config).to receive("server_rendering_file") { "simple_changed.js" }
+        allow(Humid.config).to receive("server_rendering_pack") { "simple_changed.js" }
 
         next_context = Humid.context
 
@@ -104,7 +114,7 @@ RSpec.describe "Humid" do
         allow(Webpacker).to receive_message_chain("env.development?") { true }
         allow(Webpacker).to receive_message_chain("compiler.stale?") { true }
         allow(Webpacker).to receive_message_chain("compiler.compile")
-        allow(Humid.config).to receive("server_rendering_file") { "simple.js" }
+        allow(Humid.config).to receive("server_rendering_pack") { "simple.js" }
 
         Humid.create_context
         prev_context = Humid.context
@@ -113,7 +123,7 @@ RSpec.describe "Humid" do
 
         allow(Webpacker).to receive_message_chain("compiler.stale?") { false }
         # This simulates a changing file
-        allow(Humid.config).to receive("server_rendering_file") { "simple_changed.js" }
+        allow(Humid.config).to receive("server_rendering_pack") { "simple_changed.js" }
 
         next_context = Humid.context
 
@@ -126,14 +136,14 @@ RSpec.describe "Humid" do
 
   describe "render" do
     it "returns a js output" do
-      allow(Humid.config).to receive("server_rendering_file") { "simple.js" }
+      allow(Humid.config).to receive("server_rendering_pack") { "simple.js" }
       Humid.create_context
 
       expect(Humid.render).to eql("hello")
     end
 
     it "applys args to the func" do
-      allow(Humid.config).to receive("server_rendering_file") { "args.js" }
+      allow(Humid.config).to receive("server_rendering_pack") { "args.js" }
       Humid.create_context
 
       args = ["a", 1, 2, [], {}]
@@ -142,7 +152,7 @@ RSpec.describe "Humid" do
     end
 
     it "can use source maps to see errors" do
-      allow(Humid.config).to receive("server_rendering_file") { "reporting.js" }
+      allow(Humid.config).to receive("server_rendering_pack") { "reporting.js" }
       allow(Humid.config).to receive("use_source_map") { true }
 
       Humid.create_context
@@ -151,12 +161,28 @@ RSpec.describe "Humid" do
         Humid.render
       }.to raise_error { |error|
         expect(error).to be_a(Humid::RenderError)
-        message = error.message.split("\n")
-        expect(message[0]).to eql("Error: ^^ Look! These stack traces map to the actual source code :)")
-        expect(message[1]).to eql("JavaScript at throwSomeError (/webpack:/app/javascript/packs/components/error-causing-component.js:2:1)")
-        expect(message[2]).to eql("JavaScript at ErrorCausingComponent (/webpack:/app/javascript/packs/components/error-causing-component.js:8:1)")
-        expect(message[3]).to eql("JavaScript at /webpack:/app/javascript/packs/reporting.js:18:1")
+        message = <<~MSG
+          Error: ^^ Look! These stack traces map to the actual source code :)
+          JavaScript at throwSomeError (/webpack:/app/javascript/packs/components/error-causing-component.js:2:1)
+          JavaScript at ErrorCausingComponent (/webpack:/app/javascript/packs/components/error-causing-component.js:8:1)
+          JavaScript at /webpack:/app/javascript/packs/reporting.js:18:1
+        MSG
+
+        expect(error.message).to eql message.strip
       }
     end
+
+    it "siliences render errors to the log" do
+      allow(Humid.config).to receive("server_rendering_pack") { "reporting.js" }
+      allow(Humid.config).to receive("raise_render_errors") { false }
+      allow(Humid.config).to receive("use_source_map") { true }
+
+      Humid.create_context
+
+      expect(Humid.logger).to receive(:error)
+      output = Humid.render
+
+      expect(output).to eql("")
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: humid
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Johny Ho
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-23 00:00:00.000000000 Z
+date: 2021-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: webpacker