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

Pare back the parallax animation on empty chats #35232

Merged
merged 9 commits into from
Feb 5, 2024

Conversation

staszekscp
Copy link
Contributor

@staszekscp staszekscp commented Jan 26, 2024

@roryabraham

Details

The PR limits limits the empty chat background gyroscope animation. It also adds a simple logic to disable the animation entirely if a user has the Reduced Motion set in system settings.

The PR will be tested subjectively, and may be further adjusted, therefore I won't add any videos for now. It is supposed to be tested on an Ad-Hoc build.

Fixed Issues

$ #35172
PROPOSAL: #35172

Tests

  • Verify that no errors appear in the JS console
  • Enter an empty chat, see if the animation in the background works
  • Change Remove Animations/Reduce Motion setting on your phone
  • Restart the app - the animation should be now disabled

Offline tests

QA Steps

  • Verify that no errors appear in the JS console
  • Enter an empty chat, see if the animation in the background works
  • Change Remove Animations/Reduce Motion setting on your phone
  • Restart the app - the animation should be now disabled
  • [ ]

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

Screenshots/Videos

Android: Native
rn_image_picker_lib_temp_b1714663-8e14-4385-a20a-5a2afb4c5b41-2024-01-31.10_09_48.201.mp4
Android: mWeb Chrome
rn_image_picker_lib_temp_d58bc9b0-03ef-4a2e-97ea-74c591a847ec-2024-01-31.10_09_27.946.mp4
iOS: Native
RPReplay_Final1706694977-2024-01-31.10_09_13.474.mp4
iOS: mWeb Safari image
MacOS: Chrome / Safari image
MacOS: Desktop image

@staszekscp staszekscp marked this pull request as ready for review January 26, 2024 11:33
@staszekscp staszekscp requested a review from a team as a code owner January 26, 2024 11:33
@melvin-bot melvin-bot bot requested review from ntdiary and removed request for a team January 26, 2024 11:33
Copy link

melvin-bot bot commented Jan 26, 2024

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

@@ -18,6 +18,15 @@ const useScreenReaderStatus = (): boolean => {
return isScreenReaderEnabled;
};

const useReduceMotionStatus = (): boolean => {
const [isScreenReaderEnabled, setIsScreenReaderEnabled] = useState(false);
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
const [isScreenReaderEnabled, setIsScreenReaderEnabled] = useState(false);
const [isReduceMotionEnabled, setIsReduceMotionEnabled] = useState(false);

Comment on lines 21 to 28
const useReduceMotionStatus = (): boolean => {
const [isScreenReaderEnabled, setIsScreenReaderEnabled] = useState(false);
useEffect(() => {
AccessibilityInfo.isReduceMotionEnabled().then((enabled) => setIsScreenReaderEnabled(enabled));
}, []);

return isScreenReaderEnabled;
};
Copy link
Contributor

Choose a reason for hiding this comment

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

Let's use useReducedMotion from Reanimated instead (see docs here).

Pros:

  • It is synchronous (no need for additional render when promise is resolved and false changes to true)

Cons:

  • it's not reactive (yet), meaning the setting state is read only once and you need to reset the app after you change the setting; however we plan to address it in the future

Copy link
Contributor

@tomekzaw tomekzaw left a comment

Choose a reason for hiding this comment

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

Thanks for applying code review suggestions. Looks good to me!

roryabraham
roryabraham previously approved these changes Jan 27, 2024
Copy link
Contributor

@roryabraham roryabraham left a comment

Choose a reason for hiding this comment

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

LGTM, but let's get some feedback from @Expensify/design

This comment has been minimized.

src/CONST.ts Outdated
@@ -46,6 +46,8 @@ const CONST = {
IN: 'in',
OUT: 'out',
},
// Multiplier for gyroscope animation in order to make it a bit more subtle
ANIMATION_GYROSCOPE_VALUE: 0.65,
Copy link
Contributor

Choose a reason for hiding this comment

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

What was the previous value? Just 1?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, it's a multiplier value I have just added, therefore previously it was 1 😄

@shawnborton
Copy link
Contributor

Just tested and I think we can back it down even further. Could we try something like .4 and see what happens?

Another piece of feedback while we're here - I feel like the empty state image is way too far down, to the point where a lot of the content overlaps it. Our intention was indeed to have some content overlap it slightly, but the parallax feature seems to place it way further than than expected. Are we able to scoot it up the page just a bit so that you see more of the empty state that isn't behind text?

Here is what I see on my phone:
CleanShot 2024-01-27 at 06 38 03@2x

Whereas this is how much empty state floats above the content on desktop:
CleanShot 2024-01-27 at 06 38 27@2x

cc @Expensify/design for visibility on this one too

@staszekscp
Copy link
Contributor Author

Hey @shawnborton, thanks for the feedback! The low position of the image for task reports was apparently a small bug, I have just fixed it. In other cases it should work just fine 😄 As per the gyroscope value, I have just lowered it to 0.4, so we can run another build.

@shawnborton
Copy link
Contributor

Cool, will trigger a new build now

Copy link
Contributor

@shawnborton
Copy link
Contributor

Nice, this feels great to me! I'm good with merging this. cc @Expensify/design in case you have feedback too

@ntdiary
Copy link
Contributor

ntdiary commented Jan 29, 2024

Hi, if needed, can we request another c+? I'm still busy with other issues. 😂

@situchan
Copy link
Contributor

I am interested in reviewing this

@roryabraham roryabraham requested review from situchan and removed request for ntdiary January 29, 2024 19:24
Copy link
Contributor

@roryabraham roryabraham left a comment

Choose a reason for hiding this comment

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

LGTM, thanks @staszekscp!

Can you look into the failing jest test? Is it possible it was introduce here or is it unrelated / flaky?

@situchan
Copy link
Contributor

@staszekscp please pull main. If unit tests still failing after that, caused by this PR for sure, as not happening on main.

@dubielzyk-expensify
Copy link
Contributor

Tried it out on Android and it looks good to me as well!

@situchan
Copy link
Contributor

Could you add screenshots/videos per each platform?

);
}
return (
<>
<View style={[StyleUtils.getReportWelcomeContainerStyle(props.isSmallScreenWidth, true)]}>
Copy link
Contributor

Choose a reason for hiding this comment

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

The meaning of 2nd param is isMoneyReport. Why is set to true here? (this is task report)

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 wanted to reuse the function in order to increase the topMargin. The task report requires it in order to move the background screen a bit higher. I can rename it to be eg. MONEY_OR_TASK_REPORT, if you wish

Copy link
Contributor

Choose a reason for hiding this comment

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

ok let's rename then

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done :)

