webpacker 2.0 → 3.0.0

data/lib/tasks/webpacker/yarn_install.rake

@@ -1,5 +1,5 @@
 namespace :webpacker do
-  desc "Support for older Rails versions.Install all JavaScript dependencies as specified via Yarn"
+  desc "Support for older Rails versions. Install all JavaScript dependencies as specified via Yarn"
   task :yarn_install, [:arg1, :arg2] do |task, args|
     system "yarn #{args[:arg1]} #{args[:arg2]}"
   end

data/lib/webpacker.rb

@@ -1,24 +1,28 @@
+require "active_support/core_ext/module/attribute_accessors"
+require "active_support/logger"
+require "active_support/tagged_logging"
+
 module Webpacker
   extend self
 
-  def bootstrap
-    Webpacker::Env.load
-    Webpacker::Configuration.load
-    Webpacker::Manifest.load
+  def instance=(instance)
+    @instance = instance
   end
 
-  def compile
-    Webpacker::Compiler.compile
-    Webpacker::Manifest.load
+  def instance
+    @instance ||= Webpacker::Instance.new
   end
 
-  def env
-    Webpacker::Env.current.inquiry
-  end
+  delegate :logger, :logger=, :env, to: :instance
+  delegate :config, :compiler, :manifest, :commands, :dev_server, to: :instance
+  delegate :bootstrap, :clobber, :compile, to: :commands
 end
 
-require "webpacker/env"
+require "webpacker/instance"
 require "webpacker/configuration"
 require "webpacker/manifest"
 require "webpacker/compiler"
+require "webpacker/commands"
+require "webpacker/dev_server"
+
 require "webpacker/railtie" if defined?(Rails)

data/lib/webpacker/commands.rb

@@ -0,0 +1,22 @@
+class Webpacker::Commands
+  delegate :config, :compiler, :manifest, to: :@webpacker
+
+  def initialize(webpacker)
+    @webpacker = webpacker
+  end
+
+  def clobber
+    config.public_output_path.rmtree if config.public_output_path.exist?
+    config.cache_path.rmtree if config.cache_path.exist?
+  end
+
+  def bootstrap
+    config.refresh
+    manifest.refresh
+  end
+
+  def compile
+    compiler.compile
+    manifest.refresh
+  end
+end

data/lib/webpacker/compiler.rb

@@ -1,20 +1,76 @@
-require "rake"
+require "open3"
+require "digest/sha1"
 
-module Webpacker::Compiler
-  extend self
+class Webpacker::Compiler
+  # Additional paths that test compiler needs to watch
+  # Webpacker::Compiler.watched_paths << 'bower_components'
+  mattr_accessor(:watched_paths) { [] }
+
+  # Additional environment variables that the compiler is being run with
+  # Webpacker::Compiler.env['FRONTEND_API_KEY'] = 'your_secret_key'
+  mattr_accessor(:env) { {} }
+
+  delegate :config, :logger, to: :@webpacker
+
+  def initialize(webpacker)
+    @webpacker = webpacker
+  end
 
   def compile
-    compile_task.invoke
-    compile_task.reenable
+    if stale?
+      record_compilation_digest
+      run_webpack
+    end
+  end
+
+  # Returns true if all the compiled packs are up to date with the underlying asset files.
+  def fresh?
+    watched_files_digest == last_compilation_digest
+  end
+
+  # Returns true if the compiled packs are out of date with the underlying asset files.
+  def stale?
+    !fresh?
   end
 
   private
-    def compile_task
-      @compile_task ||= load_rake_task("webpacker:compile")
+    def last_compilation_digest
+      compilation_digest_path.read if compilation_digest_path.exist? && config.public_manifest_path.exist?
+    end
+
+    def watched_files_digest
+      files = Dir[*default_watched_paths, *watched_paths].reject { |f| File.directory?(f) }
+      Digest::SHA1.hexdigest(files.map { |f| "#{File.basename(f)}/#{File.mtime(f).utc.to_i}" }.join("/"))
+    end
+
+    def record_compilation_digest
+      config.cache_path.mkpath
+      compilation_digest_path.write(watched_files_digest)
+    end
+
+    def run_webpack
+      logger.info "Compiling…"
+
+      sterr, stdout, status = Open3.capture3(webpack_env, "#{RbConfig.ruby} ./bin/webpack")
+
+      if status.success?
+        logger.info "Compiled all packs in #{config.public_output_path}"
+      else
+        logger.error "Compilation failed:\n#{sterr}\n#{stdout}"
+      end
+
+      status.success?
+    end
+
+    def default_watched_paths
+      ["#{config.source_path}/**/*", "yarn.lock", "package.json", "config/webpack/**/*"].freeze
+    end
+
+    def compilation_digest_path
+      config.cache_path.join(".last-compilation-digest")
     end
 
