microsoft-agents-hosting-core 0.3.0.dev0__py3-none-any.whl → 0.4.0.dev3__py3-none-any.whl

{microsoft/agents → microsoft_agents}/hosting/core/__init__.py

@@ -1,6 +1,5 @@
 from .activity_handler import ActivityHandler
 from .agent import Agent
-from .oauth_flow import OAuthFlow
 from .card_factory import CardFactory
 from .channel_adapter import ChannelAdapter
 from .channel_api_handler_protocol import ChannelApiHandlerProtocol
@@ -20,12 +19,11 @@ from .app.query import Query
 from .app.route import Route, RouteHandler
 from .app.typing_indicator import TypingIndicator
 
-# OAuth
-from .app.oauth.authorization import (
+# App Auth
+from .app.oauth import (
     Authorization,
     AuthorizationHandlers,
     AuthHandler,
-    SignInState,
 )
 
 # App State
@@ -44,6 +42,16 @@ from .authorization.claims_identity import ClaimsIdentity
 from .authorization.jwt_token_validator import JwtTokenValidator
 from .authorization.auth_types import AuthTypes
 
+# OAuth
+from .oauth import (
+    FlowState,
+    FlowStateTag,
+    FlowErrorTag,
+    FlowResponse,
+    FlowStorageClient,
+    OAuthFlow,
+)
+
 # Client API
 from .client.agent_conversation_reference import AgentConversationReference
 from .client.channel_factory_protocol import ChannelFactoryProtocol
@@ -88,7 +96,6 @@ from .storage.memory_storage import MemoryStorage
 __all__ = [
     "ActivityHandler",
     "Agent",
-    "OAuthFlow",
     "CardFactory",
     "ChannelAdapter",
     "ChannelApiHandlerProtocol",
@@ -155,4 +162,10 @@ __all__ = [
     "StoreItem",
     "Storage",
     "MemoryStorage",
+    "FlowState",
+    "FlowStateTag",
+    "FlowErrorTag",
+    "FlowResponse",
+    "FlowStorageClient",
+    "OAuthFlow",
 ]

{microsoft/agents → microsoft_agents}/hosting/core/activity_handler.py

@@ -4,8 +4,8 @@ from __future__ import annotations
 from http import HTTPStatus
 from pydantic import BaseModel
 
-from microsoft.agents.activity import TurnContextProtocol
-from microsoft.agents.activity import (
+from microsoft_agents.activity import TurnContextProtocol
+from microsoft_agents.activity import (
     Activity,
     ActivityTypes,
     AdaptiveCardInvokeResponse,
@@ -34,10 +34,10 @@ class ActivityHandler(Agent):
     ):  # pylint: disable=arguments-differ
         """
         Called by the adapter (for example, :class:`ChannelAdapter`) at runtime
-        in order to process an inbound :class:`hosting.schema.Activity`.
+        in order to process an inbound :class:`microsoft_agents.activity.Activity`.
 
         :param turn_context: The context object for this turn
-        :type turn_context: :class:`microsoft.agents.builder.TurnContext`
+        :type turn_context: :class:`microsoft_agents.builder.TurnContext`
 
         :returns: A task that represents the work queued to execute
 
@@ -105,7 +105,7 @@ class ActivityHandler(Agent):
         such as the conversational logic.
 
         :param turn_context: The context object for this turn
-        :type turn_context: :class:`microsoft.agents.builder.TurnContext`
+        :type turn_context: :class:`microsoft_agents.builder.TurnContext`
 
         :returns: A task that represents the work queued to execute
         """
@@ -119,7 +119,7 @@ class ActivityHandler(Agent):
         such as the conversational logic.
 
         :param turn_context: The context object for this turn
-        :type turn_context: :class:`microsoft.agents.builder.TurnContext`
+        :type turn_context: :class:`microsoft_agents.builder.TurnContext`
 
         :returns: A task that represents the work queued to execute
         """
@@ -133,7 +133,7 @@ class ActivityHandler(Agent):
         such as the conversational logic.
 
         :param turn_context: The context object for this turn
-        :type turn_context: :class:`microsoft.agents.builder.TurnContext`
+        :type turn_context: :class:`microsoft_agents.builder.TurnContext`
 
         :returns: A task that represents the work queued to execute
         """
@@ -145,7 +145,7 @@ class ActivityHandler(Agent):
         :meth:`on_turn()` is used.
 
         :param turn_context: The context object for this turn
-        :type turn_context: :class:`microsoft.agents.builder.TurnContext`
+        :type turn_context: :class:`microsoft_agents.builder.TurnContext`
 
         :returns: A task that represents the work queued to execute
 
@@ -181,7 +181,7 @@ class ActivityHandler(Agent):
         conversation update activity
         :type members_added: :class:`typing.List`
         :param turn_context: The context object for this turn
-        :type turn_context: :class:`microsoft.agents.builder.TurnContext`
+        :type turn_context: :class:`microsoft_agents.builder.TurnContext`
 
         :returns: A task that represents the work queued to execute
 
@@ -203,7 +203,7 @@ class ActivityHandler(Agent):
         conversation update activity
         :type members_added: :class:`typing.List`
         :param turn_context: The context object for this turn
-        :type turn_context: :class:`microsoft.agents.builder.TurnContext`
+        :type turn_context: :class:`microsoft_agents.builder.TurnContext`
 
         :returns: A task that represents the work queued to execute
 
@@ -221,7 +221,7 @@ class ActivityHandler(Agent):
         :meth:`on_turn()` is used.
 
         :param turn_context: The context object for this turn
-        :type turn_context: :class:`microsoft.agents.builder.TurnContext`
+        :type turn_context: :class:`microsoft_agents.builder.TurnContext`
 
         :returns: A task that represents the work queued to execute
 
@@ -267,7 +267,7 @@ class ActivityHandler(Agent):
         :param message_reactions: The list of reactions added
         :type message_reactions: :class:`typing.List`
         :param turn_context: The context object for this turn
-        :type turn_context: :class:`microsoft.agents.builder.TurnContext`
+        :type turn_context: :class:`microsoft_agents.builder.TurnContext`
 
         :returns: A task that represents the work queued to execute
 
@@ -293,7 +293,7 @@ class ActivityHandler(Agent):
         :param message_reactions: The list of reactions removed
         :type message_reactions: :class:`typing.List`
         :param turn_context: The context object for this turn
-        :type turn_context: :class:`microsoft.agents.builder.TurnContext`
+        :type turn_context: :class:`microsoft_agents.builder.TurnContext`
 
         :returns: A task that represents the work queued to execute
 
@@ -312,7 +312,7 @@ class ActivityHandler(Agent):
         :meth:`on_turn()` is used.
 
         :param turn_context: The context object for this turn
-        :type turn_context: :class:`microsoft.agents.builder.TurnContext`
+        :type turn_context: :class:`microsoft_agents.builder.TurnContext`
 
         :returns: A task that represents the work queued to execute
 
@@ -343,7 +343,7 @@ class ActivityHandler(Agent):
         If using an `oauth_prompt`, override this method to forward this activity to the current dialog.
 
         :param turn_context: The context object for this turn
-        :type turn_context: :class:`microsoft.agents.builder.TurnContext`
+        :type turn_context: :class:`microsoft_agents.builder.TurnContext`
 
         :returns: A task that represents the work queued to execute
 
@@ -363,7 +363,7 @@ class ActivityHandler(Agent):
 
 
         :param turn_context: The context object for this turn
-        :type turn_context: :class:`microsoft.agents.builder.TurnContext`
+        :type turn_context: :class:`microsoft_agents.builder.TurnContext`
 
         :returns: A task that represents the work queued to execute
 
@@ -381,7 +381,7 @@ class ActivityHandler(Agent):
         Invoked when a conversation end activity is received from the channel.
 
         :param turn_context: The context object for this turn
-        :type turn_context: :class:`microsoft.agents.builder.TurnContext`
+        :type turn_context: :class:`microsoft_agents.builder.TurnContext`
         :returns: A task that represents the work queued to execute
         """
         return
@@ -394,7 +394,7 @@ class ActivityHandler(Agent):
         ActivityTypes.typing activities, such as the conversational logic.
 
         :param turn_context: The context object for this turn
-        :type turn_context: :class:`microsoft.agents.builder.TurnContext`
+        :type turn_context: :class:`microsoft_agents.builder.TurnContext`
         :returns: A task that represents the work queued to execute
         """
         return
@@ -407,7 +407,7 @@ class ActivityHandler(Agent):
         ActivityTypes.InstallationUpdate activities.
 
         :param turn_context: The context object for this turn
-        :type turn_context: :class:`microsoft.agents.builder.TurnContext`
+        :type turn_context: :class:`microsoft_agents.builder.TurnContext`
         :returns: A task that represents the work queued to execute
         """
         if turn_context.activity.action in ("add", "add-upgrade"):
@@ -424,7 +424,7 @@ class ActivityHandler(Agent):
         ActivityTypes.InstallationUpdate activities with 'action' set to 'add'.
 
         :param turn_context: The context object for this turn
-        :type turn_context: :class:`microsoft.agents.builder.TurnContext`
+        :type turn_context: :class:`microsoft_agents.builder.TurnContext`
         :returns: A task that represents the work queued to execute
         """
         return
@@ -437,7 +437,7 @@ class ActivityHandler(Agent):
         ActivityTypes.InstallationUpdate activities with 'action' set to 'remove'.
 
         :param turn_context: The context object for this turn
-        :type turn_context: :class:`microsoft.agents.builder.TurnContext`
+        :type turn_context: :class:`microsoft_agents.builder.TurnContext`
         :returns: A task that represents the work queued to execute
         """
         return
@@ -451,7 +451,7 @@ class ActivityHandler(Agent):
         If overridden, this method could potentially respond to any of the other activity types.
 
         :param turn_context: The context object for this turn
-        :type turn_context: :class:`microsoft.agents.builder.TurnContext`
+        :type turn_context: :class:`microsoft_agents.builder.TurnContext`
 
         :returns: A task that represents the work queued to execute
 
@@ -468,7 +468,7 @@ class ActivityHandler(Agent):
         Registers an activity event handler for the _invoke_ event, emitted for every incoming event activity.
 
         :param turn_context: The context object for this turn
-        :type turn_context: :class:`microsoft.agents.builder.TurnContext`
+        :type turn_context: :class:`microsoft_agents.builder.TurnContext`
 
         :returns: A task that represents the work queued to execute
         """
@@ -504,7 +504,7 @@ class ActivityHandler(Agent):
         By default, this method does nothing.
 
         :param turn_context: The context object for this turn
-        :type turn_context: :class:`microsoft.agents.builder.TurnContext`
+        :type turn_context: :class:`microsoft_agents.builder.TurnContext`
 
         :returns: A task that represents the work queued to execute
         """
@@ -520,9 +520,9 @@ class ActivityHandler(Agent):
         calls this method.
 
         :param turn_context: A context object for this turn.
-        :type turn_context: :class:`microsoft.agents.builder.TurnContext`
+        :type turn_context: :class:`microsoft_agents.builder.TurnContext`
         :param invoke_value: A string-typed object from the incoming activity's value.
-        :type invoke_value: :class:`microsoft.agents.activity.models.AdaptiveCardInvokeValue`
+        :type invoke_value: :class:`microsoft_agents.activity.models.AdaptiveCardInvokeValue`
         :return: The HealthCheckResponse object
         """
         raise _InvokeResponseException(HTTPStatus.NOT_IMPLEMENTED)

{microsoft/agents → microsoft_agents}/hosting/core/app/__init__.py

@@ -13,12 +13,11 @@ from .query import Query
 from .route import Route, RouteHandler
 from .typing_indicator import TypingIndicator
 
-# OAuth
-from .oauth.authorization import (
+# Auth
+from .oauth import (
     Authorization,
-    AuthorizationHandlers,
     AuthHandler,
-    SignInState,
+    AuthorizationHandlers,
 )
 
 # App State
@@ -49,7 +48,6 @@ __all__ = [
     "TurnState",
     "TempState",
     "Authorization",
-    "AuthorizationHandlers",
     "AuthHandler",
-    "SignInState",
+    "AuthorizationHandlers",
 ]

{microsoft/agents → microsoft_agents}/hosting/core/app/agent_application.py

@@ -23,18 +23,24 @@ from typing import (
     cast,
 )
 
-from microsoft.agents.hosting.core.authorization import Connections
+from microsoft_agents.hosting.core.authorization import Connections
 
-from microsoft.agents.hosting.core import Agent, TurnContext
-from microsoft.agents.activity import (
+from microsoft_agents.hosting.core import Agent, TurnContext
+from microsoft_agents.activity import (
     Activity,
     ActivityTypes,
+    ActionTypes,
     ConversationUpdateTypes,
     MessageReactionTypes,
     MessageUpdateTypes,
     InvokeResponse,
+    TokenResponse,
+    OAuthCard,
+    Attachment,
+    CardAction,
 )
 
+from .. import CardFactory, MessageFactory
 from .app_error import ApplicationError
 from .app_options import ApplicationOptions
 
@@ -42,7 +48,12 @@ from .app_options import ApplicationOptions
 from .route import Route, RouteHandler
 from .state import TurnState
 from ..channel_service_adapter import ChannelServiceAdapter
-from .oauth import Authorization, SignInState
+from ..oauth import (
+    FlowResponse,
+    FlowState,
+    FlowStateTag,
+)
+from .oauth import Authorization
 from .typing_indicator import TypingIndicator
 
 logger = logging.getLogger(__name__)
@@ -592,6 +603,103 @@ class AgentApplication(Agent, Generic[StateT]):
         self._turn_state_factory = func
         return func
 
+    async def _handle_flow_response(
+        self, context: TurnContext, flow_response: FlowResponse
+    ) -> None:
+        """Handles CONTINUE and FAILURE flow responses, sending activities back."""
+        flow_state: FlowState = flow_response.flow_state
+
+        if flow_state.tag == FlowStateTag.BEGIN:
+            # Create the OAuth card
+            sign_in_resource = flow_response.sign_in_resource
+            o_card: Attachment = CardFactory.oauth_card(
+                OAuthCard(
+                    text="Sign in",
+                    connection_name=flow_state.connection,
+                    buttons=[
+                        CardAction(
+                            title="Sign in",
+                            type=ActionTypes.signin,
+                            value=sign_in_resource.sign_in_link,
+                            channel_data=None,
+                        )
+                    ],
+                    token_exchange_resource=sign_in_resource.token_exchange_resource,
+                    token_post_resource=sign_in_resource.token_post_resource,
+                )
+            )
+            # Send the card to the user
+            await context.send_activity(MessageFactory.attachment(o_card))
+        elif flow_state.tag == FlowStateTag.FAILURE:
+            if flow_state.reached_max_attempts():
+                await context.send_activity(
+                    MessageFactory.text(
+                        "Sign-in failed. Max retries reached. Please try again later."
+                    )
+                )
+            elif flow_state.is_expired():
+                await context.send_activity(
+                    MessageFactory.text("Sign-in session expired. Please try again.")
+                )
+            else:
+                logger.warning("Sign-in flow failed for unknown reasons.")
+                await context.send_activity("Sign-in failed. Please try again.")
+
+    async def _on_turn_auth_intercept(
+        self, context: TurnContext, turn_state: TurnState
+    ) -> bool:
+        """Intercepts the turn to check for active authentication flows."""
+        logger.debug(
+            "Checking for active sign-in flow for context: %s with activity type %s",
+            context.activity.id,
+            context.activity.type,
+        )
+        prev_flow_state = await self._auth.get_active_flow_state(context)
+        if prev_flow_state:
+            logger.debug(
+                "Previous flow state: %s",
+                {
+                    "user_id": prev_flow_state.user_id,
+                    "connection": prev_flow_state.connection,
+                    "channel_id": prev_flow_state.channel_id,
+                    "auth_handler_id": prev_flow_state.auth_handler_id,
+                    "tag": prev_flow_state.tag,
+                    "expiration": prev_flow_state.expiration,
+                },
+            )
+        # proceed if there is an existing flow to continue
+        # new flows should be initiated in _on_activity
+        # this can be reorganized later... but it works for now
+        if (
+            prev_flow_state
+            and (
+                prev_flow_state.tag == FlowStateTag.NOT_STARTED
+                or prev_flow_state.is_active()
+            )
+            and context.activity.type in [ActivityTypes.message, ActivityTypes.invoke]
+        ):
+
+            logger.debug("Sign-in flow is active for context: %s", context.activity.id)
+
+            flow_response: FlowResponse = await self._auth.begin_or_continue_flow(
+                context, turn_state, prev_flow_state.auth_handler_id
+            )
+
+            await self._handle_flow_response(context, flow_response)
+
+            new_flow_state: FlowState = flow_response.flow_state
+            token_response: TokenResponse = flow_response.token_response
+            saved_activity: Activity = new_flow_state.continuation_activity.model_copy()
+
+            if token_response:
+                new_context = copy(context)
+                new_context.activity = saved_activity
+                logger.info("Resending continuation activity %s", saved_activity.text)
+                await self.on_turn(new_context)
+                await turn_state.save(context)
+            return True  # early return from _on_turn
+        return False  # continue _on_turn
+
     async def on_turn(self, context: TurnContext):
         logger.debug(
             f"AgentApplication.on_turn(): Processing turn for context: {context.activity.id}"
@@ -599,6 +707,7 @@ class AgentApplication(Agent, Generic[StateT]):
         await self._start_long_running_call(context, self._on_turn)
 
     async def _on_turn(self, context: TurnContext):
+        # robrandao: TODO
         try:
             await self._start_typing(context)
 
@@ -607,32 +716,8 @@ class AgentApplication(Agent, Generic[StateT]):
             logger.debug("Initializing turn state")
             turn_state = await self._initialize_state(context)
 
-            sign_in_state = turn_state.get_value(
-                Authorization.SIGN_IN_STATE_KEY, target_cls=SignInState
-            )
-            logger.debug(
-                f"Sign-in state: {sign_in_state} for context: {context.activity.id}"
-            )
-
-            if self._auth and sign_in_state and not sign_in_state.completed:
-                flow_state = self._auth.get_flow_state(sign_in_state.handler_id)
-                logger.debug("Flow state: %s", flow_state)
-                if flow_state.flow_started:
-                    logger.debug("Continuing sign-in flow")
-                    token_response = await self._auth.begin_or_continue_flow(
-                        context, turn_state, sign_in_state.handler_id
-                    )
-                    saved_activity = sign_in_state.continuation_activity.model_copy()
-                    if token_response and token_response.token:
-                        new_context = copy(context)
-                        new_context.activity = saved_activity
-                        logger.info(
-                            "Resending continuation activity %s", saved_activity.text
-                        )
-                        await self.on_turn(new_context)
-                        turn_state.delete_value(Authorization.SIGN_IN_STATE_KEY)
-                        await turn_state.save(context)
-                    return
+            if self._auth and await self._on_turn_auth_intercept(context, turn_state):
+                return
 
             logger.debug("Running before turn middleware")
             if not await self._run_before_turn_middleware(context, turn_state):
@@ -645,7 +730,7 @@ class AgentApplication(Agent, Generic[StateT]):
             await self._on_activity(context, turn_state)
 
             logger.debug("Running after turn middleware")
-            if not await self._run_after_turn_middleware(context, turn_state):
+            if await self._run_after_turn_middleware(context, turn_state):
                 await turn_state.save(context)
             return
         except ApplicationError as err:
@@ -655,12 +740,10 @@ class AgentApplication(Agent, Generic[StateT]):
             )
             await self._on_error(context, err)
         finally:
-            logger.debug("Stopping typing indicator")
             self.typing.stop()
 
     async def _start_typing(self, context: TurnContext):
         if self._options.start_typing_timer:
-            logger.debug("Starting typing indicator for context")
             await self.typing.start(context)
 
     def _remove_mentions(self, context: TurnContext):
@@ -715,7 +798,7 @@ class AgentApplication(Agent, Generic[StateT]):
         for before_turn in self._internal_before_turn:
             is_ok = await before_turn(context, state)
             if not is_ok:
-                await state.save(context, self._options.storage)
+                await state.save(context)
                 return False
         return True
 
@@ -741,7 +824,7 @@ class AgentApplication(Agent, Generic[StateT]):
         for after_turn in self._internal_after_turn:
             is_ok = await after_turn(context, state)
             if not is_ok:
-                await state.save(context, self._options.storage)
+                await state.save(context)
                 return False
         return True
 
@@ -753,12 +836,26 @@ class AgentApplication(Agent, Generic[StateT]):
                 else:
                     sign_in_complete = False
                     for auth_handler_id in route.auth_handlers:
-                        token_response = await self._auth.begin_or_continue_flow(
-                            context, state, auth_handler_id
+                        logger.debug(
+                            "Beginning or continuing flow for auth handler %s",
+                            auth_handler_id,
+                        )
+                        flow_response: FlowResponse = (
+                            await self._auth.begin_or_continue_flow(
+                                context, state, auth_handler_id
+                            )
+                        )
+                        await self._handle_flow_response(context, flow_response)
+                        logger.debug(
+                            "Flow response flow_state.tag: %s",
+                            flow_response.flow_state.tag,
+                        )
+                        sign_in_complete = (
+                            flow_response.flow_state.tag == FlowStateTag.COMPLETE
                         )
-                        sign_in_complete = token_response and token_response.token
                         if not sign_in_complete:
                             break
+
                     if sign_in_complete:
                         await route.handler(context, state)
                 return

{microsoft/agents → microsoft_agents}/hosting/core/app/app_options.py

@@ -9,8 +9,8 @@ from dataclasses import dataclass, field
 from logging import Logger
 from typing import Callable, List, Optional
 
-from microsoft.agents.hosting.core.app.oauth.authorization import AuthorizationHandlers
-from microsoft.agents.hosting.core.storage import Storage
+from microsoft_agents.hosting.core.app.oauth import AuthHandler
+from microsoft_agents.hosting.core.storage import Storage
 
 # from .auth import AuthOptions
 from .input_file import InputFileDownloader
@@ -84,7 +84,7 @@ class ApplicationOptions:
     If not provided, the default `TurnState` will be used.
     """
 
-    authorization_handlers: Optional[AuthorizationHandlers] = None
+    authorization_handlers: Optional[dict[str, AuthHandler]] = None
     """
     Optional. Authorization handler for OAuth flows.
     If not provided, no OAuth flows will be supported.

{microsoft/agents → microsoft_agents}/hosting/core/app/input_file.py

@@ -9,7 +9,7 @@ from abc import ABC, abstractmethod
 from dataclasses import dataclass
 from typing import List, Optional
 
-from microsoft.agents.hosting.core import TurnContext
+from microsoft_agents.hosting.core import TurnContext
 
 
 @dataclass

microsoft_agents/hosting/core/app/oauth/__init__.py

@@ -0,0 +1,8 @@
+from .authorization import Authorization
+from .auth_handler import AuthHandler, AuthorizationHandlers
+
+__all__ = [
+    "Authorization",
+    "AuthHandler",
+    "AuthorizationHandlers",
+]

microsoft_agents/hosting/core/app/oauth/auth_handler.py

@@ -0,0 +1,48 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+import logging
+from typing import Dict
+
+logger = logging.getLogger(__name__)
+
+
+class AuthHandler:
+    """
+    Interface defining an authorization handler for OAuth flows.
+    """
+
+    def __init__(
+        self,
+        name: str = None,
+        title: str = None,
+        text: str = None,
+        abs_oauth_connection_name: str = None,
+        obo_connection_name: str = None,
+        **kwargs,
+    ):
+        """
+        Initializes a new instance of AuthHandler.
+
+        Args:
+            name: The name of the OAuth connection.
+            auto: Whether to automatically start the OAuth flow.
+            title: Title for the OAuth card.
+            text: Text for the OAuth button.
+        """
+        self.name = name or kwargs.get("NAME")
+        self.title = title or kwargs.get("TITLE")
+        self.text = text or kwargs.get("TEXT")
+        self.abs_oauth_connection_name = abs_oauth_connection_name or kwargs.get(
+            "AZUREBOTOAUTHCONNECTIONNAME"
+        )
+        self.obo_connection_name = obo_connection_name or kwargs.get(
+            "OBOCONNECTIONNAME"
+        )
+        logger.debug(
+            f"AuthHandler initialized: name={self.name}, title={self.title}, text={self.text} abs_connection_name={self.abs_oauth_connection_name} obo_connection_name={self.obo_connection_name}"
+        )
+
+
+# # Type alias for authorization handlers dictionary
+AuthorizationHandlers = Dict[str, AuthHandler]