Axsuarez/skill dialog

ci-pr-pipeline.yml

@@ -53,6 +53,7 @@ jobs:
       pip install -e ./libraries/botbuilder-testing
       pip install -e ./libraries/botbuilder-integration-applicationinsights-aiohttp
       pip install -e ./libraries/botbuilder-adapters-slack
+      pip install -e ./libraries/botbuilder-integration-aiohttp
       pip install -r ./libraries/botframework-connector/tests/requirements.txt
       pip install -r ./libraries/botbuilder-core/tests/requirements.txt
       pip install coveralls

libraries/botbuilder-core/botbuilder/core/__init__.py

@@ -22,7 +22,6 @@
 from .extended_user_token_provider import ExtendedUserTokenProvider
 from .intent_score import IntentScore
 from .invoke_response import InvokeResponse
-from .bot_framework_http_client import BotFrameworkHttpClient
 from .memory_storage import MemoryStorage
 from .memory_transcript_store import MemoryTranscriptStore
 from .message_factory import MessageFactory
@@ -63,7 +62,6 @@
     "ExtendedUserTokenProvider",
     "IntentScore",
     "InvokeResponse",
-    "BotFrameworkHttpClient",
     "MemoryStorage",
     "MemoryTranscriptStore",
     "MessageFactory",

libraries/botbuilder-core/botbuilder/core/adapters/test_adapter.py

@@ -241,7 +241,9 @@ async def receive_activity(self, activity):
         return await self.run_pipeline(context, self.logic)
 
     def get_next_activity(self) -> Activity:
-        return self.activity_buffer.pop(0)
+        if len(self.activity_buffer) > 0:
+            return self.activity_buffer.pop(0)
+        return None
 
     async def send(self, user_says) -> object:
         """

libraries/botbuilder-core/botbuilder/core/bot_adapter.py

@@ -14,7 +14,7 @@
 
 class BotAdapter(ABC):
     BOT_IDENTITY_KEY = "BotIdentity"
-    BOT_OAUTH_SCOPE_KEY = "OAuthScope"
+    BOT_OAUTH_SCOPE_KEY = "botbuilder.core.BotAdapter.OAuthScope"
     BOT_CONNECTOR_CLIENT_KEY = "ConnectorClient"
     BOT_CALLBACK_HANDLER_KEY = "BotCallbackHandler"
 

libraries/botbuilder-core/botbuilder/core/memory_storage.py

@@ -73,10 +73,14 @@ async def write(self, changes: Dict[str, StoreItem]):
                         "Etag conflict.\nOriginal: %s\r\nCurrent: %s"
                         % (new_value_etag, old_state_etag)
                     )
-                if isinstance(new_state, dict):
-                    new_state["e_tag"] = str(self._e_tag)
-                else:
-                    new_state.e_tag = str(self._e_tag)
+
+                # If the original object didn't have an e_tag, don't set one (C# behavior)
+                if old_state_etag:
+                    if isinstance(new_state, dict):
+                        new_state["e_tag"] = str(self._e_tag)
+                    else:
+                        new_state.e_tag = str(self._e_tag)
+
                 self._e_tag += 1
                 self.memory[key] = deepcopy(new_state)
 

libraries/botbuilder-core/botbuilder/core/skills/__init__.py

@@ -6,13 +6,15 @@
 # --------------------------------------------------------------------------
 
 from .bot_framework_skill import BotFrameworkSkill
+from .bot_framework_client import BotFrameworkClient
 from .conversation_id_factory import ConversationIdFactoryBase
 from .skill_handler import SkillHandler
 from .skill_conversation_id_factory_options import SkillConversationIdFactoryOptions
 from .skill_conversation_reference import SkillConversationReference
 
 __all__ = [
     "BotFrameworkSkill",
+    "BotFrameworkClient",
     "ConversationIdFactoryBase",
     "SkillConversationIdFactoryOptions",
     "SkillConversationReference",

libraries/botbuilder-core/botbuilder/core/skills/bot_framework_client.py

@@ -0,0 +1,20 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from abc import ABC
+
+from botbuilder.schema import Activity
+from botbuilder.core import InvokeResponse
+
+
+class BotFrameworkClient(ABC):
+    def post_activity(
+        self,
+        from_bot_id: str,
+        to_bot_id: str,
+        to_url: str,
+        service_url: str,
+        conversation_id: str,
+        activity: Activity,
+    ) -> InvokeResponse:
+        raise NotImplementedError()

libraries/botbuilder-core/botbuilder/core/skills/skill_conversation_id_factory_options.py

@@ -13,26 +13,6 @@ def __init__(
         activity: Activity,
         bot_framework_skill: BotFrameworkSkill,
     ):
-        if from_bot_oauth_scope is None:
-            raise TypeError(
-                "SkillConversationIdFactoryOptions(): from_bot_oauth_scope cannot be None."
-            )
-
-        if from_bot_id is None:
-            raise TypeError(
-                "SkillConversationIdFactoryOptions(): from_bot_id cannot be None."
-            )
-
-        if activity is None:
-            raise TypeError(
-                "SkillConversationIdFactoryOptions(): activity cannot be None."
-            )
-
-        if bot_framework_skill is None:
-            raise TypeError(
-                "SkillConversationIdFactoryOptions(): bot_framework_skill cannot be None."
-            )
-
         self.from_bot_oauth_scope = from_bot_oauth_scope
         self.from_bot_id = from_bot_id
         self.activity = activity

libraries/botbuilder-core/botbuilder/core/skills/skill_conversation_reference.py

@@ -9,13 +9,5 @@ class SkillConversationReference:
     """
 
     def __init__(self, conversation_reference: ConversationReference, oauth_scope: str):
