shakapacker 6.2.1 → 6.4.0

data/lib/webpacker/manifest.rb

@@ -104,12 +104,12 @@ class Webpacker::Manifest
 
     def missing_file_from_manifest_error(bundle_name)
       <<-MSG
-Webpacker can't find #{bundle_name} in #{config.manifest_path}. Possible causes:
+Shakapacker can't find #{bundle_name} in #{config.manifest_path}. Possible causes:
 1. You forgot to install node packages (try `yarn install`) or are running an incompatible version of Node
 2. Your app has code with a non-standard extension (like a `.jsx` file) but the extension is not in the `extensions` config in `config/webpacker.yml`
 3. You have set compile: false (see `config/webpacker.yml`) for this environment
    (unless you are using the `bin/webpacker -w` or the `bin/webpacker-dev-server`, in which case maybe you aren't running the dev server in the background?)
-4. webpack has not yet re-run to reflect updates.
+4. webpack has not yet FINISHED running to reflect updates.
 5. You have misconfigured Webpacker's `config/webpacker.yml` file.
 6. Your webpack configuration is not creating a manifest.
 

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.2.1".freeze
+  VERSION = "6.4.0".freeze
 end

data/package/babel/preset.js

@@ -25,7 +25,6 @@ module.exports = function config(api) {
           corejs: '3.8',
           modules: 'auto',
           bugfixes: true,
-          loose: true,
           exclude: ['transform-typeof-symbol']
         }
       ],

data/package/environments/__tests__/base.js

@@ -3,15 +3,18 @@
 // environment.js expects to find config/webpacker.yml and resolved modules from
 // the root of a Rails project
 
-const { chdirTestApp, chdirCwd } = require('../../utils/helpers')
+const { chdirTestApp, chdirCwd, resetEnv } = require('../../utils/helpers')
 
 chdirTestApp()
 
 const { resolve } = require('path')
-const rules = require('../../rules')
+
 const baseConfig = require('../base')
