Add share_payload message type and book_feedback input type (#594)

hardbyte · web-flow · commit 533d9b2e415f · 2026-02-28T07:10:04.000+13:00
* Add share_payload message type and book_feedback input type

Share payload: MessageNodeProcessor resolves share_payload_variable from
session state, returning structured data the frontend can render as a
shareable card.

Book feedback: QuestionNodeProcessor supports input_type "book_feedback"
with a book_source variable reference. Users can rate books (like/dislike/
read) and the structured feedback is stored in session state for downstream
condition routing. Updated recommendation flow to v2.0.0 with feedback
collection, share payload generation, and liked-book branching.

* Fix book_feedback validation and CEL has() syntax

- Add book_feedback to InteractionCreate.input_type regex pattern so
  clients can submit feedback without getting a 422
- Fix CEL has() macro to use field-path syntax: has(obj.field) not
  has(obj, 'field')

* Relax InteractionCreate.input_type to accept any valid identifier

The hardcoded enum of allowed input types required a schema change for
every new flow input type. Replace with a simple identifier pattern so
flow authors can define custom input types without API changes.

* Relax QuestionContentSchema input_type to accept any identifier

Same change as InteractionCreate — flow authors can define custom
question input types without needing API schema changes.

* Add KNOWN_INPUT_TYPES constant and OpenAPI examples for input_type

Centralizes the set of known input types in a frozenset so they're
discoverable via IDE autocomplete and OpenAPI examples, while keeping
input_type as an open string for custom types.

* Fix integration test for relaxed input_type validation

The test used "invalid_input_type" which now passes the relaxed
identifier regex. Use "123-INVALID!" which actually violates the
pattern.
diff --git a/app/schemas/cms.py b/app/schemas/cms.py
@@ -16,6 +16,27 @@
 from app.schemas.pagination import PaginatedResponse
 from app.schemas.recommendations import HueKeys
 
+# Known input types for question nodes. Flow authors can define custom types
+# without schema changes — unknown types fall back to text input on the frontend.
+KNOWN_INPUT_TYPES: frozenset[str] = frozenset(
+    {
+        "text",
+        "number",
+        "email",
+        "phone",
+        "url",
+        "date",
+        "choice",
+        "multiple_choice",
+        "button",
+        "slider",
+        "image_choice",
+        "carousel",
+        "book_feedback",
+        "continue",
+    }
+)
+
 
 # Content Schemas
 class ContentCreate(BaseModel):
@@ -465,7 +486,8 @@ class InteractionCreate(BaseModel):
     input: str
     input_type: str = Field(
         ...,
-        pattern="^(text|button|file|choice|number|email|phone|url|date|slider|image_choice|carousel|multiple_choice|continue)$",
+        pattern=r"^[a-z][a-z0-9_]{0,49}$",
+        json_schema_extra={"examples": sorted(KNOWN_INPUT_TYPES)},
     )
 
 
diff --git a/app/services/chat_runtime.py b/app/services/chat_runtime.py
@@ -136,6 +136,15 @@ async def process(
                     message["delay"] = msg_config["delay"]
                 messages.append(message)
 
+        # Handle share_payload_variable: resolve variable and emit share_payload message
+        share_payload_var = node_content.get("share_payload_variable")
+        if share_payload_var:
+            payload = self.runtime.substitute_object(
+                f"{{{{{share_payload_var}}}}}", session_state
+            )
+            if payload and isinstance(payload, dict):
+                messages.append({"type": "share_payload", "content": payload})
+
         # Fallback: check for direct "text" or "rich_text" in node content
         if not messages:
             if node_content.get("rich_text"):
@@ -407,7 +416,7 @@ async def process(
                 state_updates={"system": {"_current_options": options}},
             )
 
-        return {
+        result: Dict[str, Any] = {
             "type": "question",
             "question": question_message,
             "content_id": content_id,
@@ -418,6 +427,18 @@ async def process(
             "node_id": node.node_id,
         }
 
+        # For book_feedback questions, resolve the book source and include books
+        if input_type == "book_feedback":
+            book_source = node_content.get("book_source", "")
+            if book_source:
+                books = self.runtime.substitute_object(
+                    f"{{{{{book_source}}}}}", session_state
+                )
+                if books and isinstance(books, list):
+                    result["books"] = books
+
+        return result
+
     async def _fetch_random_content(
         self,
         db: AsyncSession,
@@ -648,7 +669,15 @@ async def process_response(
 
             # For choice-based inputs, try to store the full option object
             stored_value: Any = sanitized_input
-            if input_type in ("choice", "image_choice", "button"):
+            if input_type == "book_feedback":
+                # Book feedback arrives as JSON with liked/disliked/read arrays
+                import json
+
+                try:
+                    stored_value = json.loads(user_input)
+                except (json.JSONDecodeError, TypeError):
+                    stored_value = sanitized_input
+            elif input_type in ("choice", "image_choice", "button"):
                 options = (session.state or {}).get("system", {}).get(
                     "_current_options"
                 ) or []
@@ -1855,12 +1884,16 @@ async def get_initial_node(
     @staticmethod
     def _build_input_request(source: Dict[str, Any]) -> Dict[str, Any]:
         """Build an input_request dict from a question result or raw node content."""
-        return {
+        ir: Dict[str, Any] = {
             "input_type": source.get("input_type", "text"),
             "variable": source.get("variable", ""),
             "options": source.get("options", []),
             "question": source.get("question", {}),
         }
+        # Include books for book_feedback questions
+        if source.get("books"):
+            ir["books"] = source["books"]
+        return ir
 
     async def _resolve_question_node(
         self, db: AsyncSession, question_node: FlowNode, session: ConversationSession
diff --git a/app/services/node_input_validation.py b/app/services/node_input_validation.py
@@ -14,6 +14,7 @@
 from structlog import get_logger
 
 from app.models.cms import NodeType
+from app.schemas.cms import KNOWN_INPUT_TYPES
 
 logger = get_logger()
 
@@ -102,24 +103,17 @@ def validate_messages(cls, v):
 class QuestionContentSchema(BaseModel):
     """Validation schema for question node content.
 
-    Supported input types:
-    - text: Free text input
-    - number: Numeric input with optional min/max
-    - email: Email address input
-    - phone: Phone number input
-    - url: URL input
-    - date: Date picker
-    - choice: Single selection from options (buttons/radio)
-    - multiple_choice: Multiple selection from options (checkboxes)
-    - slider: Range slider (for age, ratings, scales)
-    - image_choice: Single selection from image-based options (for visual preference questions)
-    - carousel: Swipeable carousel for browsing items (e.g., books)
+    input_type must be a lowercase identifier (e.g. text, choice, book_feedback).
+    Common built-in types: text, number, email, phone, url, date, choice,
+    multiple_choice, slider, image_choice, carousel. Flow authors can define
+    custom input types without schema changes.
     """
 
     question: Dict[str, Any] = Field(...)
     input_type: str = Field(
         ...,
-        pattern=r"^(text|choice|multiple_choice|number|email|phone|url|date|slider|image_choice|carousel)$",
+        pattern=r"^[a-z][a-z0-9_]{0,49}$",
+        json_schema_extra={"examples": sorted(KNOWN_INPUT_TYPES)},
     )
     options: Optional[List[Dict[str, Any]]] = None
     validation: Optional[Dict[str, Any]] = None
diff --git a/app/tests/integration/test_chat_api_error_handling.py b/app/tests/integration/test_chat_api_error_handling.py
@@ -116,11 +116,11 @@ def test_interact_invalid_input_type(client, test_user_account_headers):
     client.cookies.set("csrf_token", csrf_token)
     headers = {**test_user_account_headers, "X-CSRF-Token": csrf_token}
 
-    # Try to interact with invalid input type
+    # Try to interact with input_type that violates the identifier pattern
     response = client.post(
         f"v1/chat/sessions/{session_token}/interact",
         json={
-            "input_type": "invalid_input_type",  # Invalid type
+            "input_type": "123-INVALID!",  # Not a valid identifier
             "input": "Hello",
         },
         headers=headers,
diff --git a/app/tests/unit/test_node_input_validation.py b/app/tests/unit/test_node_input_validation.py
@@ -115,7 +115,7 @@ def test_question_node_validation_invalid_input_type(self):
         """Test question node validation fails with invalid input type."""
         content = {
             "question": {"text": "Enter something"},
-            "input_type": "invalid_type",  # Not in allowed pattern
+            "input_type": "123-INVALID!",  # Not a valid identifier
         }
 
         report = self.validator.validate_node(self.node_id, NodeType.QUESTION, content)
diff --git a/scripts/fixtures/huey-recommendation-flow.json b/scripts/fixtures/huey-recommendation-flow.json
@@ -1,8 +1,8 @@
 {
   "seed_key": "huey-recommendation",
   "name": "Huey Recommendation",
-  "description": "Queries for book recommendations with fallback, displays results.",
-  "version": "1.0.0",
+  "description": "Queries for book recommendations with fallback, collects per-book feedback, and displays liked books.",
+  "version": "2.0.0",
   "entry_node_id": "good_choices_msg",
   "visibility": "wriveted",
   "flow_data": {
@@ -71,14 +71,60 @@
       },
       {
         "id": "show_books",
+        "type": "question",
+        "content": {
+          "question": {"text": "I found {{temp.book_count}} books for you! Swipe through and tell me what you think \ud83d\udcda"},
+          "input_type": "book_feedback",
+          "book_source": "temp.book_results",
+          "variable": "temp.book_feedback"
+        },
+        "position": {"x": 900, "y": 150}
+      },
+      {
+        "id": "build_share_payload",
+        "type": "action",
+        "content": {
+          "actions": [
+            {
+              "type": "aggregate",
+              "expression": "size(has(temp.book_feedback.liked) ? temp.book_feedback.liked : [])",
+              "target": "temp.liked_count"
+            }
+          ]
+        },
+        "position": {"x": 1100, "y": 150}
+      },
+      {
+        "id": "check_liked",
+        "type": "condition",
+        "content": {
+          "conditions": [
+            {"if": "temp.liked_count > 0", "then": "$0"}
+          ],
+          "default_path": "default"
+        },
+        "position": {"x": 1300, "y": 150}
+      },
+      {
+        "id": "show_liked_msg",
         "type": "message",
         "content": {
           "messages": [
-            {"type": "text", "text": "I found {{temp.book_count}} books for you! \ud83d\udcda"},
-            {"type": "book_list", "source": "temp.book_results"}
+            {"type": "text", "text": "Great taste! Here are the books you liked \ud83c\udf1f"},
+            {"type": "book_list", "source": "temp.book_feedback.liked"}
           ]
         },
-        "position": {"x": 900, "y": 150}
+        "position": {"x": 1500, "y": 50}
+      },
+      {
+        "id": "no_liked_msg",
+        "type": "message",
+        "content": {
+          "messages": [
+            {"type": "text", "text": "No worries! Maybe next time we'll find something you love \ud83d\ude0a"}
+          ]
+        },
+        "position": {"x": 1500, "y": 250}
       },
       {
         "id": "fallback_query",
@@ -118,12 +164,12 @@
       },
       {
         "id": "show_fallback_books",
-        "type": "message",
+        "type": "question",
         "content": {
-          "messages": [
-            {"type": "text", "text": "I found {{temp.fallback_count}} books you might enjoy! \ud83d\udcda"},
-            {"type": "book_list", "source": "temp.fallback_results"}
-          ]
+          "question": {"text": "I found {{temp.fallback_count}} books you might enjoy! Swipe through and tell me what you think \ud83d\udcda"},
+          "input_type": "book_feedback",
+          "book_source": "temp.fallback_results",
+          "variable": "temp.book_feedback"
         },
         "position": {"x": 1300, "y": 350}
       },
@@ -144,8 +190,13 @@
       {"source": "book_query", "target": "check_results", "type": "default"},
       {"source": "check_results", "target": "show_books", "type": "$0"},
       {"source": "check_results", "target": "fallback_query", "type": "default"},
+      {"source": "show_books", "target": "build_share_payload", "type": "default"},
+      {"source": "build_share_payload", "target": "check_liked", "type": "default"},
+      {"source": "check_liked", "target": "show_liked_msg", "type": "$0"},
+      {"source": "check_liked", "target": "no_liked_msg", "type": "default"},
       {"source": "fallback_query", "target": "check_fallback", "type": "default"},
       {"source": "check_fallback", "target": "show_fallback_books", "type": "$0"},
+      {"source": "show_fallback_books", "target": "build_share_payload", "type": "default"},
       {"source": "check_fallback", "target": "no_books_msg", "type": "default"}
     ]
   }

Original file line number	Diff line number	Diff line change
`@@ -115,7 +115,7 @@ def test_question_node_validation_invalid_input_type(self):`
`115`	`115`	`"""Test question node validation fails with invalid input type."""`
`116`	`116`	`content = {`
`117`	`117`	`"question": {"text": "Enter something"},`
`118`		`- "input_type": "invalid_type", # Not in allowed pattern`
	`118`	`+ "input_type": "123-INVALID!", # Not a valid identifier`
`119`	`119`	`}`
`120`	`120`
`121`	`121`	`report = self.validator.validate_node(self.node_id, NodeType.QUESTION, content)`