Budget Change: Edit BLs (including prompt for send to approval)

[jonnalley]

User Story

As a COR or other team member, I need to edit budget-impacting details (CAN, Amount, Need By) of a budget line where the BL is already in Planned or Executing status, and know that it requires an approval, so that I understand how my edit will impact the overall budget.

Preconditions

• A given contract has one or more budget lines in either planned or executing BLs

Acceptance Criteria

1. On a given existing BL on a contract, authorized users are able to edit attributes of it and elect to persist the change without altering the status of the budget line. Authorized users would be limited to project officer, named team members, division director linked to associated CANs, budget team, and system admin.
2. Before allowing any update to persist, all validations should still be enforced that were necessary to get the budget line in the current status (planned or executing). In example, amounts shouldn't be allowed to be changed to 0 or an empty string.
3. Additionally, before the update would persist, the user would be made aware of and to confirm that the change will need to undergo review and approval.
4. After successful persistence, the user is aware that the change is awaiting approval
5. Upon successful persistence, relevant entries should be recorded in the event/history table(s) of who made what changes when and this event should be properly rendered in the history of changes to the agreement.
6. User can choose to cancel making any changes and leave the pre-existing values for any metadata persisted.

---

Tasks

UX

Dev

FrontEnd

• Track changes to BLI amount, Can_ID, and dateNeeded #2261
• Display Confirmation modal if budget changes are requested
• handle 202 for change requests
• show success Alert on Agreement for BLIs Sent to Approval for submitter only #2323
• show information Alert on Agreement for all users #2324
• in BLI Table, show BLIS in review with updated Tag
• in BLI Table, show BLIS in review with detailed ToolTip
• show requests in the Agreements Log
• use in_review instead of has_active_workflow to indicate a BLI is under review
• add additional validations on the BLI Form per AC 2
• add additional validations on the BLI Form for budget rules in Tests below
• allow EXECUTING BLIs to be edited
• [tech debt]: handle Cancel by grouping temporary changes and batch api calls #2287
• fix wizard state to save BLIs created step 3 when going back to step 2 #2308
• look at Alert messages and redirects after Cancel/Save actions
• [-] create-agreement-wizard state refactor #2322
• add/update unit/e2e tests as needed
• agreement summary cards not syncing with state changes #2325
• add IN_REVIEW Tag and ToolTip to affected <ALLBLIRow />

BackEnd

• Create a general ChangeRequest model and subclasses for types of changes
• Change the existing edit endpoints (for BLI and Agreement) to create ChangeRequests conditionally and return 202 instead of 200
• change-request-reviews endpoint to approve/deny a change request (not actually needed for this ticket)
• Agreement History for BLI Change Requests #2238
• enforce validation for non-DRAFT BLIs per AC 2 (currently its only if status is changing) #2312
  • see also: Editing contract metadata should enforce validation rules for highest BL status #1629
• add validation for budget rules in Tests below

Tests (if not already in existence)

All of these tests should not change the status of the BL

• User setting a BL amount from a non-zero amount to 0
• User setting a BL amount to a negative amount
  * User setting an Executing (not Planned) BL amount over the budget remaining CAN balance/budget shouldn't be allowed
  * User setting an Executing BL but changing the CAN and the amount at the same time (success and failure given above test)
• Same tests but above but with Planned where there is no restriction on amount going over CAN balance
• date changing tests?

Definition of Done Checklist

• UI works as designed (UX team)
• Usability validated (UX team)
• PR(s) have been merged to main
• Design/tech debt eliminated
• New design/tech debt documented (if applicable)
• Build process updated
• Documentation updated or added
• Feature flags/toggles created

Additional Context & Resources

• Discovery around Editing Agreements with Financial-impacting info requiring Approvals (without a BL status change) #1964
• A more-narrative document outlining potential scenarios and needs being addressed is here
• FigJam process visual
• Figma dev-ready frame

[fpigeonjr]

• added logix to capture BLI snapshot and compare to form state
• also tracking if BLI is PLANNED or EXECUTING
• confirmation modal is firing
• seeing new props on BLI from the PATCH thanks to @stevtek

[fpigeonjr]

• updates In_Review Tag
• updates Alerts based on budget lines in review status
• allows for editing EXECUTING budget lines

[fpigeonjr]

• UX Review conducted on 5/4/2024 revealed that confirmation modal to send changes to Division Director should happen later in the flow. User should be able to make temporary BLI changes and have the ability to cancel out of those changes and/or click Save changes and if they are financial changes then the confirmation modal should fire.
• 👆is captured in task [tech debt]: handle Cancel by grouping temporary changes and batch api calls #2287

[fpigeonjr]

UX Review conducted on 5/14/2024

• add ToolTip for TBD budget-lines
• look at Alert messages and redirects after Saving
• opportunity discovered for wizard state to be refactored with the onFinish function

☝️ added FE tasks for these

[fpigeonjr]

• ToolTip now supports human-readable text

[fpigeonjr]

• all users AgreementChangeRequestAlert is now supported with changeRequests
• submitter success Alert is added sans the changeRequests
  • could not get the changeRequests to sync so moving on for now