webpacker 4.2.0 → 5.1.0

data/lib/install/template.rb

@@ -1,7 +1,7 @@
 # Install Webpacker
 copy_file "#{__dir__}/config/webpacker.yml", "config/webpacker.yml"
 
-puts "Copying webpack core config"
+say "Copying webpack core config"
 directory "#{__dir__}/config/webpack", "config/webpack"
 
 say "Copying postcss.config.js to app root directory"
@@ -36,7 +36,7 @@ end
 
 if Webpacker::VERSION =~ /^[0-9]+\.[0-9]+\.[0-9]+$/
   say "Installing all JavaScript dependencies [#{Webpacker::VERSION}]"
-  run "yarn add @rails/webpacker"
+  run "yarn add @rails/webpacker@#{Webpacker::VERSION}"
 else
   say "Installing all JavaScript dependencies [from prerelease rails/webpacker]"
   run "yarn add @rails/webpacker@next"

data/lib/install/typescript.rb

@@ -15,17 +15,10 @@ if File.exist?(package_json)
   end
 end
 
-say "Copying typescript loader to config/webpack/loaders"
-copy_file "#{__dir__}/loaders/typescript.js", Rails.root.join("config/webpack/loaders/typescript.js").to_s
-
-say "Adding typescript loader to config/webpack/environment.js"
-insert_into_file Rails.root.join("config/webpack/environment.js").to_s,
-  "const typescript =  require('./loaders/typescript')\n",
-  after: /require\(('|")@rails\/webpacker\1\);?\n/
-
-insert_into_file Rails.root.join("config/webpack/environment.js").to_s,
-  "environment.loaders.prepend('typescript', typescript)\n",
-  before: "module.exports"
+say "Adding TypeScript preset to babel.config.js"
+insert_into_file Rails.root.join("babel.config.js").to_s,
+  ",\n      ['@babel/preset-typescript', { 'allExtensions': true, 'isTSX': true }]",
+  before: /\s*\].filter\(Boolean\),\n\s*plugins: \[/
 
 say "Copying tsconfig.json to the Rails root directory for typescript"
 copy_file "#{__dir__}/examples/#{example_source}/tsconfig.json", "tsconfig.json"
@@ -41,6 +34,9 @@ copy_file "#{__dir__}/examples/typescript/hello_typescript.ts",
   "#{Webpacker.config.source_entry_path}/hello_typescript.ts"
 
 say "Installing all typescript dependencies"
-run "yarn add typescript ts-loader #{additional_packages}"
+run "yarn add typescript #{additional_packages}"
+
+say "Installing all typescript dev-dependencies"
+run "yarn add @babel/preset-typescript babel-preset-typescript-vue -D"
 
 say "Webpacker now supports typescript 🎉", :green

data/lib/tasks/webpacker/check_node.rake

@@ -1,3 +1,4 @@
+require "semantic_range"
 namespace :webpacker do
   desc "Verifies if Node.js is installed"
   task :check_node do
@@ -6,19 +7,25 @@ namespace :webpacker do
       raise Errno::ENOENT if node_version.blank?
 
       pkg_path = Pathname.new("#{__dir__}/../../../package.json").realpath
-      node_requirement = JSON.parse(pkg_path.read)["engines"]["node"]
+      node_range = JSON.parse(pkg_path.read)["engines"]["node"]
+      is_valid = SemanticRange.satisfies?(node_version, node_range) rescue false
+      semver_major = node_version[/\d+/] rescue nil
+      is_unstable = semver_major.to_i.odd? rescue false
 
-      requirement = Gem::Requirement.new(node_requirement)
-      version = Gem::Version.new(node_version.strip.tr("v", ""))
+      if is_unstable
+        $stderr.puts "Warning: you are using an unstable release of Node.js (#{node_version}). If you encounter issues with Node.js, consider switching to an Active LTS release. More info: https://docs.npmjs.com/try-the-latest-stable-version-of-node"
+      end
 
-      unless requirement.satisfied_by?(version)
-        $stderr.puts "Webpacker requires Node.js #{requirement} and you are using #{version}"
+      unless is_valid
+        $stderr.puts "Webpacker requires Node.js \"#{node_range}\" and you are using #{node_version}"
         $stderr.puts "Please upgrade Node.js https://nodejs.org/en/download/"
-        $stderr.puts "Exiting!" && exit!
+        $stderr.puts "Exiting!"
+        exit!
       end
     rescue Errno::ENOENT
       $stderr.puts "Node.js not installed. Please download and install Node.js https://nodejs.org/en/download/"
-      $stderr.puts "Exiting!" && exit!
+      $stderr.puts "Exiting!"
+      exit!
     end
   end
 end

data/lib/tasks/webpacker/check_yarn.rake

@@ -1,3 +1,4 @@
+require "semantic_range"
 namespace :webpacker do
   desc "Verifies if Yarn is installed"
   task :check_yarn do
@@ -6,19 +7,25 @@ namespace :webpacker do
       raise Errno::ENOENT if yarn_version.blank?
 
       pkg_path = Pathname.new("#{__dir__}/../../../package.json").realpath
-      yarn_requirement = JSON.parse(pkg_path.read)["engines"]["yarn"]
+      yarn_range = JSON.parse(pkg_path.read)["engines"]["yarn"]
+      is_valid = SemanticRange.satisfies?(yarn_version, yarn_range) rescue false
+      is_unsupported = SemanticRange.satisfies?(yarn_version, ">=2.0.0") rescue false
 
-      requirement = Gem::Requirement.new(yarn_requirement)
-      version = Gem::Version.new(yarn_version)
-
-      unless requirement.satisfied_by?(version)
-        $stderr.puts "Webpacker requires Yarn #{requirement} and you are using #{version}"
-        $stderr.puts "Please upgrade Yarn https://yarnpkg.com/lang/en/docs/install/"
-        $stderr.puts "Exiting!" && exit!
+      unless is_valid
+        $stderr.puts "Webpacker requires Yarn \"#{yarn_range}\" and you are using #{yarn_version}"
+        if is_unsupported
+          $stderr.puts "This version of Webpacker does not support Yarn #{yarn_version}. Please downgrade to a supported version of Yarn https://yarnpkg.com/lang/en/docs/install/"
+          $stderr.puts "For information on using Webpacker with Yarn 2.0, see https://github.com/rails/webpacker/issues/2112"
+        else
+          $stderr.puts "Please upgrade Yarn https://yarnpkg.com/lang/en/docs/install/"
+        end
+        $stderr.puts "Exiting!"
+        exit!
       end
     rescue Errno::ENOENT
       $stderr.puts "Yarn not installed. Please download and install Yarn from https://yarnpkg.com/lang/en/docs/install/"
-      $stderr.puts "Exiting!" && exit!
+      $stderr.puts "Exiting!"
+      exit!
     end
   end
 end

data/lib/tasks/webpacker/clean.rake

@@ -1,15 +1,25 @@
+$stdout.sync = true
+
 require "webpacker/configuration"
 
 namespace :webpacker do
   desc "Remove old compiled webpacks"
-  task :clean, [:keep] => ["webpacker:verify_install", :environment] do |_, args|
-    Webpacker.clean(Integer(args.keep || 2))
+  task :clean, [:keep, :age] => ["webpacker:verify_install", :environment] do |_, args|
+    Webpacker.ensure_log_goes_to_stdout do
+      Webpacker.clean(Integer(args.keep || 2), Integer(args.age || 3600))
+    end
   end
 end
 
-# Run clean if the assets:clean is run
-if Rake::Task.task_defined?("assets:clean")
-  Rake::Task["assets:clean"].enhance do
-    Rake::Task["webpacker:clean"].invoke
+skip_webpacker_clean = %w(no false n f).include?(ENV["WEBPACKER_PRECOMPILE"])
+
+unless skip_webpacker_clean
+  # Run clean if the assets:clean is run
+  if Rake::Task.task_defined?("assets:clean")
+    Rake::Task["assets:clean"].enhance do
+      Rake::Task["webpacker:clean"].invoke
+    end
+  else
+    Rake::Task.define_task("assets:clean" => "webpacker:clean")
   end
 end

data/lib/tasks/webpacker/clobber.rake

@@ -8,9 +8,13 @@ namespace :webpacker do
   end
 end
 
-# Run clobber if the assets:clobber is run
-if Rake::Task.task_defined?("assets:clobber")
-  Rake::Task["assets:clobber"].enhance do
-    Rake::Task["webpacker:clobber"].invoke
+skip_webpacker_clobber = %w(no false n f).include?(ENV["WEBPACKER_PRECOMPILE"])
+
+unless skip_webpacker_clobber
+  # Run clobber if the assets:clobber is run
+  if Rake::Task.task_defined?("assets:clobber")
+    Rake::Task["assets:clobber"].enhance do
+      Rake::Task["webpacker:clobber"].invoke
+    end
   end
 end

data/lib/tasks/webpacker/compile.rake

@@ -1,13 +1,5 @@
 $stdout.sync = true
 
-def ensure_log_goes_to_stdout
-  old_logger = Webpacker.logger
-  Webpacker.logger = ActiveSupport::Logger.new(STDOUT)
-  yield
-ensure
-  Webpacker.logger = old_logger
-end
-
 def yarn_install_available?
   rails_major = Rails::VERSION::MAJOR
   rails_minor = Rails::VERSION::MINOR
@@ -27,7 +19,7 @@ namespace :webpacker do
   desc "Compile JavaScript packs using webpack for production with digests"
   task compile: ["webpacker:verify_install", :environment] do
     Webpacker.with_node_env(ENV.fetch("NODE_ENV", "production")) do
-      ensure_log_goes_to_stdout do
+      Webpacker.ensure_log_goes_to_stdout do
         if Webpacker.compile
           # Successful compilation!
         else

data/lib/tasks/webpacker/yarn_install.rake

@@ -1,21 +1,10 @@
 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"
-
-    exit(1) unless $?.success?
+    valid_node_envs = %w[test development production]
+    node_env = ENV.fetch("NODE_ENV") do
+      valid_node_envs.include?(Rails.env) ? Rails.env : "production"
+    end
+    system({ "NODE_ENV" => node_env }, "yarn install --no-progress --frozen-lockfile")
   end
 end
-
-def enhance_yarn_install
-  Rake::Task["yarn:install"].enhance do
-    exit(1) unless $?.success?
-  end
-end
-
-if Rake::Task.task_defined?("yarn:install")
-  enhance_yarn_install
-else
-  # this is mainly for pre-5.x era
-  Rake::Task.define_task("yarn:install" => "webpacker:yarn_install")
-end

data/lib/webpacker.rb

@@ -22,6 +22,14 @@ module Webpacker
     ENV["NODE_ENV"] = original
   end
 
+  def ensure_log_goes_to_stdout
+    old_logger = Webpacker.logger
+    Webpacker.logger = ActiveSupport::Logger.new(STDOUT)
+    yield
+  ensure
+    Webpacker.logger = old_logger
+  end
+
   delegate :logger, :logger=, :env, to: :instance
   delegate :config, :compiler, :manifest, :commands, :dev_server, to: :instance
   delegate :bootstrap, :clean, :clobber, :compile, to: :commands

data/lib/webpacker/commands.rb

@@ -1,25 +1,41 @@
 class Webpacker::Commands
-  delegate :config, :compiler, :manifest, to: :@webpacker
+  delegate :config, :compiler, :manifest, :logger, to: :@webpacker
 
   def initialize(webpacker)
     @webpacker = webpacker
   end
 
-  def clean(count_to_keep = 2)
+  # Cleanup old assets in the compile directory. By default it will
+  # keep the latest version, 2 backups created within the past hour.
+  #
+  # Examples
+  #
+  #   To force only 1 backup to be kept, set count=1 and age=0.
+  #
+  #   To only keep files created within the last 10 minutes, set count=0 and
+  #   age=600.
+  #
+  def clean(count = 2, age = 3600)
     if config.public_output_path.exist? && config.public_manifest_path.exist?
-      files_in_manifest = process_manifest_hash(manifest.refresh)
-      files_to_be_removed = files_in_manifest.flat_map do |file_in_manifest|
-        file_prefix, file_ext = file_in_manifest.scan(/(.*)[0-9a-f]{20}(.*)/).first
-        versions_of_file = Dir.glob("#{file_prefix}*#{file_ext}").grep(/#{file_prefix}[0-9a-f]{20}#{file_ext}/)
-        versions_of_file.map do |version_of_file|
-          next if version_of_file == file_in_manifest
-
-          [version_of_file, File.mtime(version_of_file).utc.to_i]
-        end.compact.sort_by(&:last).reverse.drop(count_to_keep).map(&:first)
-      end
-
-      files_to_be_removed.each { |f| File.delete f }
+      versions
+        .sort
+        .reverse
+        .each_with_index
+        .drop_while do |(mtime, _), index|
+          max_age = [0, Time.now - Time.at(mtime)].max
+          max_age < age && index < count
+        end
+        .each do |(_, files), index|
+          files.each do |file|
+            if File.file?(file)
+              File.delete(file)
+              logger.info "Removed #{file}"
+            end
+          end
+        end
     end
+
+    true
   end
 
   def clobber
@@ -38,11 +54,21 @@ class Webpacker::Commands
   end
 
   private
-    def process_manifest_hash(manifest_hash)
-      manifest_hash.values.map do |value|
-        next process_manifest_hash(value) if value.is_a?(Hash)
+    def versions
+      all_files       = Dir.glob("#{config.public_output_path}/**/*")
+      manifest_config = Dir.glob("#{config.public_manifest_path}*")
+
+      packs = all_files - manifest_config - current_version
+      packs.reject { |file| File.directory?(file) }.group_by { |file| File.mtime(file).utc.to_i }
+    end
+
+    def current_version
+      packs = manifest.refresh.values.map do |value|
+        next if value.is_a?(Hash)
+
+        File.join(config.root_path, "public", "#{value}*")
+      end.compact
 
-        File.join(config.root_path, "public", value)
-      end.flatten
+      Dir.glob(packs).uniq
     end
 end

data/lib/webpacker/compiler.rb

@@ -20,9 +20,8 @@ class Webpacker::Compiler
     if stale?
       run_webpack.tap do |success|
         # We used to only record the digest on success
-        # However, the output file is still written on error, (at least with ts-loader), 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.
+        # 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

data/lib/webpacker/configuration.rb

@@ -64,11 +64,7 @@ class Webpacker::Configuration
   end
 
   def check_yarn_integrity=(value)
-    data[:check_yarn_integrity] = value
-  end
-
-  def check_yarn_integrity?
-    fetch(:check_yarn_integrity)
+    warn "Webpacker::Configuration#check_yarn_integrity=(value) has been deprecated. The integrity check has been removed from Webpacker so changing this setting will have no effect."
   end
 
   def webpack_compile_output?

data/lib/webpacker/dev_server_proxy.rb

@@ -11,7 +11,9 @@ class Webpacker::DevServerProxy < Rack::Proxy
 
   def perform_request(env)
     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_HOST"] = env["HTTP_X_FORWARDED_HOST"] = dev_server.host
+      env["HTTP_X_FORWARDED_SERVER"] = dev_server.host_with_port
+      env["HTTP_PORT"] = env["HTTP_X_FORWARDED_PORT"] = dev_server.port.to_s
       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"

data/lib/webpacker/dev_server_runner.rb

@@ -16,20 +16,20 @@ module Webpacker
       def load_config
         app_root = Pathname.new(@app_path)
 
-        config = Configuration.new(
+        @config = Configuration.new(
           root_path: app_root,
           config_path: app_root.join("config/webpacker.yml"),
           env: ENV["RAILS_ENV"]
         )
 
-        dev_server = DevServer.new(config)
+        dev_server = DevServer.new(@config)
 
         @hostname          = dev_server.host
         @port              = dev_server.port
         @pretty            = dev_server.pretty?
 
       rescue Errno::ENOENT, NoMethodError
-        $stdout.puts "webpack dev_server configuration not found in #{config.config_path}[#{ENV["RAILS_ENV"]}]."
+        $stdout.puts "webpack dev_server configuration not found in #{@config.config_path}[#{ENV["RAILS_ENV"]}]."
         $stdout.puts "Please run bundle exec rails webpacker:install to install Webpacker"
         exit!
       end
@@ -39,7 +39,7 @@ module Webpacker
         server.close
 
       rescue Errno::EADDRINUSE
-        $stdout.puts "Another program is running on port #{@port}. Set a new port in #{@config_file} for dev_server"
+        $stdout.puts "Another program is running on port #{@port}. Set a new port in #{@config.config_path} for dev_server"
         exit!
       end
 

data/lib/webpacker/helper.rb

@@ -7,8 +7,8 @@ module Webpacker::Helper
   end
 
   # Computes the relative path for a given Webpacker asset.
-  # Returns the 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.
+  # Returns the relative path using manifest.json and passes it to path_to_asset helper.
+  # This will use path_to_asset internally, so most of their behaviors will be the same.
   #
   # Example:
   #
@@ -19,13 +19,13 @@ module Webpacker::Helper
   #   <%= asset_pack_path 'calendar.css' %> # => "/packs/calendar-1016838bab065ae1e122.css"
   def asset_pack_path(name, **options)
     if current_webpacker_instance.config.extract_css? || !stylesheet?(name)
-      asset_path(current_webpacker_instance.manifest.lookup!(name), options)
+      path_to_asset(current_webpacker_instance.manifest.lookup!(name), options)
     end
   end
 
   # Computes the absolute path for a given Webpacker asset.
-  # Returns the 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.
+  # Returns the absolute path using manifest.json and passes it to url_to_asset helper.
+  # This will use url_to_asset internally, so most of their behaviors will be the same.
   #
   # Example:
   #
@@ -36,7 +36,7 @@ module Webpacker::Helper
   #   <%= asset_pack_url 'calendar.css' %> # => "http://example.com/packs/calendar-1016838bab065ae1e122.css"
   def asset_pack_url(name, **options)
     if current_webpacker_instance.config.extract_css? || !stylesheet?(name)
-      asset_url(current_webpacker_instance.manifest.lookup!(name), options)
+      url_to_asset(current_webpacker_instance.manifest.lookup!(name), options)
     end
   end
 
@@ -169,8 +169,8 @@ module Webpacker::Helper
 
     def resolve_path_to_image(name)
       path = name.starts_with?("media/images/") ? name : "media/images/#{name}"
-      asset_path(current_webpacker_instance.manifest.lookup!(path))
+      path_to_asset(current_webpacker_instance.manifest.lookup!(path))
     rescue
-      asset_path(current_webpacker_instance.manifest.lookup!(name))
+      path_to_asset(current_webpacker_instance.manifest.lookup!(name))
     end
 end