[No QA][TS migration] Migrate 'models' lib to TypeScript #27667

fvlvte · 2023-09-18T12:19:13Z

Details

Migrated src/libs/modules to TypeScript.

Fixed Issues

$ #24871
PROPOSAL: N/A

Tests

Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

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 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
  - 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 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 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
- If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
  - 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

web-ff.mov

Mobile Web - Chrome

web-chrome.mov

Mobile Web - Safari

web-safari.mov

Desktop

electron.mov

iOS

ios17.mov

Android

android.mov

melvin-bot · 2023-09-18T12:21:53Z

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

src/libs/models/BankAccount.ts

rezkiy37

I see that json and accountJSON has good detailed types. I am not sure that all those 1-line methods should have return types.

src/libs/models/BankAccount.ts

BartoszGrajdek · 2023-09-21T13:07:42Z

@fvlvte this issue is not ready for cross-review (removing it from spreadsheet for now). Please attach some videos / screenshots from your side. Thank you! 🙇🏼‍♂️

fvlvte · 2023-09-25T09:27:59Z

Sorry - updated @BartoszGrajdek

BartoszGrajdek · 2023-09-25T09:44:19Z

Reviewing...

blazejkustra

LGTM, SWM still need to do the checklist.

BartoszGrajdek · 2023-09-25T21:02:18Z

LGTM!

BartoszGrajdek · 2023-09-25T21:04:17Z

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

web.mov

Mobile Web - Chrome

chrome.mov

Mobile Web - Safari

safari.mov

Desktop

desktop.mov

iOS

ios.mov

Android

android.mp4

# Conflicts: # src/types/onyx/BankAccount.ts

# Conflicts: # src/libs/models/BankAccount.js # src/types/onyx/BankAccount.ts

fvlvte · 2023-10-20T20:53:45Z

@BartoszGrajdek can I ask for re-review? i've resolved conflicts on main branch and staled review

fabioh8010 · 2023-11-19T23:32:17Z

@fvlvte Could you update this PR so I can ask Expensify to review and merge it?

fvlvte · 2023-11-19T23:33:28Z

Sure, can do it now @fabioh8010

# Conflicts: # src/libs/models/BankAccount.ts

fabioh8010 · 2023-11-20T12:16:50Z

@thesahindia Could you review it again so we can get this merged quicker? Thanks!

situchan

Just approving to pull up engineer for final review

thesahindia · 2023-11-24T16:13:14Z

Just approving to pull up engineer for final review

Not sure why it didn't trigger the assignment when I approved the PR.

neil-marcellini

Looks good. Some NAB comments.

neil-marcellini · 2023-11-27T19:30:01Z

src/libs/models/BankAccount.ts

 import CONST from '@src/CONST';
+import BankAccountJSON, {AdditionalData} from '@src/types/onyx/BankAccount';


NAB: I would rather not call this BankAccountJSON because that makes me think it's a string that needs to be parsed. Would you please instead match the name here with the type declaration BankAccount?

Oh I do see that it's already called json in this class even though it's an object. I still like the name change.

neil-marcellini · 2023-11-27T19:38:21Z

src/libs/models/BankAccount.ts

+    bankAccountID: number;
+    state: State;
+    validateCodeExpectedDate: string;
+    needsToUpgrade: boolean;


NAB: Can we make this optionally have additionalData?

neil-marcellini · 2023-11-27T19:39:02Z

src/libs/models/BankAccount.ts

