feat(nsis): add an option to opt out tauri utils plugin

.changes/opt-in-nsis-plugin.md

@@ -0,0 +1,7 @@
+---
+tauri-utils: minor:feat
+tauri-cli: minor:feat
+tauri-bundler: minor:feat
+---
+
+Add an option to replace nsis util plugin with built-in ones, this can reduce the final bundle size by ~0.8 MB.

core/tauri-config-schema/schema.json

@@ -2294,6 +2294,11 @@
               "type": "null"
             }
           ]
+        },
+        "useTauriPlugin": {
+          "description": "Whether include and use tauri nsis plugin for compare semver, check and terminate running app, and download webview2 bootstrap, this will increase the installer size by around 0.8 MB when disabled, uses tools provided by the OS and nsis, this option has some downsides: - can't compare semver like 2.0.0-alpha.1 - no Windows 7 support when using webviewInstallMode downloadBootstrapper default to true",
+          "default": true,
+          "type": "boolean"
         }
       },
       "additionalProperties": false

core/tauri-utils/src/config.rs

@@ -744,6 +744,16 @@ pub struct NsisConfig {
   ///
   /// See <https://nsis.sourceforge.io/Reference/SetCompressor>
   pub compression: Option<NsisCompression>,
+  /// Whether include and use tauri nsis plugin for
+  /// compare semver, check and terminate running app, and download webview2 bootstrap,
+  /// this will increase the installer size by around 0.8 MB
+  /// when disabled, uses tools provided by the OS and nsis,
+  /// this option has some downsides:
+  /// - can't compare semver like 2.0.0-alpha.1
+  /// - no Windows 7 support when using webviewInstallMode downloadBootstrapper
+  /// default to true
+  #[serde(default = "default_true")]
+  pub use_tauri_plugin: bool,
 }
 
 /// Install Modes for the NSIS installer.

tooling/bundler/src/bundle/settings.rs

@@ -415,6 +415,15 @@ pub struct NsisSettings {
   pub display_language_selector: bool,
   /// Set compression algorithm used to compress files in the installer.
   pub compression: Option<NsisCompression>,
+  /// Whether include and use tauri nsis plugin for
+  /// compare semver, check and terminate running app, and download webview2 bootstrap,
+  /// this will increase the installer size by around 0.8 MB
+  /// when disabled, uses tools provided by the OS and nsis,
+  /// this option has some downsides:
+  /// - can't compare semver like 2.0.0-alpha.1
+  /// - no Windows 7 support when using webviewInstallMode downloadBootstrapper
+  /// default to true
+  pub use_tauri_plugin: bool,
 }
 
 /// The Windows bundle settings.

tooling/bundler/src/bundle/windows/nsis.rs

@@ -285,6 +285,8 @@ fn build_nsis_app_installer(
       "display_language_selector",
       to_json(nsis.display_language_selector && languages.len() > 1),
     );
