rails-react-ssr 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3912c1b48d7d967fd867a88e16704ca98cd407d89d9ec0ce81c5d84c2fd975c5
+  data.tar.gz: 3874620976e632c57a7f05cdfdb72d9953f11218cc90a81b79aac51187e6b8db
+SHA512:
+  metadata.gz: 390e781fb0622497b051d6d1cd52bf7f306c6de19a24bae542692b64680d760e5f7f4ba3a8371bec1fd3c287ed8f41e1f09f11afa08a502fe4928965cf1c10ad
+  data.tar.gz: 8eda42ff7e39306e8a5af2130d8db038cccb6725f346c59529586f59be1c2f0728d31a0992f1f31fa12a634e94a34dcf58c452d4da7ca73a98a04b5ee127967b

data/README.md

@@ -0,0 +1,202 @@
+# RailsReactSSR
+
+RailsReactSSR is a light weight JS server side rendering utility that takes advantage of `Webpacker` and `NodeJS`.
+
+## Motivation
+
+In my latest project I designed my application to use Rails for my API endpoints and `ReactJS` with `react-router` to 
+handle routing and handle the front end. I needed a basic tool that would not add a lot of bloat and be able to handle 
+server side rendering while allowing me to process the response (i.e. handle redirects from the router).
+
+## Dependencies
+
+- [Ruby On Rails](https://rubyonrails.org/)
+- [Webpacker](https://github.com/rails/webpacker)
+- [NodeJS](https://nodejs.org/)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rails-react-ssr'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install rails-react-ssr
+
+## Usage
+
+`RailsReactSSR::ServerRunner.exec!(bundle, props:, outputTemp:, max_tries:, delay:)`
+
+* `bundle` is the path or name of the bundle in the `app/javascript/packs` directory
+
+(optional)
+
+* `props` is a hash that will converted to a JSON plain object and passed to the server
+* `outputTemp` is either:
+  * a boolean, where true will output the compiled server code to `tmp/ssr/[bundle].js`
+  * a string that is the full path to the file to write to
+* `max_tries` is the number of retries when fetching the bundle from teh `webpack-dev-server`
+* `delay` is the time in ms between each retry
+
+#### Basic usage
+
+##### `server.js`
+```typescript jsx
+// Some processing here
+
+stdout(yourHtmlOutput);
+```
+
+##### Your controller
+```ruby
+def index
+  render html: RailsReactSSR::ServerRunner.exec!('server.js')
+end
+```
+
+#### Passing properties to the server
+
+##### From the controller:
+
+```ruby
+def index
+  render html: RailsReactSSR::ServerRunner.exec!('server.js', props: {current_user: current_user})
+end
+```
+
+##### From the server code:
+
+```javascript
+  ...
+
+  // Do something with the user  
+  console.log('Current user', serverProps.currentUser.username);
+
+  ...
+```
+
+The keys in the properties passed to the server will be transformed to camelized strings.
+
+#### Handling redirects with `React-Router-Web`
+
+Below is an example of handling redirects with [`react-router`](https://reacttraining.com/react-router/).
+The principle should be the same for any routing packages.
+
+##### `server.js`
+```typescript jsx
+// Not the complete story
+
+const context = {};
+
+const RedirectWithStatus = ({from, to, status}) => {
+    return (
+      <Route
+        render={({ staticContext }) => {
+          // there is no `staticContext` on the client, so
+          // we need to guard against that here
+          if (staticContext) staticContext.status = status;
+          return <Redirect from={from} to={to} />;
+        }}
+      />
+    );
+}
+
+const markup = ReactDOMServer.renderToString(
+    <StaticRouter location={serverProps.location} context={context}>
+        <Switch>
+            <RedirectWithStatus 
+                status={301} 
+                from="/users" 
+                to="/profiles" />
+            <RedirectWithStatus
+                status={302}
+                from="/courses"
+                to="/dashboard"
+            />
+        </Switch>
+    </StaticRouter>
+);
+
+const output = {
+ html: markup, 
+ logs: recordedLogs, 
+ redirect: context.url,
+ status: context.status 
+};
+
+stdout(JSON.stringify(output));
+```
+More details on SSR and `react-router` at https://reacttraining.com/react-router/web/guides/server-rendering
+
+##### Your controller
+```ruby
+def index
+  output = RailsReactSSR::ServerRunner.exec!('server.js', props: {current_user: current_user, location: request.fullpath})
+  
+  react_response = ActiveSupport::JSON.decode output.split(/[\r\n]+/).reject(&:empty?).last
+
+  react_response.deep_symbolize_keys!
+
+  if react_response[:redirect]
+    redirect_to react_response[:redirect], status: 302
+  else
+    render html: react_response[:html]
+  end
+end
+```
+
+### Caching Example
+
+To improve the response time from the server, you should consider caching.
+
+Things to consider:
+1) Using a cache key that is not the same for every route if you are using a JS routing package.
+2) How large the response is form the JS server.
+
+```ruby
+
+def index
+  ## Do something to the path to generate a key that represents it in the server routes
+  cache_key = generate_cache_key_from_uri request.fullpath  
+  
+  output = Rails.cache.fetch cache_key, expires: 12.hours, race_condition_ttl: 1.minute, namespace: :react_server do
+            RailsReactSSR::ServerRunner.exec!('server.js', props: {current_user: current_user, location: request.fullpath})
+          end
+  
+  handle_server_response output
+end
+
+```
+
+## Alternatives
+
+There are several alternatives that are more comprehensive and might be a better fit for your use case:
+
+1) [ReactOnRails](https://github.com/shakacode/react_on_rails)
+2) [react-rails](https://github.com/reactjs/react-rails)
+3) [reactssr-rails](https://github.com/towry/reactssr-rails)
+
+## Issues
+
+Report bugs at https://github.com/jefawks3/rails-react-ssr.
+Please make sure to include how to reproduce the issue, otherwise it might be ignored.
+
+## Contributing
+
+1) Fork it (https://github.com/jefawks3/rails-react-ssr)
+2) Create your feature branch (git checkout -b my-new-feature)
+3) Commit your changes (git commit -am 'Add some feature')
+4) Push to the branch (git push origin my-new-feature)
+5) Create a new Pull Request
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+

