Wrong tap when listing installed casks from custom taps using --json=v2 --installed

[cdalvaro]

brew doctor output

Your system is ready to brew.

Verification

• My "brew doctor output" above says Your system is ready to brew. and am still able to reproduce my issue.
• I ran brew update twice and am still able to reproduce my issue.
• This issue's title and/or description do not reference a single formula e.g. brew install wget. If they do, open an issue at https://github.com/Homebrew/homebrew-core/issues/new/choose instead.

brew config output

HOMEBREW_VERSION: 4.3.3-2-g26a87c0
ORIGIN: https://github.com/Homebrew/brew
HEAD: 26a87c08f5767ac9681863c407f38e545c00ca0e
Last commit: 16 minutes ago
Core tap HEAD: 4b20c62ec63f00541062ab39e5a6d7dcb54c4c4a
Core tap last commit: 20 minutes ago
Core tap JSON: 03 Jun 12:05 UTC
Core cask tap JSON: 03 Jun 12:05 UTC
HOMEBREW_PREFIX: /opt/homebrew
HOMEBREW_CASK_OPTS: []
HOMEBREW_EDITOR: vimr
HOMEBREW_MAKE_JOBS: 8
HOMEBREW_SORBET_RUNTIME: set
Homebrew Ruby: 3.3.2 => /opt/homebrew/Library/Homebrew/vendor/portable-ruby/3.3.2/bin/ruby
CPU: octa-core 64-bit arm_firestorm_icestorm
Clang: 15.0.0 build 1500
Git: 2.45.2 => /opt/homebrew/bin/git
Curl: 8.6.0 => /usr/bin/curl
macOS: 14.5-arm64
CLT: 15.3.0.0.1.1708646388
Xcode: 15.4
Rosetta 2: false

What were you trying to do (and why)?

I'm trying to list all my installed formulae and casks, and looking for their corresponding taps using the command: brew info --json=v2 --installed.

However, I have discovered that casks from custom taps have homebrew/cask as the assigned tap. (This may only happens with casks that are also available from the homebrew/cask tap. Currently, I only have two casks in my custom tap cdalvaro/tap, but they are available at the official repository too).

I'm improving the mac_brew_pkg module for salt (saltstack/salt#66611) and I have encountered this issue writing some tests.

What happened (include all command output)?

After installing a cask from a custom tap:

brew install --cask cdalvaro/tap/salt

The tap information is wrong when it is queried using: brew info --json=v2 --installed

brew info --json=v2 --installed | jq -r '.casks[] | select(.token == "salt") | .tap'
homebrew/cask

What did you expect to happen?

I expected to see cdalvaro/tap as the tap for the salt cask.

Step-by-step reproduction instructions (by running brew commands)

Carlos in Mac Studio in ~
⌘ brew info --json=v2 --installed | jq -r '.casks[] | select(.token == "salt") | .tap'
homebrew/cask

Carlos in Mac Studio in ~
⌘ brew uninstall --cask salt
==> Uninstalling Cask salt
==> Removing launchctl service com.saltstack.salt.api
==> Removing launchctl service com.saltstack.salt.master
==> Removing launchctl service com.saltstack.salt.minion
==> Removing launchctl service com.saltstack.salt.syndic
==> Uninstalling packages with sudo; the password may be necessary:
com.saltstack.salt
==> Purging files for version 3007.1 of Cask salt

Carlos in Mac Studio in ~
⌘ brew info --json=v2 --installed | jq -r '.casks[] | select(.token == "salt") | .tap'

Carlos in Mac Studio in ~
⌘ brew install --cask cdalvaro/tap/salt
==> Auto-updating Homebrew...
Adjust how often this is run with HOMEBREW_AUTO_UPDATE_SECS or disable with
HOMEBREW_NO_AUTO_UPDATE. Hide these hints with HOMEBREW_NO_ENV_HINTS (see `man brew`).
==> Auto-updated Homebrew!
==> Updated Homebrew from 4.3.2 (e130e47f23) to 4.3.3 (26a87c08f5).
No changes to formulae or casks.


The 4.3.3 changelog can be found at:
  https://github.com/Homebrew/brew/releases/tag/4.3.3
==> Caveats
Included services:

sudo launchctl load -w /Library/LaunchDaemons/com.saltstack.salt.api.plist
sudo launchctl load -w /Library/LaunchDaemons/com.saltstack.salt.master.plist
sudo launchctl load -w /Library/LaunchDaemons/com.saltstack.salt.minion.plist
sudo launchctl load -w /Library/LaunchDaemons/com.saltstack.salt.syndic.plist

==> Downloading https://repo.saltproject.io/salt/py3/macos/minor/3007.1/salt-3007.1-py3-arm64.pkg
################################################################################################################################ 100.0%
==> Installing Cask salt
==> Running installer for salt with sudo; the password may be necessary.
installer: Package name is Salt 3007.1 (Python 3)
installer: Installing at base path /
installer: The install was successful.
🍺  salt was successfully installed!

Carlos in Mac Studio in ~
⌘ brew info --json=v2 --installed | jq -r '.casks[] | select(.token == "salt") | .tap'
homebrew/cask

[apainintheneck]

brew/Library/Homebrew/cask/caskroom.rb

Lines 57 to 66 in e8430b2

	def self.casks(config: nil)
	tokens.sort.filter_map do |token|
	CaskLoader.load(token, config:, warn: false)
	rescue TapCaskAmbiguityError => e
	T.must(e.loaders.first).load(config:)
	rescue
	# Don't blow up because of a single unavailable cask.
	nil
	end
	end

This is the method that is used to load installed casks in the brew info command. It just grabs all directories in the caskroom and uses the base name of each of them to parse the token. Since this particular token is ambiguous (it's in multiple taps) and we're using the short token, it falls back to the first cask with a matching token which happens to be the one in homebrew/cask.

We do store the original caskfile that was used during installation so we could potentially try to get the full token from there. At the end of the day, this sort of situation will eventually be elegantly handled by adding an install receipt for casks (see #17013).

[cdalvaro]

Tested and working! (Although apparently it only works for newly installed casks)

Carlos in MacBook in ~
⌘ brew update
==> Updating Homebrew...
==> Updated Homebrew from 4.3.19 (81bac6c27e) to 4.3.21 (9042eb9347).
No changes to formulae or casks.

The 4.3.21 changelog can be found at:
  https://github.com/Homebrew/brew/releases/tag/4.3.21

Carlos in MacBook in ~
⌘ brew info --json=v2 --installed | jq -r '.casks[] | select(.token == "salt") | .tap'
homebrew/cask

Carlos in MacBook in ~
⌘ brew uninstall --cask salt
==> Uninstalling Cask salt
==> Removing launchctl service com.saltstack.salt.api
Password:
==> Removing launchctl service com.saltstack.salt.master
==> Removing launchctl service com.saltstack.salt.minion
==> Removing launchctl service com.saltstack.salt.syndic
==> Uninstalling packages with sudo; the password may be necessary:
com.saltstack.salt
==> Purging files for version 3007.1 of Cask salt

Carlos in MacBook in ~
⌘ brew install --cask cdalvaro/tap/salt
==> Caveats
Included services:

sudo launchctl load -w /Library/LaunchDaemons/com.saltstack.salt.api.plist
sudo launchctl load -w /Library/LaunchDaemons/com.saltstack.salt.master.plist
sudo launchctl load -w /Library/LaunchDaemons/com.saltstack.salt.minion.plist
sudo launchctl load -w /Library/LaunchDaemons/com.saltstack.salt.syndic.plist

==> Downloading https://repo.saltproject.io/salt/py3/macos/minor/3007.1/salt-3007.1-py3-arm64.pkg
################################################################################################################################ 100.0%
==> Installing Cask salt
==> Running installer for salt with sudo; the password may be necessary.
Password:
installer: Package name is Salt 3007.1 (Python 3)
installer: Installing at base path /
installer: The install was successful.
🍺  salt was successfully installed!

Carlos in MacBook in ~
⌘ brew info --json=v2 --installed | jq -r '.casks[] | select(.token == "salt") | .tap'
cdalvaro/tap

Let's go! 🚀 Thank you team!

[Rylan12]

Although apparently it only works for newly installed casks

Yes, unfortunately, this will continue to be true. Before, we did not save any information about cask installs except for the cask file, which isn't enough on its own to determine which tap it came from. Now, all cask installs also write an INSTALL_RECEIPT.json file to disk (under Caskroom/<name>/.metadata) that includes the tap information and can be referenced later on when loading installed casks to ensure that their tap is set correctly.

Unfortunately, the only way to populate this file is to reinstall the cask (because otherwise we have the same problem of not knowing what tap it came from)