-            },
-            this.getAdditionalData(),
-        );
+    toACHData(): Partial<ACHData> {


NAB: I don't really understand why we need Partial here? Aren't we filling in all required fields?

neil-marcellini · 2023-11-29T17:40:31Z

@fvlvte I'm going to go ahead and merge this since it's been open for a while. Please create a follow up PR if you want to address the NAB comments.

OSBotify · 2023-11-29T17:44:22Z

✋ 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-12-01T12:43:50Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.4.6-2 🚀

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

fvlvte added 2 commits September 18, 2023 14:09

Migrated src/libs/modules

104d34d

Fixed regression issue

12c860c

fvlvte marked this pull request as ready for review September 18, 2023 12:21

fvlvte requested a review from a team as a code owner September 18, 2023 12:21

melvin-bot bot requested review from thesahindia and removed request for a team September 18, 2023 12:21

fvlvte marked this pull request as draft September 18, 2023 12:26

fabioh8010 reviewed Sep 18, 2023

View reviewed changes

Implemented requested changes.

a52ade1

rezkiy37 reviewed Sep 18, 2023

View reviewed changes

src/libs/models/BankAccount.ts Outdated Show resolved Hide resolved

rezkiy37 reviewed Sep 18, 2023

View reviewed changes

thiagobrez reviewed Sep 19, 2023

View reviewed changes

src/libs/models/BankAccount.ts Outdated Show resolved Hide resolved

Resolved all requested changes.

b0f2d57

fvlvte requested review from fabioh8010, rezkiy37 and thiagobrez September 20, 2023 08:29

fvlvte marked this pull request as ready for review September 20, 2023 08:29

fvlvte changed the title ~~[TS migration] Migrate 'models' lib to TypeScript~~ [No QA][TS migration] Migrate 'models' lib to TypeScript Sep 20, 2023

thesahindia approved these changes Sep 20, 2023

View reviewed changes

BartoszGrajdek mentioned this pull request Sep 21, 2023

[No QA][TS migration] Migrate 'Timing.js' lib to TypeScript #27705

Merged

59 tasks

blazejkustra approved these changes Sep 25, 2023

View reviewed changes

BartoszGrajdek approved these changes Sep 25, 2023

View reviewed changes

fvlvte added 2 commits October 5, 2023 09:43

Merge branch 'main' into 24871-migrate-models-to-ts

5b93413

# Conflicts: # src/types/onyx/BankAccount.ts

Fixed conflicts and linter issues.

0589037

fvlvte requested a review from thesahindia October 6, 2023 12:05

thesahindia approved these changes Oct 12, 2023

View reviewed changes

kubabutkiewicz approved these changes Oct 16, 2023

View reviewed changes

fvlvte added 2 commits October 20, 2023 22:10

Merge branch 'main' into 24871-migrate-models-to-ts

75f8cf9

# Conflicts: # src/libs/models/BankAccount.js # src/types/onyx/BankAccount.ts

Solved conflicts.

b99bb38

fvlvte force-pushed the 24871-migrate-models-to-ts branch from 5a410c0 to b99bb38 Compare October 20, 2023 20:52

fvlvte added 2 commits November 20, 2023 13:06

Merge branch 'main' into 24871-migrate-models-to-ts

8986ffe

# Conflicts: # src/libs/models/BankAccount.ts

Linter issues fixed.

91b3bb0

thesahindia approved these changes Nov 22, 2023

View reviewed changes

fabioh8010 approved these changes Nov 24, 2023

View reviewed changes

situchan approved these changes Nov 24, 2023

View reviewed changes

melvin-bot bot requested a review from neil-marcellini November 24, 2023 10:38

neil-marcellini approved these changes Nov 27, 2023

View reviewed changes

neil-marcellini merged commit d2a9f81 into Expensify:main Nov 29, 2023
17 checks passed

github-actions bot mentioned this pull request Nov 30, 2023

Deploy Checklist: New Expensify 2023-11-30 #32266

Closed

42 tasks

melvin-bot bot mentioned this pull request Dec 1, 2023

[HOLD for payment 2023-12-08] [TS migration] Migrate 'models' lib to TypeScript #24871

Closed

fvlvte deleted the 24871-migrate-models-to-ts branch December 30, 2023 00:49

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[No QA][TS migration] Migrate 'models' lib to TypeScript #27667

[No QA][TS migration] Migrate 'models' lib to TypeScript #27667

fvlvte commented Sep 18, 2023 •

edited by github-actions bot

Loading

melvin-bot bot commented Sep 18, 2023

rezkiy37 left a comment

BartoszGrajdek commented Sep 21, 2023

fvlvte commented Sep 25, 2023

BartoszGrajdek commented Sep 25, 2023

blazejkustra left a comment

BartoszGrajdek commented Sep 25, 2023

BartoszGrajdek commented Sep 25, 2023

fvlvte commented Oct 20, 2023

fabioh8010 commented Nov 19, 2023

fvlvte commented Nov 19, 2023

fabioh8010 commented Nov 20, 2023

situchan left a comment

thesahindia commented Nov 24, 2023

neil-marcellini left a comment

neil-marcellini Nov 27, 2023

neil-marcellini Nov 27, 2023

neil-marcellini Nov 27, 2023

neil-marcellini Nov 27, 2023

neil-marcellini commented Nov 29, 2023

OSBotify commented Nov 29, 2023

OSBotify commented Dec 1, 2023

		import CONST from '@src/CONST';
		import BankAccountJSON, {AdditionalData} from '@src/types/onyx/BankAccount';

[No QA][TS migration] Migrate 'models' lib to TypeScript #27667

[No QA][TS migration] Migrate 'models' lib to TypeScript #27667

Conversation

fvlvte commented Sep 18, 2023 • edited by github-actions bot Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Sep 18, 2023

rezkiy37 left a comment

Choose a reason for hiding this comment

BartoszGrajdek commented Sep 21, 2023

fvlvte commented Sep 25, 2023

BartoszGrajdek commented Sep 25, 2023

blazejkustra left a comment

Choose a reason for hiding this comment

BartoszGrajdek commented Sep 25, 2023

BartoszGrajdek commented Sep 25, 2023

Reviewer Checklist

Screenshots/Videos

fvlvte commented Oct 20, 2023

fabioh8010 commented Nov 19, 2023

fvlvte commented Nov 19, 2023

fabioh8010 commented Nov 20, 2023

situchan left a comment

Choose a reason for hiding this comment

thesahindia commented Nov 24, 2023

neil-marcellini left a comment

Choose a reason for hiding this comment

neil-marcellini Nov 27, 2023

Choose a reason for hiding this comment

neil-marcellini Nov 27, 2023

Choose a reason for hiding this comment

neil-marcellini Nov 27, 2023

Choose a reason for hiding this comment

neil-marcellini Nov 27, 2023

Choose a reason for hiding this comment

neil-marcellini commented Nov 29, 2023

OSBotify commented Nov 29, 2023

OSBotify commented Dec 1, 2023

fvlvte commented Sep 18, 2023 •

edited by github-actions bot

Loading