feat(auto-updater): Error when requesting updates from an outdated MacOS machine COMPASS-9081 #6851

kraenhansen · 2025-04-09T09:55:51Z

Description

Merging this PR will:

Propagate MacOS product version to the update server (through a query-string param).
React to the server sending a response of status 426 (Upgrade Required) and parse the body of the response to determine any reason for the rejection.
If the reason is determined to be 'outdated-operating-system' the updater will transition to a new OutdatedOperatingSystem state.
This will propagate to the UI with a custom alert message (when the update was manually checked) and a toast to inform the user of the outdated operating system. Both with a link to the system requirements: https://www.mongodb.com/docs/compass/current/install/

After manual check

After automatic or manual check

You can verify the behaviour introduced with this PR by running Compass locally on a Mac passing a fake version (to bypass the skip in the update server) and update server endpoint:

HADRON_APP_VERSION=0.0.1-dev.1 HADRON_AUTO_UPDATE_ENDPOINT_OVERRIDE=http://localhost:8080 npm start

Use this with the update server from https://github.com/10gen/compass-mongodb-com/pull/129 updating the MINIMUM_MACOS_VERSION to a future version of MacOS ("20.0.0" or something).

Checklist

New tests and/or benchmarks are included
Documentation is changed or added
If this change updates the UI, screenshots/videos are added and a design review is requested
I have signed the MongoDB Contributor License Agreement (https://www.mongodb.com/legal/contributor-agreement)

Motivation and Context

Bugfix
New feature
Dependency update
Misc

Open Questions

Dependents

Types of changes

Backport Needed
Patch (non-breaking change which fixes an issue)
Minor (non-breaking change which adds functionality)
Major (fix or feature that would cause existing functionality to change)

Copilot

Copilot reviewed 7 out of 8 changed files in this pull request and generated 1 comment.

Files not reviewed (1)

packages/compass/package.json: Language not supported

gribnoysup · 2025-04-11T07:59:53Z

packages/compass/src/app/components/update-toasts.tsx

-    description: 'Downloading a newer Compass version failed',
+    description:
+      reason === 'outdated-operating-system'
+        ? 'The version of your operating system is no longer supported.'


Maybe a link to the docs install page where we list minimal reqs? This one https://www.mongodb.com/docs/compass/current/install/

👍 I wonder if that would be clickable? 🤔

We have both buttons and links in toasts in some places in Compass, if you render it as a link, it should be clickable

gribnoysup · 2025-04-11T08:01:46Z

packages/compass/src/main/auto-update-manager.ts

-        message: 'There are currently no updates available.',
+        message:
+          updateInfo.reason === 'outdated-operating-system'
+            ? `The version of your operating system is no longer supported. Expected at least v${updateInfo.expectedVersion}`


I would maybe run this through product. Personally I'm not sure how common it is to prefix an OS version with v and it caught my eye 🙂 Maybe we can do a better wording here and also link to the docs (same link I mentioned above)

A link here wouldn't be clickable, in which case a button on the message box would be better? 🤔

Oh, right, it's a native box, skipped my mind. Hmmm, yeah, not sure, can try a button for this, but might be slightly weird too 🤔

(Don't want to overcomplicate this too, so your call if it's too much extra effort)

I added a button - it seems better to me 👍

gribnoysup · 2025-04-11T08:05:06Z

packages/compass/src/main/auto-update-manager.ts

+        assert(
+          typeof json === 'object' && json !== null,
+          'Expected response to be an object'
+        );
+        if ('reason' in json && json.reason === 'outdated-operating-system') {
+          assert(
+            'expectedVersion' in json,
+            "Expected 'expectedVersion' in response"
+          );
+          const { expectedVersion } = json;
+          assert(
+            typeof expectedVersion === 'string',
+            "Expected 'expectedVersion' in response"
+          );
+          return {
+            available: false,
+            reason: 'outdated-operating-system',
+            expectedVersion,
+          };


Nit: you have a custom catch for the response assertion below, but not here. If we think it's worth having custom logging for the one below, it's probably worth here too?

I added a try-catch around this parsing with a message that add a bit more context 👍

gribnoysup

Didn't have a chance to run this code myself, but reading through it looks good (only small nit about error handling)! I would probalby double-check that copy looks okay to product

kraenhansen · 2025-04-11T09:44:19Z

I've added links to the system requirements and updated the screenshots accordingly 👍

kraenhansen · 2025-04-14T08:33:15Z

Merging as @betsybutton gave a LGTM on Slack 👍

kraenhansen self-assigned this Apr 9, 2025

kraenhansen changed the title ~~feat(auto-updater): Error when requesting updates from an outdated MacOS machine~~ feat(auto-updater): Error when requesting updates from an outdated MacOS machine COMPASS-9081 Apr 9, 2025

kraenhansen force-pushed the kh/send-darwin-info-when-updating branch 2 times, most recently from 7ba33c2 to 1b962c9 Compare April 10, 2025 10:01

github-actions bot added the feat label Apr 10, 2025

kraenhansen requested a review from Copilot April 10, 2025 10:58

Copilot AI reviewed Apr 10, 2025

View reviewed changes

kraenhansen force-pushed the kh/send-darwin-info-when-updating branch from 1b962c9 to d88461c Compare April 10, 2025 11:02

mongodb-js deleted a comment from Copilot bot Apr 10, 2025

kraenhansen added the no release notes Fix or feature not for release notes label Apr 10, 2025

kraenhansen marked this pull request as ready for review April 10, 2025 16:08

kraenhansen added 8 commits April 10, 2025 18:10

Upgrade get-os-info

d59aea3

Pass Darwin os version via query params

bd68c21

Add a new OutdatedOperatingSystem state

aeeddb6

Parse a status 426 response

cc06a88

Adjust message when manual check fails because of an outdated OS

c81851f

Add state transition tests

2f86f6a

Propagate error through the UI

476e008

Fix menu idle state after failing update

7cdc3eb

kraenhansen force-pushed the kh/send-darwin-info-when-updating branch from d88461c to 7cdc3eb Compare April 10, 2025 16:10

gribnoysup reviewed Apr 11, 2025

View reviewed changes

gribnoysup approved these changes Apr 11, 2025

View reviewed changes

kraenhansen added 4 commits April 11, 2025 11:34

Add a link to system requirements to the toast

8561e75

Remove v prefix

1274c6f

Wrapping parsing of 426 HTTP responses in a try-catch

7bb19d2

Add a link to system requirements to message box

4e28be4

kraenhansen merged commit c060544 into main Apr 14, 2025
82 of 83 checks passed

kraenhansen deleted the kh/send-darwin-info-when-updating branch April 14, 2025 08:33

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(auto-updater): Error when requesting updates from an outdated MacOS machine COMPASS-9081 #6851

feat(auto-updater): Error when requesting updates from an outdated MacOS machine COMPASS-9081 #6851

kraenhansen commented Apr 9, 2025 •

edited

Loading

Copilot AI left a comment

gribnoysup Apr 11, 2025

kraenhansen Apr 11, 2025 •

edited

Loading

gribnoysup Apr 11, 2025

gribnoysup Apr 11, 2025

kraenhansen Apr 11, 2025

gribnoysup Apr 11, 2025

gribnoysup Apr 11, 2025

kraenhansen Apr 11, 2025 •

edited

Loading

gribnoysup Apr 11, 2025 •

edited

Loading

kraenhansen Apr 11, 2025

gribnoysup left a comment

kraenhansen commented Apr 11, 2025

kraenhansen commented Apr 14, 2025 •

edited

Loading

feat(auto-updater): Error when requesting updates from an outdated MacOS machine COMPASS-9081 #6851

feat(auto-updater): Error when requesting updates from an outdated MacOS machine COMPASS-9081 #6851

Conversation

kraenhansen commented Apr 9, 2025 • edited Loading

Description

After manual check

After automatic or manual check

Checklist

Motivation and Context

Open Questions

Dependents

Types of changes

Copilot AI left a comment

Choose a reason for hiding this comment

gribnoysup Apr 11, 2025

Choose a reason for hiding this comment

kraenhansen Apr 11, 2025 • edited Loading

Choose a reason for hiding this comment

gribnoysup Apr 11, 2025

Choose a reason for hiding this comment

gribnoysup Apr 11, 2025

Choose a reason for hiding this comment

kraenhansen Apr 11, 2025

Choose a reason for hiding this comment

gribnoysup Apr 11, 2025

Choose a reason for hiding this comment

gribnoysup Apr 11, 2025

Choose a reason for hiding this comment

kraenhansen Apr 11, 2025 • edited Loading

Choose a reason for hiding this comment

gribnoysup Apr 11, 2025 • edited Loading

Choose a reason for hiding this comment

kraenhansen Apr 11, 2025

Choose a reason for hiding this comment

gribnoysup left a comment

Choose a reason for hiding this comment

kraenhansen commented Apr 11, 2025

kraenhansen commented Apr 14, 2025 • edited Loading

kraenhansen commented Apr 9, 2025 •

edited

Loading

kraenhansen Apr 11, 2025 •

edited

Loading

kraenhansen Apr 11, 2025 •

edited

Loading

gribnoysup Apr 11, 2025 •

edited

Loading

kraenhansen commented Apr 14, 2025 •

edited

Loading