409676

Committed 28 May 2025 05:17PM UTC coverage: 67.239% (-0.008%) from 67.247%

Build # 409676

Build Type

push

python-ci

Committed by

web-flow

Commit Message

Teams SSO and OAuth fixes (#2226)

* Fixed Teams SSO & OAuth

* Formatting

---------

Co-authored-by: Tracy Boehrer <trboehre@microsoft.com>

Run Details

10 of 21 new or added lines in 8 files covered. (47.62%)

1 existing line in 1 file now uncovered.

9205 of 13690 relevant lines covered (67.24%)

2.68 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

72.39

/libraries/botbuilder-core/botbuilder/core/activity_handler.py

# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License.
from http import HTTPStatus
from typing import List, Union

from botbuilder.schema import (
    Activity,
    ActivityTypes,
    AdaptiveCardInvokeResponse,
    AdaptiveCardInvokeValue,
    ChannelAccount,
    InvokeResponse,
    MessageReaction,
    SignInConstants,
)

from .bot import Bot
from .serializer_helper import serializer_helper
from .bot_framework_adapter import BotFrameworkAdapter
from .turn_context import TurnContext


class ActivityHandler(Bot):
    """
    Handles activities and should be subclassed.

    .. remarks::
        Derive from this class to handle particular activity types.
        Yon can add pre and post processing of activities by calling the base class
        in the derived class.
    """

    async def on_turn(
        self, turn_context: TurnContext
    ):  # pylint: disable=arguments-differ
        """
        Called by the adapter (for example, :class:`BotFrameworkAdapter`) at runtime
        in order to process an inbound :class:`botbuilder.schema.Activity`.

        :param turn_context: The context object for this turn
        :type turn_context: :class:`botbuilder.core.TurnContext`

        :returns: A task that represents the work queued to execute

        .. remarks::
            It calls other methods in this class based on the type of the activity to
            process, which allows a derived class to provide type-specific logic in a controlled way.
            In a derived class, override this method to add logic that applies to all activity types.
            Also
            - Add logic to apply before the type-specific logic and before calling :meth:`on_turn()`.
            - Add logic to apply after the type-specific logic after calling :meth:`on_turn()`.
        """
        if turn_context is None:
            raise TypeError("ActivityHandler.on_turn(): turn_context cannot be None.")

        if hasattr(turn_context, "activity") and turn_context.activity is None:
            raise TypeError(
                "ActivityHandler.on_turn(): turn_context must have a non-None activity."
            )

        if (
            hasattr(turn_context.activity, "type")
            and turn_context.activity.type is None
        ):
            raise TypeError(
                "ActivityHandler.on_turn(): turn_context activity must have a non-None type."
            )

        if turn_context.activity.type == ActivityTypes.message:
            await self.on_message_activity(turn_context)
        elif turn_context.activity.type == ActivityTypes.message_update:
            await self.on_message_update_activity(turn_context)
        elif turn_context.activity.type == ActivityTypes.message_delete:
            await self.on_message_delete_activity(turn_context)
        elif turn_context.activity.type == ActivityTypes.conversation_update:
            await self.on_conversation_update_activity(turn_context)
        elif turn_context.activity.type == ActivityTypes.message_reaction:
            await self.on_message_reaction_activity(turn_context)
        elif turn_context.activity.type == ActivityTypes.event:
            await self.on_event_activity(turn_context)
        elif turn_context.activity.type == ActivityTypes.invoke:
            invoke_response = await self.on_invoke_activity(turn_context)

            # If OnInvokeActivityAsync has already sent an InvokeResponse, do not send another one.
            if invoke_response and not turn_context.turn_state.get(
                BotFrameworkAdapter._INVOKE_RESPONSE_KEY  # pylint: disable=protected-access
            ):
                await turn_context.send_activity(
                    Activity(value=invoke_response, type=ActivityTypes.invoke_response)
                )
        elif turn_context.activity.type == ActivityTypes.end_of_conversation:
            await self.on_end_of_conversation_activity(turn_context)
        elif turn_context.activity.type == ActivityTypes.typing:
            await self.on_typing_activity(turn_context)
        elif turn_context.activity.type == ActivityTypes.installation_update:
            await self.on_installation_update(turn_context)
        else:
            await self.on_unrecognized_activity_type(turn_context)

    async def on_message_activity(  # pylint: disable=unused-argument
        self, turn_context: TurnContext
    ):
        """
        Override this method in a derived class to provide logic specific to activities,
        such as the conversational logic.

        :param turn_context: The context object for this turn
        :type turn_context: :class:`botbuilder.core.TurnContext`

        :returns: A task that represents the work queued to execute
        """
        return

    async def on_message_update_activity(  # pylint: disable=unused-argument
        self, turn_context: TurnContext
    ):
        """
        Override this method in a derived class to provide logic specific to activities,
        such as the conversational logic.

        :param turn_context: The context object for this turn
        :type turn_context: :class:`botbuilder.core.TurnContext`

        :returns: A task that represents the work queued to execute
        """
        return

    async def on_message_delete_activity(  # pylint: disable=unused-argument
        self, turn_context: TurnContext
    ):
        """
        Override this method in a derived class to provide logic specific to activities,
        such as the conversational logic.

        :param turn_context: The context object for this turn
        :type turn_context: :class:`botbuilder.core.TurnContext`

        :returns: A task that represents the work queued to execute
        """
        return

    async def on_conversation_update_activity(self, turn_context: TurnContext):
        """
        Invoked when a conversation update activity is received from the channel when the base behavior of
        :meth:`on_turn()` is used.

        :param turn_context: The context object for this turn
        :type turn_context: :class:`botbuilder.core.TurnContext`

        :returns: A task that represents the work queued to execute

        .. remarks::
            When the :meth:`on_turn()` method receives a conversation update activity, it calls this
            method.
            Also
            - If the conversation update activity indicates that members other than the bot joined the conversation,
            it calls the  :meth:`on_members_added_activity()` method.
            - If the conversation update activity indicates that members other than the bot left the conversation,
            it calls the  :meth:`on_members_removed_activity()`  method.
            - In a derived class, override this method to add logic that applies to all conversation update activities.
            Add logic to apply before the member added or removed logic before the call to this base class method.
        """
        if (
            turn_context.activity.members_added is not None
            and turn_context.activity.members_added
        ):
            return await self.on_members_added_activity(
                turn_context.activity.members_added, turn_context
            )
        if (
            turn_context.activity.members_removed is not None
            and turn_context.activity.members_removed
        ):
            return await self.on_members_removed_activity(
                turn_context.activity.members_removed, turn_context
            )
        return

    async def on_members_added_activity(
        self, members_added: List[ChannelAccount], turn_context: TurnContext
    ):  # pylint: disable=unused-argument
        """
        Override this method in a derived class to provide logic for when members other than the bot join
        the conversation. You can add your bot's welcome logic.

        :param members_added: A list of all the members added to the conversation, as described by the
        conversation update activity
        :type members_added: :class:`typing.List`
        :param turn_context: The context object for this turn
        :type turn_context: :class:`botbuilder.core.TurnContext`

        :returns: A task that represents the work queued to execute

        .. remarks::
            When the :meth:`on_conversation_update_activity()` method receives a conversation
            update activity that indicates
            one or more users other than the bot are joining the conversation, it calls this method.
        """
        return

    async def on_members_removed_activity(
        self, members_removed: List[ChannelAccount], turn_context: TurnContext
    ):  # pylint: disable=unused-argument
        """
        Override this method in a derived class to provide logic for when members other than the bot leave
        the conversation.  You can add your bot's good-bye logic.

        :param members_added: A list of all the members removed from the conversation, as described by the
        conversation update activity
        :type members_added: :class:`typing.List`
        :param turn_context: The context object for this turn
        :type turn_context: :class:`botbuilder.core.TurnContext`

        :returns: A task that represents the work queued to execute

        .. remarks::
            When the :meth:`on_conversation_update_activity()` method receives a conversation
            update activity that indicates one or more users other than the bot are leaving the conversation,
            it calls this method.
        """

        return

    async def on_message_reaction_activity(self, turn_context: TurnContext):
        """
        Invoked when an event activity is received from the connector when the base behavior of
        :meth:`on_turn()` is used.

        :param turn_context: The context object for this turn
        :type turn_context: :class:`botbuilder.core.TurnContext`

        :returns: A task that represents the work queued to execute

        .. remarks::
            Message reactions correspond to the user adding a 'like' or 'sad' etc. (often an emoji) to a previously
            sent activity.

            Message reactions are only supported by a few channels. The activity that the message reaction corresponds
            to is indicated in the reply to Id property. The value of this property is the activity id of a previously
            sent activity given back to the bot as the response from a send call.
            When the :meth:`on_turn()` method receives a message reaction activity, it calls this
            method.

            - If the message reaction indicates that reactions were added to a message, it calls
            :meth:`on_reaction_added()`.
            - If the message reaction indicates that reactions were removed from a message, it calls
            :meth:`on_reaction_removed()`.

            In a derived class, override this method to add logic that applies to all message reaction activities.
            Add logic to apply before the reactions added or removed logic before the call to the this base class
            method.
            Add logic to apply after the reactions added or removed logic after the call to the this base class method.
        """
        if turn_context.activity.reactions_added is not None:
            await self.on_reactions_added(
                turn_context.activity.reactions_added, turn_context
            )

        if turn_context.activity.reactions_removed is not None:
            await self.on_reactions_removed(
                turn_context.activity.reactions_removed, turn_context
            )

    async def on_reactions_added(  # pylint: disable=unused-argument
        self, message_reactions: List[MessageReaction], turn_context: TurnContext
    ):
        """
        Override this method in a derived class to provide logic for when reactions to a previous activity
        are added to the conversation.

        :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:`botbuilder.core.TurnContext`

        :returns: A task that represents the work queued to execute

        .. remarks::
            Message reactions correspond to the user adding a 'like' or 'sad' etc. (often an emoji)
            to a previously sent message on the conversation.
            Message reactions are supported by only a few channels.
            The activity that the message is in reaction to is identified by the activity's reply to ID property.
            The value of this property is the activity ID of a previously sent activity. When the bot sends an activity,
            the channel assigns an ID to it, which is available in the resource response Id of the result.
        """
        return

    async def on_reactions_removed(  # pylint: disable=unused-argument
        self, message_reactions: List[MessageReaction], turn_context: TurnContext
    ):
        """
        Override this method in a derived class to provide logic for when reactions to a previous activity
        are removed from the conversation.

        :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:`botbuilder.core.TurnContext`

        :returns: A task that represents the work queued to execute

        .. remarks::
            Message reactions correspond to the user adding a 'like' or 'sad' etc. (often an emoji)
            to a previously sent message on the conversation. Message reactions are supported by only a few channels.
            The activity that the message is in reaction to is identified by the activity's reply to Id property.
            The value of this property is the activity ID of a previously sent activity. When the bot sends an activity,
            the channel assigns an ID to it, which is available in the resource response Id of the result.
        """
        return

    async def on_event_activity(self, turn_context: TurnContext):
        """
        Invoked when an event activity is received from the connector when the base behavior of
        :meth:`on_turn()` is used.

        :param turn_context: The context object for this turn
        :type turn_context: :class:`botbuilder.core.TurnContext`

        :returns: A task that represents the work queued to execute

        .. remarks::
            When the :meth:`on_turn()` method receives an event activity, it calls this method.
            If the activity name is `tokens/response`, it calls :meth:`on_token_response_event()`;
            otherwise, it calls :meth:`on_event()`.

            In a derived class, override this method to add logic that applies to all event activities.
            Add logic to apply before the specific event-handling logic before the call to this base class method.
            Add logic to apply after the specific event-handling logic after the call to this base class method.

            Event activities communicate programmatic information from a client or channel to a bot.
            The meaning of an event activity is defined by the event activity name property, which is meaningful within
            the scope of a channel.
        """
        if turn_context.activity.name == SignInConstants.token_response_event_name:
            return await self.on_token_response_event(turn_context)

        return await self.on_event(turn_context)

    async def on_token_response_event(  # pylint: disable=unused-argument
        self, turn_context: TurnContext
    ):
        """
        Invoked when a `tokens/response` event is received when the base behavior of
        :meth:`on_event_activity()` is used.
        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:`botbuilder.core.TurnContext`

        :returns: A task that represents the work queued to execute

        .. remarks::
            When the :meth:`on_event()` method receives an event with an activity name of
            `tokens/response`, it calls this method. If your bot uses an `oauth_prompt`, forward the incoming
            activity to the current dialog.
        """
        return

    async def on_event(  # pylint: disable=unused-argument
        self, turn_context: TurnContext
    ):
        """
        Invoked when an event other than `tokens/response` is received when the base behavior of
        :meth:`on_event_activity()` is used.


        :param turn_context: The context object for this turn
        :type turn_context: :class:`botbuilder.core.TurnContext`

        :returns: A task that represents the work queued to execute

        .. remarks::
            When the :meth:`on_event_activity()` is used method receives an event with an
            activity name other than `tokens/response`, it calls this method.
            This method could optionally be overridden if the bot is meant to handle miscellaneous events.
        """
        return

    async def on_end_of_conversation_activity(  # pylint: disable=unused-argument
        self, turn_context: TurnContext
    ):
        """
        Invoked when a conversation end activity is received from the channel.

        :param turn_context: The context object for this turn
        :type turn_context: :class:`botbuilder.core.TurnContext`
        :returns: A task that represents the work queued to execute
        """
        return

    async def on_typing_activity(  # pylint: disable=unused-argument
        self, turn_context: TurnContext
    ):
        """
        Override this in a derived class to provide logic specific to
        ActivityTypes.typing activities, such as the conversational logic.

        :param turn_context: The context object for this turn
        :type turn_context: :class:`botbuilder.core.TurnContext`
        :returns: A task that represents the work queued to execute
        """
        return

    async def on_installation_update(  # pylint: disable=unused-argument
        self, turn_context: TurnContext
    ):
        """
        Override this in a derived class to provide logic specific to
        ActivityTypes.InstallationUpdate activities.

        :param turn_context: The context object for this turn
        :type turn_context: :class:`botbuilder.core.TurnContext`
        :returns: A task that represents the work queued to execute
        """
        if turn_context.activity.action in ("add", "add-upgrade"):
            return await self.on_installation_update_add(turn_context)
        if turn_context.activity.action in ("remove", "remove-upgrade"):
            return await self.on_installation_update_remove(turn_context)
        return

    async def on_installation_update_add(  # pylint: disable=unused-argument
        self, turn_context: TurnContext
    ):
        """
        Override this in a derived class to provide logic specific to
        ActivityTypes.InstallationUpdate activities with 'action' set to 'add'.

        :param turn_context: The context object for this turn
        :type turn_context: :class:`botbuilder.core.TurnContext`
        :returns: A task that represents the work queued to execute
        """
        return

    async def on_installation_update_remove(  # pylint: disable=unused-argument
        self, turn_context: TurnContext
    ):
        """
        Override this in a derived class to provide logic specific to
        ActivityTypes.InstallationUpdate activities with 'action' set to 'remove'.

        :param turn_context: The context object for this turn
        :type turn_context: :class:`botbuilder.core.TurnContext`
        :returns: A task that represents the work queued to execute
        """
        return

    async def on_unrecognized_activity_type(  # pylint: disable=unused-argument
        self, turn_context: TurnContext
    ):
        """
        Invoked when an activity other than a message, conversation update, or event is received when the base
        behavior of :meth:`on_turn()` is used.
        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:`botbuilder.core.TurnContext`

        :returns: A task that represents the work queued to execute

        .. remarks::
            When the :meth:`on_turn()` method receives an activity that is not a message,
            conversation update, message reaction, or event activity, it calls this method.
        """
        return

    async def on_invoke_activity(  # pylint: disable=unused-argument
        self, turn_context: TurnContext
    ) -> Union[InvokeResponse, None]:
        """
        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:`botbuilder.core.TurnContext`

        :returns: A task that represents the work queued to execute
        """
        try:
            if (
                turn_context.activity.name
                == SignInConstants.verify_state_operation_name
            ):
                await self.on_sign_in_invoke(turn_context)
                return self._create_invoke_response()

            # This is for back-compat with previous versions of Python SDK.  This method does not
            # exist in the C# SDK, and is not used in the Python SDK.
            if (
                turn_context.activity.name
                == SignInConstants.token_exchange_operation_name
            ):
                await self.on_teams_signin_token_exchange(turn_context)
                return self._create_invoke_response()

            if turn_context.activity.name == "adaptiveCard/action":
                invoke_value = self._get_adaptive_card_invoke_value(
                    turn_context.activity
                )
                return self._create_invoke_response(
                    await self.on_adaptive_card_invoke(turn_context, invoke_value)
                )

            raise _InvokeResponseException(HTTPStatus.NOT_IMPLEMENTED)
        except _InvokeResponseException as invoke_exception:
            return invoke_exception.create_invoke_response()

    async def on_sign_in_invoke(  # pylint: disable=unused-argument
        self, turn_context: TurnContext
    ):
        """
        Invoked when a signin/verifyState or signin/tokenExchange event is received when the base behavior of
        on_invoke_activity(TurnContext{InvokeActivity}) is used.
        If using an OAuthPrompt, override this method to forward this Activity"/ to the current dialog.
        By default, this method does nothing.

        :param turn_context: The context object for this turn
        :type turn_context: :class:`botbuilder.core.TurnContext`

        :returns: A task that represents the work queued to execute
        """
        raise _InvokeResponseException(HTTPStatus.NOT_IMPLEMENTED)

    async def on_adaptive_card_invoke(
        self, turn_context: TurnContext, invoke_value: AdaptiveCardInvokeValue
    ) -> AdaptiveCardInvokeResponse:
        """
        Invoked when the bot is sent an Adaptive Card Action Execute.

        When the on_invoke_activity method receives an Invoke with a Activity.name of `adaptiveCard/action`, it
        calls this method.

        :param turn_context: A context object for this turn.
        :type turn_context: :class:`botbuilder.core.TurnContext`
        :param invoke_value: A string-typed object from the incoming activity's value.
        :type invoke_value: :class:`botframework.schema.models.AdaptiveCardInvokeValue`
        :return: The HealthCheckResponse object
        """
        raise _InvokeResponseException(HTTPStatus.NOT_IMPLEMENTED)

    @staticmethod
    def _create_invoke_response(body: object = None) -> InvokeResponse:
        return InvokeResponse(status=int(HTTPStatus.OK), body=serializer_helper(body))

    def _get_adaptive_card_invoke_value(self, activity: Activity):
        if activity.value is None:
            response = self._create_adaptive_card_invoke_error_response(
                HTTPStatus.BAD_REQUEST, "BadRequest", "Missing value property"
            )
            raise _InvokeResponseException(HTTPStatus.BAD_REQUEST, response)

        invoke_value = None
        try:
            invoke_value = AdaptiveCardInvokeValue(**activity.value)
        except:
            response = self._create_adaptive_card_invoke_error_response(
                HTTPStatus.BAD_REQUEST,
                "BadRequest",
                "Value property is not properly formed",
            )
            raise _InvokeResponseException(HTTPStatus.BAD_REQUEST, response)

        if invoke_value.action is None:
            response = self._create_adaptive_card_invoke_error_response(
                HTTPStatus.BAD_REQUEST, "BadRequest", "Missing action property"
            )
            raise _InvokeResponseException(HTTPStatus.BAD_REQUEST, response)

        if invoke_value.action.get("type") != "Action.Execute":
            response = self._create_adaptive_card_invoke_error_response(
                HTTPStatus.BAD_REQUEST,
                "NotSupported",
                f"The action '{invoke_value.action.get('type')}' is not supported.",
            )
            raise _InvokeResponseException(HTTPStatus.BAD_REQUEST, response)

        return invoke_value

    def _create_adaptive_card_invoke_error_response(
        self, status_code: HTTPStatus, code: str, message: str
    ):
        return AdaptiveCardInvokeResponse(
            status_code=status_code,
            type="application/vnd.microsoft.error",
            value=Exception(code, message),
        )


class _InvokeResponseException(Exception):
    def __init__(self, status_code: HTTPStatus, body: object = None):
        super(_InvokeResponseException, self).__init__()
        self._status_code = status_code
        self._body = body

    def create_invoke_response(self) -> InvokeResponse:
        return InvokeResponse(status=int(self._status_code), body=self._body)

microsoft / botbuilder-python / 409676

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous