Porting Dialogs system from BotFramework

.azdo/ci-pr.yaml

@@ -72,6 +72,7 @@ steps:
     python -m pip install ./dist/microsoft_agents_authentication_msal*.whl
     python -m pip install ./dist/microsoft_agents_copilotstudio_client*.whl
     python -m pip install ./dist/microsoft_agents_hosting_aiohttp*.whl
+    python -m pip install ./dist/microsoft_agents_hosting_dialogs*.whl
     python -m pip install ./dist/microsoft_agents_hosting_teams*.whl
     python -m pip install ./dist/microsoft_agents_storage_blob*.whl
     python -m pip install ./dist/microsoft_agents_storage_cosmos*.whl

.github/workflows/python-package.yml

@@ -61,6 +61,7 @@ jobs:
         python -m pip install ./dist/microsoft_agents_authentication_msal*.whl
         python -m pip install ./dist/microsoft_agents_copilotstudio_client*.whl
         python -m pip install ./dist/microsoft_agents_hosting_aiohttp*.whl
+        python -m pip install ./dist/microsoft_agents_hosting_dialogs*.whl
         python -m pip install ./dist/microsoft_agents_hosting_teams*.whl
         python -m pip install ./dist/microsoft_agents_storage_blob*.whl
         python -m pip install ./dist/microsoft_agents_storage_cosmos*.whl

dev/hosting_dialogs/choices/test_channel.py

@@ -0,0 +1,89 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from typing import List, Tuple
+
+import pytest
+
+from microsoft_agents.activity import (
+    Activity,
+    ActivityTypes,
+    Channels,
+    ConversationAccount,
+    ChannelAccount,
+)
+from microsoft_agents.hosting.core import TurnContext
+from microsoft_agents.hosting.dialogs.choices import Channel
+from tests._common.testing_objects import MockTestingAdapter
+
+
+class TestChannel:
+    def test_supports_suggested_actions(self):
+        actual = Channel.supports_suggested_actions(Channels.facebook, 5)
+        assert actual
+
+    def test_supports_suggested_actions_many(self):
+        supports_suggested_actions_data: List[Tuple[str, int, bool]] = [
+            (Channels.line, 13, True),
+            (Channels.line, 14, False),
+            (Channels.skype, 10, True),
+            (Channels.skype, 11, False),
+            (Channels.kik, 20, True),
+            (Channels.kik, 21, False),
+            (Channels.emulator, 100, True),
+            (Channels.emulator, 101, False),
+            (Channels.direct_line_speech, 100, True),
+        ]
+
+        for channel, button_cnt, expected in supports_suggested_actions_data:
+            actual = Channel.supports_suggested_actions(channel, button_cnt)
+            assert (
+                expected == actual
+            ), f"channel={channel}, button_cnt={button_cnt}: expected {expected}, got {actual}"
+
+    def test_supports_card_actions_many(self):
+        supports_card_action_data: List[Tuple[str, int, bool]] = [
+            (Channels.line, 99, True),
+            (Channels.line, 100, False),
+            (Channels.slack, 100, True),
+            (Channels.skype, 3, True),
+            (Channels.skype, 5, False),
+            (Channels.direct_line_speech, 99, True),
+        ]
+
+        for channel, button_cnt, expected in supports_card_action_data:
+            actual = Channel.supports_card_actions(channel, button_cnt)
+            assert (
+                expected == actual
+            ), f"channel={channel}, button_cnt={button_cnt}: expected {expected}, got {actual}"
+
+    def test_supports_suggested_actions_accepts_string_channel_id(self):
+        assert Channel.supports_suggested_actions("facebook", 5)
+        assert not Channel.supports_suggested_actions("facebook", 11)
+
+    def test_supports_card_actions_accepts_string_channel_id(self):
+        assert Channel.supports_card_actions("msteams", 3)
+        assert not Channel.supports_card_actions("msteams", 4)
+
+    def test_should_return_channel_id_from_context_activity(self):
+        adapter = MockTestingAdapter(channel_id=Channels.facebook)
+        test_activity = Activity(
+            type=ActivityTypes.message,
+            channel_id=Channels.facebook,
+            conversation=ConversationAccount(id="test"),
+            from_property=ChannelAccount(id="user"),
+        )
+        test_context = TurnContext(adapter, test_activity)
+        channel_id = Channel.get_channel_id(test_context)
+        assert Channels.facebook == channel_id
+
+    def test_should_return_empty_from_context_activity_missing_channel(self):
+        adapter = MockTestingAdapter()
+        test_activity = Activity(
+            type=ActivityTypes.message,
+            conversation=ConversationAccount(id="test"),
+            from_property=ChannelAccount(id="user"),
+        )
+        test_context = TurnContext(adapter, test_activity)
+        channel_id = Channel.get_channel_id(test_context)
+        assert "" == channel_id