-    def load_rake_task(name)
-      @load_rakefile ||= Rake.load_rakefile(Rails.root.join("Rakefile"))
-      Rake::Task[name]
+    def webpack_env
+      env.merge("NODE_ENV" => @webpacker.env, "ASSET_HOST" => ActionController::Base.helpers.compute_asset_host)
     end
 end

data/lib/webpacker/configuration.rb

@@ -1,59 +1,75 @@
-# Loads webpacker configuration from config/webpacker.yml
+class Webpacker::Configuration
+  delegate :root_path, :config_path, :env, to: :@webpacker
 
-require "webpacker/file_loader"
+  def initialize(webpacker)
+    @webpacker = webpacker
+  end
 
-class Webpacker::Configuration < Webpacker::FileLoader
-  class << self
-    def entry_path
-      source_path.join(fetch(:source_entry_path))
-    end
+  def refresh
+    @data = load
+  end
 
-    def output_path
-      public_path.join(fetch(:public_output_path))
-    end
+  def dev_server
+    fetch(:dev_server)
+  end
 
-    def manifest_path
-      output_path.join("manifest.json")
-    end
+  def compile?
+    fetch(:compile)
+  end
 
-    def source_path
-      Rails.root.join(source)
-    end
+  def source_path
+    root_path.join(fetch(:source_path))
+  end
 
-    def public_path
-      Rails.root.join("public")
-    end
+  def source_entry_path
+    source_path.join(fetch(:source_entry_path))
+  end
 
-    def file_path(root: Rails.root)
-      root.join("config/webpacker.yml")
-    end
+  def public_path
+    root_path.join("public")
+  end
 
-    def default_file_path
-      file_path(root: Pathname.new(__dir__).join("../install"))
-    end
+  def public_output_path
+    public_path.join(fetch(:public_output_path))
+  end
 
-    def source
-      fetch(:source_path)
-    end
+  def public_manifest_path
+    public_output_path.join("manifest.json")
+  end
+
+  def cache_manifest?
+    fetch(:cache_manifest)
+  end
 
+  def cache_path
+    root_path.join(fetch(:cache_path))
+  end
+
+  private
     def fetch(key)
       data.fetch(key, defaults[key])
     end
 
     def data
-      load if Webpacker.env.development?
-      raise Webpacker::FileLoader::FileLoaderError.new("Webpacker::Configuration.load must be called first") unless instance
-      instance.data
+      @data ||= load
     end
 
-    def defaults
-      @defaults ||= HashWithIndifferentAccess.new(YAML.load(default_file_path.read)["default"])
+    def load
+      YAML.load(config_path.read)[env].deep_symbolize_keys
+
+    rescue Errno::ENOENT => e
+      raise "Webpacker configuration file not found #{config_path}. " \
+            "Please run rails webpacker:install " \
+            "Error: #{e.message}"
+
+    rescue Psych::SyntaxError => e
+      raise "YAML syntax error occurred while parsing #{config_path}. " \
+            "Please note that YAML must be consistently indented using spaces. Tabs are not allowed. " \
+            "Error: #{e.message}"
     end
-  end
 
-  private
-    def load
-      return super unless File.exist?(@path)
-      HashWithIndifferentAccess.new(YAML.load(File.read(@path))[Webpacker.env])
+    def defaults
+      @defaults ||= \
+        HashWithIndifferentAccess.new(YAML.load_file(File.expand_path("../../install/config/webpacker.yml", __FILE__))[env])
     end
 end

data/lib/webpacker/dev_server.rb

@@ -0,0 +1,47 @@
+class Webpacker::DevServer
+  delegate :config, to: :@webpacker
+
+  def initialize(webpacker)
+    @webpacker = webpacker
+  end
+
+  def running?
+    Socket.tcp(host, port, connect_timeout: 1).close
+    true
+  rescue Errno::ECONNREFUSED, NoMethodError
+    false
+  end
+
+  def hot_module_replacing?
+    fetch(:hmr)
+  end
+
+  def host
+    fetch(:host)
+  end
+
+  def port
+    fetch(:port)
+  end
+
+  def https?
+    fetch(:https)
+  end
+
+  def protocol
+    https? ? "https" : "http"
+  end
+
+  def host_with_port
+    "#{host}:#{port}"
+  end
+
+  private
+    def fetch(key)
+      config.dev_server.fetch(key, defaults[key])
+    end
+
+    def defaults
+      config.send(:defaults)[:dev_server]
+    end
+end

