[Advanced Approval Workflows] Display empty state when the member list is empty #47848

blazejkustra · 2024-08-22T09:42:41Z

Details

#47848 (comment)

Fixed Issues

$ #47700
PROPOSAL: N/A

Tests

Add all workspace members to a workflow, save it
Click on 'create new workflow' button
Verify that screen with "No members to display" is displayed

Add all workspace members to a workflow as approvers
Try to add another approver, verify that screen with "No members to display" is displayed

Offline tests

N/A

QA Steps

Same as tests

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

Screenshots/Videos

Android: Native

android.webm

Android: mWeb Chrome

android-web.webm

iOS: Native

ios.mp4

iOS: mWeb Safari

ios-web.mp4

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

melvin-bot · 2024-08-22T14:31:27Z

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

blazejkustra · 2024-08-23T13:25:11Z

@Expensify/design Please verify that it looks good to you 😄

DylanDylann · 2024-08-25T11:20:39Z

@blazejkustra Also apply this change to approver page

Screen.Recording.2024-08-25.at.18.20.06.mov

src/pages/workspace/workflows/approvals/WorkspaceWorkflowsApprovalsExpensesFromPage.tsx

blazejkustra · 2024-08-26T17:13:55Z

This is what I landed on @DylanDylann:

Screen.Recording.2024-08-26.at.19.08.25.mov

Also apply this change to approver page

I don't think we should display "Nice job! All workspace members belong to an approval workflow.", this might be misleading when selecting an approver. I see two options going forward and I lean to the latter:

Prepare new copy for approver screen
Do nothing for now, "No results found" is good enough

cc @JmillsExpensify

dannymcclain · 2024-08-27T15:13:54Z

Alright coming from this convo in Slack, we've decided to use our standard empty states for these. Here's a mock of the Expenses from and Approver empty states:

And here is the illustration: Turtle in Shell.svg.zip

blazejkustra · 2024-08-28T17:15:56Z

@DylanDylann Ready for review 👀

src/languages/es.ts

DylanDylann · 2024-08-29T04:07:17Z

src/pages/workspace/workflows/approvals/WorkspaceWorkflowsApprovalsExpensesFromPage.tsx

-                onSubmit={nextStep}
+                isDisabled={!shouldShowListEmptyContent && !selectedMembers.length}
+                buttonText={buttonText}
+                onSubmit={shouldShowListEmptyContent ? () => Navigation.goBack() : nextStep}


@blazejkustra Should apply this to approver list page

Actually no, we should always use nextStep handler for approver list page. There is an edge case where you want to remove an approver who is in circular reference, you can change the code and try it 😄

There is an edge case where you want to remove an approver who is in circular reference

The circular reference isn't allowed on Newdot. So I am not sure your mean

Could you help to clear your edge case?

@blazejkustra Could you check above comment?

Sure, let me post a video in a sec

