bug: Malformed URL causes Lazy to delete root plugins directory, crash w/ unhelpful error messages

[textzenith]

Did you check docs and existing issues?

• I have read all the lazy.nvim docs
• I have searched the existing issues of lazy.nvim
• I have searched the existing issues of plugins related to this issue

Neovim version (nvim -v)

0.10.0-dev-1705+g6b19170d4-dirty

Operating system/version

Ubuntu 20.04

Describe the bug

I've just migrated by macro from Packer to Lazy, which was fun, and almost spectacularly successful 😄, except for this gem:

Add something like {'https://git.sr.ht/~swalladge/antarctic-vim/'}, to one of your source files. This will delete your root plugin folder and cause Lazy to crash spectacularly.

Here's what I imagine is happening: Lazy will parse this URL (I'm using the default URL rules) and output "", that is an empty string. It will try to clone / install this repository with a zero-character name and, of course, fail. Even worse, it will set the empty string as its target directory, i.e your root folder, see that it fails, and subsequently delete the folder it attempted to clone into (your root folder). Oh, and now all of your other plugins have errors, too.

Let me know how close I am to the mark here. Can you reproduce this?

Another (very annoying) aspect to this problem is that it's hard to understand what's going on, particularly if you're new to Lazy. What I saw on my screen was over 100 'failed to clone' messages. I wasn't sure if the empty string at the top was the culprit or not—I did not know what caused this. I spent over an hour combing my config to see if Lazy was failing to install to / read from the right place! 🫠

Why it's important to fix this bug: Alright, by always having perfectly formed URLs and following the (justified!) advice to keep nothing precious (i.e. no local changes) inside the root folder, this is an issue that can be avoided. I think, however, because Lazy is becoming the de-facto package manager for Neovim, we ought to take special care to be nice to novice users and make things go as swimmingly as possible for them 🙂

Right, I hope that helps! I want to suggest a more in-depth solution, but I also want to do something other than Neovim package management for a few hours of my life. Probably you do too, @folke 🥲

—Written in a Tokyonight Nvim instance

Steps To Reproduce

Try to load a plugin with the above URL or similar.

Expected Behavior

Firstly, Lazy should recognize the malformed / mal-parsed URL and simply move on. As it is, it deleted the root folder, which caused every other plugin to fail to load.

The issue is compounded by the fact this looks like a plugin-installation problem, rather than a URL format problem. The errors were somewhat puzzling. It's probably easier to fix the issue than to design a legible error message for the current problem.

I would suggest the following: Plugin URL "https://git.sr.ht/~swalladge/antarctic-vim/" malformed, skipping to next

Repro

-- DO NOT change the paths and don't remove the colorscheme
local root = vim.fn.fnamemodify("./.repro", ":p")

-- set stdpaths to use .repro
for _, name in ipairs({ "config", "data", "state", "cache" }) do
  vim.env[("XDG_%s_HOME"):format(name:upper())] = root .. "/" .. name
end

-- bootstrap lazy
local lazypath = root .. "/plugins/lazy.nvim"
if not vim.loop.fs_stat(lazypath) then
  vim.fn.system({ "git", "clone", "--filter=blob:none", "https://github.com/folke/lazy.nvim.git", lazypath, })
end
vim.opt.runtimepath:prepend(lazypath)

-- install plugins
local plugins = {
  "folke/tokyonight.nvim",
  "https://git.sr.ht/~swalladge/antarctic-vim/"
}
require("lazy").setup(plugins, {
  root = root .. "/plugins",
})

vim.cmd.colorscheme("tokyonight")

[folke]

Thank you for reporting!

The issue was that the plugin name is the last part of the url/dir, which in this case was "" since it ended with a forward slash.

Fixed and also added an extra safety check in case name would resolve to the empty string in another way.