Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
32 commits
Select commit Hold shift + click to select a range
026c572
Creation of DTS example and passing of completionToken
RyanLettieri Jan 22, 2025
136a3d0
Adressing review feedback
RyanLettieri Jan 22, 2025
6df1064
Reverting dapr readme
RyanLettieri Jan 22, 2025
f731c0d
Adding accessTokenManager class for refreshing credential token
RyanLettieri Jan 24, 2025
eb98416
Adding comments to the example
RyanLettieri Jan 24, 2025
0de338d
Adding in requirement for azure-identity
RyanLettieri Jan 24, 2025
6050771
Moving dts logic into its own module
RyanLettieri Jan 28, 2025
f4f98ee
Fixing whitesapce
RyanLettieri Jan 28, 2025
ea837d0
Updating dts client to refresh token
RyanLettieri Jan 29, 2025
f8d79d3
Cleaning up construction of dts objects and improving examples
RyanLettieri Jan 29, 2025
1e67651
Migrating shared access token logic to new grpc class
RyanLettieri Feb 4, 2025
6b1bfd2
Adding log statements to access_token_manager
RyanLettieri Feb 5, 2025
bd56a35
breaking for loop when setting interceptors
RyanLettieri Feb 5, 2025
efc0146
Removing changes to client.py and adding additional steps to readme.md
RyanLettieri Feb 7, 2025
3fd0b08
Refactoring client and worker to pass around interceptors
RyanLettieri Feb 11, 2025
4260d02
Fixing import for DefaultClientInterceptorImpl
RyanLettieri Feb 11, 2025
ec4617c
Adressing round 1 of feedback
RyanLettieri Feb 11, 2025
ed733ea
Fixing interceptor issue
RyanLettieri Feb 12, 2025
99f62d7
Moving some files around to remove dependencies
RyanLettieri Feb 12, 2025
f9d55ab
Adressing more feedback
RyanLettieri Feb 12, 2025
ba1ac4f
More review feedback
RyanLettieri Feb 12, 2025
2c251ea
Passing token credential as an argument rather than 2 strings
RyanLettieri Feb 13, 2025
9c65176
More review feedback for token passing
RyanLettieri Feb 13, 2025
877dabb
Addressing None comment and using correct metadata
RyanLettieri Feb 13, 2025
b39ffad
Updating unit tests
RyanLettieri Feb 13, 2025
33c8b11
Fixing the type for the unit test
RyanLettieri Feb 13, 2025
1da819e
Fixing grpc calls
RyanLettieri Feb 13, 2025
f690264
Merge branch 'main' into durabletask-scheduler
RyanLettieri Feb 13, 2025
6142220
Fix linter errors and update documentation
cgillum Feb 14, 2025
58f4f93
Specifying version reqiuirement for pyproject.toml
RyanLettieri Feb 18, 2025
d82c1b7
Updating README
RyanLettieri Feb 18, 2025
b3a099e
Adding comment for credential type
RyanLettieri Feb 18, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 3 additions & 11 deletions durabletask-azuremanaged/durabletask/azuremanaged/client.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
from durabletask.client import TaskHubGrpcClient, OrchestrationStatus
from durabletask.azuremanaged.internal.access_token_manager import AccessTokenManager
from durabletask.azuremanaged.durabletask_grpc_interceptor import DTSDefaultClientInterceptorImpl
from azure.identity import DefaultAzureCredential
from azure.core.credentials import TokenCredential

# Client class used for Durable Task Scheduler (DTS)
class DurableTaskSchedulerClient(TaskHubGrpcClient):
Expand All @@ -14,8 +14,7 @@ def __init__(self, *,
taskhub: str,
secure_channel: Optional[bool] = True,
metadata: Optional[list[tuple[str, str]]] = None,
use_managed_identity: Optional[bool] = False,
client_id: Optional[str] = None):
token_credential: Optional[TokenCredential] = None):

