microsoft-agents-hosting-core 1.2.0.dev16__tar.gz → 1.2.0.dev20__tar.gz

{microsoft_agents_hosting_core-1.2.0.dev16/microsoft_agents_hosting_core.egg-info → microsoft_agents_hosting_core-1.2.0.dev20}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: microsoft-agents-hosting-core
-Version: 1.2.0.dev16
+Version: 1.2.0.dev20
 Summary: Core library for Microsoft Agents
 Author: Microsoft Corporation
 License-Expression: MIT
@@ -15,7 +15,7 @@ Classifier: Operating System :: OS Independent
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: microsoft-agents-activity==1.2.0.dev16
+Requires-Dist: microsoft-agents-activity==1.2.0.dev20
 Requires-Dist: pyjwt>=2.10.1
 Requires-Dist: isodate>=0.6.1
 Requires-Dist: azure-core>=1.30.0

microsoft_agents_hosting_core-1.2.0.dev20/VERSION.txt

@@ -0,0 +1 @@
+1.2.0.dev20

{microsoft_agents_hosting_core-1.2.0.dev16 → microsoft_agents_hosting_core-1.2.0.dev20}/microsoft_agents/hosting/core/__init__.py

@@ -6,7 +6,7 @@ from .channel_api_handler_protocol import ChannelApiHandlerProtocol
 from .channel_service_adapter import ChannelServiceAdapter
 from .channel_service_client_factory_base import ChannelServiceClientFactoryBase
 from .message_factory import MessageFactory
-from .middleware_set import Middleware
+from .middleware_set import Middleware, MiddlewareSet
 from .rest_channel_service_client_factory import RestChannelServiceClientFactory
 from .turn_context import TurnContext
 
