Comp and Pen: Add US Currency Formatting for Payment Amount

mjones-oddball commented 4 months ago

User Story - Business Need

Currently we are not applying currency formatting to the payment amount in our SMS, so the dollar amount is displayed as an integer. Current SMS content looks like this: “VA Benefits: Your compensation/pension monthly payment of $4321 is being processed. Reply STOP to unsubscribe, HELP for link to access VA payment history.”

This format doesn’t look appealing. We’d like to improve user-friendliness by applying a usual format for US dollar amounts where a decimal point separates dollars and cents, while a comma separates thousands.

Proposed new format: “VA Benefits: Your compensation/pension monthly payment of $4,321.00 is being processed. Reply STOP to unsubscribe, HELP for link to access VA payment history.”

[x] Ticket is understood, and QA has been contacted (if the ticket has a QA label).

User Story(ies)

As a Veteran I want view the dollar amount of my recurring payment via text So that I can confirm my deposit is the amount I expect.

Additional Info and Resources

The $ is currently static text in the template, so if it comes along with the conversion we use please ensure the template gets updated in Perf, Staging and Production. We don't want double($$).

The location of this code change is in the send_comp_and_pen_sms method of the CompPenMsgHelper class. The payment_amount that comes in is a decimal that gets changed to a string. It should be formatted with f'{payment_amount:0,.2f}'

Acceptance Criteria

Given we are sending a valid recurring payment comp and pen text message and the payment amount is a personalisation within the template:

When the payment amount is less than a thousand, we format it with decimal point only ($999.00)
When the payment amount is more than a thousand, we format it with decimal point and a comma separator for thousands ($1,999.00)

QA Considerations

Will need to confirm that the amount is translated appropriately between what’s in dynamo and the text that is populated/received.

mjones-oddball commented 4 months ago

Hey team! Please add your planning poker estimate with Zenhub @cris-oddball @k-macmillan @kalbfled @MackHalliday @mchlwellman @EvanParish

kalbfled commented 4 months ago

The necessary changes probably belong around here.

k-macmillan commented 3 months ago

Removed the AC regarding paymentAmount -> amount.

MackHalliday commented 3 months ago

Tested in PERF with @EvanParish Deployed to Perf, set test notifications to is_processed is False, wait for task to run, check on phone that commas appear. (thanks @EvanParish )

MackHalliday commented 3 months ago

Friday

Submitted PR and made updates

Today

In QA for testing.

cris-oddball commented 3 months ago

PR approved and merged, sending up to Perf, then testing.

cris-oddball commented 3 months ago

I'm still stuck without AWS access. Asked Michael to go into the Perf DB and update the following participant IDs to set is_processed as F so that they will be picked up by the cron job at 11:00 AM MT. participant_id vaprofile_id 600043175 134281 600043214 1273674 600075670 1131138

will check api logs after that time.

cris-oddball commented 3 months ago

QA PASSED

3 notifications were generated based on modifications made to the DynamoDB table for the 3 items in the above comment. The notification IDs were then fetched using the GET route and the resulting body from those requests are posted below:

[x] TC01 notification_id 1a355af3-f09d-45b5-a799-7bc1687550de had 3057 in paymentAmount, expect 3,057
```
"body": "Comp and Pen test message with amount: $3,057.00",
```
[x] TC02 notification_id 4b5eb478-4aee-43b7-97e7-a81fc8bb208a had 1413.68 in paymentAmount, expect 1,413.68
```
"body": "Comp and Pen test message with amount: $1,413.68",
```
[x] TC03 notification_id ffa93671-9c64-4b64-8ff3-5131d04980d4 had 0 in paymentAmount, expect 0.00
```
"body": "Comp and Pen test message with amount: $0.00",
```

department-of-veterans-affairs / notification-api