if taskhub == None:
raise ValueError("Taskhub value cannot be empty. Please provide a value for your taskhub")
Expand All @@ -27,14 +26,7 @@ def __init__(self, *,
# Append DurableTask-specific metadata
self._metadata.append(("taskhub", taskhub))
self._metadata.append(("dts", "True"))
self._metadata.append(("use_managed_identity", str(use_managed_identity)))
self._metadata.append(("client_id", str(client_id or "None")))

self._access_token_manager = AccessTokenManager(use_managed_identity=use_managed_identity,
client_id=client_id)
token = self._access_token_manager.get_access_token()
self._metadata.append(("authorization", token))

self._metadata.append(("token_credential", token_credential))
self._interceptors = [DTSDefaultClientInterceptorImpl(self._metadata)]

# We pass in None for the metadata so we don't construct an additional interceptor in the parent class
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,20 +13,18 @@ class DTSDefaultClientInterceptorImpl (DefaultClientInterceptorImpl):

def __init__(self, metadata: list[tuple[str, str]]):
super().__init__(metadata)

use_managed_identity = False
client_id = None

self._token_credential = None

# Check what authentication we are using
if metadata:
for key, value in metadata:
if key.lower() == "use_managed_identity":
self.use_managed_identity = value.strip().lower() == "true" # Convert to boolean
elif key.lower() == "client_id":
self.client_id = value
if key.lower() == "token_credential":
self._token_credential = value

self._token_manager = AccessTokenManager(use_managed_identity=use_managed_identity,
client_id=client_id)
self._token_manager = AccessTokenManager(token_credential=self._token_credential)
token = self._token_manager.get_access_token()
self._metadata.append(("authorization", token))

def _intercept_call(
self, client_call_details: _ClientCallDetails) -> grpc.ClientCallDetails:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,47 +4,43 @@
from datetime import datetime, timedelta, timezone
from typing import Optional
import durabletask.internal.shared as shared
from azure.core.credentials import TokenCredential

# By default, when there's 10minutes left before the token expires, refresh the token
class AccessTokenManager:
def __init__(self, refresh_interval_seconds: int = 600, use_managed_identity: bool = False, client_id: str = None):
self.scope = "https://durabletask.io/.default"
self.refresh_interval_seconds = refresh_interval_seconds
self._use_managed_identity = use_managed_identity
self._client_id = client_id
def __init__(self, refresh_interval_seconds: int = 600, token_credential: TokenCredential = None):
self._scope = "https://durabletask.io/.default"
self._refresh_interval_seconds = refresh_interval_seconds
self._logger = shared.get_logger("token_manager")

# Choose the appropriate credential based on use_managed_identity
if self._use_managed_identity:
if not self._client_id:
self._logger.debug("Using System Assigned Managed Identity for authentication.")
self.credential = ManagedIdentityCredential()
else:
self._logger.debug("Using User Assigned Managed Identity for authentication.")
self.credential = ManagedIdentityCredential(client_id=self._client_id)
# Choose the appropriate credential.
# Both TokenCredential and DefaultAzureCredential get_token methods return an AccessToken
if token_credential:
self._logger.debug("Using user provided token credentials.")
self._credential = token_credential
else:
self.credential = DefaultAzureCredential()
self._credential = DefaultAzureCredential()
self._logger.debug("Using Default Azure Credentials for authentication.")

self.token = None
self._token = self._credential.get_token(self._scope)
self.expiry_time = None

def get_access_token(self) -> str:
if self.token is None or self.is_token_expired():
if self._token is None or self.is_token_expired():
self.refresh_token()
return self.token
return self._token

# Checks if the token is expired, or if it will expire in the next "refresh_interval_seconds" seconds.
# For example, if the token is created to have a lifespan of 2 hours, and the refresh buffer is set to 30 minutes,
# We will grab a new token when there're 30minutes left on the lifespan of the token
def is_token_expired(self) -> bool:
if self.expiry_time is None:
return True
return datetime.now(timezone.utc) >= (self.expiry_time - timedelta(seconds=self.refresh_interval_seconds))
return datetime.now(timezone.utc) >= (self.expiry_time - timedelta(seconds=self._refresh_interval_seconds))

def refresh_token(self):
new_token = self.credential.get_token(self.scope)
self.token = f"Bearer {new_token.token}"
new_token = self._credential.get_token(self._scope)
self._token = f"Bearer {new_token.token}"

# Convert UNIX timestamp to timezone-aware datetime
self.expiry_time = datetime.fromtimestamp(new_token.expires_on, tz=timezone.utc)
Expand Down
16 changes: 5 additions & 11 deletions durabletask-azuremanaged/durabletask/azuremanaged/worker.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,16 @@
from durabletask.worker import TaskHubGrpcWorker
from durabletask.azuremanaged.internal.access_token_manager import AccessTokenManager
from durabletask.azuremanaged.durabletask_grpc_interceptor import DTSDefaultClientInterceptorImpl
from azure.core.credentials import TokenCredential

# Worker class used for Durable Task Scheduler (DTS)
class DurableTaskSchedulerWorker(TaskHubGrpcWorker):
def __init__(self, *,
host_address: str,
taskhub: str,
secure_channel: bool,
secure_channel: Optional[bool] = True,
metadata: Optional[list[tuple[str, str]]] = None,
use_managed_identity: Optional[bool] = False,
client_id: Optional[str] = None):
token_credential: Optional[TokenCredential] = None):

if taskhub == None:
raise ValueError("Taskhub value cannot be empty. Please provide a value for your taskhub")
Expand All @@ -24,15 +24,9 @@ def __init__(self, *,
self._metadata = metadata.copy() # Copy to prevent modifying input

# Append DurableTask-specific metadata
self._metadata.append(("taskhub", taskhub or "default-taskhub"))
self._metadata.append(("taskhub", taskhub))
self._metadata.append(("dts", "True"))
self._metadata.append(("use_managed_identity", str(use_managed_identity)))
self._metadata.append(("client_id", str(client_id or "None")))

self._access_token_manager = AccessTokenManager(use_managed_identity=use_managed_identity,
client_id=client_id)
token = self._access_token_manager.get_access_token()
self._metadata.append(("authorization", token))
self._metadata.append(("token_credential", token_credential))
interceptors = [DTSDefaultClientInterceptorImpl(self._metadata)]

# We pass in None for the metadata so we don't construct an additional interceptor in the parent class
Expand Down
2 changes: 1 addition & 1 deletion examples/dts/dts_activity_sequence.py
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ def sequence(ctx: task.OrchestrationContext, _):


# configure and start the worker
with DurableTaskSchedulerWorker(host_address=endpoint, secure_channel=True, use_managed_identity=False, client_id="", taskhub=taskhub_name) as w:
with DurableTaskSchedulerWorker(host_address=endpoint, secure_channel=True, taskhub=taskhub_name) as w:
w.add_orchestrator(sequence)
w.add_activity(hello)
w.start()
Expand Down
Loading