{Packaging} MSI: Use WixBroadcastEnvironmentChange and set `WIXUI_E…

…XITDIALOGOPTIONALTEXT` (#23749)
Azure · Sep 2, 2022 · b1c7966 · b1c7966
1 parent daa3b68
commit b1c7966
Show file tree

Hide file tree

Showing 7 changed files with 11 additions and 169 deletions.
diff --git a/build_scripts/windows/Product.wxs b/build_scripts/windows/Product.wxs
@@ -41,17 +41,7 @@
     </Feature>
 
     <!--Custom action to propagate path env variable change-->
-    <Binary Id="PropagateEnvChangeExe" SourceFile=".\propagate_env_change\propagate_env_change.exe" />
-    <Property Id="WixQuietExecCmdLine" Value="propagate_env_change.exe"/>
-    <!--Ignoring the return value if case there is app-hang we can't control -->
-    <CustomAction Id="PropagateEnvChange"
-                  BinaryKey="PropagateEnvChangeExe"
-                  ExeCommand="propagate_env_change.exe"
-                  Execute="commit"
-                  Return="ignore"/>
-    <InstallExecuteSequence>
-      <Custom Action="PropagateEnvChange" Before="InstallFinalize" />
-    </InstallExecuteSequence>
+    <CustomActionRef Id="WixBroadcastEnvironmentChange" />
 
     <!-- User Interface -->
     <WixVariable Id="WixUILicenseRtf" Value="$(var.ProductResources)CLI_LICENSE.rtf"/>
@@ -61,6 +51,12 @@
     <UIRef Id="WixUI_Minimal"/>
     <UIRef Id="WixUI_ErrorProgressText"/>
 
+    <!-- Show message to restart any terminals only if the PATH is changed -->
+    <CustomAction Id="Set_WIXUI_EXITDIALOGOPTIONALTEXT" Property="WIXUI_EXITDIALOGOPTIONALTEXT" Value="Please close and reopen any active terminal window to use Azure CLI." />
+    <InstallUISequence>
+      <Custom Action="Set_WIXUI_EXITDIALOGOPTIONALTEXT" After="CostFinalize">NOT Installed AND NOT WIX_UPGRADE_DETECTED</Custom>
+    </InstallUISequence>
+
   </Product>
 
   <Fragment>

diff --git a/build_scripts/windows/azure-cli.wixproj b/build_scripts/windows/azure-cli.wixproj
@@ -46,6 +46,10 @@
       <HintPath>$(WixExtDir)\WixUIExtension.dll</HintPath>
       <Name>WixUIExtension</Name>
     </WixExtension>
+    <WixExtension Include="WixUtilExtension">
+      <HintPath>$(WixExtDir)\WixUtilExtension.dll</HintPath>
+      <Name>WixUtilExtension</Name>
+    </WixExtension>
   </ItemGroup>
   <Import Project="$(WixTargetsPath)" />
   <Target Name="BeforeBuild">

diff --git a/build_scripts/windows/propagate_env_change/main.cpp b/build_scripts/windows/propagate_env_change/main.cpp
diff --git a/build_scripts/windows/propagate_env_change/propagate_env_change.sln b/build_scripts/windows/propagate_env_change/propagate_env_change.sln
diff --git a/build_scripts/windows/propagate_env_change/propagate_env_change.vcxproj b/build_scripts/windows/propagate_env_change/propagate_env_change.vcxproj
diff --git a/build_scripts/windows/propagate_env_change/propagate_env_change.vcxproj.filters b/build_scripts/windows/propagate_env_change/propagate_env_change.vcxproj.filters
diff --git a/build_scripts/windows/scripts/build.cmd b/build_scripts/windows/scripts/build.cmd
@@ -17,7 +17,6 @@ set PYTHON_VERSION=3.10.5
 
 set WIX_DOWNLOAD_URL="https://azurecliprod.blob.core.windows.net/msi/wix310-binaries-mirror.zip"
 set PYTHON_DOWNLOAD_URL="https://www.python.org/ftp/python/%PYTHON_VERSION%/python-%PYTHON_VERSION%-embed-win32.zip"
-set PROPAGATE_ENV_CHANGE_DOWNLOAD_URL="https://azurecliprod.blob.core.windows.net/util/propagate_env_change.zip"
 
 REM https://pip.pypa.io/en/stable/installation/#get-pip-py
 set GET_PIP_DOWNLOAD_URL="https://bootstrap.pypa.io/get-pip.py"
@@ -34,7 +33,6 @@ set TEMP_SCRATCH_FOLDER=%ARTIFACTS_DIR%\cli_scratch
 set BUILDING_DIR=%ARTIFACTS_DIR%\cli
 set WIX_DIR=%ARTIFACTS_DIR%\wix
 set PYTHON_DIR=%ARTIFACTS_DIR%\Python
-set PROPAGATE_ENV_CHANGE_DIR=%~dp0..\propagate_env_change
 
 set REPO_ROOT=%~dp0..\..\..
 
@@ -184,20 +182,6 @@ popd
 
 if %errorlevel% neq 0 goto ERROR
 
-REM ensure propagate_env_change.exe is available
-if exist "%PROPAGATE_ENV_CHANGE_DIR%\propagate_env_change.exe" (
-    echo Using existing propagate_env_change.exe at %PROPAGATE_ENV_CHANGE_DIR%
-) else (
-    pushd %PROPAGATE_ENV_CHANGE_DIR%
-    echo Downloading propagate_env_change.exe.
-    curl --output propagate_env_change.zip %PROPAGATE_ENV_CHANGE_DOWNLOAD_URL%
-    unzip propagate_env_change.zip
-    if %errorlevel% neq 0 goto ERROR
-    del propagate_env_change.zip
-    echo propagate_env_change.exe downloaded and extracted successfully.
-    popd
-)
-
 echo Building MSI...
 msbuild /t:rebuild /p:Configuration=Release %REPO_ROOT%\build_scripts\windows\azure-cli.wixproj