cli-plugins/manager: ignore broken symlinks #5922
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
Member
Author
|
cc @rumpl @Benehiko @vvoland @laurazard let me know if you think this is a good idea, or if we shouldn't ignore these broken links |
Member
|
On the one hand some users might not even know they are executing a plugin since it's hidden under the Perhaps we should rather update the error message with a clearer, "these are the next steps to get rid of this error"? |
Member
Author
|
It's tricky; so in normal cases, this would not happen. In this specific case, it's not even an issue introduced by the user but a bug in Docker Desktop's installer/updater to not cleanup things it created. Ultimately, Docker Desktop should not create these symlinks at all because the CLI plugin search-paths were designed for that; we're currently doing more work than needed, and the CLI is also slower because of that (as it's iterating multiple times over plugins that it will find in multiple places!). If you look at docker info
Client:
Version: 28.0.1
Context: desktop-linux
Debug Mode: false
Plugins:
...
buildx: Docker Buildx (Docker Inc.)
Version: v0.21.1-desktop.1
Path: /Applications/Docker.app/Contents/Resources/cli-plugins/docker-buildxThe It's als not something "solvable" in all cases; for example, bind-mounting the docker run --rm -v /var/run/docker.sock.raw:/var/run/docker.sock -v ~/.docker/:/root/.docker/ docker:cli info > /dev/null
WARNING: Plugin "/root/.docker/cli-plugins/docker-ai" is not valid: failed to fetch metadata: fork/exec /root/.docker/cli-plugins/docker-ai: no such file or directory
WARNING: Plugin "/root/.docker/cli-plugins/docker-buildx" is not valid: failed to fetch metadata: fork/exec /root/.docker/cli-plugins/docker-buildx: no such file or directory
WARNING: Plugin "/root/.docker/cli-plugins/docker-compose" is not valid: failed to fetch metadata: fork/exec /root/.docker/cli-plugins/docker-compose: no such file or directory
WARNING: Plugin "/root/.docker/cli-plugins/docker-debug" is not valid: failed to fetch metadata: fork/exec /root/.docker/cli-plugins/docker-debug: no such file or directory
WARNING: Plugin "/root/.docker/cli-plugins/docker-desktop" is not valid: failed to fetch metadata: fork/exec /root/.docker/cli-plugins/docker-desktop: no such file or directory
WARNING: Plugin "/root/.docker/cli-plugins/docker-dev" is not valid: failed to fetch metadata: fork/exec /root/.docker/cli-plugins/docker-dev: no such file or directory
WARNING: Plugin "/root/.docker/cli-plugins/docker-extension" is not valid: failed to fetch metadata: fork/exec /root/.docker/cli-plugins/docker-extension: no such file or directory
WARNING: Plugin "/root/.docker/cli-plugins/docker-feedback" is not valid: failed to fetch metadata: fork/exec /root/.docker/cli-plugins/docker-feedback: no such file or directory
WARNING: Plugin "/root/.docker/cli-plugins/docker-init" is not valid: failed to fetch metadata: fork/exec /root/.docker/cli-plugins/docker-init: no such file or directory
WARNING: Plugin "/root/.docker/cli-plugins/docker-sbom" is not valid: failed to fetch metadata: fork/exec /root/.docker/cli-plugins/docker-sbom: no such file or directory
WARNING: Plugin "/root/.docker/cli-plugins/docker-scout" is not valid: failed to fetch metadata: fork/exec /root/.docker/cli-plugins/docker-scout: no such file or directory |
Member
Author
|
Having a quick peek at the situation in Docker Desktop, it looks like we make the CLI traverse the same plugins three times;
./build/docker info > /dev/null
Listing plugins in /Applications/Docker.app/Contents/Resources/cli-plugins/
- plugin: docker-ai
- plugin: docker-buildx
- plugin: docker-cloud
- plugin: docker-compose
- plugin: docker-debug
- plugin: docker-desktop
- plugin: docker-dev
- plugin: docker-extension
- plugin: docker-init
- plugin: docker-sbom
- plugin: docker-scout
Listing plugins in /Users/thajeztah/.docker/cli-plugins
- plugin: docker-ai (symlink to /Applications/Docker.app/Contents/Resources/cli-plugins/docker-ai)
- plugin: docker-buildx (symlink to /Applications/Docker.app/Contents/Resources/cli-plugins/docker-buildx)
- plugin: docker-compose (symlink to /Applications/Docker.app/Contents/Resources/cli-plugins/docker-compose)
- plugin: docker-debug (symlink to /Applications/Docker.app/Contents/Resources/cli-plugins/docker-debug)
- plugin: docker-desktop (symlink to /Applications/Docker.app/Contents/Resources/cli-plugins/docker-desktop)
- plugin: docker-dev (symlink to /Applications/Docker.app/Contents/Resources/cli-plugins/docker-dev)
- plugin: docker-extension (symlink to /Applications/Docker.app/Contents/Resources/cli-plugins/docker-extension)
- plugin: docker-feedback
- plugin: docker-init (symlink to /Applications/Docker.app/Contents/Resources/cli-plugins/docker-init)
- plugin: docker-sbom (symlink to /Applications/Docker.app/Contents/Resources/cli-plugins/docker-sbom)
- plugin: docker-scout (symlink to /Applications/Docker.app/Contents/Resources/cli-plugins/docker-scout)
- plugin: docker-shell
Listing plugins in /usr/local/lib/docker/cli-plugins (symlink to /Applications/Docker.app/Contents/Resources/cli-plugins)
- plugin: docker-ai (actual path /Applications/Docker.app/Contents/Resources/cli-plugins/docker-ai)
- plugin: docker-buildx (actual path /Applications/Docker.app/Contents/Resources/cli-plugins/docker-buildx)
- plugin: docker-cloud (actual path /Applications/Docker.app/Contents/Resources/cli-plugins/docker-cloud)
- plugin: docker-compose (actual path /Applications/Docker.app/Contents/Resources/cli-plugins/docker-compose)
- plugin: docker-debug (actual path /Applications/Docker.app/Contents/Resources/cli-plugins/docker-debug)
- plugin: docker-desktop (actual path /Applications/Docker.app/Contents/Resources/cli-plugins/docker-desktop)
- plugin: docker-dev (actual path /Applications/Docker.app/Contents/Resources/cli-plugins/docker-dev)
- plugin: docker-extension (actual path /Applications/Docker.app/Contents/Resources/cli-plugins/docker-extension)
- plugin: docker-init (actual path /Applications/Docker.app/Contents/Resources/cli-plugins/docker-init)
- plugin: docker-sbom (actual path /Applications/Docker.app/Contents/Resources/cli-plugins/docker-sbom)
- plugin: docker-scout (actual path /Applications/Docker.app/Contents/Resources/cli-plugins/docker-scout)
Listing plugins in /usr/local/libexec/docker/cli-plugins
Listing plugins in /usr/lib/docker/cli-plugins
Listing plugins in /usr/libexec/docker/cli-plugins
WARNING: Plugin "/Users/thajeztah/.docker/cli-plugins/docker-feedback" is not valid: failed to fetch metadata: fork/exec /Users/thajeztah/.docker/cli-plugins/docker-feedback: no such file or directoryWhich gets used in order of priority; Plugin: docker desktop
1. /Applications/Docker.app/Contents/Resources/cli-plugins/docker-desktop
2. /Users/thajeztah/.docker/cli-plugins/docker-desktop
3. /usr/local/lib/docker/cli-plugins/docker-desktop
Plugin: docker sbom
1. /Applications/Docker.app/Contents/Resources/cli-plugins/docker-sbom
2. /Users/thajeztah/.docker/cli-plugins/docker-sbom
3. /usr/local/lib/docker/cli-plugins/docker-sbom
Plugin: docker feedback
1. /Users/thajeztah/.docker/cli-plugins/docker-feedback
Plugin: docker ai
1. /Applications/Docker.app/Contents/Resources/cli-plugins/docker-ai
2. /Users/thajeztah/.docker/cli-plugins/docker-ai
3. /usr/local/lib/docker/cli-plugins/docker-ai
Plugin: docker cloud
1. /Applications/Docker.app/Contents/Resources/cli-plugins/docker-cloud
2. /usr/local/lib/docker/cli-plugins/docker-cloud
Plugin: docker debug
1. /Applications/Docker.app/Contents/Resources/cli-plugins/docker-debug
2. /Users/thajeztah/.docker/cli-plugins/docker-debug
3. /usr/local/lib/docker/cli-plugins/docker-debug
Plugin: docker dev
1. /Applications/Docker.app/Contents/Resources/cli-plugins/docker-dev
2. /Users/thajeztah/.docker/cli-plugins/docker-dev
3. /usr/local/lib/docker/cli-plugins/docker-dev
Plugin: docker extension
1. /Applications/Docker.app/Contents/Resources/cli-plugins/docker-extension
2. /Users/thajeztah/.docker/cli-plugins/docker-extension
3. /usr/local/lib/docker/cli-plugins/docker-extension
Plugin: docker init
1. /Applications/Docker.app/Contents/Resources/cli-plugins/docker-init
2. /Users/thajeztah/.docker/cli-plugins/docker-init
3. /usr/local/lib/docker/cli-plugins/docker-init
Plugin: docker scout
1. /Applications/Docker.app/Contents/Resources/cli-plugins/docker-scout
2. /Users/thajeztah/.docker/cli-plugins/docker-scout
3. /usr/local/lib/docker/cli-plugins/docker-scout
Plugin: docker shell
1. /Users/thajeztah/.docker/cli-plugins/docker-shell
Plugin: docker buildx
1. /Applications/Docker.app/Contents/Resources/cli-plugins/docker-buildx
2. /Users/thajeztah/.docker/cli-plugins/docker-buildx
3. /usr/local/lib/docker/cli-plugins/docker-buildx
Plugin: docker compose
1. /Applications/Docker.app/Contents/Resources/cli-plugins/docker-compose
2. /Users/thajeztah/.docker/cli-plugins/docker-compose
3. /usr/local/lib/docker/cli-plugins/docker-compose
WARNING: Plugin "/Users/thajeztah/.docker/cli-plugins/docker-feedback" is not valid: failed to fetch metadata: fork/exec /Users/thajeztah/.docker/cli-plugins/docker-feedback: no such file or directory |
thaJeztah
force-pushed
the
ignore_broken_symlinks
branch
from
d231cf6 to
68164c4
Compare
thaJeztah
force-pushed
the
ignore_broken_symlinks
branch
2 times, most recently
from
e3204f6 to
3f0d4de
Compare
thaJeztah
commented
Sep 1, 2025
Comment on lines
80
to
70
| case os.ModeSymlink: | ||
| if _, err := os.Stat(filepath.Join(d, dentry.Name())); err != nil { | ||
| // Skip broken symlinks unless debug is enabled. With debug | ||
| // enabled, this will print a warning in "docker info". | ||
| if errors.Is(err, os.ErrNotExist) && !debug.IsEnabled() { | ||
| continue | ||
| } | ||
| } |
Member
Author
thaJeztah
force-pushed
the
ignore_broken_symlinks
branch
from
3f0d4de to
2ea69ac
Compare
Benehiko
approved these changes
Sep 2, 2025
vvoland
reviewed
Sep 17, 2025
Comment on lines
84
to
69
| if _, err := os.Stat(filepath.Join(d, dentry.Name())); errors.Is(err, os.ErrNotExist) { | ||
| if !debug.IsEnabled() { | ||
| continue | ||
| } | ||
| } |
Collaborator
There was a problem hiding this comment.
We're already in a if !debug.IsEnabled() block
Suggested change
| if _, err := os.Stat(filepath.Join(d, dentry.Name())); errors.Is(err, os.ErrNotExist) { | |
| if !debug.IsEnabled() { | |
| continue | |
| } | |
| } | |
| if _, err := os.Stat(filepath.Join(d, dentry.Name())); errors.Is(err, os.ErrNotExist) { | |
| continue | |
| } |
Member
Author
There was a problem hiding this comment.
Doh! I initially had the check here, then decided "why do the stat at all in debug more?", and forgot to remove.
Should be fixed now; PAL @vvoland
Before this patch, a broken symlink would print a warning;
docker info > /dev/null
WARNING: Plugin "/Users/thajeztah/.docker/cli-plugins/docker-feedback" is not valid: failed to fetch metadata: fork/exec /Users/thajeztah/.docker/cli-plugins/docker-feedback: no such file or directory
After this patch, such symlinks are ignored:
docker info > /dev/null
With debug enabled, we don't ignore the faulty plugin, which will
make the warning shown on docker info;
mkdir -p ~/.docker/cli-plugins
ln -s nosuchplugin ~/.docker/cli-plugins/docker-brokenplugin
docker --debug info
Client:
Version: 29.0.0-dev
Context: default
Debug Mode: true
Plugins:
buildx: Docker Buildx (Docker Inc.)
Version: v0.25.0
Path: /usr/libexec/docker/cli-plugins/docker-buildx
WARNING: Plugin "/Users/thajeztah/.docker/cli-plugins/docker-brokenplugin" is not valid: failed to fetch metadata: fork/exec /Users/thajeztah/.docker/cli-plugins/docker-brokenplugin: no such file or directory
# ...
We should als consider passing a "seen" map to de-duplicate entries.
Entries can be either a direct symlink or in a symlinked path (for
which we can filepath.EvalSymlinks). We need to benchmark the overhead
of resolving the symlink vs possibly calling the plugin (to get their
metadata) further down the line.
Signed-off-by: Sebastiaan van Stijn <[email protected]>
thaJeztah
force-pushed
the
ignore_broken_symlinks
branch
from
2ea69ac to
9b2f831
Compare
vvoland
approved these changes
Sep 24, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Before this patch, a broken symlink would print a warning;
After this patch, such symlinks are ignored:
With debug enabled, we don't ignore the faulty plugin, which will
make the warning shown on docker info;
We should als consider passing a "seen" map to de-duplicate entries. Entries can be either a direct symlink or in a symlinked path (for which we can filepath.EvalSymlinks). We need to benchmark the overhead of resolving the symlink vs possibly calling the plugin (to get their metadata) further down the line.
- Human readable description for the release notes
- A picture of a cute animal (not mandatory but encouraged)