fix: mac updates will be extracted nad deleted on appquit to prevent multiple app listing

Author: abose

src-node/installer/download-file.js

@@ -2,7 +2,6 @@ const { pipeline } = require('stream/promises');
 const { Transform } = require('stream');
 const fs = require('fs');
 const path = require('path');
-const os = require('os');
 const { exec } = require('child_process');
 
 const args = process.argv.slice(2); // Skip the first two elements
@@ -16,7 +15,7 @@ const EVENT_INSTALL_PATH= "InstallerPath,"; // its , here as separator as window
 const fileName = path.basename(new URL(downloadURL).pathname);
 const installerFolder = path.join(appdataDir, 'installer');
 const savePath = path.join(appdataDir, 'installer', fileName);
-let extractPath;
+let extractPath = null;
 
 async function getFileSize(url) {
     try {
@@ -76,33 +75,6 @@ async function downloadFile(url, outputPath) {
     console.log(`File has been downloaded and saved to ${outputPath}`);
 }
 
-/**
- * Extracts a .tar.gz file using the tar CLI utility available on macOS/linux.
- *
- * @param {string} filePath - The path to the .tar.gz file.
- * @param {string} absoluteExtractPath - The directory to extract the files into.
- */
-function extractTar(filePath, absoluteExtractPath) {
-    return new Promise((resolve, reject)=>{
-        const command = `tar -xzf "${filePath}" -C "${absoluteExtractPath}"`;
-
-        exec(command, (error, stdout, stderr) => {
-            if (error) {
-                console.error(`Extraction error: ${error.message}`);
-                reject(error.message);
-                return;
-            }
-            if (stderr) {
-                console.error(`Extraction stderr: ${stderr}`);
-                reject(stderr);
-                return;
-            }
-            console.log(`Extraction completed to ${absoluteExtractPath}`);
-            resolve();
-        });
-    });
-}
-
 /**
  * Extracts a ZIP file to the specified directory on Windows.
  *
@@ -130,33 +102,6 @@ function extractZipFileWindows(zipFilePath, absoluteExtractPath) {
     });
 }
 
-function removeQuarantineAttributeIfMac(extractPath) {
-    return new Promise((resolve)=>{
-        if (os.platform() === 'darwin') {
-            const command = `xattr -rd com.apple.quarantine "${extractPath}"`;
-
-            exec(command, (error, stdout, stderr) => {
-                // we always resolve as the user will be promted by macos if this fails here.
-                if (error) {
-                    console.error(`Error removing quarantine attribute: ${error.message}`);
-                    resolve();
-                    return;
-                }
-                if (stderr) {
-                    console.error(`Error output: ${stderr}`);
-                    resolve();
-                    return;
-                }
-                console.log(`Quarantine attribute removed successfully for ${extractPath}`);
-                resolve();
-            });
-        } else {
-            console.log("Platform is not macOS, no need to remove quarantine attribute.");
-            resolve();
-        }
-    });
-}
-
 async function downloadFileIfNeeded() {
     try {
 
@@ -181,11 +126,17 @@ async function downloadFileIfNeeded() {
             console.log(`Downloading installer to ${savePath}...`);
             await downloadFile(downloadURL, savePath);
         }
+        // extract path is assumed to be appdata/installer/extracted in phoenix side too,
+        // if changing location, update there too.
         extractPath = path.join(appdataDir, 'installer', "extracted");
         await fs.promises.rm(extractPath, { recursive: true, force: true });
         fs.mkdirSync(extractPath, { recursive: true });
         if(savePath.endsWith(".tar.gz")){
-            await extractTar(savePath, extractPath);
+            // mac installer tar.gz will be extracted at phoenix side as if we extract it now, there will be
+            // 2 `phoenix code.app` in the system, and mac will show both in the `open with` section in finder!
+            // so we only extract the app just before install.
+            extractPath = null;
+            return;
         }
         if(savePath.endsWith(".zip")){
             await extractZipFileWindows(savePath, extractPath);
@@ -195,7 +146,6 @@ async function downloadFileIfNeeded() {
         if(dirContents.length === 1){
             extractPath = path.join(extractPath, dirContents[0]);
         }
-        await removeQuarantineAttributeIfMac(extractPath);
     } catch (error) {
         console.error('An error occurred:', error);
     }

src/extensionsIntegrated/appUpdater/main.js

@@ -26,6 +26,7 @@
 define(function (require, exports, module) {
     const AppInit = require("utils/AppInit"),
         Metrics = require("utils/Metrics"),
+        FileSystem    = require("filesystem/FileSystem"),
         Commands = require("command/Commands"),
         CommandManager  = require("command/CommandManager"),
         Menus = require("command/Menus"),
@@ -334,13 +335,56 @@ define(function (require, exports, module) {
         return null;
     }
 
+    async function _extractMacInstaller() {
+        // todo delete .app files already in the install folder
+        const appdataDir = window._tauriBootVars.appLocalDir;
+        let extractPlatformPath = path.join(appdataDir, 'installer', "extracted");
+        // extract the .app file
+        const extractCommand = new window.__TAURI__.shell
+            .Command(`tar-unix`, ['-xzf', installerLocation, "-C", extractPlatformPath]);
+        let result = await extractCommand.execute();
+        if(result.code !== 0){
+            console.error("Could not extract installer at", installerLocation, "to", extractPlatformPath);
+            throw new Error("Could not extract installer at " + installerLocation + " to " + extractPlatformPath);
+        }
+        // remove the quarantine flag
+        const removeAttrCommand = new window.__TAURI__.shell
+            .Command(`mac-remove-quarantine`, ["-rd", "com.apple.quarantine", extractPlatformPath]);
+        result = await removeAttrCommand.execute();
+        if(result.code !== 0){
+            console.error("Could not remove quarantine attribute for", extractPlatformPath, "ignoring...");
+            // we can ignore this failure as the user will be asked for permission by os on clicking anyway.
+        }
+        // now get the .app path from extracted path
+        const extractedVirtualPath = window.fs.getTauriVirtualPath(extractPlatformPath);
+        let directory = FileSystem.getDirectoryForPath(extractedVirtualPath);
+        const {entries} = await directory.getContentsAsync();
+        if(entries.length !== 1){
+            throw new Error("Could not resolve .app to update from extracted folder" + extractedVirtualPath);
+        }
+        installerLocation = window.fs.getTauriPlatformPath(entries[0].fullPath);
+    }
+
+    function _cleanExtractedFolderSilent() {
+        return new Promise(resolve=>{
+            const appdataDir = window._tauriBootVars.appLocalDir;
+            let extractPlatformPath = path.join(appdataDir, 'installer', "extracted");
+            const extractedVirtualPath = window.fs.getTauriVirtualPath(extractPlatformPath);
+            let directory = FileSystem.getDirectoryForPath(extractedVirtualPath);
+            directory.unlinkAsync()
+                .catch(console.error)
+                .finally(resolve);
+        });
+    }
+
     async function doMacUpdate() {
+        await _extractMacInstaller(installerLocation);
         const currentAppPath = await getCurrentMacAppPath();
         if(!currentAppPath || !installerLocation || !currentAppPath.endsWith(".app") ||
             !installerLocation.endsWith(".app")){
             throw new Error("Cannot resolve .app location to copy.");
         }
-        const removeCommand = new window.__TAURI__.shell
+        let removeCommand = new window.__TAURI__.shell
             .Command(`recursive-rm-unix`, ['-r', currentAppPath]);
         let result = await removeCommand.execute();
         if(result.code !== 0){
@@ -353,6 +397,8 @@ define(function (require, exports, module) {
         if(result.code !== 0){
             throw new Error("Update script exit with non-0 exit code: " + result.code);
         }
+        // now remove the original .app
+        await _cleanExtractedFolderSilent();
     }
 
     let installerLocation;
@@ -413,6 +459,19 @@ define(function (require, exports, module) {
             // app updates are only for desktop builds
             return;
         }
+        if (brackets.platform === "mac") {
+            // in mac, the `update.app.tar.gz` is downloaded, and only extracted on app quit.
+            // we do this only in mac as the `.app` file is extracted only at app quit and deleted
+            // and if we see the `extracted file` at app boot, it means the update was broken,and we clear
+            // the updated folder. if not, the extracted app may be corrupt, or mac will show that app
+            // too in the finder `open with` section.
+            // in windows, the `setup.exe.zip` is downloaded and extracted to `setup.exe`. The exe is executed
+            // only on app quit. so if we do this in windows, the extracted installer.exe will be
+            // deleted on new widow create and the final update will fail if other windows were opened
+            // after the installer was downloaded and extracted.
+            // in Linux, it is an online installer, nothing is downloaded.
+            _cleanExtractedFolderSilent();
+        }
         updaterWindow = window.__TAURI__.window.WebviewWindow.getByLabel(TAURI_UPDATER_WINDOW_LABEL);
         window.__TAURI__.event.listen("updater-event", (receivedEvent)=> {
             console.log("received Event updater-event", receivedEvent);