humid 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 331e268f4bfc9f9b46e4246a9fb1af56245616bedecfb13a9b220040fca74636
+  data.tar.gz: 87631778cddbd5511202a0a3aaaa54fb6827b8aee8bdae29f80297ee6764cd55
+SHA512:
+  metadata.gz: 5161834e3f6b0a8d6cb9e991965df392491e204373c0ec54773cf114f8c489be88f435a5d6ba90c226dc6a698ea053ca3ccaf64581cb01399272057ecb600990
+  data.tar.gz: a545a0ffb5c7f1dfdf333bb960566a28fb355fd3dfc60ede7ed88f3210f507ca21e7b389138c07b2a773903110df66b7e60df844a57815c0a87fb624a15ee44c

data/README.md

@@ -0,0 +1,179 @@
+# Humid
+
+Humid is a lightweight helper that leans on [mini_racer] and [webpacker] to
+generate Server Side Rendered (SSR) pages from your javascript application.
+
+[![Build
+Status](https://circleci.com/gh/thoughtbot/humid.svg?style=shield)](https://circleci.com/gh/thoughtbot/humid)
+
+## Caution
+
+This project is in its early phases of development. Its interface,
+behavior, and name are likely to change drastically before a major version
+release.
+
+## Installation
+
+Add Humid to your Gemfile.
+
+```
+gem 'humid'
+```
+
+For source-map support, also add
+
+```
+yarn add source-map-support
+```
+
+
+## Configuration
+
+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 `nil`
+  config.server_rendering_source_map = "server_rendering.js.map"
+
+  # The logger instance. Defaults to `Logger.new(STDOUT)`
+  # `console.log` and friends (`warn`, `error`) are delegated to
+  # the respective logger levels on the ruby side.
+  config.logger = Rails.logger
+
+  # context_options. Options passed to mini_racer. Defaults to
+  # config.context_options = {
+  #   timeout: 1000,
+  #   ensure_gc_after_idle: 2000
+  # }
+end
+
+# If using puma in single mode
+# Humid.create_context
+```
+
+If you'd like support for source map support, you will need to
+1. Ensure `config.server_rendering_source_map` has a value
+2. Add the following to your `server_rendering.js` pack.
+
+```javascript
+require("source-map-support").install({
+  retrieveSourceMap: filename => {
+    return {
+      url: filename,
+      map: readSourceMap(filename)
+    };
+  }
+});
+```
+
+## The mini_racer environment.
+
+The following functions are **not** available in the mini_racer environment
+
+- `setTimeout`
+- `clearTimeout`
+- `setInterval`
+- `clearInterval`
+- `setImmediate`
+- `clearImmediate`
+
+### `console.log`
+
+`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
+ 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
+setHumidRenderer((json) => {
+  const initialState = JSON.parse(json)
+  return ReactDOMServer.renderToString(
+    <Application initialPage={initialState}/>
+  )
+})
+```
+
+And finally call `render` from ERB.
+
+```ruby
+<%= Humid.render(initial_state) %>
+```
+
+### Puma
+
+`mini_racer` is thread safe, but not fork safe. To use with web servers that
+employ forking, use `Humid.create_context` only on forked processes.
+
+```ruby
+# Puma
+on_worker_boot do
+  Humid.create_context
+end
+
+on_worker_shutdown do
+  Humid.dispose
+end
+```
+
+## Contributing
+
+Please see [CONTRIBUTING.md](/CONTRIBUTING.md).
+
+## License
+
+Humid is Copyright © 2021-2021 Johny Ho.
+It is free software, and may be redistributed under the terms specified in the
+[LICENSE](/LICENSE.md) file.
+
+## About thoughtbot
+
+![thoughtbot](https://thoughtbot.com/brand_assets/93:44.svg)
+
+Humid is maintained and funded by thoughtbot, inc.
+The names and logos for thoughtbot are trademarks of thoughtbot, inc.
+
+We love open source software!
+See [our other projects][community] or
+[hire us][hire] to design, develop, and grow your product.
+
+[community]: https://thoughtbot.com/community?utm_source=github
+[hire]: https://thoughtbot.com?utm_source=github
+[mini_racer]: https://github.com/rubyjs/mini_racer
+[webpacker]: https://github.com/rails/webpacker

data/lib/humid.rb

@@ -0,0 +1,109 @@
+require "mini_racer"
+require "logger"
+require "webpacker"
+require "active_support"
+require "active_support/core_ext"
+require "humid/log_subscriber"
+require "humid/controller_runtime"
+require "humid/version"
+
+module Humid
+  extend self
+  include ActiveSupport::Configurable
+
+  config_accessor :server_rendering_file do
+    "server_rendering.js"
+  end
+
+  config_accessor :server_rendering_source_map do
+    nil
+  end
+
+  config_accessor :logger do
+    Logger.new(STDOUT)
+  end
+
+  config_accessor :context_options do
+    {
+      timeout: 1000,
+      ensure_gc_after_idle: 2000
+    }
+  end
+
+  def remove_functions
+    <<~JS
+      delete this.setTimeout;
+      delete this.setInterval;
+      delete this.clearTimeout;
+      delete this.clearInterval;
+      delete this.setImmediate;
+      delete this.clearImmediate;
+    JS
+  end
+
+  def logger
+    config.logger
+  end
+
+  def renderer
+    <<~JS
+      var __renderer;
+      function setHumidRenderer(fn) {
+        __renderer = fn;
+      }
+    JS
+  end
+
+  def context
+    if @@context && Webpacker.env.development? && Webpacker.compiler.stale?
+      Webpacker.compiler.compile
+      dispose
+      create_context
+    else
+      @@context
+    end
+  end
+
+  def dispose
+    if @@context
+      @@context.dispose
+      @@context = nil
+    end
+  end
+
+  def create_context
+    ctx = MiniRacer::Context.new(config.context_options)
+    ctx.attach("console.log", proc { |err| logger.debug(err.to_s) })
+    ctx.attach("console.info", proc { |err| logger.info(err.to_s) })
+    ctx.attach("console.error", proc { |err| logger.error(err.to_s) })
+    ctx.attach("console.warn", proc { |err| logger.warn(err.to_s) })
+
+    js = ""
+    js << remove_functions
+    js << renderer
+    ctx.eval(js)
+
+    public_path = Webpacker.config.public_path
+    asset_path = public_path.join(Webpacker.manifest.lookup(config.server_rendering_file)[1..-1])
+    filename = File.basename(asset_path.to_s)
+    ctx.eval(File.read(asset_path), filename: filename)
+
+    if config.server_rendering_source_map
+      map_path = public_path.join(Webpacker.manifest.lookup(config.server_rendering_source_map)[1..-1])
+      ctx.attach("readSourceMap", proc { File.read(map_path) })
+    end
+
+    @@context = ctx
+  end
+
+  def render(*args)
+    ActiveSupport::Notifications.instrument("render.humid") do
+      @@context.call("__renderer", *args)
+    end
+  end
+end
+
+Humid::LogSubscriber.attach_to :humid
+ActiveSupport.on_load(:action_controller) do
+  include Humid::ControllerRuntime
+end

data/lib/humid/controller_runtime.rb

@@ -0,0 +1,41 @@
+module Humid
+  module ControllerRuntime
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def log_process_action(payload)
+        messages, humid_runtime = super, payload[:humid_runtime]
+        messages << ("Humid SSR: %.1fms" % humid_runtime.to_f) if humid_runtime
+        messages
+      end
+    end
+
+    private
+
+    attr_internal :humid_runtime
+
+    # Reset the runtime before each action.
+    def process_action(action, *args)
+      Humid::LogSubscriber.reset_runtime
+      super
+    end
+
+    def cleanup_view_runtime
+      if logger&.info?
+        humid_rt_before_render = Humid::LogSubscriber.reset_runtime
+        self.humid_runtime = (humid_runtime || 0) + humid_rt_before_render
+        runtime = super
+        humid_rt_after_render = Humid::LogSubscriber.reset_runtime
+        self.humid_runtime += humid_rt_after_render
+        runtime - humid_rt_after_render
+      else
+        super
+      end
+    end
+
+    def append_info_to_payload(payload)
+      super
+      payload[:humid_runtime] = (humid_runtime || 0) + Humid::LogSubscriber.reset_runtime
+    end
+  end
+end

data/lib/humid/log_subscriber.rb

@@ -0,0 +1,22 @@
+module Humid
+  class LogSubscriber < ActiveSupport::LogSubscriber
+    thread_cattr_accessor :humid_runtime
+
+    def self.runtime=(value)
+      self.humid_runtime = value
+    end
+
+    def self.runtime
+      self.humid_runtime ||= 0
+    end
+
+    def self.reset_runtime
+      rt, self.runtime = runtime, 0
+      rt
+    end
+
+    def render(event)
+      self.class.runtime += event.duration
+    end
+  end
+end

data/lib/humid/version.rb

@@ -0,0 +1,3 @@
+module Humid
+  VERSION = "0.0.1".freeze
+end

data/spec/controller_runtime_spec.rb

@@ -0,0 +1,79 @@
+require_relative "./support/helper"
+
+describe Humid::ControllerRuntime do
+  controller_runtime = Humid::ControllerRuntime
+
+  def set_metric value
+    Humid::LogSubscriber.runtime = value
+  end
+
+  def clear_metric!
+    Humid::LogSubscriber.reset_runtime = 0
+  end
+
+  reference_controller_class = Class.new {
+    def process_action *_
+      @process_action = true
+    end
+
+    def cleanup_view_runtime *_
+      @cleanup_view_runtime.call
+    end
+
+    def append_info_to_payload *_
+      @append_info_to_payload = true
+    end
+
+    def self.log_process_action *_
+      @log_process_action.call
+    end
+  }
+
+  controller_class = Class.new reference_controller_class do
+    include controller_runtime
+
+    def logger
+      Logger.new(STDOUT)
+    end
+  end
+
+  let(:controller) { controller_class.new }
+
+  it "resets the metric before each action" do
+    set_metric 42
+    controller.send(:process_action, "foo")
+    expect(Humid::LogSubscriber.runtime).to be(0)
+    expect(controller.instance_variable_get("@process_action")).to be(true)
+  end
+
+  it "strips the metric of other sources of the runtime" do
+    set_metric 1
+    controller.instance_variable_set "@cleanup_view_runtime", -> {
+      controller.instance_variable_set "@cleanup_view_runtime", true
+      set_metric 13
+      42
+    }
+    returned = controller.send :cleanup_view_runtime
+    expect(controller.instance_variable_get("@cleanup_view_runtime")).to be(true)
+    expect(controller.humid_runtime).to eq(14)
+    expect(returned).to be(29)
+  end
+
+  it "appends the metric to payload" do
+    payload = {}
+    set_metric 42
+    controller.send :append_info_to_payload, payload
+    expect(controller.instance_variable_get("@append_info_to_payload")).to be(true)
+    expect(payload[:humid_runtime]).to eq(42)
+  end
+
+  it "adds metric to log message" do
+    controller_class.instance_variable_set "@log_process_action", -> {
+      controller_class.instance_variable_set "@log_process_action", true
+      []
+    }
+    messages = controller_class.log_process_action humid_runtime: 42.101
+    expect(controller_class.instance_variable_get("@log_process_action")).to be(true)
+    expect(messages).to eq(["Humid SSR: 42.1ms"])
+  end
+end

data/spec/log_subscriber_spec.rb

@@ -0,0 +1,54 @@
+require_relative "./support/helper"
+require "active_support/log_subscriber/test_helper"
+require "byebug"
+
+RSpec.describe Humid::LogSubscriber do
+  around(:each) do |example|
+    app_path = File.expand_path("./testapp", File.dirname(__FILE__))
+    Dir.chdir(app_path) do
+      example.run
+    end
+  end
+
+  before(:each) do
+    Humid::LogSubscriber.reset_runtime
+  end
+
+  context ".runtime" do
+    it "is returns the runtime from the thread local" do
+      expect(Humid::LogSubscriber.runtime).to eql 0
+      key = "attr_Humid::LogSubscriber_humid_runtime"
+      Thread.current[key] = 3
+      expect(Humid::LogSubscriber.runtime).to eql 3
+    end
+  end
+
+  context ".runtime=" do
+    it "sets the runtime in a thread-safe manner" do
+      expect(Humid::LogSubscriber.runtime).to eql 0
+      Humid::LogSubscriber.runtime = 3
+      key = "attr_Humid::LogSubscriber_humid_runtime"
+      expect(Thread.current[key]).to eql 3
+    end
+  end
+
+  context ".reset_runtime" do
+    it "resets the runtime" do
+      Humid::LogSubscriber.runtime = 3
+      key = "attr_Humid::LogSubscriber_humid_runtime"
+      expect(Thread.current[key]).to eql 3
+
+      Humid::LogSubscriber.reset_runtime
+      expect(Thread.current[key]).to eql 0
+      expect(Humid::LogSubscriber.runtime).to eql 0
+    end
+  end
+
+  it "is attached" do
+    allow(Humid.config).to receive("server_rendering_file") { "simple.js" }
+    Humid.create_context
+    expect(Humid::LogSubscriber.runtime).to eql(0)
+    Humid.render
+    expect(Humid::LogSubscriber.runtime).to be > 0
+  end
+end

data/spec/render_spec.rb

@@ -0,0 +1,139 @@
+require_relative "./support/helper"
+
+RSpec.describe "Humid" do
+  around(:each) do |example|
+    app_path = File.expand_path("./testapp", File.dirname(__FILE__))
+    Dir.chdir(app_path) do
+      example.run
+    end
+  end
+
+  describe "create_context" do
+    after(:each) do
+      Humid.dispose
+    end
+
+    it "creates a context with initial js" do
+      allow(Humid.config).to receive("server_rendering_file") { "simple.js" }
+      Humid.create_context
+
+      expect(Humid.context).to be_kind_of(MiniRacer::Context)
+    end
+
+    it "does not have timeouts, immediates, and intervals" do
+      allow(Humid.config).to receive("server_rendering_file") { "simple.js" }
+
+      Humid.create_context
+
+      expect {
+        Humid.context.eval("setTimeout()")
+      }.to raise_error(MiniRacer::RuntimeError, "ReferenceError: setTimeout is not defined")
+      expect {
+        Humid.context.eval("setInterval()")
+      }.to raise_error(MiniRacer::RuntimeError, "ReferenceError: setInterval is not defined")
+      expect {
+        Humid.context.eval("clearTimeout()")
+      }.to raise_error(MiniRacer::RuntimeError, "ReferenceError: clearTimeout is not defined")
+      expect {
+        Humid.context.eval("setImmediate()")
+      }.to raise_error(MiniRacer::RuntimeError, "ReferenceError: setImmediate is not defined")
+      expect {
+        Humid.context.eval("clearImmediate()")
+      }.to raise_error(MiniRacer::RuntimeError, "ReferenceError: clearImmediate is not defined")
+    end
+
+    it "proxies to Rails logger" do
+      allow(Humid.config).to receive("server_rendering_file") { "simple.js" }
+      Humid.create_context
+      expect(Humid.logger).to receive(:info).with("hello")
+
+      Humid.context.eval("console.info('hello')")
+    end
+  end
+
+  describe "context" do
+    it "returns the created context" do
+      allow(Humid.config).to receive("server_rendering_file") { "simple.js" }
+
+      Humid.create_context
+
+      expect(Humid.context).to be_kind_of(MiniRacer::Context)
+    end
+
+    context "when the js is stale and env is NOT dev`" 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" }
+
+        Humid.create_context
+        prev_context = Humid.context
+        expect(prev_context).to be_kind_of(MiniRacer::Context)
+
+        allow(Webpacker).to receive_message_chain("compiler.stale?") { true }
+
+        next_context = Humid.context
+
+        expect(prev_context).to eql(next_context)
+        expect(next_context).to be_kind_of(MiniRacer::Context)
+      end
+    end
+
+    context "when the js is stale and env is development" do
+      it "compiles the JS" 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" }
+
+        Humid.create_context
+        prev_context = Humid.context
+        expect(prev_context).to be_kind_of(MiniRacer::Context)
+
+        allow(Webpacker).to receive_message_chain("compiler.stale?") { true }
+
+        next_context = Humid.context
+
+        expect(prev_context).to_not eql(next_context)
+        expect(next_context).to be_kind_of(MiniRacer::Context)
+      end
+    end
+  end
+
+  describe "render" do
+    it "returns a js output" do
+      allow(Humid.config).to receive("server_rendering_file") { "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" }
+      Humid.create_context
+
+      args = ["a", 1, 2, [], {}]
+
+      expect(Humid.render(*args)).to eql({"0" => "a", "1" => 1, "2" => 2, "3" => [], "4" => {}})
+    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_source_map") {
+        "reporting.js.map"
+      }
+
+      Humid.create_context
+
+      expect {
+        Humid.render
+      }.to raise_error { |error|
+        expect(error).to be_a(MiniRacer::RuntimeError)
+        expect(error.message).to eql("Error: ^^ Look! These stack traces map to the actual source code :)")
+        expect(error.backtrace[0]).to eql("JavaScript at throwSomeError (/webpack:/app/javascript/packs/components/error-causing-component.js:2:1)")
+        expect(error.backtrace[1]).to eql("JavaScript at ErrorCausingComponent (/webpack:/app/javascript/packs/components/error-causing-component.js:8:1)")
+        expect(error.backtrace[2]).to eql("JavaScript at /webpack:/app/javascript/packs/reporting.js:18:1")
+      }
+    end
+  end
+end

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: humid
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Johny Ho
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-07-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: webpacker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: mini_racer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+description: Javascript SSR rendering for Rails
+email: jho406@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/humid.rb
+- lib/humid/controller_runtime.rb
+- lib/humid/log_subscriber.rb
+- lib/humid/version.rb
+- spec/controller_runtime_spec.rb
+- spec/log_subscriber_spec.rb
+- spec/render_spec.rb
+homepage: https://github.com/thoughtbot/humid/
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: Javascript SSR rendering for Rails
+test_files:
+- spec/render_spec.rb
+- spec/log_subscriber_spec.rb
+- spec/controller_runtime_spec.rb