[TS migration] Migrate 'Desktop' files to TypeScript #37615

VickyStash · 2024-03-01T16:27:48Z

Details

[TS migration] Migrate 'Desktop' files to TypeScript

Fixed Issues

$ #25333
PROPOSAL: N/A

Tests

Verify that no errors appear in the JS console

Delete old desktop/dist folder
Launch desktop app
Login and check some basic user operations (send a message, create a money request, create a task)
Check that top menu looks as expected and test several flows from there. (for example History -> Back/Forward)
Open any chat and right click on composer (input). Make sure the shown menu looks okay.

Since concurrently lib got updated in this PR, please also check that next scripts work as expected:

npm run ipdad
npm run ipad-sm
npm run web

Offline tests

N/A

QA Steps

Verify that no errors appear in the JS console

Launch desktop app
Login and check some basic user operations (send a message, create a money request, create a task)
Check that top menu looks as expected and test several flows from there. (for example History -> Back/Forward)
Open any chat and right click on composer (input). Make sure the shown menu looks okay.

PR Author Checklist

Screenshots/Videos

MacOS: Desktop

desktop1.mp4

desktop/start.ts

VickyStash · 2024-03-04T13:44:23Z

desktop/main.ts

    return contextMenu({
        labels: {
            cut: Localize.translate(preferredLocale, 'desktopApplicationMenu.cut'),
            paste: Localize.translate(preferredLocale, 'desktopApplicationMenu.paste'),
            copy: Localize.translate(preferredLocale, 'desktopApplicationMenu.copy'),
        },
        append: (defaultActions, parameters, browserWindow) => [
-            new MenuItem({


I've made this update cause append function expects to return an array of MenuItemConstructorOptions. It seems to work as expected.

VickyStash · 2024-03-04T13:45:10Z

desktop/main.ts

-                        details.requestHeaders.origin = CONFIG.EXPENSIFY.URL_EXPENSIFY_CASH;
-                        details.requestHeaders.referer = CONFIG.EXPENSIFY.URL_EXPENSIFY_CASH;


URL_EXPENSIFY_CASH was removed from config a lot of time ago.

VickyStash · 2024-03-04T13:47:19Z

desktop/main.ts

@@ -404,14 +413,13 @@ const mainWindow = () => {
                        submenu: [
                            {
                                id: 'back',
-                                role: 'back',


back role doesn't exist, and overall since the menu item has click function it wasn't necessary. See more in docs

VickyStash · 2024-03-04T13:47:32Z

desktop/main.ts

@@ -420,14 +428,13 @@ const mainWindow = () => {
                            },
                            {
                                id: 'forward',
-                                role: 'forward',


forward role doesn't exist, and overall since the menu item has click function it wasn't necessary. See more in docs

VickyStash · 2024-03-04T13:49:06Z

desktop/main.ts

                                accelerator: process.platform === 'darwin' ? 'Cmd+[' : 'Shift+[',
                                click: () => {
                                    browserWindow.webContents.goBack();
                                },
                            },
                            {
-                                role: 'back',
+                                label: 'backWithKeyShortcut',


Without role/label this item made the app crash, since 'back' role doesn't exist I've added a label, it's not shown since this item is not visible.

VickyStash · 2024-03-04T13:49:24Z

desktop/main.ts

                                accelerator: process.platform === 'darwin' ? 'Cmd+]' : 'Shift+]',
                                click: () => {
                                    browserWindow.webContents.goForward();
                                },
                            },
                            {
-                                role: 'forward',
+                                label: 'forwardWithKeyShortcut',


Without role/label this item made the app crash, since 'back' role doesn't exist I've added a label, it's not shown since this item is not visible.

desktop/start.ts

desktop/contextBridge.ts

VickyStash · 2024-03-05T11:28:44Z

I haven't updated contextBridge.js extension here and here, cause in this cases it relates to dist/contextBridge.js file and updates are causing crashes.

fabioh8010

LGTM ❤️ Please test it extensively to make sure desktop apps are running smoothly and the desktop build script too!

blazejkustra

LGTM! Let's test desktop extensively by QA team 😄

melvin-bot · 2024-03-08T09:24:22Z

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

VickyStash · 2024-03-08T09:26:45Z

@mountiny Could you please generate adhoc builds for this branch to make sure desktop app build is okay?

mountiny · 2024-03-08T20:10:30Z

Seems like it failed in the setupNode step https://github.com/Expensify/App/actions/runs/8206513618/job/22445894155

mountiny · 2024-03-08T20:11:23Z

Testing again https://github.com/Expensify/App/actions/runs/8208509429

Does it maybe need to be build off this branch code too?

github-actions · 2024-03-08T20:30:53Z

🧪🧪 Use the links below to test this adhoc build on Android, iOS, Desktop, and Web. Happy testing! 🧪🧪

Android 🤖	iOS 🍎
❌ FAILED ❌	https://ad-hoc-expensify-cash.s3.amazonaws.com/ios/37615/index.html
The QR code can't be generated, because the android build failed
Desktop 💻	Web 🕸️
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/37615/NewExpensify.dmg	https://37615.pr-testing.expensify.com

👀 View the workflow run that generated this build 👀

VickyStash · 2024-03-11T08:17:29Z

Does it maybe need to be build off this branch code too?

@mountiny Could you please clarify what do you mean?
I've also tested building locally (build .dmg file and tested it), just in case you mean it 😅

mountiny · 2024-03-11T13:15:01Z

@VickyStash ah sorry, that was irrelevant after the second build succeeded

Basically what I meant is whether the build workflow uses the config files from the branch it building or from main.

VickyStash · 2024-03-14T07:40:16Z

@getusha kind bump 🙂

getusha · 2024-03-14T10:59:31Z

@VickyStash not sure if this is related #exfy-roadmap is not opening for me, the skeleton just flickers.

Screen.Recording.2024-03-14.at.1.57.28.in.the.afternoon.mov

getusha · 2024-03-14T11:09:30Z

@VickyStash noticed a strange thing, after running npm run desktop the web server is also started?

VickyStash · 2024-03-14T11:25:56Z

@getusha

#exfy-roadmap is not opening for me, the skeleton just flickers

I think it's related to this issue

VickyStash · 2024-03-14T11:29:38Z

@VickyStash noticed a strange thing, after running npm run desktop the web server is also started?

@getusha It works the same way on the main branch for me, could you confirm?

getusha · 2024-03-14T11:34:33Z

Can confirm it is the same on main 👍

getusha · 2024-03-14T13:49:48Z

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-03-14.at.3.01.06.in.the.afternoon.mov

melvin-bot · 2024-03-14T15:06:30Z

We did not find an internal engineer to review this PR, trying to assign a random engineer to #25333 as well as to this PR... Please reach out for help on Slack if no one gets assigned!

mountiny

Looks fine to me, thanks for testing thoroughly, be on a look out if there will be any issues with desktop please

# Conflicts: # package-lock.json

melvin-bot · 2024-03-15T18:57:17Z

@mountiny looks like this was merged without a test passing. Please add a note explaining why this was done and remove the Emergency label if this is not an emergency.

mountiny · 2024-03-15T19:03:06Z

Hmm tests were passing

OSBotify · 2024-03-15T19:04:20Z

✋ 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-03-18T16:30:19Z

🚀 Deployed to staging by https://github.com/mountiny in version: 1.4.54-0 🚀

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

OSBotify · 2024-03-19T23:11:23Z

🚀 Deployed to production by https://github.com/AndrewGable in version: 1.4.54-4 🚀

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

VickyStash added 2 commits March 1, 2024 17:25

[TS migration] Migrate 'Desktop' files

b99c2cf

Merge branch 'main' into ts-migration/desktop-files

be7fc85

VickyStash commented Mar 4, 2024

View reviewed changes

desktop/start.ts Outdated Show resolved Hide resolved

Improve typing

46d1bf5

VickyStash commented Mar 4, 2024

View reviewed changes

desktop/start.ts Outdated Show resolved Hide resolved

VickyStash commented Mar 4, 2024

View reviewed changes

Re-run checks

9f7258c

fabioh8010 reviewed Mar 5, 2024

View reviewed changes

desktop/start.ts Outdated Show resolved Hide resolved

desktop/contextBridge.ts Outdated Show resolved Hide resolved

desktop/contextBridge.ts Outdated Show resolved Hide resolved

VickyStash added 2 commits March 5, 2024 11:56

Update concurrently lib, minor code improvements

ab13698

Update files extension in the README

bb932cb

fabioh8010 approved these changes Mar 5, 2024

View reviewed changes

blazejkustra reviewed Mar 8, 2024

View reviewed changes

VickyStash marked this pull request as ready for review March 8, 2024 09:24

VickyStash requested a review from a team as a code owner March 8, 2024 09:24

melvin-bot bot requested review from getusha and removed request for a team March 8, 2024 09:24

mountiny added the Ready To Build label Mar 8, 2024

mountiny assigned VickyStash Mar 8, 2024

This comment has been minimized.

Sign in to view

getusha approved these changes Mar 14, 2024

View reviewed changes

melvin-bot bot requested a review from mountiny March 14, 2024 15:07

mountiny previously approved these changes Mar 15, 2024

View reviewed changes

VickyStash added 2 commits March 15, 2024 19:28

Merge branch 'main' into ts-migration/desktop-files

7c9afa6

# Conflicts: # package-lock.json

Re-run npm install

ec0efd0

VickyStash dismissed mountiny’s stale review via ec0efd0 March 15, 2024 18:42

mountiny approved these changes Mar 15, 2024

View reviewed changes

mountiny merged commit cdd93d1 into Expensify:main Mar 15, 2024
18 checks passed

melvin-bot bot added the Emergency label Mar 15, 2024

mountiny removed the Emergency label Mar 15, 2024

mallenexpensify mentioned this pull request Mar 18, 2024

[HOLD for payment 2024-03-26] [TS migration] Migrate 'Desktop' files to TypeScript #25333

Closed

This was referenced Mar 18, 2024

[No QA] ElectronUpdater: Fix checkForUpdates importation #38106

Closed

[HOLD for payment 2024-03-20] HIGH: [$1000] MacOS App does not update via 'Check for Updates' when an update is available #36522

Closed

github-actions bot mentioned this pull request Mar 18, 2024

Deploy Checklist: New Expensify 2024-03-18 #38489

Closed

65 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[TS migration] Migrate 'Desktop' files to TypeScript #37615

[TS migration] Migrate 'Desktop' files to TypeScript #37615

VickyStash commented Mar 1, 2024 •

edited

Loading

VickyStash Mar 4, 2024

VickyStash Mar 4, 2024

VickyStash Mar 4, 2024

VickyStash Mar 4, 2024

VickyStash Mar 4, 2024

VickyStash Mar 4, 2024

VickyStash commented Mar 5, 2024

fabioh8010 left a comment

blazejkustra left a comment •

edited

Loading

melvin-bot bot commented Mar 8, 2024

VickyStash commented Mar 8, 2024 •

edited

Loading

This comment has been minimized.

mountiny commented Mar 8, 2024

mountiny commented Mar 8, 2024

github-actions bot commented Mar 8, 2024

VickyStash commented Mar 11, 2024

mountiny commented Mar 11, 2024

VickyStash commented Mar 14, 2024

getusha commented Mar 14, 2024

getusha commented Mar 14, 2024 •

edited

Loading

VickyStash commented Mar 14, 2024

VickyStash commented Mar 14, 2024

getusha commented Mar 14, 2024

getusha commented Mar 14, 2024 •

edited

Loading

melvin-bot bot commented Mar 14, 2024

mountiny left a comment

melvin-bot bot commented Mar 15, 2024

mountiny commented Mar 15, 2024

OSBotify commented Mar 15, 2024

OSBotify commented Mar 18, 2024

OSBotify commented Mar 19, 2024

		details.requestHeaders.origin = CONFIG.EXPENSIFY.URL_EXPENSIFY_CASH;
		details.requestHeaders.referer = CONFIG.EXPENSIFY.URL_EXPENSIFY_CASH;

[TS migration] Migrate 'Desktop' files to TypeScript #37615

[TS migration] Migrate 'Desktop' files to TypeScript #37615

Conversation

VickyStash commented Mar 1, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

VickyStash Mar 4, 2024

Choose a reason for hiding this comment

VickyStash Mar 4, 2024

Choose a reason for hiding this comment

VickyStash Mar 4, 2024

Choose a reason for hiding this comment

VickyStash Mar 4, 2024

Choose a reason for hiding this comment

VickyStash Mar 4, 2024

Choose a reason for hiding this comment

VickyStash Mar 4, 2024

Choose a reason for hiding this comment

VickyStash commented Mar 5, 2024

fabioh8010 left a comment

Choose a reason for hiding this comment

blazejkustra left a comment • edited Loading

Choose a reason for hiding this comment

melvin-bot bot commented Mar 8, 2024

VickyStash commented Mar 8, 2024 • edited Loading

This comment has been minimized.

mountiny commented Mar 8, 2024

mountiny commented Mar 8, 2024

github-actions bot commented Mar 8, 2024

VickyStash commented Mar 11, 2024

mountiny commented Mar 11, 2024

VickyStash commented Mar 14, 2024

getusha commented Mar 14, 2024

getusha commented Mar 14, 2024 • edited Loading

VickyStash commented Mar 14, 2024

VickyStash commented Mar 14, 2024

getusha commented Mar 14, 2024

getusha commented Mar 14, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

melvin-bot bot commented Mar 14, 2024

mountiny left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Mar 15, 2024

mountiny commented Mar 15, 2024

OSBotify commented Mar 15, 2024

OSBotify commented Mar 18, 2024

OSBotify commented Mar 19, 2024

VickyStash commented Mar 1, 2024 •

edited

Loading

blazejkustra left a comment •

edited

Loading

VickyStash commented Mar 8, 2024 •

edited

Loading

getusha commented Mar 14, 2024 •

edited

Loading

getusha commented Mar 14, 2024 •

edited

Loading