|
| 1 | +"""Tests for redirect (``open_url``) support on quick-reply pills. |
| 2 | +
|
| 3 | +Quick replies historically only sent ``value`` back to the agent. A pill |
| 4 | +can now optionally carry an ``action`` — an ``open_url`` action makes it |
| 5 | +redirect instead of messaging. These tests pin both the new behavior and |
| 6 | +backward compatibility (no ``action`` => unchanged send-to-agent path). |
| 7 | +""" |
| 8 | + |
| 9 | +from __future__ import annotations |
| 10 | + |
| 11 | +from types import SimpleNamespace |
| 12 | + |
| 13 | +import pytest |
| 14 | +from pydantic import ValidationError |
| 15 | + |
| 16 | +from app.ai.voice.agents.breeze_buddy.template.types import QuickReplyOption |
| 17 | + |
| 18 | +# Load the template package (ui_catalog) before any chat/* module — same |
| 19 | +# circular-import precaution as the sibling ui_prompt / ui_stream tests. |
| 20 | +from app.ai.voice.agents.breeze_buddy.template.ui_catalog import ( |
| 21 | + OpenUrlAction, |
| 22 | + QuickReplies, |
| 23 | + QuickReplyItem, |
| 24 | + ToAssistantAction, |
| 25 | + validate_props, |
| 26 | +) |
| 27 | +from app.api.routers.breeze_buddy.widget.handlers import _extract_widget_config |
| 28 | +from app.schemas.breeze_buddy.chat import QuickReplyWire |
| 29 | + |
| 30 | +# --------------------------------------------------------------------------- |
| 31 | +# OpenUrlAction.target |
| 32 | +# --------------------------------------------------------------------------- |
| 33 | + |
| 34 | + |
| 35 | +def test_open_url_defaults_to_new_tab(): |
| 36 | + """Existing open_url actions (no target) keep opening in a new tab.""" |
| 37 | + action = OpenUrlAction(url="https://shop.example/orders/1") |
| 38 | + assert action.target == "new_tab" |
| 39 | + |
| 40 | + |
| 41 | +def test_open_url_accepts_same_tab(): |
| 42 | + action = OpenUrlAction(url="https://shop.example/checkout", target="same_tab") |
| 43 | + assert action.target == "same_tab" |
| 44 | + |
| 45 | + |
| 46 | +def test_open_url_rejects_unknown_target(): |
| 47 | + with pytest.raises(ValidationError): |
| 48 | + # model_validate (vs the constructor) so the intentionally-bad literal |
| 49 | + # is rejected at runtime without a static argument-type error. |
| 50 | + OpenUrlAction.model_validate( |
| 51 | + {"url": "https://shop.example/x", "target": "popup"} |
| 52 | + ) |
| 53 | + |
| 54 | + |
| 55 | +# --------------------------------------------------------------------------- |
| 56 | +# Dynamic QuickReplies primitive |
| 57 | +# --------------------------------------------------------------------------- |
| 58 | + |
| 59 | + |
| 60 | +def test_quick_replies_with_redirect_action_validates(): |
| 61 | + qr = validate_props( |
| 62 | + "QuickReplies", |
| 63 | + { |
| 64 | + "items": [ |
| 65 | + {"label": "Yes"}, |
| 66 | + { |
| 67 | + "label": "View order", |
| 68 | + "action": { |
| 69 | + "type": "open_url", |
| 70 | + "url": "https://shop.example/orders/1", |
| 71 | + "target": "same_tab", |
| 72 | + }, |
| 73 | + }, |
| 74 | + ] |
| 75 | + }, |
| 76 | + ) |
| 77 | + assert isinstance(qr, QuickReplies) |
| 78 | + assert qr.items[0].action is None # backward-compat: message pill |
| 79 | + redirect = qr.items[1].action |
| 80 | + assert isinstance(redirect, OpenUrlAction) |
| 81 | + assert redirect.type == "open_url" |
| 82 | + assert redirect.target == "same_tab" |
| 83 | + |
| 84 | + |
| 85 | +def test_quick_reply_item_without_action_is_backward_compatible(): |
| 86 | + item = QuickReplyItem(label="Track", value="Track my order") |
| 87 | + assert item.action is None |
| 88 | + assert item.value == "Track my order" |
| 89 | + |
| 90 | + |
| 91 | +def test_quick_reply_item_accepts_to_assistant_action(): |
| 92 | + item = QuickReplyItem(label="x", action={"type": "to_assistant", "msg": "hi"}) |
| 93 | + assert isinstance(item.action, ToAssistantAction) |
| 94 | + assert item.action.type == "to_assistant" |
| 95 | + |
| 96 | + |
| 97 | +# --------------------------------------------------------------------------- |
| 98 | +# Static config model (QuickReplyOption) + wire (QuickReplyWire) |
| 99 | +# --------------------------------------------------------------------------- |
| 100 | + |
| 101 | + |
| 102 | +def test_static_option_redirect_needs_no_value(): |
| 103 | + opt = QuickReplyOption( |
| 104 | + label="Checkout", |
| 105 | + action={"type": "open_url", "url": "https://shop.example/checkout"}, |
| 106 | + ) |
| 107 | + assert opt.value is None |
| 108 | + assert isinstance(opt.action, OpenUrlAction) |
| 109 | + assert opt.action.type == "open_url" |
| 110 | + |
| 111 | + |
| 112 | +def test_static_option_without_action_is_backward_compatible(): |
| 113 | + opt = QuickReplyOption(label="Track", value="Track my order") |
| 114 | + assert opt.action is None |
| 115 | + |
| 116 | + |
| 117 | +def test_wire_carries_action_with_null_value(): |
| 118 | + wire = QuickReplyWire( |
| 119 | + label="Checkout", |
| 120 | + value=None, |
| 121 | + action={"type": "open_url", "url": "https://shop.example/checkout"}, |
| 122 | + ) |
| 123 | + assert wire.value is None |
| 124 | + assert isinstance(wire.action, OpenUrlAction) |
| 125 | + assert wire.action.target == "new_tab" |
| 126 | + |
| 127 | + |
| 128 | +# --------------------------------------------------------------------------- |
| 129 | +# Widget handler — value fallback only for message pills |
| 130 | +# --------------------------------------------------------------------------- |
| 131 | + |
| 132 | + |
| 133 | +def _template_with_quick_replies(options): |
| 134 | + configurations = SimpleNamespace(quick_replies=options, enable_text_input=True) |
| 135 | + return SimpleNamespace(configurations=configurations) |
| 136 | + |
| 137 | + |
| 138 | +def test_handler_message_pill_falls_back_to_label(): |
| 139 | + template = _template_with_quick_replies([QuickReplyOption(label="Track my order")]) |
| 140 | + replies, enable_text_input = _extract_widget_config(template) |
| 141 | + assert enable_text_input is True |
| 142 | + assert replies[0].value == "Track my order" # label fallback |
| 143 | + assert replies[0].action is None |
| 144 | + |
| 145 | + |
| 146 | +def test_handler_redirect_pill_has_null_value_and_passes_action(): |
| 147 | + template = _template_with_quick_replies( |
| 148 | + [ |
| 149 | + QuickReplyOption( |
| 150 | + label="View your order", |
| 151 | + action={"type": "open_url", "url": "https://shop.example/orders/1"}, |
| 152 | + ) |
| 153 | + ] |
| 154 | + ) |
| 155 | + replies, _ = _extract_widget_config(template) |
| 156 | + # Redirect pills don't message the agent — no label fallback. |
| 157 | + assert replies[0].value is None |
| 158 | + assert isinstance(replies[0].action, OpenUrlAction) |
| 159 | + assert replies[0].action.type == "open_url" |
| 160 | + |
| 161 | + |
| 162 | +def test_handler_no_configurations_returns_defaults(): |
| 163 | + assert _extract_widget_config(SimpleNamespace(configurations=None)) == ([], True) |
0 commit comments