shakapacker 8.0.2 → 9.2.0

data/lib/shakapacker/helper.rb

@@ -95,22 +95,25 @@ module Shakapacker::Helper
   #
   #   <%= javascript_pack_tag 'calendar' %>
   #   <%= javascript_pack_tag 'map' %>
-  def javascript_pack_tag(*names, defer: true, **options)
+  def javascript_pack_tag(*names, defer: true, async: false, **options)
     if @javascript_pack_tag_loaded
       raise "To prevent duplicated chunks on the page, you should call javascript_pack_tag only once on the page. " \
       "Please refer to https://github.com/shakacode/shakapacker/blob/main/README.md#view-helpers-javascript_pack_tag-and-stylesheet_pack_tag for the usage guide"
     end
 
-    append_javascript_pack_tag(*names, defer: defer)
-    non_deferred = sources_from_manifest_entrypoints(javascript_pack_tag_queue[:non_deferred], type: :javascript)
-    deferred = sources_from_manifest_entrypoints(javascript_pack_tag_queue[:deferred], type: :javascript) - non_deferred
+    append_javascript_pack_tag(*names, defer: defer, async: async)
+    sync = sources_from_manifest_entrypoints(javascript_pack_tag_queue[:sync], type: :javascript)
+    async = sources_from_manifest_entrypoints(javascript_pack_tag_queue[:async], type: :javascript) - sync
+    deferred = sources_from_manifest_entrypoints(javascript_pack_tag_queue[:deferred], type: :javascript) - sync - async
 
     @javascript_pack_tag_loaded = true
 
     capture do
-      concat javascript_include_tag(*deferred, **options.tap { |o| o[:defer] = true })
-      concat "\n" if non_deferred.any? && deferred.any?
-      concat javascript_include_tag(*non_deferred, **options.tap { |o| o[:defer] = false })
+      render_tags(async, :javascript, **options.dup.tap { |o| o[:async] = true })
+      concat "\n" if async.any? && deferred.any?
+      render_tags(deferred, :javascript, **options.dup.tap { |o| o[:defer] = true })
+      concat "\n" if sync.any? && deferred.any?
+      render_tags(sync, :javascript, options)
     end
   end
 
@@ -163,7 +166,9 @@ module Shakapacker::Helper
 
     @stylesheet_pack_tag_loaded = true
 
-    stylesheet_link_tag(*(requested_packs | appended_packs), **options)
+    capture do
+      render_tags(requested_packs | appended_packs, :stylesheet, options)
+    end
   end
 
   def append_stylesheet_pack_tag(*names)
@@ -179,27 +184,35 @@ module Shakapacker::Helper
     nil
   end
 
-  def append_javascript_pack_tag(*names, defer: true)
-    update_javascript_pack_tag_queue(defer: defer) do |hash_key|
+  def append_javascript_pack_tag(*names, defer: true, async: false)
+    update_javascript_pack_tag_queue(defer: defer, async: async) do |hash_key|
       javascript_pack_tag_queue[hash_key] |= names
     end
   end
 
-  def prepend_javascript_pack_tag(*names, defer: true)
-    update_javascript_pack_tag_queue(defer: defer) do |hash_key|
+  def prepend_javascript_pack_tag(*names, defer: true, async: false)
+    update_javascript_pack_tag_queue(defer: defer, async: async) do |hash_key|
       javascript_pack_tag_queue[hash_key].unshift(*names)
     end
   end
 
   private
 
-    def update_javascript_pack_tag_queue(defer:)
+    def update_javascript_pack_tag_queue(defer:, async:)
       if @javascript_pack_tag_loaded
-        raise "You can only call #{caller_locations(1..1).first.label} before javascript_pack_tag helper. " \
+        raise "You can only call #{caller_locations(1..1).first.base_label} before javascript_pack_tag helper. " \
         "Please refer to https://github.com/shakacode/shakapacker/blob/main/README.md#view-helper-append_javascript_pack_tag-prepend_javascript_pack_tag-and-append_stylesheet_pack_tag for the usage guide"
       end
 
