[Communication] Use CommunicationRefreshOptions in CommunicaitonTokenCredential (#16228)

* Add user_token_refresh_options.py

* Change to use user_token_refresh_options

* Add user_token_refresh_options.py in chat and sms sdk

* Fix CommunicationTokenRefreshOptions

* Fix CommunicationTokenRefreshOptions

* Fix lint error

* Fix Doc string

* Change order of import six

* Remove unnecessary import

* Address PR review feedback

Author: sacheun

sdk/communication/azure-communication-administration/azure/communication/administration/_shared/user_credential.py

@@ -9,27 +9,22 @@
     cast,
     Tuple,
 )
-import six
+
 from msrest.serialization import TZ_UTC
-from .utils import create_access_token
 
 class CommunicationTokenCredential(object):
     """Credential type used for authenticating to an Azure Communication service.
-    :param str token: The token used to authenticate to an Azure Communication service
-    :raises: TypeError
+    :param communication_token_refresh_options: The token used to authenticate to an Azure Communication service
+    :type communication_token_refresh_options: ~azure.communication.chat.CommunicationTokenRefreshOptions
     """
 
     ON_DEMAND_REFRESHING_INTERVAL_MINUTES = 2
 
     def __init__(self,
-            token, # type: str
-            token_refresher=None
+            communication_token_refresh_options
         ):
-        # type: (str) -> None
-        if not isinstance(token, six.string_types):
-            raise TypeError("token must be a string.")
-        self._token = create_access_token(token)
-        self._token_refresher = token_refresher
+        self._token = communication_token_refresh_options.get_token()
+        self._token_refresher = communication_token_refresh_options.get_token_refresher()
         self._lock = Condition(Lock())
         self._some_thread_refreshing = False
 
@@ -70,7 +65,6 @@ def get_token(self):
                     self._lock.notify_all()
 
                 raise
-
         return self._token
 
     def _wait_till_inprogress_thread_finish_refreshing(self):

sdk/communication/azure-communication-administration/azure/communication/administration/_shared/user_credential_async.py

@@ -9,27 +9,23 @@
     cast,
     Tuple,
 )
-import six
+
 from msrest.serialization import TZ_UTC
-from .utils import create_access_token
 
 class CommunicationTokenCredential(object):
     """Credential type used for authenticating to an Azure Communication service.
-    :param str token: The token used to authenticate to an Azure Communication service
+    :param communication_token_refresh_options: The token used to authenticate to an Azure Communication service
+    :type communication_token_refresh_options: ~azure.communication.chat.aio.CommunicationTokenRefreshOptions
     :raises: TypeError
     """
 
     ON_DEMAND_REFRESHING_INTERVAL_MINUTES = 2
 
     def __init__(self,
-            token, # type: str
-            token_refresher=None
+            communication_token_refresh_options
         ):
-        # type: (str) -> None
-        if not isinstance(token, six.string_types):
-            raise TypeError("token must be a string.")
-        self._token = create_access_token(token)
-        self._token_refresher = token_refresher
+        self._token = communication_token_refresh_options.get_token()
+        self._token_refresher = communication_token_refresh_options.get_token_refresher()
         self._lock = Condition(Lock())
         self._some_thread_refreshing = False
 

sdk/communication/azure-communication-administration/azure/communication/administration/_shared/user_token_refresh_options.py

@@ -0,0 +1,36 @@
+# -------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for
+# license information.
+# --------------------------------------------------------------------------
+from typing import ( # pylint: disable=unused-import
+    cast,
+    Tuple,
+)
+import six
+from .utils import create_access_token
+
+class CommunicationTokenRefreshOptions(object):
+    """Options for refreshing CommunicationTokenCredential.
+    :param str token: The token used to authenticate to an Azure Communication service
+    :param token_refresher: The token refresher to provide capacity to fetch fresh token
+    :raises: TypeError
+    """
+
+    def __init__(self,
+        token, # type: str
+        token_refresher=None
+    ):
+        # type: (str) -> None
+        if not isinstance(token, six.string_types):
+            raise TypeError("token must be a string.")
+        self._token = token
+        self._token_refresher = token_refresher
+
+    def get_token(self):
+        """Return the the serialized JWT token."""
+        return create_access_token(self._token)
+
+    def get_token_refresher(self):
+        """Return the token refresher to provide capacity to fetch fresh token."""
+        return self._token_refresher

