regression: using neogit with external prompt for SSH freezes neovim

[akinsho]

Description

Previously i.e. probably over a year ago+ at this point, I was able to use neogit with 1Password storing my ssh keys. This means that when committing or when in some instances running a simple git fetch for refreshing a TUI program, this would throw up an OS prompt from 1Password to authorize using the SSH key. This used to work and for context works fine with Lazygit. I recently started using 1password again for this but have found that neogit no longer supports this and neovim freezes entirely.

Example of SSH auth prompt

Neovim version

NVIM v0.10.0 Build type: Release LuaJIT 2.1.1716656478

Operating system and version

macOS 11.5

Steps to reproduce

1. Setup 1password to use SSH from the link above.
2. Update SSH Config

   Host *
   IdentityAgent "~/.1password/agent.sock"

3. Open neovim in a repository and launch neogit

Expected behavior

A prompt should be opened so I can authorize the action

Actual behavior

Neovim CPU usages rises to 99% and the process completely hangs

Minimal config

-- NOTE: See the end of this file if you are reporting an issue, etc. Ignore all the "scary" functions up top, those are
-- used for setup and other operations.
local M = {}

local base_root_path = vim.fn.fnamemodify(debug.getinfo(1, "S").source:sub(2), ":p:h") .. "/.min"
function M.root(path)
  return base_root_path .. "/" .. (path or "")
end

function M.load_plugin(plugin_name, plugin_url)
  local package_root = M.root("plugins/")
  local install_destination = package_root .. plugin_name
  vim.opt.runtimepath:append(install_destination)

  if not vim.loop.fs_stat(package_root) then
    vim.fn.mkdir(package_root, "p")
  end

  if not vim.loop.fs_stat(install_destination) then
    print(string.format("> Downloading plugin '%s' to '%s'", plugin_name, install_destination))
    vim.fn.system({
      "git",
      "clone",
      "--depth=1",
      plugin_url,
      install_destination,
    })
    if vim.v.shell_error > 0 then
      error(string.format("> Failed to clone plugin: '%s' in '%s'!", plugin_name, install_destination),
        vim.log.levels.ERROR)
    end
  end
end

---@alias PluginName string The plugin name, will be used as part of the git clone destination
---@alias PluginUrl string The git url at which a plugin is located, can be a path. See https://git-scm.com/book/en/v2/Git-on-the-Server-The-Protocols for details
---@alias MinPlugins table<PluginName, PluginUrl>

---Do the initial setup. Downloads plugins, ensures the minimal init does not pollute the filesystem by keeping
---everything self contained to the CWD of the minimal init file. Run prior to running tests, reproducing issues, etc.
---@param plugins? table<PluginName, PluginUrl>
function M.setup(plugins)
  vim.opt.packpath = {}                      -- Empty the package path so we use only the plugins specified
  vim.opt.runtimepath:append(M.root(".min")) -- Ensure the runtime detects the root min dir

  -- Install required plugins
  if plugins ~= nil then
    for plugin_name, plugin_url in pairs(plugins) do
      M.load_plugin(plugin_name, plugin_url)
    end
  end

  vim.env.XDG_CONFIG_HOME = M.root("xdg/config")
  vim.env.XDG_DATA_HOME = M.root("xdg/data")
  vim.env.XDG_STATE_HOME = M.root("xdg/state")
  vim.env.XDG_CACHE_HOME = M.root("xdg/cache")

  -- NOTE: Cleanup the xdg cache on exit so new runs of the minimal init doesn't share any previous state, e.g. shada
  vim.api.nvim_create_autocmd("VimLeave", {
    callback = function()
      vim.fn.system({
        "rm",
        "-r",
        "-f",
        M.root("xdg")
      })
    end
  })
end

-- NOTE: If you have additional plugins you need to install to reproduce your issue, include them in the plugins
-- table within the setup call below.
M.setup({
  plenary = "https://github.com/nvim-lua/plenary.nvim.git",
  telescope = "https://github.com/nvim-telescope/telescope.nvim",
  diffview = "https://github.com/sindrets/diffview.nvim",
  neogit = "https://github.com/NeogitOrg/neogit"
})
-- WARN: Do all plugin setup, test runs, reproductions, etc. AFTER calling setup with a list of plugins!
-- Basically, do all that stuff AFTER this line.
require("neogit").setup({}) -- For instance, setup Neogit

[CKolkey]

😓 Awesome. Could you run NEOGIT_LOG_LEVEL="debug" NEOGIT_LOG_FILE="true" NEOGIT_DEBUG=true nvim to capture some logs, then trigger the issue?

(:= require("neogit").get_log_file_path() will print the log location)

[akinsho]

@CKolkey thanks for the quick response. I just tried that and nothing new gets logged. Seems like it freezes straightaway. No UI gets opened. Seems like whatever causes the hang happens during the loading of the plugin. The last log I have had it's last entry in 2022. Opening with the debug command didn't change that

[CKolkey]

Oh, so its when you run :Neogit ?

[akinsho]

Yeah it does