GA4 Migration: Build dynamic URL for open email tracking

MackHalliday commented 2 months ago

User Story - Business Need

We need to construct a dynamic URL that contains information on notification emails being sent. This URL should be passed as an optional parameter into the HTMLEmailTemplate class within the send_email_to_provider method. The HTMLEmailTemplate class is located in the notification-utils repository. In an earlier user story, a dynamic URL variable was embedded in the notification email, and, when the variable is populated and the email is openned, a GET request will be made to our notification-api repo. This user story focuses exclusively on building and passing the dynamic GET URL to the HTMLEmailTemplate class.

FIX BUG created in #153. We need to update the new GET ga4/open-email-tracking to return an pixel to avoid the broken image icon in appearing in emails.

[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 to build a dynamic URL that contains information on emails being sent So that the dynamic URL can eventually be use to execute a GET request through pixel tracking when the email is opened.

Additional Info and Resources

Implementation and Ticket Overview
Background on Email Tracking: We currently use UA to track email opens via pixel tracking. GA4 does not support pixel tracking directly. Instead, we will embed a dynamic URL in the email that sends a GET request to our application when the email is opened. This GET request will then trigger a POST request to GA4 with the necessary data.
Jamie Stutt on dsva.slack.com, but please ask @MackHalliday first as she has already talked to her and does not want to ask Jamie the same questions.
Campaign Details GA4 fields

Engineering Checklist

[x] Poetry update for changes to notification-utils made in UTILS-855

[x] Create methods to build the new dynamic URL in the app.googleanalytics folder

URL

url = (
   f'{public_application_root}/ga4/open-email-tracking?'
   f'campaign={notification.template.name}&campaign_id={notification.template.id}&'
   f'name=email_opens&source=vanotify&medium=email&'
   f'content={notification.service.name}/{notification.service.id}/{notification.id}'
)

[x] Call the new method in place of the UA implementation (gapixels.build_ga_pixel_url) in the get_html_email_options. Add the value for the dynamic URL to the html email options.
[x] Remove any UA implementation code
[x] Log the dynamic URL so the values appear in DataDog
[x] Add Documentation to VANotify Team
[x] Fix bug for broken image icon appearing in emails by returning pixel image from GET ga4/open-email-tracking

Acceptance Criteria

The new dynamic URL can be passed into the HTMLEmailTemplate as part of an optional arg
A GET request is made to the notification-api repo (The POST request to GA4 may not be fully implemented at this time)
Should work with emails that do and do not allow images to load. If not allowed, then email tracking should not be sent.
Fix bug: No broken image icon in email

QA Considerations

A GET request is made to the notification-api repo (The notification-api GET endpoint to trigger POST to GA4 may not be fully implemented at this time)

cris-oddball commented 2 months ago

Adding the QA Reviewed label, but the QA work on this ticket seems incomplete (based on the Utils ticket saying that the QA info will be on this ticket. We can discuss in Refinement or during the QA convo when the developer picks up the ticket.

mjones-oddball commented 1 month ago

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