@staszekscp
Copy link
Contributor Author

I have added screenshots/videos to the template (screenshots for platforms that don't have animation on production)

roryabraham
roryabraham previously approved these changes Feb 1, 2024
@situchan
Copy link
Contributor

situchan commented Feb 1, 2024

performance test failing. please merge main

@situchan
Copy link
Contributor

situchan commented Feb 1, 2024

Code looks good. Testing
@roryabraham can you please generate adhoc build (after merging main)?

Copy link
Contributor

github-actions bot commented Feb 1, 2024

🧪🧪 Use the links below to test this adhoc build on Android, iOS, Desktop, and Web. Happy testing! 🧪🧪

Android 🤖 iOS 🍎
❌ FAILED ❌ ❌ FAILED ❌
The QR code can't be generated, because the android build failed The QR code can't be generated, because the iOS build failed
Desktop 💻 Web 🕸️
❌ FAILED ❌ ❌ FAILED ❌
The QR code can't be generated, because the Desktop build failed The QR code can't be generated, because the web build failed

👀 View the workflow run that generated this build 👀

@roryabraham
Copy link
Contributor

roryabraham commented Feb 1, 2024

well, that's weird

edit: it's not directly related. setupNode is currently seeing widespread failure across many of our GitHub Actions.

@roryabraham
Copy link
Contributor

Running a fresh build, let's see if it works this time: https://github.com/Expensify/App/actions/runs/7763478577

Copy link
Contributor

github-actions bot commented Feb 3, 2024

@staszekscp
Copy link
Contributor Author

Hello! I've just merged main, so I hope we're good to go 🤞

@roryabraham
Copy link
Contributor

roryabraham commented Feb 5, 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.mp4
Android: mWeb Chrome
android.mp4
iOS: Native
trim.D885E55C-6BB1-4DCA-8351-1E9F66183AC4.MOV
iOS: mWeb Safari

n/a

MacOS: Chrome / Safari

n/a

MacOS: Desktop

n/a

@roryabraham roryabraham merged commit 54c438d into Expensify:main Feb 5, 2024
16 checks passed
@OSBotify
Copy link
Contributor

OSBotify commented Feb 5, 2024

✋ 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

OSBotify commented Feb 5, 2024

🚀 Cherry-picked to staging by https://github.com/thienlnam in version: 1.4.36-5 🚀

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

@Expensify/applauseleads please QA this PR and check it off on the deploy checklist if it passes.

1 similar comment
@OSBotify
Copy link
Contributor

OSBotify commented Feb 5, 2024

🚀 Cherry-picked to staging by https://github.com/thienlnam in version: 1.4.36-5 🚀

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

@Expensify/applauseleads please QA this PR and check it off on the deploy checklist if it passes.

@situchan
Copy link
Contributor

situchan commented Feb 6, 2024

@roryabraham sorry, this was not ready yet to merge. (I haven't approved yet)
There's issue in task view

@@ -627,7 +627,7 @@ function ReportActionItem(props) {
if (ReportUtils.isTaskReport(props.report)) {
if (ReportUtils.isCanceledTaskReport(props.report, parentReportAction)) {
return (
<>
<View style={[StyleUtils.getReportWelcomeContainerStyle(props.isSmallScreenWidth, true)]}>
Copy link
Contributor

Choose a reason for hiding this comment

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

There's regression:

Screenshot 2024-02-06 at 10 35 28 AM

@situchan
Copy link
Contributor

situchan commented Feb 7, 2024

ok, so I think above regression can be handled in #33922 since it's minor style issue.
Otherwise looks good!

@OSBotify
Copy link
Contributor

OSBotify commented Feb 7, 2024

🚀 Deployed to production by https://github.com/Julesssss in version: 1.4.37-7 🚀

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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants