webpacker 5.0.1 → 6.0.0.pre.1

data/package/rules/sass.js

@@ -1,14 +1,13 @@
+const sass = require('sass')
 const getStyleRule = require('../utils/get_style_rule')
-const { resolved_paths: includePaths } = require('../config')
+const { additional_paths: includePaths } = require('../config')
 
-module.exports = getStyleRule(/\.(scss|sass)(\.erb)?$/i, false, [
+module.exports = getStyleRule(/\.(scss|sass)(\.erb)?$/i, [
   {
-    loader: 'sass-loader',
+    loader: require.resolve('sass-loader'),
     options: {
-      sourceMap: true,
-      sassOptions: {
-        includePaths
-      }
+      sassOptions: { includePaths },
+      implementation: sass
     }
   }
 ])

data/package/rules/svg.js

@@ -0,0 +1,23 @@
+/* eslint global-require: 0 */
+/* eslint import/no-dynamic-require: 0 */
+
+module.exports = {
+  test: /\.svg$/i,
+  type: 'asset/inline',
+  generator: {
+    dataUrl: (content) => {
+      let optimisedContent = content
+
+      try {
+        if (require.resolve('mini-svg-data-uri')) {
+          const svgToMiniDataURI = require('mini-svg-data-uri')
+          optimisedContent = svgToMiniDataURI(content.toString())
+        }
+      } catch (e) {
+        /* Work out what to print here */
+      }
+
+      return optimisedContent
+    }
+  }
+}

data/package/utils/get_style_rule.js

@@ -1,44 +1,38 @@
 const MiniCssExtractPlugin = require('mini-css-extract-plugin')
-const { resolve } = require('path')
-const config = require('../config')
 
-const styleLoader = {
-  loader: 'style-loader'
+const tryPostcss = () => {
+  let postcssLoader = false
+  try {
+    if (require.resolve('postcss-loader')) {
+      postcssLoader = {
+        loader: require.resolve('postcss-loader'),
+        options: { sourceMap: true }
+      }
+    }
+  } catch (e) {
+    /* Work out what to print here */
+  }
+
+  return postcssLoader
 }
 
-const getStyleRule = (test, modules = false, preprocessors = []) => {
+const getStyleRule = (test, preprocessors = []) => {
   const use = [
+    { loader: MiniCssExtractPlugin.loader },
     {
-      loader: 'css-loader',
+      loader: require.resolve('css-loader'),
       options: {
         sourceMap: true,
-        importLoaders: 2,
-        modules: modules ? {
-          localIdentName: '[name]__[local]___[hash:base64:5]'
-        } : false
-      }
-    },
-    {
-      loader: 'postcss-loader',
-      options: {
-        config: { path: resolve() },
-        sourceMap: true
+        importLoaders: 2
       }
     },
+    tryPostcss(),
     ...preprocessors
-  ]
-
-  const options = modules ? { include: /\.module\.[a-z]+$/ } : { exclude: /\.module\.[a-z]+$/ }
-
-  if (config.extract_css) {
-    use.unshift(MiniCssExtractPlugin.loader)
-  } else {
-    use.unshift(styleLoader)
-  }
+  ].filter(Boolean)
 
-  // sideEffects - See https://github.com/webpack/webpack/issues/6571
   return {
-    test, use, sideEffects: !modules, ...options
+    test,
+    use
   }
 }
 

data/package/utils/helpers.js

@@ -1,30 +1,5 @@
-const { stringify } = require('flatted/cjs')
-
-const isObject = (value) => typeof value === 'object'
-  && value !== null
-  && (value.length === undefined || value.length === null)
-
-const isNotObject = (value) => !isObject(value)
-
-const isBoolean = (str) => /^true/.test(str) || /^false/.test(str)
-
-const isEmpty = (value) => value === null || value === undefined
-
-const isString = (key) => key && typeof key === 'string'
-
-const isStrPath = (key) => {
-  if (!isString(key)) throw new Error(`Key ${key} should be string`)
-  return isString(key) && key.includes('.')
-}
-
 const isArray = (value) => Array.isArray(value)
-
-const isEqual = (target, source) => stringify(target) === stringify(source)
-
-const canMerge = (value) => isObject(value) || isArray(value)
-
-const prettyPrint = (obj) => JSON.stringify(obj, null, 2)
-
+const isBoolean = (str) => /^true/.test(str) || /^false/.test(str)
 const chdirTestApp = () => {
   try {
     return process.chdir('test/test_app')
@@ -44,15 +19,8 @@ const ensureTrailingSlash = (path) => (path.endsWith('/') ? path : `${path}/`)
 module.exports = {
   chdirTestApp,
   chdirCwd,
-  ensureTrailingSlash,
-  isObject,
-  isNotObject,
-  isBoolean,
   isArray,
-  isEqual,
-  isEmpty,
-  isStrPath,
-  canMerge,
-  prettyPrint,
+  isBoolean,
+  ensureTrailingSlash,
   resetEnv
 }

data/test/compiler_test.rb

@@ -23,22 +23,15 @@ class CompilerTest < Minitest::Test
     Webpacker.compiler.env = {}
   end
 
-  def test_default_watched_paths
-    assert_equal Webpacker.compiler.send(:default_watched_paths), [
-      "app/assets/**/*{.mjs,.js,.sass,.scss,.css,.module.sass,.module.scss,.module.css,.png,.svg,.gif,.jpeg,.jpg}",
-      "/etc/yarn/**/*{.mjs,.js,.sass,.scss,.css,.module.sass,.module.scss,.module.css,.png,.svg,.gif,.jpeg,.jpg}",
-      "app/javascript/**/*{.mjs,.js,.sass,.scss,.css,.module.sass,.module.scss,.module.css,.png,.svg,.gif,.jpeg,.jpg}",
-      "yarn.lock",
-      "package.json",
-      "config/webpack/**/*"
-    ]
-  end
-
   def test_freshness
     assert Webpacker.compiler.stale?
     assert !Webpacker.compiler.fresh?
   end
 
+  def test_compile
+    assert !Webpacker.compiler.compile
+  end
+
   def test_freshness_on_compile_success
     status = OpenStruct.new(success?: true)
 

data/test/configuration_test.rb

@@ -14,11 +14,6 @@ class ConfigurationTest < Webpacker::Test
     assert_equal source_path, @config.source_path.to_s
   end
 
-  def test_source_path_globbed
-    assert_equal @config.source_path_globbed,
-                 "app/javascript/**/*{.mjs,.js,.sass,.scss,.css,.module.sass,.module.scss,.module.css,.png,.svg,.gif,.jpeg,.jpg}"
-  end
-
   def test_source_entry_path
     source_entry_path = File.expand_path File.join(File.dirname(__FILE__), "test_app/app/javascript", "packs").to_s
     assert_equal @config.source_entry_path.to_s, source_entry_path
@@ -53,21 +48,8 @@ class ConfigurationTest < Webpacker::Test
     assert_equal @config.cache_path.to_s, cache_path
   end
 
-  def test_resolved_paths
-    assert_equal @config.resolved_paths, ["app/assets", "/etc/yarn"]
-  end
-
-  def test_resolved_paths_globbed
-    assert_equal @config.resolved_paths_globbed, [
-      "app/assets/**/*{.mjs,.js,.sass,.scss,.css,.module.sass,.module.scss,.module.css,.png,.svg,.gif,.jpeg,.jpg}",
-      "/etc/yarn/**/*{.mjs,.js,.sass,.scss,.css,.module.sass,.module.scss,.module.css,.png,.svg,.gif,.jpeg,.jpg}"
-    ]
-  end
-
-  def test_extensions
-    config_path = File.expand_path File.join(File.dirname(__FILE__), "test_app/config/webpacker.yml").to_s
-    webpacker_yml = YAML.load_file(config_path)
-    assert_equal @config.extensions, webpacker_yml["default"]["extensions"]
+  def test_additional_paths
+    assert_equal @config.additional_paths, ["app/assets", "/etc/yarn", "some.config.js", "app/elm"]
   end
 
   def test_cache_manifest?
@@ -93,16 +75,4 @@ class ConfigurationTest < Webpacker::Test
       assert Webpacker.config.compile?
     end
   end
-
-  def test_extract_css?
-    assert @config.extract_css?
-
-    with_rails_env("development") do
-      refute Webpacker.config.extract_css?
-    end
-
-    with_rails_env("test") do
-      refute Webpacker.config.extract_css?
-    end
-  end
 end

data/test/dev_server_runner_test.rb

@@ -13,34 +13,53 @@ class DevServerRunnerTest < Webpacker::Test
   end
 
   def test_run_cmd_via_node_modules
-    cmd = ["#{test_app_path}/node_modules/.bin/webpack-dev-server", "--config", "#{test_app_path}/config/webpack/development.js"]
+    cmd = ["#{test_app_path}/node_modules/.bin/webpack", "serve", "--config", "#{test_app_path}/config/webpack/development.js"]
 
     verify_command(cmd, use_node_modules: true)
   end
 
   def test_run_cmd_via_yarn
-    cmd = ["yarn", "webpack-dev-server", "--config", "#{test_app_path}/config/webpack/development.js"]
+    cmd = ["yarn", "webpack", "serve", "--config", "#{test_app_path}/config/webpack/development.js"]
 
     verify_command(cmd, use_node_modules: false)
   end
 
+  def test_run_cmd_argv
+    cmd = ["#{test_app_path}/node_modules/.bin/webpack", "serve", "--config", "#{test_app_path}/config/webpack/development.js", "--quiet"]
+
+    verify_command(cmd, argv: ["--quiet"])
+  end
+
+  def test_run_cmd_argv_with_https
+    cmd = ["#{test_app_path}/node_modules/.bin/webpack", "serve", "--config", "#{test_app_path}/config/webpack/development.js", "--https"]
+
+    dev_server = Webpacker::DevServer.new({})
+    def dev_server.host; "localhost"; end
+    def dev_server.port; "3035"; end
+    def dev_server.pretty?; false; end
+    def dev_server.https?; true; end
+    Webpacker::DevServer.stub(:new, dev_server) do
+      verify_command(cmd, argv: ["--https"])
+    end
+  end
+
   private
     def test_app_path
       File.expand_path("test_app", __dir__)
     end
 
-    def verify_command(cmd, use_node_modules: true)
+    def verify_command(cmd, use_node_modules: true, argv: [])
       cwd = Dir.pwd
       Dir.chdir(test_app_path)
 
       klass = Webpacker::DevServerRunner
-      instance = klass.new([])
+      instance = klass.new(argv)
       mock = Minitest::Mock.new
-      mock.expect(:call, nil, [{}, *cmd])
+      mock.expect(:call, nil, [Webpacker::Compiler.env, *cmd])
 
       klass.stub(:new, instance) do
         instance.stub(:node_modules_bin_exist?, use_node_modules) do
-          Kernel.stub(:exec, mock) { klass.run([]) }
+          Kernel.stub(:exec, mock) { klass.run(argv) }
         end
       end
 

data/test/engine_rake_tasks_test.rb

@@ -0,0 +1,39 @@
+require "test_helper"
+
+class EngineRakeTasksTest < Minitest::Test
+  def setup
+    remove_webpack_binstubs
+  end
+
+  def teardown
+    remove_webpack_binstubs
+  end
+
+  def test_task_mounted
+    output = Dir.chdir(mounted_app_path) { `rake -T` }
+    assert_includes output, "app:webpacker"
+  end
+
+  def test_binstubs
+    Dir.chdir(mounted_app_path) { `bundle exec rake app:webpacker:binstubs` }
+    webpack_binstub_paths.each { |path| assert File.exist?(path) }
+  end
+
+  private
+    def mounted_app_path
+      File.expand_path("mounted_app", __dir__)
+    end
+
+    def webpack_binstub_paths
+      [
+        "#{mounted_app_path}/test/dummy/bin/webpack",
+        "#{mounted_app_path}/test/dummy/bin/webpack-dev-server",
+      ]
+    end
+
+    def remove_webpack_binstubs
+      webpack_binstub_paths.each do |path|
+        File.delete(path) if File.exist?(path)
+      end
+    end
+end

data/test/helper_test.rb

@@ -17,21 +17,27 @@ class HelperTest < ActionView::TestCase
   def test_asset_pack_path
     assert_equal "/packs/bootstrap-300631c4f0e0f9c865bc.js", asset_pack_path("bootstrap.js")
     assert_equal "/packs/bootstrap-c38deda30895059837cf.css", asset_pack_path("bootstrap.css")
-
-    Webpacker.config.stub :extract_css?, false do
-      assert_nil asset_pack_path("bootstrap.css")
-      assert_equal "/packs/application-k344a6d59eef8632c9d1.png", asset_pack_path("application.png")
-    end
   end
 
   def test_asset_pack_url
     assert_equal "https://example.com/packs/bootstrap-300631c4f0e0f9c865bc.js", asset_pack_url("bootstrap.js")
     assert_equal "https://example.com/packs/bootstrap-c38deda30895059837cf.css", asset_pack_url("bootstrap.css")
+  end
 
-    Webpacker.config.stub :extract_css?, false do
-      assert_nil asset_pack_path("bootstrap.css")
-      assert_equal "https://example.com/packs/application-k344a6d59eef8632c9d1.png", asset_pack_url("application.png")
-    end
+  def test_image_pack_path
+    assert_equal "/packs/application-k344a6d59eef8632c9d1.png", image_pack_path("application.png")
+    assert_equal "/packs/media/images/image-c38deda30895059837cf.jpg", image_pack_path("image.jpg")
+    assert_equal "/packs/media/images/image-c38deda30895059837cf.jpg", image_pack_path("media/images/image.jpg")
+    assert_equal "/packs/media/images/nested/image-c38deda30895059837cf.jpg", image_pack_path("nested/image.jpg")
+    assert_equal "/packs/media/images/nested/image-c38deda30895059837cf.jpg", image_pack_path("media/images/nested/image.jpg")
+  end
+
+  def test_image_pack_url
+    assert_equal "https://example.com/packs/application-k344a6d59eef8632c9d1.png", image_pack_url("application.png")
+    assert_equal "https://example.com/packs/media/images/image-c38deda30895059837cf.jpg", image_pack_url("image.jpg")
+    assert_equal "https://example.com/packs/media/images/image-c38deda30895059837cf.jpg", image_pack_url("media/images/image.jpg")
+    assert_equal "https://example.com/packs/media/images/nested/image-c38deda30895059837cf.jpg", image_pack_url("nested/image.jpg")
+    assert_equal "https://example.com/packs/media/images/nested/image-c38deda30895059837cf.jpg", image_pack_url("media/images/nested/image.jpg")
   end
 
   def test_image_pack_tag
@@ -50,6 +56,9 @@ class HelperTest < ActionView::TestCase
     assert_equal \
       "<img alt=\"Edit Entry\" src=\"/packs/media/images/nested/image-c38deda30895059837cf.jpg\" width=\"16\" height=\"10\" />",
       image_pack_tag("media/images/nested/image.jpg", size: "16x10", alt: "Edit Entry")
+    assert_equal \
+      "<img srcset=\"/packs/media/images/image-2x-7cca48e6cae66ec07b8e.jpg 2x\" src=\"/packs/media/images/image-c38deda30895059837cf.jpg\" />",
+      image_pack_tag("media/images/image.jpg", srcset: { "media/images/image-2x.jpg" => "2x" })
   end
 
   def test_favicon_pack_tag

data/test/mounted_app/Rakefile

@@ -0,0 +1,4 @@
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"

data/test/mounted_app/test/dummy/Rakefile

@@ -0,0 +1,3 @@
+require_relative "config/application"
+
+Rails.application.load_tasks

data/test/mounted_app/test/dummy/bin/rails

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path("../config/application", __dir__)
+require "rails/commands"

data/test/mounted_app/test/dummy/bin/rake

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require "rake"
+Rake.application.run

data/test/mounted_app/test/dummy/config.ru

@@ -0,0 +1,5 @@
+# This file allows the `Rails.root` to be correctly determined.
+
+require_relative "config/environment"
+
+run Rails.application

data/test/mounted_app/test/dummy/config/application.rb

@@ -0,0 +1,10 @@
+require "action_controller/railtie"
+require "action_view/railtie"
+require "webpacker"
+
+module TestDummyApp
+  class Application < Rails::Application
+    config.secret_key_base = "abcdef"
+    config.eager_load = true
+  end
+end

data/test/mounted_app/test/dummy/config/environment.rb

@@ -0,0 +1,3 @@
+require_relative "application"
+
+Rails.application.initialize!

data/test/mounted_app/test/dummy/config/webpacker.yml

@@ -0,0 +1,75 @@
+# Note: You must restart bin/webpack-dev-server for changes to take effect
+
+default: &default
+  source_path: app/javascript
+  source_entry_path: packs
+  public_output_path: packs
+  cache_path: tmp/cache/webpacker
+
+  # Additional paths webpack should lookup modules
+  # ['app/assets', 'engine/foo/app/assets']
+  additional_paths:
+    - app/assets
+    - /etc/yarn
+
+  # Reload manifest.json on all requests so we reload latest compiled packs
+  cache_manifest: false
+
+  extensions:
+    - .js
+    - .sass
+    - .scss
+    - .css
+    - .module.sass
+    - .module.scss
+    - .module.css
+    - .png
+    - .svg
+    - .gif
+    - .jpeg
+    - .jpg
+
+development:
+  <<: *default
+  compile: true
+
+  # Reference: https://webpack.js.org/configuration/dev-server/
+  dev_server:
+    https: false
+    host: localhost
+    port: 3035
+    public: localhost:3035
+    hmr: false
+    # Inline should be set to true if using HMR
+    inline: true
+    overlay: true
+    disable_host_check: true
+    use_local_ip: 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