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

[CP Staging] Fix: align badge in workspace list #40599

Merged
merged 6 commits into from
Apr 21, 2024

Conversation

dragnoir
Copy link
Contributor

Details

This PR fixes the misalignment of the badge inside a row in workspace list.

Fixed Issues

$ #40524
PROPOSAL: #40524 (comment)

Tests

  1. Open a workspace join link that we aren't a member of this (workspace from gmail account)
  2. Check the workspace type name
  • Verify that no errors appear in the JS console

Offline tests

QA Steps

  1. Open a workspace join link that we aren't a member of this (workspace from gmail account)
  2. Check the workspace type name
  • 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 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 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.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 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.
  • 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

image

Android: mWeb Chrome

image

iOS: Native

image

iOS: mWeb Safari

image

MacOS: Chrome / Safari

image

MacOS: Desktop

image

@dragnoir dragnoir requested review from a team as code owners April 19, 2024 17:45
@melvin-bot melvin-bot bot requested review from cubuspl42 and removed request for a team April 19, 2024 17:45
Copy link

melvin-bot bot commented Apr 19, 2024

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

@@ -3207,6 +3207,20 @@ const styles = (theme: ThemeColors) =>
marginLeft: 3,
},

WorkspaceRightColumn: {
marginLeft: 99,
Copy link
Contributor

Choose a reason for hiding this comment

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

Hmm why are we taking this kind of approach with hard-coded values instead of just using flex to fill up space?

Copy link
Contributor

Choose a reason for hiding this comment

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

Where did you get 99 from?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

width of the badge
image

the value was 40 which is the with of the 3 dots menu

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 can use 100 or any higher value

Copy link
Contributor Author

Choose a reason for hiding this comment

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

At the table header, we have a non-visible 4th column, all the 1st 3 columns use flex to stretch on the space equally. and we do hard-coded spacing for the 4th column to make sure it takes the lowest space.

image

I set the value to 100 to fit the badge in some cases and the 3 dots menu.

Copy link
Contributor

Choose a reason for hiding this comment

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

Hmm but you can tell that the columns in the header don't perfectly match up with the content below. Owner looks like it's too far to the left for instance, compared to the content below it.

Why wouldn't that invisible 4th column header just match the width of the 4th column in the table?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This is a screenshot from stagging

image

As you can see, under Owner, the content has some margins, that push the content to the right a bit, and this is why you see

the header don't perfectly match up with the content below

Copy link
Contributor Author

Choose a reason for hiding this comment

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

this is why 100px

image

Copy link
Contributor

Choose a reason for hiding this comment

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

Right, but if there is no badge present, that means we just have a bunch of dead space?

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 and No

Yes because technically it's true.

No because the space is already empty:
image

and if you think we need the space in small screens, the layout change on small screens to
image

So I think it's not a wasted space.

But if you want, I can create a logic to find out if there well be a badge for Request, then adjust this value 100/40

},

workspaceThreeDotMenu: {
marginLeft: 59,
Copy link
Contributor

Choose a reason for hiding this comment

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

Where does 59 come from?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

99 (badge width) - 40 (3 dots width)

@@ -3207,6 +3207,20 @@ const styles = (theme: ThemeColors) =>
marginLeft: 3,
},

WorkspaceRightColumn: {
marginLeft: 100,
Copy link
Contributor

Choose a reason for hiding this comment

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

Can you show me exactly what this looks like? I don't understand why we are hard coding so much margin. Does that mean we have 100px of space that can only be occupied by margin? How does that work when the viewport is bigger or smaller? It just feels like these hard coded margins are a hack and don't provide good responsiveness.

This comment has been minimized.

@mountiny mountiny changed the title Fix: align badge in workspace list [CP Staging] Fix: align badge in workspace list Apr 19, 2024
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.

I agree with @shawnborton that this logic feels fragile, I can assure you that if someone changes the width of the badge or adds a badge of a different width, they will bring this bug back.

Could you please try to find solution which wont depend on the width of the badge?

@@ -3207,6 +3207,20 @@ const styles = (theme: ThemeColors) =>
marginLeft: 3,
},

