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

revert usage of InteractionManager in Modal #21865

Merged
merged 7 commits into from
Jul 6, 2023

Conversation

kushu7
Copy link
Contributor

@kushu7 kushu7 commented Jun 29, 2023

Details

Due to race condition, reverting usage of InteractionManager in Modal.
which causes this regression #21833

Fixed Issues

$ #20516
PROPOSAL: #20516 (comment)
REGRESSION: #21833

Tests

  1. Open an existing chat
  2. Open JS console
  3. Send a message
  4. Right-click on the sent message
  5. Click on 'Add reaction' icon
  6. Verify that no errors appear in console.
  • Verify that no errors appear in the JS console

Offline tests

Same as Tests

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 / 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
    • 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 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
web.mov
Mobile Web - Chrome
mweb.chrome.mov
Mobile Web - Safari
mweb.safari.mov
Desktop
desktop.mov
iOS
ios.mp4
Android
android.mp4

@kushu7 kushu7 marked this pull request as ready for review June 29, 2023 13:15
@kushu7 kushu7 requested a review from a team as a code owner June 29, 2023 13:15
@melvin-bot melvin-bot bot requested review from allroundexperts and removed request for a team June 29, 2023 13:15
@melvin-bot
Copy link

melvin-bot bot commented Jun 29, 2023

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

@kushu7
Copy link
Contributor Author

kushu7 commented Jun 30, 2023

@allroundexperts wait, I'll let you know, I'm trying to more optimize it

@kushu7
Copy link
Contributor Author

kushu7 commented Jun 30, 2023

@allroundexperts problem is not limited to IntractionManager, in staging and production hex are converted to rgba by default. Thats why it was not reproduced in dev.
I will modify that function to accept both hex and rgb/rgba as param.

@allroundexperts
Copy link
Contributor

@allroundexperts problem is not limited to IntractionManager, in staging and production hex are converted to rgba by default. Thats why it was not reproduced in dev. I will modify that function to accept both hex and rgb/rgba as param.

Hm... Are you implying that the problem existed before your PR?

@kushu7
Copy link
Contributor Author

kushu7 commented Jun 30, 2023

I guess something got also changed in staging and production, if you look at meta color in staging its default to rgba value and we are just apply rgb value only while opening modal.
Maybe some config got changed.? Can you also check. As issue started reporting 3 days ago regarding this

I'm also modifying the function to accept rgb/rgba as param.

@allroundexperts
Copy link
Contributor

I guess something got also changed in staging and production, if you look at meta color in staging its default to rgba value and we are just apply rgb value only while opening modal. Maybe some config got changed.? Can you also check. As issue started reporting 3 days ago regarding this

I'm also modifying the function to accept rgb/rgba as param.

Right. Can you revert your change and see if the error still occurs?

@kushu7
Copy link
Contributor Author

kushu7 commented Jun 30, 2023

Right. Can you revert your change and see if the error still occurs?

No it will not.
as in this PR we started reading old color of statusbar

@pecanoro pecanoro self-requested a review June 30, 2023 14:28
@kushu7
Copy link
Contributor Author

kushu7 commented Jun 30, 2023

@allroundexperts I pushed the code. i modified getThemeBackgroundColor to accept rgb/rgba colors also. and to keep consistency, it will return hexColor now instead of rgb format.

@allroundexperts Its ready for review now.

Comment on lines 757 to 758
const themeHex = convertRGBToHex(...themeRGB);
return themeHex;
Copy link
Contributor

Choose a reason for hiding this comment

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

Why do you need this change?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

We were only returning rgb here. Everywhere we use hex, i thought we should return hex from here also.

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 try not to change the existing behaviour.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

ok, reverting this one.

@@ -16,7 +15,7 @@ function Modal(props) {
return;
}

InteractionManager.runAfterInteractions(() => StatusBar.setBackgroundColor(color));
StatusBar.setBackgroundColor(color);
Copy link
Contributor

Choose a reason for hiding this comment

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

Why is this revert needed? The console error seemed to be stemming from the convertRGBToHex function?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

There was race condition also with modal. to get correct current color of StatusBar. i reverted usage of InteractionManager

@allroundexperts
Copy link
Contributor

allroundexperts commented Jul 4, 2023

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

Web
Screen.Recording.2023-07-04.at.12.55.16.PM.mov
Mobile Web - Chrome
Screen.Recording.2023-07-04.at.12.59.45.PM.mov
Mobile Web - Safari
Screen.Recording.2023-07-04.at.1.01.59.PM.mov
Desktop
Screen.Recording.2023-07-04.at.12.56.10.PM.mov
iOS
Screen.Recording.2023-07-04.at.1.05.42.PM.mov
Android
Screen.Recording.2023-07-04.at.1.08.30.PM.mov

allroundexperts

This comment was marked as outdated.

@allroundexperts
Copy link
Contributor

@kushu7 I found out that we did a PR that animated the top bar colour previously. Can you merge the latest main and make sure that we're leveraging the animations done there?

@allroundexperts
Copy link
Contributor

@pecanoro I think we might be able to fix the janky animations as well. Let's wait for @kushu7 to resolve my comment before merging this.

@kushu7
Copy link
Contributor Author

kushu7 commented Jul 4, 2023

Can you merge the latest main and make sure that we're leveraging the animations done there?

Sure

@kushu7
Copy link
Contributor Author

kushu7 commented Jul 4, 2023

@allroundexperts Its pretty much better now in android.

android
Record_2023-07-04-22-08-10.1.mp4

@pecanoro
Copy link
Contributor

pecanoro commented Jul 5, 2023

So ready for me to do a final test and review?

@allroundexperts
Copy link
Contributor

So ready for me to do a final test and review?

Yes, please!

src/styles/StyleUtils.js Outdated Show resolved Hide resolved
src/styles/StyleUtils.js Show resolved Hide resolved
@pecanoro
Copy link
Contributor

pecanoro commented Jul 5, 2023

Two small changes

@pecanoro
Copy link
Contributor

pecanoro commented Jul 5, 2023

Otherwise, it works well

@kushu7 kushu7 requested a review from pecanoro July 5, 2023 23:35
@pecanoro pecanoro merged commit 40c494f into Expensify:main Jul 6, 2023
@OSBotify
Copy link
Contributor

OSBotify commented Jul 6, 2023

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

@kushu7 kushu7 deleted the fix-regression-21833 branch July 6, 2023 00:09
@OSBotify
Copy link
Contributor

OSBotify commented Jul 7, 2023

🚀 Deployed to staging by https://github.com/pecanoro in version: 1.3.38-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/francoisl in version: 1.3.38-7 🚀

platform result
🤖 android 🤖 success ✅
🖥 desktop 🖥 success ✅
🍎 iOS 🍎 success ✅
🕸 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.

4 participants