rails-react-ssr 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3912c1b48d7d967fd867a88e16704ca98cd407d89d9ec0ce81c5d84c2fd975c5
-  data.tar.gz: 3874620976e632c57a7f05cdfdb72d9953f11218cc90a81b79aac51187e6b8db
+  metadata.gz: 4ad59fce8226f5e73736449a5a2b85930470960916ff111dc4acb8b71066a525
+  data.tar.gz: d705798c238dc41fcfb5a3299b1e7289c9d3e366a80095bc4330abdfb8687b3b
 SHA512:
-  metadata.gz: 390e781fb0622497b051d6d1cd52bf7f306c6de19a24bae542692b64680d760e5f7f4ba3a8371bec1fd3c287ed8f41e1f09f11afa08a502fe4928965cf1c10ad
-  data.tar.gz: 8eda42ff7e39306e8a5af2130d8db038cccb6725f346c59529586f59be1c2f0728d31a0992f1f31fa12a634e94a34dcf58c452d4da7ca73a98a04b5ee127967b
+  metadata.gz: 0edf899b630e4a184844fa8758ea823cd5964d35883800247112360145c5f2b6dc790ec1588dbbeccf0280b037e0d4edccdb14069c6463ab62ef3c2a5ee5a9e2
+  data.tar.gz: 6bf7ea4daf87400c26541ed101b192a848623439ecef8a9edbfbae10f37a2e0296a3bf80f110c3340b7c74dce23c4e5b08ca0ceb06403894faaade9b2a963b5d

data/README.md

@@ -5,8 +5,9 @@ RailsReactSSR is a light weight JS server side rendering utility that takes adva
 ## 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).
+handle routing and handle the front end. I needed a basic tool that would not add a lot of bloat, be able to handle 
+server side rendering while allowing me to process the response (i.e. handle redirects from the router) and did not
+force me to use any packages or make decisions for me on how to structure my ReactJS code.
 
 ## Dependencies
 
@@ -175,6 +176,19 @@ end
 
 ```
 
+## Common Issues with SSR and Rails
+
+### I'm unable to execute code with webpacker-dev-server running.
+
+The `webpacker-dev-server` injects a websocket when `inline` or `hmr` flags are set to true in for the `dev_server`
+configuration in `webpacker.yml`. Make sure these are set to **false** if you plan on implementing SSR.
+
+### `document` or `window` is not defined
+
+Global objects like `document` or `window` that are specific to browsers are not set when running the javascript on 
+the server; so it's best to wrap any code, or avoid using it outside of `componentDidMount`, `componentDidUpdate` or
+`componentWillUnmount`.
+
 ## Alternatives
 
 There are several alternatives that are more comprehensive and might be a better fit for your use case:

data/lib/rails_react_ssr/server_runner.rb

@@ -35,12 +35,6 @@ const recordedLogs = [];
     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
 
@@ -49,7 +43,7 @@ const recordedLogs = [];
 
         begin
           write_console_polyfill js
-          write_props_polyfill js, jsProps
+          write_props_polyfill js, props
           write_bundle js, bundle_file
 
           js.flush
@@ -101,8 +95,14 @@ const recordedLogs = [];
     end
 
     def self.write_props_polyfill(temp_file, props)
+      ## Format the properties for js
+      jsProps = props.inject({}) do |hash,(k,v)|
+        hash[k.to_s.camelcase.gsub(/\A./, &:downcase)] = v
+        hash
+      end
+
       temp_file.write <<-JS
-const serverProps = #{ActiveSupport::JSON.encode props};
+const serverProps = #{ActiveSupport::JSON.encode jsProps};
 
       JS
     end

data/lib/rails_react_ssr/version.rb

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

data/test/webpacker_utils_test.rb

@@ -13,7 +13,7 @@ class RailsReactSSR::WebpackerUtilsTest < RailsReactSSR::Test
 
   def test_bundle_found!
     assert_equal RailsReactSSR::WebpackerUtils.hashed_bundle_name!('application.js'),
-                 "/packs/application-k344a6d59eef8632c9d1.js"
+                 '/packs/application-k344a6d59eef8632c9d1.js'
   end
 
   def test_open_local_file
@@ -29,6 +29,15 @@ class RailsReactSSR::WebpackerUtilsTest < RailsReactSSR::Test
     skip 'Need to find a way to run the dev server during the tests'
   end
 
+  def test_build_remote_uri
+    with_rails_env 'development' do
+      hashed_bundle = '/packs/application-k344a6d59eef8632c9d1.js'
+      uri = RailsReactSSR::WebpackerUtils.send :dev_bundle_uri, hashed_bundle
+
+      assert_equal uri, 'http://localhost:3035/packs/application-k344a6d59eef8632c9d1.js'
+    end
+  end
+
   private
 
   def raw_application_js

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-react-ssr
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - James Fawks
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-21 00:00:00.000000000 Z
+date: 2020-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: webpacker