data/lib/rails-react-ssr.rb

@@ -0,0 +1 @@
+require 'rails_react_ssr'

data/lib/rails_react_ssr.rb

@@ -0,0 +1,7 @@
+require 'rails_react_ssr/errors'
+require 'rails_react_ssr/webpacker_utils'
+require 'rails_react_ssr/server_runner'
+
+module RailsReactSSR
+
+end

data/lib/rails_react_ssr/errors.rb

@@ -0,0 +1,24 @@
+module RailsReactSSR
+  # RailsReactSSR error
+  class Error < StandardError
+  end
+
+  # Bundle errors
+  class BundleError < Error
+    attr_reader :bundle
+
+    def initialize(bundle, *args)
+      super *args
+
+      @bundle = bundle
+    end
+  end
+
+  # Missing bundle package
+  class MissingBundleError < BundleError
+  end
+
+  # Execution Error
+  class ExecutionError < BundleError
+  end
+end

data/lib/rails_react_ssr/server_runner.rb

@@ -0,0 +1,120 @@
+require 'webpacker'
+require 'shellwords'
+require 'active_support/json'
+require 'open-uri'
+require 'rails'
+require 'open3'
+
+module RailsReactSSR
+  ##
+  # Executes the ReactJS package using NodeJS that was built using webpacker
+  class ServerRunner
+    ##
+    # Redirect console output to be logged by an array
+    CONSOLE_POLYFILL = <<-CONSOLE_POLYFILL
+const stdout = console.log;
+const stderr = console.error;
+
+const recordedLogs = [];
+
+['log', 'info', 'debug', 'warn', 'error'].forEach(level => {
+    console[level] = (...args) => {
+        recordedLogs.push({ level: level, args: args });
+    }
+});
+    CONSOLE_POLYFILL
+
+    ##
+    # Execute the bundled package
+    #
+    # <tt>:props</tt> - The properties to pass to the server JS code
+    # <tt>:outputTemp</tt> - If true, output the compiled bundle to the tmp/ssr directory, pass a string to specify the
+    #   output file
+    # <tt>:max_tries</tt> - The number of tries when getting the bundle from the webpack dev server
+    # <tt>:delay</tt> - The delay in ms between tries
+    def self.exec!(bundle, props: {}, outputTemp: false, max_tries: 10, delay: 1000)
+      bundle_file = RailsReactSSR::WebpackerUtils.open_bundle bundle, max_tries: max_tries, delay: delay
+
+      ## Format the properties for js
+      jsProps = props.inject({}) do |hash,(k,v)|
+        hash[k.to_s.camelcase.gsub(/\A./, &:downcase)] = v
+        hash
+      end
+
+      status = 0
+      output = nil
+
+      begin
+        js = Tempfile.new [File.basename(bundle_file, '.*'), File.extname(bundle_file)]
+
+        begin
+          write_console_polyfill js
+          write_props_polyfill js, jsProps
+          write_bundle js, bundle_file
+
+          js.flush
+
+          if outputTemp
+            outputTemp = Rails.root.join('tmp/ssr/', bundle) if outputTemp.is_a? TrueClass
+
+            Rails.logger.debug "Coping server bundle to #{outputTemp}"
+            IO.copy_stream js.path, outputTemp
+          end
+
+          status, output = exec_contents js
+        ensure
+          js.unlink
+        end
+      rescue => e
+        Rails.logger.error "Unable to execute the bundle '#{bundle}': #{e.message}"
+        raise RailsReactSSR::ExecutionError.new(bundle, "Unable to run the bundle '#{bundle}'")
+      ensure
+        bundle_file.close
+      end
+
+      raise RailsReactSSR::ExecutionError.new(bundle,"Unable to execute the server bundle #{bundle}") unless status.zero?
+
+      output
+    end
+
+    private
+
+    def self.exec_contents(file)
+      output = error = ''
+
+      cmd = ['node', Shellwords.escape(file.path)]
+
+      cmd_str = cmd.join ' '
+
+      status = Open3.popen3 cmd_str do |inp, out, err, thr|
+        output = out.read
+        error = err.read
+
+        Rails.logger.info "[#{thr.value.exitstatus}}] #{cmd_str}"
+        Rails.logger.debug output
+        Rails.logger.error error unless error.nil? || error.empty?
+
+        thr.value.exitstatus
+      end
+
+      [status, output]
+    end
+
+    def self.write_props_polyfill(temp_file, props)
+      temp_file.write <<-JS
+const serverProps = #{ActiveSupport::JSON.encode props};
+
+      JS
+    end
+
+    def self.write_console_polyfill(temp_file)
+      temp_file.write CONSOLE_POLYFILL
+      temp_file.write "\n\n"
+    end
+
+    def self.write_bundle(temp_file, bundle_file)
+      IO.copy_stream bundle_file, temp_file
+    end
+
+  end
+end

