webpacker 3.6.0 → 4.0.2

data/lib/tasks/installers.rake

@@ -13,6 +13,8 @@ dependencies = {
   "Angular": [:typescript]
 }
 
+bin_path = ENV["BUNDLE_BIN"] || "./bin"
+
 namespace :webpacker do
   namespace :install do
     installers.each do |name, task_name|
@@ -21,9 +23,9 @@ namespace :webpacker do
         template = File.expand_path("../install/#{task_name}.rb", __dir__)
         base_path =
           if Rails::VERSION::MAJOR >= 5
-            "#{RbConfig.ruby} ./bin/rails app:template"
+            "#{RbConfig.ruby} #{bin_path}/rails app:template"
           else
-            "#{RbConfig.ruby} ./bin/rake rails:template"
+            "#{RbConfig.ruby} #{bin_path}/rake rails:template"
           end
 
         dependencies[name] ||= []

data/lib/tasks/webpacker/binstubs.rake

@@ -1,12 +1,13 @@
 binstubs_template_path = File.expand_path("../../install/binstubs.rb", __dir__).freeze
+bin_path = ENV["BUNDLE_BIN"] || "./bin"
 
 namespace :webpacker do
   desc "Installs Webpacker binstubs in this application"
   task binstubs: [:check_node, :check_yarn] do
     if Rails::VERSION::MAJOR >= 5
-      exec "#{RbConfig.ruby} ./bin/rails app:template LOCATION=#{binstubs_template_path}"
+      exec "#{RbConfig.ruby} #{bin_path}/rails app:template LOCATION=#{binstubs_template_path}"
     else
-      exec "#{RbConfig.ruby} ./bin/rake rails:template LOCATION=#{binstubs_template_path}"
+      exec "#{RbConfig.ruby} #{bin_path}/rake rails:template LOCATION=#{binstubs_template_path}"
     end
   end
 end

data/lib/tasks/webpacker/compile.rake

@@ -8,12 +8,17 @@ ensure
   Webpacker.logger = old_logger
 end
 
+def yarn_install_available?
+  rails_major = Rails::VERSION::MAJOR
+  rails_minor = Rails::VERSION::MINOR
+
+  rails_major > 5 || (rails_major == 5 && rails_minor >= 1)
+end
+
 def enhance_assets_precompile
-  Rake::Task["assets:precompile"].enhance do
-    unless Rake::Task.task_defined?("yarn:install")
-      # For Rails < 5.1
-      Rake::Task["webpacker:yarn_install"].invoke
-    end
+  # yarn:install was added in Rails 5.1
+  deps = yarn_install_available? ? [] : ["webpacker:yarn_install"]
+  Rake::Task["assets:precompile"].enhance(deps) do
     Rake::Task["webpacker:compile"].invoke
   end
 end

data/lib/tasks/webpacker/install.rake

@@ -1,12 +1,13 @@
 install_template_path = File.expand_path("../../install/template.rb", __dir__).freeze
+bin_path = ENV["BUNDLE_BIN"] || "./bin"
 
 namespace :webpacker do
   desc "Install Webpacker in this application"
   task install: [:check_node, :check_yarn] do
     if Rails::VERSION::MAJOR >= 5
-      exec "#{RbConfig.ruby} ./bin/rails app:template LOCATION=#{install_template_path}"
+      exec "#{RbConfig.ruby} #{bin_path}/rails app:template LOCATION=#{install_template_path}"
     else
-      exec "#{RbConfig.ruby} ./bin/rake rails:template LOCATION=#{install_template_path}"
+      exec "#{RbConfig.ruby} #{bin_path}/rake rails:template LOCATION=#{install_template_path}"
     end
   end
 end

data/lib/tasks/webpacker/verify_install.rake

@@ -3,10 +3,7 @@ require "webpacker/configuration"
 namespace :webpacker do
   desc "Verifies if Webpacker is installed"
   task verify_install: [:check_node, :check_yarn, :check_binstubs] do
-    if Webpacker.config.config_path.exist?
-      $stdout.puts "Webpacker is installed 🎉 🍰"
-      $stdout.puts "Using #{Webpacker.config.config_path} file for setting up webpack paths"
-    else
+    unless Webpacker.config.config_path.exist?
       $stderr.puts "Configuration config/webpacker.yml file not found. \n"\
            "Make sure webpacker:install is run successfully before " \
            "running dependent tasks"

data/lib/tasks/webpacker/yarn_install.rake

