Disable interactive git terminal prompts during fetches by piegamesde · Pull Request #11744 · astral-sh/uv

piegamesde · 2025-02-24T11:52:38Z

Summary

The animation shadows any interactive authentication prompt which may occur when resolving dependencies of private repos.

Fixes #5107.

Test Plan

I started creating install_git_private_https_interactive as a regression test but am unsure how to test this because it is interactive and I don't really know the test framework

piegamesde · 2025-02-24T12:06:06Z

It looks like the test drive is having at least some sort of git credentials configuration leaking through global user state. If I run it naively, it fails directly:

   Updating https://github.com/astral-test/uv-private-pypackage (HEAD)                                                                                                     × Failed to download and build `uv-private-pypackage @ git+https://github.com/astral-test/uv-private-pypackage`
  ├─▶ Git operation failed
  ├─▶ failed to clone into: /home/piegames/.cache/uv/git-v0/db/8401f5508e3e612d
  ╰─▶ process didn't exit successfully: `/home/piegames/.nix-profile/bin/git fetch --force --update-head-ok 'https://github.com/astral-test/uv-private-pypackage'
      '+HEAD:refs/remotes/origin/HEAD'` (exit status: 128)
      --- stderr
      remote: Repository not found.
      fatal: repository 'https://github.com/astral-test/uv-private-pypackage/' not found

But if I run it with my .git-credentials file deleted, I instead get the desired password prompt

    Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.20s
     Running `/home/piegames/.cache/cargo-target/debug/uv pip install 'git+https://github.com/astral-test/uv-private-pypackage'`
   Updating https://github.com/astral-test/uv-private-pypackage (HEAD)
Resolving dependencies...                                                                                                                                                Username for 'https://github.com': piegamesde
   Updating https://github.com/astral-test/uv-private-pypackage (HEAD)                                                                                                   error: Git operation failed
  Caused by: failed to fetch into: /home/piegames/.cache/uv/git-v0/db/8401f5508e3e612d
  Caused by: process didn't exit successfully: `/home/piegames/.nix-profile/bin/git fetch --force --update-head-ok 'https://github.com/astral-test/uv-private-pypackage' '+HEAD:refs/remotes/origin/HEAD'` (exit status: 128)

(Which then also fails because I didn't use the correct credentials, but that's besides the point)

zanieb · 2025-02-24T17:18:15Z

I'm not sure if this is the change we want. Disabling the spinner entirely seems like a loss. It's unclear to me if we even want to try to support interactive authentication here.

It looks like the test drive is having at least some sort of git credentials configuration leaking through global user state. If I run it naively, it fails directly:

Do we need to just change the git configuration home to a tmpdir or something?

zanieb · 2025-02-24T17:18:48Z

cc @jtfmumm since this was on your list of projects

piegamesde · 2025-02-25T12:11:29Z

Disabling the spinner entirely seems like a loss. It's unclear to me if we even want to try to support interactive authentication here.

If the spinner should stay, then interactive auth needs to go. I removed the spinner because it was the easier fix, but with some instructions I can also try to disable interactive auth instead. Keeping this PR as a hotfix in the meantime would also be okay for me.

This issue is a major road block for a project migration to uv, because the project has private dependencies and if these are not set up correctly beforehand the application will seemingly just hang forever.

piegamesde · 2025-02-25T13:28:22Z

Turns out that disabling the prompt is pretty easy, and it even works with other interactive auth mechanisms outside of the CLI. This is clearly a better solution.

I'm not sure on whether the env variable should be set to all git calls to be sure, or only to the ones with operations which might prompt in the first place. Also, not sure how to make a proper regression test for this

crates/uv/src/commands/reporters.rs

crates/uv/tests/it/pip_install.rs

zanieb · 2025-02-25T14:28:39Z

crates/uv/tests/it/pip_install.rs

+    Resolved 1 package in [TIME]
+    Prepared 1 package in [TIME]
+    Installed 1 package in [TIME]
+     + uv-private-pypackage==0.1.0 (from git+https://***@github.com/astral-test/uv-private-pypackage@d780faf0ac91257d4d5a4f0c5a0e4509608c0071)


I'm guessing this succeeds because the credentials are in the git cache. Is there a way to disable that?

Oh it does fail in CI

8 │- + uv-private-pypackage==0.1.0 (from git+https://***@github.com/astral-test/uv-private-pypackage@d780faf0ac91257d4d5a4f0c5a0e4509608c0071) 5 │+ × Failed to download and build `uv-private-pypackage @ git+[https://github.com/astral-test/uv-private-pypackage`](https://github.com/astral-test/uv-private-pypackage%60) 6 │+ ├─▶ Git operation failed 7 │+ ├─▶ failed to clone into: [CACHE_DIR]/git-v0/db/8401f5508e3e612d 8 │+ ╰─▶ process didn't exit successfully: `/usr/bin/git fetch --force --update-head-ok 'https://github.com/astral-test/uv-private-pypackage' '+HEAD:refs/remotes/origin/HEAD'` (exit status: 128) 9 │+ --- stderr 10 │+ fatal: could not read Username for 'https://github.com/': terminal prompts disabled

Maybe you just need to update the snapshot?

We should also probably special-case this error, but we can track that in a new issue.

zanieb · 2025-02-25T14:36:47Z

Thanks for looking into that!

The interactive terminal prompt is not compatible with our TUI spinner animation, which will shadow the prompt and make it look like uv is hanging forever. Interactive auth is still supported via GUI mechanisms configured through git, like SSH_ASKPASS. This fixes astral-sh#5107

charliermarsh · 2025-02-25T19:46:24Z

crates/uv-git/src/git.rs

    let mut cmd = ProcessBuilder::new(GIT.as_ref()?);
+    // Fix for https://github.com/astral-sh/uv/issues/5107.
+    // Interactive prompts via GUI like SSH_ASKPASS still work
+    cmd.env("GIT_TERMINAL_PROMPT", "0");


@zanieb -- Should this be an EnvVars?

Technically, yeah. Though we don't read it, so it matters less. I can add it.

Still good source for documentation purposes internally like we annotate with #[attr_hidden] the other git env vars https://github.com/astral-sh/uv/blob/main/crates/uv-static/src/env_vars.rs#L454

Oh thanks, I didn't notice we were hiding attrs.

) ## Summary The animation shadows any interactive authentication prompt which may occur when resolving dependencies of private repos. Fixes astral-sh#5107. ## Test Plan I started creating `install_git_private_https_interactive` as a regression test but am unsure how to test this because it is interactive and I don't really know the test framework

