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

Fix popover menu anchor alignment prop #19849

Merged

Conversation

huzaifa-99
Copy link
Contributor

@huzaifa-99 huzaifa-99 commented May 30, 2023

Details

Fixed Issues

$ #19453, #19791
PROPOSAL: #19453 (comment)

Tests

  1. Go to profile settings page /settings/profile - verify that on clicking the photo icon the popover is not covering the profile photo
  2. Go to profile settings page /workspace/:id/settings - verify that on clicking the photo icon the popover is not covering the workspace photo
  3. Go to a workspace details page /workspace/:id - verify that on clicking the 3-dots the popover is not covering the header
  • Verify that no errors appear in the JS console

Offline tests

Same as above

QA Steps

Same as above

  • 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

Chrome

Web.chrome.mp4

Safari

Web.Safari.mp4
Mobile Web - Chrome
mWeb.Chrome.mp4
Mobile Web - Safari
IOS.Safari.mp4
Desktop
Desktop.mp4
iOS
ios.-.compressed.mp4
Android
Android.mp4

@huzaifa-99 huzaifa-99 requested a review from a team as a code owner May 30, 2023 20:32
@melvin-bot melvin-bot bot requested review from iwiznia and Santhosh-Sellavel and removed request for a team May 30, 2023 20:32
@melvin-bot
Copy link

melvin-bot bot commented May 30, 2023

@iwiznia @Santhosh-Sellavel 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]

@huzaifa-99
Copy link
Contributor Author

Apologies for the lint issues, I will try best for them to not happen again!

@huzaifa-99
Copy link
Contributor Author

huzaifa-99 commented May 31, 2023

Bump for review @Santhosh-Sellavel

@Santhosh-Sellavel
Copy link
Collaborator

@huzaifa-99 Conflicts

@huzaifa-99
Copy link
Contributor Author

@Santhosh-Sellavel Fixed merge conflicts!

@Santhosh-Sellavel
Copy link
Collaborator

Santhosh-Sellavel commented Jun 1, 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 & Desktop
Screen.Recording.2023-06-07.at.12.37.08.AM.mov
Mobile Web - Chrome & Android
device-2023-06-02-022200.mp4
Mobile Web - Safari & iOS
Simulator.Screen.Recording.-.iPhone.14.-.2023-06-02.at.02.16.58.mp4

@huzaifa-99
Copy link
Contributor Author

@Santhosh-Sellavel bump for review.

@Santhosh-Sellavel
Copy link
Collaborator

@huzaifa-99 There are conflicts again

@huzaifa-99
Copy link
Contributor Author

@Santhosh-Sellavel resolved

@Santhosh-Sellavel
Copy link
Collaborator

@huzaifa-99 All looks good, there is slight inconsistency between Desktop & Web

@Santhosh-Sellavel
Copy link
Collaborator

See the top positioning of popover between desktop & web

Desktop

Screenshot 2023-06-05 at 10 45 22 PM

Web

Screenshot 2023-06-05 at 10 45 11 PM

@huzaifa-99
Copy link
Contributor Author

I did some digging, its because we are adding an extra 12px to height on desktop HeaderGap/index.desktop.js#L7.

I suggest we make a height style utility, and use it like this

threeDotsPopoverOffset: (windowWidth) => ({
        vertical: height(60),
        horizontal: windowWidth - 60,
}),

and we create the desktop variant height/index.desktop.

import styles from '../styles';
import variables from '../variables';

export default (height) => {
    return height + 12; // we add 12px as a header gap on desktop
};

In desktop it will add 12px with the provided value, and there wont be any vertical position variation.

image

@Santhosh-Sellavel please let me know if you agree so I add these changes.

@Santhosh-Sellavel
Copy link
Collaborator

Looks good @iwiznia Thoughts?

@iwiznia
Copy link
Contributor

iwiznia commented Jun 5, 2023

hmmmm kind of odd, do we do something like that? Define specific helper methods for styling different the different platforms?

Would it be better to do something like pass the heather gap height as a param to the method, so it can add that to the position?

@Santhosh-Sellavel
Copy link
Collaborator

