MSI: Add support for extra_envs (#1186)

* add support for extra_envs, work in progress

* Fix rebase issues

* Add more examples to MSI testing

* fix error: TypeError: unhashable type

* Changed default value of shortcut option for consistency with NSIS

* Add debug output

* Always uninstall with conda-standalone

* Add debug output

* Improve debug output

* Remove debug output, skip test

* Remove more debug statements

* Use pytest.xfail

* Review fix

* Add suggestion from review

Co-authored-by: Marco Esters <mesters@anaconda.com>

* Bump min conda-standalone

---------

Co-authored-by: Marco Esters <mesters@anaconda.com>

Author: lrandersson

constructor/briefcase.py

@@ -28,6 +28,7 @@
     bat_env_var_esc,
     copy_conda_exe,
     filename_dist,
+    get_final_channels,
     shortcuts_flags,
 )
 
@@ -151,11 +152,50 @@ def _get_script_env_variables(info: dict) -> dict[str, str]:
     return escaped_vars
 
 
+def _setup_envs_commands(info: dict) -> list[dict]:
+    """Build environment setup data for base and extra_envs.
+
+    Returns a list of dicts, each containing the data needed to install
+    one environment. Used by the run_installation.bat template.
+    """
+    environments = []
+
+    # Base environment
+    environments.append(
+        {
+            "name": "base",
+            "prefix": "%BASE_PATH%",
+            "lockfile": r"%BASE_PATH%\conda-meta\initial-state.explicit.txt",
+            "channels": ",".join(get_final_channels(info)),
+            "shortcuts": shortcuts_flags(info),
+        }
+    )
+
+    # Extra environments
+    for env_name in info.get("_extra_envs_info", {}):
+        env_config = info["extra_envs"][env_name]
+        # Needed for shortcuts_flags function
+        if "_conda_exe_type" not in env_config:
+            env_config["_conda_exe_type"] = info.get("_conda_exe_type")
+        channel_info = {
+            "channels": env_config.get("channels", info.get("channels", ())),
+            "channels_remap": env_config.get("channels_remap", info.get("channels_remap", ())),
+        }
+        environments.append(
+            {
+                "name": env_name,
+                "prefix": rf"%BASE_PATH%\envs\{env_name}",
+                "lockfile": rf"%BASE_PATH%\envs\{env_name}\conda-meta\initial-state.explicit.txt",
+                "channels": ",".join(get_final_channels(channel_info)),
+                "shortcuts": shortcuts_flags(env_config),
+            }
+        )
+
+    return environments
+
+
 def create_uninstall_options_list(info: dict) -> list[dict]:
-    """Returns a list of dicts with data formatted for the uninstallation options page.
-    Options are currently only shown when uninstall_with_conda_exe is True."""
-    if not bool(info.get("uninstall_with_conda_exe")):
-        return []
+    """Returns a list of dicts with data formatted for the uninstallation options page."""
     return [
         {
             "name": "remove_user_data",
@@ -243,7 +283,7 @@ def create_install_options_list(info: dict) -> list[dict]:
                 "name": "enable_shortcuts",
                 "title": "Create shortcuts",
                 "description": "Create shortcuts (supported packages only).",
-                "default": False,
+                "default": True,
             }
         )
 
@@ -411,14 +451,8 @@ def render_templates(self) -> list[Path]:
             # In the .bat template this is used in the "shortcuts enabled" branch,
             # so passing an empty string here is correct when all shortcuts are wanted.
             "shortcuts": shortcuts_flags(self.info),
-            # --- uninstall_with_conda_exe ---
-            "uninstall_with_conda_exe": bool(self.info.get("uninstall_with_conda_exe")),
-            # --- has_conda ---
-            "has_conda": self.info.get("_has_conda", False),
             # --- setup_envs ---
-            # Placeholder for extra_envs support. Currently only contains base env.
-            # Will be expanded when extra_envs is implemented for MSI installers.
-            "setup_envs": [{"name": "base", "prefix": "%BASE_PATH%"}],
+            "setup_envs": _setup_envs_commands(self.info),
             # --- virtual_specs ---
             # virtual_specs: quoted for command-line use
             # virtual_specs_debug: unquoted for display