In the editor you can create a workflow with circular reference (you can't save it, but you can get to this state).

Try to remove this duplicated approver and make sure there are no other approvers to choose from:

Once your approver is unchecked, empty state is displayed:

Clicking on got it has to trigger nextStep function in oder to call Workflow.clearApprovalWorkflowApprover(approverIndex) function

Here is the video:

Screen.Recording.2024-08-30.at.12.40.28.mov

Thanks for your explanation

DylanDylann · 2024-08-29T04:32:33Z

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-08-29.at.11.30.23.mov

Android: mWeb Chrome

Screen.Recording.2024-08-29.at.11.29.24.mov

iOS: Native

Screen.Recording.2024-08-29.at.11.29.05.mov

iOS: mWeb Safari

Screen.Recording.2024-08-29.at.11.28.26.mov

MacOS: Chrome / Safari

Screen.Recording.2024-08-29.at.11.18.38.mov

MacOS: Desktop

Screen.Recording.2024-08-29.at.11.21.03.mov

shawnborton · 2024-08-30T11:17:24Z

For this empty state here:

Do we want the text part under the headline to use our textSupporting color? I feel like I've seen us take both approaches, but wanted to doublecheck what is expected. cc @Expensify/design for confirmation there.

blazejkustra · 2024-08-30T12:36:15Z

@dannymcclain @shawnborton FYI, looking at the code most of the "empty states" have the default color instead of textSupporting one. I'm open to changing it to whatever you think is better 😄

shawnborton · 2024-08-30T12:42:34Z

I have a feeling @dannymcclain is going to want to change it to textSupporting, let's wait and see what he says though!

dannymcclain · 2024-08-30T13:19:40Z

I have a feeling @dannymcclain is going to want to change it to textSupporting, let's wait and see what he says though!

You're feeling is correct! 😁 All of the empty states should use text for the headline and textSupporting for the body text (not just here but everywhere).

melvin-bot · 2024-08-30T14:13:12Z

We did not find an internal engineer to review this PR, trying to assign a random engineer to #47700 as well as to this PR... Please reach out for help on Slack if no one gets assigned!

DylanDylann · 2024-08-30T14:14:21Z

@blazejkustra Please help to address this comment #47848 (comment)

blazejkustra · 2024-08-30T15:21:44Z

not just here but everywhere

@dannymcclain should we create a new issue to change it everywhere?

blazejkustra · 2024-08-30T15:28:35Z

Adjusted 👌

cc @DylanDylann

jasperhuangg · 2024-08-30T23:32:57Z

Code looks good to me! Gonna leave it for @shawnborton and @dannymcclain to approve the design changes before merging.

dubielzyk-expensify

Looks from Slack that we want this in early, so I'll go ahead and approve :D

blazejkustra · 2024-09-02T08:45:13Z

Back to you @jasperhuangg

OSBotify · 2024-09-03T00:10:59Z

✋ 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 · 2024-09-03T23:42:50Z

🚀 Deployed to staging by https://github.com/jasperhuangg in version: 9.0.29-0 🚀

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

OSBotify · 2024-09-05T19:16:50Z

🚀 Deployed to production by https://github.com/roryabraham in version: 9.0.29-12 🚀

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

blazejkustra added 2 commits August 22, 2024 11:42

Display empty state when the member list is empty

e373048

Fix lint

d7ecdfb

blazejkustra changed the title ~~Display empty state when the member list is empty~~ [Advanced Approval Workflows] Display empty state when the member list is empty Aug 22, 2024

Clean the code

09222b7

blazejkustra marked this pull request as ready for review August 22, 2024 14:31

blazejkustra requested a review from a team as a code owner August 22, 2024 14:31

melvin-bot bot requested review from DylanDylann and removed request for a team August 22, 2024 14:31

Update translation

3a3cac2

blazejkustra mentioned this pull request Aug 22, 2024

[$250] [Advanced Approval Workflows] Should display empty state when the member list is empty #47700

Closed

DylanDylann reviewed Aug 25, 2024

View reviewed changes

src/pages/workspace/workflows/approvals/WorkspaceWorkflowsApprovalsExpensesFromPage.tsx Outdated Show resolved Hide resolved

src/pages/workspace/workflows/approvals/WorkspaceWorkflowsApprovalsExpensesFromPage.tsx Outdated Show resolved Hide resolved

Improve empty state

465bab0

This comment was marked as outdated.

Sign in to view

blazejkustra added 5 commits August 28, 2024 18:10

Merge branch 'main' into approval-workflows/display-empty-state

683a892

Update translations

e4bdec1

Add turtle in shell icon

f624b1c

Add empty content view for expenses from page

6c3f4c9

Add empty content view for approver page

4db199f

blazejkustra requested a review from a team as a code owner August 28, 2024 17:05

blazejkustra added 2 commits August 28, 2024 19:09

Fix es translations

eed5c85

Fix the case when removing an approver that is in circular reference

c1ce3ba

blazejkustra requested a review from DylanDylann August 28, 2024 17:16

blazejkustra commented Aug 28, 2024

View reviewed changes

src/languages/es.ts Show resolved Hide resolved

DylanDylann reviewed Aug 29, 2024

View reviewed changes

blazejkustra requested a review from DylanDylann August 30, 2024 10:49

Merge branch 'main' into approval-workflows/display-empty-state

68963bf

DylanDylann approved these changes Aug 30, 2024

View reviewed changes

Use a different style for subtitle

203cc5f

DylanDylann approved these changes Aug 30, 2024

View reviewed changes

melvin-bot bot requested a review from jasperhuangg August 30, 2024 15:32

jasperhuangg approved these changes Aug 30, 2024

View reviewed changes

dubielzyk-expensify approved these changes Sep 1, 2024

View reviewed changes

jasperhuangg merged commit 72add22 into Expensify:main Sep 2, 2024
17 checks passed

github-actions bot mentioned this pull request Sep 3, 2024

Deploy Checklist: New Expensify 2024-09-03 #48515

Closed

68 tasks

bernhardoj mentioned this pull request Sep 4, 2024

[HOLD for payment 2024-09-16] [$125] Advanced approvals - Left and right side of the empty state image is cut off #48531

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Advanced Approval Workflows] Display empty state when the member list is empty #47848

