feat: update electron builder to generate separate builds #24588

allroundexperts · 2023-08-15T16:09:18Z

Details

This PR updates electron builder config such that separate builds of the app are created on each platform.

Note: When running npm run build-desktop-adhoc locally, the build generated uses word marks of dev environment. This is because .env.adhoc file is missing on localhost. I haven't created one and committed it because each adhoc build has its own URL. I'm assuming this won't be a problem in the builds generated by the CI because proper environment would be set there.

Fixed Issues

$ #24426
PROPOSAL: #24426 (comment)

Tests

Build staging, adhoc and production desktop apps using npm run desktop-build-env.
Install the built apps.
Verify that all of these apps are installed and used separately.

Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

QA not applicable here.

Verify that no errors appear in the JS console

PR Author Checklist

I linked the correct issue in the ### Fixed Issues section above
I wrote clear testing steps that cover the changes made in this PR
- I added steps for local testing in the Tests section
- I added steps for the expected offline behavior in the Offline steps section
- I added steps for Staging and/or Production testing in the QA steps section
- I added steps to cover 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 tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
I included screenshots or videos for tests on all platforms
I ran the tests on all platforms & verified they passed on:
- Android / native
- Android / Chrome
- iOS / native
- iOS / Safari
- MacOS / Chrome / Safari
- MacOS / Desktop
I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
I followed proper code patterns (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 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
- If any non-english text was added/modified, I verified the translation was requested/reviewed in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
- 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 correct English and approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
- 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 followed the guidelines as stated in the Review Guidelines
I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
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
I verified that if a function's arguments changed that all usages have also been updated correctly
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(themeColors.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 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 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 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

melvin-bot · 2023-08-15T16:09:23Z

@ArekChr 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]

Julesssss · 2023-08-15T16:19:55Z

Generating a build here, but ignore the unrelated iOS failure.

Julesssss

Can we change staging to dev, this matches the Android and iOS flavours and simplifies things for us internally.

allroundexperts · 2023-08-15T16:25:16Z

Can we change staging to dev, this matches the Android and iOS flavours and simplifies things for us internally.

Do you want to change logos as well? Or are you talking about just the name?

Julesssss · 2023-08-15T16:38:43Z

Just the app name, package name, and env name

allroundexperts · 2023-08-15T16:58:46Z

Just the app name, package name, and env name

Done.

ArekChr · 2023-08-16T09:50:19Z

I need help building the app locally. I have some codesign issues.

allroundexperts · 2023-08-22T00:18:29Z

@Julesssss How do we want to proceed here? Seems like @ArekChr is having issues with building the desktop app.

Julesssss · 2023-08-29T09:24:45Z

@ArekChr what is the problem exactly? I just kicked off an AdHoc build for testing, but we still need to confirm the dev builds.

ArekChr · 2023-08-29T10:54:56Z

@Julesssss when building it locally using the npm run desktop-build got an error:

⨯ Command failed: codesign --sign Apple Development: Arkadiusz Chrabszczewski (4FPNF5NXXX) --force --timestamp --options runtime --entitlements desktop/entitlements.mac.plist /Users/arkadiuszchrabaszczewski/git/App/desktop-build/mac-arm64/New Expensify.app/Contents/Frameworks/Electron Framework.framework/Versions/A/Resources/af.lproj/locale.pak Apple Development: Arkadiusz Chrabszczewski (4FPNF5NXXX): ambiguous (matches "Apple Development: Arkadiusz Chrabszczewski (4FPNF5NXXX)" and "Apple Development: Arkadiusz Chrabszczewski (4FPNF5NXXX)" in /Users/arkadiuszchrabaszczewski/Library/Keychains/login.keychain-db)

ArekChr · 2023-08-29T11:24:49Z

Also, on GH Action, there is a template error in testBuild.yml

Julesssss · 2023-09-07T10:23:42Z

I started a new build. iOS will fail for an unrelated issue

Julesssss · 2023-09-07T11:38:16Z

I forgot to generate the test build using the changes from this PR, retrying....

Julesssss · 2023-09-11T07:24:13Z

Creating new test builds: https://github.com/Expensify/App/actions/runs/6143244978

Julesssss · 2023-09-11T07:42:24Z

Hi @allroundexperts, could you please merge main into this PR? I think that will solve the build errors.

allroundexperts · 2023-09-11T19:05:01Z

@Julesssss Updated!

Julesssss

Working well, with two issues:

We need to update the filename, as the old AdHoc download link no longer works (it should now be https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/24588/NewExpensifyAdHoc.dmg)
The apps seem to share an env/database -- though this is probably fine for now I guess

Julesssss

Can you update this line to be:

DESKTOP_LINK: https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/${{ env.PULL_REQUEST_NUMBER }}/NewExpensifyAdHoc.dmg

allroundexperts · 2023-09-12T20:19:18Z

Updated @Julesssss!

Julesssss · 2023-09-13T07:47:10Z

Started a new build

OSBotify · 2023-09-13T08:16:30Z

🧪🧪 Use the links below to test this build in android and iOS. Happy testing! 🧪🧪

android 🤖	iOS 🍎
https://ad-hoc-expensify-cash.s3.amazonaws.com/android/24588/index.html	https://ad-hoc-expensify-cash.s3.amazonaws.com/ios/24588/index.html

desktop 💻	web 🕸️
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/24588/NewExpensifyAdHoc.dmg	https://24588.pr-testing.expensify.com

Julesssss

AdHoc download works this time 👍

Julesssss · 2023-09-13T08:29:53Z

Hey @ArekChr, ready for testing again

ArekChr · 2023-09-14T08:08:09Z

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 / Chrome
- iOS / native
- iOS / 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 approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
- 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(themeColors.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 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

Web

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

ArekChr

LGTM!

OSBotify · 2023-09-14T08:37:14Z

✋ 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 · 2023-09-14T10:52:01Z

🚀 Deployed to staging by https://github.com/Julesssss in version: 1.3.70-0 🚀

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

OSBotify · 2023-09-18T10:10:00Z

🚀 Deployed to production by https://github.com/thienlnam in version: 1.3.70-8 🚀

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

feat: update electron builder to generate separate builds

b6689a9

allroundexperts requested a review from a team as a code owner August 15, 2023 16:09

melvin-bot bot requested review from ArekChr and removed request for a team August 15, 2023 16:09

allroundexperts mentioned this pull request Aug 15, 2023

[$500] Allow Desktop AhDoc and Dev builds to be installed alongside production #24426

Closed

Julesssss reviewed Aug 15, 2023

View reviewed changes

Julesssss assigned allroundexperts Aug 15, 2023

fix: update name of staging artifact

9386956

Julesssss added the Ready To Build label Aug 29, 2023

Expensify deleted a comment from OSBotify Sep 7, 2023

Expensify deleted a comment from OSBotify Sep 11, 2023

Merge branch 'main' into fix-24426

24ae32e

allroundexperts requested a review from Julesssss September 11, 2023 19:05

Julesssss reviewed Sep 12, 2023

View reviewed changes

allroundexperts added 2 commits September 13, 2023 01:17

Merge branch 'main' into fix-24426

664db1a

fix: update desktop link in testbuild.yml file

f629235

Julesssss approved these changes Sep 13, 2023

View reviewed changes

ArekChr approved these changes Sep 14, 2023

View reviewed changes

melvin-bot bot requested a review from Julesssss September 14, 2023 08:08

Julesssss merged commit 207945c into Expensify:main Sep 14, 2023
19 of 20 checks passed

OSBotify mentioned this pull request Sep 14, 2023

Deploy Checklist: New Expensify 2023-09-14 #27425

Closed

Julesssss mentioned this pull request Sep 15, 2023

[NO QA] Revert PR 24588 #27504

Merged

57 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: update electron builder to generate separate builds #24588

feat: update electron builder to generate separate builds #24588

allroundexperts commented Aug 15, 2023

melvin-bot bot commented Aug 15, 2023

Julesssss commented Aug 15, 2023

Julesssss left a comment

allroundexperts commented Aug 15, 2023

Julesssss commented Aug 15, 2023

allroundexperts commented Aug 15, 2023

ArekChr commented Aug 16, 2023

allroundexperts commented Aug 22, 2023

Julesssss commented Aug 29, 2023

ArekChr commented Aug 29, 2023

ArekChr commented Aug 29, 2023

Julesssss commented Sep 7, 2023 •

edited

Loading

Julesssss commented Sep 7, 2023

Julesssss commented Sep 11, 2023

Julesssss commented Sep 11, 2023

allroundexperts commented Sep 11, 2023

Julesssss left a comment

Julesssss left a comment

allroundexperts commented Sep 12, 2023

Julesssss commented Sep 13, 2023

OSBotify commented Sep 13, 2023

Julesssss left a comment

Julesssss commented Sep 13, 2023

ArekChr commented Sep 14, 2023

ArekChr left a comment

OSBotify commented Sep 14, 2023

OSBotify commented Sep 14, 2023

OSBotify commented Sep 18, 2023

feat: update electron builder to generate separate builds #24588

feat: update electron builder to generate separate builds #24588

Conversation

allroundexperts commented Aug 15, 2023

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Aug 15, 2023

Julesssss commented Aug 15, 2023

Julesssss left a comment

Choose a reason for hiding this comment

allroundexperts commented Aug 15, 2023

Julesssss commented Aug 15, 2023

allroundexperts commented Aug 15, 2023

ArekChr commented Aug 16, 2023

allroundexperts commented Aug 22, 2023

Julesssss commented Aug 29, 2023

ArekChr commented Aug 29, 2023

ArekChr commented Aug 29, 2023

Julesssss commented Sep 7, 2023 • edited Loading

Julesssss commented Sep 7, 2023

Julesssss commented Sep 11, 2023

Julesssss commented Sep 11, 2023

allroundexperts commented Sep 11, 2023

Julesssss left a comment

Choose a reason for hiding this comment

Julesssss left a comment

Choose a reason for hiding this comment

allroundexperts commented Sep 12, 2023

Julesssss commented Sep 13, 2023

OSBotify commented Sep 13, 2023

Julesssss left a comment

Choose a reason for hiding this comment

Julesssss commented Sep 13, 2023

ArekChr commented Sep 14, 2023

Reviewer Checklist

Screenshots/Videos

ArekChr left a comment

Choose a reason for hiding this comment

OSBotify commented Sep 14, 2023

OSBotify commented Sep 14, 2023

OSBotify commented Sep 18, 2023

Julesssss commented Sep 7, 2023 •

edited

Loading