+
+    data.insert("use_tauri_plugin", to_json(nsis.use_tauri_plugin));
   }
   data.insert(
     "install_mode",

tooling/bundler/src/bundle/windows/templates/installer.nsi

@@ -43,6 +43,7 @@ ${StrLoc}
 !define MANUPRODUCTKEY "Software\${MANUFACTURER}\${PRODUCTNAME}"
 !define UNINSTALLERSIGNCOMMAND "{{uninstaller_sign_cmd}}"
 !define ESTIMATEDSIZE "{{estimated_size}}"
+!define USETAURIPLUGIN "{{use_tauri_plugin}}"
 
 Name "${PRODUCTNAME}"
 BrandingText "${COPYRIGHT}"
@@ -178,7 +179,12 @@ Function PageReinstall
   ${EndIf}
   ${IfThen} $R0 == "" ${|} StrCpy $R4 "$(unknown)" ${|}
 
-  nsis_tauri_utils::SemverCompare "${VERSION}" $R0
+  !if "${USETAURIPLUGIN}" == "true"
+    nsis_tauri_utils::SemverCompare "${VERSION}" $R0
+  !else
+    ; https://nsis.sourceforge.io/VersionCompare
+    ${VersionCompare} "${VERSION}" $R0 $R0
+  !endif
   Pop $R0
   ; Reinstalling the same version
   ${If} $R0 == 0
@@ -195,7 +201,11 @@ Function PageReinstall
     !insertmacro MUI_HEADER_TEXT "$(alreadyInstalled)" "$(choowHowToInstall)"
     StrCpy $R5 "1"
   ; Downgrading
+  !if "${USETAURIPLUGIN}" == "true"
   ${ElseIf} $R0 == -1
+  !else
+  ${ElseIf} $R0 == 2
+  !endif
     StrCpy $R1 "$(newerVersionInstalled)"
     StrCpy $R2 "$(uninstallBeforeInstalling)"
     !if "${ALLOWDOWNGRADES}" == "true"
@@ -451,7 +461,11 @@ Section WebView2
   !if "${INSTALLWEBVIEW2MODE}" == "downloadBootstrapper"
     Delete "$TEMP\MicrosoftEdgeWebview2Setup.exe"
     DetailPrint "$(webview2Downloading)"
-    nsis_tauri_utils::download "https://go.microsoft.com/fwlink/p/?LinkId=2124703" "$TEMP\MicrosoftEdgeWebview2Setup.exe"
+    !if "${USETAURIPLUGIN}" == "true"
+      nsis_tauri_utils::download "https://go.microsoft.com/fwlink/p/?LinkId=2124703" "$TEMP\MicrosoftEdgeWebview2Setup.exe"
+    !else
+      nsExec::Exec 'curl --location "https://go.microsoft.com/fwlink/p/?LinkId=2124703" --output "$TEMP\MicrosoftEdgeWebview2Setup.exe"'
+    !endif
     Pop $0
     ${If} $0 == 0
       DetailPrint "$(webview2DownloadSuccess)"
@@ -494,6 +508,7 @@ Section WebView2
   webview2_done:
 SectionEnd
 
+!if "${USETAURIPLUGIN}" == "true"
 !macro CheckIfAppIsRunning
   !if "${INSTALLMODE}" == "currentUser"
     nsis_tauri_utils::FindProcessCurrentUser "${MAINBINARYNAME}.exe"
@@ -532,6 +547,54 @@ SectionEnd
   ${EndIf}
   app_check_done:
 !macroend
+!else
+!macro CheckIfAppIsRunning
+  ; Modified from https://github.com/electron-userland/electron-builder/blob/master/packages/app-builder-lib/templates/nsis/include/allowOnlyOneInstallerInstance.nsh
+  ; Pipe tasklist output to find to convert not found to an error
+  !macro FIND_PROCESS _FILE _ERR
+    !if "${INSTALLMODE}" == "currentUser"
+      nsExec::Exec 'cmd /c tasklist /fi "USERNAME eq %USERNAME%" /fi "IMAGENAME eq ${_FILE}" /nh | find "${_FILE}"'
+      Pop ${_ERR}
+    !else
+      nsExec::Exec 'cmd /c tasklist /fi "IMAGENAME eq ${_FILE}" /nh | find "${_FILE}"'
+      Pop ${_ERR}
+    !endif
+  !macroend
+
+  !insertmacro FIND_PROCESS "${MAINBINARYNAME}.exe" $R0
+  ${If} $R0 == 0
+    IfSilent kill 0
+    ${IfThen} $PassiveMode != 1 ${|} MessageBox MB_OKCANCEL "$(appRunningOkKill)" IDOK kill IDCANCEL cancel ${|}
+
+    kill:
+      !if "${INSTALLMODE}" == "currentUser"
+        nsExec::Exec 'taskkill /im "${MAINBINARYNAME}.exe" /fi "USERNAME eq %USERNAME%" /f'
+      !else
+        nsExec::Exec 'taskkill /im "${MAINBINARYNAME}.exe" /f'
+      !endif
+
+      !insertmacro FIND_PROCESS "${MAINBINARYNAME}.exe" $R0
+      ${If} $R0 == 0
+        IfSilent silent ui
+        silent:
+          System::Call 'kernel32::AttachConsole(i -1)i.r0'
+          ${If} $0 != 0
+            System::Call 'kernel32::GetStdHandle(i -11)i.r0'
+            System::call 'kernel32::SetConsoleTextAttribute(i r0, i 0x0004)' ; set red color
+            FileWrite $0 "$(appRunning)$\n"
+          ${EndIf}
+          Abort
+        ui:
+          Abort "$(failedToKillApp)"
+      ${Else}
+        Goto app_check_done
+      ${EndIf}
+    cancel:
+      Abort "$(appRunning)"
+    app_check_done:
+  ${EndIf}
+!macroend
+!endif
 
 Section Install
   SetOutPath $INSTDIR

tooling/cli/schema.json

@@ -2294,6 +2294,11 @@
               "type": "null"
             }
           ]
+        },
+        "useTauriPlugin": {
+          "description": "Whether include and use tauri nsis plugin for compare semver, check and terminate running app, and download webview2 bootstrap, this will increase the installer size by around 0.8 MB when disabled, uses tools provided by the OS and nsis, this option has some downsides: - can't compare semver like 2.0.0-alpha.1 - no Windows 7 support when using webviewInstallMode downloadBootstrapper default to true",
+          "default": true,
+          "type": "boolean"
         }
       },
       "additionalProperties": false

tooling/cli/src/helpers/config.rs

@@ -106,6 +106,7 @@ pub fn nsis_settings(config: NsisConfig) -> tauri_bundler::NsisSettings {
     custom_language_files: config.custom_language_files,
     display_language_selector: config.display_language_selector,
     compression: config.compression,
+    use_tauri_plugin: config.use_tauri_plugin,
   }
 }