This MR contains the following updates: | Package | Update | Change | |---|---|---| | [astral-sh/uv](https://github.com/astral-sh/uv) | patch | `0.6.3` -> `0.6.4` | MR created with the help of [el-capitano/tools/renovate-bot](https://gitlab.com/el-capitano/tools/renovate-bot). **Proposed changes to behavior should be submitted there as MRs.** --- ### Release Notes <details> <summary>astral-sh/uv (astral-sh/uv)</summary> ### [`v0.6.4`](https://github.com/astral-sh/uv/blob/HEAD/CHANGELOG.md#064) [Compare Source](astral-sh/uv@0.6.3...0.6.4) ##### Enhancements - Upgrade pypy3.10 to v7.3.19 ([#11814](astral-sh/uv#11814)) - Allow configuring log verbosity from the CLI (i.e., `-vvv`) ([#11758](astral-sh/uv#11758)) - Warn when duplicate index names found in single file ([#11824](astral-sh/uv#11824)) ##### Bug fixes - Always store registry index on resolution packages ([#11815](astral-sh/uv#11815)) - Avoid error on relative paths in `uv tool uninstall` ([#11889](astral-sh/uv#11889)) - Avoid silently dropping errors in directory enumeration ([#11890](astral-sh/uv#11890)) - Disable interactive git terminal prompts during fetches ([#11744](astral-sh/uv#11744)) - Discover Windows registry (PEP 514) Python versions across 32/64-bit ([#11801](astral-sh/uv#11801)) - Don't panic on Ctrl-C in confirm prompt ([#11706](astral-sh/uv#11706)) - Fix non-directory in workspace on Windows ([#11833](astral-sh/uv#11833)) - Make interpreter caching robust to OS upgrades ([#11875](astral-sh/uv#11875)) - Respect `include-system-site-packages` in layered environments ([#11873](astral-sh/uv#11873)) - Suggest `uv tool update-shell` in PowerShell ([#11846](astral-sh/uv#11846)) - Update code page to `65001` before setting environment variables in virtual environments ([#11831](astral-sh/uv#11831)) - Use hash instead of full wheel name in wheels bucket ([#11738](astral-sh/uv#11738)) - Fix version string truncation while generating cache_key ([#11830](astral-sh/uv#11830)) - Explicitly handle ctrl-c in confirmation prompt instead of using a signal handler ([#11897](astral-sh/uv#11897)) ##### Performance - Avoid cloning to string when creating cache path ([#11772](astral-sh/uv#11772)) - Avoid redundant clones in version containment check ([#11767](astral-sh/uv#11767)) - Avoid string allocation when enumerating tool names ([#11910](astral-sh/uv#11910)) - Avoid using owned `String` for package name constructors ([#11768](astral-sh/uv#11768)) - Avoid using owned `String` in deserializers ([#11764](astral-sh/uv#11764)) - Migrate to `zlib-rs` (again) ([#11894](astral-sh/uv#11894)) - Remove unnecessary clones when adding package names ([#11771](astral-sh/uv#11771)) - Skip unquote allocation for non-quoted strings ([#11813](astral-sh/uv#11813)) - Use `SmallString` for filenames and URLs ([#11765](astral-sh/uv#11765)) - Use a Boxed slice for version specifiers ([#11766](astral-sh/uv#11766)) - Use matches over contains for extra value parsing ([#11770](astral-sh/uv#11770)) ##### Documentation - Avoid fallback to PyPI in mixed CPU/CUDA example ([#11115](astral-sh/uv#11115)) - Docs: Clarify that setting cache-keys overrides defaults ([#11895](astral-sh/uv#11895)) - Document our MSRV policy ([#11898](astral-sh/uv#11898)) - Fix reference to macOS cache path ([#11845](astral-sh/uv#11845)) - Fix typo in `no_default_groups` documentation and changelog ([#11928](astral-sh/uv#11928)) - Update the "Locking and syncing" page ([#11647](astral-sh/uv#11647)) - Update alternative indexes documentation to use new interface ([#10826](astral-sh/uv#10826)) </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever MR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this MR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this MR, check this box --- This MR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).

piegamesde force-pushed the main branch from 7d3c0ff to 48610a6 Compare February 24, 2025 12:15

zanieb reviewed Feb 25, 2025

View reviewed changes

crates/uv/src/commands/reporters.rs Outdated Show resolved Hide resolved

zanieb reviewed Feb 25, 2025

View reviewed changes

crates/uv/tests/it/pip_install.rs Outdated Show resolved Hide resolved

zanieb reviewed Feb 25, 2025

View reviewed changes

zanieb self-assigned this Feb 25, 2025

piegamesde force-pushed the main branch 4 times, most recently from 8b9c193 to f8bf20c Compare February 25, 2025 15:44

piegamesde force-pushed the main branch from f8bf20c to 1d33bbb Compare February 25, 2025 15:50

piegamesde marked this pull request as ready for review February 25, 2025 16:01

zanieb changed the title ~~Remove animated spinner when resolving dependencies~~ Disable interactive git terminal prompts during fetches Feb 25, 2025

zanieb added the bug Something isn't working label Feb 25, 2025

zanieb approved these changes Feb 25, 2025

View reviewed changes

zanieb merged commit 15ac3a9 into astral-sh:main Feb 25, 2025
74 checks passed

charliermarsh reviewed Feb 25, 2025

View reviewed changes

BrewTestBot mentioned this pull request Mar 4, 2025

uv 0.6.4 Homebrew/homebrew-core#209642

Merged

artpelling mentioned this pull request Mar 7, 2025

uv add private GitHub repository with PAT on Actions fails #11342

Closed

jtfmumm mentioned this pull request Apr 4, 2025

SSH authentication skips password check, hangs #3783

Open

zanieb mentioned this pull request Apr 5, 2025

uv hides the password prompt when updating protected git dependencies #12685

Open

nichmor mentioned this pull request May 13, 2025

fix: hanging on ssh passphrase prefix-dev/pixi#3761

Merged

Comments

Conversation

piegamesde commented Feb 24, 2025

Summary

Test Plan

Uh oh!

piegamesde commented Feb 24, 2025

Uh oh!

zanieb commented Feb 24, 2025

Uh oh!

zanieb commented Feb 24, 2025

Uh oh!

piegamesde commented Feb 25, 2025

Uh oh!

piegamesde commented Feb 25, 2025

Uh oh!

Uh oh!

Uh oh!

zanieb Feb 25, 2025

Choose a reason for hiding this comment

Uh oh!

zanieb Feb 25, 2025

Choose a reason for hiding this comment

Uh oh!

zanieb commented Feb 25, 2025

Uh oh!

Uh oh!

charliermarsh Feb 25, 2025

Choose a reason for hiding this comment

Uh oh!

zanieb Feb 25, 2025

Choose a reason for hiding this comment

Uh oh!

samypr100 Feb 26, 2025

Choose a reason for hiding this comment

Uh oh!

zanieb Feb 26, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants