mirror of
https://github.com/nomadkaraoke/karaoke-gen.git
synced 2026-11-20 13:07:57 +09:00
feat(email): migrate to Postmark with feature-flag cutover (#735)
## Summary
Replace SendGrid with Postmark as the transactional email provider,
behind an `EMAIL_PROVIDER` feature flag for safe cutover.
## Why
SendGrid's shared IPs have been throttled by Yahoo since ~Apr 22 (`421
4.7.0 [TSS04]`), causing 6-28h delivery delays and breaking magic-link
sign-in for Yahoo users. Postmark has a much stronger transactional
reputation with Yahoo/AOL and is cheaper ($16/mo vs SendGrid Pro at
$90/mo for a dedicated IP). Domain verification is already complete in
Postmark (SPF, DKIM, return-path all green for `nomadkaraoke.com`).
## Approach
- New `PostmarkEmailProvider` in \`backend/services/email_service.py\` —
uses the Postmark REST API directly (no new SDK dependency, reuses
\`requests\`).
- \`_get_provider()\` honors \`EMAIL_PROVIDER\` env var
(\`postmark\`|\`sendgrid\`). Code default is \`postmark\`. CI/Cloud Run
defaults to \`sendgrid\` so this PR is a no-op in prod on merge.
- gdrive-validator Cloud Function swapped to Postmark (drops the
\`sendgrid\` Python dep).
- Pulumi adds \`postmark-server-token\` Secret Manager resource + wires
\`POSTMARK_SERVER_TOKEN\` into encoding job and gdrive-validator. Keeps
\`SENDGRID_API_KEY\` wired in parallel during cutover.
## Cutover plan
1. \`pulumi up --stack prod\` locally **before merging** (creates the
new secret resource — needs admin GCP creds, my readonly SA can't do
it).
2. After \`pulumi up\` succeeds, populate the secret value:
\`\`\`
gcloud secrets versions add postmark-server-token \\
--data-file=- --project=nomadkaraoke <<<"\$POSTMARK_SERVER_KEY"
\`\`\`
3. Merge this PR → \`gcloud run deploy\` runs in CI with
\`EMAIL_PROVIDER=sendgrid\` (zero behavior change). New env vars wired
but inert.
4. Once Postmark account is staff-approved (tomorrow), flip the env var:
\`\`\`
gcloud run services update karaoke-backend --region=us-central1 \\
--update-env-vars=EMAIL_PROVIDER=postmark --project=nomadkaraoke
\`\`\`
5. Test sign-in to a Yahoo address. Confirm the customer
(\`hojob2002@yahoo.com\`) can sign in.
6. Follow-up PR: delete \`SendGridEmailProvider\` class,
\`sendgrid-api-key\` secret, \`sendgrid\` Python dep, and
\`SENDGRID_API_KEY\` env bindings.
## Files
- \`backend/services/email_service.py\` — new \`PostmarkEmailProvider\`,
updated \`_get_provider()\`, shared \`_dedupe_emails()\` helper
- \`backend/tests/test_email_service.py\` — Postmark provider +
provider-selection tests (22 new)
- \`infrastructure/modules/secrets.py\` — adds \`postmark-server-token\`
- \`infrastructure/__main__.py\` — gdrive-validator function gets
\`POSTMARK_SERVER_TOKEN\` (keeps \`SENDGRID_API_KEY\`)
- \`infrastructure/modules/cloud_run.py\` — video-encoding-job gets
\`POSTMARK_SERVER_TOKEN\` (keeps \`SENDGRID_API_KEY\`)
-
\`infrastructure/functions/gdrive_validator/{main.py,deploy.sh,requirements.txt}\`
— swap SendGrid for Postmark; drop \`sendgrid\` Python dep
- \`.github/workflows/ci.yml\` — adds \`POSTMARK_SERVER_TOKEN\` secret +
\`EMAIL_PROVIDER=sendgrid\` env to backend deploy
- \`pyproject.toml\` — 0.172.3 → 0.172.4
## Test plan
- [x] \`pytest backend/tests/ -k "magic_link or anti_abuse or
user_service or auth or email"\` — 377 passed
- [x] \`pulumi preview\` — clean diff (1 create, 2 update with both
providers wired)
- [ ] **Run \`pulumi up --stack prod\` locally before merging**
(requires admin GCP creds)
- [ ] Populate \`postmark-server-token\` secret value via gcloud
- [ ] Verify deploy succeeds with \`EMAIL_PROVIDER=sendgrid\` (no
behavior change)
- [ ] Tomorrow: flip env to \`postmark\`, sign in to a Yahoo address,
observe Postmark Activity feed for instant delivery
@coderabbitai ignore
🤖 Generated with [Claude Code](https://claude.com/claude-code)
---------
Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This commit is contained in:
1 parent
5c00f2c922
commit
48e24f4e83
10 files changed
+342
-43
No files matched your search
@@ -1639,8 +1639,8 @@ jobs:
|
||||
--min-instances 1 \
|
||||
--vpc-connector projects/nomadkaraoke/locations/us-central1/connectors/cloud-run-connector \
|
||||
--vpc-egress private-ranges-only \
|
||||
--set-env-vars "GOOGLE_CLOUD_PROJECT=${{ env.PROJECT_ID }},GCS_BUCKET_NAME=karaoke-gen-storage-${{ env.PROJECT_ID }},FIRESTORE_COLLECTION=jobs,ENVIRONMENT=production,KARAOKE_GEN_VERSION=$VERSION,DEFAULT_DROPBOX_PATH=/MediaUnsynced/Karaoke/Tracks-Organized,DEFAULT_GDRIVE_FOLDER_ID=1laRKAyxo0v817SstfM5XkpbWiNKNAMSX,ENABLE_CLOUD_TASKS=true,CLOUD_RUN_SERVICE_URL=https://api.nomadkaraoke.com,GCP_REGION=us-central1,DEFAULT_ENABLE_YOUTUBE_UPLOAD=true,DEFAULT_BRAND_PREFIX=NOMAD,DEFAULT_PRIVATE_DROPBOX_PATH=/MediaUnsynced/Karaoke/Tracks-NonPublished,DEFAULT_PRIVATE_BRAND_PREFIX=NOMADNP,USE_GCE_ENCODING=true,USE_GCE_PREVIEW_ENCODING=true,ENABLE_PUSH_NOTIFICATIONS=true,USE_CLOUD_RUN_JOBS_FOR_VIDEO=true,COMMIT_SHA=${{ steps.build-meta.outputs.sha }},PR_NUMBER=${{ steps.build-meta.outputs.pr_number }},PR_TITLE=${{ steps.build-meta.outputs.pr_title }}" \
|
||||
--set-secrets "AUDIOSHAKE_API_TOKEN=audioshake-api-key:latest,GENIUS_API_TOKEN=genius-api-key:latest,SPOTIFY_COOKIE_SP_DC=spotify-cookie:latest,RAPIDAPI_KEY=rapidapi-key:latest,DEFAULT_DISCORD_WEBHOOK_URL=discord-releases-webhook:latest,ADMIN_TOKENS=admin-tokens:latest,RED_API_KEY=red-api-key:latest,RED_API_URL=red-api-url:latest,OPS_API_KEY=ops-api-key:latest,OPS_API_URL=ops-api-url:latest,FLACFETCH_API_URL=flacfetch-api-url:latest,FLACFETCH_API_KEY=flacfetch-api-key:latest,SENDGRID_API_KEY=sendgrid-api-key:latest,STRIPE_SECRET_KEY=stripe-secret-key:latest,STRIPE_WEBHOOK_SECRET=stripe-webhook-secret:latest,LANGFUSE_PUBLIC_KEY=langfuse-public-key:latest,LANGFUSE_SECRET_KEY=langfuse-secret-key:latest,LANGFUSE_HOST=langfuse-host:latest,ENCODING_WORKER_URL=encoding-worker-url:latest,ENCODING_WORKER_API_KEY=encoding-worker-api-key:latest,VAPID_PUBLIC_KEY=vapid-public-key:latest,VAPID_PRIVATE_KEY=vapid-private-key:latest,E2E_BYPASS_KEY=e2e-bypass-key:latest,GDRIVE_VALIDATOR_URL=gdrive-validator-url:latest"
|
||||
--set-env-vars "GOOGLE_CLOUD_PROJECT=${{ env.PROJECT_ID }},GCS_BUCKET_NAME=karaoke-gen-storage-${{ env.PROJECT_ID }},FIRESTORE_COLLECTION=jobs,ENVIRONMENT=production,KARAOKE_GEN_VERSION=$VERSION,DEFAULT_DROPBOX_PATH=/MediaUnsynced/Karaoke/Tracks-Organized,DEFAULT_GDRIVE_FOLDER_ID=1laRKAyxo0v817SstfM5XkpbWiNKNAMSX,ENABLE_CLOUD_TASKS=true,CLOUD_RUN_SERVICE_URL=https://api.nomadkaraoke.com,GCP_REGION=us-central1,DEFAULT_ENABLE_YOUTUBE_UPLOAD=true,DEFAULT_BRAND_PREFIX=NOMAD,DEFAULT_PRIVATE_DROPBOX_PATH=/MediaUnsynced/Karaoke/Tracks-NonPublished,DEFAULT_PRIVATE_BRAND_PREFIX=NOMADNP,USE_GCE_ENCODING=true,USE_GCE_PREVIEW_ENCODING=true,ENABLE_PUSH_NOTIFICATIONS=true,USE_CLOUD_RUN_JOBS_FOR_VIDEO=true,EMAIL_PROVIDER=sendgrid,COMMIT_SHA=${{ steps.build-meta.outputs.sha }},PR_NUMBER=${{ steps.build-meta.outputs.pr_number }},PR_TITLE=${{ steps.build-meta.outputs.pr_title }}" \
|
||||
--set-secrets "AUDIOSHAKE_API_TOKEN=audioshake-api-key:latest,GENIUS_API_TOKEN=genius-api-key:latest,SPOTIFY_COOKIE_SP_DC=spotify-cookie:latest,RAPIDAPI_KEY=rapidapi-key:latest,DEFAULT_DISCORD_WEBHOOK_URL=discord-releases-webhook:latest,ADMIN_TOKENS=admin-tokens:latest,RED_API_KEY=red-api-key:latest,RED_API_URL=red-api-url:latest,OPS_API_KEY=ops-api-key:latest,OPS_API_URL=ops-api-url:latest,FLACFETCH_API_URL=flacfetch-api-url:latest,FLACFETCH_API_KEY=flacfetch-api-key:latest,SENDGRID_API_KEY=sendgrid-api-key:latest,POSTMARK_SERVER_TOKEN=postmark-server-token:latest,STRIPE_SECRET_KEY=stripe-secret-key:latest,STRIPE_WEBHOOK_SECRET=stripe-webhook-secret:latest,LANGFUSE_PUBLIC_KEY=langfuse-public-key:latest,LANGFUSE_SECRET_KEY=langfuse-secret-key:latest,LANGFUSE_HOST=langfuse-host:latest,ENCODING_WORKER_URL=encoding-worker-url:latest,ENCODING_WORKER_API_KEY=encoding-worker-api-key:latest,VAPID_PUBLIC_KEY=vapid-public-key:latest,VAPID_PRIVATE_KEY=vapid-private-key:latest,E2E_BYPASS_KEY=e2e-bypass-key:latest,GDRIVE_VALIDATOR_URL=gdrive-validator-url:latest"
|
||||
|
||||
- name: Update Cloud Run Jobs with new image
|
||||
run: |
|
||||
|
||||
@@ -2,13 +2,12 @@
|
||||
Email service for sending transactional emails.
|
||||
|
||||
Supports multiple providers:
|
||||
- SendGrid (recommended for production)
|
||||
- Postmark (production default — better Yahoo/AOL deliverability)
|
||||
- SendGrid (legacy fallback, retained during cutover)
|
||||
- Console logging (for development/testing)
|
||||
|
||||
Future providers can be added:
|
||||
- Mailgun
|
||||
- AWS SES
|
||||
- Postmark
|
||||
Provider selection: EMAIL_PROVIDER env var (postmark|sendgrid). Defaults to
|
||||
postmark when both keys are present.
|
||||
"""
|
||||
import html
|
||||
import logging
|
||||
@@ -18,6 +17,8 @@ from datetime import datetime, timedelta, timezone
|
||||
from typing import Optional, List
|
||||
from zoneinfo import ZoneInfo
|
||||
|
||||
import requests
|
||||
|
||||
from backend.config import get_settings
|
||||
from backend.i18n import t, get_locale_prefix
|
||||
from karaoke_gen.utils import sanitize_filename
|
||||
@@ -205,6 +206,93 @@ class SendGridEmailProvider(EmailProvider):
|
||||
return False
|
||||
|
||||
|
||||
class PostmarkEmailProvider(EmailProvider):
|
||||
"""
|
||||
Postmark email provider for production.
|
||||
|
||||
Requires POSTMARK_SERVER_TOKEN environment variable. Sends via the
|
||||
Postmark REST API directly (no SDK dependency).
|
||||
"""
|
||||
|
||||
API_URL = "https://api.postmarkapp.com/email"
|
||||
|
||||
def __init__(self, server_token: str, from_email: str, from_name: str = "Nomad Karaoke"):
|
||||
self.server_token = server_token
|
||||
self.from_email = from_email
|
||||
self.from_name = from_name
|
||||
|
||||
def send_email(
|
||||
self,
|
||||
to_email: str,
|
||||
subject: str,
|
||||
html_content: str,
|
||||
text_content: Optional[str] = None,
|
||||
cc_emails: Optional[List[str]] = None,
|
||||
bcc_emails: Optional[List[str]] = None,
|
||||
from_email_override: Optional[str] = None,
|
||||
) -> bool:
|
||||
try:
|
||||
sender_email = from_email_override or self.from_email
|
||||
payload = {
|
||||
"From": f'"{self.from_name}" <{sender_email}>',
|
||||
"To": to_email,
|
||||
"Subject": subject,
|
||||
"HtmlBody": html_content,
|
||||
"MessageStream": "outbound",
|
||||
}
|
||||
if text_content:
|
||||
payload["TextBody"] = text_content
|
||||
|
||||
if cc_emails:
|
||||
payload["Cc"] = ", ".join(_dedupe_emails(cc_emails))
|
||||
if bcc_emails:
|
||||
payload["Bcc"] = ", ".join(_dedupe_emails(bcc_emails))
|
||||
|
||||
response = requests.post(
|
||||
self.API_URL,
|
||||
headers={
|
||||
"Accept": "application/json",
|
||||
"Content-Type": "application/json",
|
||||
"X-Postmark-Server-Token": self.server_token,
|
||||
},
|
||||
json=payload,
|
||||
timeout=10,
|
||||
)
|
||||
|
||||
if 200 <= response.status_code < 300:
|
||||
cc_info = f" (CC: {', '.join(cc_emails)})" if cc_emails else ""
|
||||
bcc_info = f" (BCC: {', '.join(bcc_emails)})" if bcc_emails else ""
|
||||
logger.info(f"Email sent to {to_email}{cc_info}{bcc_info} via Postmark")
|
||||
return True
|
||||
|
||||
# Surface Postmark's structured error so we can see suppressions, invalid signature, etc.
|
||||
try:
|
||||
err = response.json()
|
||||
logger.error(
|
||||
f"Postmark returned status {response.status_code}: "
|
||||
f"ErrorCode={err.get('ErrorCode')} Message={err.get('Message')}"
|
||||
)
|
||||
except ValueError:
|
||||
logger.error(f"Postmark returned status {response.status_code}: {response.text[:200]}")
|
||||
return False
|
||||
|
||||
except requests.RequestException:
|
||||
logger.exception("Failed to send email via Postmark")
|
||||
return False
|
||||
|
||||
|
||||
def _dedupe_emails(emails: List[str]) -> List[str]:
|
||||
"""Lowercase-normalize and deduplicate a list of email addresses, preserving order."""
|
||||
seen = set()
|
||||
out = []
|
||||
for em in emails:
|
||||
normalized = em.strip().lower()
|
||||
if normalized and normalized not in seen:
|
||||
seen.add(normalized)
|
||||
out.append(em.strip())
|
||||
return out
|
||||
|
||||
|
||||
class EmailService:
|
||||
"""
|
||||
High-level email service for sending transactional emails.
|
||||
@@ -227,21 +315,48 @@ class EmailService:
|
||||
self.buy_url = os.getenv("BUY_URL", self.frontend_url)
|
||||
|
||||
def _get_provider(self) -> EmailProvider:
|
||||
"""Get the configured email provider."""
|
||||
"""
|
||||
Get the configured email provider.
|
||||
|
||||
Selection rules:
|
||||
- EMAIL_PROVIDER=postmark → Postmark (requires POSTMARK_SERVER_TOKEN)
|
||||
- EMAIL_PROVIDER=sendgrid → SendGrid (requires SENDGRID_API_KEY)
|
||||
- Unset/auto → Postmark if its token is set, else SendGrid if its key is set, else console
|
||||
"""
|
||||
provider_name = (os.getenv("EMAIL_PROVIDER") or "").strip().lower()
|
||||
postmark_token = os.getenv("POSTMARK_SERVER_TOKEN")
|
||||
sendgrid_api_key = os.getenv("SENDGRID_API_KEY")
|
||||
from_email = os.getenv("EMAIL_FROM", "gen@nomadkaraoke.com")
|
||||
from_name = os.getenv("EMAIL_FROM_NAME", "Nomad Karaoke")
|
||||
|
||||
if sendgrid_api_key:
|
||||
if provider_name == "postmark":
|
||||
if not postmark_token:
|
||||
logger.error("EMAIL_PROVIDER=postmark but POSTMARK_SERVER_TOKEN is not set; falling back to console")
|
||||
return ConsoleEmailProvider()
|
||||
logger.info("Using Postmark email provider")
|
||||
return PostmarkEmailProvider(postmark_token, from_email, from_name)
|
||||
|
||||
if provider_name == "sendgrid":
|
||||
if not sendgrid_api_key:
|
||||
logger.error("EMAIL_PROVIDER=sendgrid but SENDGRID_API_KEY is not set; falling back to console")
|
||||
return ConsoleEmailProvider()
|
||||
logger.info("Using SendGrid email provider")
|
||||
return SendGridEmailProvider(sendgrid_api_key, from_email, from_name)
|
||||
else:
|
||||
logger.warning("No email provider configured, using console logging")
|
||||
return ConsoleEmailProvider()
|
||||
|
||||
# Auto-detect: prefer Postmark when both keys are present
|
||||
if postmark_token:
|
||||
logger.info("Using Postmark email provider (auto-detected)")
|
||||
return PostmarkEmailProvider(postmark_token, from_email, from_name)
|
||||
if sendgrid_api_key:
|
||||
logger.info("Using SendGrid email provider (auto-detected)")
|
||||
return SendGridEmailProvider(sendgrid_api_key, from_email, from_name)
|
||||
|
||||
logger.warning("No email provider configured, using console logging")
|
||||
return ConsoleEmailProvider()
|
||||
|
||||
def is_configured(self) -> bool:
|
||||
"""Check if a real email provider is configured (not just console logging)."""
|
||||
return isinstance(self.provider, SendGridEmailProvider)
|
||||
return isinstance(self.provider, (SendGridEmailProvider, PostmarkEmailProvider))
|
||||
|
||||
def send_magic_link(
|
||||
self,
|
||||
|
||||
@@ -12,6 +12,7 @@ from backend.services.email_service import (
|
||||
EmailProvider,
|
||||
ConsoleEmailProvider,
|
||||
SendGridEmailProvider,
|
||||
PostmarkEmailProvider,
|
||||
get_email_service,
|
||||
)
|
||||
|
||||
@@ -153,6 +154,165 @@ class TestSendGridEmailProvider:
|
||||
assert result is False
|
||||
|
||||
|
||||
class TestPostmarkEmailProvider:
|
||||
"""Tests for Postmark email provider."""
|
||||
|
||||
def _mock_response(self, status_code=200, body=None):
|
||||
resp = Mock()
|
||||
resp.status_code = status_code
|
||||
resp.json.return_value = body or {"To": "user@example.com", "MessageID": "abc"}
|
||||
resp.text = ""
|
||||
return resp
|
||||
|
||||
def test_send_email_success(self):
|
||||
provider = PostmarkEmailProvider(
|
||||
server_token="test-token",
|
||||
from_email="from@example.com",
|
||||
from_name="Test Sender",
|
||||
)
|
||||
|
||||
with patch("backend.services.email_service.requests.post") as mock_post:
|
||||
mock_post.return_value = self._mock_response(200)
|
||||
|
||||
result = provider.send_email(
|
||||
to_email="user@example.com",
|
||||
subject="Test Subject",
|
||||
html_content="<p>Test</p>",
|
||||
text_content="Test",
|
||||
)
|
||||
|
||||
assert result is True
|
||||
mock_post.assert_called_once()
|
||||
call = mock_post.call_args
|
||||
assert call.kwargs["headers"]["X-Postmark-Server-Token"] == "test-token"
|
||||
payload = call.kwargs["json"]
|
||||
assert payload["From"] == '"Test Sender" <from@example.com>'
|
||||
assert payload["To"] == "user@example.com"
|
||||
assert payload["Subject"] == "Test Subject"
|
||||
assert payload["HtmlBody"] == "<p>Test</p>"
|
||||
assert payload["TextBody"] == "Test"
|
||||
assert payload["MessageStream"] == "outbound"
|
||||
|
||||
def test_send_email_with_cc_and_bcc_dedupes(self):
|
||||
provider = PostmarkEmailProvider(
|
||||
server_token="test-token",
|
||||
from_email="from@example.com",
|
||||
)
|
||||
|
||||
with patch("backend.services.email_service.requests.post") as mock_post:
|
||||
mock_post.return_value = self._mock_response(200)
|
||||
|
||||
result = provider.send_email(
|
||||
to_email="user@example.com",
|
||||
subject="Test",
|
||||
html_content="<p>x</p>",
|
||||
cc_emails=["cc1@example.com", "CC1@example.com", "cc2@example.com"],
|
||||
bcc_emails=["bcc@example.com"],
|
||||
)
|
||||
|
||||
assert result is True
|
||||
payload = mock_post.call_args.kwargs["json"]
|
||||
assert payload["Cc"] == "cc1@example.com, cc2@example.com"
|
||||
assert payload["Bcc"] == "bcc@example.com"
|
||||
|
||||
def test_send_email_with_sender_override(self):
|
||||
provider = PostmarkEmailProvider(
|
||||
server_token="test-token",
|
||||
from_email="default@example.com",
|
||||
from_name="Default",
|
||||
)
|
||||
|
||||
with patch("backend.services.email_service.requests.post") as mock_post:
|
||||
mock_post.return_value = self._mock_response(200)
|
||||
|
||||
provider.send_email(
|
||||
to_email="user@example.com",
|
||||
subject="Test",
|
||||
html_content="<p>x</p>",
|
||||
from_email_override="tenant@partner.com",
|
||||
)
|
||||
|
||||
payload = mock_post.call_args.kwargs["json"]
|
||||
assert payload["From"] == '"Default" <tenant@partner.com>'
|
||||
|
||||
def test_send_email_failure_status(self):
|
||||
provider = PostmarkEmailProvider(server_token="t", from_email="f@e.com")
|
||||
|
||||
with patch("backend.services.email_service.requests.post") as mock_post:
|
||||
mock_post.return_value = self._mock_response(
|
||||
422, body={"ErrorCode": 406, "Message": "Inactive recipient"}
|
||||
)
|
||||
|
||||
result = provider.send_email(
|
||||
to_email="user@example.com",
|
||||
subject="Test",
|
||||
html_content="<p>x</p>",
|
||||
)
|
||||
|
||||
assert result is False
|
||||
|
||||
def test_send_email_request_exception(self):
|
||||
import requests as _requests
|
||||
provider = PostmarkEmailProvider(server_token="t", from_email="f@e.com")
|
||||
|
||||
with patch("backend.services.email_service.requests.post") as mock_post:
|
||||
mock_post.side_effect = _requests.ConnectionError("network down")
|
||||
|
||||
result = provider.send_email(
|
||||
to_email="user@example.com",
|
||||
subject="Test",
|
||||
html_content="<p>x</p>",
|
||||
)
|
||||
|
||||
assert result is False
|
||||
|
||||
|
||||
class TestEmailServiceProviderSelection:
|
||||
"""Tests for EmailService._get_provider() selection logic."""
|
||||
|
||||
@pytest.fixture(autouse=True)
|
||||
def _clear_env(self, monkeypatch):
|
||||
for var in ("EMAIL_PROVIDER", "POSTMARK_SERVER_TOKEN", "SENDGRID_API_KEY"):
|
||||
monkeypatch.delenv(var, raising=False)
|
||||
|
||||
def test_explicit_postmark_uses_postmark(self, monkeypatch):
|
||||
monkeypatch.setenv("EMAIL_PROVIDER", "postmark")
|
||||
monkeypatch.setenv("POSTMARK_SERVER_TOKEN", "pm-token")
|
||||
monkeypatch.setenv("SENDGRID_API_KEY", "sg-key")
|
||||
svc = EmailService()
|
||||
assert isinstance(svc.provider, PostmarkEmailProvider)
|
||||
assert svc.is_configured() is True
|
||||
|
||||
def test_explicit_sendgrid_uses_sendgrid(self, monkeypatch):
|
||||
monkeypatch.setenv("EMAIL_PROVIDER", "sendgrid")
|
||||
monkeypatch.setenv("POSTMARK_SERVER_TOKEN", "pm-token")
|
||||
monkeypatch.setenv("SENDGRID_API_KEY", "sg-key")
|
||||
svc = EmailService()
|
||||
assert isinstance(svc.provider, SendGridEmailProvider)
|
||||
|
||||
def test_explicit_postmark_without_token_falls_back_to_console(self, monkeypatch):
|
||||
monkeypatch.setenv("EMAIL_PROVIDER", "postmark")
|
||||
monkeypatch.setenv("SENDGRID_API_KEY", "sg-key")
|
||||
svc = EmailService()
|
||||
assert isinstance(svc.provider, ConsoleEmailProvider)
|
||||
assert svc.is_configured() is False
|
||||
|
||||
def test_auto_prefers_postmark_when_both_keys_set(self, monkeypatch):
|
||||
monkeypatch.setenv("POSTMARK_SERVER_TOKEN", "pm-token")
|
||||
monkeypatch.setenv("SENDGRID_API_KEY", "sg-key")
|
||||
svc = EmailService()
|
||||
assert isinstance(svc.provider, PostmarkEmailProvider)
|
||||
|
||||
def test_auto_falls_back_to_sendgrid_when_only_sendgrid_set(self, monkeypatch):
|
||||
monkeypatch.setenv("SENDGRID_API_KEY", "sg-key")
|
||||
svc = EmailService()
|
||||
assert isinstance(svc.provider, SendGridEmailProvider)
|
||||
|
||||
def test_auto_uses_console_when_no_keys(self, monkeypatch):
|
||||
svc = EmailService()
|
||||
assert isinstance(svc.provider, ConsoleEmailProvider)
|
||||
|
||||
|
||||
class TestEmailServiceJobCompletion:
|
||||
"""Tests for job completion email method."""
|
||||
|
||||
|
||||
@@ -247,6 +247,12 @@ gdrive_validator_function = cloudfunctionsv2.Function(
|
||||
secret=all_secrets["sendgrid-api-key"].secret_id,
|
||||
version="latest",
|
||||
),
|
||||
cloudfunctionsv2.FunctionServiceConfigSecretEnvironmentVariableArgs(
|
||||
key="POSTMARK_SERVER_TOKEN",
|
||||
project_id=PROJECT_ID,
|
||||
secret=all_secrets["postmark-server-token"].secret_id,
|
||||
version="latest",
|
||||
),
|
||||
],
|
||||
),
|
||||
)
|
||||
|
||||
@@ -54,7 +54,7 @@ gcloud functions deploy "${FUNCTION_NAME}" \
|
||||
--max-instances=1 \
|
||||
--service-account="gdrive-validator@${PROJECT_ID}.iam.gserviceaccount.com" \
|
||||
--set-env-vars="GDRIVE_FOLDER_ID=1laRKAyxo0v817SstfM5XkpbWiNKNAMSX,EMAIL_TO=gen@nomadkaraoke.com,EMAIL_FROM=gen@nomadkaraoke.com,NOTIFY_ON_SUCCESS=true" \
|
||||
--set-secrets="PUSHBULLET_API_KEY=pushbullet-api-key:latest,SENDGRID_API_KEY=sendgrid-api-key:latest" \
|
||||
--set-secrets="PUSHBULLET_API_KEY=pushbullet-api-key:latest,POSTMARK_SERVER_TOKEN=postmark-server-token:latest" \
|
||||
--project="${PROJECT_ID}"
|
||||
|
||||
echo ""
|
||||
|
||||
@@ -6,7 +6,7 @@ Validates the Nomad Karaoke public share folder for:
|
||||
- Invalid filename formats
|
||||
- Sequence gaps (with configurable known gaps)
|
||||
|
||||
Sends email notification (via SendGrid) if issues are detected.
|
||||
Sends email notification (via Postmark) if issues are detected.
|
||||
Pushbullet is kept as a secondary fallback.
|
||||
|
||||
Triggered daily via Cloud Scheduler and after each job completion.
|
||||
@@ -30,7 +30,7 @@ logger = logging.getLogger(__name__)
|
||||
# Configuration from environment variables
|
||||
GDRIVE_FOLDER_ID = os.environ.get("GDRIVE_FOLDER_ID", "1laRKAyxo0v817SstfM5XkpbWiNKNAMSX")
|
||||
PUSHBULLET_API_KEY = os.environ.get("PUSHBULLET_API_KEY", "").strip()
|
||||
SENDGRID_API_KEY = os.environ.get("SENDGRID_API_KEY", "").strip()
|
||||
POSTMARK_SERVER_TOKEN = os.environ.get("POSTMARK_SERVER_TOKEN", "").strip()
|
||||
EMAIL_TO = os.environ.get("EMAIL_TO", "gen@nomadkaraoke.com")
|
||||
EMAIL_FROM = os.environ.get("EMAIL_FROM", "gen@nomadkaraoke.com")
|
||||
|
||||
@@ -330,40 +330,51 @@ def format_notification(issues: dict) -> tuple[str, str]:
|
||||
|
||||
|
||||
def send_email_notification(subject: str, body: str) -> bool:
|
||||
"""Send a notification via SendGrid email API."""
|
||||
if not SENDGRID_API_KEY:
|
||||
logger.warning("SENDGRID_API_KEY not set, skipping email notification")
|
||||
"""Send a notification via Postmark email API."""
|
||||
if not POSTMARK_SERVER_TOKEN:
|
||||
logger.warning("POSTMARK_SERVER_TOKEN not set, skipping email notification")
|
||||
return False
|
||||
|
||||
try:
|
||||
from sendgrid import SendGridAPIClient
|
||||
from sendgrid.helpers.mail import Mail, Email, To, Content
|
||||
|
||||
sg = SendGridAPIClient(api_key=SENDGRID_API_KEY)
|
||||
|
||||
# Convert plain text body to simple HTML (preserve whitespace/newlines)
|
||||
html_body = body.replace("&", "&").replace("<", "<").replace(">", ">")
|
||||
html_body = html_body.replace("\n", "<br>\n")
|
||||
html_body = f"<pre style='font-family: monospace; white-space: pre-wrap;'>{html_body}</pre>"
|
||||
|
||||
message = Mail(
|
||||
from_email=Email(EMAIL_FROM, "Nomad Karaoke GDrive Validator"),
|
||||
to_emails=To(EMAIL_TO),
|
||||
subject=subject,
|
||||
html_content=Content("text/html", html_body),
|
||||
response = requests.post(
|
||||
"https://api.postmarkapp.com/email",
|
||||
headers={
|
||||
"Accept": "application/json",
|
||||
"Content-Type": "application/json",
|
||||
"X-Postmark-Server-Token": POSTMARK_SERVER_TOKEN,
|
||||
},
|
||||
json={
|
||||
"From": f'"Nomad Karaoke GDrive Validator" <{EMAIL_FROM}>',
|
||||
"To": EMAIL_TO,
|
||||
"Subject": subject,
|
||||
"HtmlBody": html_body,
|
||||
"TextBody": body,
|
||||
"MessageStream": "outbound",
|
||||
},
|
||||
timeout=10,
|
||||
)
|
||||
|
||||
response = sg.send(message)
|
||||
|
||||
if 200 <= response.status_code < 300:
|
||||
logger.info(f"Email notification sent to {EMAIL_TO}")
|
||||
logger.info(f"Email notification sent to {EMAIL_TO} via Postmark")
|
||||
return True
|
||||
else:
|
||||
logger.error(f"SendGrid returned status {response.status_code}")
|
||||
return False
|
||||
|
||||
try:
|
||||
err = response.json()
|
||||
logger.error(
|
||||
f"Postmark returned status {response.status_code}: "
|
||||
f"ErrorCode={err.get('ErrorCode')} Message={err.get('Message')}"
|
||||
)
|
||||
except ValueError:
|
||||
logger.error(f"Postmark returned status {response.status_code}: {response.text[:200]}")
|
||||
return False
|
||||
|
||||
except Exception:
|
||||
logger.exception("Failed to send email notification via SendGrid")
|
||||
logger.exception("Failed to send email notification via Postmark")
|
||||
return False
|
||||
|
||||
|
||||
|
||||
@@ -5,9 +5,6 @@ google-auth>=2.23.0
|
||||
# Cloud Functions framework
|
||||
functions-framework>=3.0.0
|
||||
|
||||
# HTTP requests for Pushbullet API
|
||||
# HTTP requests for Pushbullet and Postmark APIs
|
||||
requests>=2.31.0
|
||||
|
||||
# Email notifications via SendGrid
|
||||
sendgrid>=6.0.0
|
||||
|
||||
@@ -509,7 +509,16 @@ def create_video_encoding_job(
|
||||
name="GOOGLE_CLOUD_PROJECT",
|
||||
value=PROJECT_ID,
|
||||
),
|
||||
# SendGrid for completion emails
|
||||
# Email provider for completion emails (Postmark primary, SendGrid fallback)
|
||||
cloudrunv2.JobTemplateTemplateContainerEnvArgs(
|
||||
name="POSTMARK_SERVER_TOKEN",
|
||||
value_source=cloudrunv2.JobTemplateTemplateContainerEnvValueSourceArgs(
|
||||
secret_key_ref=cloudrunv2.JobTemplateTemplateContainerEnvValueSourceSecretKeyRefArgs(
|
||||
secret=f"projects/{PROJECT_ID}/secrets/postmark-server-token",
|
||||
version="latest",
|
||||
),
|
||||
),
|
||||
),
|
||||
cloudrunv2.JobTemplateTemplateContainerEnvArgs(
|
||||
name="SENDGRID_API_KEY",
|
||||
value_source=cloudrunv2.JobTemplateTemplateContainerEnvValueSourceArgs(
|
||||
|
||||
@@ -26,7 +26,8 @@ def create_secrets() -> dict[str, secretmanager.Secret]:
|
||||
# Payment and email
|
||||
"stripe-secret-key",
|
||||
"stripe-webhook-secret",
|
||||
"sendgrid-api-key",
|
||||
"sendgrid-api-key", # Legacy — retained during Postmark cutover; remove once stable
|
||||
"postmark-server-token",
|
||||
|
||||
# Observability (Langfuse for LLM tracing)
|
||||
"langfuse-public-key",
|
||||
|
||||
+1
-1
@@ -1,6 +1,6 @@
|
||||
[tool.poetry]
|
||||
name = "karaoke-gen"
|
||||
version = "0.172.3"
|
||||
version = "0.172.4"
|
||||
description = "Generate karaoke videos with synchronized lyrics. Handles the entire process from downloading audio and lyrics to creating the final video with title screens."
|
||||
authors = ["Andrew Beveridge <andrew@beveridge.uk>"]
|
||||
license = "MIT"
|
||||
|
||||
Reference in new issue
Block a user