Improvements to `opam init` "Git" menu on Windows #5963

dra27 · 2024-05-18T11:08:40Z

This PR extends the detection of Git on Windows during opam init in several ways (which includes addressing the cyclic logic identified in #5835)

The PR is three sections: the first three commits add Windows primitives:

We already have a function to write string data to the Registry; an equivalent function is added to read string data from it
A function and types are added to process any version information embedded in the .rsrc of PE files (TL;DR reads the "Details" tab of an executable or DLL - we don't have to process PE to do this; Windows has very old API functions to do it for us, but the API shows its age...)
A function to read the "initial" environment given to new processes for the current user. Specifically, this allows opam to be able to determine the value of PATH when a new Command Prompt or PowerShell prompt would be opened (before any user commands are executed) so including things which may have been added to PATH after the current session was started (it's very loosely like running env -i $(command -v bash) -lc "env" but without the terror, as it's an actual OS-supported thing)

The next part is easy: OpamClient.git_for_windows_check current does stuff when opam is built for Cygwin, which it categorically should not. From our perspective, if a user is using Cygwin's build of opam then they should only use Cygwin's build of git (or have to work very very hard themselves to change that); from the Cygwin opam package maintainer's perspective, a Cygwin tool should not suddenly ignore a Cygwin package in preference for an external tool (imagine we were trying to make the Linux build of opam behave this way in WSL and then imagine the response of the Debian maintainer 🙂)

There are then three areas where opam init's Git for Windows detection is enhanced. We can identify a Git for Windows binary from the Product Version string in the executable which will contain .windows. (the tag format for Git for Windows versions is covered in their security guide). This instantly differentiates it from much older builds of msysgit (from pre-Git-for-Windows days) and also from Cygwin/MSYS2's Git (which isn't built with resource blocks anyway, and would use Git's tag numbers if it were). I've gone with just checking the .windows. format for now because its clearly enough - if it were ever to stop being enough, we could examine other fields (like the author name, etc...!).

If opam init resolves git.exe in PATH, and that git.exe has a Product Version of the format git-major.git-minor.git-revision.windows.gfw-revision, then no menu is displayed - Git for Windows is in use and has been identified, which fixes #5835.

The last two commits extend this further to deal with what I think is one very likely user mistake and one possible user misconfiguration.

I think it is highly likely that we will encounter users who do see that they should go and install Git for Windows, but who do not then open a fresh Command Prompt / PowerShell session before running opam init again. In this instance, git.exe will still not be found in PATH. To counter this, opam init now checks the initial environment which, after running winget install Git.Git or using the Git-for-Windows installer, will now include the location of git.exe. If git.exe can be found in PATH in this environment then the menu is still displayed, but with a warning, thus:

<><> Git ><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><>  🐫
Cygwin Git is functional but can have credentials issues for private repositories, we recommend using:
  - Install via 'winget install Git.Git'
  - Git for Windows can be downloaded and installed from https://gitforwindows.org

[WARNING] It looks as though Git for Windows has been installed but the shell needs to
          be restarted. You may wish to abort and re-run opam init from a fresh
          session.

Which Git should opam use?
> 1. Use default Cygwin Git
  2. Enter the location of installed Git
  3. Abort initialisation to install recommended Git.

The final commit extends this one stage further. The Git for Windows installer includes an option to install, but not update PATH. If git.exe is found in neither the current PATH nor the pristine/initial PATH, then opam now searches the Registry for the two entries which may point to Git for Windows installations (it is possible to install both for the entire machine and for the current user). If one or both of these are found, then opam still displays the menu, but with a different warning and it also adds the \cmd directory of this installation to the list of possible values to use for git-location:

<><> Git ><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><>  🐫
Cygwin Git is functional but can have credentials issues for private repositories, we recommend using:
  - Install via 'winget install Git.Git'
  - Git for Windows can be downloaded and installed from https://gitforwindows.org

[WARNING] It looks as though Git for Windows has been installed, but configured not to
          put the git binary in your PATH. You can either abort and reconfigure your
          environment (or re-run the Git for Windows installer) to enable this, or you
          can use the menu below to have opam use this Git installation internally.

Which Git should opam use?
> 1. Use default Cygwin Git
  2. Use found git in C:\Program Files\Git\cmd
  3. Enter the location of installed Git
  4. Abort initialisation to install recommended Git.

configure.ac

kit-ty-kate · 2024-05-20T10:10:48Z

LGTM on first read apart from the question above

configure.ac

One of the simpler parts of the Win16 API...

Complementing OpamStubs.writeRegistry

On Windows, uses CreateEnvironmentBlock to get the pristine environment which would be applied to a new terminal. Allows `opam init` to determine if `git` _will_ be in Path next time round...

Users of the Cygwin port of opam should be using the Cygwin port of git, with no exceptions.

rjbou

Little comment, otherwise, lgtm!

rjbou · 2024-06-03T14:52:20Z

src/client/opamClient.ml

@@ -693,6 +767,7 @@ let git_for_windows_check =
            `Abort, "Abort initialisation to install recommended Git.";
          ]
        in
+        OpamStd.Option.iter (OpamConsole.warning "%s\n") gfw_message;


What about changing the abort message in case git was found ? Something like "Abort initialisation to restart your shell".

I like it!

DRA@Tau MSYS /c/Devel/opam-3 $ ./opam init No configuration file found, using built-in defaults. <><> Git ><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><> 🐫 Cygwin Git is functional but can have credentials issues for private repositories, we recommend using: - Install via 'winget install Git.Git' - Git for Windows can be downloaded and installed from https://gitforwindows.org [WARNING] It looks as though Git for Windows has been installed but the shell needs to be restarted. You may wish to abort and re-run opam init from a fresh session. Which Git should opam use? > 1. Use default Cygwin Git 2. Enter the location of installed Git 3. Abort initialisation to restart your shell. [1/2/3]

If git is resolved in PATH and the binary's version block indicates that it's a Git-for-Windows binary, skip the menu.

During `opam init` on Windows, if git is not found in PATH, test again using the initial environment and if git is found display an additional warning on the Git configuration menu that the user appears not to have started a fresh shell.

In addition to not restarting the shell, it is possible that a user has installed Git for Windows, but instructed its installer not to update PATH. In this case, the installations will be referred to in the Windows Registry. As a final fallback, opam init searches for these installations and, if found, displays a warning suggesting that the user may wish to reconfigure them (because then git will available to things installed by opam, such as Dune), but also includes them in the list of "gits" which can be manually selected with for git-location.

If opam is configured with --with-private-runtime, then shared linking should be assumed by default.

dra27 · 2024-06-04T08:45:36Z

I pulled your changes from rjbou/gwf-menu as well, thanks!

rjbou

thanks!

dra27 added AREA: UI PR: WAITING FOR REVIEW labels May 18, 2024

dra27 added this to the 2.2.0~beta3 milestone May 18, 2024

dra27 added this to For beta3 in Opam 2.2.0 May 18, 2024

dra27 force-pushed the gwf-menu branch 3 times, most recently from a32608c to 811889f Compare May 18, 2024 13:01

kit-ty-kate reviewed May 20, 2024

View reviewed changes

configure.ac Outdated Show resolved Hide resolved

kit-ty-kate requested a review from rjbou May 21, 2024 22:30

kit-ty-kate reviewed May 22, 2024

View reviewed changes

configure.ac Outdated Show resolved Hide resolved

kit-ty-kate approved these changes May 22, 2024

View reviewed changes

dra27 force-pushed the gwf-menu branch 2 times, most recently from 1e4490c to 8c29b1b Compare May 23, 2024 14:21

kit-ty-kate force-pushed the gwf-menu branch from 8c29b1b to 5aca409 Compare May 28, 2024 11:42

dra27 added 4 commits June 2, 2024 12:26

Add a function to read version info blocks

dc0b192

One of the simpler parts of the Win16 API...

Add OpamStubs.readRegistry

55963b8

Complementing OpamStubs.writeRegistry

Add a function to get the initial environment

a620521

On Windows, uses CreateEnvironmentBlock to get the pristine environment which would be applied to a new terminal. Allows `opam init` to determine if `git` _will_ be in Path next time round...

Cygwin is Unix - no special git handling

f042b9c

Users of the Cygwin port of opam should be using the Cygwin port of git, with no exceptions.

dra27 force-pushed the gwf-menu branch from 5aca409 to 67fae1c Compare June 2, 2024 11:27

rjbou approved these changes Jun 3, 2024

View reviewed changes

dra27 added 4 commits June 3, 2024 17:26

Skip the Git-for-Windows menu at init if git found

1381bf0

If git is resolved in PATH and the binary's version block indicates that it's a Git-for-Windows binary, skip the menu.

Check the initial environment if git isn't found

ad51ad6

During `opam init` on Windows, if git is not found in PATH, test again using the initial environment and if git is found display an additional warning on the Git configuration menu that the user appears not to have started a fresh shell.

--with-private-runtime should default to shared

410a91d

If opam is configured with --with-private-runtime, then shared linking should be assumed by default.

dra27 force-pushed the gwf-menu branch from 67fae1c to 410a91d Compare June 4, 2024 08:45

rjbou approved these changes Jun 4, 2024

View reviewed changes

rjbou added STATE: READY TO MERGE and removed PR: WAITING FOR REVIEW labels Jun 4, 2024

rjbou merged commit 5a817d1 into ocaml:master Jun 4, 2024
29 checks passed

Opam 2.2.0 automation moved this from For beta3 to Done Jun 4, 2024

dra27 mentioned this pull request Jun 6, 2024

Small refactoring and fixes to opam init on Windows. #6000

Merged

dra27 mentioned this pull request Jun 13, 2024

Does OPAM work on windows? #246

Closed

rjbou removed the STATE: READY TO MERGE label Aug 13, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improvements to `opam init` "Git" menu on Windows #5963

Improvements to `opam init` "Git" menu on Windows #5963

dra27 commented May 18, 2024

kit-ty-kate commented May 20, 2024

rjbou left a comment

rjbou Jun 3, 2024

dra27 Jun 4, 2024

dra27 commented Jun 4, 2024

rjbou left a comment

Improvements to opam init "Git" menu on Windows #5963

Improvements to opam init "Git" menu on Windows #5963

Conversation

dra27 commented May 18, 2024

kit-ty-kate commented May 20, 2024

rjbou left a comment

Choose a reason for hiding this comment

rjbou Jun 3, 2024

Choose a reason for hiding this comment

dra27 Jun 4, 2024

Choose a reason for hiding this comment

dra27 commented Jun 4, 2024

rjbou left a comment

Choose a reason for hiding this comment

Improvements to `opam init` "Git" menu on Windows #5963

Improvements to `opam init` "Git" menu on Windows #5963