WorkspaceRightColumn: {
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
WorkspaceRightColumn: {
workspaceRightColumn: {

Copy link
Contributor Author

Choose a reason for hiding this comment

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

solved.

@dragnoir
Copy link
Contributor Author

@mountiny @shawnborton This layout and the way to use content width value was there, I didn't create it. I just changed the value from 40 to 100. 40 was the width of the 3 dots menu.

The idea from this aspect, is to use 4 columns keeping the 4th one small as possible.

To solve the issue you mentioned, we have 2 main solutions:

1- Use flex for the 4th column as it's been used for the other 3 columns

This solution creates 4 equal columns, equal in width. The issue here there will be a more empty space between the "Workspace type" and the final 4th column.

image

2- change the table to only 3 columns

where the action will be part of the 3rd column but aligned to the right.

image

What do you think? I like solution 2

@mountiny
Copy link
Contributor

@dragnoir I think the option 2 is quite elegant, how does it scale on other screensizes?

@dragnoir
Copy link
Contributor Author

@dragnoir I think the option 2 is quite elegant, how does it scale on other screensizes?

Same, I will update the layout to keep it as it us now (fixed)

@mountiny
Copy link
Contributor

Lets watch out to make sure the style changes will not influence any other components

@dragnoir
Copy link
Contributor Author

@mountiny bad news, we can't use solution 2, in very tight screens, this UI bug will happen

image

It happens because we made the Workspace type + the action in one column.

I think it's better to keep the 4th column with a max width equal to 100px. What do you see?

below a screenshot from the solution with 100 and in the same tight screen:

image

@mountiny
Copy link
Contributor

Ah alright, that I guess makes sense.

I dont think we should be doing some major styling changes in cherry pick PR, so since as you mentioned this fragile pixel logic existed before, I think we could just update it for now to fix the styling in staging, but follow up with exploration on how to make this styling responsive without the esoteric pixel math

@dragnoir
Copy link
Contributor Author

@cubuspl42 you can review the code, please.

@mountiny mountiny removed the request for review from cubuspl42 April 21, 2024 10:04
@mountiny
Copy link
Contributor

Asking for a C+ who is available now

@allroundexperts
Copy link
Contributor

allroundexperts commented Apr 21, 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 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.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 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.
  • 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 Screenshot 2024-04-21 at 5 35 32 PM
Android: mWeb Chrome Screenshot 2024-04-21 at 5 34 55 PM
iOS: Native Screenshot 2024-04-21 at 5 33 35 PM
iOS: mWeb Safari Screenshot 2024-04-21 at 5 33 22 PM
MacOS: Chrome / Safari Screenshot 2024-04-21 at 3 35 56 PM
MacOS: Desktop Screenshot 2024-04-21 at 3 37 29 PM

@allroundexperts
Copy link
Contributor

BUG

Invite badge overlapping with workspace name on small screens

Screenshot 2024-04-21 at 3 37 47 PM

@allroundexperts
Copy link
Contributor

Same is happening on iOS safari:

Screenshot 2024-04-21 at 3 40 34 PM

@dragnoir
Copy link
Contributor Author

Fixing now..

@dragnoir
Copy link
Contributor Author

@allroundexperts fixed

image

image

image

Copy link
Contributor

@allroundexperts allroundexperts left a comment

Choose a reason for hiding this comment

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

Works good!

@melvin-bot melvin-bot bot requested a review from mountiny April 21, 2024 12:40
@allroundexperts
Copy link
Contributor

@dragnoir Found another bug. The types are not aligned.

Screenshot 2024-04-21 at 5 47 56 PM

Copy link
Contributor

@allroundexperts allroundexperts left a comment

Choose a reason for hiding this comment

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

Found another bug.

@dragnoir
Copy link
Contributor Author

@allroundexperts fixed

image

image

Copy link
Contributor

@allroundexperts allroundexperts left a comment

Choose a reason for hiding this comment

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

Works good now. Thank you!

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.

I think this is good to fix the deploy blocker, but as mentioned before, we should look into removing this pixel-based logic for styles because it will break again soon.

@mountiny
Copy link
Contributor

I will wait for Monday morning for @shawnborton to review but since this is a deploy blocker I would merge it past 10am CET to unblock deploy

Copy link
Contributor

@mountiny
Copy link
Contributor

Based on NewDot, Shawn is in the US so to make sure we can deploy sooner than later, I am going to go ahead with the merge here, I have tested as well and it looks good (do not worry about the blinking that is my local thing)
https://github.com/Expensify/App/assets/36083550/4d3d6822-4587-49f0-9fe7-1b78811fcce4

@mountiny mountiny merged commit 0f30b3d into Expensify:main Apr 21, 2024
16 checks passed
@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.

OSBotify pushed a commit that referenced this pull request Apr 22, 2024
[CP Staging] Fix: align badge in workspace list

(cherry picked from commit 0f30b3d)
@Beamanator
Copy link
Contributor

🚀 Cherry-picked to staging by https://github.com/Beamanator in version: 1.4.63-18 🚀

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

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

@shawnborton
Copy link
Contributor

Cool, I think that looks good. Only minor comment is that the overflow icon (three dots) on mobile feels like it's not quite as far to the right as it should be?
CleanShot 2024-04-22 at 08 18 25@2x

I should have caught this sooner but it's strange that we're wrapping the overflow icon in a 40x40 wrapper and then sending that wrapper to the edge of the view. I think that's what's causing the weirdness above:
CleanShot 2024-04-22 at 08 21 13@2x

Ideally the icon should just be 20x20 and there should be even 20px padding both vertically and horizontally on the entire row:
CleanShot 2024-04-22 at 08 22 01@2x

None of that was caused by @dragnoir - but just noting in case we want to do a follow up PR to clean that stuff up.

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/mountiny in version: 1.4.63-21 🚀

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

Successfully merging this pull request may close these issues.

6 participants