feat: add universal build for desktop app #43505

dominictb · 2024-06-11T18:59:56Z

Details

Fixed Issues

Tests

Run npm run desktop-build
Inspect the binary in the desktop-build/mac-universal folder (Right click -> Get info on Mac)

Verify that the kind is Application (Universal)
Verify that the startup time of the new binary is faster compared to the old desktop build

For #39631

Run desktop app using the new build
Change chat with chat switcher all using the keyboard (hit Cmd+K),
Hit enter to go to another chat (not the currently open one)

Verify that: the app has navigated to the new chat

Verify that no errors appear in the JS console

Offline tests

QA Steps

Download the new built app
Inspect the app in the Application folder (Right click -> Get info on Mac)

Verify that the kind is Application (Universal)
Verify that the startup time of the new binary is faster compared to the old desktop build

For #39631

Run desktop app using the new app
Change chat with chat switcher all using the keyboard (hit Cmd+K),
Hit enter to go to another chat (not the currently open one)

Verify that: the app has navigated to the new chat

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

Signed-off-by: dominictb <tb-dominic@outlook.com>

melvin-bot · 2024-06-12T06:42:48Z

@fedirjh Please copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

dominictb · 2024-06-12T06:45:28Z

@eh2077 PR is ready for review. Sorry I might mess up a bit the reviewer automation

eh2077 · 2024-06-12T15:09:31Z

Reviewer Checklist

I have verified the author checklist is complete (all boxes are checked off).
I verified the correct issue is linked in the ### Fixed Issues section above
I verified testing steps are clear and they cover the changes made in this PR
- I verified the steps for local testing are in the Tests section
- I verified the steps for Staging and/or Production testing are in the QA steps section
- I verified the steps cover any possible failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
- I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
I checked that screenshots or videos are included for tests on all platforms
I included screenshots or videos for tests on all platforms
I verified tests pass on all platforms & I tested again on:
- Android: Native
- Android: mWeb Chrome
- iOS: Native
- iOS: mWeb Safari
- MacOS: Chrome / Safari
- MacOS: Desktop
If there are any errors in the console that are unrelated to this PR, I either fixed them (preferred) or linked to where I reported them in Slack
I verified proper code patterns were followed (see Reviewing the code)
- I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick).
- I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
- I verified that comments were added to code that is not self explanatory
- I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
- I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
- I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
- I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
- I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
- I verified the JSDocs style guidelines (in STYLE.md) were followed
If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
I verified that this PR follows the guidelines as stated in the Review Guidelines
I verified other components that can be impacted by these changes have been tested, and I retested again (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar have been tested & I retested again)
I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
If a new component is created I verified that:
- A similar component doesn't exist in the codebase
- All props are defined accurately and each prop has a /** comment above it */
- The file is named correctly
- The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
- The only data being stored in the state is data necessary for rendering and nothing else
- For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
- Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
- All JSX used for rendering exists in the render method
- The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
If any new file was added I verified that:
- The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
If a new CSS style is added I verified that:
- A similar style doesn't already exist
- The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG)
If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
If the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label and/or tagged @Expensify/design so the design team can review the changes.
If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

Screen.Recording.2024-06-13.at.12.21.51.AM.mov

eh2077

LGTM

neil-marcellini

Looks good, thanks.

OSBotify · 2024-06-13T21:29:05Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

OSBotify · 2024-06-14T23:17:15Z

🚀 Deployed to staging by https://github.com/neil-marcellini in version: 1.4.84-0 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅

OSBotify · 2024-06-17T23:49:28Z

🚀 Deployed to production by https://github.com/AndrewGable in version: 1.4.84-3 🚀

platform	result
🤖 android 🤖	failure ❌
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅

s77rt · 2024-07-18T13:58:44Z

config/electronBuilder.config.js

+        target: [
+            {
+                target: 'dmg',
+                arch: ['universal'],
+            },
+        ],


Changing the target to dmg broke app updates. From the electron-builder docs: Squirrel.Mac auto update mechanism requires both dmg and zip to be enabled, even when only dmg is used. Disabling zip will break auto update in dmg packages.

We should have left the target set to default

dominictb added 2 commits June 12, 2024 01:58

feat: add universal build for desktop app

e0d52eb

Signed-off-by: dominictb <tb-dominic@outlook.com>

fix: format

aa9ab6d

Signed-off-by: dominictb <tb-dominic@outlook.com>

dominictb marked this pull request as ready for review June 12, 2024 06:42

dominictb requested a review from a team as a code owner June 12, 2024 06:42

melvin-bot bot requested review from fedirjh and removed request for a team June 12, 2024 06:42

eh2077 approved these changes Jun 12, 2024

View reviewed changes

melvin-bot bot requested a review from neil-marcellini June 12, 2024 16:23

neil-marcellini approved these changes Jun 13, 2024

View reviewed changes

neil-marcellini merged commit 9ddc788 into Expensify:main Jun 13, 2024
20 checks passed

github-actions bot mentioned this pull request Jun 14, 2024

Deploy Checklist: New Expensify 2024-06-14 #43793

Closed

53 tasks

This was referenced Jun 17, 2024

[HOLD for payment 2024-06-24] [$250] Desktop app startup is slow #42558

Closed

[HOLD for payment 2024-06-24][$1000] Correct chat is not opening when typing someone's name and hit Enter in chat switcher #39631

Closed

s77rt mentioned this pull request Jun 30, 2024

[HOLD for payment 2024-08-13] [$500] Desktop - "Check for update" never actually shows option to update the Desktop app #44097

Closed

6 tasks

dominictb deleted the fix/42558 branch July 11, 2024 16:41

s77rt reviewed Jul 18, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add universal build for desktop app #43505

feat: add universal build for desktop app #43505

dominictb commented Jun 11, 2024 •

edited

Loading

melvin-bot bot commented Jun 12, 2024

dominictb commented Jun 12, 2024

eh2077 commented Jun 12, 2024 •

edited

Loading

eh2077 left a comment

neil-marcellini left a comment

OSBotify commented Jun 13, 2024

OSBotify commented Jun 14, 2024

OSBotify commented Jun 17, 2024

s77rt Jul 18, 2024

feat: add universal build for desktop app #43505

feat: add universal build for desktop app #43505

Conversation

dominictb commented Jun 11, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Jun 12, 2024

dominictb commented Jun 12, 2024

eh2077 commented Jun 12, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

eh2077 left a comment

Choose a reason for hiding this comment

neil-marcellini left a comment

Choose a reason for hiding this comment

OSBotify commented Jun 13, 2024

OSBotify commented Jun 14, 2024

OSBotify commented Jun 17, 2024

s77rt Jul 18, 2024

Choose a reason for hiding this comment

dominictb commented Jun 11, 2024 •

edited

Loading

eh2077 commented Jun 12, 2024 •

edited

Loading