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

#45951 & #45958: Implement <ApprovalWorkflowSection /> component and Enhance toLocaleOrdinal to support string ordinals #46562

Conversation

Guccio163
Copy link
Contributor

@Guccio163 Guccio163 commented Jul 31, 2024

Details

This PR adds a view of more than the default approval workflows; The buttons should be presable, but their functionalities are yet to be implemented. This PR is UI-focused.

UI with enabled canUseWorkflowsAdvancedApproval should look like this:
Screenshot 2024-07-31 at 13 58 58

Meanwhile, account without canUseWorkflowsAdvancedApproval permission should remain unchanged:
Screenshot 2024-07-31 at 14 01 58

Fixed Issues

$ #45951
$ #45958
PROPOSAL:

Tests

  1. Right now, canUseWorkflowsAdvancedApproval permission is switched off, to see the new layout, make function src/libs/Permissions.tsx/canUseWorkflowsAdvancedApproval return true.

  2. Open WorkspaceWorkflowPage.tsx and check if page looks like this:

Screenshot 2024-07-31 at 13 58 58
  1. Check if every section redirects to ROUTES.WORKSPACE_WORKFLOWS_APPROVALS_EDIT

  2. Add approvals button's update involved only UI, it's functionality will be added in [CRITICAL] [Advanced Approval Workflows] Implement <WorkspaceWorkflowsApprovalsCreatePage /> for Workflow Creation #45954

  • Verify that no errors appear in the JS console

Offline tests

N/A

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: 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
android.mov
Android: mWeb Chrome
mWeb-android.mov
iOS: Native
ios.mov
iOS: mWeb Safari
mWeb-ios.mov
MacOS: Chrome / Safari
web.mov
MacOS: Desktop
desktop.mov

src/components/Temp.tsx Outdated Show resolved Hide resolved
src/components/ApprovalWorkflowSection.tsx Outdated Show resolved Hide resolved
src/components/ApprovalWorkflowSection.tsx Outdated Show resolved Hide resolved
@Guccio163 Guccio163 changed the title #45951 Implement <ApprovalWorkflowSection /> component #45951 Implement <ApprovalWorkflowSection /> component and Enhance toLocaleOrdinal to support string ordinals Jul 31, 2024
@Guccio163 Guccio163 changed the title #45951 Implement <ApprovalWorkflowSection /> component and Enhance toLocaleOrdinal to support string ordinals #45951 & #45958: Implement <ApprovalWorkflowSection /> component and Enhance toLocaleOrdinal to support string ordinals Jul 31, 2024
@Guccio163
Copy link
Contributor Author

In videos you can see that all approvers are with their order prefix, even if there is only 1 approver; I just fixed it, just didn't update the videos:
Screenshot 2024-07-31 at 15 59 09

@Guccio163
Copy link
Contributor Author

PR is ready for review from C+; I'm OOO until the end of the week, so any change before that will be handled by @blazejkustra, good luck!👋

@Guccio163 Guccio163 marked this pull request as ready for review July 31, 2024 14:18
@Guccio163 Guccio163 requested review from a team as code owners July 31, 2024 14:18
@melvin-bot melvin-bot bot requested review from shubham1206agra and removed request for a team July 31, 2024 14:18
Copy link

melvin-bot bot commented Jul 31, 2024

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

@shubham1206agra
Copy link
Contributor

@blazejkustra @Guccio163 One question.

Does #45892 help improve this PR in some way?

@Guccio163
Copy link
Contributor Author

@shubham1206agra function from #45892 is directly used by this PR, we decided to link them together to speed up the process and not to block the #45951

@@ -0,0 +1,10 @@
<?xml version="1.0" encoding="utf-8"?>
<svg version="1.1" id="Layer_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
Copy link
Contributor

Choose a reason for hiding this comment

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

Hmm. This looks wrong.

Copy link
Contributor

Choose a reason for hiding this comment

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

What exactly? @shubham1206agra

Copy link
Contributor

Choose a reason for hiding this comment

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

I used what @shawnborton sent here

Copy link
Contributor

Choose a reason for hiding this comment

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

Try this one, that's my fault: user-check 2.svg.zip

Copy link
Contributor

Choose a reason for hiding this comment

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

Thanks! It's changed @shubham1206agra

@blazejkustra
Copy link
Contributor

@shubham1206agra I merged the newest main for you 🚀

@shubham1206agra
Copy link
Contributor

@blazejkustra I am getting this error on toggling Approval section.

{
    "jsonCode": 404,
    "message": "404 Account not found",
    "onyxData": [],
    "requestID": "8acf33b07bc959b2-DEL"
}


{approvalWorkflow.approvers.map((approver, index) => (
<View key={approver.email}>
<View style={{height: 16, width: 1, backgroundColor: theme.border, marginLeft: 19}} />
Copy link
Contributor

@shubham1206agra shubham1206agra Aug 2, 2024

Choose a reason for hiding this comment

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

@blazejkustra Can you please explain me the choice of style here (especially marginLeft)? And can we use styles here.

Copy link
Contributor

Choose a reason for hiding this comment

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

These are the styles for the vertical line from the screenshot:
image

I moved the styles as requested 👌

Copy link
Contributor

@blazejkustra blazejkustra Aug 2, 2024

Choose a reason for hiding this comment

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

marginLeft is set to 19 to match the designs @shubham1206agra:
image

@blazejkustra
Copy link
Contributor

@blazejkustra I am getting this error on toggling Approval section.

{
    "jsonCode": 404,
    "message": "404 Account not found",
    "onyxData": [],
    "requestID": "8acf33b07bc959b2-DEL"
}

Is this connected to this PR? 🤔

@shawnborton
Copy link
Contributor

It looks like we aren't using a selected BG color for the selected approver. Is that something we are working on in this PR? Or should we handle that elsewhere?
CleanShot 2024-08-02 at 13 50 24@2x

@shawnborton
Copy link
Contributor

This is generally feeling good. cc @Expensify/design - I added you both to the beta in case you want to test the adhoc build above. You might need to clear cache from Settings > Troubleshoot.

Just confirming, do we want to truncate after two lines here? cc @JmillsExpensify
CleanShot 2024-08-02 at 13 55 01@2x

@blazejkustra
Copy link
Contributor

It looks like we aren't using a selected BG color for the selected approver. Is that something we are working on in this PR? Or should we handle that elsewhere?

The screen you are seeing is still the old Approver screen, meaning it will be handled in a future PR. Although, I thought it should be highligthed only when hovering over the item like in other selection lists in the app:

Screen.Recording.2024-08-02.at.20.05.48.mov

Is using a selected BG color for the selected approver a novelty in the app or is it used somewhere? @shawnborton

@shubham1206agra
Copy link
Contributor

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-08-05 at 3 23 12 PM
Android: mWeb Chrome Screenshot 2024-08-05 at 11 24 35 AM
iOS: Native Screenshot 2024-08-05 at 2 56 26 PM
iOS: mWeb Safari Screenshot 2024-08-05 at 11 01 51 AM
MacOS: Chrome / Safari Screenshot 2024-08-05 at 10 59 47 AM
MacOS: Desktop Screenshot 2024-08-05 at 2 47 12 PM

@melvin-bot melvin-bot bot requested a review from tgolen August 5, 2024 09:58
import Text from './Text';

type ApprovalWorkflowSectionProps = {
approvalWorkflow: ApprovalWorkflow;
Copy link
Contributor

Choose a reason for hiding this comment

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

Please add /** */ style comments to each prop

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Just added, please take a quick look if they're okay :)

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.

Thank you!

@tgolen tgolen merged commit 02d0d61 into Expensify:main Aug 5, 2024
15 checks passed
@OSBotify
Copy link
Contributor

OSBotify commented Aug 5, 2024

✋ 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

OSBotify commented Aug 6, 2024

🚀 Deployed to staging by https://github.com/tgolen in version: 9.0.17-0 🚀

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

@OSBotify
Copy link
Contributor

OSBotify commented Aug 7, 2024

🚀 Deployed to production by https://github.com/marcaaron in version: 9.0.17-2 🚀

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

2 similar comments
@OSBotify
Copy link
Contributor

OSBotify commented Aug 8, 2024

🚀 Deployed to production by https://github.com/marcaaron in version: 9.0.17-2 🚀

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

@OSBotify
Copy link
Contributor

OSBotify commented Aug 8, 2024

🚀 Deployed to production by https://github.com/marcaaron in version: 9.0.17-2 🚀

platform result
🤖 android 🤖 failure ❌
🖥 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.

7 participants