@@ -174,6 +174,7 @@ __all__ = [
     "MemoryStorage",
     "AgenticUserAuthorization",
     "Authorization",
+    "MiddlewareSet",
     "error_resources",
     "ErrorMessage",
     "ErrorResources",

{microsoft_agents_hosting_core-1.2.0.dev16 → microsoft_agents_hosting_core-1.2.0.dev20}/microsoft_agents/hosting/core/channel_adapter.py

@@ -232,16 +232,14 @@ class ChannelAdapter(ABC, ChannelAdapterProtocol):
         :param context: The context object for the turn.
         :type context: :class:`microsoft_agents.hosting.core.turn_context.TurnContext`
         :param callback: A callback method to run at the end of the pipeline.
-        :type callback: Callable[[TurnContext], Awaitable]
-        :return: Result produced by the middleware pipeline.
-        :rtype: typing.Any
+        :type callback: Callable[[TurnContext], Awaitable] | None
         """
         if context is None:
             raise TypeError(context.__class__.__name__)
 
         if context.activity is not None:
             try:
-                return await self.middleware_set.receive_activity_with_status(
+                await self.middleware_set.receive_activity_with_status(
                     context, callback
                 )
             except Exception as error:

{microsoft_agents_hosting_core-1.2.0.dev16 → microsoft_agents_hosting_core-1.2.0.dev20}/microsoft_agents/hosting/core/connector/client/user_token_client.py

@@ -9,6 +9,7 @@ from aiohttp import ClientResponseError, ClientSession
 
 from microsoft_agents.hosting.core.connector import UserTokenClientBase
 from microsoft_agents.activity import (
+    ChannelId,
     TokenOrSignInResourceResponse,
     TokenResponse,
     TokenStatus,
@@ -112,6 +113,15 @@ class UserToken(UserTokenBase):
     def __init__(self, client: ClientSession):
         self.client = client
 
+    @staticmethod
+    def _base_channel_id(channel_id: Optional[str]) -> Optional[str]:
+        """Return the Bot Framework channel without an optional sub-channel."""
+        if not channel_id or not channel_id.strip():
+            return channel_id
+
+        base_channel_id = ChannelId(channel_id).channel
+        return base_channel_id or channel_id
+
     async def get_token(
         self,
         user_id: str,
@@ -120,6 +130,8 @@ class UserToken(UserTokenBase):
         code: Optional[str] = None,
     ) -> TokenResponse:
 
+        channel_id = self._base_channel_id(channel_id)
+
         with spans.GetUserToken(
             connection_name=connection_name, user_id=user_id, channel_id=channel_id
         ) as span:
@@ -155,6 +167,8 @@ class UserToken(UserTokenBase):
     ) -> TokenOrSignInResourceResponse:
         """Get token or sign-in resource for a user."""
 
+        channel_id = self._base_channel_id(channel_id)
+
         with spans.GetTokenOrSignInResource(
             connection_name=connection_name, user_id=user_id, channel_id=channel_id
         ) as span:
@@ -192,6 +206,8 @@ class UserToken(UserTokenBase):
     ) -> dict[str, TokenResponse]:
         """Get AAD tokens for a user."""
 
+        channel_id = self._base_channel_id(channel_id)
+
         with spans.GetAadTokens(
             connection_name=connection_name, user_id=user_id, channel_id=channel_id
         ) as span:
@@ -221,6 +237,8 @@ class UserToken(UserTokenBase):
     ) -> None:
         """Sign out user from a connection."""
 
+        channel_id = self._base_channel_id(channel_id)
+
         with spans.SignOut(
             user_id=user_id, connection_name=connection_name, channel_id=channel_id
         ) as span:
@@ -249,6 +267,8 @@ class UserToken(UserTokenBase):
     ) -> list[TokenStatus]:
         """Get token status for a user."""
 
+        channel_id = self._base_channel_id(channel_id)
+
         with spans.GetTokenStatus(user_id=user_id, channel_id=channel_id) as span:
             params = {"userId": user_id}
 
@@ -281,6 +301,8 @@ class UserToken(UserTokenBase):
     ) -> TokenResponse:
         """Exchange token for a user."""
 
+        channel_id = self._base_channel_id(channel_id)
+
         with spans.ExchangeToken(
             connection_name=connection_name, user_id=user_id, channel_id=channel_id
         ) as span:

microsoft_agents_hosting_core-1.2.0.dev20/microsoft_agents/hosting/core/middleware_set.py

@@ -0,0 +1,99 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+from abc import abstractmethod
+from typing import Awaitable, Callable, Protocol
+from typing_extensions import Self
+
+from .turn_context import TurnContext
+
+
+class Middleware(Protocol):
+
+    @abstractmethod
+    async def on_turn(
+        self, context: TurnContext, logic: Callable[[TurnContext], Awaitable]
+    ):
+        """
+        Called for each turn of the conversation.
+
+        :param context: The turn context.
+        :param logic: The next middleware in the pipeline or the final logic to be executed.
+        """
+        pass
+
+
+class MiddlewareSet(Middleware):
+    """
+    A set of `Middleware` plugins. The set itself is middleware so you can easily package up a set
+    of middleware that can be composed into an agent with a single `agent.use(mySet)` call or even into
+    another middleware set using `set.use(mySet)`.
+    """
+
+    def __init__(self):
+        super().__init__()
+        self._middleware: list[Middleware] = []
+
+    def use(self, *middleware: Middleware) -> Self:
+        """
+        Registers middleware plugin(s) with the agent or set.
+        :param middleware : The middleware plugin(s) to register.
+        :return: The `MiddlewareSet` instance to allow chaining of `use` calls.
+        :rtype: Self
+        """
+        for idx, mid in enumerate(middleware):
+            if hasattr(mid, "on_turn") and callable(mid.on_turn):
+                self._middleware.append(mid)
+            else:
+                raise TypeError(
+                    'MiddlewareSet.use(): invalid middleware at index "%s" being added.'
+                    % idx
+                )
+        return self
+
+    async def _receive_activity_internal(
+        self,
+        context: TurnContext,
+        callback: Callable[[TurnContext], Awaitable] | None,
+        next_middleware_index: int = 0,
+    ):
+        """Recursively invokes middleware in the set, passing the context and callback through the pipeline.
+
+        :param context: The turn context.
+        :param callback: The final logic to be executed after the middleware pipeline.
+        :param next_middleware_index: The index of the next middleware to invoke.
+        """
+        if next_middleware_index == len(self._middleware):
+            if callback is not None:
+                await callback(context)
+            return
+
+        next_middleware = self._middleware[next_middleware_index]
+
+        async def call_next_middleware(ctx: TurnContext):
+            await self._receive_activity_internal(
+                ctx, callback, next_middleware_index + 1
+            )
+
+        await next_middleware.on_turn(context, call_next_middleware)
+
+    async def receive_activity_with_status(
+        self, context: TurnContext, logic: Callable[[TurnContext], Awaitable] | None
+    ):
+        """Handles an incoming activity by passing it through the middleware pipeline and then to the final logic.
+
+        :param context: The turn context.
+        :param logic: The final logic to be executed after the middleware pipeline.
+        """
+        await self._receive_activity_internal(context, logic)
+
+    async def on_turn(
+        self, context: TurnContext, logic: Callable[[TurnContext], Awaitable]
+    ):
+        """Handles an incoming activity by passing it through the middleware pipeline and then to the final logic.
+
+        :param context: The turn context.
+        :param logic: The final logic to be executed after the middleware pipeline.
+        """
+        await self._receive_activity_internal(context, None)
+        await logic(context)

{microsoft_agents_hosting_core-1.2.0.dev16 → microsoft_agents_hosting_core-1.2.0.dev20}/microsoft_agents/hosting/core/state/agent_state.py

@@ -5,6 +5,7 @@ from __future__ import annotations
 
 from abc import abstractmethod
 from copy import deepcopy
+import logging
 from typing import Callable, Type
 
 from microsoft_agents.hosting.core.storage import Storage, StoreItem
@@ -12,6 +13,8 @@ from microsoft_agents.hosting.core.storage import Storage, StoreItem
 from .state_property_accessor import StatePropertyAccessor
 from ..turn_context import TurnContext
 
+logger = logging.getLogger(__name__)
+
 
 class CachedAgentState(StoreItem):
     """
@@ -47,6 +50,10 @@ class CachedAgentState(StoreItem):
         }
         return serialized
 