@@ -475,7 +509,11 @@ def write_pyproject_toml(self, root: Path, external: Path) -> None:
 
     def _stage_dists(self, pkgs_dir: Path) -> None:
         download_dir = Path(self.info["_download_dir"])
-        for dist in self.info["_dists"]:
+        # Collect dists from base and extra_envs, de-duplicated
+        dists = set(self.info["_dists"])
+        for env_info in self.info.get("_extra_envs_info", {}).values():
+            dists.update(env_info.get("_dists", []))
+        for dist in sorted(dists):
             shutil.copy(download_dir / filename_dist(dist), pkgs_dir)
 
     def _stage_conda(self, external_dir: Path) -> None:
@@ -489,6 +527,11 @@ def create(info, verbose=False):
     if not info.get("_conda_exe_supports_logging"):
         raise Exception("MSI installers require conda-standalone with logging support.")
 
+    # MSI installers always use conda-standalone for uninstallation.
+    # This ensures proper cleanup of conda init, environments, and shortcuts
+    # via the `conda constructor uninstall` command.
+    info["uninstall_with_conda_exe"] = True
+
     payload = Payload(info)
     payload.prepare()
 

constructor/briefcase/pre_uninstall.bat

@@ -115,7 +115,6 @@ exit /b 0
 :after_remove_python_registry
 {%- endif %}
 