data/lib/webpacker/dev_server_proxy.rb

@@ -0,0 +1,24 @@
+require "rack/proxy"
+
+class Webpacker::DevServerProxy < Rack::Proxy
+  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?
+    response
+  end
+
+  def perform_request(env)
+    if env["PATH_INFO"] =~ /#{public_output_uri_path}/ && Webpacker.dev_server.running?
+      env["HTTP_HOST"] = Webpacker.dev_server.host_with_port
+      super(env)
+    else
+      @app.call(env)
+    end
+  end
+
+  private
+    def public_output_uri_path
+      Webpacker.config.public_output_path.relative_path_from(Webpacker.config.public_path)
+    end
+end

data/lib/webpacker/helper.rb

@@ -9,7 +9,7 @@ module Webpacker::Helper
   # In production mode:
   #   <%= asset_pack_path 'calendar.css' %> # => "/packs/calendar-1016838bab065ae1e122.css"
   def asset_pack_path(name, **options)
-    asset_path(Webpacker::Manifest.lookup(name), **options)
+    asset_path(Webpacker.manifest.lookup(name), **options)
   end
   # Creates a script tag that references the named pack file, as compiled by Webpack per the entries list
   # in config/webpack/shared.js. By default, this list is auto-generated to match everything in
@@ -24,24 +24,42 @@ module Webpacker::Helper
   #   # In production mode:
   #   <%= javascript_pack_tag 'calendar', 'data-turbolinks-track': 'reload' %> # =>
   #   <script src="/packs/calendar-1016838bab065ae1e314.js" data-turbolinks-track="reload"></script>
-  def javascript_pack_tag(name, **options)
-    javascript_include_tag(Webpacker::Manifest.lookup("#{name}#{compute_asset_extname(name, type: :javascript)}"), **options)
+  def javascript_pack_tag(*names, **options)
+    javascript_include_tag(*sources_from_pack_manifest(names, type: :javascript), **options)
   end
 
   # Creates a link tag that references the named pack file, 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. In production mode, the digested reference is automatically looked up.
   #
+  # Note: If the development server is running and hot module replacement is active, this will return nothing.
+  # In that setup you need to configure your styles to be inlined in your JavaScript for hot reloading.
+  #
   # Examples:
   #
   #   # In development mode:
   #   <%= stylesheet_pack_tag 'calendar', 'data-turbolinks-track': 'reload' %> # =>
   #   <link rel="stylesheet" media="screen" href="/packs/calendar.css" data-turbolinks-track="reload" />
   #
+  #   # In development mode with hot module replacement:
+  #   <%= stylesheet_pack_tag 'calendar', 'data-turbolinks-track': 'reload' %> # =>
+  #   nil
+  #
   #   # In production mode:
   #   <%= 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(name, **options)
-    stylesheet_link_tag(Webpacker::Manifest.lookup("#{name}#{compute_asset_extname(name, type: :stylesheet)}"), **options)
+  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)
+    end
   end
+
+  private
+    def sources_from_pack_manifest(names, type:)
+      names.map { |name| Webpacker.manifest.lookup(pack_name_with_extension(name, type: type)) }
+    end
+
+    def pack_name_with_extension(name, type:)
+      "#{name}#{compute_asset_extname(name, type: type)}"
+    end
 end

data/lib/webpacker/instance.rb

@@ -0,0 +1,44 @@
+class Webpacker::Instance
+  cattr_accessor(:logger) { ActiveSupport::TaggedLogging.new(ActiveSupport::Logger.new(STDOUT)) }
+
+  attr_reader :root_path, :config_path
+
+  def initialize(root_path: Rails.root, config_path: Rails.root.join("config/webpacker.yml"))
+    @root_path, @config_path = root_path, config_path
+  end
+
+  def env
+    (ENV["NODE_ENV"].presence_in(available_environments) ||
+      Rails.env.presence_in(available_environments) ||
+        "production".freeze).inquiry
+  end
+
+  def config
+    @config ||= Webpacker::Configuration.new self
+  end
+
+  def compiler
+    @compiler ||= Webpacker::Compiler.new self
+  end
+
+  def dev_server
+    @dev_server ||= Webpacker::DevServer.new self
+  end
+
+  def manifest
+    @manifest ||= Webpacker::Manifest.new self
+  end
+
+  def commands
+    @commands ||= Webpacker::Commands.new self
+  end
+
+  private
+    def available_environments
+      if config_path.exist?
+        YAML.load(config_path.read).keys
+      else
+        [].freeze
+      end
+    end
+end