[TS Migration] Migrate withWindowDimensions and Modal directories to TypeScript #30338

JKobrynski · 2023-10-25T13:08:45Z

Details

Fixed Issues

$ #25139
PROPOSAL: N/A

Tests

Log into the app
Test different Modals and make sure they work/look correctly. Some examples of where you can find Modals:

Attachment modal (when you want to send an attachment in a conversation)
Delete comment modal
Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

Same as Tests section above

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: mWeb Chrome
- iOS: Native
- iOS: mWeb 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

Android: Native

android.webm

Android: mWeb Chrome

chrome.webm

iOS: Native

ios.mp4

iOS: mWeb Safari

safari.mp4

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

src/components/Modal/BaseModal.tsx

src/components/withWindowDimensions/index.tsx

src/components/Modal/BaseModal.tsx

src/components/Modal/index.tsx

src/components/Modal/types.ts

src/components/withWindowDimensions/index.native.tsx

src/components/withWindowDimensions/index.tsx

fabioh8010

LGTM

blazejkustra

One small comment, other than that LGTM!

src/components/withWindowDimensions/index.tsx

src/components/Modal/index.android.tsx

situchan · 2023-11-09T07:59:08Z

Please also check #30338 (comment)

JKobrynski · 2023-11-09T08:32:18Z

@situchan prop brought back, bug fixed

src/components/Modal/index.tsx

src/components/Modal/index.ios.tsx

BartoszGrajdek · 2023-11-13T09:54:19Z

@situchan kind bump 😄

situchan · 2023-11-13T15:20:42Z

@BartoszGrajdek please pull main. author checklist failing

mountiny · 2023-11-13T16:20:43Z

@situchan I would disregard the checklist for now, there as been recent changes to it

situchan

Mostly looks good

situchan · 2023-11-13T17:38:58Z

src/components/Modal/index.tsx