@@ -1,6 +1,6 @@
 namespace :webpacker do
   desc "Support for older Rails versions. Install all JavaScript dependencies as specified via Yarn"
   task :yarn_install do
-    system "yarn install --no-progress --production"
+    system "yarn install --no-progress"
   end
 end

data/lib/webpacker/commands.rb

@@ -11,7 +11,6 @@ class Webpacker::Commands
   end
 
   def bootstrap
-    config.refresh
     manifest.refresh
   end
 

data/lib/webpacker/compiler.rb

@@ -10,7 +10,7 @@ class Webpacker::Compiler
   # Webpacker::Compiler.env['FRONTEND_API_KEY'] = 'your_secret_key'
   cattr_accessor(:env) { {} }
 
-  delegate :config, :logger, to: :@webpacker
+  delegate :config, :logger, to: :webpacker
 
   def initialize(webpacker)
     @webpacker = webpacker
@@ -18,9 +18,8 @@ class Webpacker::Compiler
 
   def compile
     if stale?
-      record_compilation_digest
       run_webpack.tap do |success|
-        remove_compilation_digest if !success
+        record_compilation_digest if success
       end
     else
       true
@@ -38,8 +37,11 @@ class Webpacker::Compiler
   end
 
   private
+    attr_reader :webpacker
+
     def last_compilation_digest
       compilation_digest_path.read if compilation_digest_path.exist? && config.public_manifest_path.exist?
+    rescue Errno::ENOENT, Errno::ENOTDIR
     end
 
     def watched_files_digest
@@ -53,16 +55,16 @@ class Webpacker::Compiler
       compilation_digest_path.write(watched_files_digest)
     end
 
-    def remove_compilation_digest
-      compilation_digest_path.delete if compilation_digest_path.exist?
-    end
-
     def run_webpack
       logger.info "Compiling…"
 
-      stdout, sterr , status = Open3.capture3(webpack_env, "#{RbConfig.ruby} ./bin/webpack")
+      stdout, sterr , status = Open3.capture3(
+        webpack_env,
+        "#{RbConfig.ruby} ./bin/webpack",
+        chdir: File.expand_path(config.root_path)
+      )
 
-      if status.success?
+      if sterr == "" && status.success?
         logger.info "Compiled all packs in #{config.public_output_path}"
         logger.info stdout if config.webpack_compile_output?
       else
@@ -75,18 +77,20 @@ class Webpacker::Compiler
     def default_watched_paths
       [
         *config.resolved_paths_globbed,
-        "#{config.source_path.relative_path_from(Rails.root)}/**/*",
+        "#{config.source_path.relative_path_from(config.root_path)}/**/*",
         "yarn.lock", "package.json",
         "config/webpack/**/*"
       ].freeze
     end
 
     def compilation_digest_path
-      config.cache_path.join(".last-compilation-digest-#{Webpacker.env}")
+      config.cache_path.join("last-compilation-digest-#{webpacker.env}")
     end
 
     def webpack_env
-      env.merge("WEBPACKER_ASSET_HOST"        => ActionController::Base.helpers.compute_asset_host,
-                "WEBPACKER_RELATIVE_URL_ROOT" => ActionController::Base.relative_url_root)
+      return env unless defined?(ActionController::Base)
+
+      env.merge("WEBPACKER_ASSET_HOST"        => ENV.fetch("WEBPACKER_ASSET_HOST", ActionController::Base.helpers.compute_asset_host),
+                "WEBPACKER_RELATIVE_URL_ROOT" => ENV.fetch("WEBPACKER_RELATIVE_URL_ROOT", ActionController::Base.relative_url_root))
     end
 end

data/lib/webpacker/configuration.rb

@@ -11,10 +11,6 @@ class Webpacker::Configuration
     @env = env
   end
 
-  def refresh
-    @data = load
-  end
-
   def dev_server
     fetch(:dev_server)
   end
@@ -40,7 +36,7 @@ class Webpacker::Configuration
   end
 
   def public_path
-    root_path.join("public")
+    root_path.join(fetch(:public_root_path))
   end
 
   def public_output_path
@@ -63,10 +59,22 @@ class Webpacker::Configuration
     fetch(:extensions)
   end
 
+  def check_yarn_integrity=(value)
+    data[:check_yarn_integrity] = value
+  end
+
+  def check_yarn_integrity?
+    fetch(:check_yarn_integrity)
+  end
+
   def webpack_compile_output?
     fetch(:webpack_compile_output)
   end
 
