Windows: Report installation messages to console #847

jaimergp · 2024-08-30T15:47:01Z

Description

Taking inspiration from the examples collected in #764 (comment), we can print directly to the attached console (which might not be the stdout stream!) and report some information. This mostly works but we can't rely on stream redirection, piping or capture (that's why we still need the log files for testing) unless we execute the installer directly without START /WAIT. For most end users, this won't be an issue, I hope. The output can be silenced with /Q (quiet).

This only applies to /S mode (S for silent, but let's call it headlesS now).

This is how it looks more or less:

> cmd /C START /WAIT Miniforge3-4.10.1-0-Windows-x86_64.exe /S /D=C:\Users\Jaime\Miniforge-again
Welcome to Miniforge3 4.10.1-0

By continuing this installation you are accepting this license agreement:
C:\Users\Jaime\Miniforge-again\EULA.txt
Please run the installer in GUI mode to read the details.

Miniforge3 will now be installed into this location:
C:\Users\Jaime\Miniforge-again

Unpacking payload...
Setting up the package cache...
Setting up the base environment...
Installing packages for base, creating shortcuts if necessary...
Initializing conda directories...
Running post install...
Done!

> cmd /C START /WAIT Miniforge3-4.10.1-0-Windows-x86_64.exe /?
Installs Miniforge3 4.10.1-0

USAGE
-----

Miniforge3-4.10.1-0-Windows-x86_64.exe [options]

OPTIONS
-------

/InstallationType=AllUsers [default: JustMe]
/AddToPath=[0|1] [default: 0]
/KeepPkgCache=[0|1] [default: 1]
/RegisterPython=[0|1] [default: AllUsers: 1, JustMe: 0]
/NoRegistry=[0|1] [default: AllUsers: 0, JustMe: 0]
/NoScripts=[0|1] [default: 0]
/NoShortcuts=[0|1] [default: 0]
/CheckPathLength=[0|1] [default: 1]
/? (show this help message)
/S (run in CLI/headless mode)
/D=[installation directory] (must be last parameter)

EXAMPLES
--------

Install for all users, but don't add to PATH env var:
> Miniforge3-4.10.1-0-Windows-x86_64.exe /InstallationType=AllUsers

Install for just me, add to PATH and register as system Python:
> Miniforge3-4.10.1-0-Windows-x86_64.exe /RegisterPython=1 /AddToPath=1

Install for just me, with no registry modification (for CI):
> Miniforge3-4.10.1-0-Windows-x86_64.exe /NoRegistry=1

Install via CLI (no GUI) into C:\Miniforge3
> cmd /C START /WAIT Miniforge3-4.10.1-0-Windows-x86_64.exe /S /D=C:\Miniforge3

NOTE: If you install for AllUsers, then the option to AddToPath
is disabled (i.e. if /InstallationType=AllUsers, then
/AddToPath=1 will be ignored).

Checklist - did you ...

Add a file to the news directory (using the template) for the next release's release notes?
Add / update necessary tests?
Add / update outdated documentation?

marcoesters

I like this a lot. However, I think it there should be an option to suppress the output to still allow for old behavior, especially since stream redirecting doesn't work.

Alternatively, we can make this an opt-in option, but I think outputting into the console should be the default.

Do you know how this would look like inside a GitHub Action?

jaimergp · 2024-09-10T18:11:12Z

I think it there should be an option to suppress the output to still allow for old behavior, especially since stream redirecting doesn't work.

Good point. You mean a CLI flag (e.g. /Q?) or a constructor option?

Do you know how this would look like inside a GitHub Action?

Haven't checked yet, but will do.

marcoesters · 2024-09-10T18:36:06Z

I think it there should be an option to suppress the output to still allow for old behavior, especially since stream redirecting doesn't work.

Good point. You mean a CLI flag (e.g. /Q?) or a constructor option?

A CLI flag

jaimergp · 2024-09-10T19:01:43Z

Do you know how this would look like inside a GitHub Action?

The output doesn't show up in GHA logs. I guess their capture mechanism doesn't involve low level Windows APIs and "just" the stdout streams 😂

Or am I missing something in how I set this up?

…o nsis-log-stdout

jaimergp · 2024-09-10T19:47:55Z

Ok, it looks like stream redirection does work if invoked directly like:

my-installer.exe /S > out.txt

However that call is not blocking, so the user will have to check the logs manually via polling or something. Added this gotcha to the docs.

jaimergp · 2024-09-10T20:10:57Z

You can see that the direct call does work on GHA output now, but we have to block with some sleep-like statements.

marcoesters

I discovered another gotcha: calling the uninstaller opens a new Window for some reason.

marcoesters · 2024-09-10T20:26:20Z

docs/source/cli-options.md

+like this:
+
+```batch
+> cmd.exe /c start /wait my_installer.exe /S


cmd.exe /c is not necessary. You could also consider adding PowerShell since this is the default profile in the Windows Terminal

Start-Process -FilePath my_installer.exe -ArgumentList "/S" -NoNewWindow -Wait

Nice, you can even use -RedirectStandardOutput out.txt to correctly redirect things!

Added this to the documentation.

It looks like you replaced the documentation. I don't see the harm showing both cmd.exe and PowerShell.

Added tabs with both now.

constructor/nsis/main.nsi.tmpl

jaimergp · 2024-09-11T09:25:48Z

calling the uninstaller opens a new Window for some reason.

Yep, can reproduce. I think this is due to the fact that the uninstaller copies itself to a temporary location so it can delete itself during the "Removing files and folders..." step. That would cause the new process to lose the parent console and hence why we get a new allocated console for that. I guess that's better than nothing so I'm inclined to leave it like that. I'm not concerned about CI usage because in those cases users don't really uninstall, just spin a new one up, right?

marcoesters · 2024-09-11T16:25:55Z

calling the uninstaller opens a new Window for some reason.

Yep, can reproduce. I think this is due to the fact that the uninstaller copies itself to a temporary location so it can delete itself during the "Removing files and folders..." step. That would cause the new process to lose the parent console and hence why we get a new allocated console for that. I guess that's better than nothing so I'm inclined to leave it like that. I'm not concerned about CI usage because in those cases users don't really uninstall, just spin a new one up, right?

I use the uninstallation procedure in a CI, but I don't see how this would break it. And even if it does, /Q never attaches to the console.

However, it might be worth pointing out the new window in the documentation.

jaimergp · 2024-09-12T10:13:25Z

However, it might be worth pointing out the new window in the documentation.

Added a couple sentences.

marcoesters · 2024-09-12T18:14:33Z

docs/source/cli-options.md

-> cmd.exe /c start /wait my_installer.exe /S
+`````{tab-set}
+````{tab-item} CMD
+```pwsh


Suggested change

```pwsh

```batch

I used pwsh on purpose here because the batch syntax highlighting didn't shown any colours at all.

marcoesters · 2024-09-12T18:14:45Z

docs/source/cli-options.md

+
+`````{tab-set}
+````{tab-item} CMD
+```pwsh


Suggested change

```pwsh

```batch

marcoesters · 2024-09-12T18:14:58Z

docs/source/cli-options.md

-> cmd.exe /c start /wait my_installer.exe /S
+`````{tab-set}
+````{tab-item} CMD
+```pwsh


Suggested change

```pwsh

```batch

marcoesters · 2024-09-12T18:15:15Z

docs/source/cli-options.md

-> my_installer.exe /S > logs.txt
+`````{tab-set}
+````{tab-item} CMD
+```pwsh


Suggested change

```pwsh

```batch

Draft support for stdout logging

143b914

conda-bot added the cla-signed [bot] added once the contributor has signed the CLA label Aug 30, 2024

jaimergp added 12 commits September 6, 2024 09:35

Homogeneize stdout messaging

a6c78d3

this should be silent too

b11ecf3

test stdout

14f026f

fix has_license check

a8ddc50

Check NSIS version properly

a32620f

has_license fix again

52e7688

reformat /? message

55e8e83

ship license file and refer to it during silent install

747d88e

pre-commit

815a14d

add news

f7636e6

adjust error message and general Windows assertions

f116140

adjust docs

32563bf

jaimergp marked this pull request as ready for review September 6, 2024 10:20

jaimergp requested a review from a team as a code owner September 6, 2024 10:20

jaimergp changed the title ~~Draft support for stdout logging~~ Windows: Report installation messages to console Sep 6, 2024

send unquoted version too

1a9029f

marcoesters reviewed Sep 9, 2024

View reviewed changes

jaimergp mentioned this pull request Sep 10, 2024

Try constructor#847 (DNM) napari/packaging#182

Draft

jaimergp added 2 commits September 10, 2024 20:46

add /Q flag

73d333c

Merge branch 'main' into nsis-log-stdout

691f134

jaimergp added 2 commits September 10, 2024 21:46

Fix and clarify stream redirection

7193751

Merge branch 'nsis-log-stdout' of github.com:jaimergp/constructor int…

de79678

…o nsis-log-stdout

marcoesters reviewed Sep 10, 2024

View reviewed changes

jaimergp added 3 commits September 11, 2024 10:26

better docs for quiet mode

0fb70c6

suggest powershell

e4172e9

add help to uninstaller too

379679d

Reformat examples for both CMD and Powershell

37af49d

marcoesters reviewed Sep 12, 2024

View reviewed changes

marcoesters approved these changes Sep 12, 2024

View reviewed changes

jaimergp merged commit 89348cc into conda:main Sep 13, 2024
20 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Windows: Report installation messages to console #847

Windows: Report installation messages to console #847

jaimergp commented Aug 30, 2024 •

edited

Loading

marcoesters left a comment

jaimergp commented Sep 10, 2024

marcoesters commented Sep 10, 2024

jaimergp commented Sep 10, 2024

jaimergp commented Sep 10, 2024

jaimergp commented Sep 10, 2024

marcoesters left a comment

marcoesters Sep 10, 2024

jaimergp Sep 11, 2024

jaimergp Sep 11, 2024

marcoesters Sep 11, 2024

jaimergp Sep 12, 2024

jaimergp commented Sep 11, 2024

marcoesters commented Sep 11, 2024

jaimergp commented Sep 12, 2024

marcoesters Sep 12, 2024

jaimergp Sep 12, 2024

marcoesters Sep 12, 2024

marcoesters Sep 12, 2024

marcoesters Sep 12, 2024

Windows: Report installation messages to console #847

Windows: Report installation messages to console #847

Conversation

jaimergp commented Aug 30, 2024 • edited Loading

Description

Checklist - did you ...

marcoesters left a comment

Choose a reason for hiding this comment

jaimergp commented Sep 10, 2024

marcoesters commented Sep 10, 2024

jaimergp commented Sep 10, 2024

jaimergp commented Sep 10, 2024

jaimergp commented Sep 10, 2024

marcoesters left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jaimergp commented Sep 11, 2024

marcoesters commented Sep 11, 2024

jaimergp commented Sep 12, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jaimergp commented Aug 30, 2024 •

edited

Loading