arize-phoenix 8.22.1__py3-none-any.whl → 8.24.0__py3-none-any.whl

phoenix/server/email/sender.py

@@ -1,14 +1,19 @@
-import asyncio
 import smtplib
 import ssl
 from email.message import EmailMessage
 from pathlib import Path
 from typing import Literal
 
+from anyio import to_thread
 from jinja2 import Environment, FileSystemLoader, select_autoescape
+from typing_extensions import TypeAlias
+
+from phoenix.config import get_env_root_url
 
 EMAIL_TEMPLATE_FOLDER = Path(__file__).parent / "templates"
 
+ConnectionMethod: TypeAlias = Literal["STARTTLS", "SSL", "PLAIN"]
+
 
 class SimpleEmailSender:
     def __init__(
@@ -18,7 +23,7 @@ class SimpleEmailSender:
         username: str,
         password: str,
         sender_email: str,
-        connection_method: Literal["STARTTLS", "SSL", "PLAIN"] = "STARTTLS",
+        connection_method: ConnectionMethod = "STARTTLS",
         validate_certs: bool = True,
     ) -> None:
         self.smtp_server = smtp_server
@@ -26,7 +31,7 @@ class SimpleEmailSender:
         self.username = username
         self.password = password
         self.sender_email = sender_email
-        self.connection_method = connection_method.upper()
+        self.connection_method: ConnectionMethod = connection_method
         self.validate_certs = validate_certs
 
         self.env = Environment(
@@ -34,6 +39,28 @@ class SimpleEmailSender:
             autoescape=select_autoescape(["html", "xml"]),
         )
 
+    async def send_welcome_email(
+        self,
+        email: str,
+        name: str,
+    ) -> None:
+        subject = "[Phoenix] Welcome to Arize Phoenix"
+        template_name = "welcome.html"
+
+        template = self.env.get_template(template_name)
+        html_content = template.render(
+            name=name,
+            welcome_url=str(get_env_root_url()),
+        )
+
+        msg = EmailMessage()
+        msg["Subject"] = subject
+        msg["From"] = self.sender_email
+        msg["To"] = email
+        msg.set_content(html_content, subtype="html")
+
+        await to_thread.run_sync(self._send_email, msg)
+
     async def send_password_reset_email(
         self,
         email: str,
@@ -51,47 +78,47 @@ class SimpleEmailSender:
         msg["To"] = email
         msg.set_content(html_content, subtype="html")
 
-        def send_email() -> None:
-            context: ssl.SSLContext
-            if self.validate_certs:
-                context = ssl.create_default_context()
-            else:
-                context = ssl._create_unverified_context()
-
-            methods_to_try = [self.connection_method]
-            # add secure method fallbacks
-            if self.connection_method != "PLAIN":
-                if self.connection_method != "STARTTLS":
-                    methods_to_try.append("STARTTLS")
-                elif self.connection_method != "SSL":
-                    methods_to_try.append("SSL")
-
-            for method in methods_to_try:
-                try:
-                    if method == "STARTTLS":
-                        server = smtplib.SMTP(self.smtp_server, self.smtp_port)
-                        server.ehlo()
-                        server.starttls(context=context)
-                        server.ehlo()
-                    elif method == "SSL":
-                        server = smtplib.SMTP_SSL(self.smtp_server, self.smtp_port, context=context)
-                        server.ehlo()
-                    elif method == "PLAIN":
-                        server = smtplib.SMTP(self.smtp_server, self.smtp_port)
-                        server.ehlo()
-                    else:
-                        continue  # Unsupported method
-
-                    if self.username and self.password:
-                        server.login(self.username, self.password)
-
-                    server.send_message(msg)
-                    server.quit()
-                    break  # Success
-                except Exception as e:
-                    print(f"Failed to send email using {method}: {e}")
-                    continue
-            else:
-                raise Exception("All connection methods failed")
-
-        await asyncio.to_thread(send_email)
+        await to_thread.run_sync(self._send_email, msg)
+
+    def _send_email(self, msg: EmailMessage) -> None:
+        context: ssl.SSLContext
+        if self.validate_certs:
+            context = ssl.create_default_context()
+        else:
+            context = ssl._create_unverified_context()
+
+        methods_to_try: list[ConnectionMethod] = [self.connection_method]
+        # add secure method fallbacks
+        if self.connection_method != "PLAIN":
+            if self.connection_method != "STARTTLS":
+                methods_to_try.append("STARTTLS")
+            if self.connection_method != "SSL":
+                methods_to_try.append("SSL")
+
+        for method in methods_to_try:
+            try:
+                if method == "STARTTLS":
+                    server = smtplib.SMTP(self.smtp_server, self.smtp_port)
+                    server.ehlo()
+                    server.starttls(context=context)
+                    server.ehlo()
+                elif method == "SSL":
+                    server = smtplib.SMTP_SSL(self.smtp_server, self.smtp_port, context=context)
+                    server.ehlo()
+                elif method == "PLAIN":
+                    server = smtplib.SMTP(self.smtp_server, self.smtp_port)
+                    server.ehlo()
+                else:
+                    continue  # Unsupported method
+
+                if self.username and self.password:
+                    server.login(self.username, self.password)
+
+                server.send_message(msg)
+                server.quit()
+                break  # Success
+            except Exception as e:
+                print(f"Failed to send email using {method}: {e}")
+                continue
+        else:
+            raise Exception("All connection methods failed")

phoenix/server/email/templates/welcome.html

@@ -0,0 +1,12 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="UTF-8" />
+    <title>Welcome to Arize Phoenix</title>
+  </head>
+  <body>
+    <h1>Welcome to Arize Phoenix!</h1>
+    <p>Hi {{ name }}, please click the link below to get started:</p>
+    <a href="{{ welcome_url }}">Get Started</a>
+  </body>
+</html>

phoenix/server/email/types.py

@@ -3,9 +3,24 @@ from __future__ import annotations
 from typing import Protocol
 
 
-class EmailSender(Protocol):
+class WelcomeEmailSender(Protocol):
+    async def send_welcome_email(
+        self,
+        email: str,
+        name: str,
+    ) -> None: ...
+
+
+class PasswordResetEmailSender(Protocol):
     async def send_password_reset_email(
         self,
         email: str,
         reset_url: str,
     ) -> None: ...
+
+
+class EmailSender(
+    WelcomeEmailSender,
+    PasswordResetEmailSender,
+    Protocol,
+): ...

phoenix/server/main.py

@@ -16,6 +16,7 @@ import phoenix.trace.v1 as pb
 from phoenix.config import (
     EXPORT_DIR,
     get_env_access_token_expiry,
+    get_env_allowed_origins,
     get_env_auth_settings,
     get_env_database_connection_str,
     get_env_database_schema,
@@ -60,6 +61,7 @@ from phoenix.server.app import (
     instrument_engine_if_enabled,
 )
 from phoenix.server.email.sender import SimpleEmailSender
+from phoenix.server.email.types import EmailSender
 from phoenix.server.types import DbSessionFactory
 from phoenix.settings import Settings
 from phoenix.trace.fixtures import (
@@ -98,6 +100,7 @@ _WELCOME_MESSAGE = Environment(loader=BaseLoader()).from_string("""
 |  Phoenix UI: {{ ui_path }}
 |  Authentication: {{ auth_enabled }}
 |  Websockets: {{ websockets_enabled }}
+{%- if allowed_origins %}\n|  Allowed Origins: {{ allowed_origins }}{% endif %}
 |  Log traces:
 |    - gRPC: {{ grpc_path }}
 |    - HTTP: {{ http_path }}
@@ -359,6 +362,8 @@ def main() -> None:
     if enable_websockets is None:
         enable_websockets = True
 
+    allowed_origins = get_env_allowed_origins()
+
     # Print information about the server
     root_path = urljoin(f"http://{host}:{port}", host_root_path)
     msg = _WELCOME_MESSAGE.render(
@@ -370,6 +375,7 @@ def main() -> None:
         schema=get_env_database_schema(),
         auth_enabled=authentication_enabled,
         websockets_enabled=enable_websockets,
+        allowed_origins=allowed_origins,
     )
     if sys.platform.startswith("win"):
         msg = codecs.encode(msg, "ascii", errors="ignore").decode("ascii").strip()
@@ -380,7 +386,7 @@ def main() -> None:
         scaffold_datasets=scaffold_datasets,
         phoenix_url=root_path,
     )
-    email_sender = None
+    email_sender: Optional[EmailSender] = None
     if mail_sever := get_env_smtp_hostname():
         assert (mail_username := get_env_smtp_username()), "SMTP username is required"
         assert (mail_password := get_env_smtp_password()), "SMTP password is required"
@@ -419,6 +425,7 @@ def main() -> None:
         scaffolder_config=scaffolder_config,
         email_sender=email_sender,
         oauth2_client_configs=get_env_oauth2_settings(),
+        allowed_origins=allowed_origins,
     )
     server = Server(config=Config(app, host=host, port=port, root_path=host_root_path))  # type: ignore
     Thread(target=_write_pid_file_when_ready, args=(server,), daemon=True).start()

phoenix/server/static/.vite/manifest.json

@@ -1,28 +1,28 @@
 {
-  "_components-BAc4OPED.js": {
-    "file": "assets/components-BAc4OPED.js",
+  "_components-B6cljCxu.js": {
+    "file": "assets/components-B6cljCxu.js",
     "name": "components",
     "imports": [
-      "_vendor-CEisxXSv.js",
-      "_pages-Dz-gbBPF.js",
-      "_vendor-arizeai-BCTsSnvS.js",
-      "_vendor-codemirror-DIWnRs_7.js",
+      "_vendor-C3H3sezv.js",
+      "_pages-Dhitcl5V.js",
+      "_vendor-arizeai-DT8pwHfH.js",
+      "_vendor-codemirror-DvimrGxD.js",
       "_vendor-three-C5WAXd5r.js"
     ]
   },
-  "_pages-Dz-gbBPF.js": {
-    "file": "assets/pages-Dz-gbBPF.js",
+  "_pages-Dhitcl5V.js": {
+    "file": "assets/pages-Dhitcl5V.js",
     "name": "pages",
     "imports": [
-      "_vendor-CEisxXSv.js",
-      "_vendor-arizeai-BCTsSnvS.js",
-      "_components-BAc4OPED.js",
-      "_vendor-codemirror-DIWnRs_7.js",
-      "_vendor-recharts-Bame54mG.js"
+      "_vendor-C3H3sezv.js",
+      "_vendor-arizeai-DT8pwHfH.js",
+      "_components-B6cljCxu.js",
+      "_vendor-codemirror-DvimrGxD.js",
+      "_vendor-recharts-DuSQBcYW.js"
     ]
   },
-  "_vendor-CEisxXSv.js": {
-    "file": "assets/vendor-CEisxXSv.js",
+  "_vendor-C3H3sezv.js": {
+    "file": "assets/vendor-C3H3sezv.js",
     "name": "vendor",
     "imports": [
       "_vendor-three-C5WAXd5r.js"
@@ -35,33 +35,33 @@
     "file": "assets/vendor-Cg6lcjUC.css",
     "src": "_vendor-Cg6lcjUC.css"
   },
-  "_vendor-arizeai-BCTsSnvS.js": {
-    "file": "assets/vendor-arizeai-BCTsSnvS.js",
+  "_vendor-arizeai-DT8pwHfH.js": {
+    "file": "assets/vendor-arizeai-DT8pwHfH.js",
     "name": "vendor-arizeai",
     "imports": [
-      "_vendor-CEisxXSv.js"
+      "_vendor-C3H3sezv.js"
     ]
   },
-  "_vendor-codemirror-DIWnRs_7.js": {
-    "file": "assets/vendor-codemirror-DIWnRs_7.js",
+  "_vendor-codemirror-DvimrGxD.js": {
+    "file": "assets/vendor-codemirror-DvimrGxD.js",
     "name": "vendor-codemirror",
     "imports": [
-      "_vendor-CEisxXSv.js",
-      "_vendor-shiki-Cc73E4D-.js"
+      "_vendor-C3H3sezv.js",
+      "_vendor-shiki-i05Hmswh.js"
     ]
   },
-  "_vendor-recharts-Bame54mG.js": {
-    "file": "assets/vendor-recharts-Bame54mG.js",
+  "_vendor-recharts-DuSQBcYW.js": {
+    "file": "assets/vendor-recharts-DuSQBcYW.js",
     "name": "vendor-recharts",
     "imports": [
-      "_vendor-CEisxXSv.js"
+      "_vendor-C3H3sezv.js"
     ]
   },
-  "_vendor-shiki-Cc73E4D-.js": {
-    "file": "assets/vendor-shiki-Cc73E4D-.js",
+  "_vendor-shiki-i05Hmswh.js": {
+    "file": "assets/vendor-shiki-i05Hmswh.js",
     "name": "vendor-shiki",
     "imports": [
-      "_vendor-CEisxXSv.js"
+      "_vendor-C3H3sezv.js"
     ]
   },
   "_vendor-three-C5WAXd5r.js": {
@@ -69,19 +69,19 @@
     "name": "vendor-three"
   },
   "index.tsx": {
-    "file": "assets/index-Du53xkjY.js",
+    "file": "assets/index-DfHKoAV9.js",
     "name": "index",
     "src": "index.tsx",
     "isEntry": true,
     "imports": [
-      "_vendor-CEisxXSv.js",
-      "_vendor-arizeai-BCTsSnvS.js",
-      "_pages-Dz-gbBPF.js",
-      "_components-BAc4OPED.js",
+      "_vendor-C3H3sezv.js",
+      "_vendor-arizeai-DT8pwHfH.js",
+      "_pages-Dhitcl5V.js",
+      "_components-B6cljCxu.js",
       "_vendor-three-C5WAXd5r.js",
-      "_vendor-codemirror-DIWnRs_7.js",
-      "_vendor-shiki-Cc73E4D-.js",
-      "_vendor-recharts-Bame54mG.js"
+      "_vendor-codemirror-DvimrGxD.js",
+      "_vendor-shiki-i05Hmswh.js",
+      "_vendor-recharts-DuSQBcYW.js"
     ]
   }
 }