Skip to content

Latest commit

 

History

History
1310 lines (1015 loc) · 91.1 KB

CHANGELOG.md

File metadata and controls

1310 lines (1015 loc) · 91.1 KB
Raw

Change Log

All notable changes to this project's source code will be documented in this file. Items under Unreleased is upcoming features that will be out in the next version.

Migration instructions for the major updates can be found here. Some smaller migration information can be found here.

Want to Save Time Updating?

If you need help upgrading react_on_rails, webpacker to shakapacker, or JS packages, contact [email protected]. We can upgrade your project and improve your development and customer experiences, allowing you to focus on building new features or fixing bugs instead.

For an overview of working with us, see our Client Engagement Model article and how we bill for time.

If you think ShakaCode can help your project, click here to book a call with Justin Gordon, the creator of React on Rails and Shakapacker.

Contributors

Please follow the recommendations outlined at keepachangelog.com. Please use the existing headings and styling as a guide, and add a link for the version diff at the bottom of the file. Also, please update the Unreleased link to compare to the latest release version.

Versions

Unreleased

Changes since the last non-beta release.

Added(https://github.com/AbanoubGhadban).

  • Added streaming server rendering support:
    • PR #1633 by AbanoubGhadban.
      • New stream_react_component helper for adding streamed components to views
      • New streamServerRenderedReactComponent function in the react-on-rails package that uses React 18's renderToPipeableStream API
      • Enables progressive page loading and improved performance for server-rendered React components
    • Added support for replaying console logs that occur during server rendering of streamed React components. This enables debugging of server-side rendering issues by capturing and displaying console output on the client and on the server output. PR #1647 by AbanoubGhadban.
    • Added support for handling errors happening during server rendering of streamed React components. It handles errors that happen during the initial render and errors that happen inside suspense boundaries. PR #1648 by AbanoubGhadban.

Changed

  • Console replay script generation now awaits the render request promise before generating, allowing it to capture console logs from asynchronous operations. This requires using a version of the Node renderer that supports replaying async console logs. PR #1649 by AbanoubGhadban.

Fixed

  • Incorrect type and confusing name for ReactOnRails.registerStore, use registerStoreGenerators instead. PR 1651 by alexeyr-ci.

14.0.5 - 2024-08-20

Fixed

14.0.4 - 2024-07-02

Improved

  • Improved dependency management by integrating package_json. PR 1639 by vaukalak.

Changed

  • Update outdated GitHub Actions to use Node.js 20.0 versions instead PR 1623 by adriangohjw.

14.0.3 - 2024-06-28

Fixed

14.0.2 - 2024-06-11

Fixed

14.0.1 - 2024-05-16

Fixed

  • Pack Generation: Added functionality that will add an import statement, if missing, to the server bundle entry point even if the auto-bundle generated files still exist PR 1610 by judahmeek.

14.0.0 - 2024-04-03

Major bump because dropping support for Ruby 2.7 and deprecated webpackConfigLoader.js.

Removed

Fixed

  • Trimmed the Gem to remove package.json which could cause superflous security warnings. PR 1605 by justin808.
  • Prevent displaying the deprecation message for using webpacker_precompile? method and webpacker:clean rake task when using Shakapacker v7+ PR 1592 by ahangarha.
  • Fixed Typescript types for ServerRenderResult, ReactComponent, RenderFunction, and RailsContext interfaces. PR 1582 & PR 1585 by kotarella1110
  • Removed a workaround in JsonOutput#escape for an no-longer supported Rails version. Additionally, removed Utils.rails_version_less_than_4_1_1 which was only used in the workaround. PR 1580 by wwahammy

Added

13.4.0 - 2023-07-30

Fixed

  • Fixed Pack Generation logic during assets:precompile if auto_load_bundle is false & components_subdirectory is not set. PR 1567 by blackjack26 & judahmeek.

Improved

  • Improved performance by removing an unnecessary JS eval from Ruby. PR 1544 by wyattades.

Added

Changed

  • Throw error when attempting to redefine ReactOnRails. PR 1562 by rubenochiavone.
  • Prevent generating FS-based packs when component_subdirectory configuration is not present. PR 1567 by blackjack26.
  • Removed a requirement for autoloaded pack files to be generated as part of CI or deployment separate from initial Shakapacker bundling. PR 1545 by judahmeek.

13.3.5 - 2023-05-31

Fixed

  • Fixed race condition where a react component could attempt to initialize before it had been registered. PR 1540 by judahmeek.

13.3.4 - 2023-05-23

Added

  • Improved functionality of Filesystem-based pack generation & auto-bundling. Added make_generated_server_bundle_the_entrypoint configuration key. PR 1531 by judahmeek.

Removed

  • Removed unneeded HMR=true from Procfile.dev in install template PR 1537 by ahangarha.

13.3.3 - 2023-03-21

Fixed

13.3.2 - 2023-02-24

Fixed

  • Fixed the bug in bin/dev and bin/dev-static scripts by using system instead of exec and remove option to pass arguments PR 1519 by ahangarha.

13.3.1 - 2023-01-30

Added

  • Optimized ReactOnRails::TestHelper's RSpec integration using when_first_matching_example_defined. PR 1496 by mcls.

Fixed

13.3.0 - 2023-01-29

Fixed

  • Fixed pack not found warning while using react_component and react_component_hash helpers, even when corresponding chunks are present. PR 1511 by pulkitkkr.
  • Fixed FS-based packs generation functionality to trigger pack generation on the creation of a new react component inside components_subdirectory. PR 1506 by pulkitkkr.
  • Upgrade several JS dependencies to fix security issues. PR 1514 by ahangarha.

Added

  • Added ./bin/dev and ./bin/dev-static executables to ease and standardize running the dev server. PR 1491 by ahangarha.

13.2.0 - 2022-12-23

Fixed

  • Fix reactOnRailsPageUnloaded when there is no component on the page. Important for apps using both hotwire and react_on_rails. PR 1498 by NhanHo.
  • Fixing wrong type. The throwIfMissing param of getStore should be optional as it defaults to true. PR 1480 by wouldntsavezion.

Added

13.1.0 - 2022-08-20

Improved

  • Removed addition of mini_racer gem by default. PR 1453 by vtamara and tomdracz.

    Using mini_racer makes most sense when deploying or building in environments that do not have Javascript runtime present. Since react_on_rails requires Node.js, there's no reason to override ExecJS runtime with mini_racer.

    To migrate this change, remove mini_racer gem from your Gemfile and test your app for correct behaviour. You can continue using mini_racer and it will be still picked as the default ExecJS runtime, if present in your app Gemfile.

  • Upgraded the example test app in spec/dummy to React 18. PR 1463 by alexeyr.

  • Added file-system-based automatic bundle generation feature. PR 1455 by pulkitkkr.

Fixed

  • Correctly unmount roots under React 18. PR 1466 by alexeyr.

  • Fixed the You are importing hydrateRoot from "react-dom" [...] You should instead import it from "react-dom/client" warning under React 18 (#1441). PR 1460 by alexeyr.

    In exchange, you may see a warning like this when building using any version of React below 18:

    WARNING in ./node_modules/react-on-rails/node_package/lib/reactHydrateOrRender.js19:25-52
Module not found: Error: Can't resolve 'react-dom/client' in '/home/runner/work/react_on_rails/react_on_rails/spec/dummy/node_modules/react-on-rails/node_package/lib'
 @ ./node_modules/react-on-rails/node_package/lib/ReactOnRails.js 34:45-78
 @ ./client/app/packs/client-bundle.js 5:0-42 32:0-23 35:0-21 59:0-26

    It can be safely suppressed in your Webpack configuration.

13.0.2 - 2022-03-09

Fixed

  • React 16 doesn't support version property, causing problems loading React on Rails. PR 1435 by justin808.

13.0.1 - 2022-02-09

Improved

13.0.0 - 2022-02-08

Breaking

  • Removed webpacker as a dependency. Add gem Shakapacker to your project, and update your package.json to also use shakapacker.

Fixed

  • Proper throwing of exceptions.
  • Default configuration better handles test env.

12.6.0 - 2022-01-22

Added

  • A rendering_props_extension configuration which takes a module with an adjust_props_for_client_side_hydration method, which is used to process props differently for server/client if prerender is set to true. PR 1413 by gscarv13 & judahmeek.

12.5.2 - 2021-12-29

Fixed

  • Usage of config.build_production_command for custom command for production builds fixed. PR 1415 by judahmeek.

12.5.1 - 2021-12-27

Fixed

  • A fatal server rendering error if running an ReactOnRails >=12.4.0 with ReactOnRails Pro <2.4.0. PR 1412 by judahmeek.

12.5.0 - 2021-12-26

Added

  • Support for React 18, including the changed SSR API. PR 1409 by kylemellander.
  • Added webpack configuration files as part of the generator and updated webpacker to version 6. PR 1404 by gscarv13.
  • Supports Rails 7.

Changed

  • Changed logic of determining the usage of the default rails/webpacker webpack config or a custom command to only check if the config.build_production_command is defined. PR 1402 by justin808 and gscarv13.
  • Minimum required Ruby is 2.7 to match latest rails/webpacker.

12.4.0 - 2021-09-22

Added

  • ScoutAPM tracing support for server rendering PR 1379 by justin808.

  • Ability to stop React on Rails from modifying or creating the assets:precompile task. PR 1371 by justin808. Thanks to elstgav for the suggestion!

  • Added the ability to have render functions return a promise to be awaited by React on Rails Pro Node Renderer. PR 1380 by judahmeek

12.3.0 - 2021-07-26

Added

  • Ability to use with Turbo (@hotwired/turbo), as Turbolinks gets obsolete. PR 1374 by pgruener and PR 1377 by mdesantis.

    To configure turbo the following option can be set: ReactOnRails.setOptions({ turbo: true })

12.2.0 - 2021-03-25

Added

  • Ability to configure server react rendering to throw rather than just logging the error. Useful for React on Rails Pro Node rendering PR 1365 by justin808.

12.1.0 - 2021-03-23

Added

Fixed

12.0.4 - 2020-11-14

Fixed

12.0.3 - 2020-09-20

Fixed

12.0.2 - 2020-07-09

Fixed

12.0.1 - 2020-07-09

Fixed

  • Changed invocation of webpacker:clean to use a very large number of versions so it does not accidentally delete the server-bundle.js. PR 1306 by By justin808.

12.0.0 - 2020-07-08

For upgrade instructions, see docs/guides/upgrading-react-on-rails.md.

Major Improvements

  1. React Hooks Support for top level components
  2. Typescript bindings
  3. rails/webpacker "just works" with React on Rails by default.
  4. i18n support for generating a JSON file rather than a JS file.

BREAKING CHANGE

In order to solve the issues regarding React Hooks compatibility, the number of parameters for functions is used to determine if you have a generator function that will get invoked to return a React component, or you are registering a functional React component. Alternately, you can set JavaScript property renderFunction on the function for which you want to return to be invoked to return the React component. In that case, you won't need to pass any unused params. PR 1268 by justin808

See docs/guides/upgrading-react-on-rails for details.

Other Updates

  • react_on_rails fully supports rails/webpacker. The example test app in spec/dummy was recently converted over to use rails/webpacker v4+. It's a good example of how to leverage rails/webpacker's webpack configuration for server-side rendering.

  • Changed the precompile task to use the rails/webpacker one by default

  • Updated generators to use React hooks

  • Requires the use of rails/webpacker view helpers

  • If the webpacker webpack config files exist, then React on Rails will not override the default assets:precompile setup by rails/webpacker. If you are not using the rails/webpacker setup for webpack, then be sure to remove the JS files inside of config/webpack, like config/webpack/production.js.

  • Removed env_javascript_include_tag and env_stylesheet_link_tag as these are replaced by view helpers from rails/webpacker

  • Removal of support for old Rubies and Rails.

  • Removal of config.symlink_non_digested_assets_regex as it's no longer needed with rails/webpacker. If any business needs this, we can move the code to a separate gem.

  • Added configuration option same_bundle_for_client_and_server with default false because

    1. Production applications would typically have a server bundle that differs from the client bundle
    2. This change only affects trying to use HMR with react_on_rails with rails/webpacker.

    The previous behavior was to always go to the webpack-dev-server for the server bundle if the webpack-dev-server was running and the server bundle was found in the manifest.json.

    If you are using the same bundle for client and server rendering, then set this configuration option to true. By justin808.

  • Added support to export locales in JSON format. New option added i18n_output_format which allows to specify locales format either JSON or JS. JSON format is now the default.

    Use this config setting to get the old behavior: config.i18n_output_format = 'js'

    PR 1271 by ashgaliyev.

  • Added Typescript definitions to the Node package. By justin808 and judahmeek in PR 1287.
  • Removed restriction to keep the server bundle in the same directory with the client bundles. Rails/webpacker 4 has an advanced cleanup that will remove any files in the directory of other webpack files. Removing this restriction allows the server bundle to be created in a sibling directory. By justin808.

11.3.0 - 2019-05-24

Added

  • Added method for retrieving any option from render_options PR 1213 by ashgaliyev.

  • html_options has an option for 'tag' to set the html tag name like this: html_options: { tag: "span" }. PR 1208 by tahsin352.

11.2.2 - 2018-12-24

Improved

  • rails_context can more easily be called from controller methods. The mandatory param of server_side has been made optional.

11.2.1 - 2018-12-06

MIGRATION for v11.2

  • If using React on Rails Pro, upgrade react_on_rails_pro to a version >= 1.3.

Improved

  • To support React v16, updated API for manually calling ReactOnRails.render(name, props, domNodeId, hydrate). Added 3rd @param hydrate Pass truthy to update server rendered html. Default is falsey Any truthy values calls hydrate rather than render. PR 1159 by justin808 and coopersamuel.

  • Enabled the use of webpack-dev-server with Server-side rendering. PR 1173 by justin808 and judahmeek.

Changed

  • Changed the default for:

    config.raise_on_prerender_error = Rails.env.development?

    Thus, developers will need to fix server rendering errors before continuing. PR 1145 by justin808.

11.2.0 - 2018-12-06

Do not use. Unpublished. Caused by an issue with the release script.

11.1.8 - 2018-10-14

Improved

  • Improved tutorial and support for HMR when using rails/webpacker for Webpack configuration. PR 1156 by justin808.

11.1.7 - 2018-10-10

Fixed

  • Fixed bug where intl parsing would fail when trying to parse integers or blank entries. by sepehr500

11.1.6 - 2018-10-05

Fixed

  • Fix client startup invoking render prematurely, AGAIN. Fix additional cases of client startup failing during interactive readyState". Closes issue #1150. PR 1152 by rakelley.

11.1.5 - 2018-10-03

Fixed

11.1.4 - 2018-09-12

Fixed

11.1.3 - 2018-08-26

Fixed

11.1.2 - 2018-08-18

Fixed

  • Tests now properly exit if the config.build_test_command fails!
  • Source path for project using Webpacker would default to "app/javascript" even if when the node_modules directory was set to "client". Fix now makes the configuration of this crystal clear.
  • renamed method RenderOptions.has_random_dom_id? to RenderOptions.random_dom_id? for rubocop rule. PR 1133 by justin808

11.1.1 - 2018-08-09

Fixed

11.1.0 - 2018-08-07

Added

  • Add random dom id option. This new global and react_component helper option allows configuring whether or not React on Rails will automatically add a random id to the DOM node ID. PR 1121 by justin808
    • Added configuration option random_dom_id
    • Added method RenderOptions has_random_dom_id?

Fixed

11.0.10 - 2018-07-22

Fixed

  • Much better logging of rendering errors when there are lots of props. Only the a 1,000 chars are logged, and the center is indicated to be truncated. PR 1117 and PR 1118 by justin808.
  • Properly clearing hydrated stores when server rendering. PR 1120 by squadette.

11.0.9 - 2018-06-24

11.0.8 - 2018-06-15

Fixed

  • HashWithIndifferent access for props threw if used for props. PR 1100 by justin808.
  • Test helper for detecting stale bundles did not properly handle the case of a server-bundle.js without a hash.PR 1102 by justin808.
  • Fix test helper determination of stale assets. PR 1093 by justin808.

Changed

  • Document how to manually rehydrate XHR-substituted components on client side. PR 1095 by hchevalier.

11.0.7 - 2018-05-16

Fixed

11.0.6 - 2018-05-15

Changed

  • Even more detailed errors for Honeybadger and Sentry when there's a JSON parse error on server rendering. PR 1086 by justin808.

11.0.5 - 2018-05-11

Changed

11.0.4 - 2018-05-3

Changed

  • Throw if configuration.generated_assets_dir specified, and using webpacker, and if that doesn't match the public_output_path. Otherwise, warn if generated_assets_dir is specified
  • Fix the setup for tests for spec/dummy so they automatically rebuild by correctly setting the source_path in the webpacker.yml
  • Updated documentation for the testing setup.
  • Above in PR 1072 by justin808.
  • react_component_hash has implicit prerender: true because it makes no sense to have react_component_hash not use prerrender. Improved docs on react_component_hash. Also, fixed issue where checking gem existence. PR 1077 by justin808.

11.0.3 - 2018-04-24

Fixed

  • Fixed issue with component script initialization when using react_component_hash. PR 1071 by jblasco3.

11.0.2 - 2018-04-24

Fixed

11.0.1 - 2018-04-23

Added

  • react_component allows logging_on_server specified at the component level. PR 1068 by justin808.

Fixed

11.0.0 - 2018-04-21

MIGRATION for v11

  • Unused server_render_method was removed from the configuration. If you want to use a custom renderer, contact [email protected]. We have a custom node rendering solution in production for egghead.io.
  • Removed ReactOnRails::Utils.server_bundle_file_name and ReactOnRails::Utils.bundle_file_name. These are part of the performance features of "React on Rails Pro".
  • Removed ENV["TRACE_REACT_ON_RAILS"] usage and replacing it with config.trace.

Enhancements: Better Error Messages, Support for React on Rails Pro

  • Tracing (debugging) options are simplified with a single config.trace setting that defaults to true for development and false otherwise.
  • Calls to setTimeout, setInterval, clearTimeout will now always log some message if config.trace is true. Your JavaScript code should not be calling setTimout when server rendering.
  • Errors raised are of type ReactOnRailsError, so you can see they came from React on Rails for debugging.
  • Removed ReactOnRails::Utils.server_bundle_file_name and ReactOnRails::Utils.bundle_file_name.
  • No longer logging the railsContext when server logging.
  • Rails.env is provided in the default railsContext, as suggested in issue #697. PR 1065 by justin808.

Fixes

  • More exact version checking. We keep the react_on_rails gem and the react-on-rails node package at the same exact versions so that we can be sure that the interaction between them is precise. This is so that if a bug is detected after some update, it's critical that both the gem and the node package get the updates. This change ensures that the package.json specification does not use a ~ or ^ as reported in issue #1062. PR 1063 by justin808.
  • Sprockets: Now use the most recent manifest when creating symlinks. See issue #1023. PR 1064 by justin808.

10.1.4 - 2018-04-11

Fixed

  • Changed i18n parsing to convert ruby i18n argument syntax into FormatJS argument syntax. PR 1046 by sepehr500.

  • Fixed an issue where the spec compiler check would fail if the project path contained spaces. PR 1045 by andrewmarkle.

  • Updated the default build_production_command that caused production assets to be built with development settings. PR 1053 by Roman Kushnir.

10.1.3 - 2018-02-28

Fixed

  • Improved error reporting on version mismatches between Javascript and Ruby packages. PR 1025 by theJoeBiz.

10.1.2 - 2018-02-27

Fixed

  • Use ReactDOM.hydrate() for hydrating a SSR component if available. ReactDOM.render() has been deprecated for use on SSR components in React 16 and this addresses the warning. PR 1028 by theJoeBiz.

10.1.1 - 2018-01-26

Fixed

10.1.0 - 2018-01-23

Added

  • Added 2 cache helpers: ReactOnRails::Utils.bundle_file_name(bundle_name) and ReactOnRails::Utils.server_bundle_file_name for easy access to the hashed filenames for use in cache keys. PR 1018 by justin808.

Fixed

  • Use redux component in generated redux Hello World example: PR 1006 by lewaabahmad.
  • Fixed Utils.bundle_js_file_path generating the incorrect path for manifest.json in webpacker projects: Issue #1011 by elstgav

10.0.2 - 2017-11-10

Fixed

  • Remove unnecessary dependencies from released NPM package: PR 968 by tricknotes.

10.0.1 - 2017-10-28

Fixed

  • Fixed react_component_hash functionality in cases of prerendering errors: PR 960 by Judahmeek.
  • Fix to add missing dependency to run generator spec individually: PR 962 by tricknotes.
  • Fixes check for i18n_dir in LocalesToJs returning false when i18n_dir was set. PR 899 by hakongit.
  • Fixed mistake in rubocop comments that led to errors when handling exceptions in ReactOnRails::ServerRendering::Exec PR 963 by railsme.
  • Fixed and improved I18n directories checks: PR 967 by railsme

10.0.0 - 2017-10-08

Created

  • Created react_component_hash method for react_helmet support.

Deprecated

  • Deprecated react_component functionality for react_helmet support. To clarify, the method itself is not deprecated, only certain functionality which has been moved to react_component_hash PR 951 by Judahmeek.

9.0.3 - 2017-09-20

Improved

9.0.2 - 2017-09-10

Fixed

9.0.1 - 2017-09-10

Fixed

9.0.0 - 2017-09-06

Updated React on Rails to depend on rails/webpacker. PR 908 by justin808.

9.0 from 8.x. Upgrade Instructions

Moved to our documentation.

8.0.7 - 2017-08-16

Fixed

  • Fixes generator bug by keeping blank line at top in case existing .gitignore does not end in a newline. #916 by justin808.

8.0.6 - 2017-07-19

Fixed

  • Fixes server rendering when using a CDN. Server rendering would try to fetch a file with the "asset_host". This change updates the webpacker_lite dependency to 2.1.0 which has a new helper pack_path. #901 by justin808. Be sure to update webpacker_lite to 2.1.0.
  • The package.json file created by the generator now creates minified javascript production builds by default. This was done by adding the -p flag to webpack on the build:production script. #895 by serodriguez68
  • Fixes GitUtils.uncommitted_changes? throwing an error when called in an environment without Git, and allows install generator to be run successfully with --ignore-warnings #878 by jasonblalock.

8.0.5 - 2017-07-04

Fixed

  • Corrects devBuild value for webpack production build from webpackConfigLoader. #877 by chenqingspring.
  • Remove contentBase deprecation warning message. #878 by ened .
  • Removes invalid reference to _railsContext in the generated files. #886 by justin808.
  • All tests run against Rails 5.1.2

Note: 8.0.4 skipped.

8.0.3 - 2017-06-19

Fixed

8.0.2 - 2017-06-04

Fixed

  • Any failure in webpack to build test files quits tests.
  • Fixed a Ruby 2.4 potential crash which could cause a crash due to pathname change in Ruby 2.4.
  • CI Improvements:
    • Switched to yarn link and removed relative path install of react-on-rails
    • Removed testing of Turbolinks 2
    • All tests run against Rails 5.1.1
    • Fixed test failures against Ruby 2.4
  • #862 by justin808

8.0.1 - 2017-05-30

Fixed

8.0.0 - 2017-05-29

  • Generators and full support for webpacker_lite
  • No breaking changes to move to 8.0.0 other than the default for this setting changed to nil. If you depended on the default of this setting and are using the asset pipeline (and not webpacker_lite), then add this to your config/initializers/react_on_rails.rb: 
    symlink_non_digested_assets_regex: /\.(png|jpg|jpeg|gif|tiff|woff|ttf|eot|svg|map)/,
  • For an example of migration, see: react-webpack-rails-tutorial PR #395
  • For a simple example of the webpacker_lite setup, run the basic generator.

8.0.0-beta.3 - 2017-05-27

Changed

8.0.0-beta.2 - 2017-05-08

Changed

Removed unnecessary values in default paths.yml files for generators. #834 by justin808.

8.0.0-beta.1 - 2017-05-03

Added

Support for WebpackerLite in the generators. #822 by kaizencodes and justin808.

Changed

Breaking change is that the default value of symlink_non_digested_assets_regex has changed from this old value to nil. This is a breaking change if you didn't have this value set in your config/initializers/react_on_rails.rb file and you need this because you're using webpack's CSS features and you have not switched to webpacker lite.

symlink_non_digested_assets_regex: /\.(png|jpg|jpeg|gif|tiff|woff|ttf|eot|svg|map)/,

7.0.4 - 2017-04-27

  • Return empty json when nil in json_safe_and_pretty #824 by dzirtusss

7.0.3 - 2017-04-27

Same as 7.0.1.

7.0.2 - 2017-04-27

Accidental release of beta gem here

7.0.1 - 2017-04-27

Fixed

  • Fix to handle nil values in json_safe_and_pretty #823 by dzirtusss

7.0.0 - 2017-04-25

Changed

  • Any version differences in gem and node package for React on Rails throw an error #821 by justin808

Fixed

  • Fixes serious performance regression when using String props for rendering. #821 by justin808

6.10.1 - 2017-04-23

Fixed

6.10.0 - 2017-04-13

Added

  • Add an ability to return multiple HTML strings in a Hash as a result of react_component method call. Allows to build <head> contents with React Helmet. #800 by udovenko.

Fixed

  • Fix PropTypes, createClass deprecation warnings for React 15.5.x. #804 by udovenko .

6.9.3 - 2017-04-03

Fixed

  • Removed call of to_json on strings when formatting props. #791 by justin808.

6.9.2 - 2017-04-02

Changed

  • Update version_checker.rb to logger.error rather than logger.warn for gem/npm version mismatch. #788 by justin808.

Fixed

  • Remove pretty formatting of JSON in development. #789 by justin808
  • Clear hydrated stores with each server rendered block. #785 by udovenko

6.9.1 - 2017-03-30

Fixed

  • Fixes Crash in Development for String Props. #784 by justin808.

6.9.0 - 2017-03-29

Fixed

  • Fixed error in the release script. #767 by isolo.

Changed

  • Use <script type="application/json"> for props and store instead of hidden div. [#775] (#775) by cheremukhin23.

Added

  • Add option to specify i18n_yml_dir in order to include only subset of locale files when generating translations.js & default.js for react-intl. #777 by danijel.

6.8.2 - 2017-03-24

Fixed

  • Change webpack output path to absolute and update webpack to version ^2.3.1. #771 by cheremukhin23.

6.8.1 - 2017-03-21

Fixed

  • Fixed error "The node you're attempting to unmount was rendered by another copy of React." #706 when navigating to cached page using Turbolinks #763 by szyablitsky.

6.8.0 - 2017-03-06

Added

  • Converted to Webpack v2 for generators, tests, and all example code. #742 by justin808.

6.7.2 - 2017-03-05

Improved

  • Improve i18n Integration with a better error message if the value of the i18n directory is invalid. #748 by justin808.

6.7.1 - 2017-02-28

No changes other than a test fix.

6.7.0 - 2017-02-28

IMPORTANT

  • If you installed 6.6.0, you will need to comment out the line matching i18n_dir unless you are using this feature. 6.7.1 will give you an error like:
Errno::ENOENT: No such file or directory @ rb_sysopen - /tmp/build_1444a5bb9dd16ddb2561c7aff40f0fc7/my-app-816d31e9896edd90cecf1402acd002c724269333/client/app/libs/i18n/translations.js

Commenting out this line addresses the issue:

config.i18n_dir = Rails.root.join("client", "app", "libs", "i18n")

Added

  • Allow using rake task to generate javascript locale files. The test helper automatically creates the localization files when needed. #717 by JasonYCHuang.

Fixed

6.6.0 - 2017-02-18

Added

6.5.1 - 2017-02-11

Fixed

6.5.0 - 2017-01-31

Added

  • Allow generator function to return Object with property renderedHtml (already could return Object with props redirectLocation, error) rather than a React component or a function that returns a React component. One reason to use a generator function is that sometimes in server rendering, specifically with React Router v4, you need to return the result of calling ReactDOMServer.renderToString(element). #689 by justin808.

Fixed

6.4.2 - 2017-01-17

Fixed

  • Added OS detection for install generator, system call for Windows and unit-tests for it. #666 by GeorgeGorbanev.

6.4.1 - 2017-1-17

No changes.

6.4.0 - 2017-1-12

Possible Breaking Change

  • Since foreman is no longer a dependency of the React on Rails gem, please run gem install foreman. If you are using rvm, you may wish to run rvm @global do gem install foreman to install foreman for all your gemsets.

Fixed

  • Removed foreman as a dependency. #678 by x2es.

Added

  • Automatically generate i18n javascript files for react-intl when the serve starts up. #642 by JasonYCHuang.

6.3.5 - 2017-1-6

Fixed

  • The redux generator now creates a HelloWorld component that uses redux rather than local state. #669 by justin808.

6.3.4 - 2016-12-25

Fixed
  • Disable Turbolinks support when not supported. #650 by ka2n.

6.3.3 - 2016-12-25

Fixed
  • By using the hook on turbolinks:before-visit to unmount the components, we can ensure that components are unmounted even when Turbolinks cache is disabled. Previously, we used turbolinks:before-cache event hook. #644 by volkanunsal.
  • Added support for Ruby 2.0 #651 by bbonamin.

6.3.2 - 2016-12-5

Fixed
  • The react_component method was raising a NameError when ReactOnRailsHelper was included in a plain object. #636 by jtibbertsma.
  • "Node parse error" for node server rendering. #641 by alleycat-at-git and rocLv
  • Better error handling when the react-on-rails node package entry is missing.#602 by benjiwheeler.

6.3.1 - 2016-11-30

Changed
  • Improved generator post-install help messages. #631 by justin808.

6.3.0 - 2016-11-30

Changed

  • Modified register API to allow registration of renderers, allowing a user to manually render their app to the DOM. This allows for code splitting and deferred loading. #581 by jtibbertsma.

  • Updated Basic Generator & Linters. Examples are simpler. #624 by Judahmeek.

  • Slight improvement to the 'no hydrated stores' error. #605 by cookiefission.

  • Don't assume ActionMailer is available. #608 by tuzz.

6.2.1 - 2016-11-19

  • Removed unnecessary passing of context in the HelloWorld Container example and basic generator. #612 by justin808

  • Turbolinks 5 bugfix to use before-cache, not before-render. #611 by volkanunsal.

6.2.0 - 2016-11-19

Changed
  • Updated the generator templates to reflect current best practices, especially for the redux version. #584 by nostophilia.

6.1.2 - 2016-10-24

Fixed
  • Added compatibility with older manifest.yml files produced by Rails 3 Sprockets when symlinking digested assets during precompilation #566 by etripier.

6.1.1 - 2016-09-09

Fixed
  • React on Rails was incorrectly failing to create symlinks when a file existed in the location for the new symlink. #491 by robwise and justin808.

6.1.0 - 2016-08-21

Added
  • Node option for installer added as alternative for server rendering #469 by jbhatab.
  • Server rendering now supports contexts outside of browser rendering, such as ActionMailer templates #486 by eacaps.
  • Added authenticityToken() and authenticityHeaders() javascript helpers for easier use when working with CSRF protection tag generated by Rails #517 by dzirtusss.
  • Updated JavaScript error handling on the client side. Errors in client rendering now pass through to the browser #521 by dzirtusss.
Fixed
  • React on Rails now correctly parses single-digit version strings from package.json #491 by samphilipd .
  • Fixed assets symlinking to correctly use filenames with spaces. Beginning in #510, ending in #513 by dzirtusss.
  • Check encoding of request's original URL and force it to UTF-8 #527 by lucke84

6.0.5 - 2016-07-11

Added
  • Added better error messages to avoid issues with shared redux stores #470 by justin808.

6.0.4 - 2016-06-13

Fixed
  • Added polyfill for clearTimeout which is used by babel-polyfill #451 by martyphee

6.0.3 - 2016-06-07

Fixed

6.0.2 - 2016-06-06

Fixed
  • Fix collisions in ids of DOM nodes generated by react_component by indexing in using a UUID rather than an auto-increment value. This means that it should be overridden using the id parameter of react_component if one wants to generate a predictable id (e.g. for testing purpose). See Issue #437. Fixed in #438 by Michael Baudino.

6.0.1 - 2016-05-27

Fixed

6.0.0 - 2016-05-25

Breaking Changes

  • Added automatic compilation of assets at precompile is now done by ReactOnRails. Thus, you don't need to provide your own assets.rake file that does the precompilation. #398 by robwise, jbhatab, and justin808.

  • Migration to v6

    • Do not run the generator again if you've already run it.

    • See shakacode/react-webpack-rails-tutorial/pull/287 for an example of upgrading from v5.

    • To configure the asset compilation you can either

      1. Specify a config/react_on_rails setting for build_production_command to be nil to turn this feature off.
      2. Specify the script command you want to run to build your production assets, and remove your assets.rake file.

    • If you are using the ReactOnRails test helper, then you will need to add the 'config.npm_build_test_command' to your config to tell react_on_rails what command to run when you run rspec.

  • See shakacode/react-webpack-rails-tutorial #287 for an upgrade example. The PR has a few comments on the upgrade.

Here is the addition to the generated config file:

  # This configures the script to run to build the production assets by webpack. Set this to nil
  # if you don't want react_on_rails building this file for you.
  config.build_production_command = "npm run build:production"

  # If you are using the ReactOnRails::TestHelper.configure_rspec_to_compile_assets(config)
  # with rspec then this controls what npm command is run
  # to automatically refresh your webpack assets on every test run.
  config.npm_build_test_command = "npm run build:test"
Fixed
  • Fixed errors when server rendered props contain \u2028 or \u2029 characters #375 by mariusandra
  • Fixed "too early unmount" which caused problems with Turbolinks 5 not updating the screen #425 by szyablitsky
Added
  • Experimental ability to use node.js process for server rendering. See #380 by alleycat-at-git.
  • Non-digested version of assets in public folder #413 by alleycat-at-git.
  • Cache client/node_modules directory to prevent Heroku from reinstalling all modules from scratch #324 by modosc.
  • ReactOnRails.reactOnRailsPageLoaded() is exposed in case one needs to call this manually and information on async script loading added. See #315 by SqueezedLight.
Changed
  • #398 by robwise, jbhatab, and justin808 contains:
    • Only one webpack config is generated for server and client config. Package.json files were changed to reflect this.
    • Added npm_build_test_command to allow developers to change what npm command is automatically run from rspec.
  • Replace URI with Addressable gem. See #405 by lucke84
Removed
  • #398 by robwise, jbhatab, and justin808 contains:
    • Server rendering is no longer an option in the generator and is always accessible.
    • Removed lodash, jquery, and loggerMiddleware from the generated code.
    • Removed webpack watch check for test helper automatic compilation.

5.2.0 - 2016-04-08

Added
  • Support for React 15.0 to react_on_rails. See #379 by brucek.
  • Support for Node.js server side rendering. See #380 by alleycat and doc
Removed
  • Generator removals to simplify installer. See #364 by jbhatab.
    • Removed options for heroku, boostrap, and the linters from generator.
    • Removed install for the Webpack Dev Server, as we can now do hot reloading with Rails, so the complexity of this feature is not justified. Nevertheless, the setup of React on Rails still supports this setup, just not with the generator.
    • Documentation added for removed installer options.

5.1.1 - 2016-04-04

Fixed
  • Security Fixes: Address failure to sanitize console messages when server rendering and displaying in the browser console. See #366 and #370 by justin808
Added
  • railsContext includes the port number and a boolean if the code is being run on the server or client.

5.1.0 - 2016-04-03

Added

All 5.1.0 changes can be found in #362 by justin808.

  • Generator enhancements
    • Generator adds line to spec/rails_helper.rb so that running specs will ensure assets are compiled.
    • Other small changes to the generator including adding necessary npm scripts to allow React on Rails to build assets.
    • Npm modules updated for generator.
    • Added babel-runtime in to the client/package.json created.
  • Server rendering
    • Added more diagnostics for server rendering.
    • Calls to setTimeout and setInterval are not logged for server rendering unless env TRACE_REACT_ON_RAILS is set to YES.
  • Updated all project npm dependencies to latest.
  • Update to node 5.10.0 for CI.
  • Added babel-runtime as a peer dependency for the npm module.

5.0.0 - 2016-04-01

Added
  • Added railsContext, an object which gets passed always as the second parameter to both react component and redux store generator functions, both for server and client rendering. This provides data like the current locale, the pathname, etc. The data values are customizable by a new configuration called rendering_extension where you can create a module with a method called rendering_extension. This allows you to add additional values to the Rails Context. Implement one static method called custom_context(view_context) and return a Hash. See #345 by justin808
Changed
  • Previously, you could pass arbitrary additional html attributes to react_component. Now, you need to pass them in as a named parameter html_options to react_component.
Breaking Changes
  • You must provide named attributes, including props for view helper react_component. See this commit for an example migration used for www.reactrails.com.

4.0.3 - 2016-03-17

Fixed
  • ReactOnRailsHelper#react_component: Invalid deprecation message when called with only one parameter, the component name.

4.0.2 - 2016-03-17

Fixed
  • ReactOnRails::Controller#redux_store: 2nd parameter changed to a named parameter props for consistency.

4.0.1 - 2016-03-16

Fixed
  • Switched to heroku buildpacks:set syntax rather than using a .buildpacks file, which is deprecated. See #319 by esauter5. Includes both generator and doc updates.

4.0.0 - 2016-03-14

Added
  • spec/dummy is a full sample app of React on Rails techniques including the hot reloading of assets from Rails!
  • Added helpers env_stylesheet_link_tag and env_javascript_include_tag to support hot reloading Rails. See the README.md for more details and see the example application in spec/dummy. Also see how this is used in the tutorial: application.html.erb
  • Added optional parameter for ReactOnRails.getStore(name, throwIfMissing = true) so that you can check if a store is defined easily.
  • Added controller module ReactOnRails::Controller. Adds method redux_store to setup redux stores in the view.
  • Added option defer: true for view helper redux_store. This allows the view helper to specify the props for store hydration, yet still render the props at the bottom of the view.
  • Added view helper redux_store_hydration_data to render the props on the application's layout, near the bottom. This allows for the client hydration data to be parsed after the server rendering, which may result in a faster load time.
  • The checker for outdated bundles before running tests will two configuration options: generated_assets_dir and webpack_generated_files.
  • Better support for Turbolinks 5!
  • Fixed generator check of uncommitted code for foreign languages. See #303 by nmatyukov.
  • Added several parameters used for ensuring webpack assets are built for running tests:
    • config.generated_assets_dir: Directory where your generated webpack assets go. You can have only one directory for this.
    • config.webpack_generated_files: List of files that will get created in the generated_assets_dir. The test runner helper will ensure these generated files are newer than any of the files in the client directory.
Changed
  • Generator default for webpack generated assets is now app/assets/webpack as we use this for both JavaScript and CSS generated assets.
Fixed
  • The test runner "assets up to date checker" is greatly improved.
  • Lots of doc updates!
  • Improved the spec/dummy sample app so that it supports CSS modules, hot reloading, etc, and it can server as a template for a new ReactOnRails installation.
Breaking Changes
  • Deprecated calling redux_store(store_name, props). The API has changed. Use redux_store(store_name, props: props, defer: false) A new option called defer allows the rendering of store hydration at the bottom of the your layout. Place redux_store_hydration_data on your layout.
  • config.server_bundle_js_file has changed. The default value is now blank, meaning no server rendering. Addtionally, if you specify the file name, you should not include the path, as that should be specified in the config.generated_assets_dir.
  • config.generated_assets_dirs has been renamed to config.generated_assets_dir (singular) and it only takes one directory.

3.0.6 - 2016-03-01

Fixed
  • Improved errors when registered store is not found. See #301 by justin808.

3.0.5 - 2016-02-26

Fixed
  • Fixed error in linters rake file for generator. See #299 by mpugach.

3.0.4 - 2016-02-25

Fixed
  • Updated CHANGELOG.md to include contributors for each PR.
  • Fixed config.server_bundle_js file value in generator to match generator setting of server rendering. See #295 by aaronvb.

3.0.3 - 2016-02-21

Fixed
  • Cleaned up code in spec/dummy to latest React and Redux APIs. See #282.
  • Update generator messages with helpful information. See #279.
  • Other small generated comment fixes and doc fixes.

3.0.2 - 2016-02-15

Fixed
  • Fixed missing information in the helpful message after running the base install generator regarding how to run the node server with hot reloading support.

3.0.1 - 2016-02-15

Fixed
  • Fixed several jscs linter issues.

3.0.0 - 2016-02-15

Fixed
  • Fix Bootstrap Sass Append to Gemfile, missing new line. #262.
Added
  • Added helper redux_store and associated JavaScript APIs that allow multiple React components to use the same store. Thus, you initialize the store, with props, separately from the components.
  • Added forman to gemspec in case new dev does not have it globally installed. #248.
  • Support for Turbolinks 5! #270.
  • Added better error messages for ReactOnRails.register(). #273.
Breaking Change

  • Calls to react_component should use a named argument of props. For example, change this:

    <%= react_component("ReduxSharedStoreApp", {}, prerender: false, trace: true) %>

    to

    <%= react_component("ReduxSharedStoreApp", props: {}, prerender: false, trace: true) %>

    You'll get a deprecation message to change this.

  • Renamed ReactOnRails.configure_rspec_to_compile_assets to ReactOnRails::TestHelper.configure_rspec_to_compile_assets. The code has also been optimized to check for whether or not the compiled webpack bundles are up to date or not and will not run if not necessary. If you are using non-standard directories for your generated webpack assets (app/assets/javascripts/generated and app/assets/stylesheets/generated) or have additional directories you wish the helper to check, you need to update your ReactOnRails configuration accordingly. See documentation for how to do this. #253.

  • You have to call ReactOnRails.register to register react components. This was deprecated in v2. #273.

Migration Steps v2 to v3
RSpec.configure do |config|
  # Ensure that if we are running js tests, we are using latest webpack assets
  ReactOnRails::TestHelper.configure_rspec_to_compile_assets(config)

2.3.0 - 2016-02-01

Added
  • Added polyfills for setInterval and setTimeout in case other libraries expect these to exist.
  • Added much improved debugging for errors in the server JavaScript webpack file.
  • See #244 for these improvements.

2.2.0 - 2016-01-29

Added
  • New JavaScript API for debugging TurboLinks issues. Be sure to see turbolinks docs. ReactOnRails.setOptions({ traceTurbolinks: true });. Removed the file debug_turbolinks added in 2.1.1. See #243.

2.1.1 - 2016-01-28

Fixed
  • Fixed regression where apps that were not using Turbolinks would not render components on page load.
Added
  • ReactOnRails.render returns a virtualDomElement Reference to your React component's backing instance. See #234.
  • debug_turbolinks helper for debugging turbolinks issues. See turbolinks.
  • Enhanced regression testing for non-turbolinks apps. Runs all tests for dummy app with turbolinks both disabled and enabled.

2.1.0 - 2016-01-26

Added
  • Added EnsureAssetsCompiled feature so that you do not accidentally run tests without properly compiling the JavaScript bundles. Add a line to your rails_helper.rb file to check that the latest Webpack bundles have been generated prior to running tests that may depend on your client-side code. See docs for more detailed instructions. #222
  • Added migration guide for migrating from React-Rails. #219
  • Added React on Rails Doctrine to docs. Discusses the project's motivations, conventions, and principles. #220
  • Added ability to skip display:none style in the generated content tag for a component. Some developers may want to disable inline styles for security reasons. See generated config initializer file for example on setting skip_display_none. #218
Changed
  • Changed message when running the dev (a.k.a. "express" server). #227
Fixed
  • Fixed handling of Turbolinks. Code was checking that Turbolinks was installed when it was not yet because some setups load Turbolinks after the bundles. The changes to the code will check if Turbolinks is installed after the page loaded event fires. Code was also added to allow easy debugging of Turbolinks, which should be useful when v5 of Turbolinks is released shortly. Details of how to configure Turbolinks with troubleshooting were added to docs directory. #221
  • Fixed issue with already initialized constant warning appearing when starting a Rails server #226
  • Fixed to make backwards compatible with Ruby v2.0 and updated all Ruby and Node dependencies.

2.0.2

  • Added better messages after generator runs. #210

2.0.1

  • Fixed bug with version matching between gem and npm package.

2.0.0

  • Move JavaScript part of react_on_rails to npm package 'react-on-rails'.
  • Converted JavaScript code to ES6! with tests!
  • No global namespace pollution. ReactOnRails is the only global added.
  • New API. Instead of placing React components on the global namespace, you instead call ReactOnRails.register, passing an object where keys are the names of your components:
import ReactOnRails from 'react-on-rails';
ReactOnRails.register({name: component});

Best done with Object destructing:

  import ReactOnRails from 'react-on-rails';
  ReactOnRails.register(
    {
      Component1,
      Component2
    }
  );

Previously, you used

window.Component1 = Component1;
window.Component2 = Component2;

This would pollute the global namespace. See details in the README.md for more information.

  • Your jade template for the WebpackDevServer setup should use the new API:
  ReactOnRails.render(componentName, props, domNodeId);

such as:

  ReactOnRails.render("HelloWorldApp", {name: "Stranger"}, 'app');
Migration Steps v1 to v2

Example of upgrading

  1. Update the react_on_rails gem.
  2. Remove //= require react_on_rails from any files such as app/assets/javascripts/application.js. This file comes from npm now.
  3. Search you app for 'generator_function' and remove lines in layouts and rb files that contain it. Determination of a generator function is handled automatically.
  4. Find your files where you registered client and server globals, and use the new ReactOnRails.register syntax. Optionally rename the files clientRegistration.jsx and serverRegistration.jsx rather than Globals.
  5. Update your index.jade to use the new API ReactOnRails.render("MyApp", !{props}, 'app');
  6. Update your webpack files per the example commit. Remove globally exposing React and ReactDom, as well as their inclusion in the entry section. These are automatically included now.
  7. Run cd client && npm i --save react-on-rails to get react-on-rails into your client/package.json.
  8. You should also update any other dependencies if possible to match up with the react-webpack-rails-tutorial. This includes updating to Babel 6.
  9. If you want to stick with Babel 5 for a bit, see Issue #238.

1.2.2

Fixed
  • Missing Lodash from generated package.json #175
  • Rails 3.2 could not run generators #182
  • Better placement of jquery_ujs dependency #171
  • Add more detailed description when adding --help option to generator #161
  • Lots of better docs.

1.2.0

Added
  • Support --skip-bootstrap or -b option for generator.
  • Create examples tasks to test generated example apps.
Fixed
  • Fix non-server rendering configuration issues.
  • Fix application.js incorrect overwritten issue.
  • Fix Gemfile dependencies.
  • Fix several generator issues.
Removed
  • Removed templates/client folder.

1.1.1 - 2015-11-28

Added
  • Support for React Router.
  • Error and redirect handling.
  • Turbolinks support.
Fixed
  • Fix several generator-related issues.