+const config = require("../../config");
 
 describe('Base config', () => {
+  beforeEach(() => jest.resetModules() && resetEnv())
+
   afterAll(chdirCwd)
 
   describe('config', () => {
@@ -21,11 +24,33 @@ describe('Base config', () => {
       )
     })
 
-    test('should return multi file entry points', () => {
+    test('should return only 2 entry points with config.nested_entries == false', () => {
+      expect(config.nested_entries).toEqual(false)
+
+      expect(baseConfig.entry.multi_entry.sort()).toEqual([
+        resolve('app', 'packs', 'entrypoints', 'multi_entry.css'),
+        resolve('app', 'packs', 'entrypoints', 'multi_entry.js')
+      ])
+      expect(baseConfig.entry['generated/something']).toEqual(undefined)
+    })
+
+    test('should returns top level and nested entry points with config.nested_entries == true', () => {
+      process.env.WEBPACKER_CONFIG = 'config/webpacker_nested_entries.yml'
+      const config = require("../../config");
+      const baseConfig = require('../base')
+
+      expect(config.nested_entries).toEqual(true)
+
+      expect(baseConfig.entry.application).toEqual(
+        resolve('app', 'packs', 'entrypoints', 'application.js')
+      )
       expect(baseConfig.entry.multi_entry.sort()).toEqual([
         resolve('app', 'packs', 'entrypoints', 'multi_entry.css'),
         resolve('app', 'packs', 'entrypoints', 'multi_entry.js')
       ])
+      expect(baseConfig.entry['generated/something']).toEqual(
+        resolve('app', 'packs', 'entrypoints', 'generated', 'something.js')
+      )
     })
 
     test('should return output', () => {
@@ -36,6 +61,8 @@ describe('Base config', () => {
     })
 
     test('should return default loader rules for each file in config/loaders', () => {
+      const rules = require('../../rules')
+
       const defaultRules = Object.keys(rules)
       const configRules = baseConfig.module.rules
 

data/package/environments/base.js

@@ -14,8 +14,15 @@ const { moduleExists } = require('../utils/helpers')
 const getEntryObject = () => {
   const entries = {}
   const rootPath = join(config.source_path, config.source_entry_path)
+  if (config.source_entry_path === '/' && config.nested_entries) {
+    throw new Error(
+      "Your webpacker config specified using a source_entry_path of '/' with 'nested_entries' == " +
+      "'true'. Doing this would result in packs for every one of your source files"
+    )
+  }
+  const nesting = config.nested_entries ? '**/' : ''
 
-  globSync(`${rootPath}/*.*`).forEach((path) => {
+  globSync(`${rootPath}/${nesting}*.*`).forEach((path) => {
     const namespace = relative(join(rootPath), dirname(path))
     const name = join(namespace, basename(path, extname(path)))
     let assetPaths = resolve(path)

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.2.1",
+  "version": "6.4.0",
   "description": "Use webpack to manage app-like JavaScript modules in Rails",
   "main": "package/index.js",
   "files": [
@@ -12,16 +12,17 @@
     "yarn": ">=1 <4"
   },
   "peerDependencies": {
-    "@babel/core": "^7.15.5",
-    "@babel/plugin-transform-runtime": "^7.15.0",
-    "@babel/preset-env": "^7.15.6",
-    "@babel/runtime": "^7.15.4",
-    "babel-loader": "^8.2.2",
-    "compression-webpack-plugin": "^9.0.0",
-    "terser-webpack-plugin": "^5.2.4",
-    "webpack": "^5.53.0",
+    "@babel/core": "^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",
+    "compression-webpack-plugin": "^9.0.0 || ^10.0.0",
+    "terser-webpack-plugin": "^5.3.1",
+    "webpack": "^5.72.0",
     "webpack-assets-manifest": "^5.0.6",
-    "webpack-cli": "^4.8.0",
+    "webpack-cli": "^4.9.2",
+    "webpack-dev-server": "^4.9.0",
     "webpack-merge": "^5.8.0"
   },
   "dependencies": {
@@ -30,7 +31,7 @@
     "path-complete-extname": "^1.0.0"
   },
   "devDependencies": {
-    "babel-loader": "^8.2.2",
+    "babel-loader": "^8.2.4",
     "compression-webpack-plugin": "^9.0.0",
     "esbuild-loader": "^2.18.0",
     "eslint": "^7.32.0",
@@ -41,7 +42,7 @@
     "eslint-plugin-react": "^7.26.0",
     "jest": "^27.2.1",
     "swc-loader": "^0.1.15",
-    "webpack": "^5.53.0",
+    "webpack": "^5.72.0",
     "webpack-assets-manifest": "^5.0.6",
     "webpack-merge": "^5.8.0"
   },

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

@@ -1,20 +1,6 @@
 require "test_helper"
 
 class CompilerTest < Minitest::Test
-  def remove_compilation_digest_path
-    Webpacker.compiler.send(:compilation_digest_path).tap do |path|
-      path.delete if path.exist?
-    end
-  end
-
-  def setup
-    remove_compilation_digest_path
-  end
-
-  def teardown
-    remove_compilation_digest_path
-  end
-
   def test_custom_environment_variables
     assert_nil Webpacker.compiler.send(:webpack_env)["FOO"]
     Webpacker.compiler.env["FOO"] = "BAR"
@@ -23,37 +9,43 @@ class CompilerTest < Minitest::Test
     Webpacker.compiler.env = {}
   end
 
-  def test_freshness
-    assert Webpacker.compiler.stale?
-    assert !Webpacker.compiler.fresh?
+  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_compile
-    assert !Webpacker.compiler.compile
-  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_on_compile_success
     status = OpenStruct.new(success?: true)
 
-    assert Webpacker.compiler.stale?
-    Open3.stub :capture3, [:sterr, :stdout, status] do
-      Webpacker.compiler.compile
-      assert Webpacker.compiler.fresh?
+    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_on_compile_fail
+  def test_after_compile_hook_called_on_failure
+    mock = Minitest::Mock.new
+    mock.expect(:stale?, true)
+    mock.expect(:after_compile_hook, nil)
+
     status = OpenStruct.new(success?: false)
 
-    assert Webpacker.compiler.stale?
-    Open3.stub :capture3, [:sterr, :stdout, status] do
-      Webpacker.compiler.compile
-      assert Webpacker.compiler.fresh?
+    Webpacker.compiler.stub(:strategy, mock) do
+      Open3.stub :capture3, [:sterr, :stdout, status] do
+        Webpacker.compiler.compile
+      end
     end
-  end
-
-  def test_compilation_digest_path
-    assert_equal Webpacker.compiler.send(:compilation_digest_path).basename.to_s, "last-compilation-digest-#{Webpacker.env}"
+    assert_mock mock
   end
 
   def test_external_env_variables

data/test/configuration_test.rb

@@ -28,14 +28,14 @@ class ConfigurationTest < Webpacker::Test
     public_output_path = File.expand_path File.join(File.dirname(__FILE__), "test_app/public/packs").to_s
     assert_equal @config.public_output_path.to_s, public_output_path
 
-    @config = Webpacker::Configuration.new(
+    @public_root_config = Webpacker::Configuration.new(
       root_path: @config.root_path,
       config_path: Pathname.new(File.expand_path("./test_app/config/webpacker_public_root.yml", __dir__)),
       env: "production"
     )
 
     public_output_path = File.expand_path File.join(File.dirname(__FILE__), "public/packs").to_s
-    assert_equal @config.public_output_path.to_s, public_output_path
+    assert_equal @public_root_config.public_output_path.to_s, public_output_path
   end
 
   def test_public_manifest_path
@@ -47,14 +47,14 @@ class ConfigurationTest < Webpacker::Test
     manifest_path = File.expand_path File.join(File.dirname(__FILE__), "test_app/public/packs", "manifest.json").to_s
     assert_equal @config.manifest_path.to_s, manifest_path
 
-    @config = Webpacker::Configuration.new(
+    @manifest_config = Webpacker::Configuration.new(
       root_path: @config.root_path,
       config_path: Pathname.new(File.expand_path("./test_app/config/webpacker_manifest_path.yml", __dir__)),
       env: "production"
     )
 
     manifest_path = File.expand_path File.join(File.dirname(__FILE__), "test_app/app/packs", "manifest.json").to_s
-    assert_equal @config.manifest_path.to_s, manifest_path
+    assert_equal @manifest_config.manifest_path.to_s, manifest_path
   end
 
   def test_cache_path
@@ -100,5 +100,25 @@ class ConfigurationTest < Webpacker::Test
     with_rails_env("test") do
       refute Webpacker.config.ensure_consistent_versioning?
     end
+
+    def test_webpacker_precompile
+      assert @config.webpacker_precompile
+
+      ENV["WEBPACKER_PRECOMPILE"] = "false"
+
+      refute Webpacker.config.webpacker_precompile?
+
+      ENV["WEBPACKER_PRECOMPILE"] = "yes"
+
+      assert Webpacker.config.webpacker_precompile?
+
+      @no_precompile_config = Webpacker::Configuration.new(
+        root_path: @config.root_path,
+        config_path: Pathname.new(File.expand_path("./test_app/config/webpacker_no_precompile.yml", __dir__)),
+        env: "production"
+      )
+
+      refute @no_precompile_config.webpacker_precompile
+    end
   end
 end

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/helper_test.rb

@@ -115,6 +115,28 @@ class HelperTest < ActionView::TestCase
       javascript_pack_tag("application", "bootstrap", defer: false)
   end
 
+  def test_javascript_pack_with_append
+    append_javascript_pack_tag("bootstrap", defer: false)
+    assert_equal \
+      %(<script src="/packs/vendors~application~bootstrap-c20632e7baf2c81200d3.chunk.js" defer="defer"></script>\n) +
+        %(<script src="/packs/vendors~application-e55f2aae30c07fb6d82a.chunk.js" defer="defer"></script>\n) +
+        %(<script src="/packs/application-k344a6d59eef8632c9d1.js" defer="defer"></script>\n) +
+        %(<script src="/packs/bootstrap-300631c4f0e0f9c865bc.js"></script>),
+      javascript_pack_tag("application")
+  end
+
+  def test_append_javascript_pack_tag_raises
+    error = assert_raises do
+      javascript_pack_tag("application")
+      append_javascript_pack_tag("bootstrap", defer: false)
+    end
+
+    assert_equal \
+      "You can only call append_javascript_pack_tag before javascript_pack_tag helper. " +
+        "Please refer to https://github.com/shakacode/shakapacker/blob/master/README.md#usage for the usage guide",
+      error.message
+  end
+
   def test_javascript_pack_tag_splat
     assert_equal \
       %(<script src="/packs/vendors~application~bootstrap-c20632e7baf2c81200d3.chunk.js" defer="defer"></script>\n) +

data/test/manifest_test.rb

@@ -8,7 +8,7 @@ class ManifestTest < Minitest::Test
       Webpacker.manifest.lookup!(asset_file)
     end
 
-    assert_match "Webpacker can't find #{asset_file} in #{manifest_path}", error.message
+    assert_match "Shakapacker can't find #{asset_file} in #{manifest_path}", error.message
   end
 
   def test_lookup_with_type_exception!
@@ -18,7 +18,7 @@ class ManifestTest < Minitest::Test
       Webpacker.manifest.lookup!(asset_file, type: :javascript)
     end
 
-    assert_match "Webpacker can't find #{asset_file}.js in #{manifest_path}", error.message
+    assert_match "Shakapacker can't find #{asset_file}.js in #{manifest_path}", error.message
   end
 
   def test_lookup_success!
@@ -60,7 +60,7 @@ class ManifestTest < Minitest::Test
       Webpacker.manifest.lookup_pack_with_chunks!(asset_file, type: :javascript)
     end
 
-    assert_match "Webpacker can't find #{asset_file}.js in #{manifest_path}", error.message
+    assert_match "Shakapacker can't find #{asset_file}.js in #{manifest_path}", error.message
   end
 
   def test_lookup_entrypoint

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

data/test/rake_tasks_test.rb

@@ -30,42 +30,8 @@ class RakeTasksTest < Minitest::Test
     refute_includes output, "Webpacker requires Yarn"
   end
 
-  def test_rake_webpacker_yarn_install_in_non_production_environments
-    assert_includes test_app_dev_dependencies, "right-pad"
-
-    Webpacker.with_node_env("test") do
-      Dir.chdir(test_app_path) do
-        `bundle exec rake webpacker:yarn_install`
-      end
-    end
-
-    assert_includes installed_node_module_names, "right-pad",
-                    "Expected dev dependencies to be installed"
-  end
-
-  def test_rake_webpacker_yarn_install_in_production_environment
-    Webpacker.with_node_env("production") do
-      Dir.chdir(test_app_path) do
-        `bundle exec rake webpacker:yarn_install`
-      end
-    end
-
-    refute_includes installed_node_module_names, "right-pad",
-                    "Expected only production dependencies to be installed"
-  end
-
   private
     def test_app_path
       File.expand_path("test_app", __dir__)
     end
-
-    def test_app_dev_dependencies
-      package_json = File.expand_path("package.json", test_app_path)
-      JSON.parse(File.read(package_json))["devDependencies"]
-    end
-
-    def installed_node_module_names
-      node_modules_path = File.expand_path("node_modules", test_app_path)
-      Dir.chdir(node_modules_path) { Dir.glob("*") }
-    end
 end

data/test/test_app/app/packs/entrypoints/generated/something.js

@@ -0,0 +1,2 @@
+/* eslint no-console:0 */
+console.log('entrypoints/nested/something')

data/test/test_app/config/webpacker.yml

@@ -3,6 +3,7 @@
 default: &default
   source_path: app/packs
   source_entry_path: entrypoints
+  nested_entries: false
   public_root_path: public
   public_output_path: packs
   cache_path: tmp/webpacker

data/test/test_app/config/webpacker_nested_entries.yml

@@ -0,0 +1,83 @@
+# Note: You must restart bin/webpacker-dev-server for changes to take effect
+
+default: &default
+  source_path: app/packs
+  source_entry_path: entrypoints
+  nested_entries: true
+  public_root_path: public
+  public_output_path: packs
+  cache_path: tmp/webpacker
+  webpack_compile_output: false
+  webpack_loader: babel
+
+  # Location for manifest.json, defaults to {public_output_path}/manifest.json if unset
+  # manifest_path: public/packs/manifest.json
+
+  # Additional paths webpack should look up modules
+  # ['app/assets', 'engine/foo/app/assets']
+  additional_paths:
+    - app/assets
+    - /etc/yarn
+    - some.config.js
+    - app/elm
+
+  # Reload manifest.json on all requests so we reload latest compiled packs
+  cache_manifest: false
+
+  static_assets_extensions:
+    - .jpg
+    - .jpeg
+    - .png
+    - .gif
+    - .tiff
+    - .ico
+    - .svg
+
+  extensions:
+    - .mjs
+    - .js
+
+development:
+  <<: *default
+  compile: true
+  ensure_consistent_versioning: true
+
+  # Reference: https://webpack.js.org/configuration/dev-server/
+  dev_server:
+    https: false
+    host: localhost
+    port: 3035
+    public: localhost:3035
+    hmr: false
+    overlay: true
+    disable_host_check: true
+    use_local_ip: false
+    pretty: false
+
+test:
+  <<: *default
+  compile: true
+
+  # Compile test packs to a separate directory
+  public_output_path: packs-test
+
+production:
+  <<: *default
+
+  # Production depends on precompilation of packs prior to booting for performance.
+  compile: false
+
+  # Cache manifest.json for performance
+  cache_manifest: true
+
+staging:
+  <<: *default
+
+  # Production depends on precompilation of packs prior to booting for performance.
+  compile: false
+
+  # Cache manifest.json for performance
+  cache_manifest: true
+
+  # Compile staging packs to a separate directory
+  public_output_path: packs-staging