-
Notifications
You must be signed in to change notification settings - Fork 2.8k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #46189 from software-mansion-labs/approval-workflo…
…ws/onyx-setup [No QA][CRITICAL] [Advanced Approval Workflows] Implement Onyx Actions (API calls & Onyx writes)
- Loading branch information
Showing
9 changed files
with
1,003 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| import type {PolicyEmployee} from '@src/types/onyx'; | ||
|
|
||
| type CreateWorkspaceApprovalParams = { | ||
| authToken: string; | ||
| policyID: string; | ||
| employees: PolicyEmployee[]; | ||
| }; | ||
|
|
||
| type UpdateWorkspaceApprovalParams = CreateWorkspaceApprovalParams; | ||
|
|
||
| type RemoveWorkspaceApprovalParams = CreateWorkspaceApprovalParams; | ||
|
|
||
| export type {CreateWorkspaceApprovalParams, UpdateWorkspaceApprovalParams, RemoveWorkspaceApprovalParams}; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,173 @@ | ||
| import lodashMapKeys from 'lodash/mapKeys'; | ||
| import type {Approver, Member} from '@src/types/onyx/ApprovalWorkflow'; | ||
| import type ApprovalWorkflow from '@src/types/onyx/ApprovalWorkflow'; | ||
| import type {PersonalDetailsList} from '@src/types/onyx/PersonalDetails'; | ||
| import type {PolicyEmployeeList} from '@src/types/onyx/PolicyEmployee'; | ||
|
|
||
| type GetApproversParams = { | ||
| /** | ||
| * List of employees in the policy | ||
| */ | ||
| employees: PolicyEmployeeList; | ||
|
|
||
| /** | ||
| * Personal details of the employees where the key is the email | ||
| */ | ||
| personalDetailsByEmail: PersonalDetailsList; | ||
|
|
||
| /** | ||
| * Email of the first approver | ||
| */ | ||
| firstEmail: string; | ||
| }; | ||
|
|
||
| /** Get the list of approvers for a given workflow */ | ||
| function getApprovalWorkflowApprovers({employees, firstEmail, personalDetailsByEmail}: GetApproversParams): Approver[] { | ||
| const approvers: Approver[] = []; | ||
| // Keep track of approver emails to detect circular references | ||
| const currentApproverEmails = new Set<string>(); | ||
|
|
||
| let nextEmail: string | undefined = firstEmail; | ||
| while (nextEmail) { | ||
| if (!employees[nextEmail]) { | ||
| break; | ||
| } | ||
|
|
||
| const isCircularReference = currentApproverEmails.has(nextEmail); | ||
| approvers.push({ | ||
| email: nextEmail, | ||
| forwardsTo: employees[nextEmail].forwardsTo, | ||
| avatar: personalDetailsByEmail[nextEmail]?.avatar, | ||
| displayName: personalDetailsByEmail[nextEmail]?.displayName, | ||
| isInMultipleWorkflows: false, | ||
| isCircularReference, | ||
| }); | ||
|
|
||
| // If we've already seen this approver, break to prevent infinite loop | ||
| if (isCircularReference) { | ||
| break; | ||
| } | ||
| currentApproverEmails.add(nextEmail); | ||
|
|
||
| // If there is a forwardsTo, set the next approver to the forwardsTo | ||
| nextEmail = employees[nextEmail].forwardsTo; | ||
| } | ||
|
|
||
| return approvers; | ||
| } | ||
|
|
||
| type ConvertPolicyEmployeesToApprovalWorkflowsParams = { | ||
| /** | ||
| * List of employees in the policy | ||
| */ | ||
| employees: PolicyEmployeeList; | ||
|
|
||
| /** | ||
| * Personal details of the employees | ||
| */ | ||
| personalDetails: PersonalDetailsList; | ||
|
|
||
| /** | ||
| * Email of the default approver for the policy | ||
| */ | ||
| defaultApprover: string; | ||
| }; | ||
|
|
||
| /** Convert a list of policy employees to a list of approval workflows */ | ||
| function convertPolicyEmployeesToApprovalWorkflows({employees, defaultApprover, personalDetails}: ConvertPolicyEmployeesToApprovalWorkflowsParams): ApprovalWorkflow[] { | ||
| const approvalWorkflows: Record<string, ApprovalWorkflow> = {}; | ||
|
|
||
| // Keep track of how many times each approver is used to detect approvers in multiple workflows | ||
| const approverCountsByEmail: Record<string, number> = {}; | ||
| const personalDetailsByEmail = lodashMapKeys(personalDetails, (value, key) => value?.login ?? key); | ||
|
|
||
| // Add each employee to the appropriate workflow | ||
| Object.values(employees).forEach((employee) => { | ||
| const {email, submitsTo} = employee; | ||
| if (!email || !submitsTo) { | ||
| return; | ||
| } | ||
|
|
||
| const member: Member = {email, avatar: personalDetailsByEmail[email]?.avatar, displayName: personalDetailsByEmail[email]?.displayName ?? email}; | ||
| if (!approvalWorkflows[submitsTo]) { | ||
| const approvers = getApprovalWorkflowApprovers({employees, firstEmail: submitsTo, personalDetailsByEmail}); | ||
| approvers.forEach((approver) => (approverCountsByEmail[approver.email] = (approverCountsByEmail[approver.email] ?? 0) + 1)); | ||
|
|
||
| approvalWorkflows[submitsTo] = { | ||
| members: [], | ||
| approvers, | ||
| isDefault: defaultApprover === submitsTo, | ||
| isBeingEdited: false, | ||
| }; | ||
| } | ||
| approvalWorkflows[submitsTo].members.push(member); | ||
| }); | ||
|
|
||
| // Sort the workflows by the first approver's name (default workflow has priority) | ||
| const sortedApprovalWorkflows = Object.values(approvalWorkflows).sort((a, b) => { | ||
| if (a.isDefault) { | ||
| return -1; | ||
| } | ||
|
|
||
| return (a.approvers[0]?.displayName ?? '-1').localeCompare(b.approvers[0]?.displayName ?? '-1'); | ||
| }); | ||
|
|
||
| // Add a flag to each approver to indicate if they are in multiple workflows | ||
| return sortedApprovalWorkflows.map((workflow) => ({ | ||
| ...workflow, | ||
| approvers: workflow.approvers.map((approver) => ({ | ||
| ...approver, | ||
| isInMultipleWorkflows: approverCountsByEmail[approver.email] > 1, | ||
| })), | ||
| })); | ||
| } | ||
|
|
||
| type ConvertApprovalWorkflowToPolicyEmployeesParams = { | ||
| /** | ||
| * Approval workflow to convert | ||
| */ | ||
| approvalWorkflow: ApprovalWorkflow; | ||
|
|
||
| /** | ||
| * Current list of employees in the policy | ||
| */ | ||
| employeeList: PolicyEmployeeList; | ||
|
|
||
| /** | ||
| * Should the workflow be removed from the employees | ||
| */ | ||
| removeWorkflow?: boolean; | ||
| }; | ||
|
|
||
| /** Convert an approval workflow to a list of policy employees */ | ||
| function convertApprovalWorkflowToPolicyEmployees({approvalWorkflow, employeeList, removeWorkflow = false}: ConvertApprovalWorkflowToPolicyEmployeesParams): PolicyEmployeeList { | ||
| const updatedEmployeeList: PolicyEmployeeList = {}; | ||
| const firstApprover = approvalWorkflow.approvers.at(0); | ||
|
|
||
| if (!firstApprover) { | ||
| throw new Error('Approval workflow must have at least one approver'); | ||
| } | ||
|
|
||
| approvalWorkflow.approvers.forEach((approver, index) => { | ||
| if (updatedEmployeeList[approver.email]) { | ||
| return; | ||
| } | ||
|
|
||
| const nextApprover = approvalWorkflow.approvers.at(index + 1); | ||
| updatedEmployeeList[approver.email] = { | ||
| ...employeeList[approver.email], | ||
| forwardsTo: removeWorkflow ? undefined : nextApprover?.email, | ||
| }; | ||
| }); | ||
|
|
||
| approvalWorkflow.members.forEach(({email}) => { | ||
| updatedEmployeeList[email] = { | ||
| ...(updatedEmployeeList[email] ? updatedEmployeeList[email] : employeeList[email]), | ||
| submitsTo: removeWorkflow ? undefined : firstApprover.email, | ||
| }; | ||
| }); | ||
|
|
||
| return updatedEmployeeList; | ||
| } | ||
|
|
||
| export {getApprovalWorkflowApprovers, convertPolicyEmployeesToApprovalWorkflows, convertApprovalWorkflowToPolicyEmployees}; |
Oops, something went wrong.