-      yield(defer ? :deferred : :non_deferred)
+      # When both async and defer are specified, async takes precedence per HTML5 spec
+      hash_key = if async
+        :async
+      elsif defer
+        :deferred
+      else
+        :sync
+      end
+      yield(hash_key)
 
       # prevent rendering Array#to_s representation when used with <%= … %> syntax
       nil
@@ -207,8 +220,9 @@ module Shakapacker::Helper
 
     def javascript_pack_tag_queue
       @javascript_pack_tag_queue ||= {
+        async: [],
         deferred: [],
-        non_deferred: []
+        sync: []
       }
     end
 
@@ -226,4 +240,38 @@ module Shakapacker::Helper
     rescue
       path_to_asset(current_shakapacker_instance.manifest.lookup!(name), options)
     end
+
+    def lookup_integrity(source)
+      (source.respond_to?(:dig) && source.dig("integrity")) || nil
+    end
+
+    def lookup_source(source)
+      (source.respond_to?(:dig) && source.dig("src")) || source
+    end
+
+    # Handles rendering javascript and stylesheet tags with integrity, if that's enabled.
+    def render_tags(sources, type, options)
+      return unless sources.present? || type.present?
+
+      sources.each.with_index do |source, index|
+        tag_source = lookup_source(source)
+
+        if current_shakapacker_instance.config.integrity[:enabled]
+          integrity = lookup_integrity(source)
+
+          if integrity.present?
+            options[:integrity] = integrity
+            options[:crossorigin] = current_shakapacker_instance.config.integrity[:cross_origin]
+          end
+        end
+
+        if type == :javascript
+          concat javascript_include_tag(tag_source, **options)
+        else
+          concat stylesheet_link_tag(tag_source, **options)
+        end
+
+        concat "\n" unless index == sources.size - 1
+      end
+    end
 end

data/lib/shakapacker/manifest.rb

@@ -67,7 +67,12 @@ class Shakapacker::Manifest
     end
 
     def find(name)
-      data[name.to_s].presence
+      return nil unless data[name.to_s].present?
+
+      return data[name.to_s] unless data[name.to_s].respond_to?(:dig)
+
+      # Try to return src, if that fails, (ex. entrypoints object) return the whole object.
+      data[name.to_s].dig("src") || data[name.to_s]
     end
 
     def full_pack_name(name, pack_type)
@@ -103,15 +108,17 @@ class Shakapacker::Manifest
     end
 
     def missing_file_from_manifest_error(bundle_name)
+      bundler_name = config.assets_bundler
       <<-MSG
 Shakapacker can't find #{bundle_name} in #{config.manifest_path}. Possible causes:
 1. You forgot to install javascript packages or are running an incompatible javascript runtime version
 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/shakapacker.yml`
 3. You have set compile: false (see `config/shakapacker.yml`) for this environment
    (unless you are using the `bin/shakapacker -w` or the `bin/shakapacker-dev-server`, in which case maybe you aren't running the dev server in the background?)
-4. webpack has not yet FINISHED running to reflect updates.
+4. Your #{bundler_name} has not yet FINISHED running to reflect updates.
 5. You have misconfigured Shakapacker's `config/shakapacker.yml` file.
-6. Your webpack configuration is not creating a manifest.
+6. Your #{bundler_name} configuration is not creating a manifest with the expected structure.
+7. Ensure the 'assets_bundler' in config/shakapacker.yml is set correctly (currently: #{bundler_name}).
 
 Your manifest contains:
 #{JSON.pretty_generate(@data)}

data/lib/shakapacker/mtime_strategy.rb

@@ -1,4 +1,4 @@
-require "shakapacker/base_strategy"
+require_relative "base_strategy"
 
 module Shakapacker
   class MtimeStrategy < BaseStrategy

data/lib/shakapacker/railtie.rb

@@ -1,9 +1,9 @@
 require "rails/railtie"
 
-require "shakapacker/helper"
-require "shakapacker/dev_server_proxy"
-require "shakapacker/version_checker"
-require "shakapacker/utils/manager"
+require_relative "helper"
+require_relative "dev_server_proxy"
+require_relative "version_checker"
+require_relative "utils/manager"
 
 class Shakapacker::Engine < ::Rails::Engine
   # Allows Shakapacker config values to be set via Rails env config files

data/lib/shakapacker/rspack_runner.rb

@@ -0,0 +1,19 @@
+require "shellwords"
+
+require_relative "runner"
+
+module Shakapacker
+  class RspackRunner < Shakapacker::Runner
+    def self.run(argv)
+      $stdout.sync = true
+      Shakapacker.ensure_node_env!
+      new(argv).run
+    end
+
+    private
+
+      def build_cmd
+        package_json.manager.native_exec_command("rspack")
+      end
+  end
+end

data/lib/shakapacker/runner.rb

@@ -1,26 +1,73 @@
-require "shakapacker/utils/misc"
-require "shakapacker/utils/manager"
+require_relative "utils/misc"
+require_relative "utils/manager"
+require_relative "configuration"
+
 require "package_json"
+require "pathname"
 
 module Shakapacker
   class Runner
+    attr_reader :config
+
+    # Common commands that don't work with --config option
+    BASE_COMMANDS = [
+      "help",
+      "h",
+      "--help",
+      "-h",
+      "version",
+      "v",
+      "--version",
+      "-v",
+      "info",
+      "i"
+    ].freeze
     def self.run(argv)
       $stdout.sync = true
-      ENV["NODE_ENV"] ||= (ENV["RAILS_ENV"] == "production") ? "production" : "development"
-      new(argv).run
+      Shakapacker.ensure_node_env!
+
+      # Create a single runner instance to avoid loading configuration twice.
+      # We extend it with the appropriate build command based on the bundler type.
+      runner = new(argv)
+
+      if runner.config.rspack?
+        require_relative "rspack_runner"
+        # Extend the runner instance with rspack-specific methods
+        # This avoids creating a new RspackRunner which would reload the configuration
+        runner.extend(Module.new do
+          def build_cmd
+            package_json.manager.native_exec_command("rspack")
+          end
+
+          def assets_bundler_commands
+            BASE_COMMANDS + %w[build watch]
+          end
+        end)
+        runner.run
+      else
+        require_relative "webpack_runner"
+        # Extend the runner instance with webpack-specific methods
+        # This avoids creating a new WebpackRunner which would reload the configuration
+        runner.extend(Module.new do
+          def build_cmd
+            package_json.manager.native_exec_command("webpack")
+          end
+        end)
+        runner.run
+      end
     end
 
     def initialize(argv)
       @argv = argv
 
       @app_path              = File.expand_path(".", Dir.pwd)
-      @webpack_config        = File.join(@app_path, "config/webpack/webpack.config.js")
       @shakapacker_config    = ENV["SHAKAPACKER_CONFIG"] || File.join(@app_path, "config/shakapacker.yml")
-
-      unless File.exist?(@webpack_config)
-        $stderr.puts "webpack config #{@webpack_config} not found, please run 'bundle exec rails shakapacker:install' to install Shakapacker with default configs or add the missing config file for your custom environment."
-        exit!
-      end
+      @config                = Configuration.new(
+        root_path: Pathname.new(@app_path),
+        config_path: Pathname.new(@shakapacker_config),
+        env: ENV["RAILS_ENV"] || ENV["NODE_ENV"] || "development"
+      )
+      @webpack_config        = find_assets_bundler_config
 
       Shakapacker::Utils::Manager.error_unless_package_manager_is_obvious!
     end
@@ -28,5 +75,107 @@ module Shakapacker
     def package_json
       @package_json ||= PackageJson.read(@app_path)
     end
+
+    def run
+      puts "[Shakapacker] Preparing environment for assets bundler execution..."
+      env = Shakapacker::Compiler.env
+      env["SHAKAPACKER_CONFIG"] = @shakapacker_config
+      env["NODE_OPTIONS"] = ENV["NODE_OPTIONS"] || ""
+
+      cmd = build_cmd
+      puts "[Shakapacker] Base command: #{cmd.join(" ")}"
+
+      if @argv.delete("--debug-shakapacker")
+        puts "[Shakapacker] Debug mode enabled (--debug-shakapacker)"
+        env["NODE_OPTIONS"] = "#{env["NODE_OPTIONS"]} --inspect-brk"
+      end
+
+      if @argv.delete "--trace-deprecation"
+        puts "[Shakapacker] Trace deprecation enabled (--trace-deprecation)"
+        env["NODE_OPTIONS"] = "#{env["NODE_OPTIONS"]} --trace-deprecation"
+      end
+
+      if @argv.delete "--no-deprecation"
+        puts "[Shakapacker] Deprecation warnings disabled (--no-deprecation)"
+        env["NODE_OPTIONS"] = "#{env["NODE_OPTIONS"]} --no-deprecation"
+      end
+
+      # Commands are not compatible with --config option.
+      if (@argv & assets_bundler_commands).empty?
+        puts "[Shakapacker] Adding config file: #{@webpack_config}"
+        cmd += ["--config", @webpack_config]
+      else
+        puts "[Shakapacker] Skipping config file (running assets bundler command: #{(@argv & assets_bundler_commands).join(", ")})"
+      end
+
+      cmd += @argv
+      puts "[Shakapacker] Final command: #{cmd.join(" ")}"
+      puts "[Shakapacker] Working directory: #{@app_path}"
+
+      Dir.chdir(@app_path) do
+        Kernel.exec env, *cmd
+      end
+    end
+
+    protected
+
+      def assets_bundler_commands
+        BASE_COMMANDS
+      end
+
+    private
+      def find_assets_bundler_config
+        if @config.rspack?
+          find_rspack_config_with_fallback
+        else
+          find_webpack_config
+        end
+      end
+
+      def find_rspack_config_with_fallback
+        # First try rspack-specific paths
+        rspack_paths = %w[ts js].map do |ext|
+          File.join(@app_path, "config/rspack/rspack.config.#{ext}")
+        end
+
+        puts "[Shakapacker] Looking for Rspack config in: #{rspack_paths.join(", ")}"
+        rspack_path = rspack_paths.find { |f| File.exist?(f) }
+        if rspack_path
+          puts "[Shakapacker] Found Rspack config: #{rspack_path}"
+          return rspack_path
+        end
+
+        # Fallback to webpack config with deprecation warning
+        webpack_paths = %w[ts js].map do |ext|
+          File.join(@app_path, "config/webpack/webpack.config.#{ext}")
+        end
+
+        puts "[Shakapacker] Rspack config not found, checking for webpack config fallback..."
+        webpack_path = webpack_paths.find { |f| File.exist?(f) }
+        if webpack_path
+          $stderr.puts "⚠️  DEPRECATION WARNING: Using webpack config file for Rspack assets bundler."
+          $stderr.puts "   Please create config/rspack/rspack.config.js and migrate your configuration."
+          $stderr.puts "   Using: #{webpack_path}"
+          return webpack_path
+        end
+
+        # No config found
+        $stderr.puts "[Shakapacker] ERROR: rspack config #{rspack_paths.last} not found, please run 'bundle exec rails shakapacker:install' to install Shakapacker with default configs or create the missing config file."
+        exit(1)
+      end
+
+      def find_webpack_config
+        possible_paths = %w[ts js].map do |ext|
+          File.join(@app_path, "config/webpack/webpack.config.#{ext}")
+        end
+        puts "[Shakapacker] Looking for Webpack config in: #{possible_paths.join(", ")}"
+        path = possible_paths.find { |f| File.exist?(f) }
+        unless path
+          $stderr.puts "[Shakapacker] ERROR: webpack config #{possible_paths.last} not found, please run 'bundle exec rails shakapacker:install' to install Shakapacker with default configs or add the missing config file for your custom environment."
+          exit(1)
+        end
+        puts "[Shakapacker] Found Webpack config: #{path}"
+        path
+      end
   end
 end