+    def clear(self) -> None:
+        self.state = {}
+        self.hash = ""
+
     @staticmethod
     def from_json_to_store_item(json_data: dict) -> StoreItem:
         return CachedAgentState(json_data)
@@ -87,16 +94,23 @@ class AgentState:
         self._context_service_key = context_service_key
         self._cached_state: CachedAgentState | None = None
 
-    def get_cached_state(self, turn_context: TurnContext) -> CachedAgentState:
+    def get_cached_state(
+        self, turn_context: TurnContext | None = None
+    ) -> CachedAgentState:
         """
         Gets the cached agent state instance that wraps the raw cached data for this "AgentState"
         from the turn context.
 
-        :param turn_context: The context object for this turn.
+        :param turn_context: Deprecated. The context object for this turn. This parameter is no
+            longer required and will be removed in a future release.
         :type turn_context: :class:`microsoft_agents.hosting.core.turn_context.TurnContext`
         :return: The cached agent state instance.
         """
-        return turn_context.turn_state.get(self._context_service_key)
+        if turn_context:
+            logger.warning(
+                "AgentState.get_cached_state(): turn_context is deprecated and no longer required for get_cached_state(); it will be removed in a future release"
+            )
+        return self._cached_state
 
     def create_property(self, name: str) -> StatePropertyAccessor:
         """
@@ -113,10 +127,20 @@ class AgentState:
             )
         return BotStatePropertyAccessor(self, name)
 
-    def get(self, turn_context: TurnContext) -> dict[str, StoreItem]:
-        cached = self.get_cached_state(turn_context)
+    def get(self, turn_context: TurnContext | None = None) -> dict[str, StoreItem]:
+        """
+        Gets the raw cached state dictionary for this "AgentState".
 
-        return getattr(cached, "state", None)
+        :param turn_context: Deprecated. The context object for this turn. This parameter is no
+            longer required and will be removed in a future release.
+        :type turn_context: :class:`microsoft_agents.hosting.core.turn_context.TurnContext`
+        :return: The cached state dictionary.
+        """
+        if turn_context:
+            logger.warning(
+                "AgentState.get(): turn_context is deprecated and no longer required for get(); it will be removed in a future release"
+            )
+        return getattr(self._cached_state, "state", None)
 
     async def load(self, turn_context: TurnContext, force: bool = False) -> None:
         """
