shakapacker 6.1.1 → 6.2.0

data/lib/webpacker/manifest.rb

@@ -80,8 +80,8 @@ class Webpacker::Manifest
     end
 
     def load
-      if config.public_manifest_path.exist?
-        JSON.parse config.public_manifest_path.read
+      if config.manifest_path.exist?
+        JSON.parse config.manifest_path.read
       else
         {}
       end
@@ -104,7 +104,7 @@ class Webpacker::Manifest
 
     def missing_file_from_manifest_error(bundle_name)
       <<-MSG
-Webpacker can't find #{bundle_name} in #{config.public_manifest_path}. Possible causes:
+Webpacker can't find #{bundle_name} in #{config.manifest_path}. Possible causes:
 1. You forgot to install node packages (try `yarn install`) or are running an incompatible version of Node
 2. Your app has code with a non-standard extension (like a `.jsx` file) but the extension is not in the `extensions` config in `config/webpacker.yml`
 3. You have set compile: false (see `config/webpacker.yml`) for this environment

data/lib/webpacker/railtie.rb

@@ -2,11 +2,18 @@ require "rails/railtie"
 
 require "webpacker/helper"
 require "webpacker/dev_server_proxy"
+require "webpacker/version_checker"
 
 class Webpacker::Engine < ::Rails::Engine
   # Allows Webpacker config values to be set via Rails env config files
   config.webpacker = ActiveSupport::OrderedOptions.new
 
+  initializer "webpacker.version_checker" do
+    if File.exist?(Webpacker::VersionChecker::NodePackageVersion.package_json_path)
+      Webpacker::VersionChecker.build.raise_if_gem_and_node_package_versions_differ
+    end
+  end
+
   initializer "webpacker.proxy" do |app|
     if (Webpacker.config.dev_server.present? rescue nil)
       app.middleware.insert_before 0,

data/lib/webpacker/version.rb

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

data/lib/webpacker/version_checker.rb

