fix illustration is sitting too far down #40822

tienifr · 2024-04-23T19:21:40Z

Details

Fixed Issues

$ #38594 (comment)
PROPOSAL:

Tests

Verify that no errors appear in the JS console

Offline tests

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: 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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
- I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
- I verified the JSDocs style guidelines (in STYLE.md) were followed
If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
I 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 any new file was added I verified that:
- The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
If a new CSS style is added I verified that:
- A similar style doesn't already exist
- The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG))
If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
If the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label and/or tagged @Expensify/design so the design team can review the changes.
If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.

Screenshots/Videos

Android: Native

Screen.Recording.2024-04-24.at.02.32.51.mov

Android: mWeb Chrome

Screen.Recording.2024-04-24.at.02.34.31.mov

iOS: Native

Screen.Recording.2024-04-24.at.02.27.18.mov

iOS: mWeb Safari

Screen.Recording.2024-04-24.at.02.28.32.mov

MacOS: Chrome / Safari

Screen.Recording.2024-04-24.at.02.24.06.mov

MacOS: Desktop

Screen.Recording.2024-04-24.at.02.26.43.mov

melvin-bot · 2024-04-23T19:36:32Z

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

shawnborton · 2024-04-23T19:41:26Z

src/pages/settings/Troubleshoot/TroubleshootPage.tsx