@@ -129,12 +153,27 @@ class AgentState:
         """
         storage_key = self.get_storage_key(turn_context)
 
-        if force or not self._cached_state:
+        if self._should_load(turn_context, force):
             items = await self._storage.read([storage_key], target_cls=CachedAgentState)
             val = items.get(storage_key, CachedAgentState())
             self._cached_state = val
             turn_context.turn_state[self._context_service_key] = val
 
+    def _should_load(self, turn_context: TurnContext, force: bool = False) -> bool:
+        """
+        Determines whether the state should be loaded from storage.
+
+        :param turn_context: The context object for this turn
+        :type turn_context: :class:`microsoft_agents.hosting.core.turn_context.TurnContext`
+        :param force: Optional, true to bypass the cache
+        :type force: bool
+        :return: True if the state should be loaded from storage, False otherwise
+        :rtype: bool
+        """
+
+        self._cached_state = turn_context.turn_state.get(self._context_service_key)
+        return force or self._cached_state is None
+
     async def save(self, turn_context: TurnContext, force: bool = False) -> None:
         """
         Saves the state cached in the current context for this turn.
@@ -146,17 +185,21 @@ class AgentState:
         :type force: bool
         """
 
-        if force or (self._cached_state is not None and self._cached_state.is_changed):
+        # Avoid self._cached_state updating during the save operation
+        cached_state = self._cached_state
+
+        if force or (cached_state is not None and cached_state.is_changed):
             storage_key = self.get_storage_key(turn_context)
-            changes: dict[str, StoreItem] = {storage_key: self._cached_state}
+            changes: dict[str, StoreItem] = {storage_key: cached_state}
             await self._storage.write(changes)
-            self._cached_state.hash = self._cached_state.compute_hash()
+            cached_state.hash = cached_state.compute_hash()
 
-    def clear(self, turn_context: TurnContext):
+    def clear(self, turn_context: TurnContext | None = None) -> None:
         """
         Clears any state currently stored in this state scope.
 
-        :param turn_context: The context object for this turn
+        :param turn_context: Deprecated. The context object for this turn. This parameter is no
+            longer required and will be removed in a future release.
         :type turn_context: :class:`microsoft_agents.hosting.core.turn_context.TurnContext`
 
         :return: None
@@ -165,9 +208,14 @@ class AgentState:
             This function must be called in order for the cleared state to be persisted to the underlying store.
         """
         #  Explicitly setting the hash will mean IsChanged is always true. And that will force a Save.
-        cache_value = CachedAgentState()
-        cache_value.hash = ""
-        self._cached_state = cache_value
+        if turn_context:
+            logger.warning(
+                "AgentState.clear(): turn_context is deprecated and no longer required for clear(); it will be removed in a future release"
+            )
+        if self._cached_state is None:
+            logger.warning("AgentState.clear(): No cached state to clear.")
+            return
+        self._cached_state.clear()
 
     async def delete(self, turn_context: TurnContext) -> None:
         """
@@ -246,7 +294,7 @@ class AgentState:
         """
         if not property_name:
             raise TypeError(
-                "AgentState.delete_property(): property_name cannot be None."
+                "AgentState.delete_value(): property_name cannot be None or empty."
             )
 
         if self._cached_state.state.get(property_name):
@@ -265,7 +313,7 @@ class AgentState:
         """
         if not property_name:
             raise TypeError(
-                "AgentState.delete_property(): property_name cannot be None."
+                "AgentState.set_value(): property_name cannot be None or empty."
             )
         self._cached_state.state[property_name] = value
 

{microsoft_agents_hosting_core-1.2.0.dev16 → microsoft_agents_hosting_core-1.2.0.dev20}/microsoft_agents/hosting/core/storage/transcript_logger.py

