Reorganizing OAuth Flow (#99)

* Changed default cloud for ConnectionSettings to be PROD

* New draft implementations for classes to rework authorization

* Revising oauth refactor with new proposed architecture

* Adding code to connect to AgentApp

* Generating new unit tests

* Filling in test cases for OAuthFlow and models

* Adding more tests

* Fixing test cases and catching bugs

* Another commit

* Finishing flow storage client and auth flow tests

* Adding more authorization tests

* Adding documentation

* Added more Authorizationt tests and fixed inconsistencies in storage client

* Renaming, restructing, and revising imports

* Passing all Authorization unit tests

* Cleaning code and removing unused args

* Fixing test cases and implementing cached client

* Added refresh() and adjusted tests

* Aligned more test cases

* Fixed expiration time handling

* Changed magic_code keyword to code in tests

* Fixed expiration time issue

* Undid TokenResponse changes

* Updated logging

* Adding some comments

* Removed unused cache field

* Added back the __bool__ op on TokenResponse

* Revised some comments

* Updated default flow duration to 10 minutes

* Changing default flow duration

* Reformatted with black

* Added pytest-mock as a dependency

Author: rodrigobr-msft

.azdo/ci-pr.yaml

@@ -26,7 +26,7 @@ steps:
 
 - script: |
     python -m pip install --upgrade pip
-    python -m pip install flake8 pytest black pytest-asyncio build setuptools-git-versioning
+    python -m pip install flake8 pytest pytest-mock black pytest-asyncio build setuptools-git-versioning
     if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
   displayName: 'Install dependencies'
 

.github/workflows/python-package.yml

@@ -30,7 +30,7 @@ jobs:
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        python -m pip install flake8 pytest black pytest-asyncio build setuptools-git-versioning
+        python -m pip install flake8 pytest pytest-mock black pytest-asyncio build setuptools-git-versioning
         if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
     - name: Check format with black
       run: |

libraries/microsoft-agents-activity/microsoft/agents/activity/token_response.py

@@ -23,3 +23,6 @@ class TokenResponse(AgentsModel):
     token: NonEmptyString = None
     expiration: NonEmptyString = None
     channel_id: NonEmptyString = None
+
+    def __bool__(self):
+        return bool(self.token)

libraries/microsoft-agents-hosting-core/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.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.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 @@
 __all__ = [
     "ActivityHandler",
     "Agent",
-    "OAuthFlow",
     "CardFactory",
     "ChannelAdapter",
     "ChannelApiHandlerProtocol",
@@ -155,4 +162,10 @@
     "StoreItem",
     "Storage",
     "MemoryStorage",
+    "FlowState",
+    "FlowStateTag",
+    "FlowErrorTag",
+    "FlowResponse",
+    "FlowStorageClient",
+    "OAuthFlow",
 ]

libraries/microsoft-agents-hosting-core/microsoft/agents/hosting/core/app/__init__.py

@@ -13,12 +13,11 @@
 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 @@
     "TurnState",
     "TempState",
     "Authorization",
-    "AuthorizationHandlers",
     "AuthHandler",
-    "SignInState",
+    "AuthorizationHandlers",
 ]