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

Add animation for switch children #55478

Conversation

sumo-slonik
Copy link
Contributor

@sumo-slonik sumo-slonik commented Jan 20, 2025

Explanation of Change

These PR add animations of the appearance and disappearance of elements after the switch using reanimated.

Fixed Issues

$ #53759
Fixed also reason to reverse previous revert:
$ #55451

PROPOSAL:

Tests

  1. Go to Settings.
  2. Launch Workflows.
  3. Check if workflows appear correctly with animations (especially on iOS).
  4. Enter Workflows.
  5. Click the switches and check if the content below appears with smooth animation.
  • Verify that no errors appear in the JS console

Offline tests

Offline tests are not needed.

QA Steps

Same as tests

  • 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 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 used JaimeGPT to get English > Spanish translation. I then posted it 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.ts 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.
  • I added unit tests for any new feature or bug fix in this PR to help automatically prevent regressions in this user flow.
  • 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.2025-01-21.at.12.12.57.mp4
Android: mWeb Chrome
Screen.Recording.2025-01-21.at.12.38.23.mp4
iOS: Native
Screen.Recording.2025-01-20.at.16.07.39.mp4
iOS: mWeb Safari
Screen.Recording.2025-01-20.at.16.13.57.mp4
MacOS: Chrome / Safari
Screen.Recording.2025-01-20.at.16.17.23.mp4
MacOS: Desktop
Screen.Recording.2025-01-20.at.16.40.29.mp4

@sumo-slonik sumo-slonik changed the title [Draft] Add animation for switch childreans [Draft] Add animation for switch children Jan 20, 2025
Copy link
Contributor

@blazejkustra blazejkustra left a comment

Choose a reason for hiding this comment

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

LGTM!

@@ -181,6 +359,8 @@ function WorkspaceInitialPage({policyDraft, policy: policyProp, route}: Workspac
newFeatureStates[key] =
prevPendingFields?.[key] !== policy?.pendingFields?.[key] || isOffline || !policy?.pendingFields?.[key] ? isFeatureEnabled : currentFeatureStates[key];
});

setHighlightedFeature(Object.keys(newFeatureStates).at(0) ?? '');
Copy link
Contributor

Choose a reason for hiding this comment

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

NAB: instead of empty string we could use undefined.

@sumo-slonik sumo-slonik marked this pull request as ready for review January 20, 2025 20:22
@sumo-slonik sumo-slonik requested a review from a team as a code owner January 20, 2025 20:22
@melvin-bot melvin-bot bot requested review from dubielzyk-expensify and thesahindia and removed request for a team January 20, 2025 20:22
Copy link

melvin-bot bot commented Jan 20, 2025

@dubielzyk-expensify @thesahindia One of you needs to 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]

@sumo-slonik sumo-slonik changed the title [Draft] Add animation for switch children Add animation for switch children Jan 20, 2025
@dubielzyk-expensify
Copy link
Contributor

Same thing as we discussed in this draft PR but the padding is off here on the Android recording:

CleanShot 2025-01-21 at 14 17 23@2x

The workflow animations looks pretty great 😄

Also MacOS Desktop, iOS mWeb, and Android mWeb videos didn't upload or display properly.

@sumo-slonik
Copy link
Contributor Author

sumo-slonik commented Jan 21, 2025

@dubielzyk-expensify

Same thing as we discussed in this draft PR but the padding is off here on the Android recording:

CleanShot 2025-01-21 at 14 17 23@2x

The workflow animations looks pretty great 😄

Also MacOS Desktop, iOS mWeb, and Android mWeb videos didn't upload or display properly.

here are not these changes for accounting tabs, they will be in a separaten PR, I added the wrong recording. It is already corrected

@mountiny
Copy link
Contributor

@thesahindia What is your eta for this review?

@sumo-slonik could you please highligh in the diff the changes made to fix the issue found in staging? thanks!

@dubielzyk-expensify
Copy link
Contributor

here are not these changes for accounting tabs, they will be in a separaten #55412, I added the wrong recording. It is already corrected

Ahh all good then. It looks good to me on the workflow page 👍

@sumo-slonik
Copy link
Contributor Author

here are not these changes for accounting tabs, they will be in a separaten #55412, I added the wrong recording. It is already corrected

Ahh all good then. It looks good to me on the workflow page 👍

if you want to see what the other tabs will look like you can check PR:
PR
That PR is ready but I'm not opening it because first we need to merge this one.

@thesahindia
Copy link
Member

There's an issue in navigation.

  1. Navigate to "More features"
  2. Enable any feature (e.g., Workflows)
  3. Click on "Workflows"
  4. Return to "More features"
  5. Disable "Workflows"
  6. Click the browser back button
Screen.Recording.2025-01-22.at.4.54.31.PM.mov

@thesahindia
Copy link
Member

Currently, there's a sliding animation when a newly enabled feature appears in the list. Are we okay with just highlighting the new feature instead?

Current behaviour:

Screen.Recording.2025-01-22.at.5.20.33.PM.mov

New behaviour:

Screen.Recording.2025-01-22.at.5.19.14.PM.mov

@sumo-slonik
Copy link
Contributor Author

There's an issue in navigation.

  1. Navigate to "More features"
  2. Enable any feature (e.g., Workflows)
  3. Click on "Workflows"
  4. Return to "More features"
  5. Disable "Workflows"
  6. Click the browser back button

