Git repositories with spaces in their name are not recognized #1211

Activity

1. ardislu

   added

   bug

   on Feb 1, 2023
2. welcome commented on Feb 1, 2023

   

   welcomeBot

   on Feb 1, 2023

   More actions

   Thank you for opening your first issue in this project! Engagement like this is essential for open source projects! 🤗
   
   If you haven't done so already, check out Jupyter's Code of Conduct. Also, please try to follow the issue template as it helps other other community members to contribute more effectively.
   
   You can meet the other Jovyans by joining our Discourse forum. There is also an intro thread there where you can stop by and say Hi! 👋
   
   Welcome to the Jupyter community! 🎉
3. ardislu

   changed the title [-]Git repositories with spaces in their name are not recognized by the extension[/-] [+]Git repositories with spaces in their name are not recognized[/+] on Feb 1, 2023
4. fcollonval commented on Feb 1, 2023

   

   fcollonval

   on Feb 1, 2023

   Member

   More actions

   Thanks @ardislu

   would you be willing to contribute fixing this? I can provide pointers
5. ardislu commented on Feb 2, 2023

   

   ardislu

   on Feb 2, 2023

   ContributorAuthor

   More actions

   @fcollonval Sure, I gave it a shot.

   I believe the issue is that the path ends up unescaped when it gets passed to various functions in git.py.

   But in this case, we actually want spaces to remain escaped because that's how the folder name is cloned. So my first pass to get it working was to update each execute call to re-escape the spaces in the directory path.

   Either like this:

   async def show_prefix(self, path):
       cmd = ["git", "rev-parse", "--show-prefix"]
       code, my_output, my_error = await execute(
           cmd,
   -       cwd=path,
   +       cwd=quote(path, safe=":/\\"),
       )

   Or like this:

   async def branch(self, path):
   +   path = quote(path, safe=":/\\")
       heads = await self.branch_heads(path)

   This solution fixes this issue, but I don't think it's optimal:

   • If the user manually renames the folder to replace %20 with spaces, like suggested in workaround 1, then this solution will break it.
   • There are 53 execute calls in git.py that would need to get updated, plus possibly others in other files I haven't looked at.

   Any suggestions? Thank you for your help on this.
6. ardislu commented on Feb 4, 2023

   

   ardislu

   on Feb 4, 2023

   Last edited by ardislu

   ContributorAuthor

   More actions

   Thought about it some more and realized it'd be much easier and simpler to just move the same quote logic directly into execute. Created #1214 to do that. Confirmed that folders named repo with spaces in its name and repo%20with%20spaces%20in%20its%20name now both work as expected.

   Edit: if two folders named repo with spaces in its name and repo%20with%20spaces%20in%20its%20name both exist in the same folder, then my update will cause git commands from either folder to only go to repo with spaces in its name. Note that this is the same behavior as currently (maybe another issue should be raised for this). So I think the root cause is not yet fixed.

   I believe the root cause is that this URL:

   /repo%2520with%2520spaces%2520in%2520its%2520name
   

   Should only be decoded once to:

   /repo%20with%20spaces%20in%20its%20name
   

   But there is some logic which decodes it again, so the actual string passed to the git.py functions is:

   /repo with spaces in its name
   

   However, I'm having a hard time finding where/how the URL is getting decoded twice. In handlers.py I see the path is decoded by url2localpath:

   local_path = os.path.join(os.path.expanduser(cm.root_dir), url2path(path))

   But I can't see where it's getting decoded again before getting passed to git.py. @fcollonval Any ideas?