data/lib/rails_react_ssr/version.rb

@@ -0,0 +1,3 @@
+module RailsReactSSR
+  VERSION = "0.1.0"
+end

data/lib/rails_react_ssr/webpacker_utils.rb

@@ -0,0 +1,73 @@
+require 'uri'
+
+module RailsReactSSR
+  class WebpackerUtils
+    ##
+    # Return the hashed name from the +bundle+
+    def self.hashed_bundle_name!(bundle)
+      Webpacker.manifest.lookup! bundle
+    rescue Webpacker::Manifest::MissingEntryError
+      raise RailsReactSSR::MissingBundleError.new(bundle, "The ReactJS package '#{bundle}' is missing from the manifest.json file.")
+    end
+
+    ##
+    # Open the +bundle+ file for reading
+    #
+    # Returns IO stream with the +bundle+ contents. If +bundle+ cannot be found,
+    # raises +RailsReactSSR::MissingBundleError+
+    def self.open_bundle(bundle, max_tries: 10, delay: 1000)
+      hashed = hashed_bundle_name! bundle
+
+      if Webpacker.dev_server.running?
+        dev_server_bundle hashed, max_tries, delay
+      else
+        local_file_bundle hashed
+      end
+    end
+
+    private
+
+    def self.dev_bundle_uri(path)
+      URI::Generic.new(
+          Webpacker.dev_server.protocol,
+          nil,
+          Webpacker.dev_server.host,
+          Webpacker.dev_server.port,
+          nil,
+          path,
+          nil,
+          nil,
+          nil
+      ).to_s
+    end
+
+    def self.bundle_fullpath(path)
+      File.join Rails.root, 'public', path
+    end
+
+    def self.dev_server_bundle(hashed_bundle, max_tries, delay, tries = 0)
+      tries += 1
+
+      uri = self.dev_bundle_uri hashed_bundle
+
+      Rails.logger.debug "Reading remote bundle #{uri}"
+
+      open uri
+    rescue OpenURI::HTTPError => e
+      # On the first page hit my not be available on the dev server so we need to wait for it to compile
+      if tries < max_tries
+        Rails.logger.debug "The remote bundle is not ready trying again in #{delay}ms - #{tries} of #{max_tries}"
+        sleep delay / 1000
+        retry
+      else
+        raise e
+      end
+    end
+
+    def self.local_file_bundle(hashed_bundle)
+      full_path = File.join Rails.root, 'public', hashed_bundle
+
+      File.open full_path, 'rb'
+    end
+  end
+end