@@ -0,0 +1,152 @@
+# frozen_string_literal: true
+require "webpacker/version"
+
+module Webpacker
+  class VersionChecker
+    attr_reader :node_package_version
+
+    MAJOR_MINOR_PATCH_VERSION_REGEX = /(\d+)\.(\d+)\.(\d+)/.freeze
+
+    def self.build
+      new(NodePackageVersion.build)
+    end
+
+    def initialize(node_package_version)
+      @node_package_version = node_package_version
+    end
+
+    def raise_if_gem_and_node_package_versions_differ
+      # Skip check if package is not in package.json or listed from relative path, git repo or github URL
+      return if node_package_version.skip_processing?
+
+      node_major_minor_patch = node_package_version.major_minor_patch
+      gem_major_minor_patch = gem_major_minor_patch_version
+      versions_match = node_major_minor_patch[0] == gem_major_minor_patch[0] &&
+                       node_major_minor_patch[1] == gem_major_minor_patch[1] &&
+                       node_major_minor_patch[2] == gem_major_minor_patch[2]
+
+      uses_wildcard = node_package_version.semver_wildcard?
+
+      if !Webpacker.config.ensure_consistent_versioning? && (uses_wildcard || !versions_match)
+        check_failed = if uses_wildcard
+          "Semver wildcard detected"
+        else
+          "Version mismatch detected"
+        end
+
+        warn <<-MSG.strip_heredoc
+          Webpacker::VersionChecker - #{check_failed}
+
+          You are currently not checking for consistent versions of shakapacker gem and npm package. A version mismatch or usage of semantic versioning wildcard (~ or ^) has been detected.
+
+          Version mismatch can lead to incorrect behavior and bugs. You should ensure that both the gem and npm package dependencies are locked to the same version.
+
+          You can enable the version check by setting `ensure_consistent_versioning: true` in your `webpacker.yml` file.
+
+          Checking for gem and npm package versions mismatch or wildcard will be enabled by default in the next major version of shakapacker.
+        MSG
+
+        return
+      end
+
+      raise_differing_versions_warning unless versions_match
+
+      raise_node_semver_version_warning if uses_wildcard
+    end
+
+    private
+
+      def common_error_msg
+        <<-MSG.strip_heredoc
+         Detected: #{node_package_version.raw}
+              gem: #{gem_version}
+         Ensure the installed version of the gem is the same as the version of
+         your installed node package. Do not use >= or ~> in your Gemfile for shakapacker.
+         Do not use ^ or ~ in your package.json for shakapacker.
+         Run `yarn add shakapacker --exact` in the directory containing folder node_modules.
+      MSG
+      end
+
+      def raise_differing_versions_warning
+        msg = "**ERROR** Webpacker: Webpacker gem and node package versions do not match\n#{common_error_msg}"
+        raise msg
+      end
+
+      def raise_node_semver_version_warning
+        msg = "**ERROR** Webpacker: Your node package version for shakapacker contains a "\
+              "^ or ~\n#{common_error_msg}"
+        raise msg
+      end
+
+      def gem_version
+        Webpacker::VERSION
+      end
+
+      def gem_major_minor_patch_version
+        match = gem_version.match(MAJOR_MINOR_PATCH_VERSION_REGEX)
+        [match[1], match[2], match[3]]
+      end
+
+      class NodePackageVersion
+        attr_reader :package_json
+
+        def self.build
+          new(package_json_path)
+        end
+
+        def self.package_json_path
+          Rails.root.join("package.json")
+        end
+
+        def initialize(package_json)
+          @package_json = package_json
+        end
+
+        def raw
+          parsed_package_contents = JSON.parse(package_json_contents)
+          parsed_package_contents.dig("dependencies", "shakapacker").to_s
+        end
+
+        def semver_wildcard?
+          raw.match(/[~^]/).present?
+        end
+
+        def skip_processing?
+          !package_specified? || relative_path? || git_url? || github_url?
+        end
+
+        def major_minor_patch
+          return if skip_processing?
+
+          match = raw.match(MAJOR_MINOR_PATCH_VERSION_REGEX)
+          unless match
+            raise "Cannot parse version number '#{raw}' (wildcard versions are not supported)"
+          end
+
+          [match[1], match[2], match[3]]
+        end
+
+        private
+
+          def package_specified?
+            raw.present?
+          end
+
+          def relative_path?
+            raw.match(%r{(\.\.|\Afile:///)}).present?
+          end
+
+          def git_url?
+            raw.match(%r{^git}).present?
+          end
+
+          def github_url?
+            raw.match(%r{^([\w-]+\/[\w-]+)}).present?
+          end
+
+          def package_json_contents
+            @package_json_contents ||= File.read(package_json)
+          end
+      end
+  end
+end

data/package/__tests__/config.js

@@ -1,6 +1,7 @@
 /* global test expect, describe */
 
 const { chdirCwd, chdirTestApp, resetEnv } = require('../utils/helpers')
+const { resolve } = require('path')
 
 chdirTestApp()
 
@@ -31,4 +32,14 @@ describe('Config', () => {
       'app/elm'
     ])
   })
+
+  test('should default manifestPath to the public dir', () => {
+    expect(config.manifestPath).toEqual(resolve('public/packs/manifest.json'))
+  })
+
+  test('should allow overriding manifestPath', () => {
+    process.env.WEBPACKER_CONFIG = 'config/webpacker_manifest_path.yml'
+    const config = require('../config')
+    expect(config.manifestPath).toEqual(resolve('app/packs/manifest.json'))
+  })
 })

data/package/config.js

@@ -29,4 +29,10 @@ const getPublicPath = () => {
 config.publicPath = getPublicPath()
 config.publicPathWithoutCDN = `/${config.public_output_path}/`
 
+if (config.manifest_path) {
+  config.manifestPath = resolve(config.manifest_path)
+} else {
+  config.manifestPath = resolve(config.outputPath, 'manifest.json')
+}
+
 module.exports = config

data/package/environments/base.js

@@ -54,7 +54,7 @@ const getPlugins = () => {
     new WebpackAssetsManifest({
       entrypoints: true,
       writeToDisk: true,
-      output: 'manifest.json',
+      output: config.manifestPath,
       entrypointsUseAssets: true,
       publicPath: true
     })

data/package/inliningCss.js

@@ -2,6 +2,6 @@ const { runningWebpackDevServer } = require('./env')
 const devServer = require('./dev_server')
 
 // This logic is tied to lib/webpacker/instance.rb
-const inliningCss = runningWebpackDevServer && devServer.hmr
+const inliningCss = runningWebpackDevServer && devServer.hmr && devServer.inline_css !== false
 
 module.exports = inliningCss

data/package/rules/__tests__/file.js

@@ -0,0 +1,35 @@
+const file = require('../file')
+
+describe('file', () => {
+  test('test expected file types', () => {
+    const types = [
+      '.bmp',
+      '.gif',
+      '.jpg',
+      '.jpeg',
+      '.png',
+      '.tiff',
+      '.ico',
+      '.avif',
+      '.webp',
+      '.eot',
+      '.otf',
+      '.ttf',
+      '.woff',
+      '.woff2',
+      '.svg',
+    ]
+    types.forEach(type => expect(file.test.test(type)).toBe(true))
+  })
+
+  test('exclude expected file types', () => {
+    const types = [
+      '.js',
+      '.mjs',
+      '.jsx',
+      '.ts',
+      '.tsx',
+    ]
+    types.forEach(type => expect(file.exclude.test(type)).toBe(true))
+  })
+})

data/package/rules/__tests__/index.js

@@ -0,0 +1,11 @@
+const rules = require('../index')
+
+describe('index', () => {
+  test('rule tests are regexes', () => {
+    rules.forEach(rule => expect(rule.test instanceof RegExp).toBe(true))
+  })
+
+  test('rule excludes are regexes', () => {
+    rules.forEach(rule => expect(rule.exclude instanceof RegExp).toBe(true))
+  })
+})

data/package/rules/__tests__/raw.js

@@ -0,0 +1,18 @@
+const raw = require('../raw')
+
+describe('raw', () => {
+  test('test expected file types', () => {
+    expect(raw.test.test('.html')).toBe(true)
+  })
+
+  test('exclude expected file types', () => {
+    const types = [
+      '.js',
+      '.mjs',
+      '.jsx',
+      '.ts',
+      '.tsx',
+    ]
+    types.forEach(type => expect(raw.exclude.test(type)).toBe(true))
+  })
+})

data/package/rules/file.js

@@ -2,23 +2,8 @@ const { dirname, join } = require('path')
 const { source_path: sourcePath } = require('../config')
 
 module.exports = {
-  test: [
-    /\.bmp$/,
-    /\.gif$/,
-    /\.jpe?g$/,
-    /\.png$/,
-    /\.tiff$/,
-    /\.ico$/,
-    /\.avif$/,
-    /\.webp$/,
-    /\.eot$/,
-    /\.otf$/,
-    /\.ttf$/,
-    /\.woff$/,
-    /\.woff2$/,
-    /\.svg$/
-  ],
-  exclude: [/\.(js|mjs|jsx|ts|tsx)$/],
+  test: /\.(bmp|gif|jpe?g|png|tiff|ico|avif|webp|eot|otf|ttf|woff|woff2|svg)$/,
+  exclude: /\.(js|mjs|jsx|ts|tsx)$/,
   type: 'asset/resource',
   generator: {
     filename: (pathData) => {

data/package/rules/raw.js

@@ -1,5 +1,5 @@
 module.exports = {
-  test: [/\.html$/],
-  exclude: [/\.(js|mjs|jsx|ts|tsx)$/],
+  test: /\.html$/,
+  exclude: /\.(js|mjs|jsx|ts|tsx)$/,
   type: 'asset/source'
 }

data/package/swc/index.js

@@ -30,12 +30,12 @@ const getSwcLoaderConfig = (filenameToProcess) => {
             : 'ecmascript',
           [isTypescriptFile(filenameToProcess) ? 'tsx' : 'jsx']:
             isJsxFile(filenameToProcess)
-        }
+        },
+        loose: true
       },
       sourceMaps: true,
       env: {
-        coreJs: '3.8',
-        loose: true,
+        coreJs: 3,
         exclude: ['transform-typeof-symbol'],
         mode: 'entry'
       }

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "shakapacker",
-  "version": "6.1.1",
+  "version": "6.2.0",
   "description": "Use webpack to manage app-like JavaScript modules in Rails",
   "main": "package/index.js",
   "files": [

data/test/configuration_test.rb

@@ -38,9 +38,18 @@ class ConfigurationTest < Webpacker::Test
     assert_equal @config.public_output_path.to_s, public_output_path
   end
 
-  def test_public_manifest_path
-    public_manifest_path = File.expand_path File.join(File.dirname(__FILE__), "test_app/public/packs", "manifest.json").to_s
-    assert_equal @config.public_manifest_path.to_s, public_manifest_path
+  def test_manifest_path
+    manifest_path = File.expand_path File.join(File.dirname(__FILE__), "test_app/public/packs", "manifest.json").to_s
+    assert_equal @config.manifest_path.to_s, manifest_path
+
+    @config = Webpacker::Configuration.new(
+      root_path: @config.root_path,
+      config_path: Pathname.new(File.expand_path("./test_app/config/webpacker_manifest_path.yml", __dir__)),
+      env: "production"
+    )
+
+    manifest_path = File.expand_path File.join(File.dirname(__FILE__), "test_app/app/packs", "manifest.json").to_s
+    assert_equal @config.manifest_path.to_s, manifest_path
   end
 
   def test_cache_path
@@ -75,4 +84,16 @@ class ConfigurationTest < Webpacker::Test
       assert Webpacker.config.compile?
     end
   end
+
+  def test_ensure_consistent_versioning?
+    refute @config.ensure_consistent_versioning?
+
+    with_rails_env("development") do
+      assert Webpacker.config.ensure_consistent_versioning?
+    end
+
+    with_rails_env("test") do
+      refute Webpacker.config.ensure_consistent_versioning?
+    end
+  end
 end

data/test/fixtures/beta_package.json

@@ -0,0 +1,13 @@
+{
+  "name": "test_app",
+  "version": "1.0.0",
+  "main": "index.js",
+  "license": "MIT",
+  "private": true,
+  "dependencies": {
+    "shakapacker": "6.0.0-beta.1"
+  },
+  "devDependencies": {
+    "right-pad": "^1.0.1"
+  }
+}

data/test/fixtures/git_url_package.json

@@ -0,0 +1,13 @@
+{
+  "name": "test_app",
+  "version": "1.0.0",
+  "main": "index.js",
+  "license": "MIT",
+  "private": true,
+  "dependencies": {
+    "shakapacker": "git://github.com/shakapacker/shakapacker.git"
+  },
+  "devDependencies": {
+    "right-pad": "^1.0.1"
+  }
+}

data/test/fixtures/github_url_package.json

@@ -0,0 +1,13 @@
+{
+  "name": "test_app",
+  "version": "1.0.0",
+  "main": "index.js",
+  "license": "MIT",
+  "private": true,
+  "dependencies": {
+    "shakapacker": "shakapacker/shakapacker#feature\/branch"
+  },
+  "devDependencies": {
+    "right-pad": "^1.0.1"
+  }
+}

data/test/fixtures/normal_package.json

@@ -0,0 +1,13 @@
+{
+  "name": "test_app",
+  "version": "1.0.0",
+  "main": "index.js",
+  "license": "MIT",
+  "private": true,
+  "dependencies": {
+    "shakapacker": "6.0.0"
+  },
+  "devDependencies": {
+    "right-pad": "^1.0.1"
+  }
+}

data/test/fixtures/relative_path_package.json

@@ -0,0 +1,13 @@
+{
+  "name": "test_app",
+  "version": "1.0.0",
+  "main": "index.js",
+  "license": "MIT",
+  "private": true,
+  "dependencies": {
+    "shakapacker": "../shakapacker"
+  },
+  "devDependencies": {
+    "right-pad": "^1.0.1"
+  }
+}

data/test/fixtures/semver_caret_package.json

@@ -0,0 +1,13 @@
+{
+  "name": "test_app",
+  "version": "1.0.0",
+  "main": "index.js",
+  "license": "MIT",
+  "private": true,
+  "dependencies": {
+    "shakapacker": "^6.0.0"
+  },
+  "devDependencies": {
+    "right-pad": "^1.0.1"
+  }
+}

data/test/fixtures/semver_tilde_package.json

@@ -0,0 +1,13 @@
+{
+  "name": "test_app",
+  "version": "1.0.0",
+  "main": "index.js",
+  "license": "MIT",
+  "private": true,
+  "dependencies": {
+    "shakapacker": "~6.0.0"
+  },
+  "devDependencies": {
+    "right-pad": "^1.0.1"
+  }
+}

data/test/fixtures/without_package.json

@@ -0,0 +1,13 @@
+{
+  "name": "test_app",
+  "version": "1.0.0",
+  "main": "index.js",
+  "license": "MIT",
+  "private": true,
+  "dependencies": {
+    "left-pad": "1.0.2"
+  },
+  "devDependencies": {
+    "right-pad": "^1.0.1"
+  }
+}

data/test/helper_test.rb

@@ -14,7 +14,6 @@ class HelperTest < ActionView::TestCase
     end.new
 
     @javascript_pack_tag_loaded = nil
-    @stylesheet_pack_tag_loaded = nil
   end
 
   def test_asset_pack_path
@@ -149,19 +148,19 @@ class HelperTest < ActionView::TestCase
   end
 
   def hello_stimulus_stylesheet_chunks
-    %w[/packs/hello_stimulus-k344a6d59eef8632c9d1.chunk.css]
+    %w[/packs/1-c20632e7baf2c81200d3.chunk.css /packs/hello_stimulus-k344a6d59eef8632c9d1.chunk.css]
   end
 
   def test_stylesheet_pack_tag
     assert_equal \
-      (application_stylesheet_chunks + hello_stimulus_stylesheet_chunks)
+      (application_stylesheet_chunks + hello_stimulus_stylesheet_chunks).uniq
         .map { |chunk| stylesheet_link_tag(chunk) }.join("\n"),
       stylesheet_pack_tag("application", "hello_stimulus")
   end
 
   def test_stylesheet_pack_tag_symbol
     assert_equal \
-      (application_stylesheet_chunks + hello_stimulus_stylesheet_chunks)
+      (application_stylesheet_chunks + hello_stimulus_stylesheet_chunks).uniq
         .map { |chunk| stylesheet_link_tag(chunk) }.join("\n"),
       stylesheet_pack_tag(:application, :hello_stimulus)
   end
@@ -172,15 +171,16 @@ class HelperTest < ActionView::TestCase
       stylesheet_pack_tag("application", media: "all")
   end
 
-  def test_stylesheet_pack_tag_multiple_invocations
-    error = assert_raises do
-      stylesheet_pack_tag(:application)
-      stylesheet_pack_tag(:hello_stimulus)
-    end
+  def test_stylesheet_pack_tag_multiple_invocations_are_allowed
+    app_style = stylesheet_pack_tag(:application)
+    stimulus_style = stylesheet_pack_tag(:hello_stimulus)
 
     assert_equal \
-      "To prevent duplicated chunks on the page, you should call stylesheet_pack_tag only once on the page. " +
-        "Please refer to https://github.com/shakacode/shakapacker/blob/master/README.md#usage for the usage guide",
-      error.message
+      application_stylesheet_chunks.map { |chunk| stylesheet_link_tag(chunk) }.join("\n"),
+      app_style
+
+    assert_equal \
+      hello_stimulus_stylesheet_chunks.map { |chunk| stylesheet_link_tag(chunk) }.join("\n"),
+      stimulus_style
   end
 end

data/test/test_app/config/webpacker.yml

@@ -9,6 +9,9 @@ default: &default
   webpack_compile_output: false
   webpack_loader: babel
 
+  # Location for manifest.json, defaults to {public_output_path}/manifest.json if unset
+  # manifest_path: public/packs/manifest.json
+
   # Additional paths webpack should look up modules
   # ['app/assets', 'engine/foo/app/assets']
   additional_paths:
@@ -36,6 +39,7 @@ default: &default
 development:
   <<: *default
   compile: true
+  ensure_consistent_versioning: true
 
   # Reference: https://webpack.js.org/configuration/dev-server/
   dev_server: