FMA: Installing macOS app bundles when they're already installed breaks the app #24148

noahtalerman · 2024-11-25T21:46:11Z

Fleet version: Observed in Fleet's dogfood environment

Web browser and operating system: macOS 14.6.1

💥 Actual behavior

Check out the Loom video here.

Restarting my Mac resolved the issue.

🧑‍💻 Steps to reproduce

See Loom video here.

🕯️ More info (optional)

@kennyb-222 observed that sometimes the install fails when VS Code is already installed. Check out the recording here.

@noahtalerman: Is this a different bug?

That recording^ includes suggested tweaks to the install script for VS Code.

@kennyb-222 on why this is happening:

"macOS doesn’t handle copying app bundles over existing ones very well since Big Sur (I believe) and later. It’s generally best practice to move the existing app out of the way before deploying a new one. In the video, I also highlighted how modifying the generated install script resolves this issue."
- Here's how Homebrew approached a similar problem: Don't remove cask directories when upgrading. Homebrew/brew#15138
"I used VS Code as an example, but seems like an inherent issue with how Fleet handles all app installs and likely affects all apps that are copied to the /Applications dir using cp."

To fix

If the app has already been installed and launched/configured by the user, the following apps will break upon re-install so will need the install script tweaked (or a fix applied):

1Password
Brave
Docker
Figma
Chrome
VSCode
Firefox
Notion
Slack
WhatsApp

QA Plan

noahtalerman · 2024-11-25T21:47:44Z

nherent issue with how Fleet handles all app installs and likely affects all apps that are copied to the /Applications dir using cp

@PezHub just checking, as part of testing for Fleet-maintained apps, do we test installing the apps on workstations that already have the apps installed?

cc @georgekarrv

PezHub · 2024-11-25T22:27:58Z

I did (Column H) but tbh I did not test installing over existing apps if they were already open, I simply looked to see that the FMA was in the Applications folder once it completed. I did test that behavior (if app was open) for uninstalls tho (Column J).

https://docs.google.com/spreadsheets/d/1L2u7r3vZrNrEa6aOKFRKmiFDqpHOsXWekVr8VYFgMoE/edit?gid=1818352066#gid=1818352066

It would be nice to have the install check for existing version and include the logic to quit if open

PezHub · 2024-12-02T21:42:34Z

Additional QA Notes:

if VSCode is previously installed but never launched, a re-install over it (fleet-maintained app) will succeed and the app will launch. This explains why my initial tests passed
a previously installed and launched version of VS Code will break when user or admin installs the fleet-maintained app over it. Same results that @noahtalerman posted in his video
confirmed the same behavior with another FMA (chrome)

So adding additional logic to check for existing installs and take action if present (similar to what Keeny mentioned above) makes sense

noahtalerman · 2024-12-04T22:51:19Z

if VSCode is previously installed but never launched, a re-install over it (fleet-maintained app) will succeed and the app will launch. This explains why my initial tests passed

a previously installed and launched version of VS Code will break when user or admin installs the fleet-maintained app over it. Same results that @noahtalerman posted in his video

confirmed the same behavior with another FMA (chrome)

So adding additional logic to check for existing installs and take action if present (similar to what Keeny mentioned above) makes sense

@PezHub instead of adding additional logic to check, can we tweak the install script (see how Kenny did in recording here), to work w/o breaking the app in both of the above cases?

Just realized this wasn't on the release board. I moved it there. FYI @georgekarrv

lukeheath · 2024-12-06T21:58:53Z

Fleet version: Observed in Fleet's dogfood environment

@noahtalerman I'm not clear on if this is an unreleased bug or released bug. Would you please update? Thanks!

PezHub · 2024-12-09T18:48:50Z

added ~released bug label
confirmed all 20 FMAs will re-install successfully over existing apps if they are never launched

However, if the FMA's have already been installed and launched/configured by the user, the following apps will break upon re-install so will need the install script tweaked (or a fix applied):

1Password
Brave
Docker
Figma
Chrome
VSCode
Firefox
Notion
Slack
WhatsApp

noahtalerman · 2024-12-09T20:30:29Z

However, if the FMA's have already been installed and launched/configured by the user, the following apps will break upon re-install so will need the install script tweaked (or a fix applied):

1Password

Brave

Docker

Figma

Chrome

VSCode

Firefox

Notion

Slack

WhatsApp

@PezHub thanks! I added your list to the issue description under the "To fix" section.

FYI @georgekarrv

getvictor · 2025-01-02T21:54:19Z

@mostlikelee should this be in #g-software?

mostlikelee · 2025-01-03T14:12:27Z

