Merge branch 'aarthy/email-empty' into 'enterprise'

fix(emails): add empty state message when smtp server not configured

See merge request dkinternal/testgen/dataops-testgen!362

Author: ci bot

testgen/__main__.py

@@ -44,8 +44,10 @@
 )
 from testgen.common.models import with_database_session
 from testgen.common.models.profiling_run import ProfilingRun
+from testgen.common.models.settings import PersistedSetting
 from testgen.common.models.test_run import TestRun
 from testgen.common.models.test_suite import TestSuite
+from testgen.common.notifications.base import smtp_configured
 from testgen.common.notifications.profiling_run import send_profiling_run_notifications
 from testgen.common.notifications.test_run import send_test_run_notifications
 from testgen.scheduler import register_scheduler_job, run_scheduler
@@ -647,7 +649,7 @@ def run_ui():
     patch_streamlit.patch(force=True)
 
     @with_database_session
-    def cancel_all_running():
+    def init_ui():
         try:
             for profiling_run_id in ProfilingRun.cancel_all_running():
                 send_profiling_run_notifications(ProfilingRun.get(profiling_run_id))
@@ -656,7 +658,9 @@ def cancel_all_running():
         except Exception:
             LOG.warning("Failed to cancel 'Running' profiling/test runs")
 
-    cancel_all_running()
+        PersistedSetting.set("SMTP_CONFIGURED", smtp_configured())
+
+    init_ui()
 
     app_file = os.path.join(os.path.dirname(os.path.abspath(__file__)), "ui/app.py")
     process= subprocess.Popen(

testgen/common/models/test_result.py

@@ -66,7 +66,6 @@ def diff(cls, test_run_id_a: UUID, test_run_id_b: UUID) -> list[TestResultDiffTy
                     alias_a.test_definition_id == alias_b.test_definition_id,
                 ),
             ),
-            isouter=True,
             full=True,
         ).where(
             or_(alias_a.test_run_id == test_run_id_a, alias_a.test_run_id.is_(None)),

testgen/common/notifications/base.py

@@ -24,6 +24,10 @@
 )
 
 
+def smtp_configured() -> bool:
+    return all(getattr(settings, setting_name) is not None for setting_name in MANDATORY_SETTINGS)
+
+
 class EmailTemplateException(Exception):
     pass
 

testgen/ui/components/frontend/js/components/empty_state.js

@@ -54,6 +54,10 @@ const EMPTY_STATE_MESSAGE = {
         line1: 'Track data quality scores',
         line2: 'Filter or select columns to assess the quality of your data assets across different categories.',
     },
+    notifications: {
+        line1: '',
+        line2: 'Configure an SMTP email server for TestGen to get alerts on profiling runs, test runs, and quality scorecards.',
+    },
 };
 
 const EmptyState = (/** @type Properties */ props) => {

testgen/ui/components/frontend/js/pages/notification_settings.js

@@ -19,6 +19,7 @@
  *
  * @typedef Properties
  * @type {object}
+ * @property {Boolean} smtp_configured
  * @property {String} event
  * @property {NotificationItem[]} items
  * @property {Permissions} permissions
@@ -39,8 +40,9 @@ import { Alert } from '../components/alert.js';
 import { Textarea } from '../components/textarea.js';
 import { Icon } from '../components/icon.js';
 import { TruncatedText } from '../components/truncated_text.js';
-import { Input } from "../components/input.js";
-import { numberBetween } from "../form_validators.js";
+import { Input } from '../components/input.js';
+import { numberBetween } from '../form_validators.js';
+import { EmptyState, EMPTY_STATE_MESSAGE } from '../components/empty_state.js';
 
 const minHeight = 500;
 const { div, span, b } = van.tags;
@@ -49,6 +51,20 @@ const NotificationSettings = (/** @type Properties */ props) => {
     loadStylesheet('notification-settings', stylesheet);
     window.testgen.isPage = true;
 
+    if (!getValue(props.smtp_configured)) {
+        Streamlit.setFrameHeight(400);
+        return EmptyState({
+            label: 'Email server not configured.',
+            message: EMPTY_STATE_MESSAGE.notifications,
+            class: 'notifications--empty',
+            link: {
+                label: 'View documentation',
+                href: 'https://docs.datakitchen.io/articles/dataops-testgen-help/configure-email-server',
+                open_new: true,
+            },
+        });
+    }
+
     const nsItems = van.derive(() => {
         const items = getValue(props.items);
         Streamlit.setFrameHeight(Math.max(minHeight, 70 * items.length || 150));
@@ -329,6 +345,9 @@ const NotificationSettings = (/** @type Properties */ props) => {
 
 const stylesheet = new CSSStyleSheet();
 stylesheet.replace(`
+.notifications--empty.tg-empty-state {
+    margin-top: 0;
+}
 .notifications--editing-row {
     background-color: var(--select-hover-background);
 }

testgen/ui/views/dialogs/manage_notifications.py

@@ -8,6 +8,7 @@
 
 from testgen.common.models import with_database_session
 from testgen.common.models.notification_settings import NotificationSettings, NotificationSettingsValidationError
+from testgen.common.models.settings import PersistedSetting
 from testgen.ui.components import widgets
 from testgen.ui.session import session, temp_value
 
@@ -121,6 +122,7 @@ def render(self) -> None:
         widgets.testgen_component(
             "notification_settings",
             props={
+                "smtp_configured": PersistedSetting.get("SMTP_CONFIGURED"),
                 "items": ns_json_list,
                 "event": self.ns_class.__mapper_args__["polymorphic_identity"].value,
                 "permissions": {"can_edit": user_can_edit},

testgen/ui/views/profiling_runs.py

@@ -128,6 +128,8 @@ def get_job_arguments(self, arg_value: str) -> tuple[list[typing.Any], dict[str,
 
 class ProfilingRunNotificationSettingsDialog(NotificationSettingsDialogBase):
 
+    title = "Profiling Notifications"
+
     def _item_to_model_attrs(self, item: dict[str, typing.Any]) -> dict[str, typing.Any]:
         return {
             "trigger": ProfilingRunNotificationTrigger(item["trigger"]),

testgen/ui/views/score_details.py

@@ -234,6 +234,8 @@ def recalculate_score_history(definition_id: str) -> None:
 
 class ScoreDropNotificationSettingsDialog(NotificationSettingsDialogBase):
 
+    title = "Scorecard Notifications"
+
     def _item_to_model_attrs(self, item: dict[str, Any]) -> dict[str, Any]:
         model_data = {
             attr: Decimal(item[attr])

testgen/ui/views/test_runs.py

@@ -125,6 +125,8 @@ def open_dialog(*_):
 
 class TestRunNotificationSettingsDialog(NotificationSettingsDialogBase):
 
+    title = "Test Run Notifications"
+
     def _item_to_model_attrs(self, item: dict[str, Any]) -> dict[str, Any]:
         return {
             "trigger": TestRunNotificationTrigger(item["trigger"]),