Skip to content

fix: incorrect next step message when approval mode enabled #57985

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

Merged
merged 4 commits into from
Apr 1, 2025

Conversation

daledah
Copy link
Contributor

@daledah daledah commented Mar 7, 2025

Explanation of Change

Fixed Issues

$ #57574
PROPOSAL: #57574 (comment)

Tests

  1. Add a member to WS
  2. Go to Workflows, disable Delayed submission, and change approver to the added member
  3. Go offline
  4. Go to expense chat and create a manual expense
  5. Open the expense report
  6. Verify that: The next step message shows "Waiting for .... to approve the expense(s)"
  • Verify that no errors appear in the JS console

Offline tests

QA Steps

  1. Add a member to WS
  2. Go to Workflows, disable Delayed submission, and change approver to the added member
  3. Go offline
  4. Go to expense chat and create a manual expense
  5. Open the expense report
  6. Verify that: The next step message shows "Waiting for .... to approve the expense(s)"
  • 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 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 used JaimeGPT to get English > Spanish translation. I then posted it 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.ts 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.
  • I added unit tests for any new feature or bug fix in this PR to help automatically prevent regressions in this user flow.
  • 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
Screen.Recording.2025-03-07.at.14.06.22.mov
Android: mWeb Chrome
Screen.Recording.2025-03-07.at.14.07.31.mov
iOS: Native
Screen.Recording.2025-03-07.at.14.08.49.mov
iOS: mWeb Safari
Screen.Recording.2025-03-07.at.14.11.07.mov
MacOS: Chrome / Safari
Screen.Recording.2025-03-07.at.14.12.44.mov
MacOS: Desktop
Screen.Recording.2025-03-07.at.14.13.52.mov

@daledah daledah marked this pull request as ready for review March 7, 2025 07:54
@daledah daledah requested a review from a team as a code owner March 7, 2025 07:54
@melvin-bot melvin-bot bot requested review from suneox and removed request for a team March 7, 2025 07:54
Copy link

melvin-bot bot commented Mar 7, 2025

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

@suneox
Copy link
Contributor

suneox commented Mar 10, 2025

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 that the composer does not automatically focus or open the keyboard on mobile unless explicitly intended. This includes checking that returning the app from the background does not unexpectedly open the keyboard.
  • 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 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.ts 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.
  • For any bug fix or new feature in this PR, I verified that sufficient unit tests are included to prevent regressions in this flow.
  • 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.2025-03-10.at.13.06.46.mp4
Android: mWeb Chrome
Screen.Recording.2025-03-10.at.13.06.46.mp4
iOS: Native
Screen.Recording.2025-03-10.at.13.00.15.mp4
iOS: mWeb Safari
Screen.Recording.2025-03-10.at.12.53.58.mp4
MacOS: Chrome / Safari
Screen.Recording.2025-03-09.at.22.46.04.mp4

Advance approval

Screen.Recording.2025-03-10.at.13.30.15.mov
MacOS: Desktop
Screen.Recording.2025-03-10.at.12.50.08.mp4

@@ -578,6 +578,38 @@ describe('libs/NextStepUtils', () => {
expect(result).toMatchObject(optimisticNextStep);
});
});

test('approval mode enabled', () => {
Copy link
Contributor

Choose a reason for hiding this comment

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

Could you please add more test case for advance approval mode?

@daledah
Copy link
Contributor Author

daledah commented Mar 11, 2025

@suneox I discovered a bug while adding the test: The next to approve is oneself but the message shows other:

Screenshot 2025-03-11 at 18 45 16

I'll investigate and update soon.

@suneox
Copy link
Contributor

suneox commented Mar 11, 2025

@suneox I discovered a bug while adding the test: The next to approve is oneself but the message shows other:

Note to test the advanced approval flow.

Screen.Recording.2025-03-10.at.13.30.15.mov

@daledah
Copy link
Contributor Author

daledah commented Mar 14, 2025

I'm still investigating, will update today.

@daledah
Copy link
Contributor Author

daledah commented Mar 17, 2025

@suneox

Sorry for the delay. After some lookups and testings, seems like the bug is from another flow not related to changes in this issue. BE also send incorrect next step data

Screenshot 2025-03-17 at 09 19 09

So I believe it's out of scope and we should address the bug in another issue.

@suneox
Copy link
Contributor

suneox commented Mar 17, 2025

@daledah Could you please provide the steps to reproduce this case? I’ve tested it, and both the basic and advanced approval flows are working as expected in my screenshot/video checklist. And could you please merge with the latest main branch? I’ll verify it again.

@daledah
Copy link
Contributor Author

daledah commented Mar 17, 2025

@suneox Here are the steps:

  1. Invite an admin to WS
  2. In workflows, click on default approval flow
  3. Click on Additional approver, select the invited admin
  4. Go to WS chat, create an expense and submit it

Expected: Next step should be "Waiting for you to approve approve expense(s)", because there's an "approve" button.
Actual: Next step is "Waiting for other admin to approve expense(s)"

@suneox
Copy link
Contributor

suneox commented Mar 17, 2025

@suneox Here are the steps:

  1. Invite an admin to WS
  2. In workflows, click on default approval flow
  3. Click on Additional approver, select the invited admin
  4. Go to WS chat, create an expense and submit it

@daledah Could you please provide more details about which member is involved at step 3 when the following members submit expenses?

Expected: Next step should be "Waiting for you to approve approve expense(s)", because there's an "approve" button. Actual: Next step is "Waiting for other admin to approve expense(s)"

Based on your expected result, it looks incorrect because, at step 3: select the invited admin, so the next step should refer to the invited admin instead of you.

@daledah
Copy link
Contributor Author

daledah commented Mar 18, 2025

@suneox In a multi-approver flow like this one:

Screenshot 2025-03-18 at 14 15 57

User who submit expense will be approved by da, then approved by Daledah. The same happens if da submits expense.

However when da submits, Approve button shows up (correct behavior), but next step says Daledah to approve next:

Screenshot 2025-03-18 at 14 18 15

@suneox
Copy link
Contributor

suneox commented Mar 26, 2025

@suneox In a multi-approver flow like this one:

I can’t reproduce on the latest main, so we can go ahead with this change. @daledah could you please add a unit test for the advanced approval flow case?

@daledah
Copy link
Contributor Author

daledah commented Mar 28, 2025

@suneox Sorry for the delay, I'll udpate soon.

@daledah
Copy link
Contributor Author

daledah commented Mar 31, 2025

@suneox I updated.

Copy link
Contributor

@suneox suneox left a comment

Choose a reason for hiding this comment

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

Works as expected after merging latest main

Screen.Recording.2025-04-01.at.21.54.05.mp4

@melvin-bot melvin-bot bot requested a review from robertjchen April 1, 2025 15:22
Copy link
Contributor

@robertjchen robertjchen left a comment

Choose a reason for hiding this comment

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

Perfect, thanks!

@robertjchen robertjchen merged commit 62360e1 into Expensify:main Apr 1, 2025
17 checks passed
@OSBotify
Copy link
Contributor

OSBotify commented Apr 1, 2025

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

Copy link
Contributor

github-actions bot commented Apr 3, 2025

🚀 Deployed to staging by https://github.com/robertjchen in version: 9.1.23-1 🚀

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

Copy link
Contributor

github-actions bot commented Apr 7, 2025

🚀 Deployed to production by https://github.com/jasperhuangg in version: 9.1.23-7 🚀

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