renaming the issue to cover all app bundle copy installs

mostlikelee · 2025-01-03T15:01:58Z

Hey team! Please add your planning poker estimate with Zenhub @jahzielv @iansltx

jahzielv · 2025-01-07T17:08:28Z

in g-software standup today we discussed with @eugkuo and determined that we should be closing the application when a re-install is happening.

cc @mostlikelee

jahzielv · 2025-01-08T16:07:33Z

QA plan

Validate that the migration updates existing install scripts for the above list of FMAs. Any of those FMAs that were previously added to a team and had their install scripts edited shouldn't have updated.
Validate that triggering an ingestion of FMA data writes the updated install scripts
For each of the FMAs listed, check that
a. installing it manually works
b. automatic install works
c. closing the app and then installing it again works
d. re-installing the app while the app is opened on the host should quit the app and successfully re-install

iansltx · 2025-01-08T19:41:21Z

Additional QA check:

When reinstalling, at the end of a successful install we shouldn't have the backup of the old app in the temp dir.

Questions:

Should we fail the install when the app is open and doesn't close?
If the install fails when reinstalling an existing app, what should we do? Normally we run an uninstall script, but that uninstall script almost certainly doesn't have "move the backup app back" in it right now.

…5238) > For #24148 # Checklist for submitter If some of the following don't apply, delete the relevant line.  - [x] Changes file added for user-visible changes in `changes/`, `orbit/changes/` or `ee/fleetd-chrome/changes`. See [Changes files](https://github.com/fleetdm/fleet/blob/main/docs/Contributing/Committing-Changes.md#changes-files) for more information. - [x] Input data is properly validated, `SELECT *` is avoided, SQL injection is prevented (using placeholders for values in statements) - [x] If database migrations are included, checked table schema to confirm autoupdate - For database migrations: - [x] Checked schema for all modified table for columns that will auto-update timestamps during migration. - [x] Confirmed that updating the timestamps is acceptable, and will not cause unwanted side effects. - [x] Ensured the correct collation is explicitly set for character columns (`COLLATE utf8mb4_unicode_ci`). - [x] Added/updated automated tests - [x] A detailed QA plan exists on the associated ticket (if it isn't there, work with the product group's QA engineer to add it) - [x] Manual QA for all new/changed functionality

jmwatts · 2025-01-10T16:58:22Z

Full QA test plan with results (In progress)

QA Plan

Setup:
Start with previous version, ensure all FMAs listed above have been added to at least one team.
On another team, add all FMAs listed above but edit install scripts (make note of changes made)

Upgrade:

Upgrade to fix version, validate that the migration runs
2025/01/10 14:18:08 [2025-01-09] Update FMA Install Scripts
Validate that the migration updates existing install scripts for the FMAs that did not have edited install scripts.
Validate that the migration DOES NOT update any existing FMAs that had their install scripts edited prior to upgrade

After Upgrade:
Add each FMA listed above and validate that they have the updated install scripts

1Password

Validate it has the updated install scripts
Validate a manual install is successful
Validate an automatic install is successful
Validate opening app, closing app, then reinstalling app is successful
Validate opening app and leaving open while reinstalling forces the app to quit and reinstall is successful
Validate when reinstalling, at the end of a successful install we shouldn't have the backup of the old app in the temp dir.

Brave

Validate it has the updated install scripts
Validate a manual install is successful
Validate an automatic install is successful
Validate opening app, closing app, then reinstalling app is successful
Validate opening app and leaving open while reinstalling forces the app to quit and reinstall is successful
Validate when reinstalling, at the end of a successful install we shouldn't have the backup of the old app in the temp dir.

Docker

Validate it has the updated install scripts
Validate a manual install is successful
Validate an automatic install is successful
Validate opening app, closing app, then reinstalling app is successful
Validate opening app and leaving open while reinstalling forces the app to quit and reinstall is successful Docker FMA installation fails with current install script #25874
Validate when reinstalling, at the end of a successful install we shouldn't have the backup of the old app in the temp dir.

Figma

Validate it has the updated install scripts
Validate a manual install is successful
Validate an automatic install is successful
Validate opening app, closing app, then reinstalling app is successful
Validate opening app and leaving open while reinstalling forces the app to quit and reinstall is successful
Validate when reinstalling, at the end of a successful install we shouldn't have the backup of the old app in the temp dir.

Chrome

Validate it has the updated install scripts
Validate a manual install is successful
Validate an automatic install is successful
Validate opening app, closing app, then reinstalling app is successful
Validate opening app and leaving open while reinstalling forces the app to quit and reinstall is successful
Validate when reinstalling, at the end of a successful install we shouldn't have the backup of the old app in the temp dir.