+  def extract_css?
+    fetch(:extract_css)
+  end
+
   private
     def fetch(key)
       data.fetch(key, defaults[key])

data/lib/webpacker/dev_server.rb

@@ -1,4 +1,6 @@
 class Webpacker::DevServer
+  DEFAULT_ENV_PREFIX = "WEBPACKER_DEV_SERVER".freeze
+
   # Configure dev server connection timeout (in seconds), default: 0.01
   # Webpacker.dev_server.connect_timeout = 1
   cattr_accessor(:connect_timeout) { 0.01 }
@@ -20,15 +22,6 @@ class Webpacker::DevServer
     false
   end
 
-  def hot_module_replacing?
-    case fetch(:hmr)
-    when true, "true"
-      true
-    else
-      false
-    end
-  end
-
   def host
     fetch(:host)
   end
@@ -58,9 +51,13 @@ class Webpacker::DevServer
     fetch(:pretty)
   end
 
+  def env_prefix
+    config.dev_server.fetch(:env_prefix, DEFAULT_ENV_PREFIX)
+  end
+
   private
     def fetch(key)
-      ENV["WEBPACKER_DEV_SERVER_#{key.upcase}"] || config.dev_server.fetch(key, defaults[key])
+      ENV["#{env_prefix}_#{key.upcase}"] || config.dev_server.fetch(key, defaults[key])
     end
 
     def defaults

data/lib/webpacker/dev_server_proxy.rb

@@ -1,18 +1,25 @@
 require "rack/proxy"
 
 class Webpacker::DevServerProxy < Rack::Proxy
+  delegate :config, :dev_server, to: :@webpacker
+
+  def initialize(app = nil, opts = {})
+    @webpacker = opts.delete(:webpacker) || Webpacker.instance
+    super
+  end
+
   def rewrite_response(response)
     _status, headers, _body = response
     headers.delete "transfer-encoding"
-    headers.delete "content-length" if Webpacker.dev_server.running? && Webpacker.dev_server.https?
+    headers.delete "content-length" if dev_server.running? && dev_server.https?
     response
   end
 
   def perform_request(env)
-    if env["PATH_INFO"].start_with?("/#{public_output_uri_path}") && Webpacker.dev_server.running?
-      env["HTTP_HOST"] = env["HTTP_X_FORWARDED_HOST"] = env["HTTP_X_FORWARDED_SERVER"] = Webpacker.dev_server.host_with_port
-      env["HTTP_X_FORWARDED_PROTO"] = env["HTTP_X_FORWARDED_SCHEME"] = Webpacker.dev_server.protocol
-      unless Webpacker.dev_server.https?
+    if env["PATH_INFO"].start_with?("/#{public_output_uri_path}") && dev_server.running?
+      env["HTTP_HOST"] = env["HTTP_X_FORWARDED_HOST"] = env["HTTP_X_FORWARDED_SERVER"] = dev_server.host_with_port
+      env["HTTP_X_FORWARDED_PROTO"] = env["HTTP_X_FORWARDED_SCHEME"] = dev_server.protocol
+      unless dev_server.https?
         env["HTTPS"] = env["HTTP_X_FORWARDED_SSL"] = "off"
       end
       env["SCRIPT_NAME"] = ""
@@ -25,6 +32,6 @@ class Webpacker::DevServerProxy < Rack::Proxy
 
   private
     def public_output_uri_path
-      Webpacker.config.public_output_path.relative_path_from(Webpacker.config.public_path)
+      config.public_output_path.relative_path_from(config.public_path)
     end
 end

data/lib/webpacker/dev_server_runner.rb

@@ -44,16 +44,23 @@ module Webpacker
       end
 
       def execute_cmd
-        env = { "NODE_PATH" => @node_modules_path.shellescape }
-        cmd = [
-          "#{@node_modules_path}/.bin/webpack-dev-server",
-          "--config", @webpack_config
-        ]
+        env = Webpacker::Compiler.env
+
+        cmd = if node_modules_bin_exist?
+          ["#{@node_modules_bin_path}/webpack-dev-server"]
+        else
+          ["yarn", "webpack-dev-server"]
+        end
+        cmd += ["--config", @webpack_config]
         cmd += ["--progress", "--color"] if @pretty
 
         Dir.chdir(@app_path) do
-          exec env, *cmd
+          Kernel.exec env, *cmd
         end
       end
+
+      def node_modules_bin_exist?
+        File.exist?("#{@node_modules_bin_path}/webpack-dev-server")
+      end
   end
 end

