notifications: use "Estuary" in alert email subjects (#3000)#3173
Closed
0xfandom wants to merge 3 commits into
Closed
notifications: use "Estuary" in alert email subjects (#3000)#31730xfandom wants to merge 3 commits into
0xfandom wants to merge 3 commits into
Conversation
Alert email subjects were prefixed "Estuary Flow:", while the rest of the
product refers to just "Estuary". Drop "Flow" from the subject line of
every alert type for consistent messaging.
This finishes a migration already partly done: the FreeTrial fired
subject was already "Estuary Free Trial", MissingPaymentMethod's was
already "Estuary: ...", and several bodies already say "Your Estuary
account" / "Your Estuary {{spec_type}}".
Email bodies still say "Estuary Flow" in a few places; those are prose
rather than subject lines and are left to the next commit.
Fixes estuary#3000
Follow through on the subject-line rename: the free-trial and
missing-payment-method bodies still read "We hope you are enjoying
Estuary Flow". Bodies elsewhere in the crate already say "Your Estuary
account" and "Your Estuary {{spec_type}}", so this brings the remaining
prose in line.
Only the `notifications__*` snapshots are updated. The parallel
`alert_notifications__*` snapshot files are orphaned leftovers that no
test renders, and are already being removed by estuary#3079.
The subject templates for TaskIdle, TaskAutoDisabledFailing and TaskAutoDisabledIdle had no test asserting them: breaking any of their subject strings left the suite green, so the rename in the preceding commits touched three lines nothing guarded. Add a fired-state test per alert type, following the existing assert_email + body snapshot pattern. Each now fails on a subject mismatch. All three are fired-only, so there is no resolved case.
Collaborator
|
Hey, thanks for the interest in contributing to Estuary! I ended up wanting to change some other aspects of notification emails beyond the "Estuary vs. Estuary Flow" issue, so I opened my own PR to address #3000. Appreciate the thought, though! |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description:
Alert emails prefixed their subject with
Estuary Flow:, while the rest of the product says just "Estuary". This drops "Flow" from the subject of every alert type, and from the remaining body prose.This mostly finishes a migration that was already underway —
FreeTrial's fired subject was alreadyEstuary Free Trial,MissingPaymentMethod's was alreadyEstuary: …, and several bodies already read "Your Estuary account" / "Your Estuary {{spec_type}}".Three commits, so the last two can be dropped independently if you'd rather scope this tightly:
Estuary Flow:→Estuary:across all 13 subject templates. This is what Update product name in alert emails #3000 asks for.Fixes #3000
Workflow steps:
No API or CLI surface changes; this only affects the subject and body text of outbound alert emails. For example, a failing capture previously sent:
and now sends:
Affected alert types:
AutoDiscoverFailed,BackgroundPublicationFailed,DataMovementStalled,FreeTrial,FreeTrialEnding,ShardFailed,TaskAutoDisabledFailing,TaskAutoDisabledIdle,TaskChronicallyFailing,TaskIdle.Documentation links affected:
None. The subject strings live only in the
notificationscrate's handlebars templates; nothing undersite/documents them.Notes for reviewers:
TaskIdle,TaskAutoDisabledFailingandTaskAutoDisabledIdlehad no test asserting them — I changed one toBROKEN:and the suite stayed green, so the rename was touching three lines nothing guarded. The third commit adds a fired-state test per type, following the existingassert_email+ snapshot pattern; the same deliberate break now fails onsubject mismatch. All three are fired-only, so there's no resolved case. Happy to split that commit into its own PR if you'd prefer it separate from a rename.notifications__*files are updated. The parallelalert_notifications__*set appears orphaned — no test renders them, and they don't regenerate — and notifications: remove stale alert_notifications snapshot files #3079 is already removing them, so I left them alone rather than create a conflict. Each of the 5 updated snapshots is a one-line diff.free_trial's resolved subject is a conditional; itshas_credit_cardbranch becomesEstuary: Paid Tier, which lines up with the existingelsebranch (Estuary Paid Tier: Enter Payment Info…).cargo test -p notifications— 28 passing (25 existing + 3 new).cargo fmtclean.