Santhosh-Sellavel commented Jun 5, 2023

@iwiznia
This is kind of an specific case, maybe we can define a separate NOOP method to getVerticalPosition as we do for HeaderGap. Instead of writing a height method which is unnecessary

cc: @huzaifa-99

@iwiznia
Copy link
Contributor

iwiznia commented Jun 5, 2023

I like that more.

@iwiznia
Copy link
Contributor

iwiznia commented Jun 5, 2023

Or maybe getVerticalOffset?

// On desktop app we are adding a header gap of 12px
// which we need to add to vertical offset when setting
// offset on desktop
vertical: vertical + 12,
Copy link
Collaborator

Choose a reason for hiding this comment

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

12 should be made as CONST and used at both places.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@huzaifa-99
Copy link
Contributor Author

Updated test videos for desktop and web.

Copy link
Collaborator

@Santhosh-Sellavel Santhosh-Sellavel left a comment

Choose a reason for hiding this comment

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

@iwiznia Do you have any suggestions?

@@ -0,0 +1,8 @@
import CONST from '../../CONST';

export default (vertical) => ({
Copy link
Collaborator

Choose a reason for hiding this comment

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

Add JS Doc

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

src/CONST.js Outdated
@@ -827,6 +827,7 @@ const CONST = {
WIDTH: 320,
HEIGHT: 416,
},
DESKTOP_HEADER_HEIGHT: 12,
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
DESKTOP_HEADER_HEIGHT: 12,
DESKTOP_HEADER_PADDING: 12,

Copy link
Collaborator

Choose a reason for hiding this comment

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

Make changes in other places too

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

@huzaifa-99
Copy link
Contributor Author

@Santhosh-Sellavel bump for review. The suggested changes are done!

Copy link
Collaborator

@Santhosh-Sellavel Santhosh-Sellavel left a comment

Choose a reason for hiding this comment

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

All yours @iwiznia!

@huzaifa-99
Copy link
Contributor Author

@iwiznia bump for review

@@ -0,0 +1,13 @@
import CONST from '../../CONST';
Copy link
Contributor

Choose a reason for hiding this comment

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

Comment related to the whole directory, not this specific line.
Can we make the name of this function be more clear? Like can we add it under a directory that indicates what components use this or add something to the name or something?
Reading getVerticalOffset tells you nothing about what vertical offset is this supposed to be.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Can we make the name of this function be more clear? Like can we add it under a directory that indicates what components use this or add something to the name or something?

I think the one's directly in /styles/ folder are for these one-off cases like cardStyles, addOutlineWidth, editedLabelStyles and more, and those in styles/utilities are proper style utilities like cursor, visibility etc. (By one-off cases i meant the one we have in PR)

But i maybe wrong here since we also have bold and italic directly in /styles and not in /styles/utilities and vice versa. TBH idk why we have the styles/utilities in the first place it just seems unnecessary or if it is necessary then the styles folder's outside of it seems unnecessary.

Reading getVerticalOffset tells you nothing about what vertical offset is this supposed to be.

Its a little ambiguous yes, maybe we could add a direction with it like getVerticalOffsetFromTop etc or any other name, @Santhosh-Sellavel curious if you have any suggestions here?

cc: @iwiznia @Santhosh-Sellavel

Copy link
Contributor

Choose a reason for hiding this comment

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

Sorry for not being clear. This style is related to the PopOver component, no?
threeDotsPopoverOffset and threeDotsPopoverOffsetNoCloseButton then createMenuPositionProfile also ends up passing this to a PopOver component.
So, a better name might be getPopOverVerticalOffset or similar.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sounds good, Thank you! I will be updating it.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@iwiznia added those changes

@huzaifa-99 huzaifa-99 requested a review from iwiznia June 9, 2023 01:20
@iwiznia iwiznia merged commit d91fe14 into Expensify:main Jun 9, 2023
@OSBotify
Copy link
Contributor

OSBotify commented Jun 9, 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.

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/iwiznia in version: 1.3.27-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/iwiznia in version: 1.3.27-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/AndrewGable in version: 1.3.27-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
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants