brew bump --open-pr fails with Error: no implicit conversion of nil into String

[jrdodds]

Output of brew config

HOMEBREW_VERSION: 4.1.20-23-g25d1f10
ORIGIN: https://github.com/Homebrew/brew
HEAD: 25d1f1064aa2f79e1a01d7418b920b85a99c1f03
Last commit: 6 hours ago
Core tap JSON: 16 Nov 22:35 UTC
HOMEBREW_PREFIX: /opt/homebrew
HOMEBREW_CASK_OPTS: []
HOMEBREW_MAKE_JOBS: 10
HOMEBREW_SORBET_RUNTIME: set
Homebrew Ruby: 2.6.10 => /System/Library/Frameworks/Ruby.framework/Versions/2.6/usr/bin/ruby
CPU: 10-core 64-bit arm_firestorm_icestorm
Clang: 15.0.0 build 1500
Git: 2.42.1 => /opt/homebrew/bin/git
Curl: 8.1.2 => /usr/bin/curl
macOS: 14.1.1-arm64
CLT: 15.0.0.0.1.1694021235
Xcode: 15.0.1
Rosetta 2: false

Output of brew doctor

Please note that these warnings are just used to help the Homebrew maintainers
with debugging if you file an issue. If everything you use Homebrew for is
working fine: please don't worry or file an issue; just ignore this. Thanks!

Warning: Unbrewed header files were found in /usr/local/include.
If you didn't put them there on purpose they could cause problems when
building Homebrew formulae, and may need to be deleted.

Unexpected header files:
  /usr/local/include/node/**/*
[omitted the list of files under the node sub-directory]

Description of issue

macOS Sonoma 14.1.1 (23B81) with Apple M1 Pro

Running the command

brew bump --open-pr powershell --verbose

produces

Error: no implicit conversion of nil into String
Please report this issue:
  https://docs.brew.sh/Troubleshooting
