mirror of
https://github.com/langbot-app/LangBot.git
synced 2026-08-24 11:07:14 +00:00
Hyu
a45e27e76e
* style(cloud): redesign workspace invitation email * fix(email): harden Outlook spacing and text contrast --------- Co-authored-by: Junyan Qin <rockchinq@gmail.com>
365 lines
15 KiB
Python
365 lines
15 KiB
Python
from __future__ import annotations
|
||
|
||
import asyncio
|
||
import dataclasses
|
||
import os
|
||
import smtplib
|
||
import ssl
|
||
import typing
|
||
from email.message import EmailMessage
|
||
from urllib.parse import quote
|
||
|
||
import httpx
|
||
|
||
from ..utils import httpclient
|
||
|
||
if typing.TYPE_CHECKING:
|
||
from ..core.app import Application
|
||
|
||
|
||
DeliveryStatus = typing.Literal['sent', 'link_only', 'failed']
|
||
|
||
|
||
@dataclasses.dataclass(frozen=True, slots=True)
|
||
class InvitationDeliveryResult:
|
||
status: DeliveryStatus
|
||
provider: str | None
|
||
|
||
def to_public_dict(self) -> dict[str, str | None]:
|
||
return {'status': self.status, 'provider': self.provider}
|
||
|
||
|
||
@dataclasses.dataclass(frozen=True, slots=True)
|
||
class _EmailConfig:
|
||
provider: typing.Literal['resend', 'smtp'] | None
|
||
sender: str
|
||
resend_api_key: str
|
||
resend_api_url: str
|
||
smtp_host: str
|
||
smtp_port: int
|
||
smtp_username: str
|
||
smtp_password: str
|
||
smtp_starttls: bool
|
||
smtp_ssl: bool
|
||
timeout: float
|
||
|
||
|
||
class InvitationDeliveryService:
|
||
"""Optional Workspace invitation email delivery.
|
||
|
||
The invitation link is always returned to the caller. Email failures are
|
||
reported as non-secret status and never invalidate the persisted invite.
|
||
"""
|
||
|
||
def __init__(self, ap: Application) -> None:
|
||
self.ap = ap
|
||
|
||
def capability(self) -> dict[str, str | bool | None]:
|
||
config = self._email_config()
|
||
return {'enabled': config.provider is not None, 'provider': config.provider}
|
||
|
||
def build_invitation_link(self, token: str) -> str:
|
||
base_url = self._public_web_url().rstrip('/')
|
||
return f'{base_url}/invitations/accept#token={quote(token, safe="")}'
|
||
|
||
async def deliver_invitation(
|
||
self,
|
||
*,
|
||
recipient_email: str,
|
||
workspace_name: str,
|
||
invitation_link: str,
|
||
) -> InvitationDeliveryResult:
|
||
config = self._email_config()
|
||
if config.provider is None:
|
||
return InvitationDeliveryResult(status='link_only', provider=None)
|
||
|
||
try:
|
||
if config.provider == 'resend':
|
||
sent = await self._send_resend(config, recipient_email, workspace_name, invitation_link)
|
||
else:
|
||
sent = await self._send_smtp(config, recipient_email, workspace_name, invitation_link)
|
||
except Exception as exc:
|
||
self._log_delivery_failure(config.provider, exc)
|
||
sent = False
|
||
|
||
return InvitationDeliveryResult(
|
||
status='sent' if sent else 'failed',
|
||
provider=config.provider,
|
||
)
|
||
|
||
async def _send_resend(
|
||
self,
|
||
config: _EmailConfig,
|
||
recipient_email: str,
|
||
workspace_name: str,
|
||
invitation_link: str,
|
||
) -> bool:
|
||
payload = {
|
||
'from': config.sender,
|
||
'to': [recipient_email],
|
||
'subject': f'You were invited to {workspace_name}',
|
||
'text': self._plain_text(workspace_name, invitation_link),
|
||
'html': self._html(workspace_name, invitation_link),
|
||
}
|
||
async with httpx.AsyncClient(
|
||
timeout=httpx.Timeout(config.timeout),
|
||
trust_env=True,
|
||
event_hooks=httpclient.httpx_response_limit_hooks(),
|
||
) as client:
|
||
response = await client.post(
|
||
config.resend_api_url,
|
||
headers={'Authorization': f'Bearer {config.resend_api_key}'},
|
||
json=payload,
|
||
)
|
||
if response.status_code >= 400:
|
||
self._log_delivery_failure(
|
||
config.provider or 'resend', RuntimeError(f'Resend returned {response.status_code}')
|
||
)
|
||
return False
|
||
return True
|
||
|
||
async def _send_smtp(
|
||
self,
|
||
config: _EmailConfig,
|
||
recipient_email: str,
|
||
workspace_name: str,
|
||
invitation_link: str,
|
||
) -> bool:
|
||
message = EmailMessage()
|
||
message['From'] = config.sender
|
||
message['To'] = recipient_email
|
||
message['Subject'] = f'You were invited to {workspace_name}'
|
||
message.set_content(self._plain_text(workspace_name, invitation_link))
|
||
message.add_alternative(self._html(workspace_name, invitation_link), subtype='html')
|
||
|
||
return await asyncio.to_thread(self._send_smtp_sync, config, message)
|
||
|
||
@staticmethod
|
||
def _send_smtp_sync(config: _EmailConfig, message: EmailMessage) -> bool:
|
||
smtp_cls = smtplib.SMTP_SSL if config.smtp_ssl else smtplib.SMTP
|
||
context = ssl.create_default_context()
|
||
with smtp_cls(config.smtp_host, config.smtp_port, timeout=config.timeout) as smtp:
|
||
if config.smtp_starttls and not config.smtp_ssl:
|
||
smtp.starttls(context=context)
|
||
if config.smtp_username:
|
||
smtp.login(config.smtp_username, config.smtp_password)
|
||
smtp.send_message(message)
|
||
return True
|
||
|
||
def _email_config(self) -> _EmailConfig:
|
||
data = getattr(getattr(self.ap, 'instance_config', None), 'data', {}) or {}
|
||
email = data.get('workspace', {}).get('invitations', {}).get('email', {})
|
||
if not isinstance(email, dict):
|
||
email = {}
|
||
raw_provider = self._env('WORKSPACE__INVITATIONS__EMAIL__PROVIDER', email.get('provider', ''))
|
||
raw_provider = str(raw_provider or '').strip().casefold()
|
||
provider: typing.Literal['resend', 'smtp'] | None
|
||
provider = raw_provider if raw_provider in {'resend', 'smtp'} else None
|
||
sender = str(self._env('WORKSPACE__INVITATIONS__EMAIL__FROM', email.get('from', '')) or '').strip()
|
||
timeout = self._number(
|
||
self._env('WORKSPACE__INVITATIONS__EMAIL__TIMEOUT_SECONDS', email.get('timeout_seconds', 10)),
|
||
10.0,
|
||
)
|
||
|
||
resend = email.get('resend', {})
|
||
if not isinstance(resend, dict):
|
||
resend = {}
|
||
smtp_config = email.get('smtp', {})
|
||
if not isinstance(smtp_config, dict):
|
||
smtp_config = {}
|
||
|
||
resend_api_key = str(
|
||
self._env('WORKSPACE__INVITATIONS__EMAIL__RESEND__API_KEY', resend.get('api_key', '')) or ''
|
||
).strip()
|
||
resend_api_url = str(
|
||
self._env(
|
||
'WORKSPACE__INVITATIONS__EMAIL__RESEND__API_URL',
|
||
resend.get('api_url', 'https://api.resend.com/emails'),
|
||
)
|
||
or ''
|
||
).strip()
|
||
smtp_host = str(
|
||
self._env('WORKSPACE__INVITATIONS__EMAIL__SMTP__HOST', smtp_config.get('host', '')) or ''
|
||
).strip()
|
||
smtp_port = int(
|
||
self._number(self._env('WORKSPACE__INVITATIONS__EMAIL__SMTP__PORT', smtp_config.get('port', 587)), 587)
|
||
)
|
||
smtp_username = str(
|
||
self._env('WORKSPACE__INVITATIONS__EMAIL__SMTP__USERNAME', smtp_config.get('username', '')) or ''
|
||
).strip()
|
||
smtp_password = str(
|
||
self._env('WORKSPACE__INVITATIONS__EMAIL__SMTP__PASSWORD', smtp_config.get('password', '')) or ''
|
||
)
|
||
smtp_starttls = self._bool(
|
||
self._env('WORKSPACE__INVITATIONS__EMAIL__SMTP__STARTTLS', smtp_config.get('starttls', True))
|
||
)
|
||
smtp_ssl = self._bool(self._env('WORKSPACE__INVITATIONS__EMAIL__SMTP__SSL', smtp_config.get('ssl', False)))
|
||
|
||
if provider == 'resend' and not (sender and resend_api_key and resend_api_url):
|
||
provider = None
|
||
elif provider == 'smtp' and not (sender and smtp_host):
|
||
provider = None
|
||
|
||
return _EmailConfig(
|
||
provider=provider,
|
||
sender=sender,
|
||
resend_api_key=resend_api_key,
|
||
resend_api_url=resend_api_url,
|
||
smtp_host=smtp_host,
|
||
smtp_port=smtp_port,
|
||
smtp_username=smtp_username,
|
||
smtp_password=smtp_password,
|
||
smtp_starttls=smtp_starttls,
|
||
smtp_ssl=smtp_ssl,
|
||
timeout=timeout,
|
||
)
|
||
|
||
def _public_web_url(self) -> str:
|
||
data = getattr(getattr(self.ap, 'instance_config', None), 'data', {}) or {}
|
||
invitations = data.get('workspace', {}).get('invitations', {})
|
||
configured = ''
|
||
if isinstance(invitations, dict):
|
||
configured = str(
|
||
self._env('WORKSPACE__INVITATIONS__PUBLIC_WEB_URL', invitations.get('public_web_url', '')) or ''
|
||
).strip()
|
||
if configured:
|
||
return configured
|
||
api = data.get('api', {})
|
||
if isinstance(api, dict):
|
||
webui_url = str(api.get('webui_url', '') or '').strip()
|
||
if webui_url:
|
||
return webui_url
|
||
webhook_prefix = str(api.get('webhook_prefix', '') or '').strip()
|
||
if webhook_prefix:
|
||
return webhook_prefix
|
||
port = api.get('port', 5300)
|
||
else:
|
||
port = 5300
|
||
return f'http://127.0.0.1:{port}'
|
||
|
||
@staticmethod
|
||
def _plain_text(workspace_name: str, invitation_link: str) -> str:
|
||
return (
|
||
'You have been invited to LangBot Cloud\n\n'
|
||
f'Join the Workspace “{workspace_name}” to collaborate with your team.\n\n'
|
||
f'Accept invitation: {invitation_link}\n\n'
|
||
'This secure invitation expires in 7 days and can only be accepted by the email address '
|
||
'it was sent to. If you were not expecting it, you can safely ignore this email.\n'
|
||
)
|
||
|
||
@staticmethod
|
||
def _html(workspace_name: str, invitation_link: str) -> str:
|
||
import html
|
||
|
||
escaped_workspace = html.escape(workspace_name, quote=True)
|
||
escaped_link = html.escape(invitation_link, quote=True)
|
||
return f'''<!doctype html>
|
||
<html lang="en">
|
||
<head>
|
||
<meta charset="utf-8">
|
||
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||
<title>Join {escaped_workspace} on LangBot Cloud</title>
|
||
</head>
|
||
<body style="margin:0;padding:0;background:#f4f7fb;color:#111827;font-family:Arial,'Helvetica Neue',sans-serif;">
|
||
<div style="display:none;max-height:0;overflow:hidden;opacity:0;">You have been invited to join {escaped_workspace} on LangBot Cloud.</div>
|
||
<table role="presentation" width="100%" cellspacing="0" cellpadding="0" border="0" style="width:100%;background:#f4f7fb;">
|
||
<tr>
|
||
<td align="center" style="padding:48px 16px;">
|
||
<table role="presentation" width="100%" cellspacing="0" cellpadding="0" border="0" style="width:100%;max-width:600px;">
|
||
<tr>
|
||
<td style="padding:0 4px 20px;">
|
||
<a href="https://cloud.langbot.app" style="display:inline-block;text-decoration:none;color:#111827;">
|
||
<img src="https://docs.langbot.app/langbot-logo.png" alt="LangBot" width="34" height="34" style="display:inline-block;width:34px;height:34px;border:0;vertical-align:middle;">
|
||
<span style="display:inline-block;margin-left:10px;vertical-align:middle;font-size:18px;font-weight:700;letter-spacing:-.01em;">LangBot Cloud</span>
|
||
</a>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td style="background:#ffffff;border:1px solid #dfe6f0;border-top:4px solid #2563eb;border-radius:14px;overflow:hidden;">
|
||
<table role="presentation" width="100%" cellspacing="0" cellpadding="0" border="0">
|
||
<tr>
|
||
<td style="padding:42px 42px 38px;">
|
||
<div style="margin:0 0 12px;font-size:12px;line-height:1.4;font-weight:700;letter-spacing:.11em;text-transform:uppercase;color:#2563eb;">Workspace invitation</div>
|
||
<h1 style="margin:0 0 16px;font-size:28px;line-height:1.25;font-weight:700;letter-spacing:-.025em;color:#111827;">You’re invited to collaborate</h1>
|
||
<p style="margin:0 0 28px;font-size:15px;line-height:1.7;color:#526173;">Join your team on LangBot Cloud and start building together in this Workspace.</p>
|
||
|
||
<table role="presentation" width="100%" cellspacing="0" cellpadding="0" border="0" style="background:#f5f8ff;border:1px solid #dbe7ff;border-radius:10px;">
|
||
<tr>
|
||
<td style="width:4px;background:#2563eb;border-radius:10px 0 0 10px;font-size:0;line-height:0;"> </td>
|
||
<td style="padding:16px 18px;">
|
||
<div style="margin:0 0 4px;font-size:11px;line-height:1.4;font-weight:700;letter-spacing:.08em;text-transform:uppercase;color:#5f6f84;">Workspace</div>
|
||
<div style="font-size:18px;line-height:1.4;font-weight:700;color:#111827;">{escaped_workspace}</div>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
|
||
<table role="presentation" width="100%" cellspacing="0" cellpadding="0" border="0">
|
||
<tr><td height="28" style="height:28px;font-size:0;line-height:0;"> </td></tr>
|
||
</table>
|
||
|
||
<table role="presentation" cellspacing="0" cellpadding="0" border="0">
|
||
<tr>
|
||
<td style="background:#2563eb;border-radius:8px;">
|
||
<a href="{escaped_link}" target="_blank" style="display:inline-block;padding:13px 22px;font-size:15px;line-height:1.2;font-weight:700;color:#ffffff;text-decoration:none;border-radius:8px;">Accept invitation</a>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
|
||
<table role="presentation" width="100%" cellspacing="0" cellpadding="0" border="0">
|
||
<tr><td height="32" style="height:32px;font-size:0;line-height:0;"> </td></tr>
|
||
</table>
|
||
|
||
<table role="presentation" width="100%" cellspacing="0" cellpadding="0" border="0" style="border-top:1px solid #e8edf4;">
|
||
<tr>
|
||
<td style="padding-top:22px;">
|
||
<p style="margin:0 0 10px;font-size:13px;line-height:1.6;color:#5f6f84;">For your security, this invitation expires in 7 days and only works for the email address that received it.</p>
|
||
<a href="{escaped_link}" target="_blank" style="font-size:13px;line-height:1.6;font-weight:600;color:#2563eb;text-decoration:none;">Open invitation link →</a>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td align="center" style="padding:20px 24px 0;font-size:12px;line-height:1.6;color:#5f6f84;">
|
||
Sent by LangBot Cloud<br>
|
||
If you were not expecting this invitation, you can safely ignore this email.
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
</body>
|
||
</html>'''
|
||
|
||
@staticmethod
|
||
def _number(value: typing.Any, default: float) -> float:
|
||
try:
|
||
return float(value)
|
||
except (TypeError, ValueError):
|
||
return default
|
||
|
||
@staticmethod
|
||
def _bool(value: typing.Any) -> bool:
|
||
if isinstance(value, bool):
|
||
return value
|
||
if isinstance(value, str):
|
||
return value.strip().lower() in {'true', '1', 'yes', 'on'}
|
||
return bool(value)
|
||
|
||
@staticmethod
|
||
def _env(name: str, fallback: typing.Any) -> typing.Any:
|
||
value = os.environ.get(name)
|
||
if value is None:
|
||
return fallback
|
||
return value
|
||
|
||
def _log_delivery_failure(self, provider: str, exc: Exception) -> None:
|
||
logger = getattr(self.ap, 'logger', None)
|
||
if logger is not None:
|
||
logger.warning(f'Workspace invitation email delivery via {provider} failed: {exc.__class__.__name__}')
|