-{%- if uninstall_with_conda_exe %}
 rem Run constructor uninstall, conditionally passing optional flags
 set "UNINST_ARGS="
 if "%OPTION_REMOVE_USER_DATA%"=="1" (
@@ -136,31 +135,6 @@ if "%OPTION_REMOVE_CONFIG_FILES%"=="1" (
 {{ tee("Running constructor uninstall...") }}
 "%CONDA_EXE%" constructor uninstall --prefix "%BASE_PATH%"!UNINST_ARGS! --log-file "%LOG%"
 if errorlevel 1 ( exit /b %errorlevel% )
-{%- else %}
-rem Remove menus for each environment.
-{%- for env in setup_envs %}
-{{ tee("Removing menus for " + env.name + "...") }}
-"%CONDA_EXE%" constructor --prefix "{{ env.prefix }}" --rm-menus --log-file "%LOG%"
-if errorlevel 1 ( exit /b %errorlevel% )
-{%- endfor %}
-
-{%- if has_conda %}
-rem Reverse conda shell initialization
-if "%REG_HIVE%"=="HKCU" (
-    set "CONDA_INIT_SCOPE=user"
-) else (
-    set "CONDA_INIT_SCOPE=system"
-)
-{{ tee("Reversing conda shell initialization...") }}
-"%BASE_PATH%\condabin\conda.bat" init cmd.exe --reverse --!CONDA_INIT_SCOPE! --log-file "%LOG%"
-if errorlevel 1 ( exit /b %errorlevel% )
-{%- endif %}
-
-rem Remove conda environments. INSTDIR itself is cleaned up by the MSI engine.
-{{ tee("Removing environments...") }}
-rmdir /s /q "%BASE_PATH%"
-if errorlevel 1 ( exit /b %errorlevel% )
-{%- endif %}
 
 rem If we reached this far without any errors, remove any log files.
 if exist "%INSTDIR%\install.log" del "%INSTDIR%\install.log"

constructor/briefcase/run_installation.bat

@@ -15,6 +15,18 @@ echo {{ message }}
 >> "%LOG%" echo {{ message }}
 {%- endmacro %}
 
+{% macro install_env(env) %}
+{{ tee("Setting up " ~ env.name ~ " environment...") }}
+set "CONDA_CHANNELS={{ env.channels }}"
+if "%OPTION_ENABLE_SHORTCUTS%"=="1" (
+    "%CONDA_EXE%" install --offline -yp "{{ env.prefix }}" --file "{{ env.lockfile }}" {{ env.shortcuts }} {{ no_rcs_arg }} --log-file "%LOG%"
+) else (
+    "%CONDA_EXE%" install --offline -yp "{{ env.prefix }}" --file "{{ env.lockfile }}" --no-shortcuts {{ no_rcs_arg }} --log-file "%LOG%"
+)
+set "INSTALL_ERRORLEVEL=%errorlevel%"
+if %INSTALL_ERRORLEVEL% neq 0 ( exit /b %INSTALL_ERRORLEVEL% )
+{% endmacro %}
+
 rem Assign INSTDIR and normalize the path
 set "INSTDIR=%~dp0.."
 for %%I in ("%INSTDIR%") do set "INSTDIR=%%~fI"
@@ -98,24 +110,17 @@ set "CONDA_PKGS_DIRS=%BASE_PATH%\pkgs"
 "%CONDA_EXE%" constructor extract --prefix "%BASE_PATH%" --conda-pkgs --log-file "%LOG%"
 if errorlevel 1 ( exit /b %errorlevel% )
 
-rem TODO: loop over extra_envs when extra_envs support is implemented for MSI.
-
 rem Create .nonadmin marker file for user-scoped installs inside BASE_PATH.
 rem This is used by the uninstaller (and menuinst) to determine the install mode.
 if "%ALLUSERS%"=="0" (
     echo. > "%BASE_PATH%\.nonadmin"
     if errorlevel 1 ( exit /b %errorlevel% )
 )
 
-rem Install packages, conditionally creating shortcuts
-if "%OPTION_ENABLE_SHORTCUTS%"=="1" (
-    {{ tee("Installing packages with shortcuts...") }}
-    "%CONDA_EXE%" install --offline -yp "%BASE_PATH%" --file "%BASE_PATH%\conda-meta\initial-state.explicit.txt" {{ shortcuts }} {{ no_rcs_arg }} --log-file "%LOG%"
-) else (
-    {{ tee("Installing packages...") }}
-    "%CONDA_EXE%" install --offline -yp "%BASE_PATH%" --file "%BASE_PATH%\conda-meta\initial-state.explicit.txt" --no-shortcuts {{ no_rcs_arg }} --log-file "%LOG%"
-)
-if errorlevel 1 ( exit /b %errorlevel% )
+rem Install packages for each environment
+{%- for env in setup_envs %}
+{{ install_env(env) }}
+{%- endfor %}
 
 rem Delete the payload to save disk space.
 rem A truncated placeholder of 0 bytes is recreated during uninstall

constructor/main.py

@@ -48,6 +48,19 @@ def get_installer_type(info: dict):
         return os_allowed[osname][:1]
     elif itype == "all":
         return os_allowed[osname]
+    elif isinstance(itype, (list, tuple)):
+        # Handle list of installer types, e.g. [exe, msi]
+        for t in itype:
+            if t not in all_allowed:
+                all_allowed_str = ", ".join(sorted(all_allowed))
+                sys.exit("Error: invalid installer type '%s'; allowed: %s" % (t, all_allowed_str))
+            if t not in os_allowed[osname]:
+                os_allowed_str = ", ".join(sorted(os_allowed[osname]))
+                sys.exit(
+                    "Error: invalid installer type '%s' for %s; allowed: %s"
+                    % (t, osname, os_allowed_str)
+                )
+        return tuple(itype)
     elif itype not in all_allowed:
         all_allowed = ", ".join(sorted(all_allowed))
         sys.exit("Error: invalid installer type '%s'; allowed: %s" % (itype, all_allowed))

examples/outputs/construct.yaml

@@ -4,7 +4,7 @@
 name: Outputs
 version: 1.0.0
 installer_type: sh  # [unix]
-installer_type: exe  # [win]
+installer_type: [exe, msi]  # [win]
 channels:
   - https://conda.anaconda.org/conda-forge
 specs:

examples/shortcuts/construct.yaml

@@ -3,7 +3,7 @@
 
 name: MinicondaWithShortcuts
 version: X
-installer_type: {{ "exe" if os.name == "nt" else "all" }}
+installer_type: all
 
 channels:
   - conda-test/label/menuinst-tests

recipe/meta.yaml

@@ -25,7 +25,7 @@ requirements:
     - conda >=4.6
     - python  # >=3.10
     - ruamel.yaml >=0.11.14,<0.19
-    - conda-standalone >=24.1.2
+    - conda-standalone >=24.11.0
     - jinja2
     - jsonschema >=4
     - pillow >=3.1     # [win or osx]