webpacker 3.6.0 → 4.0.2

data/lib/webpacker/manifest.rb

@@ -4,7 +4,7 @@
 # "/packs/calendar-1016838bab065ae1e314.css".
 #
 # When the configuration is set to on-demand compilation, with the `compile: true` option in
-# the webpacker.yml file, any lookups will be preceeded by a compilation if one is needed.
+# the webpacker.yml file, any lookups will be preceded by a compilation if one is needed.
 class Webpacker::Manifest
   class MissingEntryError < StandardError; end
 
@@ -18,13 +18,35 @@ class Webpacker::Manifest
     @data = load
   end
 
-  def lookup(name)
+  def lookup_pack_with_chunks(name, pack_type = {})
     compile if compiling?
-    find name
+
+    manifest_pack_type = manifest_type(pack_type[:type])
+    manifest_pack_name = manifest_name(name, manifest_pack_type)
+    find("entrypoints")[manifest_pack_name][manifest_pack_type]
+  rescue NoMethodError
+    nil
+  end
+
+  def lookup_pack_with_chunks!(name, pack_type = {})
+    lookup_pack_with_chunks(name, pack_type) || handle_missing_entry(name)
+  end
+
+  # Computes the relative path for a given Webpacker asset using manifest.json.
+  # If no asset is found, returns nil.
+  #
+  # Example:
+  #
+  #   Webpacker.manifest.lookup('calendar.js') # => "/packs/calendar-1016838bab065ae1e122.js"
+  def lookup(name, pack_type = {})
+    compile if compiling?
+
+    find(full_pack_name(name, pack_type[:type]))
   end
 
-  def lookup!(name)
-    lookup(name) || handle_missing_entry(name)
+  # Like lookup, except that if no asset is found, raises a Webpacker::Manifest::MissingEntryError.
+  def lookup!(name, pack_type = {})
+    lookup(name, pack_type) || handle_missing_entry(name)
   end
 
   private
@@ -36,14 +58,51 @@ class Webpacker::Manifest
       Webpacker.logger.tagged("Webpacker") { compiler.compile }
     end
 
+    def data
+      if config.cache_manifest?
+        @data ||= load
+      else
+        refresh
+      end
+    end
+
     def find(name)
       data[name.to_s].presence
     end
 
+    def full_pack_name(name, pack_type)
+      return name unless File.extname(name.to_s).empty?
+      "#{name}.#{manifest_type(pack_type)}"
+    end
+
     def handle_missing_entry(name)
       raise Webpacker::Manifest::MissingEntryError, missing_file_from_manifest_error(name)
     end
 
+    def load
+      if config.public_manifest_path.exist?
+        JSON.parse config.public_manifest_path.read
+      else
+        {}
+      end
+    end
+
+    # The `manifest_name` method strips of the file extension of the name, because in the
+    # manifest hash the entrypoints are defined by their pack name without the extension.
+    # When the user provides a name with a file extension, we want to try to strip it off.
+    def manifest_name(name, pack_type)
+      return name if File.extname(name.to_s).empty?
+      File.basename(name, pack_type)
+    end
+
+    def manifest_type(pack_type)
+      case pack_type
+      when :javascript then "js"
+      when :stylesheet then "css"
+      else pack_type.to_s
+      end
+    end
+
     def missing_file_from_manifest_error(bundle_name)
       <<-MSG
 Webpacker can't find #{bundle_name} in #{config.public_manifest_path}. Possible causes:
@@ -56,20 +115,4 @@ Your manifest contains:
 #{JSON.pretty_generate(@data)}
       MSG
     end
-
-    def data
-      if config.cache_manifest?
-        @data ||= load
-      else
-        refresh
-      end
-    end
-
-    def load
-      if config.public_manifest_path.exist?
-        JSON.parse config.public_manifest_path.read
-      else
-        {}
-      end
-    end
 end

data/lib/webpacker/railtie.rb

@@ -6,7 +6,12 @@ require "webpacker/dev_server_proxy"
 class Webpacker::Engine < ::Rails::Engine
   # Allows Webpacker config values to be set via Rails env config files
   config.webpacker = ActiveSupport::OrderedOptions.new
-  config.webpacker.check_yarn_integrity = false
+
+  initializer "webpacker.set_configs" do |app|
+    if app.config.webpacker.key?(:check_yarn_integrity)
+      Webpacker.config.check_yarn_integrity = app.config.webpacker.check_yarn_integrity
+    end
+  end
 
   # ================================
   # Check Yarn Integrity Initializer
@@ -24,18 +29,18 @@ class Webpacker::Engine < ::Rails::Engine
   #     - edit config/environments/production.rb
   #     - add `config.webpacker.check_yarn_integrity = true`
   initializer "webpacker.yarn_check" do |app|
-    if File.exist?("yarn.lock") && app.config.webpacker.check_yarn_integrity
-      output = `yarn check --integrity 2>&1`
+    if File.exist?("yarn.lock") && Webpacker.config.config_path.exist? && Webpacker.config.check_yarn_integrity?
+      output = `yarn check --integrity && yarn check --verify-tree 2>&1`
 
       unless $?.success?
         $stderr.puts "\n\n"
         $stderr.puts "========================================"
         $stderr.puts "  Your Yarn packages are out of date!"
-        $stderr.puts "  Please run `yarn install` to update."
+        $stderr.puts "  Please run `yarn install --check-files` to update."
         $stderr.puts "========================================"
         $stderr.puts "\n\n"
-        $stderr.puts "To disable this check, please add `config.webpacker.check_yarn_integrity = false`"
-        $stderr.puts "to your Rails development config file (config/environments/development.rb)."
+        $stderr.puts "To disable this check, please change `check_yarn_integrity`"
+        $stderr.puts "to `false` in your webpacker config file (config/webpacker.yml)."
         $stderr.puts "\n\n"
         $stderr.puts output
         $stderr.puts "\n\n"
@@ -77,7 +82,11 @@ class Webpacker::Engine < ::Rails::Engine
   initializer "webpacker.bootstrap" do
     if defined?(Rails::Server) || defined?(Rails::Console)
       Webpacker.bootstrap
-      Spring.after_fork { Webpacker.bootstrap } if defined?(Spring)
+      if defined?(Spring)
+        require "spring/watcher"
+        Spring.after_fork { Webpacker.bootstrap }
+        Spring.watch(Webpacker.config.config_path)
+      end
     end
   end
 end

data/lib/webpacker/runner.rb

@@ -9,9 +9,9 @@ module Webpacker
     def initialize(argv)
       @argv = argv
 
-      @app_path          = File.expand_path(".", Dir.pwd)
-      @node_modules_path = File.join(@app_path, "node_modules")
-      @webpack_config    = File.join(@app_path, "config/webpack/#{ENV["NODE_ENV"]}.js")
+      @app_path              = File.expand_path(".", Dir.pwd)
+      @node_modules_bin_path = ENV["WEBPACKER_NODE_MODULES_BIN_PATH"] || `yarn bin`.chomp
+      @webpack_config        = File.join(@app_path, "config/webpack/#{ENV["NODE_ENV"]}.js")
 
       unless File.exist?(@webpack_config)
         $stderr.puts "webpack config #{@webpack_config} not found, please run 'bundle exec rails webpacker:install' to install Webpacker with default configs or add the missing config file for your custom environment."

data/lib/webpacker/version.rb

@@ -1,4 +1,4 @@
 module Webpacker
   # Change the version in package.json too, please!
-  VERSION = "3.6.0".freeze
+  VERSION = "4.0.2".freeze
 end

data/lib/webpacker/webpack_runner.rb

@@ -4,12 +4,23 @@ require "webpacker/runner"
 module Webpacker
   class WebpackRunner < Webpacker::Runner
     def run
-      env = { "NODE_PATH" => @node_modules_path.shellescape }
-      cmd = [ "#{@node_modules_path}/.bin/webpack", "--config", @webpack_config ] + @argv
+      env = Webpacker::Compiler.env
+
+      cmd = if node_modules_bin_exist?
+        ["#{@node_modules_bin_path}/webpack"]
+      else
+        ["yarn", "webpack"]
+      end
+      cmd += ["--config", @webpack_config] + @argv
 
       Dir.chdir(@app_path) do
-        exec env, *cmd
+        Kernel.exec env, *cmd
       end
     end
+
+    private
+      def node_modules_bin_exist?
+        File.exist?("#{@node_modules_bin_path}/webpack")
+      end
   end
 end

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rails/webpacker",
-  "version": "3.6.0",
+  "version": "4.0.2",
   "description": "Use webpack to manage app-like JavaScript modules in Rails",
   "main": "package/index.js",
   "files": [
@@ -8,43 +8,55 @@
     "lib/install/config/webpacker.yml"
   ],
   "engines": {
-    "node": ">=6.0.0",
-    "yarn": ">=0.25.2"
+    "node": ">=6.14.4",
+    "yarn": ">=1.0.0"
   },
   "dependencies": {
-    "babel-core": "^6.26.3",
-    "babel-loader": "^7.1.5",
-    "babel-plugin-syntax-dynamic-import": "^6.18.0",
-    "babel-plugin-transform-class-properties": "^6.24.1",
-    "babel-plugin-transform-object-rest-spread": "^6.26.0",
-    "babel-polyfill": "^6.26.0",
-    "babel-preset-env": "^1.7.0",
-    "case-sensitive-paths-webpack-plugin": "^2.1.2",
-    "compression-webpack-plugin": "^1.1.11",
-    "css-loader": "^0.28.11",
-    "extract-text-webpack-plugin": "^3.0.2",
-    "file-loader": "^1.1.11",
-    "glob": "^7.1.2",
-    "js-yaml": "^3.12.0",
-    "node-sass": "^4.9.2",
-    "optimize-css-assets-webpack-plugin": "^3.2.0",
+    "@babel/core": "^7.3.4",
+    "@babel/plugin-proposal-class-properties": "^7.3.4",
+    "@babel/plugin-proposal-object-rest-spread": "^7.3.4",
+    "@babel/plugin-syntax-dynamic-import": "^7.2.0",
+    "@babel/plugin-transform-destructuring": "^7.3.2",
+    "@babel/plugin-transform-regenerator": "^7.3.4",
+    "@babel/plugin-transform-runtime": "^7.3.4",
+    "@babel/polyfill": "^7.2.5",
+    "@babel/preset-env": "^7.3.4",
+    "@babel/runtime": "^7.3.4",
+    "babel-loader": "^8.0.5",
+    "babel-plugin-dynamic-import-node": "^2.2.0",
+    "babel-plugin-macros": "^2.5.0",
+    "case-sensitive-paths-webpack-plugin": "^2.2.0",
+    "compression-webpack-plugin": "^2.0.0",
+    "css-loader": "^2.1.0",
+    "file-loader": "^3.0.1",
+    "flatted": "^2.0.0",
+    "glob": "^7.1.3",
+    "js-yaml": "^3.12.2",
+    "mini-css-extract-plugin": "^0.5.0",
+    "node-sass": "^4.11.0",
+    "optimize-css-assets-webpack-plugin": "^5.0.1",
     "path-complete-extname": "^1.0.0",
-    "postcss-cssnext": "^3.1.0",
-    "postcss-import": "^11.1.0",
-    "postcss-loader": "^2.1.5",
-    "sass-loader": "^6.0.7",
-    "style-loader": "^0.21.0",
-    "uglifyjs-webpack-plugin": "^1.2.7",
-    "webpack": "^3.12.0",
-    "webpack-manifest-plugin": "^1.3.2"
+    "pnp-webpack-plugin": "^1.3.1",
+    "postcss-flexbugs-fixes": "^4.1.0",
+    "postcss-import": "^12.0.1",
+    "postcss-loader": "^3.0.0",
+    "postcss-preset-env": "^6.6.0",
+    "postcss-safe-parser": "^4.0.1",
+    "sass-loader": "^7.1.0",
+    "style-loader": "^0.23.1",
+    "terser-webpack-plugin": "^1.2.3",
+    "webpack": "^4.29.6",
+    "webpack-assets-manifest": "^3.1.1",
+    "webpack-cli": "^3.2.3",
+    "webpack-sources": "^1.3.0"
   },
   "devDependencies": {
-    "eslint": "^4.19.1",
-    "eslint-config-airbnb": "^16.1.0",
-    "eslint-plugin-import": "^2.11.0",
-    "eslint-plugin-jsx-a11y": "^6.0.3",
-    "eslint-plugin-react": "^7.7.0",
-    "jest": "^23.3.0"
+    "eslint": "^5.15.0",
+    "eslint-config-airbnb": "^17.1.0",
+    "eslint-plugin-import": "^2.16.0",
+    "eslint-plugin-jsx-a11y": "^6.2.1",
+    "eslint-plugin-react": "^7.12.4",
+    "jest": "^24.1.0"
   },
   "jest": {
     "testRegex": "(/__tests__/.*|(\\.|/))\\.jsx?$",
@@ -54,7 +66,7 @@
   },
   "scripts": {
     "test": "jest",
-    "lint": "eslint {package,lib}/"
+    "lint": "eslint package/"
   },
   "repository": {
     "type": "git",

data/package/__tests__/config.js

@@ -1,18 +1,17 @@
 /* global test expect, describe */
 
-const { chdirCwd, chdirTestApp } = require('../utils/helpers')
+const { chdirCwd, chdirTestApp, resetEnv } = require('../utils/helpers')
 
 chdirTestApp()
 
 const config = require('../config')
 
 describe('Config', () => {
-  beforeEach(() => jest.resetModules())
+  beforeEach(() => jest.resetModules() && resetEnv())
   afterAll(chdirCwd)
 
   test('public path', () => {
     process.env.RAILS_ENV = 'development'
-    delete process.env.RAILS_RELATIVE_URL_ROOT
     const config = require('../config')
     expect(config.publicPath).toEqual('/packs/')
   })
@@ -25,8 +24,31 @@ describe('Config', () => {
     expect(config.publicPath).toEqual('/foo/packs/')
   })
 
+  test('public path with relative root without slash', () => {
+    process.env.RAILS_ENV = 'development'
+    process.env.RAILS_RELATIVE_URL_ROOT = 'foo'
+    const config = require('../config')
+    expect(config.publicPath).toEqual('/foo/packs/')
+  })
+
+  test('public path with asset host and relative root', () => {
+    process.env.RAILS_ENV = 'development'
+    process.env.RAILS_RELATIVE_URL_ROOT = '/foo/'
+    process.env.WEBPACKER_ASSET_HOST = 'http://foo.com/'
+    const config = require('../config')
+    expect(config.publicPath).toEqual('http://foo.com/foo/packs/')
+  })
+
+  test('public path with asset host', () => {
+    process.env.RAILS_ENV = 'development'
+    process.env.WEBPACKER_ASSET_HOST = 'http://foo.com/'
+    const config = require('../config')
+    expect(config.publicPath).toEqual('http://foo.com/packs/')
+  })
+
   test('should return extensions as listed in app config', () => {
     expect(config.extensions).toEqual([
+      '.mjs',
       '.js',
       '.sass',
       '.scss',
@@ -41,4 +63,16 @@ describe('Config', () => {
       '.jpg'
     ])
   })
+
+  test('should return static assets extensions as listed in app config', () => {
+    expect(config.static_assets_extensions).toEqual([
+      '.jpg',
+      '.jpeg',
+      '.png',
+      '.gif',
+      '.tiff',
+      '.ico',
+      '.svg',
+    ])
+  })
 })

data/package/__tests__/dev_server.js

@@ -20,6 +20,21 @@ describe('DevServer', () => {
     expect(devServer.port).toEqual('5000')
   })
 
+  test('with custom env prefix', () => {
+    const config = require('../config')
+    config.dev_server.env_prefix = 'TEST_WEBPACKER_DEV_SERVER'
+
+    process.env.NODE_ENV = 'development'
+    process.env.RAILS_ENV = 'development'
+    process.env.TEST_WEBPACKER_DEV_SERVER_HOST = '0.0.0.0'
+    process.env.TEST_WEBPACKER_DEV_SERVER_PORT = 5000
+
+    const devServer = require('../dev_server')
+    expect(devServer).toBeDefined()
+    expect(devServer.host).toEqual('0.0.0.0')
+    expect(devServer.port).toEqual('5000')
+  })
+
   test('with NODE_ENV and RAILS_ENV set to production', () => {
     process.env.RAILS_ENV = 'production'
     process.env.NODE_ENV = 'production'

data/package/__tests__/production.js

@@ -17,11 +17,11 @@ describe('Production environment', () => {
 
       const { environment } = require('../index')
       const config = environment.toWebpackConfig()
-      
+
       expect(config.output.path).toEqual(resolve('public', 'packs'))
       expect(config.output.publicPath).toEqual('/packs/')
       expect(config).toMatchObject({
-        devtool: 'nosources-source-map',
+        devtool: 'source-map',
         stats: 'normal'
       })
     })

data/package/__tests__/staging.js

@@ -11,17 +11,17 @@ describe('Custom environment', () => {
   describe('toWebpackConfig', () => {
     beforeEach(() => jest.resetModules())
 
-    test('should use staging config and production environment', () => {
+    test('should use staging config and default production environment', () => {
       process.env.RAILS_ENV = 'staging'
       delete process.env.NODE_ENV
 
       const { environment } = require('../index')
       const config = environment.toWebpackConfig()
-      
+
       expect(config.output.path).toEqual(resolve('public', 'packs-staging'))
       expect(config.output.publicPath).toEqual('/packs-staging/')
       expect(config).toMatchObject({
-        devtool: 'nosources-source-map',
+        devtool: 'source-map',
         stats: 'normal'
       })
     })