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

[No QA] Empty state modal #45690

Merged
merged 13 commits into from
Jul 22, 2024
Merged

Conversation

koko57
Copy link
Contributor

@koko57 koko57 commented Jul 18, 2024

Details

Fixed Issues

$ #44306
PROPOSAL: -

Tests

PREREQUISITES: you need to have permissions for workspace card enabled

  1. Go to Workspaces -> Workspace -> Expensify card (enable it in more features if you don't have it enabled)
  2. Click Issue New Card, verify that you're redirected to the Choose Bank Account page
  3. Choose a bank account
  4. On web after choosing bank account you will see that under the RHP the page changes. Dismiss the modal. On mobile you will see Issue New Card flow step 1 - go back with back button - you should be redirected to the Expensify Card page.
  5. Verify that you see a modal, the skeletons and two buttons (Issue card and Settings) above.
  6. Scroll the page - after scrolling down you should see the disclaimer.
  • Verify that no errors appear in the JS console

Offline tests

QA Steps

n/a

  • 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
    • If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
      • 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 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 form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native
Android: mWeb Chrome

Screenshot_1721320082
Screenshot_1721320085

padding fix:
Screenshot_1721375601

iOS: Native

Simulator Screenshot - iPhone 15 Pro - 2024-07-19 at 10 49 16
Simulator Screenshot - iPhone 15 Pro - 2024-07-19 at 10 49 22

padding fix:
Simulator Screenshot - iPhone 15 Pro - 2024-07-19 at 09 47 03

iOS: mWeb Safari

Simulator Screenshot - iPhone 15 Pro - 2024-07-18 at 18 07 07
Simulator Screenshot - iPhone 15 Pro - 2024-07-18 at 18 07 42
Simulator Screenshot - iPhone 15 Pro - 2024-07-19 at 11 16 01
Simulator Screenshot - iPhone 15 Pro - 2024-07-19 at 11 18 15

padding fix:
Simulator Screenshot - iPhone 15 Pro - 2024-07-19 at 09 52 21

MacOS: Chrome / Safari

https://github.com/user-attachments/assets/d212e7e7-b42a-4d6a-bae0-30092fa18811
Screenshot 2024-07-18 at 17 39 13
Screenshot 2024-07-18 at 17 23 37
Screenshot 2024-07-18 at 17 23 25
Screenshot 2024-07-18 at 17 56 05

padding fix:
Screenshot 2024-07-19 at 09 57 08

MacOS: Desktop Screenshot 2024-07-18 at 18 01 23 Screenshot 2024-07-18 at 18 01 11 Screenshot 2024-07-18 at 18 01 00 Screenshot 2024-07-18 at 18 00 50

padding fix:
Screenshot 2024-07-19 at 09 58 21

@koko57
Copy link
Contributor Author

koko57 commented Jul 18, 2024

@shawnborton padding fixed:
Screenshot 2024-07-18 at 17 58 50

@shawnborton
Copy link
Contributor

Amazing - and just confirming that the modal uses 20px padding for mobile devices?

@koko57
Copy link
Contributor Author

koko57 commented Jul 18, 2024

@shawnborton yep, it now has the same styles as Workspace Empty page. I have some problems with building the app on mobile rn, so I can't make a screenshot. When I fix it I'll add one.

@shawnborton
Copy link
Contributor

Wonderful, thanks again!

@mountiny
Copy link
Contributor

@koko57 making a build so you can at least test android

@allgandalf @DylanDylann maybe you could test the native too and provide screenshots to unblock this?

Copy link
Contributor

@DylanDylann
Copy link
Contributor

I will take over this PR

@@ -1,3 +1,4 @@
import EmptyCardState from '@assets/images/emptystate__expensifycard.svg';
Copy link
Contributor

Choose a reason for hiding this comment

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

Comment to add reviewer

@shawnborton
Copy link
Contributor

The screenshots are looking great! Just one small thing here on mobile where I'm seeing a slight green line/border below the top modal image/illustration:
CleanShot 2024-07-19 at 08 54 37@2x

@koko57
Copy link
Contributor Author

koko57 commented Jul 19, 2024

@shawnborton I'm looking into it. Not sure if it is one of the reasons, but in the SVG the screenshot element is subtly overflowing the green background
Screenshot 2024-07-19 at 09 13 56

@shawnborton
Copy link
Contributor

Oh good catch on that... here is a new one to try, sorry for all of the different versions of this one. emptystate__expensifycard.svg.zip

@DylanDylann
Copy link
Contributor

Screenshots/Videos

Android: Native Screenshot 2024-07-19 at 15 38 13
Android: mWeb Chrome Screenshot 2024-07-19 at 15 39 06
iOS: Native Screenshot 2024-07-19 at 15 37 48
iOS: mWeb Safari Screenshot 2024-07-19 at 15 38 30
MacOS: Chrome / Safari Screenshot 2024-07-19 at 15 36 49
MacOS: Desktop Screenshot 2024-07-19 at 15 37 04

@DylanDylann
Copy link
Contributor

@koko57 It failed on native app

@koko57
Copy link
Contributor Author

koko57 commented Jul 19, 2024

@DylanDylann just pushed a fix for that - can you test on Android, please? I'm still having a problem with building for android, I have screenshots for iOS, will add them in a sec

@koko57
Copy link
Contributor Author

koko57 commented Jul 19, 2024

@shawnborton I've added the screenshots for padding fix for other platforms to the Author's Checklist

@koko57
Copy link
Contributor Author

koko57 commented Jul 19, 2024

@mountiny I'm still fighting with Andorid builds, should I open the PR anyway?

@DylanDylann
Copy link
Contributor

I will test this PR on Android. Feel free to open this PR

@koko57 koko57 marked this pull request as ready for review July 19, 2024 09:00
mountiny
mountiny previously approved these changes Jul 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.

Changes look good to me! @DylanDylann let us know when you are done, thanks

@DylanDylann
Copy link
Contributor

@koko57 I don't think we should use ScrollView in EmptyCardView Component. We should display the footer in the end of page

Screen.Recording.2024-07-22.at.13.58.35.mov

@shawnborton
Copy link
Contributor

I don't think we should use ScrollView in EmptyCardView Component. We should display the footer in the end of page

What we're doing in the video is on purpose though, we want to make the fine print show below the fold here.

@DylanDylann
Copy link
Contributor

@koko57 Please resolve conflict

@DylanDylann
Copy link
Contributor

DylanDylann commented Jul 22, 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
Screen.Recording.2024-07-22.at.14.38.30.mov
Android: mWeb Chrome
Screen.Recording.2024-07-22.at.14.33.20.mov
iOS: Native
Screen.Recording.2024-07-22.at.14.38.04.mov
iOS: mWeb Safari
Screen.Recording.2024-07-22.at.14.31.41.mov
MacOS: Chrome / Safari
Screen.Recording.2024-07-22.at.14.27.46.mov
MacOS: Desktop
Screen.Recording.2024-07-22.at.14.30.58.mov

@koko57
Copy link
Contributor Author

koko57 commented Jul 22, 2024

@DylanDylann conflicts resolved

@melvin-bot melvin-bot bot requested a review from mountiny July 22, 2024 07:39
@DylanDylann
Copy link
Contributor

@koko57 Lint error 😄

@koko57
Copy link
Contributor Author

koko57 commented Jul 22, 2024

@DylanDylann fixed

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.

Thanks, changes looking good, just waiting for a final design confirmation @shawnborton

@shawnborton
Copy link
Contributor

Looks good to me! The only minor thing I can spot - do we want a little more space below the buttons and above the empty state rows?
CleanShot 2024-07-22 at 16 50 58@2x

cc @Expensify/design for thoughts

@dannymcclain
Copy link
Contributor

Yeah I think the desktop spacing looks pretty good but I think the mobile/small viewports could benefit from a little extra space below the buttons. Not a HUGE deal, but a nice little polish.

@mountiny
Copy link
Contributor

Thanks, I think we can address that in the next design follow up as this is a larger PR to avoid conflicts, I will merge it now and link this to the design polish issue

@mountiny mountiny merged commit 146b847 into Expensify:main Jul 22, 2024
15 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
Copy link
Contributor

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

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

@OSBotify
Copy link
Contributor

🚀 Cherry-picked to staging by https://github.com/francoisl in version: 9.0.11-2 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/francoisl in version: 9.0.11-5 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/francoisl in version: 9.0.12-0 🚀

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

renderItem={renderItem}
ListHeaderComponent={WorkspaceCardListHeader}
/>
{!isEmptyObject(cardsList) ? (
Copy link
Contributor

Choose a reason for hiding this comment

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

@koko57 Please help to explain this line

As I understand, we display EmptyCardView if cardList í empty

Copy link
Contributor Author

@koko57 koko57 Aug 9, 2024

Choose a reason for hiding this comment

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

@DylanDylann yes, I did it probably bc I didn't want to remove mockedCard list in this PR. I'll tell Vicky (she's integrating BE with the cardList), to correct this condition

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@DylanDylann DylanDylann mentioned this pull request Aug 9, 2024
61 tasks
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