bug fix: assert because M.version is nil #960

ray-x · 2024-03-29T01:39:20Z

Fixed a bug related to version checking before the version was established.

This issue likely arose due to the asynchronous nature of gitsigns operations. By adding logging for the check_version and _set_version functions, I observed the following behavior:

Initial version check (2.13) was against nil; no version being set and returning false.
Subsequently, the version was correctly set, showing values for major, minor, and patch levels.
However, an error occurred when checking the version again due to an attempt to access a non-existent .git directory, causing a failure in the coroutine.

Bellow is the logs I capture

check version { 2, 13 } against nil  <- inside check_version() git.lua:90
no version nil return false               <- after   if not M.version then in     check_version()                                                                                                                                                                                                                              
version set:  {                                   <- version is set                                                                                                                                                                                                              
  major = 2,                                                                                                                                                                                                                                                    
  minor = 39,                                                                                                                                                                                                                                                   
  patch = 3                                                                                                                                                                                                                                                     
}                                                                                                                                                                                                                                                               
check version { 2, 13 } against {    <- following calls are OK                                                                                                                                                                                                                           
  major = 2,                                                                                                                                                                                                                                                    
  minor = 39,                                                                                                                                                                                                                                                   
  patch = 3                                                                                                                                                                                                                                                     
}                                                                                                                                                                                                                                                               
Error executing luv callback:                                                                                                                                                                                                                                   
...cal/share/nvim/lazy/gitsigns.nvim/lua/gitsigns/async.lua:85: The coroutine failed with this message: ...local/share/nvim/lazy/gitsigns.nvim/lua/gitsigns/git.lua:316: ENOENT: no such file or directory: .git                                                
stack traceback:                                                                                                                                                                                                                                                
        [C]: in function 'assert'                                                                                                                                                                                                                               
        ...local/share/nvim/lazy/gitsigns.nvim/lua/gitsigns/git.lua:316: in function 'get_repo_info'                                                                                                                                                            
        ...xu/.local/share/nvim/lazy/gitsigns.nvim/lua/gitsigns.lua:53: in function 'update_cwd_head'                                                                                                                                                           
        ...xu/.local/share/nvim/lazy/gitsigns.nvim/lua/gitsigns.lua:143: in function 'setup_cwd_head'                                                                                                                                                           
        ...xu/.local/share/nvim/lazy/gitsigns.nvim/lua/gitsigns.lua:189: in function <...xu/.local/share/nvim/lazy/gitsigns.nvim/lua/gitsigns.lua:162>

This issue appears to be sporadic and not consistently reproducible for a couple of reasons:

The version eventually gets correctly set, depending on the timing and manner of the Git command execution.
My setup involves a mini session manager, where the root folder contains a .git folder, but the working folder does not. For example, my root folder might be nvim, but my working directory is nvim/lua/plugin. If the version has not yet been set, Lua asserts an error due to the absence of the .git directory in the working folder.

lewis6991

Thanks

lewis6991 · 2024-03-29T07:46:54Z

lua/gitsigns/git.lua

@@ -88,7 +88,8 @@ end
 --- @return boolean
 local function check_version(version)
  if not M.version then
-    return false
+    M._set_version(config._git_version)
+    return check_version(version)


I don't think this line is necessary. Once the version is set the rest of the function should work.

The plugin functions properly once the M.version is loaded. However, the persistent assert messages that appear every time files are loaded are bothersome. I would appreciate it if the assert statement in get_repo_info could be eliminated.

- Avoid emitting errors when the version check fails. - Put version checking into separate module. - Pull in upstream changes for vim.system. Fixes: #948 Closes: #960

bug fix: assert because M.version is nil

7606db5

lewis6991 reviewed Mar 29, 2024

View reviewed changes

lewis6991 mentioned this pull request Apr 1, 2024

fix(version): handle version checks more gracefully #962

Merged

lewis6991 closed this in #962 Apr 1, 2024

lewis6991 closed this in 3cb0f84 Apr 1, 2024

lewis6991 mentioned this pull request Apr 17, 2024

chore(main): release 1.0.0 #990

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

bug fix: assert because M.version is nil #960

bug fix: assert because M.version is nil #960

Uh oh!

ray-x commented Mar 29, 2024

Uh oh!

lewis6991 left a comment

Uh oh!

lewis6991 Mar 29, 2024

Uh oh!

ray-x Mar 29, 2024

Uh oh!

Uh oh!

Uh oh!

bug fix: assert because M.version is nil #960

bug fix: assert because M.version is nil #960

Uh oh!

Conversation

ray-x commented Mar 29, 2024

Uh oh!

lewis6991 left a comment

Choose a reason for hiding this comment

Uh oh!

lewis6991 Mar 29, 2024

Choose a reason for hiding this comment

Uh oh!

ray-x Mar 29, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!