-function Modal(props) {
-    const [previousStatusBarColor, setPreviousStatusBarColor] = useState();
+function Modal({fullscreen, onModalHide, type, onModalShow, children, ...rest}: BaseModalProps) {


Please define default values same as the ones in defaultProps before migration.
i.e. onModalHide() will crash in hideModal function

Good example of regression because of fullscreen not defaulting to true:

Before:

After:

JKobrynski · 2023-11-14T08:29:35Z

@situchan default props brought back 😄

JKobrynski · 2023-11-15T07:07:54Z

@situchan kind bump 😄

situchan · 2023-11-15T07:09:53Z

final test today

mountiny · 2023-11-15T12:02:32Z

@situchan let me know in slack when this is ready, thanks!

situchan · 2023-11-15T12:24:01Z

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 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

Android: Native

android.mov

Android: mWeb Chrome

mchrome.mov

iOS: Native

ios.mov

iOS: mWeb Safari

msafari.mov

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

situchan

melvin-bot · 2023-11-15T12:25:03Z

🎯 @situchan, thanks for reviewing and testing this PR! 🎉

An E/App issue has been created to issue payment here: #31360.

mountiny

One commment for my understanding @JKobrynski

mountiny · 2023-11-15T12:33:41Z

src/components/Modal/index.tsx

+            setStatusBarColor(isFullScreenModal ? themeColors.appBG : StyleUtils.getThemeBackgroundColor(statusBarColor));
+        }
+
+        onModalShow?.();


How does this syntax work for a method? call the method if it is not null?

Ignores when onModalShow is undefined or null and returns undefined. Otherwise same as onModalShow()
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Optional_chaining

Exactly! It's very useful and you can also use it to safely access arrays i.e. lets say you have a variable test and it's type is string[] | null if you use test?.[0] it won't throw an error even if test === null, if you don't use optional chaining however this would throw a TypeError

OSBotify · 2023-11-15T16:02:50Z

✋ 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-11-20T13:40:37Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.4.0-3 🚀

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

JKobrynski added 13 commits October 20, 2023 13:41

migrate withWindowDimensions directory to TypeScript

eebfbf1

create types file for Modal

8213caa

start migrating BaseModal to TypeScript

cf613ad

add missing prop types

408ef25

update types, update helper function types

1c1d092

reorganise types in StyleUtils

118415e

fix typings in BaseModal

4c18fc0

migrate index.web.js to TypeScript

c016d84

migrate index.ios.js to TypeScript

5f3968d

migrate index.android.js to TypeScript

ffa9d70

fix spacing calculation

a437818

Merge branch 'main' into migrateModalToTypeScript

7a637b9

apply finishing touches

7385968

JKobrynski changed the title ~~Migrate modal to type script~~ [No QA] [TS Migration] Migrate withWindowDimensions and Modal directories to TypeScript Oct 26, 2023

kubabutkiewicz reviewed Oct 26, 2023

View reviewed changes

src/components/Modal/BaseModal.tsx Show resolved Hide resolved

barttom reviewed Oct 26, 2023

View reviewed changes

src/components/Modal/BaseModal.tsx Show resolved Hide resolved

src/components/Modal/BaseModal.tsx Outdated Show resolved Hide resolved

src/components/Modal/BaseModal.tsx Outdated Show resolved Hide resolved

src/components/withWindowDimensions/index.tsx Outdated Show resolved Hide resolved

JKobrynski added 3 commits October 26, 2023 10:38

remove unnecessary conditional function calls

c26a716

create common NewDimensions type

a1adc37

change index.web.tsx to index.tsx to fix linting

bc5c041

fabioh8010 reviewed Oct 26, 2023

View reviewed changes

JKobrynski added 2 commits October 26, 2023 14:14

add event to backdrop press handler

673d120

apply changes based on feedback from code review

2d7d45b

JKobrynski requested review from fabioh8010, kubabutkiewicz and barttom October 26, 2023 12:34

extract PopoverAnchorPosition to TypeScript

a75557f

fabioh8010 approved these changes Oct 26, 2023

View reviewed changes

blazejkustra approved these changes Oct 27, 2023

View reviewed changes

src/components/withWindowDimensions/index.tsx Outdated Show resolved Hide resolved

JKobrynski added 2 commits October 30, 2023 16:14

Merge branch 'main' into migrateModalToTypeScript

595c90d

add return types to HOCs, fix linting

da8b083

situchan reviewed Nov 8, 2023

View reviewed changes

src/components/Modal/index.android.tsx Show resolved Hide resolved

mountiny self-requested a review November 8, 2023 18:07

bring back default useNativeDriver prop for android

8082b7c

add optional chaining to onModalShow

a5e8a58

situchan reviewed Nov 9, 2023

View reviewed changes

src/components/Modal/index.tsx Outdated Show resolved Hide resolved

situchan reviewed Nov 9, 2023

View reviewed changes

src/components/Modal/index.ios.tsx Outdated Show resolved Hide resolved

destructure props in Modal

20e80d1

JKobrynski requested a review from situchan November 13, 2023 08:29

mountiny assigned JKobrynski Nov 13, 2023

situchan suggested changes Nov 13, 2023

View reviewed changes

bring back default props

434e472

JKobrynski requested a review from situchan November 14, 2023 08:29

situchan approved these changes Nov 15, 2023

View reviewed changes

melvin-bot bot mentioned this pull request Nov 15, 2023

Payment issue for E/App PR#30338 PAY 11/27 #31360

Closed

mountiny approved these changes Nov 15, 2023

View reviewed changes

mountiny merged commit 181aeb2 into Expensify:main Nov 15, 2023
20 checks passed

OSBotify mentioned this pull request Nov 16, 2023

Deploy Checklist: New Expensify 2023-11-15 #31404

Closed

37 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[TS Migration] Migrate withWindowDimensions and Modal directories to TypeScript #30338

[TS Migration] Migrate withWindowDimensions and Modal directories to TypeScript #30338

JKobrynski commented Oct 25, 2023 •

edited by github-actions bot

Loading

fabioh8010 left a comment

blazejkustra left a comment

situchan commented Nov 9, 2023

JKobrynski commented Nov 9, 2023

BartoszGrajdek commented Nov 13, 2023

situchan commented Nov 13, 2023

mountiny commented Nov 13, 2023

situchan left a comment

situchan Nov 13, 2023 •

edited

Loading

situchan Nov 13, 2023

JKobrynski commented Nov 14, 2023

JKobrynski commented Nov 15, 2023

situchan commented Nov 15, 2023

mountiny commented Nov 15, 2023

situchan commented Nov 15, 2023

situchan left a comment

melvin-bot bot commented Nov 15, 2023

mountiny left a comment

mountiny Nov 15, 2023

situchan Nov 15, 2023

BartoszGrajdek Nov 15, 2023 •

edited

Loading

mountiny Nov 15, 2023

OSBotify commented Nov 15, 2023

OSBotify commented Nov 20, 2023

[TS Migration] Migrate withWindowDimensions and Modal directories to TypeScript #30338

[TS Migration] Migrate withWindowDimensions and Modal directories to TypeScript #30338

Conversation

JKobrynski commented Oct 25, 2023 • edited by github-actions bot Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

fabioh8010 left a comment

Choose a reason for hiding this comment

blazejkustra left a comment

Choose a reason for hiding this comment

situchan commented Nov 9, 2023

JKobrynski commented Nov 9, 2023

BartoszGrajdek commented Nov 13, 2023

situchan commented Nov 13, 2023

mountiny commented Nov 13, 2023

situchan left a comment

Choose a reason for hiding this comment

situchan Nov 13, 2023 • edited Loading

Choose a reason for hiding this comment

situchan Nov 13, 2023

Choose a reason for hiding this comment

JKobrynski commented Nov 14, 2023

JKobrynski commented Nov 15, 2023

situchan commented Nov 15, 2023

mountiny commented Nov 15, 2023

situchan commented Nov 15, 2023

Reviewer Checklist

Screenshots/Videos

situchan left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Nov 15, 2023

mountiny left a comment

Choose a reason for hiding this comment

mountiny Nov 15, 2023

Choose a reason for hiding this comment

situchan Nov 15, 2023

Choose a reason for hiding this comment

BartoszGrajdek Nov 15, 2023 • edited Loading

Choose a reason for hiding this comment

mountiny Nov 15, 2023

Choose a reason for hiding this comment

OSBotify commented Nov 15, 2023

OSBotify commented Nov 20, 2023

JKobrynski commented Oct 25, 2023 •

edited by github-actions bot

Loading

situchan Nov 13, 2023 •

edited

Loading

BartoszGrajdek Nov 15, 2023 •

edited

Loading