[Advanced Approval Workflows] Display empty state when the member list is empty #47848

blazejkustra commented Aug 22, 2024 •

edited

Loading

melvin-bot bot commented Aug 22, 2024

blazejkustra commented Aug 23, 2024

DylanDylann commented Aug 25, 2024

blazejkustra commented Aug 26, 2024

This comment was marked as outdated.

dannymcclain commented Aug 27, 2024

blazejkustra commented Aug 28, 2024

DylanDylann Aug 29, 2024

blazejkustra Aug 29, 2024

DylanDylann Aug 29, 2024

DylanDylann Aug 30, 2024

blazejkustra Aug 30, 2024

blazejkustra Aug 30, 2024

DylanDylann Aug 30, 2024

DylanDylann commented Aug 29, 2024 •

edited

Loading

shawnborton commented Aug 30, 2024

blazejkustra commented Aug 30, 2024

shawnborton commented Aug 30, 2024

dannymcclain commented Aug 30, 2024

melvin-bot bot commented Aug 30, 2024

DylanDylann commented Aug 30, 2024

blazejkustra commented Aug 30, 2024

blazejkustra commented Aug 30, 2024

jasperhuangg commented Aug 30, 2024

dubielzyk-expensify left a comment

blazejkustra commented Sep 2, 2024

OSBotify commented Sep 3, 2024

OSBotify commented Sep 3, 2024

OSBotify commented Sep 5, 2024

[Advanced Approval Workflows] Display empty state when the member list is empty #47848

[Advanced Approval Workflows] Display empty state when the member list is empty #47848

Conversation

blazejkustra commented Aug 22, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Aug 22, 2024

blazejkustra commented Aug 23, 2024

DylanDylann commented Aug 25, 2024

blazejkustra commented Aug 26, 2024

This comment was marked as outdated.

dannymcclain commented Aug 27, 2024

blazejkustra commented Aug 28, 2024

DylanDylann Aug 29, 2024

Choose a reason for hiding this comment

blazejkustra Aug 29, 2024

Choose a reason for hiding this comment

DylanDylann Aug 29, 2024

Choose a reason for hiding this comment

DylanDylann Aug 30, 2024

Choose a reason for hiding this comment

blazejkustra Aug 30, 2024

Choose a reason for hiding this comment

blazejkustra Aug 30, 2024

Choose a reason for hiding this comment

DylanDylann Aug 30, 2024

Choose a reason for hiding this comment

DylanDylann commented Aug 29, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

shawnborton commented Aug 30, 2024

blazejkustra commented Aug 30, 2024

shawnborton commented Aug 30, 2024

dannymcclain commented Aug 30, 2024

melvin-bot bot commented Aug 30, 2024

DylanDylann commented Aug 30, 2024

blazejkustra commented Aug 30, 2024

blazejkustra commented Aug 30, 2024

jasperhuangg commented Aug 30, 2024

dubielzyk-expensify left a comment

Choose a reason for hiding this comment

blazejkustra commented Sep 2, 2024

OSBotify commented Sep 3, 2024

OSBotify commented Sep 3, 2024

OSBotify commented Sep 5, 2024

blazejkustra commented Aug 22, 2024 •

edited

Loading

DylanDylann commented Aug 29, 2024 •

edited

Loading