[Windows] "panic: Any" crash in repository with filenames exceeding MAX_PATH

[nbusseneau]

Hello! Love this tool, thanks for your work 😄
I encountered and reproduced an issue with the Windows binary on repositories containing long filenames.

Bug description
On Windows, when running gitui.exe from the command line in repositories with filenames exceeding MAX_PATH (260 characters), it fails with the following error:

panic: Any
trace:
   0: <unknown>
   1: <unknown>
   2: <unknown>
   3: <unknown>
   4: <unknown>
   5: <unknown>
   6: <unknown>
   7: <unknown>
   8: <unknown>
   9: BaseThreadInitThunk
  10: RtlUserThreadStart

Running from Git Bash yields an additional bit of information about the crash origin:

5⣯: <unknown>>n>load: Any, message: Some(failed to fetch status: Git(Error { code: -1, klass: 30, message: "invalid path \'\\\\?\\C:\\U
   6: <unknown>\Workspace\\Git\\toto\\very-long-path-lorem-ipsum-dolor-sit-amet-consectetur-adipiscing-elit-quisque-pharetra-faucibus-d
   7: <unknown>orbi-dolor-ligula-tempus-dir\\very-long-path-lorem-ipsum-dolor-sit-amet-consectetur-adipiscing-elit-quisque-pharetra-faupanic: Anynown>uctor-morbi-dolor-ligula-tempus\' (path too long)" })), location: Location { file: "asyncgit\\src\\status.rs", line: 122trace:<unknown>
   0: <unknown>
   1: <unknown>
   2: <unknown>
   3: <unknown>
   4: <unknown>
   5: <unknown>dInitThunk
   6: <unknown>readStart
   7: <unknown>
   8: <unknown>
   9: BaseThreadInitThunk
  10: RtlUserThreadStart

To reproduce
On Windows, from command line:

git init toto
cd toto
:: 136 characters long file name
echo . > very-long-path-lorem-ipsum-dolor-sit-amet-consectetur-adipiscing-elit-quisque-pharetra-faucibus-diam-ut-auctor-morbi-dolor-ligula-tempus
:: 140 characters long directory name
mkdir very-long-path-lorem-ipsum-dolor-sit-amet-consectetur-adipiscing-elit-quisque-pharetra-faucibus-diam-ut-auctor-morbi-dolor-ligula-tempus-dir
:: At this point, gitui works
gitui
:: Move file inside directory, which will exceed MAX_PATH length
mv very-long-path-lorem-ipsum-dolor-sit-amet-consectetur-adipiscing-elit-quisque-pharetra-faucibus-diam-ut-auctor-morbi-dolor-ligula-tempus very-long-path-lorem-ipsum-dolor-sit-amet-consectetur-adipiscing-elit-quisque-pharetra-faucibus-diam-ut-auctor-morbi-dolor-ligula-tempus-dir\
:: At this point, gitui crashes
gitui

Expected behavior
gitui does not crash. Since Git allows working with long paths on Windows thanks to git config core.longpaths (usually set at the --system or --global level), this scenario is not an oddity.

Context

• OS/Distro + Version: Windows 10
• GitUI Version: 0.8
• Rust version: unknown (bundled in .exe I guess?)

[extrawurst]

@Skymirrh thanks for reporting this, unfortunately I have no windows machine at my disposal, I would need support here.

[MCord]

I can look into this.

[laarmen]

I just had a quick look, and even if the gitui code were ready to handle long paths, in the end the backing libgit2 doesn't seem to cope with them just yet, see this issue and this recent pull request.

[extrawurst]

@MCord thanks for volunteering here, but I think @laarmen is right and the only thing we can do is hope/wait for libgit2 to sort this limitation. BUT at least this issue should be resolved to gracefully have gitui exit with a compelling message and maybe even link the libgit issue so people can show demand :)

edit: funny how many tools suffer this: cargo, nodegit (used by many like GitKraken), gitup and even tortoiseGit

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

[nbusseneau]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

Perhaps this issue should be marked to be exempted, as it's not really getting "stale due to inactivity"?

[mdonoughe]

I cannot reproduce the crash. Instead of crashing, gitui just displays no unstaged files, even if there are unstaged files with short names.

As of the most recent code, even if you add the manifest to enable long filenames for gitui.exe, libgit2 checks if the path of the file it is trying to diff is longer than the old MAX_PATH constant before passing the path to the Win32 API. If the name is longer, diff generation ends (for the whole directory) and libgit2 returns code -1 and no results.

[nbusseneau]

Still reproducing on my end with v0.10.1, with the steps given in OP. Perhaps your issue is something different?

[extrawurst]

@mdonoughe I guess you build yourself from master, right?

[mdonoughe]

Yeah I was using b21fad7 built locally.