Merge pull request #97 from ariel-research/feature/researcher-console-ui

Feature/researcher console UI

Author: Lioo7

application/routes/dashboard.py

@@ -1,21 +1,149 @@
 import logging
 from datetime import datetime
+from json import JSONDecodeError, loads
 
-from flask import Blueprint, render_template
+from flask import Blueprint, render_template, url_for
 
 from application.services.dashboard_service import get_dashboard_metrics
 from application.translations import get_translation
 
 logger = logging.getLogger(__name__)
 dashboard_routes = Blueprint("dashboard", __name__)
 
+# Constants for external vendor handover and testing purposes.
+# These values are intentionally fixed to allow vendors to perform technical tests,
+# while allowing the system to identify and filter test responses.
+VENDOR_TEST_USER = "test"
+VENDOR_TEST_SURVEY_ID = "link_copy"
+VENDOR_TEST_LANG = "he"
+VENDOR_TEST_DEMO = "false"
+
+
+def _safe_json(value, default):
+    """Safely parse a JSON-like value (str/dict/list) with fallback."""
+    if value is None:
+        return default
+    if isinstance(value, (dict, list)):
+        return value
+    if isinstance(value, str):
+        try:
+            return loads(value)
+        except JSONDecodeError:
+            return default
+    return default
+
+
+def parse_survey_data(survey):
+    """
+    Parse raw survey row into a resilient dashboard console shape.
+
+    Rules:
+    - status ignores `active`; survey is active only when participant_count > 0
+    - strategy from pair_generation_config.strategy, default Unknown
+    - dimension from subjects length
+    - context from English story title with Hebrew fallback
+    - date in `%b %d` format
+    """
+    pair_config = _safe_json(survey.get("pair_generation_config"), {})
+    title = _safe_json(survey.get("title"), {})
+    subjects = _safe_json(survey.get("subjects"), [])
+
+    strategy_raw = (
+        pair_config.get("strategy") if isinstance(pair_config, dict) else None
+    )
+    if isinstance(strategy_raw, str) and strategy_raw.strip():
+        strategy_name = strategy_raw.strip().replace("_", " ").title()
+    else:
+        strategy_name = "Unknown"
+
+    if not isinstance(subjects, list):
+        subjects = []
+
+    if isinstance(title, dict):
+        context = title.get("en") or title.get("he") or ""
+    else:
+        context = str(title or "")
+
+    participant_count_raw = survey.get("participant_count", 0)
+    try:
+        participant_count = int(participant_count_raw or 0)
+    except (TypeError, ValueError):
+        participant_count = 0
+
+    created_at = survey.get("created_at")
+    created_dt = None
+    date_label = ""
+    sort_date = ""
+    if isinstance(created_at, datetime):
+        created_dt = created_at
+    elif isinstance(created_at, str):
+        try:
+            created_dt = datetime.fromisoformat(created_at.replace("Z", "+00:00"))
+        except ValueError:
+            # Keep empty when date is malformed; do not break rendering.
+            created_dt = None
+
+    if created_dt:
+        date_label = created_dt.strftime("%d %b %y")
+        sort_date = created_dt.strftime("%Y-%m-%d")
+
+    is_active_data = participant_count > 0
+    dimension_count = len(subjects)
+    dimension_label = f"{dimension_count}D" if dimension_count > 0 else "N/A"
+
+    # Three-Tier Maturity Model Logic
+    if participant_count == 0:
+        ui_status = "gray"
+        ui_status_tooltip = "Inactive (N=0)"
+    elif participant_count < 30:
+        ui_status = "orange"
+        ui_status_tooltip = "Gathering Data (N<30)"
+    else:
+        ui_status = "green"
+        ui_status_tooltip = "Sufficient Data (N>=30)"
+
+    ui_share_link = url_for(
+        "survey.index",
+        userID=VENDOR_TEST_USER,
+        surveyID=VENDOR_TEST_SURVEY_ID,
+        internalID=survey.get("id"),
+        lang=VENDOR_TEST_LANG,
+        demo=VENDOR_TEST_DEMO,
+        _external=True,
+    )
+
+    return {
+        "id": survey.get("id"),
+        "ui_date": date_label,
+        "ui_status": ui_status,
+        "ui_status_tooltip": ui_status_tooltip,
+        "is_active_data": is_active_data,
+        "ui_strategy": strategy_name,
+        "ui_context": context,
+        "ui_dimension": dimension_label,
+        "ui_volume": participant_count,
+        "sort_date": sort_date,
+        "sort_identity": strategy_name,
+        "sort_dim": dimension_count,
+        "ui_share_link": ui_share_link,
+    }
+
 
 @dashboard_routes.route("/")
 def view_dashboard():
     """Display the dashboard overview."""
     try:
         # Get dashboard data and metrics
         dashboard_data = get_dashboard_metrics()
+        raw_surveys = dashboard_data.get("surveys", [])
+        parsed_surveys = [parse_survey_data(survey) for survey in raw_surveys]
+
+        inactive_surveys = sum(1 for survey in raw_surveys if not survey.get("active"))
+        logger.info(
+            "Dashboard survey load complete: total=%s, inactive=%s",
+            len(raw_surveys),
+            inactive_surveys,
+        )
 
         # Get translations for dashboard content
         translations = {
@@ -25,9 +153,15 @@ def view_dashboard():
             "total_surveys_description": get_translation(
                 "total_surveys_description", "dashboard"
             ),
-            "total_participants": get_translation("total_participants", "dashboard"),
+            "total_participants": get_translation(
+                "total_participants",
+                "dashboard",
+            ),
             "excluded_users": get_translation("excluded_users", "dashboard"),
-            "all_participants": get_translation("all_participants", "dashboard"),
+            "all_participants": get_translation(
+                "all_participants",
+                "dashboard",
+            ),
             "total_participants_description": get_translation(
                 "total_participants_description", "dashboard"
             ),
@@ -40,11 +174,33 @@ def view_dashboard():
             "last_updated": get_translation("last_updated", "dashboard"),
             "view_responses": get_translation("view_responses", "dashboard"),
             "take_survey": get_translation("take_survey", "dashboard"),
+            "blocked_users": get_translation("blocked_users", "dashboard"),
+            "search_placeholder": get_translation("search_placeholder", "dashboard"),
+            "active_data_toggle": get_translation("active_data_toggle", "dashboard"),
+            "all_surveys_toggle": get_translation("all_surveys_toggle", "dashboard"),
+            "copied_to_clipboard": get_translation("copied_to_clipboard", "dashboard"),
+            "copy_link": get_translation("copy_link", "dashboard"),
+            "col_id": get_translation("col_id", "dashboard"),
+            "col_date": get_translation("col_date", "dashboard"),
+            "col_status": get_translation("col_status", "dashboard"),
+            "col_identity": get_translation("col_identity", "dashboard"),
+            "col_dim": get_translation("col_dim", "dashboard"),
+            "col_volume": get_translation("col_volume", "dashboard"),
+            "col_actions": get_translation("col_actions", "dashboard"),
+            "filter_all_strategies": get_translation(
+                "filter_all_strategies", "dashboard"
+            ),
+            "filter_all_stories": get_translation("filter_all_stories", "dashboard"),
+            "filter_all_dims": get_translation("filter_all_dims", "dashboard"),
+            "col_story": get_translation("col_story", "dashboard"),
+            "no_results_found": get_translation("no_results_found", "dashboard"),
+            "clear_all_filters": get_translation("clear_all_filters", "dashboard"),
         }
 
         return render_template(
             "dashboard/surveys_overview.html",
-            surveys=dashboard_data["surveys"],
+            surveys=raw_surveys,
+            surveys_console=parsed_surveys,
             total_surveys=dashboard_data["total_surveys"],
             total_participants=dashboard_data["total_participants"],
             unaware_users_count=dashboard_data["unaware_users_count"],

application/routes/dashboard_OLD.py

@@ -0,0 +1,61 @@
+import logging
+from datetime import datetime
+
+from flask import Blueprint, render_template
+
+from application.services.dashboard_service import get_dashboard_metrics
+from application.translations import get_translation
+
+logger = logging.getLogger(__name__)
+dashboard_routes = Blueprint("dashboard", __name__)
+
+
+@dashboard_routes.route("/")
+def view_dashboard():
+    """Display the dashboard overview."""
+    try:
+        # Get dashboard data and metrics
+        dashboard_data = get_dashboard_metrics()
+
+        # Get translations for dashboard content
+        translations = {
+            "title": get_translation("title", "dashboard"),
+            "subtitle": get_translation("subtitle", "dashboard"),
+            "total_surveys": get_translation("total_surveys", "dashboard"),
+            "total_surveys_description": get_translation(
+                "total_surveys_description", "dashboard"
+            ),
+            "total_participants": get_translation("total_participants", "dashboard"),
+            "excluded_users": get_translation("excluded_users", "dashboard"),
+            "all_participants": get_translation("all_participants", "dashboard"),
+            "total_participants_description": get_translation(
+                "total_participants_description", "dashboard"
+            ),
+            "excluded_users_description": get_translation(
+                "excluded_users_description", "dashboard"
+            ),
+            "all_participants_description": get_translation(
+                "all_participants_description", "dashboard"
+            ),
+            "last_updated": get_translation("last_updated", "dashboard"),
+            "view_responses": get_translation("view_responses", "dashboard"),
+            "take_survey": get_translation("take_survey", "dashboard"),
+        }
+
+        return render_template(
+            "dashboard/surveys_overview.html",
+            surveys=dashboard_data["surveys"],
+            total_surveys=dashboard_data["total_surveys"],
+            total_participants=dashboard_data["total_participants"],
+            unaware_users_count=dashboard_data["unaware_users_count"],
+            users_with_surveys=dashboard_data["users_with_surveys"],
+            translations=translations,
+            last_update_time=datetime.now().strftime("%Y-%m-%d %H:%M"),
+        )
+
+    except Exception as e:
+        logger.error(f"Error displaying dashboard: {str(e)}")
+        return render_template(
+            "error.html",
+            message=get_translation("dashboard_error", "messages"),
+        )

application/services/dashboard_service.py

@@ -2,8 +2,8 @@
 from typing import Any, Dict, List
 
 from database.queries import (
-    get_active_surveys,
     get_blacklisted_users,
+    get_surveys_for_dashboard,
     get_user_participation_overview,
     retrieve_completed_survey_responses,
 )
@@ -13,7 +13,8 @@
 
 def process_survey_data(surveys: List[Dict]) -> List[Dict]:
     """
-    Process raw survey data to include strategy information.
+    Process raw survey data to include strategy information while preserving
+    rich metadata needed by the dashboard parser.
 
     Args:
         surveys: List of survey records from database
@@ -25,23 +26,33 @@ def process_survey_data(surveys: List[Dict]) -> List[Dict]:
 
     for survey in surveys:
         try:
+            pair_config = survey.get("pair_generation_config") or {}
+            strategy_name = (
+                pair_config.get("strategy") if isinstance(pair_config, dict) else None
+            )
             survey_data.append(
                 {
+                    # Legacy fields currently used by template
                     "id": survey["id"],
-                    "name": survey["title"],
-                    "description": (
-                        survey["description"] if survey["description"] else None
-                    ),
-                    "strategy_name": (
-                        survey["pair_generation_config"].get("strategy")
-                        if survey["pair_generation_config"]
-                        else None
-                    ),
-                    "story_code": survey["story_code"],
+                    "name": survey.get("title", {}),
+                    "description": survey.get("description") or None,
+                    "strategy_name": strategy_name,
+                    "story_code": survey.get("story_code"),
+                    # New fields for Researcher's Console parser
+                    "active": survey.get("active", False),
+                    "created_at": survey.get("created_at"),
+                    "pair_generation_config": pair_config,
+                    "title": survey.get("title", {}),
+                    "subjects": survey.get("subjects", []),
+                    "participant_count": int(survey.get("participant_count") or 0),
                 }
             )
         except Exception as e:
-            logger.error(f"Error processing survey {survey['id']}: {str(e)}")
+            logger.error(
+                "Error processing survey %s: %s",
+                survey.get("id", "unknown"),
+                str(e),
+            )
             continue
 
     return survey_data
@@ -50,11 +61,9 @@ def process_survey_data(surveys: List[Dict]) -> List[Dict]:
 def get_dashboard_metrics() -> Dict[str, Any]:
     """Calculate basic metrics for the dashboard."""
     try:
-        # Get and process active surveys
-        # Note: get_active_surveys now returns pre-processed data with story information
-        active_surveys = get_active_surveys()
-        logger.info(f"Active surveys retrieved: {active_surveys}")
-        processed_surveys = process_survey_data(active_surveys)
+        # Get and process all surveys for dashboard visibility.
+        dashboard_surveys = get_surveys_for_dashboard()
+        processed_surveys = process_survey_data(dashboard_surveys)
 
         # Get completed responses
         completed_responses = retrieve_completed_survey_responses()

application/static/css/_variables.css

@@ -45,6 +45,11 @@
   --color-background-light: #ffffff;
   --color-background-alt: #f8fafc;
 
+  /* Semantic Dashboard Colors */
+  --color-bg-page: #f8fafc;
+  --color-bg-surface: #ffffff;
+  --color-text-emphasis: #1e293b;
+  
   /* Grays and text */
   --color-black: #000000;
   --color-disabled: #708090;