Screen.Recording.2025-01-22.at.4.54.31.PM.mov

This also occurs on https://new.expensify.com, so I think it's not due to this PR

const [featureStates, setFeatureStates] = useState(policyFeatureStates);
const [highlightedFeature, setHighlightedFeature] = useState<string | undefined>(undefined);

const workspaceMenuItems: WorkspaceMenuItem[] = useMemo(() => {
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@mountiny

@sumo-slonik could you please highligh in the diff the changes made to fix the issue found in staging? thanks!

The addition of mnemonization here eliminates the problem that caused unnecessary rerendering and caused the flag responsible for highlighting to be removed.

Copy link
Contributor

🚧 @mountiny has triggered a test hybrid app build. You can view the workflow run here.

Copy link
Contributor

🧪🧪 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 🕸️
N/A N/A
N/A N/A

👀 View the workflow run that generated this build 👀

@blazejkustra
Copy link
Contributor

@mountiny this looks weird, ad hoc builds are failing with a surprising error:
image

@sumo-slonik
Copy link
Contributor Author

@thesahindia ready to check again, I hope it will be good now :D

@mountiny
Copy link
Contributor

@sumo-slonik thanks! Can you please fix the lint?

@thesahindia please feel free to review and test even with the failing action. Thanks

@sumo-slonik
Copy link
Contributor Author

Hi, it seems to me that this is a rather large PR and in the changes I added there is already a risk of regression, I would prefer to avoid correcting imports not related to my PR in order not to increase this risk unnecessarily. What do you think about this @mountiny ?

@@ -1069,6 +1069,12 @@ function navigateWhenEnableFeature(policyID: string) {
}, CONST.WORKSPACE_ENABLE_FEATURE_REDIRECT_DELAY);
}

function goBackWhenEnableFeature(policyID: string) {
setTimeout(() => {
Copy link
Member

@thesahindia thesahindia Jan 27, 2025

Choose a reason for hiding this comment

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

I'm a bit concerned about using setTimeout, we try to avoid it unless absolutely necessary.

cc: @mountiny

Copy link
Contributor Author

Choose a reason for hiding this comment

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

is exactly the same solution as it was before in the navigate function:

function navigateWhenEnableFeature(policyID: string) {
    setTimeout(() => {
        Navigation.navigate(ROUTES.WORKSPACE_INITIAL.getRoute(policyID));
    }, CONST.WORKSPACE_ENABLE_FEATURE_REDIRECT_DELAY);
}

which we replacing here

Copy link
Member

Choose a reason for hiding this comment

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

Ah, my bad. Let's not make any changes here then.

@thesahindia
Copy link
Member

thesahindia commented Jan 27, 2025

This one needs to be updated as well.

navigateWhenEnableFeature(policyID);

Please remove the function as well.

function navigateWhenEnableFeature(policyID: string) {

@mountiny
Copy link
Contributor

@sumo-slonik sounds fine, if all the lint issues are about the import rule then dont worry about it

…itch_childreans

# Conflicts:
#	src/pages/workspace/WorkspaceInitialPage.tsx
@sumo-slonik
Copy link
Contributor Author

I've already resolved the conflict but I'm checking if it still works on all platforms after attaching the master

@sumo-slonik
Copy link
Contributor Author

@thesahindia
Everything is working, and you can start testing.

@thesahindia
Copy link
Member

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 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 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 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.ts 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 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.
  • For any bug fix or new feature in this PR, I verified that sufficient unit tests are included to prevent regressions in this flow.
  • 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
Screen.Recording.2025-01-29.at.5.50.00.PM.mov
iOS: Native
Screen.Recording.2025-01-25.at.9.54.21.PM.mov
iOS: mWeb Safari
Screen.Recording.2025-01-25.at.10.12.42.PM.mov
MacOS: Chrome / Safari
Screen.Recording.2025-01-25.at.10.14.39.PM.mov
MacOS: Desktop
Screen.Recording.2025-01-25.at.10.17.30.PM.mov

Copy link
Member

@thesahindia thesahindia left a comment

Choose a reason for hiding this comment

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

Works well!

Copy link
Contributor

@mountiny mountiny left a comment

Choose a reason for hiding this comment

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

The PR is large enough already so we decided not ot fix all the libs import lint errors.

@mountiny mountiny merged commit ced121a into Expensify:main Jan 29, 2025
16 of 17 checks passed
Copy link

melvin-bot bot commented Jan 29, 2025

@mountiny looks like this was merged without a test passing. Please add a note explaining why this was done and remove the Emergency label if this is not an emergency.

@mountiny
Copy link
Contributor

Explained above

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

Copy link
Contributor

🚀 Deployed to staging by https://github.com/mountiny in version: 9.0.92-0 🚀

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

Copy link
Contributor

🚀 Deployed to production by https://github.com/yuwenmemon in version: 9.0.92-6 🚀

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

'payload' in action &&
action.payload &&
'name' in action.payload &&
(isSideModalNavigator(action.payload.name) || action.payload.name === NAVIGATORS.FULL_SCREEN_NAVIGATOR)
Copy link
Contributor

Choose a reason for hiding this comment

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

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.

7 participants