react_on_rails 11.0.4 → 11.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 55cdca62eaf8c15553635f8255d102728e030761
-  data.tar.gz: c72e8903805accdf9cf3964162dfdfe4254380ca
+  metadata.gz: 1e2e9cfdc5d161ab3706f779c18c8ce1a166b066
+  data.tar.gz: 6211ecc33d60cccc7d385ddcc7550a31f1502d43
 SHA512:
-  metadata.gz: 74f8c628d2e4ef60422d383483d2828fc70e773ab85a88f2d44a8a43a357cfd61b3213e9016aefe3963371d965b70fbca3f2599f29037d09f2d3218c08cc9d06
-  data.tar.gz: 8f34bcfa66613559f97ffaa766e676bdd6df69484eb21d1e1f1d34eeaba972910eee058e7347c84e252bee8f87b44e5282d9ae896d467d05c92ddba03a00e3cd
+  metadata.gz: 3cac9f496b6163da14528c717ef9c6a87ad15d11f87cab027d3af08ebe48121345f62264cd42dcd2cb64e847a38bc07a2ccb6b5951a98b9ca4737414e1a5afe2
+  data.tar.gz: e692554e9375d8c789894624c86639fcc442314ccc024050fca0ee4e371a7f05e047188bed0cf24f6d32497b7ee454ad9cba07fc1d062821c720a0274d4ddd50

data/CHANGELOG.md

@@ -10,6 +10,11 @@ Changes since last non-beta release.
 
 *Please add entries here for your pull requests that are not yet released.*
 
+#### Changed
+
+### [11.0.5] - 2018-05-11
+- More detailed errors for Honeybadger and Sentry. [PR 1081](https://github.com/shakacode/react_on_rails/pull/1081) by [justin808](https://github.com/justin808).
+
 ### [11.0.4] - 2018-05-3
 
 #### Changed
@@ -753,7 +758,8 @@ Best done with Object destructing:
 ##### Fixed
 - Fix several generator related issues.
 
-[Unreleased]: https://github.com/shakacode/react_on_rails/compare/11.0.4...master
+[Unreleased]: https://github.com/shakacode/react_on_rails/compare/11.0.5...master
+[11.0.5]: https://github.com/shakacode/react_on_rails/compare/11.0.4...11.0.5
 [11.0.4]: https://github.com/shakacode/react_on_rails/compare/11.0.3...11.0.4
 [11.0.3]: https://github.com/shakacode/react_on_rails/compare/11.0.2...11.0.3
 [11.0.2]: https://github.com/shakacode/react_on_rails/compare/11.0.1...11.0.2

data/README.md

@@ -697,6 +697,10 @@ If you are using [jquery-ujs](https://github.com/rails/jquery-ujs) for AJAX call
 1. Examples in [spec/dummy/app/views/react_router](./spec/dummy/app/views/react_router) and follow to the JavaScript code in the [spec/dummy/client/app/startup/ServerRouterApp.jsx](spec/dummy/client/app/startup/ServerRouterApp.jsx).
 1. [Code Splitting docs](./docs/additional-reading/code-splitting.md) for information about how to set up code splitting for server rendered routes.
 
+## Error Handling
+* All errors from ReactOnRails will be of type ReactOnRails::Error.
+* Prerendering (server rendering) errors get context information for HoneyBadger and Sentry for easier debugging.
+
 ## Caching and Performance
 Consider fragment and http caching of pages that contain React on Rails components. See [Caching and Performance](./docs/additional-reading/caching-and-performance.md) for more details.
 

data/docs/basics/configuration.md

@@ -5,7 +5,6 @@ Here is the full set of config options. This file is `/config/initializers/react
 
 # NOTE: you typically will leave the commented out configurations set to their defaults.
 # Thus, you only need to pay careful attention to the non-commented settings in this file.
-
 ReactOnRails.configure do |config|
   # `trace`: General debugging flag.
   # The default is true for development, off otherwise.
@@ -61,6 +60,9 @@ ReactOnRails.configure do |config|
   # The default is `%w( manifest.json )` as will be sufficient for most webpacker builds.
   #
   config.webpack_generated_files = %w( manifest.json )
+  
+  # You can optionally add values to your rails_context. See example below for RenderingExtension
+  # config.rendering_extension = RenderingExtension
 
   ################################################################################
   ################################################################################
@@ -141,3 +143,21 @@ ReactOnRails.configure do |config|
 end
 
 ```
+
+Example of a RenderingExtension for custom values in the `rails_context`:
+
+```ruby
+module RenderingExtension
+
+  # Return a Hash that contains custom values from the view context that will get merged with
+  # the standard rails_context values and passed to all calls to generator functions used by the
+  # react_component and redux_store view helpers
+  def self.custom_context(view_context)
+    {
+     somethingUseful: view_context.session[:something_useful]
+    }
+  end
+end
+```
+
+

data/lib/react_on_rails/prerender_error.rb

@@ -2,10 +2,34 @@
 
 # rubocop:disable: Layout/IndentHeredoc
 module ReactOnRails
-  class PrerenderError < StandardError
+  class PrerenderError < ::ReactOnRails::Error
+    attr_reader :component_name, :err, :props, :js_code, :console_messages
+
     # err might be nil if JS caught the error
     def initialize(component_name: nil, err: nil, props: nil,
                    js_code: nil, console_messages: nil)
+      @component_name = component_name
+      @err = err
+      @props = props
+      @js_code = js_code
+      @console_messages = console_messages
+
+      backtrace, message = calc_message(component_name, console_messages, err, js_code, props)
+
+      super([message, backtrace].compact.join("\n"))
+    end
+
+    def to_honeybadger_context
+      to_error_context
+    end
+
+    def raven_context
+      to_error_context
+    end
+
+    private
+
+    def calc_message(component_name, console_messages, err, js_code, props)
       message = "ERROR in SERVER PRERENDERING\n".dup
       if err
         # rubocop:disable Layout/IndentHeredoc
@@ -33,8 +57,17 @@ console messages:
         MSG
         # rubocop:enable Layout/IndentHeredoc
       end
+      [backtrace, message]
+    end
 
-      super([message, backtrace].compact.join("\n"))
+    def to_error_context
+      {
+        component_name: component_name,
+        err: err,
+        props: props,
+        js_code: js_code,
+        console_messages: console_messages
+      }
     end
   end
 end

data/lib/react_on_rails/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ReactOnRails
-  VERSION = "11.0.4".freeze
+  VERSION = "11.0.5".freeze
 end

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-on-rails",
-  "version": "11.0.4",
+  "version": "11.0.5",
   "description": "react-on-rails JavaScript for react_on_rails Ruby gem",
   "main": "node_package/lib/ReactOnRails.js",
   "directories": {

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: react_on_rails
 version: !ruby/object:Gem::Version
-  version: 11.0.4
+  version: 11.0.5
 platform: ruby
 authors:
 - Justin Gordon
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-04 00:00:00.000000000 Z
+date: 2018-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable