shakapacker 6.3.0.pre.rc.1 → 6.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 862dd1243830eb271661d0a7be8ad35b4837ab8aaabfa2a39cc9a65e5c6d01f3
-  data.tar.gz: a9b58deb1b8038aecbac2df1ca3516d59c03dfd2cc5a6a71e06edf480ba3443c
+  metadata.gz: ceac7ca1c43918c99f5c5f50eec4f34fc591ef9de90bac0f2a35c7d0e7c4cc69
+  data.tar.gz: 4f571c49df398b3ff2dfd3faf476908c4492b361a9ebaf64d4c91e4c6074df5e
 SHA512:
-  metadata.gz: c03da71f446adc4f470acdca8de67487ff7934650abca9278a4e26c854329432d6a94b02368f5825cca0214f1fb878399711114b67c5f8e1dbb9d27620cf22b9
-  data.tar.gz: 900fdb88440208f4860c7255b5ca71ba316d6ba69223f720a67b4564663f633eb11e31403b41247c94e5755488804dd9f6745b9ddbfb6c82c5f928ec360abdd5
+  metadata.gz: 4bcccce7cc22a42f20ac8738904a97d8288abb862a5d0c98e487393450d60a6a703559aa1b3add2f70f5211643fb02769ca16ef118cee5870f7de580a07cfcbb
+  data.tar.gz: 6f27881ee63c1cc94c416c9d59e8354a3425707e055b035bb89d1da86905c2ae876e3d329da59f9015f29f3219f716f042dccabaf563a01cf327a0d8be89b41e

data/CHANGELOG.md

@@ -8,7 +8,17 @@ Changes since last non-beta release.
 
 *Please add entries here for your pull requests that are not yet released.*
 
-## [v6.3.0-rc.1] - April 24, 2024
+## [v6.3.0] - May 19, 2022
+
+### Improved
+- Add ability to configure usage of either last modified timestamp and digest strategies when checking asset freshness. [PR 112](https://github.com/shakacode/shakapacker/pull/112) by [tomdracz](https://github.com/tomdracz). 
+
+### Fixed
+- On Windows CSS urls no longer contain backslashes resulting in 404 errors. [PR 115](https://github.com/shakacode/shakapacker/pull/115) by [daniel-rikowski](https://github.com/daniel-rikowski).
+
+## [v6.3.0-rc.1] - April 24, 2022
+
+Note: [Rubygem is 6.3.0.pre.rc.1](https://rubygems.org/gems/shakapacker/versions/6.3.0.pre.rc.1) and [NPM is 6.3.0-rc.1](https://www.npmjs.com/package/shakapacker/v/6.3.0-rc.1).
 
 ### Changed
 - Remove Loose mode from the default @babel-preset/env configuration. [PR 107](https://github.com/shakacode/shakapacker/pull/107) by [Jeremy Liberman](https://github.com/MrLeebo).
@@ -115,8 +125,9 @@ Changes since last non-beta release.
 ## v5.4.3 and prior changes from rails/webpacker
 See [CHANGELOG.md in rails/webpacker (up to v5.4.3)](https://github.com/rails/webpacker/blob/master/CHANGELOG.md) 
 
-[Unreleased]: https://github.com/shakacode/shakapacker/compare/v6.3.0-rc.1...master
-[v6.3.0-rc.0]: https://github.com/shakacode/shakapacker/compare/v6.2.1...v6.3.0-rc.1
+[Unreleased]: https://github.com/shakacode/shakapacker/compare/v6.3.0...master
+[v6.3.0]: https://github.com/shakacode/shakapacker/compare/v6.3.0-rc.1...v6.3.0
+[v6.3.0-rc.1]: https://github.com/shakacode/shakapacker/compare/v6.2.1...v6.3.0-rc.1
 [v6.2.1]: https://github.com/shakacode/shakapacker/compare/v6.2.0...v6.2.1
 [v6.2.0]: https://github.com/shakacode/shakapacker/compare/v6.1.1...v6.2.0
 [v6.1.1]: https://github.com/shakacode/shakapacker/compare/v6.1.0...v6.1.1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    shakapacker (6.2.1)
+    shakapacker (6.3.0.pre.rc.1)
       activesupport (>= 5.2)
       rack-proxy (>= 0.6.1)
       railties (>= 5.2)

data/README.md

@@ -62,6 +62,7 @@ Discussion forum and Slack to discuss debugging and troubleshooting tips. Please
     - [Other frameworks](#other-frameworks)
   - [Custom Rails environments](#custom-rails-environments)
   - [Upgrading](#upgrading)
+  - [Compiler strategies](#compiler-strategies)
   - [Paths](#paths)
   - [Additional paths](#additional-paths)
 - [Deployment](#deployment)
@@ -431,7 +432,9 @@ Webpacker out of the box supports JS and static assets (fonts, images etc.) comp
 
 #### React
 
-See customization example the [Customizing Babel Config](./docs/customizing_babel_config.md) for React configuration.
+See here for detailed instructions on how to [configure Shakapacker to bundle a React app](./docs/react.md) (with optional HMR).
+
+See also [Customizing Babel Config](./docs/customizing_babel_config.md) for an example React configuration.
 
 #### Typescript
 ...if you are using typescript, update your `tsconfig.json`
@@ -671,6 +674,17 @@ yarn add shakapacker@next
 
 Also, consult the [CHANGELOG](./CHANGELOG.md) for additional upgrade links.
 
+### Compiler strategies
+
+Shakapacker ships with two different strategies that are used to determine whether assets need recompilation.
+
+- `digest` - This strategy calculates SHA1 digest of files in your watched paths (see below). The calculated digest is then stored in a temp file. To check whether the assets need to be recompiled, Shakapacker calculates the SHA1 of the watched files and compares it with the one stored. If the digests are equal, no recompilation occurs. If the digests are different or the temp file is missing, files are recompiled.
+- `mtime` - This strategy looks at last modified at timestamps of both files AND directories in your watched paths. The timestamp of the most recent file or directory is then compared with the timestamp of `manifest.json` file generated. If the manifest file timestamp is newer than one of the most recently modified file or directory in the watched paths, no recompilation occurs. If the manifest file is order, files are recompiled.
+
+`mtime` strategy is generally faster than the `digest` one, but it requires stable timestamps, this makes it perfect for development environment. In production or CI environments, the `digest` strategy is more suitable, unless you are using incremental builds or caching and can guarantee that the timestamps will not change after e.g. cache restore.
+
+You can control what strategy is used by `compiler_strategy` option in `webpacker.yml` config file. By default `mtime` strategy is used in development environment, `digest` is used elsewhere.
+
 ### Paths
 
 By default, Webpacker ships with simple conventions for where the JavaScript app files and compiled webpack bundles will go in your Rails app. All these options are configurable from `config/webpacker.yml` file.
@@ -718,7 +732,7 @@ import 'images/rails.png'
 
 **Note:** Please be careful when adding paths here otherwise it will make the compilation slow, consider adding specific paths instead of whole parent directory if you just need to reference one or two modules
 
-**Also note:** While importing assets living outside your `source_path` defined in webpacker.yml (like, for instance, assets under `app/assets`) from within your packs using _relative_ paths like `import '../../assets/javascripts/file.js'` will work in development, Webpacker won't recompile the bundle in production unless a file that lives in one of it's watched paths has changed (check out `Webpacker::Compiler#latest_modified_timestamp`). That's why you'd need to add `app/assets` to the additional_paths as stated above and use `import 'javascripts/file.js'` instead.
+**Also note:** While importing assets living outside your `source_path` defined in webpacker.yml (like, for instance, assets under `app/assets`) from within your packs using _relative_ paths like `import '../../assets/javascripts/file.js'` will work in development, Webpacker won't recompile the bundle in production unless a file that lives in one of it's watched paths has changed (check out `Webpacker::MtimeStrategy#latest_modified_timestamp` or `Webpacker::DigestStrategy#watched_files_digest` depending on strategy configured by `compiler_strategy` option in `webpacker.yml`). That's why you'd need to add `app/assets` to the additional_paths as stated above and use `import 'javascripts/file.js'` instead.
 
 
 ## Deployment

data/docs/react.md

@@ -0,0 +1,262 @@
+# React Integration
+
+These steps describe how to create a Rails/React app, using Shakapacker as the bundler.
+
+Before starting, ensure that you have Yarn installed, for example:
+
+```shell
+npm i -g yarn
+```
+
+## Basic Setup
+
+Create a new Rails app as per the [installation instructions in the README](https://github.com/shakacode/shakapacker#installation).
+
+Add React, as well as the necessary libraries to enable CSS support in your application:
+
+```shell
+yarn add react react-dom @babel/preset-react
+yarn add css-loader style-loader mini-css-extract-plugin css-minimizer-webpack-plugin
+```
+
+Update the Babel configuration in the `package.json` file:
+
+```diff
+"babel": {
+  "presets": [
+    "./node_modules/shakapacker/package/babel/preset.js",
++   "@babel/preset-react"
+  ]
+},
+```
+
+And that's it. You can now create a React app using `app/javascript/application.js` as your entry point.
+
+## Enabling Hot Module Replacement (HMR)
+
+With HMR enabled, Shakapacker will automatically update only that part of the page that changed when it detects changes in your project files. This has the nice advantage of preserving your app’s state.
+
+To enable HMR in a React app, proceed as follows:.
+
+In `config/webpacker.yml` set `hmr` is set to `true`.
+
+Install the [react-refresh](https://www.npmjs.com/package/react-refresh) package, as well as [@pmmmwh/react-refresh-webpack-plugin](https://www.npmjs.com/package/@pmmmwh/react-refresh-webpack-plugin):
+
+```shell
+yarn add --dev react-refresh @pmmmwh/react-refresh-webpack-plugin
+```
+
+Alter `config/webpack/webpack.config.js` like so:
+
+```js
+const { webpackConfig, inliningCss } = require('shakapacker');
+const ReactRefreshWebpackPlugin = require('@pmmmwh/react-refresh-webpack-plugin');
+const isDevelopment = process.env.NODE_ENV !== 'production';
+
+if (isDevelopment && inliningCss) {
+  webpackConfig.plugins.push(
+    new ReactRefreshWebpackPlugin({
+      overlay: {
+        sockPort: webpackConfig.devServer.port,
+      },
+    })
+  );
+}
+
+module.exports = webpackConfig;
+```
+
+This applies the plugin to the webpack configuration.
+
+Delete the Babel configuration from `package.json`:
+
+```diff
+- "babel": {
+-   "presets": [
+-     "./node_modules/shakapacker/package/babel/preset.js",
+-     "@babel/preset-react"
+-   ]
+- },
+```
+
+Then create a `babel.config.js` file in the root of project and add the following:
+
+```js
+module.exports = function (api) {
+  const defaultConfigFunc = require('shakapacker/package/babel/preset.js')
+  const resultConfig = defaultConfigFunc(api)
+  const isDevelopmentEnv = api.env('development')
+  const isProductionEnv = api.env('production')
+  const isTestEnv = api.env('test')
+
+  const changesOnDefault = {
+    presets: [
+      [
+        '@babel/preset-react',
+        {
+          development: isDevelopmentEnv || isTestEnv,
+          useBuiltIns: true
+        }
+      ]
+    ].filter(Boolean),
+    plugins: [
+      isProductionEnv && ['babel-plugin-transform-react-remove-prop-types',
+        {
+          removeImport: true
+        }
+      ],
+      process.env.WEBPACK_SERVE && 'react-refresh/babel'
+    ].filter(Boolean),
+  }
+
+  resultConfig.presets = [...resultConfig.presets, ...changesOnDefault.presets]
+  resultConfig.plugins = [...resultConfig.plugins, ...changesOnDefault.plugins ]
+
+  return resultConfig
+}
+```
+
+This is taken from the [sample React Babel config](https://github.com/jameshibbard/shakapacker/blob/master/docs/customizing_babel_config.md#react-configuration).
+
+HMR for your React app is now enabled. 🚀
+
+## A Basic Demo App
+
+To test that all of the above is working, you can follow these instructions to create a basic React app using Shakapacker.
+
+1. Create a new Rails app:
+```shell
+rails new myapp --skip-javascript
+cd myapp
+bundle add shakapacker --strict
+./bin/bundle install
+./bin/rails webpacker:install
+yarn add react react-dom @babel/preset-react
+yarn add css-loader style-loader mini-css-extract-plugin css-minimizer-webpack-plugin
+```
+
+2. Generate a controller
+```shell
+rails g controller site index
+echo '<div id="root"></div>' > app/views/site/index.html.erb
+```
+
+3. Create a CSS file and a React component:
+```shell
+touch app/javascript/App.css app/javascript/App.js
+```
+
+4. Edit `app/javascript/application.js` like so:
+```jsx
+import React from 'react';
+import { createRoot } from 'react-dom/client';
+import HelloMessage from './App';
+
+const container = document.getElementById('root');
+const root = createRoot(container);
+
+document.addEventListener('DOMContentLoaded', () => {
+  root.render(<HelloMessage name="World" />);
+});
+```
+
+5. Add the following to `app/javascript/App.js`:
+```jsx
+import React from 'react';
+import 'App.css';
+const HelloMessage = ({ name }) => <h1>Hello, {name}!</h1>;
+export default HelloMessage;
+```
+
+6. Add the following to `app/javascript/App.css`:
+```css
+h1 { color: blue; }
+```
+
+7. Enable HMR in config/webpacker.yml:
+```shell
+hmr: true
+```
+
+8. Install the [react-refresh](https://www.npmjs.com/package/react-refresh) package, as well as [@pmmmwh/react-refresh-webpack-plugin](https://www.npmjs.com/package/@pmmmwh/react-refresh-webpack-plugin):
+
+```shell
+yarn add --dev react-refresh @pmmmwh/react-refresh-webpack-plugin
+```
+
+9. Alter `config/webpack/webpack.config.js` like so:
+
+```js
+const { webpackConfig, inliningCss } = require('shakapacker');
+const ReactRefreshWebpackPlugin = require('@pmmmwh/react-refresh-webpack-plugin');
+const isDevelopment = process.env.NODE_ENV !== 'production';
+
+if (isDevelopment && inliningCss) {
+  webpackConfig.plugins.push(
+    new ReactRefreshWebpackPlugin({
+      overlay: {
+        sockPort: webpackConfig.devServer.port,
+      },
+    })
+  );
+}
+
+module.exports = webpackConfig;
+```
+
+10. Remove the Babel configuration from `package.json`
+```diff
+- "babel": {
+-   "presets": [
+-     "./node_modules/shakapacker/package/babel/preset.js"
+-   ]
+- },
+```
+
+11. Create a `babel.config.js` file in the project root and add the following [sample code](https://github.com/shakacode/shakapacker/blob/master/docs/customizing_babel_config.md#react-configuration):
+```js
+module.exports = function (api) {
+  const defaultConfigFunc = require('shakapacker/package/babel/preset.js')
+  const resultConfig = defaultConfigFunc(api)
+  const isDevelopmentEnv = api.env('development')
+  const isProductionEnv = api.env('production')
+  const isTestEnv = api.env('test')
+
+  const changesOnDefault = {
+    presets: [
+      [
+        '@babel/preset-react',
+        {
+          development: isDevelopmentEnv || isTestEnv,
+          useBuiltIns: true
+        }
+      ]
+    ].filter(Boolean),
+    plugins: [
+      isProductionEnv && ['babel-plugin-transform-react-remove-prop-types',
+        {
+          removeImport: true
+        }
+      ],
+      process.env.WEBPACK_SERVE && 'react-refresh/babel'
+    ].filter(Boolean),
+  }
+
+  resultConfig.presets = [...resultConfig.presets, ...changesOnDefault.presets]
+  resultConfig.plugins = [...resultConfig.plugins, ...changesOnDefault.plugins ]
+
+  return resultConfig
+}
+```
+
+9. Start the Rails server and the webpack-dev-server in separate console windows:
+```shell
+rails s
+./bin/webpacker-dev-server
+```
+
+10. Hit: <http://localhost:3000/site/index>
+
+11. Edit either the React component at `app/javascript/App.js` or the CSS file at `app/javascript/App.css` and observe the HMR goodness.
+
+Note that HMR will not work if you edit `app/javascript/application.js` and you experience a full refresh with a warning in the console. For more info on this, see here: https://github.com/pmmmwh/react-refresh-webpack-plugin/issues/177

data/lib/install/config/webpacker.yml

@@ -26,9 +26,13 @@ default: &default
   # Set to true to enable check for matching versions of shakapacker gem and NPM package - will raise an error if there is a mismatch or wildcard versioning is used
   ensure_consistent_versioning: false
 
+  # Select whether the compiler will use SHA digest ('digest' option) or most most recent modified timestamp ('mtime') to determine freshness
+  compiler_strategy: digest
+
 development:
   <<: *default
   compile: true
+  compiler_strategy: mtime
 
   # Reference: https://webpack.js.org/configuration/dev-server/
   dev_server:

data/lib/webpacker/base_strategy.rb

@@ -0,0 +1,24 @@
+module Webpacker
+  class BaseStrategy
+    def initialize
+      @config = Webpacker.config
+    end
+
+    def after_compile_hook
+      nil
+    end
+
+    private
+
+      attr_reader :config
+
+      def default_watched_paths
+        [
+          *config.additional_paths.map { |path| "#{path}{,/**/*}" },
+          "#{config.source_path}{,/**/*}",
+          "yarn.lock", "package.json",
+          "config/webpack{,/**/*}"
+        ].freeze
+      end
+  end
+end

data/lib/webpacker/compiler.rb

@@ -1,17 +1,13 @@
 require "open3"
+require "webpacker/compiler_strategy"
 
 class Webpacker::Compiler
-  # Additional paths that test compiler needs to watch
-  # Webpacker::Compiler.watched_paths << 'bower_components'
-  #
-  # Deprecated. Use additional_paths in the YAML configuration instead.
-  cattr_accessor(:watched_paths) { [] }
-
   # Additional environment variables that the compiler is being run with
   # Webpacker::Compiler.env['FRONTEND_API_KEY'] = 'your_secret_key'
   cattr_accessor(:env) { {} }
 
-  delegate :config, :logger, to: :webpacker
+  delegate :config, :logger, :strategy, to: :webpacker
+  delegate :fresh?, :stale?, :after_compile_hook, to: :strategy
 
   def initialize(webpacker)
     @webpacker = webpacker
@@ -19,50 +15,18 @@ class Webpacker::Compiler
 
   def compile
     if stale?
-      run_webpack
+      run_webpack.tap do |success|
+        after_compile_hook
+      end
     else
       logger.debug "Everything's up-to-date. Nothing to do"
       true
     end
   end
 
-  # Returns true if manifest file mtime is newer than the timestamp of the last modified watched file
-  def fresh?
-    manifest_mtime > latest_modified_timestamp
-  end
-
-  # Returns true if manifest file mtime is older than the timestamp of the last modified watched file
-  def stale?
-    !fresh?
-  end
-
   private
     attr_reader :webpacker
 
-    def manifest_mtime
-      config.manifest_path.exist? ? File.mtime(config.manifest_path).to_i : 0
-    end
-
-    def latest_modified_timestamp
-      if Rails.env.development?
-        warn <<~MSG.strip
-          Webpacker::Compiler - Slow setup for development
-
-          Prepare JS assets with either:
-          1. Running `bin/webpacker-dev-server`
-          2. Set `compile` to false in webpacker.yml and run `bin/webpacker -w`
-        MSG
-      end
-
-      warn "Webpacker::Compiler.watched_paths has been deprecated. Set additional_paths in webpacker.yml instead." unless watched_paths.empty?
-      root_path = Pathname.new(File.expand_path(config.root_path))
-      expanded_paths = [*default_watched_paths, *watched_paths].map do |path|
-        root_path.join(path)
-      end
-      latest_modified = Dir[*expanded_paths].max_by { |f| File.mtime(f) }
-      File.mtime(latest_modified).to_i
-    end
-
     def optionalRubyRunner
       bin_webpack_path = config.root_path.join("bin/webpacker")
       first_line = File.readlines(bin_webpack_path).first.chomp
@@ -93,15 +57,6 @@ class Webpacker::Compiler
       status.success?
     end
 
-    def default_watched_paths
-      [
-        *config.additional_paths.map { |path| "#{path}{,/**/*}" },
-        "#{config.source_path}{,/**/*}",
-        "yarn.lock", "package.json",
-        "config/webpack{,/**/*}"
-      ].freeze
-    end
-
     def webpack_env
       return env unless defined?(ActionController::Base)
 

data/lib/webpacker/compiler_strategy.rb

@@ -0,0 +1,20 @@
+require "webpacker/mtime_strategy"
+require "webpacker/digest_strategy"
+
+module Webpacker
+  class CompilerStrategy
+    def self.from_config
+      strategy_from_config = Webpacker.config.compiler_strategy
+
+      case strategy_from_config
+      when "mtime"
+        Webpacker::MtimeStrategy.new
+      when "digest"
+        Webpacker::DigestStrategy.new
+      else
+        raise "Unknown strategy '#{strategy_from_config}'. " \
+              "Available options are 'mtime' and 'digest'."
+      end
+    end
+  end
+end

data/lib/webpacker/configuration.rb

@@ -85,6 +85,10 @@ class Webpacker::Configuration
     fetch(:webpack_compile_output)
   end
 
+  def compiler_strategy
+    fetch(:compiler_strategy)
+  end
+
   def fetch(key)
     data.fetch(key, defaults[key])
   end

data/lib/webpacker/digest_strategy.rb

@@ -0,0 +1,59 @@
+require "digest/sha1"
+require "webpacker/base_strategy"
+
+module Webpacker
+  class DigestStrategy < BaseStrategy
+    # Returns true if all the compiled packs are up to date with the underlying asset files.
+    def fresh?
+      last_compilation_digest&.== watched_files_digest
+    end
+
+    # Returns true if the compiled packs are out of date with the underlying asset files.
+    def stale?
+      !fresh?
+    end
+
+    def after_compile_hook
+      # We used to only record the digest on success
+      # However, the output file is still written on error, meaning that the digest should still be updated.
+      # If it's not, you can end up in a situation where a recompile doesn't take place when it should.
+      # See https://github.com/rails/webpacker/issues/2113
+      record_compilation_digest
+    end
+
+    private
+
+      def last_compilation_digest
+        compilation_digest_path.read if compilation_digest_path.exist? && config.manifest_path.exist?
+      rescue Errno::ENOENT, Errno::ENOTDIR
+      end
+
+      def watched_files_digest
+        if Rails.env.development?
+          warn <<~MSG.strip
+          Webpacker::Compiler - Slow setup for development
+          Prepare JS assets with either:
+          1. Running `bin/webpacker-dev-server`
+          2. Set `compile` to false in webpacker.yml and run `bin/webpacker -w`
+        MSG
+        end
+
+        root_path = Pathname.new(File.expand_path(config.root_path))
+        expanded_paths = [*default_watched_paths].map do |path|
+          root_path.join(path)
+        end
+        files = Dir[*expanded_paths].reject { |f| File.directory?(f) }
+        file_ids = files.sort.map { |f| "#{File.basename(f)}/#{Digest::SHA1.file(f).hexdigest}" }
+        Digest::SHA1.hexdigest(file_ids.join("/"))
+      end
+
+      def record_compilation_digest
+        config.cache_path.mkpath
+        compilation_digest_path.write(watched_files_digest)
+      end
+
+      def compilation_digest_path
+        config.cache_path.join("last-compilation-digest-#{Webpacker.env}")
+      end
+  end
+end

data/lib/webpacker/instance.rb

@@ -19,6 +19,10 @@ class Webpacker::Instance
     )
   end
 
+  def strategy
+    @strategy ||= Webpacker::CompilerStrategy.from_config
+  end
+
   def compiler
     @compiler ||= Webpacker::Compiler.new self
   end

data/lib/webpacker/mtime_strategy.rb

@@ -0,0 +1,40 @@
+require "webpacker/base_strategy"
+
+module Webpacker
+  class MtimeStrategy < BaseStrategy
+    # Returns true if manifest file mtime is newer than the timestamp of the last modified watched file
+    def fresh?
+      manifest_mtime > latest_modified_timestamp
+    end
+
+    # Returns true if manifest file mtime is older than the timestamp of the last modified watched file
+    def stale?
+      !fresh?
+    end
+
+    private
+
+      def manifest_mtime
+        config.manifest_path.exist? ? File.mtime(config.manifest_path).to_i : 0
+      end
+
+      def latest_modified_timestamp
+        if Rails.env.development?
+          warn <<~MSG.strip
+          Webpacker::Compiler - Slow setup for development
+
+          Prepare JS assets with either:
+          1. Running `bin/webpacker-dev-server`
+          2. Set `compile` to false in webpacker.yml and run `bin/webpacker -w`
+        MSG
+        end
+
+        root_path = Pathname.new(File.expand_path(config.root_path))
+        expanded_paths = [*default_watched_paths].map do |path|
+          root_path.join(path)
+        end
+        latest_modified = Dir[*expanded_paths].max_by { |f| File.mtime(f) }
+        File.mtime(latest_modified).to_i
+      end
+  end
+end

data/lib/webpacker/version.rb

@@ -1,4 +1,4 @@
 module Webpacker
   # Change the version in package.json too, please!
-  VERSION = "6.3.0-rc.1".freeze
+  VERSION = "6.3.0".freeze
 end

data/package/rules/file.js

@@ -1,4 +1,4 @@
-const { dirname, join } = require('path')
+const { dirname } = require('path')
 const { source_path: sourcePath } = require('../config')
 
 module.exports = {
@@ -12,7 +12,7 @@ module.exports = {
         .split('/')
         .slice(1)
 
-      const foldersWithStatic = join('static', ...folders)
+      const foldersWithStatic = ['static', ...folders].join('/')
       return `${foldersWithStatic}/[name]-[hash][ext][query]`
     }
   }

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "shakapacker",
-  "version": "6.3.0-rc.1",
+  "version": "6.3.0",
   "description": "Use webpack to manage app-like JavaScript modules in Rails",
   "main": "package/index.js",
   "files": [
@@ -13,7 +13,7 @@
   },
   "peerDependencies": {
     "@babel/core": "^7.17.9",
-    "@babel/plugin-transform-runtime": "^7.17.9",
+    "@babel/plugin-transform-runtime": "^7.17.0",
     "@babel/preset-env": "^7.16.11",
     "@babel/runtime": "^7.17.9",
     "babel-loader": "^8.2.4",
@@ -22,7 +22,7 @@
     "webpack": "^5.72.0",
     "webpack-assets-manifest": "^5.0.6",
     "webpack-cli": "^4.9.2",
-    "webpack-dev-server": "^4.8.1",
+    "webpack-dev-server": "^4.9.0",
     "webpack-merge": "^5.8.0"
   },
   "dependencies": {

data/test/compiler_strategy_test.rb

@@ -0,0 +1,27 @@
+require "test_helper"
+
+class CompilerStrategyTest < Minitest::Test
+  def test_mtime_strategy_returned
+    Webpacker.config.stub :compiler_strategy, "mtime" do
+      assert_instance_of Webpacker::MtimeStrategy, Webpacker::CompilerStrategy.from_config
+    end
+  end
+
+  def test_digest_strategy_returned
+    Webpacker.config.stub :compiler_strategy, "digest" do
+      assert_instance_of Webpacker::DigestStrategy, Webpacker::CompilerStrategy.from_config
+    end
+  end
+
+  def test_raise_on_unknown_strategy
+    Webpacker.config.stub :compiler_strategy, "other" do
+      error = assert_raises do
+        Webpacker::CompilerStrategy.from_config
+      end
+
+      assert_equal \
+        "Unknown strategy 'other'. Available options are 'mtime' and 'digest'.",
+        error.message
+    end
+  end
+end

data/test/compiler_test.rb

@@ -9,46 +9,43 @@ class CompilerTest < Minitest::Test
     Webpacker.compiler.env = {}
   end
 
-  def setup
-    @manifest_timestamp = Time.parse("2021-01-01 12:34:56 UTC")
-  end
-
-  def with_stubs(latest_timestamp:, manifest_exists: true)
-    Webpacker.compiler.stub :latest_modified_timestamp, latest_timestamp do
-      FileTest.stub :exist?, manifest_exists do
-        File.stub :mtime, @manifest_timestamp do
-          yield
-        end
-      end
+  def test_compile_true_when_fresh
+    mock = Minitest::Mock.new
+    mock.expect(:stale?, false)
+    Webpacker.compiler.stub(:strategy, mock) do
+      assert Webpacker.compiler.compile
     end
+    assert_mock mock
   end
 
-  def test_freshness_when_manifest_missing
-    latest_timestamp = @manifest_timestamp + 3600
-
-    with_stubs(latest_timestamp: latest_timestamp.to_i, manifest_exists: false) do
-      assert Webpacker.compiler.stale?
-    end
-  end
+  def test_after_compile_hook_called_on_success
+    mock = Minitest::Mock.new
+    mock.expect(:stale?, true)
+    mock.expect(:after_compile_hook, nil)
 
-  def test_freshness_when_manifest_older
-    latest_timestamp = @manifest_timestamp + 3600
+    status = OpenStruct.new(success?: true)
 
-    with_stubs(latest_timestamp: latest_timestamp.to_i) do
-      assert Webpacker.compiler.stale?
+    Webpacker.compiler.stub(:strategy, mock) do
+      Open3.stub :capture3, [:sterr, :stdout, status] do
+        Webpacker.compiler.compile
+      end
     end
+    assert_mock mock
   end
 
-  def test_freshness_when_manifest_newer
-    latest_timestamp = @manifest_timestamp - 3600
+  def test_after_compile_hook_called_on_failure
+    mock = Minitest::Mock.new
+    mock.expect(:stale?, true)
+    mock.expect(:after_compile_hook, nil)
 
-    with_stubs(latest_timestamp: latest_timestamp.to_i) do
-      assert Webpacker.compiler.fresh?
-    end
-  end
+    status = OpenStruct.new(success?: false)
 
-  def test_compile
-    assert !Webpacker.compiler.compile
+    Webpacker.compiler.stub(:strategy, mock) do
+      Open3.stub :capture3, [:sterr, :stdout, status] do
+        Webpacker.compiler.compile
+      end
+    end
+    assert_mock mock
   end
 
   def test_external_env_variables

data/test/digest_strategy_test.rb

@@ -0,0 +1,33 @@
+require "test_helper"
+
+class DigestStrategyTest < Minitest::Test
+  def remove_compilation_digest_path
+    @digest_strategy.send(:compilation_digest_path).tap do |path|
+      path.delete if path.exist?
+    end
+  end
+
+  def setup
+    @digest_strategy = Webpacker::DigestStrategy.new
+    remove_compilation_digest_path
+  end
+
+  def teardown
+    remove_compilation_digest_path
+  end
+
+  def test_freshness
+    assert @digest_strategy.stale?
+    assert !@digest_strategy.fresh?
+  end
+
+  def test_freshness_after_compilation_hook
+    @digest_strategy.after_compile_hook
+    assert @digest_strategy.fresh?
+    assert !@digest_strategy.stale?
+  end
+
+  def test_compilation_digest_path
+    assert_equal @digest_strategy.send(:compilation_digest_path).basename.to_s, "last-compilation-digest-#{Webpacker.env}"
+  end
+end

data/test/mtime_strategy_test.rb

@@ -0,0 +1,42 @@
+require "test_helper"
+
+class MtimeStrategyTest < Minitest::Test
+  def setup
+    @mtime_strategy = Webpacker::MtimeStrategy.new
+    @manifest_timestamp = Time.parse("2021-01-01 12:34:56 UTC")
+  end
+
+  def with_stubs(latest_timestamp:, manifest_exists: true)
+    @mtime_strategy.stub :latest_modified_timestamp, latest_timestamp do
+      FileTest.stub :exist?, manifest_exists do
+        File.stub :mtime, @manifest_timestamp do
+          yield
+        end
+      end
+    end
+  end
+
+  def test_freshness_when_manifest_missing
+    latest_timestamp = @manifest_timestamp + 3600
+
+    with_stubs(latest_timestamp: latest_timestamp.to_i, manifest_exists: false) do
+      assert @mtime_strategy.stale?
+    end
+  end
+
+  def test_freshness_when_manifest_older
+    latest_timestamp = @manifest_timestamp + 3600
+
+    with_stubs(latest_timestamp: latest_timestamp.to_i) do
+      assert @mtime_strategy.stale?
+    end
+  end
+
+  def test_freshness_when_manifest_newer
+    latest_timestamp = @manifest_timestamp - 3600
+
+    with_stubs(latest_timestamp: latest_timestamp.to_i) do
+      assert @mtime_strategy.fresh?
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shakapacker
 version: !ruby/object:Gem::Version
-  version: 6.3.0.pre.rc.1
+  version: 6.3.0
 platform: ruby
 authors:
 - David Heinemeier Hansson
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-04-24 00:00:00.000000000 Z
+date: 2022-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -142,6 +142,7 @@ files:
 - docs/customizing_babel_config.md
 - docs/deployment.md
 - docs/developing_webpacker.md
+- docs/react.md
 - docs/style_loader_vs_mini_css.md
 - docs/troubleshooting.md
 - docs/using_esbuild_loader.md
@@ -179,16 +180,20 @@ files:
 - lib/tasks/webpacker/yarn_install.rake
 - lib/tasks/yarn.rake
 - lib/webpacker.rb
+- lib/webpacker/base_strategy.rb
 - lib/webpacker/commands.rb
 - lib/webpacker/compiler.rb
+- lib/webpacker/compiler_strategy.rb
 - lib/webpacker/configuration.rb
 - lib/webpacker/dev_server.rb
 - lib/webpacker/dev_server_proxy.rb
 - lib/webpacker/dev_server_runner.rb
+- lib/webpacker/digest_strategy.rb
 - lib/webpacker/env.rb
 - lib/webpacker/helper.rb
 - lib/webpacker/instance.rb
 - lib/webpacker/manifest.rb
+- lib/webpacker/mtime_strategy.rb
 - lib/webpacker/railtie.rb
 - lib/webpacker/runner.rb
 - lib/webpacker/version.rb
@@ -236,10 +241,12 @@ files:
 - package/utils/helpers.js
 - rakelib/release.rake
 - test/command_test.rb
+- test/compiler_strategy_test.rb
 - test/compiler_test.rb
 - test/configuration_test.rb
 - test/dev_server_runner_test.rb
 - test/dev_server_test.rb
+- test/digest_strategy_test.rb
 - test/engine_rake_tasks_test.rb
 - test/env_test.rb
 - test/fixtures/beta_package.json
@@ -261,6 +268,7 @@ files:
 - test/mounted_app/test/dummy/config/environment.rb
 - test/mounted_app/test/dummy/config/webpacker.yml
 - test/mounted_app/test/dummy/package.json
+- test/mtime_strategy_test.rb
 - test/rake_tasks_test.rb
 - test/test_app/Rakefile
 - test/test_app/app/packs/entrypoints/application.js
@@ -292,7 +300,7 @@ homepage: https://github.com/shakacode/shakapacker
 licenses:
 - MIT
 metadata:
-  source_code_uri: https://github.com/shakacode/shakapacker/tree/v6.3.0-rc.1
+  source_code_uri: https://github.com/shakacode/shakapacker/tree/v6.3.0
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -304,9 +312,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.2.32
 signing_key:
@@ -314,10 +322,12 @@ specification_version: 4
 summary: Use webpack to manage app-like JavaScript modules in Rails
 test_files:
 - test/command_test.rb
+- test/compiler_strategy_test.rb
 - test/compiler_test.rb
 - test/configuration_test.rb
 - test/dev_server_runner_test.rb
 - test/dev_server_test.rb
+- test/digest_strategy_test.rb
 - test/engine_rake_tasks_test.rb
 - test/env_test.rb
 - test/fixtures/beta_package.json
@@ -339,6 +349,7 @@ test_files:
 - test/mounted_app/test/dummy/config/environment.rb
 - test/mounted_app/test/dummy/config/webpacker.yml
 - test/mounted_app/test/dummy/package.json
+- test/mtime_strategy_test.rb
 - test/rake_tasks_test.rb
 - test/test_app/Rakefile
 - test/test_app/app/packs/entrypoints/application.js