Add Callback URL on email/sms POST Requests

[k-macmillan]

User Story - Business Need

We want to ensure the new callback_url ends up in the database for that notification.

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

User Story(ies)

As a VA Notify developer I want callback_url to be available everywhere the Notification object is available So that we can use it when appropriate

Additional Info and Resources

Acceptance Criteria

• [x] TDD ~- [ ] Schema is updated with optional param for callback_url, using https_url in app/schema_validation/definitions.py~ See comments
• [x] callback_url is updated in the DB if one was present in the validated request
• [x] Deserializing the Notification object shows the callback URL
• [x] This work is added to the sprint review slide deck (key win bullet point and demo slide)

QA Considerations

• Validate the POST route, including edge cases
• Validate the GET response returns the appropriate callback
• As needed after speaking with developer

Potential Dependencies

[npmartin-oddball]

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

[MackHalliday]

NOTES from QA call with @k-macmillan

• To test, send self notification email, check that callback_url appears in GET {{notification-api-url}}/service/{{service-id}}/template/{{template-id}}
• POST route - see post_notification method
• When you created, api key in DEV put name in Key. Use POST {{notification-api-url}}/service/{{service-id}}/api-key
• Can use POSTMAN to test - SMS and Email

[MackHalliday]

Today

• Picked up ticket and talked to Kyle
• Started working on updates to POST /notification (post_notification method).

Tomorrow

• Continue to work on POST and then GET
• Test in DEV

[MackHalliday]

Unit Testing

• GET {notification-api-url}}/v2/notifications/{{notification-id}}
  • [x] Returns callback_url value in JSON response
  • [x] Can return callback_url value as None if no value
• GET {notification-api-url}}/v2/notifications
  • [x] Returns callback_url value in JSON response
  • [x] Can return callback_url value as None if no value
  • [x] Works with filter options
• POST {{notification-api-url}}/v2/notifications/sms
  • phone_number
    • [x] Updates in DB
    • [x] Returns value in JSON response
    • [x] Returns 400 if invalid url format
  • recipient_identifier
    • [x] Updates in DB
    • [x] Returns value in JSON response
    • [x] Returns 400 if invalid url format
  • POST {{notification-api-url}}/v2/notifications/email
  • phone_number
    • [x] Updates in DB
    • [x] Returns value in JSON response
    • [x] Returns 400 if invalid url format
  • recipient_identifier
    • [x] Updates in DB
    • [x] Returns value in JSON response
    • [x] Returns 400 if invalid url format

DEV Testing

• GET {notification-api-url}}/v2/notifications/{{notification-id}}
  • [x] Returns callback_url value in JSON response
  • [x] Can return callback_url value as None if no value
• GET {notification-api-url}}/v2/notifications
  • [x] Returns callback_url value in JSON response
  • [x] Can return callback_url value as None if no value
  • [x] Works with filter options
• POST {{notification-api-url}}/v2/notifications/sms
  • phone_number
    • [x] Updates in DB
    • [x] Returns value in JSON response
    • [x] Returns 400 if invalid url format
  • recipient_identifier
    • [x] Updates in DB
    • [x] Returns value in JSON response
    • [x] Returns 400 if invalid url format
  • POST {{notification-api-url}}/v2/notifications/email
  • phone_number
    • [x] Updates in DB
    • [x] Returns value in JSON response
    • [x] Returns 400 if invalid url format
  • recipient_identifier
    • [x] Updates in DB
    • [x] Returns value in JSON response
    • [x] Returns 400 if invalid url format

[MackHalliday]

Note - check edge case for length of URL. Should throw ValidationError instead of DataError

[MackHalliday]

Discovered that updating the schema for the https_url to have a max length 255 has an unintended side affect of limiting the max length of the url on the ServiceCallback table.

Should the url be constrained on the ServiceCallback table be constrained?

[kalbfled]

@k-macmillan Mack and I discussed this. The schema https_url is used to create and update rows in the ServiceCallback table. It shouldn't be part of this ticket.

[cris-oddball]

PR approved and merged, along with the QA PR that validates this work.

Sending up to Perf, new regression will vet this, then can close ticket.

[cris-oddball]

Passed valdiation