Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix: Implement new layout in About page #27241

Merged
merged 22 commits into from
Jan 14, 2024
Merged

Conversation

Pujan92
Copy link
Contributor

@Pujan92 Pujan92 commented Sep 12, 2023

Details

#26779

Fixed Issues

$ #26779
PROPOSAL: #26779 (comment)

Tests

  1. Go to Settings -> About
  2. Verify that it shows the Coin animation and matches the design.
  • Verify that no errors appear in the JS console

Offline tests

  1. Go to Settings -> About
  2. Verify that it shows the Coin animation and matches the design.

QA Steps

  1. Go to Settings -> About
  2. Verify that it shows the Coin animation and matches the design.
  • 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
    • 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

Web
Screen.Recording.2024-01-04.at.09.09.32.mov
Screen.Recording.2024-01-04.at.09.13.15.mov
Mobile Web - Chrome
Mobile Web - Safari
Desktop
iOS
Android

@Pujan92 Pujan92 requested a review from a team as a code owner September 12, 2023 11:57
@melvin-bot melvin-bot bot requested review from s77rt and removed request for a team September 12, 2023 11:57
@melvin-bot
Copy link

melvin-bot bot commented Sep 12, 2023

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

@Pujan92
Copy link
Contributor Author

Pujan92 commented Sep 12, 2023

@roryabraham I think the animation file needs to be corrected bcoz
-> It is not working in iOS safari
-> Not sure whether its intentional -> Its height is more(375) compare to other screen animations(240)

Screen.Recording.2023-09-12.at.17.13.18.mp4

@roryabraham
Copy link
Contributor

Sorry for the delay @Pujan92, let me look into this

@roryabraham
Copy link
Contributor

@Pujan92 try this one please

Loading.json.zip

@roryabraham
Copy link
Contributor

Regarding the safari thing – not sure. Can you try passing renderer="canvas" to the <Lottie /> component? If that works, add a prop to IllustratedHeaderPageLayout because I think we want to use the svg renderer by default.

If that doesn't work, I think we'll need help 😅

@Pujan92
Copy link
Contributor Author

Pujan92 commented Sep 14, 2023

Thanks @roryabraham.
new file shows weird animation and using renderer=canvas works for safari but reducing the height to correct aspect-ratio with width. Also seeing a red line for android chrome.

New File

Screen.Recording.2023-09-14.at.11.05.19.mov

Renderer Canvas

Screenshot 2023-09-14 at 11 07 36

Screenshot_1694670286

@Pujan92
Copy link
Contributor Author

Pujan92 commented Sep 14, 2023

Or let me tag @shawnborton to check the current animation file once. Issue

@shawnborton
Copy link
Contributor

Hmm @roryabraham thoughts on this one? I thought we had this one working just fine?

@roryabraham
Copy link
Contributor

maybe I botched the JSON animation when I resized it?

@roryabraham
Copy link
Contributor

Finally managed to get this animation fixed, here you go:

Loading.json.zip

Copy link
Contributor

@s77rt s77rt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also:

  • The icon is too large (stretched to the entire canvas)
  • The text version is very close to the icon and to the bottom

src/styles/styles.js Outdated Show resolved Hide resolved
src/pages/settings/AboutPage/AboutPage.js Outdated Show resolved Hide resolved
Comment on lines 105 to 107
<View style={[styles.settingsPageBody, styles.mb6, styles.alignItemsCenter, styles.ph5]}>
<Text style={[styles.baseFontStyle]}>{props.translate('initialSettingsPage.aboutPage.description')}</Text>
</View>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is missing the "About Expensify" header

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@roryabraham could you plz provide a figma so I can verify "About Expnensify" header styles.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good spot @s77rt!

@Pujan92 I can't provide a Figma because I don't know where the mockup we need is in our Figma or how I could provide you that access. But I can tell you that the About Expensify text should be using styles.textHeadline. You'll have to make do with the screenshot to get the paddings / margins right.

@Pujan92
Copy link
Contributor Author

Pujan92 commented Sep 20, 2023

