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

[CRITICAL] Implement <WorkspaceWorkflowsApprovalsExpensesFromPage /> for Member Selection #46484

Merged

Conversation

blazejkustra
Copy link
Contributor

@blazejkustra blazejkustra commented Jul 30, 2024

Details

Link to the doc.

Approval member page is going to be a page with a header and (multi select variant) with a save button.
image

Clicking on the next button will set the members with setApprovalWorkflowMembers action (more info in the Onyx setup section). Users will be navigated to the Approver selection page (‘settings/workspaces/:policyID/workflows/approvals/approver’) when creating a new approval workflow or navigated to the ‘Edit approval’ page (‘settings/workspaces/:policyID/workflows/approvals/:firstApproverEmail/edit’) based on isBeingEdited property in Onyx.

Fixed Issues

$ #45955
PROPOSAL: N/A

Tests

  • Open Workflows page (it has to be turned on in More features settings page)
  • Locally edit canUseWorkflowsAdvancedApproval function to return true (or use canUseWorkflowsAdvancedApproval beta)
  • Click on the 'Add approval workflow' button, it should navigate to 'Expenses from' page
  • Verify that Expenses From page functions as other selection list (good example is Workspace invite screen)
    • "Find a member" input should filter users
    • You can select and deselect people in the list properly
  • Next button should navigate to the approver page

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

@blazejkustra blazejkustra changed the title Approval workflows/expenses from [CRITICAL] Implement <WorkspaceWorkflowsApprovalsExpensesFromPage /> for Member Selection Jul 30, 2024
Copy link
Contributor

@Guccio163 Guccio163 left a comment

Choose a reason for hiding this comment

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

LGTM 🙌

@@ -1291,6 +1291,7 @@ export default {
},
workflowsExpensesFromPage: {
title: 'Gastos de',
header: 'Cuando los siguientes miembros presenten gastos:',
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Translation already approved here

@blazejkustra blazejkustra marked this pull request as ready for review July 30, 2024 12:37
@blazejkustra blazejkustra requested a review from a team as a code owner July 30, 2024 12:37
@melvin-bot melvin-bot bot requested review from thesahindia and removed request for a team July 30, 2024 12:37
Copy link

melvin-bot bot commented Jul 30, 2024

@thesahindia 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
Copy link
Contributor Author

@thesahindia I would appreciate a quick review on this one, as Approval Workflow project has a tight deadline (Aug 15)

@thesahindia
Copy link
Member

We need to fix this error.

Screenshot 2024-07-30 at 7 24 02 PM

@thesahindia
Copy link
Member

After selecting the admin and clicking "Next", when we come back the "Admin" badge goes away.

Screen.Recording.2024-07-30.at.9.56.12.PM.mov

Shouldn't we dismiss the modal after the user selects an approver instead of navigating back to "Expenses from" page?

Screen.Recording.2024-07-30.at.9.54.25.PM.mov

@blazejkustra
Copy link
Contributor Author

After selecting the admin and clicking "Next", when we come back the "Admin" badge goes away.

On it!

Shouldn't we dismiss the modal after the user selects an approver instead of navigating back to "Expenses from" page?

It will be covered in the next PR here, so I wouldn't block this PR because of it. (Add approval button is behind a beta so shouldn't be a problem).

@blazejkustra
Copy link
Contributor Author

We need to fix this error.

Screenshot 2024-07-30 at 7 24 02 PM

I don't see it, can you add reproduction steps? (make sure you have the newest changes)

@thesahindia
Copy link
Member

We need to fix this error.

Screenshot 2024-07-30 at 7 24 02 PM

I don't see it, can you add reproduction steps? (make sure you have the newest changes)

It was fixed after the new changes.

@blazejkustra
Copy link
Contributor Author

After selecting the admin and clicking "Next", when we come back the "Admin" badge goes away.

@thesahindia Fixed!

@thesahindia
Copy link
Member

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-31.at.10.09.58.PM.mov
Android: mWeb Chrome
Screen.Recording.2024-07-31.at.9.49.10.PM.mov
iOS: Native
Screen.Recording.2024-07-31.at.10.16.35.PM.mov
iOS: mWeb Safari
Screen.Recording.2024-07-31.at.10.17.49.PM.mov
MacOS: Chrome / Safari
Screen.Recording.2024-07-31.at.9.19.50.PM.mov
MacOS: Desktop
Screen.Recording.2024-07-31.at.10.19.40.PM.mov

Copy link
Member

@thesahindia thesahindia left a comment

Choose a reason for hiding this comment

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

👍🏼

@melvin-bot melvin-bot bot requested a review from tgolen July 31, 2024 16:53
Copy link
Contributor

@tgolen tgolen left a comment

Choose a reason for hiding this comment

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

Looking good!

@tgolen tgolen merged commit c425f7c into Expensify:main Jul 31, 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/tgolen in version: 9.0.15-0 🚀

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

@kavimuru
Copy link

@tgolen @thesahindia How should we run this step?

Locally edit canUseWorkflowsAdvancedApproval function to return true (or use canUseWorkflowsAdvancedApproval beta)

@tgolen
Copy link
Contributor

tgolen commented Jul 31, 2024

I don't think this one is QA-able yet. Since it's under beta, the testing will come later. Sorry for the confusion! You can just mark this one off the deploy checklist.

@OSBotify
Copy link
Contributor

OSBotify commented Aug 2, 2024

🚀 Deployed to production by https://github.com/roryabraham in version: 9.0.15-9 🚀

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

Comment on lines +140 to +145
const goBack = useCallback(() => {
if (!approvalWorkflow?.isBeingEdited) {
Workflow.clearApprovalWorkflow();
}
Navigation.goBack();
}, [approvalWorkflow?.isBeingEdited]);
Copy link
Contributor

Choose a reason for hiding this comment

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

Clearing the approval workflow on going back caused the not found view to appear briefly while hiding the modal (#50094). Also this goBack function is not called if we dismiss the modal on outside-click.

We went with a different approach that is to clear the workflow (from WorkspaceWorkflowsPage) before navigating to this page.

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.

7 participants