sdk/communication/azure-communication-administration/tests/user_credential_tests.py

@@ -6,6 +6,7 @@
 from unittest import TestCase
 from unittest.mock import MagicMock
 from azure.communication.administration._shared.user_credential import CommunicationTokenCredential
+from azure.communication.administration._shared.user_token_refresh_options import CommunicationTokenRefreshOptions
 from azure.communication.administration._shared.utils import create_access_token
 
 
@@ -18,24 +19,29 @@ class TestCommunicationTokenCredential(TestCase):
 
 
     def test_communicationtokencredential_decodes_token(self):
-        credential = CommunicationTokenCredential(self.sample_token)
+        refresh_options = CommunicationTokenRefreshOptions(self.sample_token)
+        credential = CommunicationTokenCredential(refresh_options)
         access_token = credential.get_token()
 
         self.assertEqual(access_token.token, self.sample_token)
 
     def test_communicationtokencredential_throws_if_invalid_token(self):
-        self.assertRaises(ValueError, lambda: CommunicationTokenCredential("foo.bar.tar"))
+        refresh_options = CommunicationTokenRefreshOptions("foo.bar.tar")
+        self.assertRaises(ValueError, lambda: CommunicationTokenCredential(refresh_options))
 
     def test_communicationtokencredential_throws_if_nonstring_token(self):