data/lib/webpacker/helper.rb

@@ -1,35 +1,42 @@
 module Webpacker::Helper
+  # Returns current Webpacker instance.
+  # Could be overriden to use multiple Webpacker
+  # configurations within the same app (e.g. with engines)
+  def current_webpacker_instance
+    Webpacker.instance
+  end
+
   # Computes the relative path for a given Webpacker asset.
-  # Return relative path using manifest.json and passes it to asset_path helper
+  # Return relative path using manifest.json and passes it to asset_path helper.
   # This will use asset_path internally, so most of their behaviors will be the same.
   #
   # Example:
   #
-  #   # In development mode with hot module replacement:
+  #   # When extract_css is false in webpacker.yml and the file is a css:
   #   <%= asset_pack_path 'calendar.css' %>  # => nil
   #
-  #   # In production mode:
+  #   # When extract_css is true in webpacker.yml or the file is not a css:
   #   <%= asset_pack_path 'calendar.css' %> # => "/packs/calendar-1016838bab065ae1e122.css"
   def asset_pack_path(name, **options)
-    unless stylesheet?(name) && Webpacker.dev_server.running? && Webpacker.dev_server.hot_module_replacing?
-      asset_path(Webpacker.manifest.lookup!(name), **options)
+    if current_webpacker_instance.config.extract_css? || !stylesheet?(name)
+      asset_path(current_webpacker_instance.manifest.lookup!(name), **options)
     end
   end
 
   # Computes the absolute path for a given Webpacker asset.
-  # Return absolute path using manifest.json and passes it to asset_url helper
+  # Return absolute path using manifest.json and passes it to asset_url helper.
   # This will use asset_url internally, so most of their behaviors will be the same.
   #
   # Example:
   #
-  #   # In development mode with hot module replacement:
+  #   # When extract_css is false in webpacker.yml and the file is a css:
   #   <%= asset_pack_url 'calendar.css' %> # => nil
   #
-  #   # In production mode:
+  #   # When extract_css is true in webpacker.yml or the file is not a css:
   #   <%= asset_pack_url 'calendar.css' %> # => "http://example.com/packs/calendar-1016838bab065ae1e122.css"
   def asset_pack_url(name, **options)
-    unless Webpacker.dev_server.running? && Webpacker.dev_server.hot_module_replacing?
-      asset_url(Webpacker.manifest.lookup!(name), **options)
+    if current_webpacker_instance.config.extract_css? || !stylesheet?(name)
+      asset_url(current_webpacker_instance.manifest.lookup!(name), **options)
     end
   end
 
@@ -40,7 +47,7 @@ module Webpacker::Helper
   #  <%= image_pack_tag 'application.png', size: '16x10', alt: 'Edit Entry' %>
   #  <img alt='Edit Entry' src='/packs/application-k344a6d59eef8632c9d1.png' width='16' height='10' />
   def image_pack_tag(name, **options)
-    image_tag(asset_path(Webpacker.manifest.lookup!(name)), **options)
+    image_tag(resolve_path_to_image(name), **options)
   end
 
   # Creates a script tag that references the named pack file, as compiled by webpack per the entries list
@@ -52,7 +59,29 @@ module Webpacker::Helper
   #   <%= javascript_pack_tag 'calendar', 'data-turbolinks-track': 'reload' %> # =>
   #   <script src="/packs/calendar-1016838bab065ae1e314.js" data-turbolinks-track="reload"></script>
   def javascript_pack_tag(*names, **options)
-    javascript_include_tag(*sources_from_pack_manifest(names, type: :javascript), **options)
+    javascript_include_tag(*sources_from_manifest_entries(names, type: :javascript), **options)
+  end
+
+  # Creates script tags that references the js chunks from entrypoints when using split chunks API,
+  # as compiled by webpack per the entries list in config/webpack/shared.js.
+  # By default, this list is auto-generated to match everything in
+  # app/javascript/packs/*.js and all the dependent chunks. In production mode, the digested reference is automatically looked up.
+  # See: https://webpack.js.org/plugins/split-chunks-plugin/
+  # Example:
+  #
+  #   <%= javascript_packs_with_chunks_tag 'calendar', 'map', 'data-turbolinks-track': 'reload' %> # =>
+  #   <script src="/packs/vendor-16838bab065ae1e314.chunk.js" data-turbolinks-track="reload"></script>
+  #   <script src="/packs/calendar~runtime-16838bab065ae1e314.chunk.js" data-turbolinks-track="reload"></script>
+  #   <script src="/packs/calendar-1016838bab065ae1e314.chunk.js" data-turbolinks-track="reload"></script>
+  #   <script src="/packs/map~runtime-16838bab065ae1e314.chunk.js" data-turbolinks-track="reload"></script>
+  #   <script src="/packs/map-16838bab065ae1e314.chunk.js" data-turbolinks-track="reload"></script>
+  # DO:
+  # <%= javascript_packs_with_chunks_tag 'calendar', 'map' %>
+  # DON'T:
+  # <%= javascript_packs_with_chunks_tag 'calendar' %>
+  # <%= javascript_packs_with_chunks_tag 'map' %>
+  def javascript_packs_with_chunks_tag(*names, **options)
+    javascript_include_tag(*sources_from_manifest_entrypoints(names, type: :javascript), **options)
   end
 
   # Creates a link tag that references the named pack file, as compiled by webpack per the entries list