VSCode

Validate it has the updated install scripts
Validate a manual install is successful
Validate an automatic install is successful
Validate opening app, closing app, then reinstalling app is successful
Validate opening app and leaving open while reinstalling forces the app to quit and reinstall is successful
Validate when reinstalling, at the end of a successful install we shouldn't have the backup of the old app in the temp dir.

Firefox

Validate it has the updated install scripts
Validate a manual install is successful
Validate an automatic install is successful
Validate opening app, closing app, then reinstalling app is successful
Validate opening app and leaving open while reinstalling forces the app to quit and reinstall is successful
Validate when reinstalling, at the end of a successful install we shouldn't have the backup of the old app in the temp dir.

Notion

Validate it has the updated install scripts
Validate a manual install is successful
Validate an automatic install is successful
Validate opening app, closing app, then reinstalling app is successful
Validate opening app and leaving open while reinstalling forces the app to quit and reinstall is successful
Validate when reinstalling, at the end of a successful install we shouldn't have the backup of the old app in the temp dir.

Slack

Validate it has the updated install scripts
Validate a manual install is successful
Validate an automatic install is successful
Validate opening app, closing app, then reinstalling app is successful
Validate opening app and leaving open while reinstalling forces the app to quit and reinstall is successful
Validate when reinstalling, at the end of a successful install we shouldn't have the backup of the old app in the temp dir.

Validate it has the updated install scripts
Validate a manual install is successful
Validate an automatic install is successful
Validate opening app, closing app, then reinstalling app is successful
Validate opening app and leaving open while reinstalling forces the app to quit and reinstall is successful
Validate when reinstalling, at the end of a successful install we shouldn't have the backup of the old app in the temp dir.

jmwatts · 2025-01-10T20:26:54Z

@jahzielv I feel a little picky about this but... there are extra lines at the beginning of the updated scripts... is that intentional?
Before upgrade:

After upgrade:

jahzielv · 2025-01-10T20:28:03Z

@jmwatts wasn't intentional, shouldn't affect functionality but I can look into removing them if we want (agree that it looks a bit weird)

jmwatts · 2025-01-10T22:20:05Z

@jahzielv I'm getting failed installs for Brave and Firefox so far when the app was already installed and open when reinstalling. Text files are attached below with the output.
Additionally, I'm seeing a lot of folders in /tmp. This is what it looked like after installing and re-installing 8/10 apps. When should those disappear?

BraveRe-installFail.txt
FirefoxRe-installFail.txt

jahzielv · 2025-01-10T22:37:06Z

@jmwatts thanks for the report! I'll dig into those failures.

Yeah, we shouldn't be seeing stuff linger in /tmp. Orbit should be removing those. I'll try to repro on my end.

jahzielv · 2025-01-13T16:30:36Z

did some pairing with @jmwatts this morning! Our findings:

the extra folders in /tmp are an existing bug. We defer the temp dir cleanup after trying to download the installer, so if there is an error in downloading the installer (like there was when Janis was testing, the installer is very large and ngrok timed out during download), we do not clean up the temp dir we created. We should move that defer higher up. Janis is filing a bug for this.
I was able to repro the firefox error pasted above. I'm looking into it now, probably something I changed in between my own tests and the PR merging.

jmwatts · 2025-01-14T22:41:32Z

@jahzielv will there be additional changes for the Firefox and Brave installers in this ticket or will those need an unreleased bug ticket to address the issues?

jahzielv · 2025-01-15T13:28:55Z