@@ -101,7 +108,7 @@ function TroubleshootPage({shouldStoreLogs}: TroubleshootPageProps) {
                        isCentralPane
                        subtitleMuted
                        illustration={LottieAnimations.Desk}
-                        illustrationStyle={[styles.mt4, styles.mbn4]}
+                        illustrationStyle={!isNativePlatform && [styles.mt4, styles.mbn4]}


Hmm why are we making a platform-specific style here? Can't we find a solution that works everywhere?

Agreed, Why this page specifically has this problem whereas other similar pages(about page) are just fine.

tienifr · 2024-04-26T10:02:10Z

@shawnborton I think we need to supply a new LottieAnimations.Desk file because previously, that file was used for the RHN screen, but now is the center panel. I just tried to replace LottieAnimations.Desk by others, such as LottieAnimations.PreferencesDJ and it works well

shawnborton · 2024-04-29T12:03:48Z

Are you sure we need a new file? I feel like we wanted the illustration to sit downwards on all platforms, so why can't we address this with styles but use those same styles everywhere?

tienifr · 2024-05-01T12:39:04Z

Are you sure we need a new file

Yes. I think it a good solution as if I replace LottieAnimations.Desk by others, such as LottieAnimations.PreferencesDJ it works well without making any style change.

so why can't we address this with styles but use those same styles everywhere?

I tried to address the issue by using the style but as you can see, we need to make a platform-specific style.

@alitoshmatov Do you have any feedback?

shawnborton · 2024-05-01T12:41:36Z

Can you elaborate on why the style failed on iOS though? Can we try something different that might work everywhere?

tienifr · 2024-05-03T02:59:53Z

why the style failed on iOS though

I do not know exactly why the style failed on native devices with the current illustration file and still investigating it. @alitoshmatov any thoughts on this?

tienifr · 2024-05-06T07:38:23Z

@alitoshmatov Friendly bump to review comment

alitoshmatov · 2024-05-07T19:25:54Z

Sorry was busy with other issue, I will catch up with this and leave my feedback soon

alitoshmatov · 2024-05-08T21:53:40Z

Looks like we are in deadend. I am really confused on root cause of this and why it is only happening in troubleshooting page. But comparing it directly to other pages is also misleading since each page is utilizing different illustration with different sizes and animations.

@tienifr If we were to replace the file what exactly should be different in it?

shawnborton · 2024-05-09T00:19:11Z

Hmm before replacing the file, I'm mostly interested to understand why the negative margin isn't working on iOS, as it seems to work fine on other platforms?

tienifr · 2024-05-09T17:51:40Z

@shawnborton I am still investigating. But FYI, the library we used to display the illustration handles web and native separately. That is why the bug appears in ios (and android as well):

App/src/components/Lottie/index.tsx

Lines 37 to 38 in 072e537

    
           style={[aspectRatioStyle, props.style]} 
        
           webStyle={{...aspectRatioStyle, ...webStyle}}

tienifr · 2024-05-15T03:11:13Z

@alitoshmatov Reply your comment: In here:

App/src/pages/Travel/getTripIllustrationStyle/index.native.ts

Line 3 in edd1719

    
           // Styling lottie animations for the ManageTrips component requires different margin values depending on the platform.

we need to add the illustration for each platform as well. So I think it makes sense if we apply the current solution.

tienifr · 2024-05-20T07:44:54Z

@alitoshmatov Do you have any feedback about my comment here?

alitoshmatov · 2024-05-21T20:10:39Z

No, I am really confused on what should be our next step. As I understand we are not sure on exact root cause here?

tienifr · 2024-05-23T08:58:58Z

Asked here

tienifr · 2024-05-27T11:49:58Z

@shawnborton I think we can fix the issue using platform-specific style because the issue has already existed in here and we applied the same solution in that. Then we can create a follow-up PR if the exact RCA is discovered. @alitoshmatov @danieldoglas What do you think?

shawnborton · 2024-05-27T12:06:28Z

That works for me, especially if we're already doing something similar.

tienifr · 2024-05-29T21:52:51Z

@alitoshmatov Based on this comment, should we move forward with the current solution?

alitoshmatov · 2024-05-30T17:54:56Z

@tienifr Yes, go head please

tienifr · 2024-05-31T11:07:06Z

@alitoshmatov Can you review this PR again?

alitoshmatov · 2024-06-02T23:28:44Z

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

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

alitoshmatov

LGTM!

src/pages/settings/Troubleshoot/TroubleshootPage.tsx

tienifr · 2024-06-06T10:28:22Z

@danieldoglas Can you review it again?

alitoshmatov

Looks good

OSBotify · 2024-06-06T19:26:27Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

OSBotify · 2024-06-11T23:31:19Z

🚀 Deployed to production by https://github.com/luacmartins in version: 1.4.81-11 🚀

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

fix illustration is sitting too far down

5685c8c

tienifr marked this pull request as ready for review April 23, 2024 19:36

tienifr requested a review from a team as a code owner April 23, 2024 19:36

melvin-bot bot requested review from alitoshmatov and removed request for a team April 23, 2024 19:36

tienifr mentioned this pull request Apr 23, 2024

[HOLD for payment 2024-07-17][$500] Move "Troubleshoot" out of About and into Settings as its own nav item #38594

Closed

shawnborton self-requested a review April 23, 2024 19:40

shawnborton reviewed Apr 23, 2024

View reviewed changes

alitoshmatov approved these changes Jun 2, 2024

View reviewed changes

melvin-bot bot requested a review from danieldoglas June 2, 2024 23:28

shawnborton previously approved these changes Jun 3, 2024

View reviewed changes

danieldoglas requested changes Jun 3, 2024

View reviewed changes

src/pages/settings/Troubleshoot/TroubleshootPage.tsx Outdated Show resolved Hide resolved

fix create getLightbulbIllustrationStyle

4664650

tienifr dismissed shawnborton’s stale review via 4664650 June 4, 2024 22:38

fix merge main

a08557b

danieldoglas requested review from alitoshmatov and shawnborton June 4, 2024 22:54

shawnborton approved these changes Jun 5, 2024

View reviewed changes

alitoshmatov approved these changes Jun 6, 2024

View reviewed changes

melvin-bot bot requested a review from danieldoglas June 6, 2024 18:53

danieldoglas approved these changes Jun 6, 2024

View reviewed changes

danieldoglas merged commit 1f3658c into Expensify:main Jun 6, 2024
19 checks passed

github-actions bot mentioned this pull request Jun 10, 2024

Deploy Checklist: New Expensify 2024-06-10 #43344

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix illustration is sitting too far down #40822

fix illustration is sitting too far down #40822

tienifr commented Apr 23, 2024 •

edited

Loading

melvin-bot bot commented Apr 23, 2024

shawnborton Apr 23, 2024

alitoshmatov Apr 24, 2024

tienifr commented Apr 26, 2024

shawnborton commented Apr 29, 2024

tienifr commented May 1, 2024

shawnborton commented May 1, 2024

tienifr commented May 3, 2024

tienifr commented May 6, 2024

alitoshmatov commented May 7, 2024

alitoshmatov commented May 8, 2024 •

edited

Loading

shawnborton commented May 9, 2024

tienifr commented May 9, 2024 •

edited

Loading

tienifr commented May 15, 2024 •

edited

Loading

tienifr commented May 20, 2024

alitoshmatov commented May 21, 2024

tienifr commented May 23, 2024

tienifr commented May 27, 2024

shawnborton commented May 27, 2024

tienifr commented May 29, 2024

alitoshmatov commented May 30, 2024

tienifr commented May 31, 2024

alitoshmatov commented Jun 2, 2024

alitoshmatov left a comment

tienifr commented Jun 6, 2024

alitoshmatov left a comment

OSBotify commented Jun 6, 2024

OSBotify commented Jun 11, 2024

fix illustration is sitting too far down #40822

fix illustration is sitting too far down #40822

Conversation

tienifr commented Apr 23, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Apr 23, 2024

shawnborton Apr 23, 2024

Choose a reason for hiding this comment

alitoshmatov Apr 24, 2024

Choose a reason for hiding this comment

tienifr commented Apr 26, 2024

shawnborton commented Apr 29, 2024

tienifr commented May 1, 2024

shawnborton commented May 1, 2024

tienifr commented May 3, 2024

tienifr commented May 6, 2024

alitoshmatov commented May 7, 2024

alitoshmatov commented May 8, 2024 • edited Loading

shawnborton commented May 9, 2024

tienifr commented May 9, 2024 • edited Loading

tienifr commented May 15, 2024 • edited Loading

tienifr commented May 20, 2024

alitoshmatov commented May 21, 2024

tienifr commented May 23, 2024

tienifr commented May 27, 2024

shawnborton commented May 27, 2024

tienifr commented May 29, 2024

alitoshmatov commented May 30, 2024

tienifr commented May 31, 2024

alitoshmatov commented Jun 2, 2024

Reviewer Checklist

Screenshots/Videos

alitoshmatov left a comment

Choose a reason for hiding this comment

tienifr commented Jun 6, 2024

alitoshmatov left a comment

Choose a reason for hiding this comment

OSBotify commented Jun 6, 2024

OSBotify commented Jun 11, 2024

tienifr commented Apr 23, 2024 •

edited

Loading

alitoshmatov commented May 8, 2024 •

edited

Loading

tienifr commented May 9, 2024 •

edited

Loading

tienifr commented May 15, 2024 •

edited

Loading