@@ -64,16 +93,38 @@ module Webpacker::Helper
   #
   # Examples:
   #
-  #   # In development mode with hot module replacement:
+  #   # When extract_css is false in webpacker.yml:
   #   <%= stylesheet_pack_tag 'calendar', 'data-turbolinks-track': 'reload' %> # =>
   #   nil
   #
-  #   # In production mode:
+  #   # When extract_css is true in webpacker.yml:
   #   <%= stylesheet_pack_tag 'calendar', 'data-turbolinks-track': 'reload' %> # =>
   #   <link rel="stylesheet" media="screen" href="/packs/calendar-1016838bab065ae1e122.css" data-turbolinks-track="reload" />
   def stylesheet_pack_tag(*names, **options)
-    unless Webpacker.dev_server.running? && Webpacker.dev_server.hot_module_replacing?
-      stylesheet_link_tag(*sources_from_pack_manifest(names, type: :stylesheet), **options)
+    if current_webpacker_instance.config.extract_css?
+      stylesheet_link_tag(*sources_from_manifest_entries(names, type: :stylesheet), **options)
+    end
+  end
+
+  # Creates link tags that references the css chunks from entrypoints when using split chunks API,
+  # as compiled by webpack per the entries list in config/webpack/shared.js.
+  # By default, this list is auto-generated to match everything in
+  # app/javascript/packs/*.js and all the dependent chunks. In production mode, the digested reference is automatically looked up.
+  # See: https://webpack.js.org/plugins/split-chunks-plugin/
+  # Example:
+  #
+  #   <%= stylesheet_packs_with_chunks_tag 'calendar', 'map' %> # =>
+  #   <link rel="stylesheet" media="screen" href="/packs/3-8c7ce31a.chunk.css" />
+  #   <link rel="stylesheet" media="screen" href="/packs/calendar-8c7ce31a.chunk.css" />
+  #   <link rel="stylesheet" media="screen" href="/packs/map-8c7ce31a.chunk.css" />
+  # DO:
+  # <%= stylesheet_packs_with_chunks_tag 'calendar', 'map' %>
+  # DON'T:
+  # <%= stylesheet_packs_with_chunks_tag 'calendar' %>
+  # <%= stylesheet_packs_with_chunks_tag 'map' %>
+  def stylesheet_packs_with_chunks_tag(*names, **options)
+    if current_webpacker_instance.config.extract_css?
+      stylesheet_link_tag(*sources_from_manifest_entrypoints(names, type: :stylesheet), **options)
     end
   end
 
@@ -82,11 +133,18 @@ module Webpacker::Helper
       File.extname(name) == ".css"
     end
 
-    def sources_from_pack_manifest(names, type:)
-      names.map { |name| Webpacker.manifest.lookup!(pack_name_with_extension(name, type: type)) }
+    def sources_from_manifest_entries(names, type:)
+      names.map { |name| current_webpacker_instance.manifest.lookup!(name, type: type) }.flatten
+    end
+
+    def sources_from_manifest_entrypoints(names, type:)
+      names.map { |name| current_webpacker_instance.manifest.lookup_pack_with_chunks!(name, type: type) }.flatten.uniq
     end
 
-    def pack_name_with_extension(name, type:)
-      "#{name}#{compute_asset_extname(name, type: type)}"
+    def resolve_path_to_image(name)
+      path = name.starts_with?("media/images/") ? name : "media/images/#{name}"
+      asset_path(current_webpacker_instance.manifest.lookup!(path))
+    rescue
+      asset_path(current_webpacker_instance.manifest.lookup!(name))
     end
 end