data/test/server_runner_test.rb

@@ -0,0 +1,47 @@
+require 'test_helper'
+
+class RailsReactSSR::ServerRunnerTest < RailsReactSSR::Test
+  def setup
+    # Do nothing
+  end
+
+  def teardown
+    # Do nothing
+  end
+
+  def test_application_temp_output
+    tempFile = File.expand_path 'tmp/output.js'
+
+    File.unlink tempFile if File.exists? tempFile
+
+    RailsReactSSR::ServerRunner.exec! 'application.js', outputTemp: tempFile
+
+    assert_equal File.read(tempFile), <<-OUTPUT
+const stdout = console.log;
+const stderr = console.error;
+
+const recordedLogs = [];
+
+['log', 'info', 'debug', 'warn', 'error'].forEach(level => {
+    console[level] = (...args) => {
+        recordedLogs.push({ level: level, args: args });
+    }
+});
+
+
+const serverProps = {};
+
+console.log('Hello World from Webpacker');
+
+stdout('<html><body>Hello from the server</body></html>');
+    OUTPUT
+  end
+
+  def test_application_output
+    output = RailsReactSSR::ServerRunner.exec! 'application.js'
+
+    assert_equal output, <<-OUTPUT
+<html><body>Hello from the server</body></html>
+OUTPUT
+  end
+end

data/test/test_app/Rakefile

@@ -0,0 +1,3 @@
+require_relative "config/application"
+
+Rails.application.load_tasks

data/test/test_app/app/javascript/packs/application.js

@@ -0,0 +1,3 @@
+console.log('Hello World from Webpacker');
+
+stdout('<html><body>Hello from the server</body></html>');

data/test/test_app/bin/webpack

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+ENV["RAILS_ENV"] ||= ENV["RACK_ENV"] || "development"
+ENV["NODE_ENV"] ||= ENV["RAILS_ENV"]
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "bundler/setup"
+
+require "webpacker"
+require "webpacker/webpack_runner"
+Webpacker::WebpackRunner.run(ARGV)

data/test/test_app/bin/webpack-dev-server

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+ENV["RAILS_ENV"] ||= ENV["RACK_ENV"] || "development"
+ENV["NODE_ENV"] ||= ENV["RAILS_ENV"]
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "bundler/setup"
+
+require "webpacker"
+require "webpacker/dev_server_runner"
+Webpacker::DevServerRunner.run(ARGV)

data/test/test_app/config.ru

@@ -0,0 +1,5 @@
+# This file allows the `Rails.root` to be correctly determined.
+
+require_relative "config/environment"
+
+run Rails.application

data/test/test_app/config/application.rb

@@ -0,0 +1,12 @@
+require "action_controller/railtie"
+require "action_view/railtie"
+require "webpacker"
+
+module TestApp
+  class Application < ::Rails::Application
+    config.secret_key_base = "abcdef"
+    config.eager_load = true
+    config.webpacker.check_yarn_integrity = false
+    config.active_support.test_order = :sorted
+  end
+end

data/test/test_app/config/environment.rb

@@ -0,0 +1,4 @@
+require_relative "application"
+
+Rails.backtrace_cleaner.remove_silencers!
+Rails.application.initialize!

data/test/test_app/config/webpacker.yml

@@ -0,0 +1,97 @@
+# Note: You must restart bin/webpack-dev-server for changes to take effect
+
+default: &default
+  source_path: app/javascript
+  source_entry_path: packs
+  public_root_path: public
+  public_output_path: packs
+  cache_path: tmp/cache/webpacker
+  webpack_compile_output: false
+
+  # Additional paths webpack should lookup modules
+  # ['app/assets', 'engine/foo/app/assets']
+  resolved_paths:
+    - app/assets
+    - /etc/yarn
+
+  # Reload manifest.json on all requests so we reload latest compiled packs
+  cache_manifest: false
+
+  # Extract and emit a css file
+  extract_css: false
+
+  static_assets_extensions:
+    - .jpg
+    - .jpeg
+    - .png
+    - .gif
+    - .tiff
+    - .ico
+    - .svg
+
+  extensions:
+    - .mjs
+    - .js
+    - .sass
+    - .scss
+    - .css
+    - .module.sass
+    - .module.scss
+    - .module.css
+    - .png
+    - .svg
+    - .gif
+    - .jpeg
+    - .jpg
+
+development:
+  <<: *default
+  compile: true
+
+  # Reference: https://webpack.js.org/configuration/dev-server/
+  dev_server:
+    https: false
+    host: localhost
+    port: 3035
+    public: localhost:3035
+    hmr: false
+    # Inline should be set to true if using HMR
+    inline: true
+    overlay: true
+    disable_host_check: true
+    use_local_ip: false
+    pretty: false
+
+test:
+  <<: *default
+  compile: true
+
+  # Compile test packs to a separate directory
+  public_output_path: packs-test
+
+production:
+  <<: *default
+
+  # Production depends on precompilation of packs prior to booting for performance.
+  compile: false
+
+  # Extract and emit a css file
+  extract_css: true
+
+  # Cache manifest.json for performance
+  cache_manifest: true
+
+staging:
+  <<: *default
+
+  # Production depends on precompilation of packs prior to booting for performance.
+  compile: false
+
+  # Extract and emit a css file
+  extract_css: true
+
+  # Cache manifest.json for performance
+  cache_manifest: true
+
+  # Compile staging packs to a separate directory
+  public_output_path: packs-staging

data/test/test_app/config/webpacker_public_root.yml

@@ -0,0 +1,19 @@
+# Note: You must restart bin/webpack-dev-server for changes to take effect
+
+default: &default
+  public_root_path: ../public
+
+development:
+  <<: *default
+  compile: true
+
+test:
+  <<: *default
+  compile: true
+  public_output_path: packs-test
+
+production:
+  <<: *default
+  compile: false
+  extract_css: true
+  cache_manifest: true

data/test/test_app/log/development.log

@@ -0,0 +1,12 @@
+The remote bundle is not ready trying again in 1000ms - 1 of 10
+The remote bundle is not ready trying again in 1000ms - 1 of 10
+The remote bundle is not ready trying again in 1000ms - 1 of 10
+The remote bundle is not ready trying again in 1000ms - 1 of 10
+Reading remote bundle http://localhost:3035/packs/application-k344a6d59eef8632c9d1.js
+The remote bundle is not ready trying again in 1000ms - 1 of 10
+Reading remote bundle http://localhost:3035/packs/application-k344a6d59eef8632c9d1.js
+The remote bundle is not ready trying again in 1000ms - 1 of 10
+[Webpacker] Compiling…
+[Webpacker] Compilation failed:
+error Command "webpack" not found.
+

data/test/test_app/package.json

@@ -0,0 +1,13 @@
+{
+  "name": "test_app",
+  "version": "1.0.0",
+  "main": "index.js",
+  "license": "MIT",
+  "private": true,
+  "dependencies": {
+    "left-pad": "^1.2.0"
+  },
+  "devDependencies": {
+    "right-pad": "^1.0.1"
+  }
+}

data/test/test_app/public/packs/application-k344a6d59eef8632c9d1.js

@@ -0,0 +1,3 @@
+console.log('Hello World from Webpacker');
+
+stdout('<html><body>Hello from the server</body></html>');

data/test/test_app/public/packs/manifest.json

@@ -0,0 +1,31 @@
+{
+  "bootstrap.css": "/packs/bootstrap-c38deda30895059837cf.css",
+  "application.css": "/packs/application-dd6b1cd38bfa093df600.css",
+  "bootstrap.js": "/packs/bootstrap-300631c4f0e0f9c865bc.js",
+  "application.js": "/packs/application-k344a6d59eef8632c9d1.js",
+  "application.png": "/packs/application-k344a6d59eef8632c9d1.png",
+  "fonts/fa-regular-400.woff2": "/packs/fonts/fa-regular-400-944fb546bd7018b07190a32244f67dc9.woff2",
+  "media/images/image.jpg": "/packs/media/images/image-c38deda30895059837cf.jpg",
+  "media/images/nested/image.jpg": "/packs/media/images/nested/image-c38deda30895059837cf.jpg",
+  "media/images/mb-icon.png": "/packs/media/images/mb-icon-c38deda30895059837cf.png",
+  "media/images/nested/mb-icon.png": "/packs/media/images/nested/mb-icon-c38deda30895059837cf.png",
+  "entrypoints": {
+    "application": {
+      "js": [
+        "/packs/vendors~application~bootstrap-c20632e7baf2c81200d3.chunk.js",
+        "/packs/vendors~application-e55f2aae30c07fb6d82a.chunk.js",
+        "/packs/application-k344a6d59eef8632c9d1.js"
+      ],
+      "css": [
+        "/packs/1-c20632e7baf2c81200d3.chunk.css",
+        "/packs/application-k344a6d59eef8632c9d1.chunk.css"
+      ]
+    },
+    "hello_stimulus": {
+      "css": [
+        "/packs/1-c20632e7baf2c81200d3.chunk.css",
+        "/packs/hello_stimulus-k344a6d59eef8632c9d1.chunk.css"
+      ]
+    }
+  }
+}

data/test/test_app/yarn.lock

@@ -0,0 +1,11 @@
+# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+# yarn lockfile v1
+
+
+left-pad@^1.2.0:
+  version "1.2.0"
+  resolved "https://registry.yarnpkg.com/left-pad/-/left-pad-1.2.0.tgz#d30a73c6b8201d8f7d8e7956ba9616087a68e0ee"
+
+right-pad@^1.0.1:
+  version "1.0.1"
+  resolved "https://registry.yarnpkg.com/right-pad/-/right-pad-1.0.1.tgz#8ca08c2cbb5b55e74dafa96bf7fd1a27d568c8d0"

data/test/test_helper.rb

@@ -0,0 +1,38 @@
+require 'minitest/autorun'
+
+require "rails"
+require "rails/test_help"
+require "byebug"
+require 'rails-react-ssr'
+
+require_relative "test_app/config/environment"
+
+Rails.env = "production"
+
+Rails.logger = Logger.new(STDOUT)
+Rails.logger.level = Logger::DEBUG
+
+
+Webpacker.instance = ::Webpacker::Instance.new
+
+class RailsReactSSR::Test < Minitest::Test
+  private
+  def reloaded_config
+    Webpacker.instance.instance_variable_set(:@env, nil)
+    Webpacker.instance.instance_variable_set(:@config, nil)
+    Webpacker.instance.instance_variable_set(:@dev_server, nil)
+    Webpacker.env
+    Webpacker.config
+    Webpacker.dev_server
+  end
+
+  def with_rails_env(env)
+    original = Rails.env
+    Rails.env = ActiveSupport::StringInquirer.new(env)
+    reloaded_config
+    yield
+  ensure
+    Rails.env = ActiveSupport::StringInquirer.new(original)
+    reloaded_config
+  end
+end

data/test/webpacker_utils_test.rb

@@ -0,0 +1,41 @@
+require 'test_helper'
+require 'webpacker/dev_server_runner'
+
+class RailsReactSSR::WebpackerUtilsTest < RailsReactSSR::Test
+  def test_bundle_not_found!
+    error = assert_raises RailsReactSSR::MissingBundleError do
+      RailsReactSSR::WebpackerUtils.hashed_bundle_name! 'missing.js'
+    end
+
+    assert_match 'missing.js', error.bundle
+    assert_match "The ReactJS package 'missing.js' is missing from the manifest.json file.", error.message
+  end
+
+  def test_bundle_found!
+    assert_equal RailsReactSSR::WebpackerUtils.hashed_bundle_name!('application.js'),
+                 "/packs/application-k344a6d59eef8632c9d1.js"
+  end
+
+  def test_open_local_file
+    io = RailsReactSSR::WebpackerUtils.open_bundle 'application.js'
+
+    refute Webpacker.dev_server.running?
+
+    assert_equal io.read, raw_application_js
+  end
+
+  def test_open_remote_file
+    # TODO Run dev server during tests to make sure remote file is accessible
+    skip 'Need to find a way to run the dev server during the tests'
+  end
+
+  private
+
+  def raw_application_js
+    <<-AppplicaitonJS
+console.log('Hello World from Webpacker');
+
+stdout('<html><body>Hello from the server</body></html>');
+    AppplicaitonJS
+  end
+end

metadata

@@ -0,0 +1,175 @@
+--- !ruby/object:Gem::Specification
+name: rails-react-ssr
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- James Fawks
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-01-21 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.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.2
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.14'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+description: 
+email:
+- jefawks3@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- README.md
+- lib/rails-react-ssr.rb
+- lib/rails_react_ssr.rb
+- lib/rails_react_ssr/errors.rb
+- lib/rails_react_ssr/server_runner.rb
+- lib/rails_react_ssr/version.rb
+- lib/rails_react_ssr/webpacker_utils.rb
+- test/server_runner_test.rb
+- test/test_app/Rakefile
+- test/test_app/app/javascript/packs/application.js
+- test/test_app/bin/webpack
+- test/test_app/bin/webpack-dev-server
+- test/test_app/config.ru
+- test/test_app/config/application.rb
+- test/test_app/config/environment.rb
+- test/test_app/config/webpack/development.js
+- test/test_app/config/webpacker.yml
+- test/test_app/config/webpacker_public_root.yml
+- test/test_app/log/development.log
+- test/test_app/package.json
+- test/test_app/public/packs/application-k344a6d59eef8632c9d1.js
+- test/test_app/public/packs/manifest.json
+- test/test_app/yarn.lock
+- test/test_helper.rb
+- test/webpacker_utils_test.rb
+homepage: https://github.com/jefawks3/rails-react-ssr
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/jefawks3/rails-react-ssr
+  source_code_uri: https://github.com/jefawks3/rails-react-ssr
+  changelog_uri: https://github.com/jefawks3/rails-react-ssr/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: Light weight React SSR (Server Side Rendering) integration for Ruby on Rails,
+  Webpacker and NodeJS
+test_files:
+- test/test_app/app/javascript/packs/application.js
+- test/test_app/bin/webpack
+- test/test_app/bin/webpack-dev-server
+- test/test_app/config/environment.rb
+- test/test_app/config/webpacker_public_root.yml
+- test/test_app/config/application.rb
+- test/test_app/config/webpack/development.js
+- test/test_app/config/webpacker.yml
+- test/test_app/config.ru
+- test/test_app/Rakefile
+- test/test_app/yarn.lock
+- test/test_app/public/packs/manifest.json
+- test/test_app/public/packs/application-k344a6d59eef8632c9d1.js
+- test/test_app/package.json
+- test/test_app/log/development.log
+- test/server_runner_test.rb
+- test/webpacker_utils_test.rb
+- test/test_helper.rb