-        if conversation_reference is None:
-            raise TypeError(
-                "SkillConversationReference(): conversation_reference cannot be None."
-            )
-
-        if oauth_scope is None:
-            raise TypeError("SkillConversationReference(): oauth_scope cannot be None.")
-
         self.conversation_reference = conversation_reference
         self.oauth_scope = oauth_scope

libraries/botbuilder-core/botbuilder/core/turn_context.py

@@ -295,7 +295,7 @@ async def next_handler():
         return await logic
 
     async def send_trace_activity(
-        self, name: str, value: object, value_type: str, label: str
+        self, name: str, value: object = None, value_type: str = None, label: str = None
     ) -> ResourceResponse:
         trace_activity = Activity(
             type=ActivityTypes.trace,

libraries/botbuilder-dialogs/botbuilder/dialogs/__init__.py

@@ -8,6 +8,7 @@
 from .about import __version__
 from .component_dialog import ComponentDialog
 from .dialog_context import DialogContext
+from .dialog_events import DialogEvents
 from .dialog_instance import DialogInstance
 from .dialog_reason import DialogReason
 from .dialog_set import DialogSet
@@ -17,12 +18,15 @@
 from .dialog import Dialog
 from .waterfall_dialog import WaterfallDialog
 from .waterfall_step_context import WaterfallStepContext
+from .dialog_extensions import DialogExtensions
 from .prompts import *
 from .choices import *
+from .skills import *
 
 __all__ = [
     "ComponentDialog",
     "DialogContext",
+    "DialogEvents",
     "DialogInstance",
     "DialogReason",
     "DialogSet",
@@ -43,5 +47,6 @@
     "Prompt",
     "PromptOptions",
     "TextPrompt",
+    "DialogExtensions",
     "__version__",
 ]

libraries/botbuilder-dialogs/botbuilder/dialogs/component_dialog.py

@@ -189,15 +189,15 @@ def add_dialog(self, dialog: Dialog) -> object:
             self.initial_dialog_id = dialog.id
         return self
 
-    def find_dialog(self, dialog_id: str) -> Dialog:
+    async def find_dialog(self, dialog_id: str) -> Dialog:
         """
         Finds a dialog by ID.
 
         :param dialog_id: The dialog to add.
         :return: The dialog; or None if there is not a match for the ID.
         :rtype: :class:`botbuilder.dialogs.Dialog`
         """
-        return self._dialogs.find(dialog_id)
+        return await self._dialogs.find(dialog_id)
 
     async def on_begin_dialog(
         self, inner_dc: DialogContext, options: object

libraries/botbuilder-dialogs/botbuilder/dialogs/dialog_events.py

@@ -0,0 +1,13 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from enum import Enum
+
+
+class DialogEvents(str, Enum):
+
+    begin_dialog = "beginDialog"
+    reprompt_dialog = "repromptDialog"
+    cancel_dialog = "cancelDialog"
+    activity_received = "activityReceived"
+    error = "error"

libraries/botbuilder-dialogs/botbuilder/dialogs/dialog_extensions.py

@@ -0,0 +1,77 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from botbuilder.core import BotAdapter, StatePropertyAccessor, TurnContext
+from botbuilder.dialogs import (
+    Dialog,
+    DialogEvents,
+    DialogSet,
+    DialogTurnStatus,
+)
+from botbuilder.schema import Activity, ActivityTypes
+from botframework.connector.auth import ClaimsIdentity, SkillValidation
+
+
+class DialogExtensions:
+    @staticmethod
+    async def run_dialog(
+        dialog: Dialog, turn_context: TurnContext, accessor: StatePropertyAccessor
+    ):
+        dialog_set = DialogSet(accessor)
+        dialog_set.add(dialog)
+
+        dialog_context = await dialog_set.create_context(turn_context)
+
+        claims = turn_context.turn_state.get(BotAdapter.BOT_IDENTITY_KEY)
+        if isinstance(claims, ClaimsIdentity) and SkillValidation.is_skill_claim(
+            claims.claims
+        ):
+            # The bot is running as a skill.
+            if (
+                turn_context.activity.type == ActivityTypes.end_of_conversation
+                and dialog_context.stack
+            ):
+                await dialog_context.cancel_all_dialogs()
+            else:
+                # Process a reprompt event sent from the parent.
+                if (
+                    turn_context.activity.type == ActivityTypes.event
+                    and turn_context.activity.name == DialogEvents.reprompt_dialog
+                    and dialog_context.stack
+                ):
+                    await dialog_context.reprompt_dialog()
+                    return
+
+                # Run the Dialog with the new message Activity and capture the results
+                # so we can send end of conversation if needed.
+                result = await dialog_context.continue_dialog()
+                if result.status == DialogTurnStatus.Empty:
+                    start_message_text = f"Starting {dialog.id}"
+                    await turn_context.send_trace_activity(
+                        f"Extension {Dialog.__name__}.run_dialog",
+                        label=start_message_text,
+                    )
+                    result = await dialog_context.begin_dialog(dialog.id)
+
+                # Send end of conversation if it is completed or cancelled.
+                if (
+                    result.status == DialogTurnStatus.Complete
+                    or result.status == DialogTurnStatus.Cancelled
+                ):
+                    end_message_text = f"Dialog {dialog.id} has **completed**. Sending EndOfConversation."
+                    await turn_context.send_trace_activity(
+                        f"Extension {Dialog.__name__}.run_dialog",
+                        label=end_message_text,
+                        value=result.result,
+                    )
+
+                    activity = Activity(
+                        type=ActivityTypes.end_of_conversation, value=result.result
+                    )
+                    await turn_context.send_activity(activity)
+
+        else:
+            # The bot is running as a standard bot.
+            results = await dialog_context.continue_dialog()
+            if results.status == DialogTurnStatus.Empty:
+                await dialog_context.begin_dialog(dialog.id)

libraries/botbuilder-dialogs/botbuilder/dialogs/skills/__init__.py

@@ -0,0 +1,17 @@
+# coding=utf-8
+# --------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for
+# license information.
+# --------------------------------------------------------------------------
+
+from .begin_skill_dialog_options import BeginSkillDialogOptions
+from .skill_dialog_options import SkillDialogOptions
+from .skill_dialog import SkillDialog
+
+
+__all__ = [
+    "BeginSkillDialogOptions",
+    "SkillDialogOptions",
+    "SkillDialog",
+]

libraries/botbuilder-dialogs/botbuilder/dialogs/skills/begin_skill_dialog_options.py

@@ -0,0 +1,18 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from botbuilder.schema import Activity
+
+
+class BeginSkillDialogOptions:
+    def __init__(self, activity: Activity):  # pylint: disable=unused-argument
+        self.activity = activity
+
+    @staticmethod
+    def from_object(obj: object) -> "BeginSkillDialogOptions":
+        if isinstance(obj, dict) and "activity" in obj:
+            return BeginSkillDialogOptions(obj["activity"])
+        if hasattr(obj, "activity"):
+            return BeginSkillDialogOptions(obj.activity)
+
+        return None