dev/hosting_dialogs/choices/test_choice.py

@@ -0,0 +1,29 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from typing import List
+
+import pytest
+
+from microsoft_agents.hosting.dialogs.choices import Choice
+from microsoft_agents.activity import CardAction
+
+
+class TestChoice:
+    def test_value_round_trips(self) -> None:
+        choice = Choice()
+        expected = "any"
+        choice.value = expected
+        assert expected is choice.value
+
+    def test_action_round_trips(self) -> None:
+        choice = Choice()
+        expected = CardAction(type="imBack", title="Test Action")
+        choice.action = expected
+        assert expected is choice.action
+
+    def test_synonyms_round_trips(self) -> None:
+        choice = Choice()
+        expected: List[str] = []
+        choice.synonyms = expected
+        assert expected is choice.synonyms

dev/hosting_dialogs/choices/test_choice_factory.py

@@ -0,0 +1,237 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from typing import List
+
+import pytest
+
+from microsoft_agents.hosting.dialogs.choices import (
+    Choice,
+    ChoiceFactory,
+    ChoiceFactoryOptions,
+)
+from microsoft_agents.activity import (
+    ActionTypes,
+    Activity,
+    ActivityTypes,
+    Attachment,
+    AttachmentLayoutTypes,
+    CardAction,
+    HeroCard,
+    InputHints,
+    SuggestedActions,
+    Channels,
+)
+
+
+class TestChoiceFactory:
+    color_choices: List[Choice] = [Choice("red"), Choice("green"), Choice("blue")]
+    choices_with_actions: List[Choice] = [
+        Choice(
+            "ImBack",
+            action=CardAction(
+                type=ActionTypes.im_back, title="ImBack Action", value="ImBack Value"
+            ),
+        ),
+        Choice(
+            "MessageBack",
+            action=CardAction(
+                type=ActionTypes.message_back,
+                title="MessageBack Action",
+                value="MessageBack Value",
+            ),
+        ),
+        Choice(
+            "PostBack",
+            action=CardAction(
+                type=ActionTypes.post_back,
+                title="PostBack Action",
+                value="PostBack Value",
+            ),
+        ),
+    ]
+
+    def test_inline_should_render_choices_inline(self):
+        activity = ChoiceFactory.inline(TestChoiceFactory.color_choices, "select from:")
+        assert "select from: (1) red, (2) green, or (3) blue" == activity.text
+
+    def test_should_render_choices_as_a_list(self):
+        activity = ChoiceFactory.list_style(
+            TestChoiceFactory.color_choices, "select from:"
+        )
+        assert "select from:\n\n   1. red\n   2. green\n   3. blue" == activity.text
+
+    def test_should_render_unincluded_numbers_choices_as_a_list(self):
+        activity = ChoiceFactory.list_style(
+            TestChoiceFactory.color_choices,
+            "select from:",
+            options=ChoiceFactoryOptions(include_numbers=False),
+        )
+        assert "select from:\n\n   - red\n   - green\n   - blue" == activity.text
+
+    def test_should_render_choices_as_suggested_actions(self):
+        expected = Activity(
+            type=ActivityTypes.message,
+            text="select from:",
+            input_hint=InputHints.expecting_input,
+            suggested_actions=SuggestedActions(
+                actions=[
+                    CardAction(type=ActionTypes.im_back, value="red", title="red"),
+                    CardAction(type=ActionTypes.im_back, value="green", title="green"),
+                    CardAction(type=ActionTypes.im_back, value="blue", title="blue"),
+                ]
+            ),
+        )
+
+        activity = ChoiceFactory.suggested_action(
+            TestChoiceFactory.color_choices, "select from:"
+        )
+
+        assert expected == activity
+
+    def test_should_render_choices_as_hero_card(self):
+        expected = Activity(
+            type=ActivityTypes.message,
+            input_hint=InputHints.expecting_input,
+            attachment_layout=AttachmentLayoutTypes.list,
+            attachments=[
+                Attachment(
+                    content=HeroCard(
+                        text="select from:",
+                        buttons=[
+                            CardAction(
+                                type=ActionTypes.im_back, value="red", title="red"
+                            ),
+                            CardAction(
+                                type=ActionTypes.im_back, value="green", title="green"
+                            ),
+                            CardAction(
+                                type=ActionTypes.im_back, value="blue", title="blue"
+                            ),
+                        ],
+                    ),
+                    content_type="application/vnd.microsoft.card.hero",
+                )
+            ],
+        )
+
+        activity = ChoiceFactory.hero_card(
+            TestChoiceFactory.color_choices, "select from:"
+        )
+
+        assert expected == activity
+
+    def test_should_automatically_choose_render_style_based_on_channel_type(self):
+        expected = Activity(
+            type=ActivityTypes.message,
+            text="select from:",
+            input_hint=InputHints.expecting_input,
+            suggested_actions=SuggestedActions(
+                actions=[
+                    CardAction(type=ActionTypes.im_back, value="red", title="red"),
+                    CardAction(type=ActionTypes.im_back, value="green", title="green"),
+                    CardAction(type=ActionTypes.im_back, value="blue", title="blue"),
+                ]
+            ),
+        )
+        activity = ChoiceFactory.for_channel(
+            Channels.emulator, TestChoiceFactory.color_choices, "select from:"
+        )
+
+        assert expected == activity
+
+    def test_should_choose_correct_styles_for_teams(self):
+        expected = Activity(
+            type=ActivityTypes.message,
+            input_hint=InputHints.expecting_input,
+            attachment_layout=AttachmentLayoutTypes.list,
+            attachments=[
+                Attachment(
+                    content=HeroCard(
+                        text="select from:",
+                        buttons=[
+                            CardAction(
+                                type=ActionTypes.im_back, value="red", title="red"
+                            ),
+                            CardAction(
+                                type=ActionTypes.im_back, value="green", title="green"
+                            ),
+                            CardAction(
+                                type=ActionTypes.im_back, value="blue", title="blue"
+                            ),
+                        ],
+                    ),
+                    content_type="application/vnd.microsoft.card.hero",
+                )
+            ],
+        )
+        activity = ChoiceFactory.for_channel(
+            Channels.ms_teams, TestChoiceFactory.color_choices, "select from:"
+        )
+        assert expected == activity
+
+    def test_should_include_choice_actions_in_suggested_actions(self):
+        expected = Activity(
+            type=ActivityTypes.message,
+            text="select from:",
+            input_hint=InputHints.expecting_input,
+            suggested_actions=SuggestedActions(
+                actions=[
+                    CardAction(
+                        type=ActionTypes.im_back,
+                        value="ImBack Value",
+                        title="ImBack Action",
+                    ),
+                    CardAction(
+                        type=ActionTypes.message_back,
+                        value="MessageBack Value",
+                        title="MessageBack Action",
+                    ),
+                    CardAction(
+                        type=ActionTypes.post_back,
+                        value="PostBack Value",
+                        title="PostBack Action",
+                    ),
+                ]
+            ),
+        )
+        activity = ChoiceFactory.suggested_action(
+            TestChoiceFactory.choices_with_actions, "select from:"
+        )
+        assert expected == activity
+
+    def test_should_include_choice_actions_in_hero_cards(self):
+        expected = Activity(
+            type=ActivityTypes.message,
+            input_hint=InputHints.expecting_input,
+            attachment_layout=AttachmentLayoutTypes.list,
+            attachments=[
+                Attachment(
+                    content=HeroCard(
+                        text="select from:",
+                        buttons=[
+                            CardAction(
+                                type=ActionTypes.im_back,
+                                value="ImBack Value",
+                                title="ImBack Action",
+                            ),
+                            CardAction(
+                                type=ActionTypes.message_back,
+                                value="MessageBack Value",
+                                title="MessageBack Action",
+                            ),
+                            CardAction(
+                                type=ActionTypes.post_back,
+                                value="PostBack Value",
+                                title="PostBack Action",
+                            ),
+                        ],
+                    ),
+                    content_type="application/vnd.microsoft.card.hero",
+                )
+            ],
+        )
+        activity = ChoiceFactory.hero_card(
+            TestChoiceFactory.choices_with_actions, "select from:"
+        )
+        assert expected == activity