@@ -112,7 +112,7 @@ class TranscriptLoggerMiddleware(Middleware):
         self.logger = logger
 
     async def on_turn(
-        self, context: TurnContext, logic: Callable[[TurnContext], Awaitable]
+        self, context: TurnContext, logic: Callable[[TurnContext], Awaitable] | None
     ):
         """Initialization for middleware.
         :param context: Context for the current turn of conversation with the user.
@@ -201,7 +201,7 @@ class TranscriptLoggerMiddleware(Middleware):
         context.on_delete_activity(delete_activity_handler)
 
         if logic:
-            await logic()
+            await logic(context)
 
         # Flush transcript at end of turn
         while not transcript.empty():

{microsoft_agents_hosting_core-1.2.0.dev16 → microsoft_agents_hosting_core-1.2.0.dev20/microsoft_agents_hosting_core.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: microsoft-agents-hosting-core
-Version: 1.2.0.dev16
+Version: 1.2.0.dev20
 Summary: Core library for Microsoft Agents
 Author: Microsoft Corporation
 License-Expression: MIT
@@ -15,7 +15,7 @@ Classifier: Operating System :: OS Independent
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: microsoft-agents-activity==1.2.0.dev16
+Requires-Dist: microsoft-agents-activity==1.2.0.dev20
 Requires-Dist: pyjwt>=2.10.1
 Requires-Dist: isodate>=0.6.1
 Requires-Dist: azure-core>=1.30.0

{microsoft_agents_hosting_core-1.2.0.dev16 → microsoft_agents_hosting_core-1.2.0.dev20}/microsoft_agents_hosting_core.egg-info/requires.txt

@@ -1,4 +1,4 @@
-microsoft-agents-activity==1.2.0.dev16
+microsoft-agents-activity==1.2.0.dev20
 pyjwt>=2.10.1
 isodate>=0.6.1
 azure-core>=1.30.0

microsoft_agents_hosting_core-1.2.0.dev16/VERSION.txt

@@ -1 +0,0 @@
-1.2.0.dev16

microsoft_agents_hosting_core-1.2.0.dev16/microsoft_agents/hosting/core/middleware_set.py

@@ -1,78 +0,0 @@
-# Copyright (c) Microsoft Corporation. All rights reserved.
-# Licensed under the MIT License.
-
-from abc import abstractmethod
-from typing import Awaitable, Callable, Protocol
-
-from .turn_context import TurnContext
-
-
-class Middleware(Protocol):
-    @abstractmethod
-    async def on_turn(
-        self, context: TurnContext, logic: Callable[[TurnContext], Awaitable]
-    ):
-        pass
-
-
-class MiddlewareSet(Middleware):
-    """
-    A set of `Middleware` plugins. The set itself is middleware so you can easily package up a set
-    of middleware that can be composed into an agent with a single `agent.use(mySet)` call or even into
-    another middleware set using `set.use(mySet)`.
-    """
-
-    def __init__(self):
-        super(MiddlewareSet, self).__init__()
-        self._middleware: list[Middleware] = []
-
-    def use(self, *middleware: Middleware):
-        """
-        Registers middleware plugin(s) with the agent or set.
-        :param middleware :
-        :return:
-        """
-        for idx, mid in enumerate(middleware):
-            if hasattr(mid, "on_turn") and callable(mid.on_turn):
-                self._middleware.append(mid)
-                return self
-            raise TypeError(
-                'MiddlewareSet.use(): invalid middleware at index "%s" being added.'
-                % idx
-            )
-
-    async def receive_activity(self, context: TurnContext):
-        await self.receive_activity_internal(context, None)
-
-    async def on_turn(
-        self, context: TurnContext, logic: Callable[[TurnContext], Awaitable]
-    ):
-        await self.receive_activity_internal(context, None)
-        await logic()
-
-    async def receive_activity_with_status(
-        self, context: TurnContext, callback: Callable[[TurnContext], Awaitable]
-    ):
-        return await self.receive_activity_internal(context, callback)
-
-    async def receive_activity_internal(
-        self,
-        context: TurnContext,
-        callback: Callable[[TurnContext], Awaitable],
-        next_middleware_index: int = 0,
-    ):
-        if next_middleware_index == len(self._middleware):
-            if callback is not None:
-                return await callback(context)
-            return None
-        next_middleware = self._middleware[next_middleware_index]
-
-        async def call_next_middleware():
-            return await self.receive_activity_internal(
-                context, callback, next_middleware_index + 1
-            )
-
-        try:
-            return await next_middleware.on_turn(context, call_next_middleware)
-        except Exception as error:
-            raise error