@jmwatts ~~I will file the PR under this ticket!~~ correction, I will attempt to reproduce again (I wasn't able to this morning) and if I'm able I'll file an unreleased bug

jahzielv · 2025-01-15T18:34:00Z

I was able to reproduce, so filed an unreleased bug here: #25467
working on it now!

jmwatts · 2025-01-30T00:41:51Z

QA Notes
#25467 is resolved for Firefox and Brave.
#25373 is slated for fleetd 1.39.0
One additional line was removed from the updated script - it looks better now.
Per previous notes and QA Plan, 1Password, Brave, Figma, Chrome, VSCode, Firefox, Notion, Slack, and WhatsApp are installing and reinstalling successfully now.
#25874 is filed for Docker installation fails. Will wait for that to be finished and tested before this ticket will be moved to "Ready for release".

noahtalerman added bug Something isn't working as documented #g-mdm MDM product group :incoming New issue in triage process. customer-numa labels Nov 25, 2024

noahtalerman added :release Ready to write code. Scheduled in a release. See "Making changes" in handbook. and removed :incoming New issue in triage process. labels Dec 4, 2024

lukeheath added ~released bug This bug was found in a stable release. and removed ~released bug This bug was found in a stable release. labels Dec 6, 2024

PezHub added the ~released bug This bug was found in a stable release. label Dec 9, 2024

georgekarrv added this to the 4.62.0-tentative milestone Dec 11, 2024

mostlikelee added ~backend Backend-related issue. #g-software Software product group and removed #g-mdm MDM product group labels Jan 2, 2025

iansltx removed this from the 4.62.0 milestone Jan 2, 2025

mostlikelee changed the title ~~Installing VS Code when it's already installed breaks VS Code~~ Installing macOS app bundles when they're already installed breaks the app Jan 3, 2025

mostlikelee changed the title ~~Installing macOS app bundles when they're already installed breaks the app~~ FMA: Installing macOS app bundles when they're already installed breaks the app Jan 3, 2025

mostlikelee assigned jahzielv Jan 6, 2025

mostlikelee added this to the 4.63.0-tentative milestone Jan 7, 2025

jahzielv mentioned this issue Jan 8, 2025

fix: update install script for FMAs to improve re-install process #25238

Merged

9 tasks

jmwatts mentioned this issue Jan 13, 2025

Temporary files fill the /tmp directory and are not deleted when software installer package fails to download during software installation #25373

Open

jahzielv mentioned this issue Jan 15, 2025

Firefox and Brave FMA failing to re-install #25467

Open

This was referenced Jan 23, 2025

Clearly define when an app stops being Fleet-maintained #25732

Open

Allow out-of-cycle changes to Fleet-maintained app definitions (FMAv2) #25734

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FMA: Installing macOS app bundles when they're already installed breaks the app #24148

FMA: Installing macOS app bundles when they're already installed breaks the app #24148

noahtalerman commented Nov 25, 2024 •

edited by jmwatts

Loading

noahtalerman commented Nov 25, 2024

PezHub commented Nov 25, 2024 •

edited

Loading

PezHub commented Dec 2, 2024

noahtalerman commented Dec 4, 2024

lukeheath commented Dec 6, 2024

PezHub commented Dec 9, 2024

noahtalerman commented Dec 9, 2024

getvictor commented Jan 2, 2025

mostlikelee commented Jan 3, 2025

mostlikelee commented Jan 3, 2025

jahzielv commented Jan 7, 2025

jahzielv commented Jan 8, 2025

iansltx commented Jan 8, 2025

jmwatts commented Jan 10, 2025 •

edited

Loading

jmwatts commented Jan 10, 2025

jahzielv commented Jan 10, 2025

jmwatts commented Jan 10, 2025

jahzielv commented Jan 10, 2025

jahzielv commented Jan 13, 2025

jmwatts commented Jan 14, 2025

jahzielv commented Jan 15, 2025 •

edited

Loading

jahzielv commented Jan 15, 2025

jmwatts commented Jan 30, 2025

FMA: Installing macOS app bundles when they're already installed breaks the app #24148

FMA: Installing macOS app bundles when they're already installed breaks the app #24148

Comments

noahtalerman commented Nov 25, 2024 • edited by jmwatts Loading

💥 Actual behavior

🧑‍💻 Steps to reproduce

🕯️ More info (optional)

To fix

QA Plan

noahtalerman commented Nov 25, 2024

PezHub commented Nov 25, 2024 • edited Loading

PezHub commented Dec 2, 2024

noahtalerman commented Dec 4, 2024

lukeheath commented Dec 6, 2024

PezHub commented Dec 9, 2024

noahtalerman commented Dec 9, 2024

getvictor commented Jan 2, 2025

mostlikelee commented Jan 3, 2025

mostlikelee commented Jan 3, 2025

jahzielv commented Jan 7, 2025

jahzielv commented Jan 8, 2025

QA plan

iansltx commented Jan 8, 2025

jmwatts commented Jan 10, 2025 • edited Loading

QA Plan

jmwatts commented Jan 10, 2025

jahzielv commented Jan 10, 2025

jmwatts commented Jan 10, 2025

jahzielv commented Jan 10, 2025

jahzielv commented Jan 13, 2025

jmwatts commented Jan 14, 2025

jahzielv commented Jan 15, 2025 • edited Loading

jahzielv commented Jan 15, 2025

jmwatts commented Jan 30, 2025

noahtalerman commented Nov 25, 2024 •

edited by jmwatts

Loading

PezHub commented Nov 25, 2024 •

edited

Loading

jmwatts commented Jan 10, 2025 •

edited

Loading

jahzielv commented Jan 15, 2025 •

edited

Loading