[TS Migration] Migrate CurrentUserPersonalDetailsSkeletonView to TypeScript #30441

JKobrynski · 2023-10-26T13:25:29Z

Details

Fixed Issues

$ #25052
PROPOSAL: N/A

Tests

Log into the app
Navigate to settings page
Check if the skeleton works properly, it renders while personal info is loading (profile picture, name, email on top). It can be hard to notice as this data usually loads very quickly.

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
- 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native

android.webm

iOS: Native

ios.mp4

iOS: mWeb Safari

safari.mp4

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

fabioh8010

LGTM, but let's remove [No QA] from PR's title as it can be tested by QA

blazejkustra · 2023-10-27T11:06:25Z

LGTM, but let's remove [No QA] from PR's title as it can be tested by QA

@JKobrynski Update QA Steps section in the description 😄

…wToTypeScript

melvin-bot · 2023-10-31T13:12:22Z

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

mollfpr · 2023-11-02T09:48: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 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

30441.Android.webm

Android: mWeb Chrome

30441.mWeb.Chrome.webm

iOS: Native

30441.iOS.mp4

iOS: mWeb Safari

30441.mWeb.Safari.mp4

MacOS: Chrome / Safari

30441.Web.mov

MacOS: Desktop

30441.Desktop.mov

mollfpr · 2023-11-02T10:51:48Z

Hi @JKobrynski, could you share how you are showing the skeleton? I have tried to slow my connection, but it doesn't work it only shows a blank page.

I believe it's because of this early return.

App/src/pages/settings/InitialSettingsPage.js

Lines 326 to 331 in 3eb119d

    
           // On the very first sign in or after clearing storage these 
        
           // details will not be present on the first render so we'll just 
        
           // return nothing for now. 
        
           if (_.isEmpty(props.currentUserPersonalDetails)) { 
        
               return null; 
        
           }

It prevent the skeleton from appearing.

App/src/pages/settings/InitialSettingsPage.js

Lines 334 to 339 in 3eb119d

    
           {_.isEmpty(props.currentUserPersonalDetails) || _.isUndefined(props.currentUserPersonalDetails.displayName) ? ( 
        
               <CurrentUserPersonalDetailsSkeletonView 
        
                   backgroundColor={themeColors.appBG} 
        
                   avatarSize={CONST.AVATAR_SIZE.XLARGE} 
        
               /> 
        
           ) : (

JKobrynski · 2023-11-03T08:13:32Z

@mollfpr to make 100% sure it would still look correctly, I modified the code, so it's shown no matter what.

mollfpr · 2023-11-06T16:27:39Z

src/components/CurrentUserPersonalDetailsSkeletonView/index.tsx

 import React from 'react';
+import SkeletonViewContentLoader from 'react-content-loader/native';


This component loader only works on the native platform.

Suggested change

import SkeletonViewContentLoader from 'react-content-loader/native';

import SkeletonViewContentLoader from '@components/SkeletonViewContentLoader';

mollfpr

LGTM 👍

I think we should make it clear for the QA to modify the code to test the component. I don't see any clear test case to test it out because of a condition that prevents the component from showing.

For example:

diff --git a/scripts/start-android.sh b/scripts/start-android.sh
old mode 100644
new mode 100755
diff --git a/src/pages/settings/InitialSettingsPage.js b/src/pages/settings/InitialSettingsPage.js
index bc395b47bf..8b3e13c80a 100755
--- a/src/pages/settings/InitialSettingsPage.js
+++ b/src/pages/settings/InitialSettingsPage.js
@@ -331,7 +331,7 @@ function InitialSettingsPage(props) {
     }
     const headerContent = (
         <View style={[styles.avatarSectionWrapper, styles.justifyContentCenter]}>
-            {_.isEmpty(props.currentUserPersonalDetails) || _.isUndefined(props.currentUserPersonalDetails.displayName) ? (
+            {!_.isEmpty(props.currentUserPersonalDetails) || _.isUndefined(props.currentUserPersonalDetails.displayName) ? (
                 <CurrentUserPersonalDetailsSkeletonView
                     backgroundColor={themeColors.appBG}
                     avatarSize={CONST.AVATAR_SIZE.XLARGE}

melvin-bot · 2023-11-08T16:48:07Z

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

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

OSBotify · 2023-11-10T01:21:51Z

✋ 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-10T15:59:03Z

🚀 Deployed to staging by https://github.com/marcaaron in version: 1.3.98-0 🚀

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

OSBotify · 2023-11-14T21:52:30Z

🚀 Deployed to production by https://github.com/roryabraham in version: 1.3.98-5 🚀

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

OSBotify · 2023-11-14T22:12:22Z

🚀 Deployed to staging by https://github.com/marcaaron in version: 1.3.99-0 🚀

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

OSBotify · 2023-11-15T20:55:37Z

🚀 Deployed to production by https://github.com/roryabraham in version: 1.3.99-0 🚀

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

migrate CurrentUserPersonalDetailsSkeletonView to TypeScript

a4da500

fabioh8010 approved these changes Oct 26, 2023

View reviewed changes

JKobrynski changed the title ~~[No QA] [TS Migration] Migrate CurrentUserPersonalDetailsSkeletonView to TypeScript~~ [TS Migration] Migrate CurrentUserPersonalDetailsSkeletonView to TypeScript Oct 26, 2023

blazejkustra approved these changes Oct 27, 2023

View reviewed changes

JKobrynski added 3 commits October 31, 2023 09:33

Merge branch 'main' into migrateCurrentUserPersonalDetailsSkeletonVie…

9f2b702

…wToTypeScript

Merge branch 'main' into migrateCurrentUserPersonalDetailsSkeletonVie…

51eadea

…wToTypeScript

Merge branch 'main' into migrateCurrentUserPersonalDetailsSkeletonVie…

30293c7

…wToTypeScript

JKobrynski marked this pull request as ready for review October 31, 2023 13:11

JKobrynski requested a review from a team as a code owner October 31, 2023 13:11

JKobrynski mentioned this pull request Oct 31, 2023

[$250] [TS migration] Migrate 'CurrentUserPersonalDetailsSkeletonView' component to TypeScript #25052

Closed

melvin-bot bot requested review from marcaaron and removed request for a team October 31, 2023 13:12

fix linting

2dcb8bb

marcaaron requested a review from mollfpr October 31, 2023 20:59

mollfpr reviewed Nov 6, 2023

View reviewed changes

fix web import

3bd3962

JKobrynski requested a review from mollfpr November 7, 2023 08:23

mollfpr approved these changes Nov 8, 2023

View reviewed changes

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

Payment issue for E/App PR#30441 #31070

Closed

marcaaron approved these changes Nov 10, 2023

View reviewed changes

marcaaron merged commit 1928c95 into Expensify:main Nov 10, 2023

OSBotify mentioned this pull request Nov 10, 2023

Deploy Checklist: New Expensify 2023-11-10 #31187

Closed

OSBotify mentioned this pull request Nov 14, 2023

Deploy Checklist: New Expensify 2023-11-14 #31324

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[TS Migration] Migrate CurrentUserPersonalDetailsSkeletonView to TypeScript #30441

[TS Migration] Migrate CurrentUserPersonalDetailsSkeletonView to TypeScript #30441

JKobrynski commented Oct 26, 2023 •

edited

Loading

fabioh8010 left a comment

blazejkustra commented Oct 27, 2023

melvin-bot bot commented Oct 31, 2023 •

edited by marcaaron

Loading

mollfpr commented Nov 2, 2023 •

edited

Loading

mollfpr commented Nov 2, 2023

JKobrynski commented Nov 3, 2023

mollfpr Nov 6, 2023 •

edited

Loading

JKobrynski Nov 7, 2023

mollfpr left a comment

melvin-bot bot commented Nov 8, 2023

OSBotify commented Nov 10, 2023

OSBotify commented Nov 10, 2023

OSBotify commented Nov 14, 2023

OSBotify commented Nov 14, 2023

OSBotify commented Nov 15, 2023

		import React from 'react';
		import SkeletonViewContentLoader from 'react-content-loader/native';

	import SkeletonViewContentLoader from 'react-content-loader/native';
	import SkeletonViewContentLoader from '@components/SkeletonViewContentLoader';

[TS Migration] Migrate CurrentUserPersonalDetailsSkeletonView to TypeScript #30441

[TS Migration] Migrate CurrentUserPersonalDetailsSkeletonView to TypeScript #30441

Conversation

JKobrynski commented Oct 26, 2023 • edited 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 commented Oct 27, 2023

melvin-bot bot commented Oct 31, 2023 • edited by marcaaron Loading

mollfpr commented Nov 2, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

mollfpr commented Nov 2, 2023

JKobrynski commented Nov 3, 2023

mollfpr Nov 6, 2023 • edited Loading

Choose a reason for hiding this comment

JKobrynski Nov 7, 2023

Choose a reason for hiding this comment

mollfpr left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Nov 8, 2023

OSBotify commented Nov 10, 2023

OSBotify commented Nov 10, 2023

OSBotify commented Nov 14, 2023

OSBotify commented Nov 14, 2023

OSBotify commented Nov 15, 2023

JKobrynski commented Oct 26, 2023 •

edited

Loading

melvin-bot bot commented Oct 31, 2023 •

edited by marcaaron

Loading

mollfpr commented Nov 2, 2023 •

edited

Loading

mollfpr Nov 6, 2023 •

edited

Loading