[No QA][CRITICAL] [Advanced Approval Workflows] Implement Onyx Actions (API calls & Onyx writes) #46189

blazejkustra · 2024-07-25T13:15:35Z

Details

libs/actions/Workflow.ts (from the design doc's detailed section)

createApprovalWorkflow - takes a list of member’s emails, approvers and uses API.write with CreateWorkspaceApproval command to create an approval workflow on the backend.
updateApprovalWorkflow - takes a list of member’s emails, approvers and uses API.write with UpdateWorkspaceApproval command to edit an existing approval workflow on the backend.
removeApprovalWorkflow - takes a list of member’s emails and uses API.write with RemoveWorkspaceApproval command to remove existing approval workflow on the backend.
setApprovalWorkflowMembers - takes a list of emails and sets them under ONYXKEYS.APPROVAL_WORKFLOW key (ApprovalWorkflow[‘members’]).
setApprovalWorkflowApprover - takes an index (0 for 1st approver, 1 for 2nd, etc.) and approver’s email, forwardsTo and sets it under ONYXKEYS.APPROVAL_WORKFLOW key (ApprovalWorkflow[‘approvers’][index]).
setApprovalWorkflow - takes the whole ApprovalWorkflow object and saves it under the ONYXKEYS.APPROVAL_WORKFLOW key.
clearApprovalWorkflow - clears the ApprovalWorkflow object under the ONYXKEYS.APPROVAL_WORKFLOW key.

Fixed Issues

$ #45959
PROPOSAL: N/A

Tests

N/A

Offline tests

N/A

QA Steps

N/A

PR Author Checklist

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

…kflows/onyx-setup

melvin-bot · 2024-07-25T15:15:34Z

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

tgolen

Do you happen to know if policy change logs get created optimistically and are posted to the workspace #admins room? Or do we just want for the server to send out the change logs via pusher?

src/libs/API/parameters/WorkspaceApprovalParams.ts

tgolen · 2024-07-25T16:01:20Z

src/libs/actions/Workflow.ts

+});
+
+function createApprovalWorkflow(policyID: string, approvalWorkflow: ApprovalWorkflow) {
+    const authToken = NetworkStore.getAuthToken();


getAuthToken() is a new method for me. I think this file should use Onyx.connect() and grab the authToken from the SESSION onyx key. Again, maybe there was a good reason for this change that I didn't know about.

Typically, people have proposed using singletons like this because of a perception that having lots of Onyx.connect() for the same key is bad for performance. Yet, I haven't ever seen evidence of this problem and I always direct people to keep using Onyx.connect().

The downsides to singletons is that they end up being used in react components to get Onyx data, which results in the component not being "reactive" to data changes at all. So, if we use singletons, we must be sure to only use them in lib code, and only when there is a good and clear reason to use them.

You can see in #27262 the big effort that I had to go through to fix a lot of those bad patterns.

Thanks for the context, I looked for authToken in other actions and saw this pattern that's I went for it. Changing it to Onyx.connect 😄

tgolen · 2024-07-25T16:08:13Z

src/libs/actions/Workflow.ts

+        {
+            onyxMethod: Onyx.METHOD.MERGE,
+            key: `${ONYXKEYS.COLLECTION.POLICY}${policyID}`,
+            value: {employeeList},


There is something else you need to add to this (I'm not sure if you're planning to implement it later or not).

When the first workflow is added, the policy.approvalMode will switch from BASIC to ADVANCED.

When the last workflow is removed, the policy.approvalMode will switch from ADVANCED to BASIC.

I knew I forgot about something, thanks. Just updated the logic

JmillsExpensify · 2024-07-25T18:13:20Z

@mananjadhav I believe we decided we don't require your review on this one, so mainly a heads up!

…kflows/onyx-setup

tgolen · 2024-07-26T12:54:46Z

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

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

OSBotify · 2024-07-29T19:31:38Z

🚀 Cherry-picked to staging by https://github.com/roryabraham in version: 9.0.14-1 🚀

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

OSBotify · 2024-07-31T19:41:32Z

🚀 Deployed to production by https://github.com/roryabraham in version: 9.0.14-6 🚀

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

s77rt · 2024-11-06T08:58:40Z

src/libs/actions/Workflow.ts

+    const successData: OnyxUpdate[] = [
+        {
+            onyxMethod: Onyx.METHOD.SET,
+            key: ONYXKEYS.APPROVAL_WORKFLOW,
+            value: null,
+        },
+    ];


Clearing this workflow should have been done in the optimisticData because the data is no longer needed as soon as the form is submitted.

Also clearing this in successData caused a bug if you submit the form offline and go back to the workflow page and get online. The page will suddenly becomes blank (#51468).

blazejkustra added 17 commits July 23, 2024 19:35

Add ApprovalWorkflow Onyx types

37e8cc5

Implement functions that transform the data back and forth

8a316a5

Start working on tests for WorkflowUtils

ed067de

Add getApprovalWorkflowApprovers tests

b47115f

Add a cases where user forwards to themselfs

a98914d

Add tests for convertPolicyEmployeesToApprovalWorkflows

8d63e99

Merge branch 'main' into approval-workflows/transforming-data

8467eee

Finish tests for convertPolicyEmployeesToApprovalWorkflows

52ad6c2

Improve and write tests for convertApprovalWorkflowToPolicyEmployees

0584034

Add useful comments and simplify the logic

142a12d

Add new onyx key for approval workflows

8eea2b3

Add API commands for approval workflows

e4d750c

Add Onyx actions for approval workflows

b971bc8

Add removeWorkflow mode to convertApprovalWorkflowToPolicyEmployees

f90748c

Add test for removeWorkflow option

e0341b4

Remove deuplicated test

de18619

Merge branch 'approval-workflows/transforming-data' into approval-wor…

021b8ce

…kflows/onyx-setup

blazejkustra mentioned this pull request Jul 25, 2024

[CRITICAL] [Advanced Approval Workflows] Implement utils that transform data between backend and frontend (convertApprovalWorkflowToPolicyEmployees & convertPolicyEmployeesToApprovalWorkflows functions) #45957

Closed

blazejkustra marked this pull request as ready for review July 25, 2024 15:15

blazejkustra requested a review from a team as a code owner July 25, 2024 15:15

melvin-bot bot requested review from mananjadhav and removed request for a team July 25, 2024 15:15

tgolen requested changes Jul 25, 2024

View reviewed changes

blazejkustra added 5 commits July 26, 2024 08:39

Update the comments according to feedback

a23e4fe

Merge branch 'approval-workflows/transforming-data' into approval-wor…

91074a4

…kflows/onyx-setup

DRY WorkspaceApprovalParams

7e9f4ce

Connect to authToken with Onyx.connect

7617d0c

Update the logic to update approvalMode

9fdedc7

blazejkustra requested a review from tgolen July 26, 2024 07:31

blazejkustra added 2 commits July 26, 2024 11:17

Use the correct plural form

7b43485

Merge branch 'approval-workflows/transforming-data' into approval-wor…

2845492

…kflows/onyx-setup

tgolen approved these changes Jul 26, 2024

View reviewed changes

tgolen merged commit 2583e96 into Expensify:main Jul 26, 2024
14 checks passed

github-actions bot mentioned this pull request Jul 29, 2024

Deploy Checklist: New Expensify 2024-07-29 #46436

Closed

84 tasks

melvin-bot bot mentioned this pull request Jul 31, 2024

[HOLD for payment 2024-08-07] [CRITICAL] [Advanced Approval Workflows] Implement Onyx Actions (API calls & Onyx writes) #45959

Closed

s77rt reviewed Nov 6, 2024

View reviewed changes

s77rt mentioned this pull request Nov 6, 2024

[HOLD for payment 2024-11-13] [$250] Workflows - Edit approval workflow becomes blank after editing it offline and returning online #51468

Closed

8 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[No QA][CRITICAL] [Advanced Approval Workflows] Implement Onyx Actions (API calls & Onyx writes) #46189

[No QA][CRITICAL] [Advanced Approval Workflows] Implement Onyx Actions (API calls & Onyx writes) #46189

blazejkustra commented Jul 25, 2024 •

edited

Loading

melvin-bot bot commented Jul 25, 2024

tgolen left a comment

tgolen Jul 25, 2024

tgolen Jul 25, 2024

blazejkustra Jul 26, 2024

tgolen Jul 25, 2024

blazejkustra Jul 26, 2024

JmillsExpensify commented Jul 25, 2024

tgolen commented Jul 26, 2024 •

edited

Loading

OSBotify commented Jul 29, 2024

OSBotify commented Jul 31, 2024

s77rt Nov 6, 2024

[No QA][CRITICAL] [Advanced Approval Workflows] Implement Onyx Actions (API calls & Onyx writes) #46189

[No QA][CRITICAL] [Advanced Approval Workflows] Implement Onyx Actions (API calls & Onyx writes) #46189

Conversation

blazejkustra commented Jul 25, 2024 • edited Loading

Details

libs/actions/Workflow.ts (from the design doc's detailed section)

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Jul 25, 2024

tgolen left a comment

Choose a reason for hiding this comment

tgolen Jul 25, 2024

Choose a reason for hiding this comment

tgolen Jul 25, 2024

Choose a reason for hiding this comment

blazejkustra Jul 26, 2024

Choose a reason for hiding this comment

tgolen Jul 25, 2024

Choose a reason for hiding this comment

blazejkustra Jul 26, 2024

Choose a reason for hiding this comment

JmillsExpensify commented Jul 25, 2024

tgolen commented Jul 26, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

OSBotify commented Jul 29, 2024

OSBotify commented Jul 31, 2024

s77rt Nov 6, 2024

Choose a reason for hiding this comment

blazejkustra commented Jul 25, 2024 •

edited

Loading

tgolen commented Jul 26, 2024 •

edited

Loading