-        self.assertRaises(TypeError, lambda: CommunicationTokenCredential(454))
+        refresh_options = CommunicationTokenRefreshOptions(454):
+        self.assertRaises(TypeError, lambda: CommunicationTokenCredential(refresh_options)
 
     def test_communicationtokencredential_static_token_returns_expired_token(self):
-        credential = CommunicationTokenCredential(self.expired_token)
+        refresh_options = CommunicationTokenRefreshOptions(self.expired_token)
+        credential = CommunicationTokenCredential(refresh_options)
 
         self.assertEqual(credential.get_token().token, self.expired_token)
 
     def test_communicationtokencredential_token_expired_refresh_called(self):
         refresher = MagicMock(return_value=self.sample_token)
+        refresh_options = CommunicationTokenRefreshOptions(self.sample_token, refresher)
         access_token = CommunicationTokenCredential(
             self.expired_token,
             token_refresher=refresher).get_token()
@@ -45,9 +51,8 @@ def test_communicationtokencredential_token_expired_refresh_called(self):
 
     def test_communicationtokencredential_token_expired_refresh_called_asnecessary(self):
         refresher = MagicMock(return_value=create_access_token(self.expired_token))
-        credential = CommunicationTokenCredential(
-            self.expired_token,
-            token_refresher=refresher)
+        refresh_options = CommunicationTokenRefreshOptions(self.expired_token, refresher)
+        credential = CommunicationTokenCredential(refresh_options)
 
         credential.get_token()
         access_token = credential.get_token()

sdk/communication/azure-communication-chat/README.md

@@ -48,7 +48,8 @@ from azure.communication.chat import ChatClient, CommunicationTokenCredential
 # Your unique Azure Communication service endpoint
 endpoint = "https://<RESOURCE_NAME>.communcationservices.azure.com"
 token = "<token>"
-chat_client = ChatClient(endpoint, CommunicationTokenCredential(token))
+refresh_options = CommunicationTokenRefreshOptions(token)
+chat_client = ChatClient(endpoint, CommunicationTokenCredential(refresh_options))
 ```
 
 ## Create Chat Thread Client

sdk/communication/azure-communication-chat/azure/communication/chat/__init__.py

@@ -7,6 +7,7 @@
     ChatThreadInfo,
 )
 from ._shared.user_credential import CommunicationTokenCredential
+from ._shared.user_token_refresh_options import CommunicationTokenRefreshOptions
 from ._models import (
     ChatThreadMember,
     ChatMessage,
@@ -25,6 +26,7 @@
     'ChatThread',
     'ChatThreadInfo',
     'CommunicationTokenCredential',
+    'CommunicationTokenRefreshOptions',
     'ChatThreadMember',
     'CommunicationUserIdentifier',
 ]

sdk/communication/azure-communication-chat/azure/communication/chat/_shared/user_credential.py

@@ -9,28 +9,22 @@
     cast,
     Tuple,
 )
-import six
 
 from msrest.serialization import TZ_UTC
-from .utils import create_access_token
 
 class CommunicationTokenCredential(object):
     """Credential type used for authenticating to an Azure Communication service.
-    :param str token: The token used to authenticate to an Azure Communication service
-    :raises: TypeError
+    :param communication_token_refresh_options: The token used to authenticate to an Azure Communication service
+    :type communication_token_refresh_options: ~azure.communication.chat.CommunicationTokenRefreshOptions
     """
 
     ON_DEMAND_REFRESHING_INTERVAL_MINUTES = 2
 
     def __init__(self,
-            token, # type: str
-            token_refresher=None
+            communication_token_refresh_options
         ):
-        # type: (str) -> None
-        if not isinstance(token, six.string_types):
-            raise TypeError("token must be a string.")
-        self._token = create_access_token(token)
-        self._token_refresher = token_refresher
+        self._token = communication_token_refresh_options.get_token()
+        self._token_refresher = communication_token_refresh_options.get_token_refresher()
         self._lock = Condition(Lock())
         self._some_thread_refreshing = False
 

sdk/communication/azure-communication-chat/azure/communication/chat/_shared/user_credential_async.py

@@ -10,28 +10,22 @@
     Tuple,
 )
 
-import six
-
 from msrest.serialization import TZ_UTC
-from .utils import create_access_token
 
 class CommunicationTokenCredential(object):
     """Credential type used for authenticating to an Azure Communication service.
-    :param str token: The token used to authenticate to an Azure Communication service
+    :param communication_token_refresh_options: The token used to authenticate to an Azure Communication service
+    :type communication_token_refresh_options: ~azure.communication.chat.aio.CommunicationTokenRefreshOptions
     :raises: TypeError
     """
 
     ON_DEMAND_REFRESHING_INTERVAL_MINUTES = 2
 
     def __init__(self,
-            token, # type: str
-            token_refresher=None
+            communication_token_refresh_options
         ):
-        # type: (str) -> None
-        if not isinstance(token, six.string_types):
-            raise TypeError("token must be a string.")
-        self._token = create_access_token(token)
-        self._token_refresher = token_refresher
+        self._token = communication_token_refresh_options.get_token()
+        self._token_refresher = communication_token_refresh_options.get_token_refresher()
         self._lock = Condition(Lock())
         self._some_thread_refreshing = False
 

sdk/communication/azure-communication-chat/azure/communication/chat/_shared/user_token_refresh_options.py

@@ -0,0 +1,36 @@
+# -------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for
+# license information.
+# --------------------------------------------------------------------------
+from typing import ( # pylint: disable=unused-import
+    cast,
+    Tuple,
+)
+import six
+from .utils import create_access_token
+
+class CommunicationTokenRefreshOptions(object):
+    """Options for refreshing CommunicationTokenCredential.
+    :param str token: The token used to authenticate to an Azure Communication service
+    :param token_refresher: The token refresher to provide capacity to fetch fresh token
+    :raises: TypeError
+    """
+
+    def __init__(self,
+        token, # type: str
+        token_refresher=None
+    ):
+        # type: (str) -> None
+        if not isinstance(token, six.string_types):
+            raise TypeError("token must be a string.")
+        self._token = token
+        self._token_refresher = token_refresher
+
+    def get_token(self):
+        """Return the the serialized JWT token."""
+        return create_access_token(self._token)
+
+    def get_token_refresher(self):
+        """Return the token refresher to provide capacity to fetch fresh token."""
+        return self._token_refresher

sdk/communication/azure-communication-chat/azure/communication/chat/aio/__init__.py

@@ -5,9 +5,11 @@
 from ._chat_client_async import ChatClient
 from ._chat_thread_client_async import ChatThreadClient
 from .._shared.user_credential_async import CommunicationTokenCredential
+from .._shared.user_token_refresh_options import CommunicationTokenRefreshOptions
 
 __all__ = [
     "ChatClient",
     "ChatThreadClient",
-    "CommunicationTokenCredential"
+    "CommunicationTokenCredential",
+    "CommunicationTokenRefreshOptions"
 ]