Finally managed to get this animation fixed, here you go:

Thanks @roryabraham, it looks fine now but still failing for iOS Safari. 😢
Adding the renderer canvas works but reduces the height of the animation.

Screen.Recording.2023-09-20.at.16.14.06.mov

@roryabraham
Copy link
Contributor

Adding the renderer canvas works but reduces the height of the animation.

Dang. Can we also just pass a smaller height on iOS Safari to shrink it back to the normal size?

@Pujan92
Copy link
Contributor Author

Pujan92 commented Sep 20, 2023

Adding the renderer canvas works but reduces the height of the animation.

Dang. Can we also just pass a smaller height on iOS Safari to shrink it back to the normal size?

I mean it affects the height(188px) on all platforms

Screenshot 2023-09-20 at 19 22 30

@roryabraham
Copy link
Contributor

roryabraham commented Sep 20, 2023

What if we just do something like this? (haven't tested, may need some tweaks for the style and adding a constant for lottie renderer types, but you get the idea):

diff --git a/src/components/IllustratedHeaderPageLayout.js b/src/components/IllustratedHeaderPageLayout.js
index 92a9c8b855..8bd31cc32a 100644
--- a/src/components/IllustratedHeaderPageLayout.js
+++ b/src/components/IllustratedHeaderPageLayout.js
@@ -31,15 +31,19 @@ const propTypes = {
 
     /** Overlay content to display on top of animation */
     overlayContent: PropTypes.func,
+
+    /** What renderer should we use for the Lottie animation? */
+    lottieRenderer: PropTypes.oneOf('svg', 'canvas'),
 };
 
 const defaultProps = {
     backgroundColor: themeColors.appBG,
     footer: null,
     overlayContent: null,
+    lottieRenderer: 'svg',
 };
 
-function IllustratedHeaderPageLayout({backgroundColor, children, illustration, footer, overlayContent, ...propsToPassToHeader}) {
+function IllustratedHeaderPageLayout({backgroundColor, children, illustration, footer, overlayContent, lottieRenderer, ...propsToPassToHeader}) {
     const {isOffline} = useNetwork();
     const {isSmallScreenWidth, windowHeight} = useWindowDimensions();
     const appBGColor = StyleUtils.getBackgroundColorStyle(themeColors.appBG);
@@ -75,9 +79,10 @@ function IllustratedHeaderPageLayout({backgroundColor, children, illustration, f
                             <View style={[styles.alignItemsCenter, styles.justifyContentEnd, StyleUtils.getBackgroundColorStyle(backgroundColor)]}>
                                 <Lottie
                                     source={illustration}
-                                    style={styles.w100}
+                                    style={lottieRenderer === 'svg' ? styles.w100 : styles.w70}
                                     autoPlay
                                     loop
+                                    renderer={lottieRenderer}
                                 />
                                 {overlayContent && overlayContent()}
                             </View>
diff --git a/src/pages/settings/AboutPage/AboutPage.js b/src/pages/settings/AboutPage/AboutPage.js
index 0ef2a67f1a..9930ec9978 100644
--- a/src/pages/settings/AboutPage/AboutPage.js
+++ b/src/pages/settings/AboutPage/AboutPage.js
@@ -24,6 +24,7 @@ import IllustratedHeaderPageLayout from '../../../components/IllustratedHeaderPa
 import themeColors from '../../../styles/themes/default';
 import * as LottieAnimations from '../../../components/LottieAnimations';
 import SCREENS from '../../../SCREENS';
+import * as Browser from '../../../libs/Browser';
 
 const propTypes = {
     ...withLocalizePropTypes,
@@ -99,6 +100,7 @@ function AboutPage(props) {
             illustration={LottieAnimations.Coin}
             backgroundColor={themeColors.PAGE_BACKGROUND_COLORS[SCREENS.SETTINGS.ABOUT]}
             overlayContent={overlayContent}
+            lottieRenderer={Browser.isSafari() ? 'canvas' : 'svg'}
         >
             <View style={[styles.settingsPageBody, styles.ph5]}>
                 <Text style={[styles.textHeadline, styles.mb1]}>{props.translate('footer.aboutExpensify')}</Text>

@Pujan92
Copy link
Contributor Author

Pujan92 commented Sep 20, 2023

<canvas width="750" height="376"

I still think height inconsistency(reason - reducing the width indirectly reduces the height for the correct aspect ratio) remains there compared to other animations for safari.

Screenshot 2023-09-20 at 19 56 58

Maybe you can checkout my branch to just give it a look in your local.

@roryabraham
Copy link
Contributor

Asked for help with to just get this animation working with the SVG renderer: https://expensify.slack.com/archives/C01GTK53T8Q/p1695655123405859

@Pujan92
Copy link
Contributor Author

Pujan92 commented Jan 4, 2024

Is this the latest screenshot? It feels way too big:

Yes @shawnborton , agree that looks big compare to others.

Do you need us to provide a new lottie animation to achieve that?

Yes plz.

@shawnborton
Copy link
Contributor

Sounds good, asking for a new file now, should have it in the next day or so.

@shawnborton
Copy link
Contributor

Updated version of the animation: Expensify-Loading-Coin-010924.zip

@Pujan92
Copy link
Contributor Author

Pujan92 commented Jan 9, 2024

Updated version of the animation: Expensify-Loading-Coin-010924.zip

Thanks @shawnborton..

Web
Screen.Recording.2024-01-10.at.00.20.14.mov
IOS
Simulator.Screen.Recording.-.iPhone.14.Pro.Max.-.2024-01-10.at.00.22.47.mp4
Android
ab3.webm

@shawnborton
Copy link
Contributor

Lovely!

@Pujan92
Copy link
Contributor Author

Pujan92 commented Jan 9, 2024

@s77rt now it is ready for review!

Comment on lines 99 to 103
const overlayContent = () => (
<View style={[styles.pAbsolute, styles.w100, styles.h100, styles.justifyContentEnd, styles.pb5]}>
<Text
selectable
style={[styles.textLabel, styles.textIvoryLight, styles.alignSelfCenter]}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is defining an anonymous component. On every render we define a new component and this may cause performance degradation as react will remove the child and create a completely new one. This is like changing the key prop every render. Let's use useCallback here so we keep the same component.

@s77rt
Copy link
Contributor

s77rt commented Jan 9, 2024

I noticed some delay in the Coin animation compared to others

Screen.Recording.2024-01-09.at.11.37.29.PM.mov

@s77rt
Copy link
Contributor

s77rt commented Jan 9, 2024

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(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 form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label 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.mov
Android: mWeb Chrome
mweb-chrome.mov
iOS: Native
ios.mov
iOS: mWeb Safari
mweb-safari.mov
MacOS: Chrome / Safari
web.mov
MacOS: Desktop
desktop.mov

@Pujan92
Copy link
Contributor Author

Pujan92 commented Jan 10, 2024

I noticed some delay in the Coin animation compared to others

Seems on first load sometimes it happens, I doubt it is bcoz of the file size(570KB) compare to others(30-40KB)

@s77rt
Copy link
Contributor

s77rt commented Jan 10, 2024

Right that could be it. I don't think we should block the PR on this but it does seem like something we should improve

@melvin-bot melvin-bot bot requested a review from roryabraham January 10, 2024 16:11
</Text>
</View>
),
// eslint-disable-next-line react-hooks/exhaustive-deps
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add a comment explaining the reason

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not sure whether we require comment here bcoz isn't useCallback without dependencies descriptive enough to only create a function on the mount?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I meant on why we are disabling the lint rule e.g. you can just write styles do not change

@roryabraham roryabraham merged commit 9533df3 into Expensify:main Jan 14, 2024
15 checks passed
@OSBotify
Copy link
Contributor

✋ 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
Copy link
Contributor

🚀 Deployed to staging by https://github.com/roryabraham in version: 1.4.25-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/mountiny in version: 1.4.25-10 🚀

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants