[CP Stag] Only use tab animation when in tab navigator #27974
Conversation
melvin-bot
bot
requested review from
eVoloshchak
and removed request for
a team
|
@eVoloshchak 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] |
|
@eVoloshchak My Android emulator camera won't load. Any way you could test this for me? |
thienlnam
requested review from
parasharrajat
and removed request for
eVoloshchak
| const tabPositionAnimation = useTabAnimation(); | ||
| // We can use a condition to call a hook here because otherwise the hook throws | ||
| // eslint-disable-next-line react-hooks/rules-of-hooks | ||
| const tabPositionAnimation = isInTabNavigator ? useTabAnimation() : null; |
There was a problem hiding this comment.
while this may be working, it is not the correct way of using hooks. An alternative would be to create two screens. One for direct access and one for in-tab selector. Define these in routes.
- Now create a common component from the screen logic.
- use this component on both screens.
- pass prop to manage if we want to use navigationAwareCamera with TabNavigation or a similar component without tab navigation.
- We will create two components for
navigationAwareCamera, one with tabAnimation hook and the other without it. These are used in step 3. - For the Replace button, we will navigate to the direct screen. Not in the tab selector.
- We can also update the patch to skip throwing errors and just issue a console warning.
- But this is more error-prone as users might use it in the wrong place.
There was a problem hiding this comment.
I would prefer the second option. Creating that much boilerplate just for not calling a hook conditionally isn't worth it IMO.
There was a problem hiding this comment.
So, I checked and it seems 1-2 are already done in the code. We only need to do 3-4.
There was a problem hiding this comment.
The main component used is ReceiptSelector. So we can create a prop on it saying hasTab or something and then just switch between the two versions of navigationAwareCamera component.
There was a problem hiding this comment.
I won't recommend the second option has it will lead to the same issue which we prevented by throwing the error. We want to prevent he user from using this hook in non tab screens.
| @@ -19,12 +19,19 @@ function NavigationAwareCamera({cameraTabIndex, forwardedRef, ...props}) { | |||
| const navigation = useNavigation(); | |||
| const [isCameraActive, setIsCameraActive] = useState(navigation.isFocused()); | |||
|
|
|||
| const isInTabNavigator = cameraTabIndex > -1; | |||
There was a problem hiding this comment.
This is a workaround to detect if we are in a tab.
There was a problem hiding this comment.
Agree, but I don't know I prefer isTab or something similar to proposal 2. What do you think?
There was a problem hiding this comment.
Even if we use proposal 2 is comes down to conditional use of hook.
|
|
||
| useEffect(() => { | ||
| if (!isInTabNavigator) { |
There was a problem hiding this comment.
We skipped this hook, did you check if the camera is opening?
I think we will have to add a different hook to activate the camera when not inside Tab Selector.
There was a problem hiding this comment.
|
There is a prop warning. Let's fix that. Please add the test videos for other platforms too. |
|
Done for all except android. Still having trouble with chrome and native there. Let me know if you have better luck |
|
So, I think there is a slight delay before the camera opens on the replacement screen. This is something we solved with |
|
So I don't see much difference. I think we are good. |
Screenshots🔲 iOS / nativeScreen.Recording.2023-09-22.at.5.54.51.PM.mov🔲 iOS / SafariScreen.Recording.2023-09-22.at.5.37.48.PM.mov🔲 MacOS / DesktopScreen.Recording.2023-09-22.at.5.42.45.PM.mov🔲 MacOS / ChromeScreen.Recording.2023-09-22.at.5.41.58.PM.mov🔲 Android / ChromeScreenrecorder-2023-09-22-17-21-30-118.mp4🔲 Android / nativeScreenrecorder-2023-09-22-17-16-12-490.mp4Screenrecorder-2023-09-22-17-16-51-460.mp4 |
|
Okay, so the replace page is not opening on Safari and the web. Screen.Recording.2023-09-22.at.5.26.10.PM.mov |
|
So this issue is also present on main, we can skip this bug on this PR. |
There was a problem hiding this comment.
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 Issuessection 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
Testssection - I verified the steps for Staging and/or Production testing are in the
QA stepssection - 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 verified the steps for local testing are in the
- 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 / Chrome
- iOS / native
- iOS / 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.
toggleReportand notonIconClick). - 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 Copylabel 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
- 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.
- 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 usingAvatarhave 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
thisproperly so there are no scoping issues (i.e. foronClick={this.submit}the methodthis.submitshould be bound tothisin the constructor) - Any internal methods bound to
thisare necessary to be bound (i.e. avoidthis.submit = this.submit.bind(this);ifthis.submitis never passed to a component event handler likeonClick) - 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
Avataris modified, I verified thatAvataris 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 a new page is added, I verified it's using the
ScrollViewcomponent to make it scrollable when more elements are added to the page. - If the
mainbranch was merged into this PR after a review, I tested again and verified the outcome was still expected according to theTeststeps. - I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.
🎀 👀 🎀 C+ reviewed
|
@jasperhuangg 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] |
thienlnam
changed the title
|
✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release. |
(cherry picked from commit 3d3e791)
|
🚀 Deployed to production by https://github.com/thienlnam in version: 1.3.72-11 🚀
|
|
🚀 Cherry-picked to staging by https://github.com/thienlnam in version: 1.3.72-11 🚀
@Expensify/applauseleads please QA this PR and check it off on the deploy checklist if it passes. |
|
🚀 Deployed to staging by https://github.com/thienlnam in version: 1.3.74-0 🚀
|
|
🚀 Deployed to production by https://github.com/chiragsalian in version: 1.3.74-3 🚀
|
Details
Deploy blocker. Replace Receipt crashes because the Receipt Selector is not within the tab navigator because we open it up from the three dots in the modal.
Fixed Issues
$ #27903
Tests
Offline tests
Same as QA steps, should work offline
QA Steps
PR Author Checklist
### Fixed Issuessection aboveTestssectionOffline stepssectionQA stepssectiontoggleReportand notonIconClick)myBool && <MyComponent />.src/languages/*files and using the translation methodWaiting for Copylabel for a copy review on the original GH to get the correct copy.STYLE.md) were followedAvatar, I verified the components usingAvatarare working as expected)/** comment above it */thisproperly so there are no scoping issues (i.e. foronClick={this.submit}the methodthis.submitshould be bound tothisin the constructor)thisare necessary to be bound (i.e. avoidthis.submit = this.submit.bind(this);ifthis.submitis never passed to a component event handler likeonClick)StyleUtils.getBackgroundAndBorderStyle(themeColors.componentBG))Avataris modified, I verified thatAvataris working as expected in all cases)ScrollViewcomponent to make it scrollable when more elements are added to the page.mainbranch was merged into this PR after a review, I tested again and verified the outcome was still expected according to theTeststeps.Screenshots/Videos
change only applies to mobile native
Web
Uploading Screen Recording 2023-33309-22 at 6.50.33 PM.mov…
Mobile Web - Chrome
Mobile Web - Safari
Uploading Simulator Screen Recording - iPhone 14 (16.1) - 2023-09-22 at 18.56.19.mp4…
Desktop
Uploading Screen Recording 34232023-09-22 at 7.08.17 PM.mov…
iOS
Simulator.Screen.Recording.-.iPhone.14.16.1.-.2023-09-22.at.10.33.11.mp4
Android