feat: allow choosing install dir with NSIS

Author: ryan-willis

.github/workflows/release-build.yml

@@ -136,7 +136,7 @@ jobs:
           Remove-Item -Path "packages/insomnia/dist/win-unpacked/tosign" -Recurse -Force
           Remove-Item -Path "packages/insomnia/dist/win-unpacked/signed" -Recurse -Force
 
-      # re-packages the now code-signed electron-builder contents into a squirrel installer
+      # re-packages the now code-signed electron-builder contents into the installer
       - name: Package dist app (Windows only)
         if: runner.os == 'Windows'
         shell: bash

packages/insomnia/config/uninstall-squirrel.nsh

@@ -0,0 +1,11 @@
+!macro customInit
+  StrCpy $0 "$PROFILE\AppData\Local\insomnia\Update.exe"
+  StrCpy $1 "$PROFILE\AppData\Local\insomnia\.dead"
+  IfFileExists $1 0 +2
+    Goto +4
+  IfFileExists $0 0 +5
+    MessageBox MB_YESNO "Existing Insomnia installation found, which must be uninstalled first.$\n$\nClick 'No' to exit this installer so you can uninstall yourself.$\n$\nClick 'Yes' to allow this installer to uninstall for you (your existing Insomnia data will be preserved)." IDYES 0 IDNO +3
+    nsExec::Exec '"$0" --uninstall -s'
+    Goto +2
+    Quit
+!macroend

packages/insomnia/customSign.js

@@ -5,12 +5,11 @@ const execAsync = util.promisify(exec);
 
 // adapted from https://www.electron.build/win.html#how-do-delegate-code-signing
 // It was possible code-sign installer after packaging, but some files are only available
-// through hooking into the signing step of electron-builder while the final squirrel installer is being built
-// This makes it possible to sign the Update.exe and stub of Insomnia.exe that end up in C:\Users\<user>\AppData\Local\insomnia
-exports.default = async function(configuration) {
-    // skip signing if not windows squirrel
-    if (configuration.options.target.length === 0 || configuration.options.target[0].target !== 'squirrel') {
-        console.log('[customSign] Skipping signing because target is not windows squirrel.');
+// through hooking into the signing step of electron-builder while the final nsis installer is being built
+// This makes it possible to sign the Update.exe and stub of Insomnia.exe that end up in the installation folder
+exports.default = async function (configuration) {
+    if (configuration.options.target.length === 0 || (configuration.options.target[0].target !== 'nsis')) {
+        console.log('[customSign] Skipping signing because target is not nsis.');
         return;
     }
 

packages/insomnia/electron-builder.config.js

@@ -86,16 +86,27 @@ const config = {
   win: {
     target: [
       {
-        target: 'squirrel',
+        target: 'nsis',
+        arch: ['x64'],
       },
     ],
     sign: './customSign.js',
     signingHashAlgorithms: ['sha256'], // avoid duplicate signing hook calls https://github.com/electron-userland/electron-builder/issues/3995#issuecomment-505725704
   },
-  squirrelWindows: {
+  nsis: {
     artifactName: `${BINARY_PREFIX}-\${version}.\${ext}`,
-    iconUrl:
-      'https://github.com/kong/insomnia/blob/develop/packages/insomnia/src/icons/icon.ico?raw=true',
+    include: './config/uninstall-squirrel.nsh',
+    oneClick: false,
+    selectPerMachineByDefault: true,
+    allowToChangeInstallationDirectory: true,
+    installerIcon: './build/icon.ico',
+    installerSidebar: './src/icons/nsis-sidebar.bmp',
+    uninstallerSidebar: './src/icons/nsis-sidebar.bmp',
+    uninstallerIcon: './build/icon.ico',
+    createDesktopShortcut: true,
+    createStartMenuShortcut: true,
+    shortcutName: 'Insomnia',
+    deleteAppDataOnUninstall: false,
   },
   portable: {
     artifactName: `${BINARY_PREFIX}-\${version}-portable.\${ext}`,

packages/insomnia/package.json

@@ -24,7 +24,7 @@
     "lint": "eslint . --ext .js,.ts,.tsx --cache",
     "package": "npm run build:app && cross-env USE_HARD_LINKS=false electron-builder build --config electron-builder.config.js",
     "package:windows:unpacked": "npm run build:app && cross-env USE_HARD_LINKS=false electron-builder build --config electron-builder.config.js --dir",
-    "package:windows:dist": "cross-env USE_HARD_LINKS=false electron-builder build --config electron-builder.config.js --win squirrel --prepackaged ./dist/win-unpacked",
+    "package:windows:dist": "cross-env USE_HARD_LINKS=false electron-builder build --config electron-builder.config.js --win nsis --prepackaged ./dist/win-unpacked",
     "start": "npx -y concurrently -n browser,main --kill-others \"npm run start:dev-server\" \"npm run start:electron\"",
     "start:dev-server": "vite dev",
     "start:electron": "cross-env NODE_ENV=development esr esbuild.main.ts && electron --inspect=5858 .",

packages/insomnia/src/common/constants.ts

@@ -119,7 +119,7 @@ export const displayModifierKey = (key: keyof Omit<KeyCombination, 'keyCode'>) =
 // Update
 export enum UpdateURL {
   mac = 'https://updates.insomnia.rest/builds/check/mac',
-  windows = 'https://updates.insomnia.rest/updates/win',
+  windows = 'https://updates.insomnia.rest/updates/win/RELEASES',
 }
 
 // API