/opt/homebrew/Library/Homebrew/cask/cask_loader.rb:85:in `initialize'
/opt/homebrew/Library/Homebrew/cask/cask_loader.rb:85:in `Pathname'
/opt/homebrew/Library/Homebrew/cask/cask_loader.rb:85:in `can_load?'
/opt/homebrew/Library/Homebrew/cask/cask_loader.rb:176:in `can_load?'
/opt/homebrew/Library/Homebrew/cask/cask_loader.rb:427:in `block in for'
/opt/homebrew/Library/Homebrew/cask/cask_loader.rb:426:in `each'
/opt/homebrew/Library/Homebrew/cask/cask_loader.rb:426:in `for'
/opt/homebrew/Library/Homebrew/cask/cask_loader.rb:413:in `load'
/opt/homebrew/Library/Homebrew/dev-cmd/bump.rb:318:in `block (2 levels) in retrieve_versions_by_arch'
/opt/homebrew/Library/Homebrew/simulate_system.rb:29:in `with'
/opt/homebrew/Library/Homebrew/vendor/bundle/ruby/2.6.0/gems/sorbet-runtime-0.5.10461/lib/types/private/methods/call_validation.rb:157:in `call'
/opt/homebrew/Library/Homebrew/vendor/bundle/ruby/2.6.0/gems/sorbet-runtime-0.5.10461/lib/types/private/methods/call_validation.rb:157:in `validate_call'
/opt/homebrew/Library/Homebrew/vendor/bundle/ruby/2.6.0/gems/sorbet-runtime-0.5.10461/lib/types/private/methods/_methods.rb:270:in `block in _on_method_added'
/opt/homebrew/Library/Homebrew/dev-cmd/bump.rb:310:in `block in retrieve_versions_by_arch'
/opt/homebrew/Library/Homebrew/dev-cmd/bump.rb:309:in `each'
/opt/homebrew/Library/Homebrew/dev-cmd/bump.rb:309:in `retrieve_versions_by_arch'
/opt/homebrew/Library/Homebrew/dev-cmd/bump.rb:404:in `retrieve_and_display_info_and_open_pr'
/opt/homebrew/Library/Homebrew/dev-cmd/bump.rb:142:in `block in handle_formula_and_casks'
/opt/homebrew/Library/Homebrew/dev-cmd/bump.rb:123:in `each'
/opt/homebrew/Library/Homebrew/dev-cmd/bump.rb:123:in `each_with_index'
/opt/homebrew/Library/Homebrew/dev-cmd/bump.rb:123:in `handle_formula_and_casks'
/opt/homebrew/Library/Homebrew/dev-cmd/bump.rb:93:in `block in bump'
/opt/homebrew/Library/Homebrew/extend/kernel.rb:499:in `with_env'
/opt/homebrew/Library/Homebrew/api.rb:191:in `with_no_api_env'
/opt/homebrew/Library/Homebrew/vendor/bundle/ruby/2.6.0/gems/sorbet-runtime-0.5.10461/lib/types/private/methods/call_validation.rb:157:in `call'
/opt/homebrew/Library/Homebrew/vendor/bundle/ruby/2.6.0/gems/sorbet-runtime-0.5.10461/lib/types/private/methods/call_validation.rb:157:in `validate_call'
/opt/homebrew/Library/Homebrew/vendor/bundle/ruby/2.6.0/gems/sorbet-runtime-0.5.10461/lib/types/private/methods/_methods.rb:270:in `block in _on_method_added'
/opt/homebrew/Library/Homebrew/dev-cmd/bump.rb:65:in `bump'
/opt/homebrew/Library/Homebrew/brew.rb:86:in `<main>'

[bar-dzi]

I got exactly same issue on Sonoma 14.2 (M2 Pro) for similar brew bump... command

[AlephCubed]

I have a similar issue for the command brew bump --open-pr osu:

Error: Parameter 'ref': Expected type T.any(Cask::Cask, Pathname, String, URI::Generic), got type NilClass
Caller: /opt/homebrew/Library/Homebrew/cask/cask_loader.rb:583
Definition: /opt/homebrew/Library/Homebrew/cask/cask_loader.rb:237
Please report this issue:
  https://docs.brew.sh/Troubleshooting
/opt/homebrew/Library/Homebrew/vendor/bundle/ruby/3.1.0/gems/sorbet-runtime-0.5.11287/lib/types/configuration.rb:296:in `call_validation_error_handler_default'
/opt/homebrew/Library/Homebrew/vendor/bundle/ruby/3.1.0/gems/sorbet-runtime-0.5.11287/lib/types/configuration.rb:303:in `call_validation_error_handler'
/opt/homebrew/Library/Homebrew/vendor/bundle/ruby/3.1.0/gems/sorbet-runtime-0.5.11287/lib/types/private/methods/call_validation.rb:300:in `report_error'
/opt/homebrew/Library/Homebrew/vendor/bundle/ruby/3.1.0/gems/sorbet-runtime-0.5.11287/lib/types/private/methods/call_validation.rb:136:in `block in validate_call_skip_block_type'
/opt/homebrew/Library/Homebrew/vendor/bundle/ruby/3.1.0/gems/sorbet-runtime-0.5.11287/lib/types/private/methods/signature.rb:213:in `each_args_value_type'
/opt/homebrew/Library/Homebrew/vendor/bundle/ruby/3.1.0/gems/sorbet-runtime-0.5.11287/lib/types/private/methods/call_validation.rb:133:in `validate_call_skip_block_type'
/opt/homebrew/Library/Homebrew/vendor/bundle/ruby/3.1.0/gems/sorbet-runtime-0.5.11287/lib/types/private/methods/call_validation.rb:109:in `block in create_validator_slow_skip_block_type'
/opt/homebrew/Library/Homebrew/cask/cask_loader.rb:583:in `block in for'
/opt/homebrew/Library/Homebrew/cask/cask_loader.rb:582:in `each'
/opt/homebrew/Library/Homebrew/cask/cask_loader.rb:582:in `for'
/opt/homebrew/Library/Homebrew/cask/cask_loader.rb:533:in `load'
/opt/homebrew/Library/Homebrew/dev-cmd/bump.rb:351:in `block (2 levels) in retrieve_versions_by_arch'
/opt/homebrew/Library/Homebrew/simulate_system.rb:29:in `with'
/opt/homebrew/Library/Homebrew/vendor/bundle/ruby/3.1.0/gems/sorbet-runtime-0.5.11287/lib/types/private/methods/call_validation.rb:270:in `bind_call'
/opt/homebrew/Library/Homebrew/vendor/bundle/ruby/3.1.0/gems/sorbet-runtime-0.5.11287/lib/types/private/methods/call_validation.rb:270:in `validate_call'
/opt/homebrew/Library/Homebrew/vendor/bundle/ruby/3.1.0/gems/sorbet-runtime-0.5.11287/lib/types/private/methods/_methods.rb:277:in `block in _on_method_added'
/opt/homebrew/Library/Homebrew/dev-cmd/bump.rb:343:in `block in retrieve_versions_by_arch'
/opt/homebrew/Library/Homebrew/dev-cmd/bump.rb:342:in `each'
/opt/homebrew/Library/Homebrew/dev-cmd/bump.rb:342:in `retrieve_versions_by_arch'
/opt/homebrew/Library/Homebrew/dev-cmd/bump.rb:439:in `retrieve_and_display_info_and_open_pr'
/opt/homebrew/Library/Homebrew/dev-cmd/bump.rb:156:in `block in handle_formula_and_casks'
/opt/homebrew/Library/Homebrew/dev-cmd/bump.rb:138:in `each'
/opt/homebrew/Library/Homebrew/dev-cmd/bump.rb:138:in `each_with_index'
/opt/homebrew/Library/Homebrew/dev-cmd/bump.rb:138:in `handle_formula_and_casks'
/opt/homebrew/Library/Homebrew/dev-cmd/bump.rb:108:in `block in bump'
/opt/homebrew/Library/Homebrew/extend/kernel.rb:493:in `with_env'
/opt/homebrew/Library/Homebrew/api.rb:199:in `with_no_api_env'
/opt/homebrew/Library/Homebrew/vendor/bundle/ruby/3.1.0/gems/sorbet-runtime-0.5.11287/lib/types/private/methods/call_validation.rb:270:in `bind_call'
/opt/homebrew/Library/Homebrew/vendor/bundle/ruby/3.1.0/gems/sorbet-runtime-0.5.11287/lib/types/private/methods/call_validation.rb:270:in `validate_call'
/opt/homebrew/Library/Homebrew/vendor/bundle/ruby/3.1.0/gems/sorbet-runtime-0.5.11287/lib/types/private/methods/_methods.rb:277:in `block in _on_method_added'
/opt/homebrew/Library/Homebrew/dev-cmd/bump.rb:73:in `bump'
/opt/homebrew/Library/Homebrew/brew.rb:86:in `<main>'

[johnmcdowell]

I have a similar crash to AlephCubed from brew audit on macOS/M2:

john@Johns-Air homebrew % brew audit --cask battery         
Error: Parameter 'ref': Expected type T.any(Cask::Cask, Pathname, String, URI::Generic), got type NilClass
Caller: /opt/homebrew/Library/Homebrew/cask/cask_loader.rb:564
Definition: /opt/homebrew/Library/Homebrew/cask/cask_loader.rb:235
/opt/homebrew/Library/Homebrew/vendor/bundle/ruby/3.1.0/gems/sorbet-runtime-0.5.11367/lib/types/configuration.rb:296:in `call_validation_error_handler_default'
/opt/homebrew/Library/Homebrew/vendor/bundle/ruby/3.1.0/gems/sorbet-runtime-0.5.11367/lib/types/configuration.rb:303:in `call_validation_error_handler'
/opt/homebrew/Library/Homebrew/vendor/bundle/ruby/3.1.0/gems/sorbet-runtime-0.5.11367/lib/types/private/methods/call_validation.rb:300:in `report_error'
/opt/homebrew/Library/Homebrew/vendor/bundle/ruby/3.1.0/gems/sorbet-runtime-0.5.11367/lib/types/private/methods/call_validation.rb:136:in `block in validate_call_skip_block_type'
/opt/homebrew/Library/Homebrew/vendor/bundle/ruby/3.1.0/gems/sorbet-runtime-0.5.11367/lib/types/private/methods/signature.rb:213:in `each_args_value_type'
/opt/homebrew/Library/Homebrew/vendor/bundle/ruby/3.1.0/gems/sorbet-runtime-0.5.11367/lib/types/private/methods/call_validation.rb:133:in `validate_call_skip_block_type'
/opt/homebrew/Library/Homebrew/vendor/bundle/ruby/3.1.0/gems/sorbet-runtime-0.5.11367/lib/types/private/methods/call_validation.rb:109:in `block in create_validator_slow_skip_block_type'
/opt/homebrew/Library/Homebrew/cask/cask_loader.rb:564:in `block in for'
/opt/homebrew/Library/Homebrew/cask/cask_loader.rb:563:in `each'
/opt/homebrew/Library/Homebrew/cask/cask_loader.rb:563:in `for'
/opt/homebrew/Library/Homebrew/cask/cask_loader.rb:514:in `load'
/opt/homebrew/Library/Homebrew/dev-cmd/audit.rb:255:in `block (3 levels) in run'
/opt/homebrew/Library/Homebrew/simulate_system.rb:27:in `with'
/opt/homebrew/Library/Homebrew/vendor/bundle/ruby/3.1.0/gems/sorbet-runtime-0.5.11367/lib/types/private/methods/call_validation.rb:270:in `bind_call'
/opt/homebrew/Library/Homebrew/vendor/bundle/ruby/3.1.0/gems/sorbet-runtime-0.5.11367/lib/types/private/methods/call_validation.rb:270:in `validate_call'
/opt/homebrew/Library/Homebrew/vendor/bundle/ruby/3.1.0/gems/sorbet-runtime-0.5.11367/lib/types/private/methods/_methods.rb:277:in `block in _on_method_added'
/opt/homebrew/Library/Homebrew/dev-cmd/audit.rb:251:in `block (2 levels) in run'
/opt/homebrew/Library/Homebrew/dev-cmd/audit.rb:248:in `each'
/opt/homebrew/Library/Homebrew/dev-cmd/audit.rb:248:in `flat_map'
/opt/homebrew/Library/Homebrew/dev-cmd/audit.rb:248:in `block in run'
/opt/homebrew/Library/Homebrew/dev-cmd/audit.rb:245:in `each'
/opt/homebrew/Library/Homebrew/dev-cmd/audit.rb:245:in `each_with_object'
/opt/homebrew/Library/Homebrew/dev-cmd/audit.rb:245:in `run'
/opt/homebrew/Library/Homebrew/vendor/bundle/ruby/3.1.0/gems/sorbet-runtime-0.5.11367/lib/types/private/methods/call_validation.rb:270:in `bind_call'
/opt/homebrew/Library/Homebrew/vendor/bundle/ruby/3.1.0/gems/sorbet-runtime-0.5.11367/lib/types/private/methods/call_validation.rb:270:in `validate_call'
/opt/homebrew/Library/Homebrew/vendor/bundle/ruby/3.1.0/gems/sorbet-runtime-0.5.11367/lib/types/private/methods/_methods.rb:277:in `block in _on_method_added'
/opt/homebrew/Library/Homebrew/brew.rb:92:in `<main>'

[johnmcdowell]

I'm not 100% sure this isn't somehow user error as I'm not experienced with homebrew development. I was trying to audit some changes for a pull request to homebrew-cask/Casks/b/battery.rb, and I assumed the below should audit the real installed battery.rb. I didn't end up needing the below audit command to work as I created a new tap were I put a renamed battery-custom.rb and was able to run the below command on battery-custom. But it still seems like the below shouldn't cause a runtime error...

john@Johns-Air ~ % brew audit --cask battery --debug --verbose
/opt/homebrew/Library/Homebrew/vendor/bundle/ruby/3.1.0/bin/bundle clean
/opt/homebrew/Library/Homebrew/brew.rb (Cask::CaskLoader::FromInstalledPathLoader): loading battery
/opt/homebrew/Library/Homebrew/brew.rb (Cask::CaskLoader::FromInstalledPathLoader): loading battery
/usr/bin/env XDG_CACHE_HOME=/Users/john/Library/Caches/Homebrew/style /opt/homebrew/Library/Homebrew/vendor/portable-ruby/3.1.4/bin/ruby -W1 --disable=gems,rubyopt -- /opt/homebrew/Library/Homebrew/utils/rubocop.rb --format json --force-exclusion --parallel --extra-details --except FormulaAuditStrict --config /opt/homebrew/Library/.rubocop.yml /opt/homebrew/Caskroom/battery/.metadata/1.2.1/20240502192716.248/Casks/battery.json
==> Auditing Cask battery on os sonoma and arch arm
Error: Parameter 'ref': Expected type T.any(Cask::Cask, Pathname, String, URI::Generic), got type NilClass
Caller: /opt/homebrew/Library/Homebrew/cask/cask_loader.rb:564
Definition: /opt/homebrew/Library/Homebrew/cask/cask_loader.rb:235
/opt/homebrew/Library/Homebrew/vendor/bundle/ruby/3.1.0/gems/sorbet-runtime-0.5.11367/lib/types/configuration.rb:296:in `call_validation_error_handler_default'
/opt/homebrew/Library/Homebrew/vendor/bundle/ruby/3.1.0/gems/sorbet-runtime-0.5.11367/lib/types/configuration.rb:303:in `call_validation_error_handler'
/opt/homebrew/Library/Homebrew/vendor/bundle/ruby/3.1.0/gems/sorbet-runtime-0.5.11367/lib/types/private/methods/call_validation.rb:300:in `report_error'
/opt/homebrew/Library/Homebrew/vendor/bundle/ruby/3.1.0/gems/sorbet-runtime-0.5.11367/lib/types/private/methods/call_validation.rb:136:in `block in validate_call_skip_block_type'
/opt/homebrew/Library/Homebrew/vendor/bundle/ruby/3.1.0/gems/sorbet-runtime-0.5.11367/lib/types/private/methods/signature.rb:213:in `each_args_value_type'
/opt/homebrew/Library/Homebrew/vendor/bundle/ruby/3.1.0/gems/sorbet-runtime-0.5.11367/lib/types/private/methods/call_validation.rb:133:in `validate_call_skip_block_type'
/opt/homebrew/Library/Homebrew/vendor/bundle/ruby/3.1.0/gems/sorbet-runtime-0.5.11367/lib/types/private/methods/call_validation.rb:109:in `block in create_validator_slow_skip_block_type'
/opt/homebrew/Library/Homebrew/cask/cask_loader.rb:564:in `block in for'
/opt/homebrew/Library/Homebrew/cask/cask_loader.rb:563:in `each'
/opt/homebrew/Library/Homebrew/cask/cask_loader.rb:563:in `for'
/opt/homebrew/Library/Homebrew/cask/cask_loader.rb:514:in `load'
/opt/homebrew/Library/Homebrew/dev-cmd/audit.rb:255:in `block (3 levels) in run'
/opt/homebrew/Library/Homebrew/simulate_system.rb:27:in `with'
/opt/homebrew/Library/Homebrew/vendor/bundle/ruby/3.1.0/gems/sorbet-runtime-0.5.11367/lib/types/private/methods/call_validation.rb:270:in `bind_call'
/opt/homebrew/Library/Homebrew/vendor/bundle/ruby/3.1.0/gems/sorbet-runtime-0.5.11367/lib/types/private/methods/call_validation.rb:270:in `validate_call'
/opt/homebrew/Library/Homebrew/vendor/bundle/ruby/3.1.0/gems/sorbet-runtime-0.5.11367/lib/types/private/methods/_methods.rb:277:in `block in _on_method_added'
/opt/homebrew/Library/Homebrew/dev-cmd/audit.rb:251:in `block (2 levels) in run'
/opt/homebrew/Library/Homebrew/dev-cmd/audit.rb:248:in `each'
/opt/homebrew/Library/Homebrew/dev-cmd/audit.rb:248:in `flat_map'
/opt/homebrew/Library/Homebrew/dev-cmd/audit.rb:248:in `block in run'
/opt/homebrew/Library/Homebrew/dev-cmd/audit.rb:245:in `each'
/opt/homebrew/Library/Homebrew/dev-cmd/audit.rb:245:in `each_with_object'
/opt/homebrew/Library/Homebrew/dev-cmd/audit.rb:245:in `run'
/opt/homebrew/Library/Homebrew/vendor/bundle/ruby/3.1.0/gems/sorbet-runtime-0.5.11367/lib/types/private/methods/call_validation.rb:270:in `bind_call'
/opt/homebrew/Library/Homebrew/vendor/bundle/ruby/3.1.0/gems/sorbet-runtime-0.5.11367/lib/types/private/methods/call_validation.rb:270:in `validate_call'
/opt/homebrew/Library/Homebrew/vendor/bundle/ruby/3.1.0/gems/sorbet-runtime-0.5.11367/lib/types/private/methods/_methods.rb:277:in `block in _on_method_added'
/opt/homebrew/Library/Homebrew/brew.rb:92:in `<main>'
Please report this issue:
  https://docs.brew.sh/Troubleshooting
john@Johns-Air ~ % brew info battery
==> battery: 1.2.1 (auto_updates)
https://github.com/actuallymentor/battery/
Installed
/opt/homebrew/Caskroom/battery/1.2.1 (121B)
From: https://github.com/Homebrew/homebrew-cask/blob/HEAD/Casks/b/battery.rb
==> Name
Battery
==> Description
CLI for managing the battery charging status
==> Artifacts
battery.app (App)
==> Analytics
install: 742 (30 days), 2,201 (90 days), 6,632 (365 days)

[apainintheneck]

Do you have the core cask tap installed locally? By default core casks are installed using the JSON API and that means that the tap is not installed locally.

john@Johns-Air ~ % brew audit --cask battery --debug --verbose
/opt/homebrew/Library/Homebrew/vendor/bundle/ruby/3.1.0/bin/bundle clean
/opt/homebrew/Library/Homebrew/brew.rb (Cask::CaskLoader::FromInstalledPathLoader): loading battery
...

It's currently loading the battery cask from the installed cask file which doesn't set the sourcefile_path so that explains why it ends up being nil and you got a nil error.

You can check the installed taps like this:

$ brew tap
apainintheneck/dev-utils
homebrew/aliases
homebrew/autoupdate
homebrew/bundle
homebrew/cask-fonts
homebrew/cask-versions
homebrew/command-not-found
homebrew/services
homebrew/test-bot

You should see one called homebrew/cask if it's installed locally. I deleted mine to try to debug this.

[johnmcdowell]

Thanks for the support.

I had tried tapping homebrew/cask as I was learning about cask development / changes / audit, but this message scared me into not doing it when I tried brew tap homebrew/cask as I wasn't "sure":

Error: Tapping homebrew/cask is no longer typically necessary.
Add --force if you are sure you need it done.

I hope there is something positive that comes out your looking into this runtime error other than just my education.

Given that homebrew/cask isn't installed locally unless you push past that error, I would suggest that some error checking be added so that commands that currently runtime error are more understandable when non-experts get in over their head. Perhaps the brew bump errors above have the same root issue as the brew audit. (Not trying tapping with --force first.)

Perhaps at least an "error: file XYZ was not found" if not adding a comment about "locally" or a reference to needing a local tap would be helpful to people learning homebrew development.

[apainintheneck]

Error: Tapping homebrew/cask is no longer typically necessary.
Add --force if you are sure you need it done.

This is the exact use case when it actually is necessary to have the entire tap be installed locally. We could improve the messaging there. I think the original intention was to push non-developers away from having it installed locally. Let me know if you're still having problems after doing that.

I hope there is something positive that comes out your looking into this runtime error other than just my education.

Yeah, it's not a big deal. I actually fixed another bug yesterday that required the core taps to be untapped (Homebrew/brew#17212).

Given that homebrew/cask isn't installed locally unless you push past that error, I would suggest that some error checking be added so that commands that currently runtime error are more understandable when non-experts get in over their head. Perhaps the brew bump errors above have the same root issue as the brew audit. (Not trying tapping with --force first.)

Perhaps at least an "error: file XYZ was not found" if not adding a comment about "locally" or a reference to needing a local tap would be helpful to people learning homebrew development.

Yep, I'll create an issue for that. It's very clearly a bug and we should be more explicit about what is required for that command. Unfortunately that pattern shows up in a few places throughout the codebase and each of them will need to be handled slightly differently.

[johnmcdowell]

Great, thanks so much. I'm all set.