Module: ReactOnRails::PackerUtils

Defined in:
lib/react_on_rails/packer_utils.rb

Constant Summary collapse

GENERATE_PACKS_PATTERN =

Regex pattern to detect pack generation in hook scripts Matches both:

  • The rake task: react_on_rails:generate_packs

  • The Ruby method: generate_packs_if_stale (used by generator template)

/\b(react_on_rails:generate_packs|generate_packs_if_stale)\b/
SELF_GUARD_PATTERN =

Pattern to detect a real self-guard statement that exits early when SHAKAPACKER_SKIP_PRECOMPILE_HOOK is true. This avoids false positives from comments or unrelated string literals.

/
  (?:^|\s)
  (?:exit|return)
  (?:\s+0)?
  \s+if\s+ENV\[(["'])SHAKAPACKER_SKIP_PRECOMPILE_HOOK\1\]\s*==\s*(["'])true\2
/x

Class Method Summary collapse

Class Method Details

.asset_uri_from_packer(asset_name) ⇒ Object

The function doesn’t ensure that the asset exists.

  • It just returns url to the asset if dev server is running

  • Otherwise it returns file path to the asset



77
78
79
80
81
82
83
 
# File 'lib/react_on_rails/packer_utils.rb', line 77

def self.asset_uri_from_packer(asset_name)
  if dev_server_running?
    "#{dev_server_url}/#{public_output_uri_path}#{asset_name}"
  else
    File.join(packer_public_output_path, asset_name).to_s
  end
end

.bundle_js_uri_from_packer(bundle_name) ⇒ Object

This returns either a URL for the webpack-dev-server, non-server bundle or the hashed server bundle if using the same bundle for the client. Otherwise returns a file path.



48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/react_on_rails/packer_utils.rb', line 48

def self.bundle_js_uri_from_packer(bundle_name)
  hashed_bundle_name = ::Shakapacker.manifest.lookup!(bundle_name)

  # Support for hashing the server-bundle and having that built
  # the webpack-dev-server is provided by the config value
  # "same_bundle_for_client_and_server" where a value of true
  # would mean that the bundle is created by the webpack-dev-server
  is_bundle_running_on_server = bundle_name == ReactOnRails.configuration.server_bundle_js_file

  # Check Pro RSC bundle if Pro is available
  if ReactOnRails::Utils.react_on_rails_pro?
    is_bundle_running_on_server ||= (bundle_name == ReactOnRailsPro.configuration.rsc_bundle_js_file)
  end

  if ::Shakapacker.dev_server.running? && (!is_bundle_running_on_server ||
    ReactOnRails.configuration.same_bundle_for_client_and_server)
    "#{dev_server_url}#{hashed_bundle_name}"
  else
    File.expand_path(File.join("public", hashed_bundle_name)).to_s
  end
end

.check_manifest_not_cached ⇒ Object 



113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/react_on_rails/packer_utils.rb', line 113

def self.check_manifest_not_cached
  return unless ::Shakapacker.config.cache_manifest?

  msg = <<~MSG
    ERROR: you have enabled cache_manifest in the #{Rails.env} env when using the
    ReactOnRails::TestHelper.configure_rspec_to_compile_assets helper
    To fix this: edit your config/shakapacker.yml file and set cache_manifest to false for test.
  MSG
  puts wrap_message(msg)
  exit!
end

.dev_server_running? ⇒ Boolean

Returns:

  • (Boolean) 


8
9
10
 
# File 'lib/react_on_rails/packer_utils.rb', line 8

def self.dev_server_running?
  Shakapacker.dev_server.running?
end

.dev_server_url ⇒ Object 



12
13
14
 
# File 'lib/react_on_rails/packer_utils.rb', line 12

def self.dev_server_url
  "#{Shakapacker.dev_server.protocol}://#{Shakapacker.dev_server.host_with_port}"
end

.extract_precompile_hook ⇒ Object 



186
187
188
189
190
191
192
193
194
195
 
# File 'lib/react_on_rails/packer_utils.rb', line 186

def self.extract_precompile_hook
  # Prefer the public API (available in Shakapacker 9.0+)
  return ::Shakapacker.config.precompile_hook if ::Shakapacker.config.respond_to?(:precompile_hook)

  # Fallback: access config data using private :data method
  config_data = ::Shakapacker.config.send(:data)

  # Try symbol keys first (Shakapacker's internal format), then fall back to string keys
  config_data&.[](:precompile_hook) || config_data&.[]("precompile_hook")
end

.hook_contains_generate_packs?(hook_value) ⇒ Boolean

Returns:

  • (Boolean) 


213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/react_on_rails/packer_utils.rb', line 213

def self.hook_contains_generate_packs?(hook_value)
  # The hook value can be either:
  # 1. A direct command containing the rake task
  # 2. A path to a script file that needs to be read
  return false if hook_value.blank?

  # Check if it's a direct command first
  return true if hook_value.to_s.match?(GENERATE_PACKS_PATTERN)

  # Check if it's a script file path
  script_path = resolve_hook_script_path(hook_value)
  return false unless script_path && File.exist?(script_path)

  # Read and check script contents
  script_contents = File.read(script_path)
  script_contents.match?(GENERATE_PACKS_PATTERN)
rescue StandardError
  # If we can't read the script, assume it doesn't contain generate_packs
  false
end

.hook_script_has_self_guard?(hook_value) ⇒ Boolean

Check if a hook script file contains the self-guard pattern that prevents duplicate execution when SHAKAPACKER_SKIP_PRECOMPILE_HOOK is set. Returns false for direct command hooks (non-script values).

Returns:

  • (Boolean) 


256
257
258
259
260
261
262
263
264
265
266
 
# File 'lib/react_on_rails/packer_utils.rb', line 256

def self.hook_script_has_self_guard?(hook_value)
  return false if hook_value.blank?

  script_path = resolve_hook_script_path(hook_value)
  return false unless script_path

  script_contents = File.read(script_path)
  script_contents.match?(SELF_GUARD_PATTERN)
rescue StandardError
  false
end

.manifest_exists? ⇒ Boolean

Returns:

  • (Boolean) 


105
106
107
 
# File 'lib/react_on_rails/packer_utils.rb', line 105

def self.manifest_exists?
  ::Shakapacker.config.public_manifest_path.exist?
end

.nested_entries? ⇒ Boolean

Returns:

  • (Boolean) 


97
98
99
 
# File 'lib/react_on_rails/packer_utils.rb', line 97

def self.nested_entries?
  ::Shakapacker.config.nested_entries?
end

.packer_public_output_path ⇒ Object 



101
102
103
 
# File 'lib/react_on_rails/packer_utils.rb', line 101

def self.packer_public_output_path
  ::Shakapacker.config.public_output_path.to_s
end

.packer_source_entry_path ⇒ Object 



93
94
95
 
# File 'lib/react_on_rails/packer_utils.rb', line 93

def self.packer_source_entry_path
  ::Shakapacker.config.source_entry_path
end

.packer_source_path ⇒ Object 



89
90
91
 
# File 'lib/react_on_rails/packer_utils.rb', line 89

def self.packer_source_path
  ::Shakapacker.config.source_path
end

.packer_source_path_explicit? ⇒ Boolean

Returns:

  • (Boolean) 


109
110
111
 
# File 'lib/react_on_rails/packer_utils.rb', line 109

def self.packer_source_path_explicit?
  ::Shakapacker.config.send(:data)[:source_path].present?
end

.precompile? ⇒ Boolean

Returns:

  • (Boolean) 


85
86
87
 
# File 'lib/react_on_rails/packer_utils.rb', line 85

def self.precompile?
  ::Shakapacker.config.shakapacker_precompile?
end

.project_root ⇒ Object 



241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/react_on_rails/packer_utils.rb', line 241

def self.project_root
  return Rails.root if defined?(Rails) && Rails.respond_to?(:root) && Rails.root

  bundle_gemfile = ENV.fetch("BUNDLE_GEMFILE", nil)
  if bundle_gemfile && !bundle_gemfile.strip.empty?
    gemfile_path = Pathname.new(bundle_gemfile).expand_path
    return gemfile_path.dirname if gemfile_path.file?
  end

  Pathname.new(Dir.pwd)
end

.public_output_uri_path ⇒ Object 



70
71
72
 
# File 'lib/react_on_rails/packer_utils.rb', line 70

def self.public_output_uri_path
  "#{::Shakapacker.config.public_output_path.relative_path_from(::Shakapacker.config.public_path)}/"
end

.raise_nested_entries_disabled ⇒ Object

Raises:



137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/react_on_rails/packer_utils.rb', line 137

def self.raise_nested_entries_disabled
  msg = <<~MSG
    **ERROR** ReactOnRails: `nested_entries` is configured to be disabled in shakapacker. Please update \
    config/shakapacker.yml to enable nested entries. for more information read
    https://reactonrails.com/docs/core-concepts/auto-bundling/#enable-nested_entries-for-shakapacker

    #{ReactOnRails::DOCTOR_RECOMMENDATION}
  MSG

  raise ReactOnRails::Error, msg
end

.raise_shakapacker_version_incompatible_for_autobundling ⇒ Object

Raises:



149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/react_on_rails/packer_utils.rb', line 149

def self.raise_shakapacker_version_incompatible_for_autobundling
  msg = <<~MSG
    **ERROR** ReactOnRails: Automated bundle generation requires Shakapacker >= #{ReactOnRails::PacksGenerator::MINIMUM_SHAKAPACKER_VERSION_FOR_AUTO_BUNDLING} (for nested_entries support).
    Installed version: #{ReactOnRails::PackerUtils.shakapacker_version}

    To fix: Upgrade Shakapacker, or set `auto_load_bundle: false` in your ReactOnRails configuration.

    #{ReactOnRails::DOCTOR_RECOMMENDATION}
  MSG

  raise ReactOnRails::Error, msg
end

.resolve_hook_script_path(hook_value) ⇒ Object 



234
235
236
237
238
239
 
# File 'lib/react_on_rails/packer_utils.rb', line 234

def self.resolve_hook_script_path(hook_value)
  return nil if hook_value.blank?

  potential_path = project_root.join(hook_value.to_s.strip)
  potential_path if potential_path.file?
end

.shakapacker_precompile_hook_configured? ⇒ Boolean

Check if shakapacker.yml has a precompile hook configured This prevents react_on_rails from running generate_packs twice

Returns false if detection fails for any reason (missing shakapacker, malformed config, etc.) to ensure generate_packs runs rather than being incorrectly skipped

Note: Currently checks a single hook value. Future enhancement will support hook lists to allow prepending/appending multiple commands. See related Shakapacker issue for details.

Returns:

  • (Boolean) 


170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'lib/react_on_rails/packer_utils.rb', line 170

def self.shakapacker_precompile_hook_configured?
  return false unless defined?(::Shakapacker)

  hook_value = extract_precompile_hook
  return false if hook_value.nil?

  hook_contains_generate_packs?(hook_value)
rescue StandardError => e
  # Swallow errors during hook detection to fail safe - if we can't detect the hook,
  # we should run generate_packs rather than skip it incorrectly.
  # Possible errors: NoMethodError (config method missing), TypeError (unexpected data structure),
  # or errors from shakapacker's internal implementation changes
  warn "Warning: Unable to detect shakapacker precompile hook: #{e.message}" if ENV["DEBUG"]
  false
end

.shakapacker_precompile_hook_value ⇒ Object

Returns the configured precompile hook value for logging/debugging Returns nil if no hook is configured



270
271
272
273
274
275
276
 
# File 'lib/react_on_rails/packer_utils.rb', line 270

def self.shakapacker_precompile_hook_value
  return nil unless defined?(::Shakapacker)

  extract_precompile_hook
rescue StandardError
  nil
end

.shakapacker_version ⇒ Object 



16
17
18
19
20
 
# File 'lib/react_on_rails/packer_utils.rb', line 16

def self.shakapacker_version
  return @shakapacker_version if defined?(@shakapacker_version)

  @shakapacker_version = Gem.loaded_specs["shakapacker"].version.to_s
end

.shakapacker_version_as_array ⇒ Object 



22
23
24
25
26
27
28
29
 
# File 'lib/react_on_rails/packer_utils.rb', line 22

def self.shakapacker_version_as_array
  return @shakapacker_version_as_array if defined?(@shakapacker_version_as_array)

  match = shakapacker_version.match(ReactOnRails::VersionChecker::VERSION_PARTS_REGEX)

  # match[4] is the pre-release version, not normally a number but something like "beta.1" or `nil`
  @shakapacker_version_as_array = [match[1].to_i, match[2].to_i, match[3].to_i, match[4]].compact
end

.shakapacker_version_requirement_met?(required_version) ⇒ Boolean

Returns:

  • (Boolean) 


31
32
33
34
 
# File 'lib/react_on_rails/packer_utils.rb', line 31

def self.shakapacker_version_requirement_met?(required_version)
  @version_checks ||= {}
  @version_checks[required_version] ||= Gem::Version.new(shakapacker_version) >= Gem::Version.new(required_version)
end

.supports_async_loading? ⇒ Boolean

Returns:

  • (Boolean) 


36
37
38
 
# File 'lib/react_on_rails/packer_utils.rb', line 36

def self.supports_async_loading?
  shakapacker_version_requirement_met?("8.2.0")
end

.supports_autobundling? ⇒ Boolean

Returns:

  • (Boolean) 


40
41
42
43
 
# File 'lib/react_on_rails/packer_utils.rb', line 40

def self.supports_autobundling?
  min_version = ReactOnRails::PacksGenerator::MINIMUM_SHAKAPACKER_VERSION_FOR_AUTO_BUNDLING
  ::Shakapacker.config.respond_to?(:nested_entries?) && shakapacker_version_requirement_met?(min_version)
end

.webpack_assets_status_checker ⇒ Object 



125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/react_on_rails/packer_utils.rb', line 125

def self.webpack_assets_status_checker
  source_path = ReactOnRails::Utils.source_path
  generated_assets_full_path = ReactOnRails::Utils.generated_assets_full_path
  webpack_generated_files = ReactOnRails.configuration.webpack_generated_files

  @webpack_assets_status_checker ||= ReactOnRails::TestHelper::WebpackAssetsStatusChecker.new(
    source_path: source_path,
    generated_assets_full_path: generated_assets_full_path,
    webpack_generated_files: webpack_generated_files
  )
end