durabletask 0.0.0.dev37__tar.gz → 0.0.0.dev39__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- {durabletask-0.0.0.dev37 → durabletask-0.0.0.dev39}/PKG-INFO +1 -1
- {durabletask-0.0.0.dev37 → durabletask-0.0.0.dev39}/durabletask/client.py +137 -12
- {durabletask-0.0.0.dev37 → durabletask-0.0.0.dev39}/durabletask/entities/__init__.py +3 -1
- durabletask-0.0.0.dev39/durabletask/entities/entity_instance_id.py +84 -0
- {durabletask-0.0.0.dev37 → durabletask-0.0.0.dev39}/durabletask/entities/entity_metadata.py +11 -5
- durabletask-0.0.0.dev39/durabletask/entities/entity_operation_failed_exception.py +15 -0
- {durabletask-0.0.0.dev37 → durabletask-0.0.0.dev39}/durabletask/internal/helpers.py +7 -0
- durabletask-0.0.0.dev39/durabletask/internal/json_encode_output_exception.py +12 -0
- {durabletask-0.0.0.dev37 → durabletask-0.0.0.dev39}/durabletask/worker.py +41 -19
- {durabletask-0.0.0.dev37 → durabletask-0.0.0.dev39}/durabletask.egg-info/PKG-INFO +1 -1
- {durabletask-0.0.0.dev37 → durabletask-0.0.0.dev39}/durabletask.egg-info/SOURCES.txt +2 -0
- {durabletask-0.0.0.dev37 → durabletask-0.0.0.dev39}/pyproject.toml +1 -1
- durabletask-0.0.0.dev37/durabletask/entities/entity_instance_id.py +0 -42
- {durabletask-0.0.0.dev37 → durabletask-0.0.0.dev39}/LICENSE +0 -0
- {durabletask-0.0.0.dev37 → durabletask-0.0.0.dev39}/README.md +0 -0
- {durabletask-0.0.0.dev37 → durabletask-0.0.0.dev39}/durabletask/__init__.py +0 -0
- {durabletask-0.0.0.dev37 → durabletask-0.0.0.dev39}/durabletask/entities/durable_entity.py +0 -0
- {durabletask-0.0.0.dev37 → durabletask-0.0.0.dev39}/durabletask/entities/entity_context.py +0 -0
- {durabletask-0.0.0.dev37 → durabletask-0.0.0.dev39}/durabletask/entities/entity_lock.py +0 -0
- {durabletask-0.0.0.dev37 → durabletask-0.0.0.dev39}/durabletask/internal/entity_state_shim.py +0 -0
- {durabletask-0.0.0.dev37 → durabletask-0.0.0.dev39}/durabletask/internal/exceptions.py +0 -0
- {durabletask-0.0.0.dev37 → durabletask-0.0.0.dev39}/durabletask/internal/grpc_interceptor.py +0 -0
- {durabletask-0.0.0.dev37 → durabletask-0.0.0.dev39}/durabletask/internal/orchestration_entity_context.py +0 -0
- {durabletask-0.0.0.dev37 → durabletask-0.0.0.dev39}/durabletask/internal/orchestrator_service_pb2.py +0 -0
- {durabletask-0.0.0.dev37 → durabletask-0.0.0.dev39}/durabletask/internal/orchestrator_service_pb2.pyi +0 -0
- {durabletask-0.0.0.dev37 → durabletask-0.0.0.dev39}/durabletask/internal/orchestrator_service_pb2_grpc.py +0 -0
- {durabletask-0.0.0.dev37 → durabletask-0.0.0.dev39}/durabletask/internal/proto_task_hub_sidecar_service_stub.py +0 -0
- {durabletask-0.0.0.dev37 → durabletask-0.0.0.dev39}/durabletask/internal/shared.py +0 -0
- {durabletask-0.0.0.dev37 → durabletask-0.0.0.dev39}/durabletask/py.typed +0 -0
- {durabletask-0.0.0.dev37 → durabletask-0.0.0.dev39}/durabletask/task.py +0 -0
- {durabletask-0.0.0.dev37 → durabletask-0.0.0.dev39}/durabletask.egg-info/dependency_links.txt +0 -0
- {durabletask-0.0.0.dev37 → durabletask-0.0.0.dev39}/durabletask.egg-info/requires.txt +0 -0
- {durabletask-0.0.0.dev37 → durabletask-0.0.0.dev39}/durabletask.egg-info/top_level.txt +0 -0
- {durabletask-0.0.0.dev37 → durabletask-0.0.0.dev39}/setup.cfg +0 -0
|
@@ -4,12 +4,12 @@
|
|
|
4
4
|
import logging
|
|
5
5
|
import uuid
|
|
6
6
|
from dataclasses import dataclass
|
|
7
|
-
from datetime import datetime, timezone
|
|
7
|
+
from datetime import datetime, timedelta, timezone
|
|
8
8
|
from enum import Enum
|
|
9
|
-
from typing import Any, Optional, Sequence, TypeVar, Union
|
|
9
|
+
from typing import Any, List, Optional, Sequence, TypeVar, Union
|
|
10
10
|
|
|
11
11
|
import grpc
|
|
12
|
-
from google.protobuf import wrappers_pb2
|
|
12
|
+
from google.protobuf import wrappers_pb2 as pb2
|
|
13
13
|
|
|
14
14
|
from durabletask.entities import EntityInstanceId
|
|
15
15
|
from durabletask.entities.entity_metadata import EntityMetadata
|
|
@@ -57,6 +57,12 @@ class OrchestrationState:
|
|
|
57
57
|
self.failure_details)
|
|
58
58
|
|
|
59
59
|
|
|
60
|
+
class PurgeInstancesResult:
|
|
61
|
+
def __init__(self, deleted_instance_count: int, is_complete: bool):
|
|
62
|
+
self.deleted_instance_count = deleted_instance_count
|
|
63
|
+
self.is_complete = is_complete
|
|
64
|
+
|
|
65
|
+
|
|
60
66
|
class OrchestrationFailedError(Exception):
|
|
61
67
|
def __init__(self, message: str, failure_details: task.FailureDetails):
|
|
62
68
|
super().__init__(message)
|
|
@@ -73,6 +79,12 @@ def new_orchestration_state(instance_id: str, res: pb.GetInstanceResponse) -> Op
|
|
|
73
79
|
|
|
74
80
|
state = res.orchestrationState
|
|
75
81
|
|
|
82
|
+
new_state = parse_orchestration_state(state)
|
|
83
|
+
new_state.instance_id = instance_id # Override instance_id with the one from the request, to match old behavior
|
|
84
|
+
return new_state
|
|
85
|
+
|
|
86
|
+
|
|
87
|
+
def parse_orchestration_state(state: pb.OrchestrationState) -> OrchestrationState:
|
|
76
88
|
failure_details = None
|
|
77
89
|
if state.failureDetails.errorMessage != '' or state.failureDetails.errorType != '':
|
|
78
90
|
failure_details = task.FailureDetails(
|
|
@@ -81,7 +93,7 @@ def new_orchestration_state(instance_id: str, res: pb.GetInstanceResponse) -> Op
|
|
|
81
93
|
state.failureDetails.stackTrace.value if not helpers.is_empty(state.failureDetails.stackTrace) else None)
|
|
82
94
|
|
|
83
95
|
return OrchestrationState(
|
|
84
|
-
|
|
96
|
+
state.instanceId,
|
|
85
97
|
state.name,
|
|
86
98
|
OrchestrationStatus(state.orchestrationStatus),
|
|
87
99
|
state.createdTimestamp.ToDatetime(),
|
|
@@ -93,7 +105,6 @@ def new_orchestration_state(instance_id: str, res: pb.GetInstanceResponse) -> Op
|
|
|
93
105
|
|
|
94
106
|
|
|
95
107
|
class TaskHubGrpcClient:
|
|
96
|
-
|
|
97
108
|
def __init__(self, *,
|
|
98
109
|
host_address: Optional[str] = None,
|
|
99
110
|
metadata: Optional[list[tuple[str, str]]] = None,
|
|
@@ -136,7 +147,7 @@ class TaskHubGrpcClient:
|
|
|
136
147
|
req = pb.CreateInstanceRequest(
|
|
137
148
|
name=name,
|
|
138
149
|
instanceId=instance_id if instance_id else uuid.uuid4().hex,
|
|
139
|
-
input=
|
|
150
|
+
input=helpers.get_string_value(shared.to_json(input)),
|
|
140
151
|
scheduledStartTimestamp=helpers.new_timestamp(start_at) if start_at else None,
|
|
141
152
|
version=helpers.get_string_value(version if version else self.default_version),
|
|
142
153
|
orchestrationIdReusePolicy=reuse_id_policy,
|
|
@@ -152,6 +163,54 @@ class TaskHubGrpcClient:
|
|
|
152
163
|
res: pb.GetInstanceResponse = self._stub.GetInstance(req)
|
|
153
164
|
return new_orchestration_state(req.instanceId, res)
|
|
154
165
|
|
|
166
|
+
def get_all_orchestration_states(self,
|
|
167
|
+
max_instance_count: Optional[int] = None,
|
|
168
|
+
fetch_inputs_and_outputs: bool = False) -> List[OrchestrationState]:
|
|
169
|
+
return self.get_orchestration_state_by(
|
|
170
|
+
created_time_from=None,
|
|
171
|
+
created_time_to=None,
|
|
172
|
+
runtime_status=None,
|
|
173
|
+
max_instance_count=max_instance_count,
|
|
174
|
+
fetch_inputs_and_outputs=fetch_inputs_and_outputs
|
|
175
|
+
)
|
|
176
|
+
|
|
177
|
+
def get_orchestration_state_by(self,
|
|
178
|
+
created_time_from: Optional[datetime] = None,
|
|
179
|
+
created_time_to: Optional[datetime] = None,
|
|
180
|
+
runtime_status: Optional[List[OrchestrationStatus]] = None,
|
|
181
|
+
max_instance_count: Optional[int] = None,
|
|
182
|
+
fetch_inputs_and_outputs: bool = False,
|
|
183
|
+
_continuation_token: Optional[pb2.StringValue] = None
|
|
184
|
+
) -> List[OrchestrationState]:
|
|
185
|
+
if max_instance_count is None:
|
|
186
|
+
# DTS backend does not behave well with max_instance_count = None, so we set to max 32-bit signed value
|
|
187
|
+
max_instance_count = (1 << 31) - 1
|
|
188
|
+
req = pb.QueryInstancesRequest(
|
|
189
|
+
query=pb.InstanceQuery(
|
|
190
|
+
runtimeStatus=[status.value for status in runtime_status] if runtime_status else None,
|
|
191
|
+
createdTimeFrom=helpers.new_timestamp(created_time_from) if created_time_from else None,
|
|
192
|
+
createdTimeTo=helpers.new_timestamp(created_time_to) if created_time_to else None,
|
|
193
|
+
maxInstanceCount=max_instance_count,
|
|
194
|
+
fetchInputsAndOutputs=fetch_inputs_and_outputs,
|
|
195
|
+
continuationToken=_continuation_token
|
|
196
|
+
)
|
|
197
|
+
)
|
|
198
|
+
resp: pb.QueryInstancesResponse = self._stub.QueryInstances(req)
|
|
199
|
+
states = [parse_orchestration_state(res) for res in resp.orchestrationState]
|
|
200
|
+
# Check the value for continuationToken - none or "0" indicates that there are no more results.
|
|
201
|
+
if resp.continuationToken and resp.continuationToken.value and resp.continuationToken.value != "0":
|
|
202
|
+
self._logger.info(f"Received continuation token with value {resp.continuationToken.value}, fetching next list of instances...")
|
|
203
|
+
states += self.get_orchestration_state_by(
|
|
204
|
+
created_time_from,
|
|
205
|
+
created_time_to,
|
|
206
|
+
runtime_status,
|
|
207
|
+
max_instance_count,
|
|
208
|
+
fetch_inputs_and_outputs,
|
|
209
|
+
_continuation_token=resp.continuationToken
|
|
210
|
+
)
|
|
211
|
+
states = [state for state in states if state is not None] # Filter out any None values
|
|
212
|
+
return states
|
|
213
|
+
|
|
155
214
|
def wait_for_orchestration_start(self, instance_id: str, *,
|
|
156
215
|
fetch_payloads: bool = False,
|
|
157
216
|
timeout: int = 60) -> Optional[OrchestrationState]:
|
|
@@ -199,7 +258,7 @@ class TaskHubGrpcClient:
|
|
|
199
258
|
req = pb.RaiseEventRequest(
|
|
200
259
|
instanceId=instance_id,
|
|
201
260
|
name=event_name,
|
|
202
|
-
input=
|
|
261
|
+
input=helpers.get_string_value(shared.to_json(data)))
|
|
203
262
|
|
|
204
263
|
self._logger.info(f"Raising event '{event_name}' for instance '{instance_id}'.")
|
|
205
264
|
self._stub.RaiseEvent(req)
|
|
@@ -209,7 +268,7 @@ class TaskHubGrpcClient:
|
|
|
209
268
|
recursive: bool = True):
|
|
210
269
|
req = pb.TerminateRequest(
|
|
211
270
|
instanceId=instance_id,
|
|
212
|
-
output=
|
|
271
|
+
output=helpers.get_string_value(shared.to_json(output)),
|
|
213
272
|
recursive=recursive)
|
|
214
273
|
|
|
215
274
|
self._logger.info(f"Terminating instance '{instance_id}'.")
|
|
@@ -225,10 +284,27 @@ class TaskHubGrpcClient:
|
|
|
225
284
|
self._logger.info(f"Resuming instance '{instance_id}'.")
|
|
226
285
|
self._stub.ResumeInstance(req)
|
|
227
286
|
|
|
228
|
-
def purge_orchestration(self, instance_id: str, recursive: bool = True):
|
|
287
|
+
def purge_orchestration(self, instance_id: str, recursive: bool = True) -> PurgeInstancesResult:
|
|
229
288
|
req = pb.PurgeInstancesRequest(instanceId=instance_id, recursive=recursive)
|
|
230
289
|
self._logger.info(f"Purging instance '{instance_id}'.")
|
|
231
|
-
self._stub.PurgeInstances(req)
|
|
290
|
+
resp: pb.PurgeInstancesResponse = self._stub.PurgeInstances(req)
|
|
291
|
+
return PurgeInstancesResult(resp.deletedInstanceCount, resp.isComplete.value)
|
|
292
|
+
|
|
293
|
+
def purge_orchestrations_by(self,
|
|
294
|
+
created_time_from: Optional[datetime] = None,
|
|
295
|
+
created_time_to: Optional[datetime] = None,
|
|
296
|
+
runtime_status: Optional[List[OrchestrationStatus]] = None,
|
|
297
|
+
recursive: bool = False) -> PurgeInstancesResult:
|
|
298
|
+
resp: pb.PurgeInstancesResponse = self._stub.PurgeInstances(pb.PurgeInstancesRequest(
|
|
299
|
+
instanceId=None,
|
|
300
|
+
purgeInstanceFilter=pb.PurgeInstanceFilter(
|
|
301
|
+
createdTimeFrom=helpers.new_timestamp(created_time_from) if created_time_from else None,
|
|
302
|
+
createdTimeTo=helpers.new_timestamp(created_time_to) if created_time_to else None,
|
|
303
|
+
runtimeStatus=[status.value for status in runtime_status] if runtime_status else None
|
|
304
|
+
),
|
|
305
|
+
recursive=recursive
|
|
306
|
+
))
|
|
307
|
+
return PurgeInstancesResult(resp.deletedInstanceCount, resp.isComplete.value)
|
|
232
308
|
|
|
233
309
|
def signal_entity(self,
|
|
234
310
|
entity_instance_id: EntityInstanceId,
|
|
@@ -237,7 +313,7 @@ class TaskHubGrpcClient:
|
|
|
237
313
|
req = pb.SignalEntityRequest(
|
|
238
314
|
instanceId=str(entity_instance_id),
|
|
239
315
|
name=operation_name,
|
|
240
|
-
input=
|
|
316
|
+
input=helpers.get_string_value(shared.to_json(input)),
|
|
241
317
|
requestId=str(uuid.uuid4()),
|
|
242
318
|
scheduledTime=None,
|
|
243
319
|
parentTraceContext=None,
|
|
@@ -256,4 +332,53 @@ class TaskHubGrpcClient:
|
|
|
256
332
|
if not res.exists:
|
|
257
333
|
return None
|
|
258
334
|
|
|
259
|
-
return EntityMetadata.
|
|
335
|
+
return EntityMetadata.from_entity_metadata(res.entity, include_state)
|
|
336
|
+
|
|
337
|
+
def get_all_entities(self,
|
|
338
|
+
include_state: bool = True,
|
|
339
|
+
include_transient: bool = False,
|
|
340
|
+
page_size: Optional[int] = None) -> List[EntityMetadata]:
|
|
341
|
+
return self.get_entities_by(
|
|
342
|
+
instance_id_starts_with=None,
|
|
343
|
+
last_modified_from=None,
|
|
344
|
+
last_modified_to=None,
|
|
345
|
+
include_state=include_state,
|
|
346
|
+
include_transient=include_transient,
|
|
347
|
+
page_size=page_size
|
|
348
|
+
)
|
|
349
|
+
|
|
350
|
+
def get_entities_by(self,
|
|
351
|
+
instance_id_starts_with: Optional[str] = None,
|
|
352
|
+
last_modified_from: Optional[datetime] = None,
|
|
353
|
+
last_modified_to: Optional[datetime] = None,
|
|
354
|
+
include_state: bool = True,
|
|
355
|
+
include_transient: bool = False,
|
|
356
|
+
page_size: Optional[int] = None,
|
|
357
|
+
_continuation_token: Optional[pb2.StringValue] = None
|
|
358
|
+
) -> List[EntityMetadata]:
|
|
359
|
+
self._logger.info(f"Getting entities")
|
|
360
|
+
query_request = pb.QueryEntitiesRequest(
|
|
361
|
+
query=pb.EntityQuery(
|
|
362
|
+
instanceIdStartsWith=helpers.get_string_value(instance_id_starts_with),
|
|
363
|
+
lastModifiedFrom=helpers.new_timestamp(last_modified_from) if last_modified_from else None,
|
|
364
|
+
lastModifiedTo=helpers.new_timestamp(last_modified_to) if last_modified_to else None,
|
|
365
|
+
includeState=include_state,
|
|
366
|
+
includeTransient=include_transient,
|
|
367
|
+
pageSize=helpers.get_int_value(page_size),
|
|
368
|
+
continuationToken=_continuation_token
|
|
369
|
+
)
|
|
370
|
+
)
|
|
371
|
+
resp: pb.QueryEntitiesResponse = self._stub.QueryEntities(query_request)
|
|
372
|
+
entities = [EntityMetadata.from_entity_metadata(entity, query_request.query.includeState) for entity in resp.entities]
|
|
373
|
+
if resp.continuationToken and resp.continuationToken.value != "0":
|
|
374
|
+
self._logger.info(f"Received continuation token with value {resp.continuationToken.value}, fetching next page of entities...")
|
|
375
|
+
entities += self.get_entities_by(
|
|
376
|
+
instance_id_starts_with=instance_id_starts_with,
|
|
377
|
+
last_modified_from=last_modified_from,
|
|
378
|
+
last_modified_to=last_modified_to,
|
|
379
|
+
include_state=include_state,
|
|
380
|
+
include_transient=include_transient,
|
|
381
|
+
page_size=page_size,
|
|
382
|
+
_continuation_token=resp.continuationToken
|
|
383
|
+
)
|
|
384
|
+
return entities
|
|
@@ -8,7 +8,9 @@ from durabletask.entities.durable_entity import DurableEntity
|
|
|
8
8
|
from durabletask.entities.entity_lock import EntityLock
|
|
9
9
|
from durabletask.entities.entity_context import EntityContext
|
|
10
10
|
from durabletask.entities.entity_metadata import EntityMetadata
|
|
11
|
+
from durabletask.entities.entity_operation_failed_exception import EntityOperationFailedException
|
|
11
12
|
|
|
12
|
-
__all__ = ["EntityInstanceId", "DurableEntity", "EntityLock", "EntityContext", "EntityMetadata"
|
|
13
|
+
__all__ = ["EntityInstanceId", "DurableEntity", "EntityLock", "EntityContext", "EntityMetadata",
|
|
14
|
+
"EntityOperationFailedException"]
|
|
13
15
|
|
|
14
16
|
PACKAGE_NAME = "durabletask.entities"
|
|
@@ -0,0 +1,84 @@
|
|
|
1
|
+
class EntityInstanceId:
|
|
2
|
+
def __init__(self, entity: str, key: str):
|
|
3
|
+
EntityInstanceId.validate_entity_name(entity)
|
|
4
|
+
EntityInstanceId.validate_key(key)
|
|
5
|
+
self.entity = entity.lower()
|
|
6
|
+
self.key = key
|
|
7
|
+
|
|
8
|
+
def __str__(self) -> str:
|
|
9
|
+
return f"@{self.entity}@{self.key}"
|
|
10
|
+
|
|
11
|
+
def __eq__(self, other):
|
|
12
|
+
if not isinstance(other, EntityInstanceId):
|
|
13
|
+
return False
|
|
14
|
+
return self.entity == other.entity and self.key == other.key
|
|
15
|
+
|
|
16
|
+
def __lt__(self, other):
|
|
17
|
+
if not isinstance(other, EntityInstanceId):
|
|
18
|
+
return self < other
|
|
19
|
+
return str(self) < str(other)
|
|
20
|
+
|
|
21
|
+
@staticmethod
|
|
22
|
+
def parse(entity_id: str) -> "EntityInstanceId":
|
|
23
|
+
"""Parse a string representation of an entity ID into an EntityInstanceId object.
|
|
24
|
+
|
|
25
|
+
Parameters
|
|
26
|
+
----------
|
|
27
|
+
entity_id : str
|
|
28
|
+
The string representation of the entity ID, in the format '@entity@key'.
|
|
29
|
+
|
|
30
|
+
Returns
|
|
31
|
+
-------
|
|
32
|
+
EntityInstanceId
|
|
33
|
+
The parsed EntityInstanceId object.
|
|
34
|
+
|
|
35
|
+
Raises
|
|
36
|
+
------
|
|
37
|
+
ValueError
|
|
38
|
+
If the input string is not in the correct format.
|
|
39
|
+
"""
|
|
40
|
+
if not entity_id.startswith("@"):
|
|
41
|
+
raise ValueError("Entity ID must start with '@'.")
|
|
42
|
+
try:
|
|
43
|
+
_, entity, key = entity_id.split("@", 2)
|
|
44
|
+
except ValueError as ex:
|
|
45
|
+
raise ValueError(f"Invalid entity ID format: {entity_id}") from ex
|
|
46
|
+
return EntityInstanceId(entity=entity, key=key)
|
|
47
|
+
|
|
48
|
+
@staticmethod
|
|
49
|
+
def validate_entity_name(name: str) -> None:
|
|
50
|
+
"""Validate that the entity name does not contain invalid characters.
|
|
51
|
+
|
|
52
|
+
Parameters
|
|
53
|
+
----------
|
|
54
|
+
name : str
|
|
55
|
+
The entity name to validate.
|
|
56
|
+
|
|
57
|
+
Raises
|
|
58
|
+
------
|
|
59
|
+
ValueError
|
|
60
|
+
If the name is not a valid entity name.
|
|
61
|
+
"""
|
|
62
|
+
if not name:
|
|
63
|
+
raise ValueError("Entity name cannot be empty.")
|
|
64
|
+
if "@" in name:
|
|
65
|
+
raise ValueError("Entity name cannot contain '@' symbol.")
|
|
66
|
+
|
|
67
|
+
@staticmethod
|
|
68
|
+
def validate_key(key: str) -> None:
|
|
69
|
+
"""Validate that the entity key does not contain invalid characters.
|
|
70
|
+
|
|
71
|
+
Parameters
|
|
72
|
+
----------
|
|
73
|
+
key : str
|
|
74
|
+
The entity key to validate.
|
|
75
|
+
|
|
76
|
+
Raises
|
|
77
|
+
------
|
|
78
|
+
ValueError
|
|
79
|
+
If the key is not a valid entity key.
|
|
80
|
+
"""
|
|
81
|
+
if not key:
|
|
82
|
+
raise ValueError("Entity key cannot be empty.")
|
|
83
|
+
if "@" in key:
|
|
84
|
+
raise ValueError("Entity key cannot contain '@' symbol.")
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
from datetime import datetime, timezone
|
|
2
2
|
from typing import Any, Optional, Type, TypeVar, Union, overload
|
|
3
|
+
from warnings import deprecated
|
|
3
4
|
from durabletask.entities.entity_instance_id import EntityInstanceId
|
|
4
5
|
|
|
5
6
|
import durabletask.internal.orchestrator_service_pb2 as pb
|
|
@@ -42,20 +43,25 @@ class EntityMetadata:
|
|
|
42
43
|
self.includes_state = includes_state
|
|
43
44
|
self._state = state
|
|
44
45
|
|
|
46
|
+
@deprecated("This method is deprecated. Use 'from_entity_metadata' instead.")
|
|
45
47
|
@staticmethod
|
|
46
48
|
def from_entity_response(entity_response: pb.GetEntityResponse, includes_state: bool):
|
|
49
|
+
return EntityMetadata.from_entity_metadata(entity_response.entity, includes_state)
|
|
50
|
+
|
|
51
|
+
@staticmethod
|
|
52
|
+
def from_entity_metadata(entity: pb.EntityMetadata, includes_state: bool):
|
|
47
53
|
try:
|
|
48
|
-
entity_id = EntityInstanceId.parse(
|
|
54
|
+
entity_id = EntityInstanceId.parse(entity.instanceId)
|
|
49
55
|
except ValueError:
|
|
50
56
|
raise ValueError("Invalid entity instance ID in entity response.")
|
|
51
57
|
entity_state = None
|
|
52
58
|
if includes_state:
|
|
53
|
-
entity_state =
|
|
59
|
+
entity_state = entity.serializedState.value
|
|
54
60
|
return EntityMetadata(
|
|
55
61
|
id=entity_id,
|
|
56
|
-
last_modified=
|
|
57
|
-
backlog_queue_size=
|
|
58
|
-
locked_by=
|
|
62
|
+
last_modified=entity.lastModifiedTime.ToDatetime(timezone.utc),
|
|
63
|
+
backlog_queue_size=entity.backlogQueueSize,
|
|
64
|
+
locked_by=entity.lockedBy.value,
|
|
59
65
|
includes_state=includes_state,
|
|
60
66
|
state=entity_state
|
|
61
67
|
)
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
from durabletask.internal.orchestrator_service_pb2 import TaskFailureDetails
|
|
2
|
+
from durabletask.entities.entity_instance_id import EntityInstanceId
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
class EntityOperationFailedException(Exception):
|
|
6
|
+
"""Exception raised when an operation on an Entity Function fails."""
|
|
7
|
+
|
|
8
|
+
def __init__(self, entity_instance_id: EntityInstanceId, operation_name: str, failure_details: TaskFailureDetails) -> None:
|
|
9
|
+
super().__init__()
|
|
10
|
+
self.entity_instance_id = entity_instance_id
|
|
11
|
+
self.operation_name = operation_name
|
|
12
|
+
self.failure_details = failure_details
|
|
13
|
+
|
|
14
|
+
def __str__(self) -> str:
|
|
15
|
+
return f"Operation '{self.operation_name}' on entity '{self.entity_instance_id}' failed with error: {self.failure_details.errorMessage}"
|
|
@@ -184,6 +184,13 @@ def get_string_value(val: Optional[str]) -> Optional[wrappers_pb2.StringValue]:
|
|
|
184
184
|
return wrappers_pb2.StringValue(value=val)
|
|
185
185
|
|
|
186
186
|
|
|
187
|
+
def get_int_value(val: Optional[int]) -> Optional[wrappers_pb2.Int32Value]:
|
|
188
|
+
if val is None:
|
|
189
|
+
return None
|
|
190
|
+
else:
|
|
191
|
+
return wrappers_pb2.Int32Value(value=val)
|
|
192
|
+
|
|
193
|
+
|
|
187
194
|
def get_string_value_or_empty(val: Optional[str]) -> wrappers_pb2.StringValue:
|
|
188
195
|
if val is None:
|
|
189
196
|
return wrappers_pb2.StringValue(value="")
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
from typing import Any
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
class JsonEncodeOutputException(Exception):
|
|
5
|
+
"""Custom exception type used to indicate that an orchestration result could not be JSON-encoded."""
|
|
6
|
+
|
|
7
|
+
def __init__(self, problem_object: Any):
|
|
8
|
+
super().__init__()
|
|
9
|
+
self.problem_object = problem_object
|
|
10
|
+
|
|
11
|
+
def __str__(self) -> str:
|
|
12
|
+
return f"The orchestration result could not be encoded. Object details: {self.problem_object}"
|
|
@@ -19,10 +19,12 @@ from packaging.version import InvalidVersion, parse
|
|
|
19
19
|
import grpc
|
|
20
20
|
from google.protobuf import empty_pb2
|
|
21
21
|
|
|
22
|
+
from durabletask.entities.entity_operation_failed_exception import EntityOperationFailedException
|
|
22
23
|
from durabletask.internal import helpers
|
|
23
24
|
from durabletask.internal.entity_state_shim import StateShim
|
|
24
25
|
from durabletask.internal.helpers import new_timestamp
|
|
25
26
|
from durabletask.entities import DurableEntity, EntityLock, EntityInstanceId, EntityContext
|
|
27
|
+
from durabletask.internal.json_encode_output_exception import JsonEncodeOutputException
|
|
26
28
|
from durabletask.internal.orchestration_entity_context import OrchestrationEntityContext
|
|
27
29
|
from durabletask.internal.proto_task_hub_sidecar_service_stub import ProtoTaskHubSidecarServiceStub
|
|
28
30
|
import durabletask.internal.helpers as ph
|
|
@@ -141,14 +143,12 @@ class _Registry:
|
|
|
141
143
|
orchestrators: dict[str, task.Orchestrator]
|
|
142
144
|
activities: dict[str, task.Activity]
|
|
143
145
|
entities: dict[str, task.Entity]
|
|
144
|
-
entity_instances: dict[str, DurableEntity]
|
|
145
146
|
versioning: Optional[VersioningOptions] = None
|
|
146
147
|
|
|
147
148
|
def __init__(self):
|
|
148
149
|
self.orchestrators = {}
|
|
149
150
|
self.activities = {}
|
|
150
151
|
self.entities = {}
|
|
151
|
-
self.entity_instances = {}
|
|
152
152
|
|
|
153
153
|
def add_orchestrator(self, fn: task.Orchestrator[TInput, TOutput]) -> str:
|
|
154
154
|
if fn is None:
|
|
@@ -199,8 +199,8 @@ class _Registry:
|
|
|
199
199
|
return name
|
|
200
200
|
|
|
201
201
|
def add_named_entity(self, name: str, fn: task.Entity) -> None:
|
|
202
|
-
|
|
203
|
-
|
|
202
|
+
name = name.lower()
|
|
203
|
+
EntityInstanceId.validate_entity_name(name)
|
|
204
204
|
if name in self.entities:
|
|
205
205
|
raise ValueError(f"A '{name}' entity already exists.")
|
|
206
206
|
|
|
@@ -829,7 +829,7 @@ class _RuntimeOrchestrationContext(task.OrchestrationContext):
|
|
|
829
829
|
self._pending_actions: dict[int, pb.OrchestratorAction] = {}
|
|
830
830
|
self._pending_tasks: dict[int, task.CompletableTask] = {}
|
|
831
831
|
# Maps entity ID to task ID
|
|
832
|
-
self._entity_task_id_map: dict[str, tuple[EntityInstanceId, int]] = {}
|
|
832
|
+
self._entity_task_id_map: dict[str, tuple[EntityInstanceId, str, int]] = {}
|
|
833
833
|
self._entity_lock_task_id_map: dict[str, tuple[EntityInstanceId, int]] = {}
|
|
834
834
|
# Maps criticalSectionId to task ID
|
|
835
835
|
self._entity_lock_id_map: dict[str, int] = {}
|
|
@@ -902,7 +902,13 @@ class _RuntimeOrchestrationContext(task.OrchestrationContext):
|
|
|
902
902
|
self._result = result
|
|
903
903
|
result_json: Optional[str] = None
|
|
904
904
|
if result is not None:
|
|
905
|
-
|
|
905
|
+
try:
|
|
906
|
+
result_json = result if is_result_encoded else shared.to_json(result)
|
|
907
|
+
except (ValueError, TypeError):
|
|
908
|
+
self._is_complete = False
|
|
909
|
+
self._result = None
|
|
910
|
+
self.set_failed(JsonEncodeOutputException(result))
|
|
911
|
+
return
|
|
906
912
|
action = ph.new_complete_orchestration_action(
|
|
907
913
|
self.next_sequence_number(), status, result_json
|
|
908
914
|
)
|
|
@@ -1606,7 +1612,7 @@ class _OrchestrationExecutor:
|
|
|
1606
1612
|
raise TypeError("Unexpected sub-orchestration task type")
|
|
1607
1613
|
elif event.HasField("eventRaised"):
|
|
1608
1614
|
if event.eventRaised.name in ctx._entity_task_id_map:
|
|
1609
|
-
entity_id, task_id = ctx._entity_task_id_map.get(event.eventRaised.name, (None, None))
|
|
1615
|
+
entity_id, operation, task_id = ctx._entity_task_id_map.get(event.eventRaised.name, (None, None, None))
|
|
1610
1616
|
self._handle_entity_event_raised(ctx, event, entity_id, task_id, False)
|
|
1611
1617
|
elif event.eventRaised.name in ctx._entity_lock_task_id_map:
|
|
1612
1618
|
entity_id, task_id = ctx._entity_lock_task_id_map.get(event.eventRaised.name, (None, None))
|
|
@@ -1680,9 +1686,10 @@ class _OrchestrationExecutor:
|
|
|
1680
1686
|
)
|
|
1681
1687
|
try:
|
|
1682
1688
|
entity_id = EntityInstanceId.parse(event.entityOperationCalled.targetInstanceId.value)
|
|
1689
|
+
operation = event.entityOperationCalled.operation
|
|
1683
1690
|
except ValueError:
|
|
1684
1691
|
raise RuntimeError(f"Could not parse entity ID from targetInstanceId '{event.entityOperationCalled.targetInstanceId.value}'")
|
|
1685
|
-
ctx._entity_task_id_map[event.entityOperationCalled.requestId] = (entity_id, entity_call_id)
|
|
1692
|
+
ctx._entity_task_id_map[event.entityOperationCalled.requestId] = (entity_id, operation, entity_call_id)
|
|
1686
1693
|
elif event.HasField("entityOperationSignaled"):
|
|
1687
1694
|
# This history event confirms that the entity signal was successfully scheduled.
|
|
1688
1695
|
# Remove the entityOperationSignaled event from the pending action list so we don't schedule it
|
|
@@ -1743,7 +1750,7 @@ class _OrchestrationExecutor:
|
|
|
1743
1750
|
ctx.resume()
|
|
1744
1751
|
elif event.HasField("entityOperationCompleted"):
|
|
1745
1752
|
request_id = event.entityOperationCompleted.requestId
|
|
1746
|
-
entity_id, task_id = ctx._entity_task_id_map.pop(request_id, (None, None))
|
|
1753
|
+
entity_id, operation, task_id = ctx._entity_task_id_map.pop(request_id, (None, None, None))
|
|
1747
1754
|
if not entity_id:
|
|
1748
1755
|
raise RuntimeError(f"Could not parse entity ID from request ID '{request_id}'")
|
|
1749
1756
|
if not task_id:
|
|
@@ -1762,10 +1769,29 @@ class _OrchestrationExecutor:
|
|
|
1762
1769
|
entity_task.complete(result)
|
|
1763
1770
|
ctx.resume()
|
|
1764
1771
|
elif event.HasField("entityOperationFailed"):
|
|
1765
|
-
|
|
1766
|
-
|
|
1767
|
-
|
|
1768
|
-
|
|
1772
|
+
request_id = event.entityOperationFailed.requestId
|
|
1773
|
+
entity_id, operation, task_id = ctx._entity_task_id_map.pop(request_id, (None, None, None))
|
|
1774
|
+
if not entity_id:
|
|
1775
|
+
raise RuntimeError(f"Could not parse entity ID from request ID '{request_id}'")
|
|
1776
|
+
if operation is None:
|
|
1777
|
+
raise RuntimeError(f"Could not parse operation name from request ID '{request_id}'")
|
|
1778
|
+
if not task_id:
|
|
1779
|
+
raise RuntimeError(f"Could not find matching task ID for entity operation with request ID '{request_id}'")
|
|
1780
|
+
entity_task = ctx._pending_tasks.pop(task_id, None)
|
|
1781
|
+
if not entity_task:
|
|
1782
|
+
if not ctx.is_replaying:
|
|
1783
|
+
self._logger.warning(
|
|
1784
|
+
f"{ctx.instance_id}: Ignoring unexpected entityOperationFailed event with request ID = {request_id}."
|
|
1785
|
+
)
|
|
1786
|
+
return
|
|
1787
|
+
failure = EntityOperationFailedException(
|
|
1788
|
+
entity_id,
|
|
1789
|
+
operation,
|
|
1790
|
+
event.entityOperationFailed.failureDetails
|
|
1791
|
+
)
|
|
1792
|
+
ctx._entity_context.recover_lock_after_call(entity_id)
|
|
1793
|
+
entity_task.fail(str(failure), failure)
|
|
1794
|
+
ctx.resume()
|
|
1769
1795
|
elif event.HasField("orchestratorCompleted"):
|
|
1770
1796
|
# Added in Functions only (for some reason) and does not affect orchestrator flow
|
|
1771
1797
|
pass
|
|
@@ -1777,7 +1803,7 @@ class _OrchestrationExecutor:
|
|
|
1777
1803
|
if action and action.HasField("sendEntityMessage"):
|
|
1778
1804
|
if action.sendEntityMessage.HasField("entityOperationCalled"):
|
|
1779
1805
|
entity_id, event_id = self._parse_entity_event_sent_input(event)
|
|
1780
|
-
ctx._entity_task_id_map[event_id] = (entity_id, event.eventId)
|
|
1806
|
+
ctx._entity_task_id_map[event_id] = (entity_id, action.sendEntityMessage.entityOperationCalled.operation, event.eventId)
|
|
1781
1807
|
elif action.sendEntityMessage.HasField("entityLockRequested"):
|
|
1782
1808
|
entity_id, event_id = self._parse_entity_event_sent_input(event)
|
|
1783
1809
|
ctx._entity_lock_task_id_map[event_id] = (entity_id, event.eventId)
|
|
@@ -1937,11 +1963,7 @@ class _EntityExecutor:
|
|
|
1937
1963
|
ctx = EntityContext(orchestration_id, operation, state, entity_id)
|
|
1938
1964
|
|
|
1939
1965
|
if isinstance(fn, type) and issubclass(fn, DurableEntity):
|
|
1940
|
-
|
|
1941
|
-
entity_instance = self._registry.entity_instances[str(entity_id)]
|
|
1942
|
-
else:
|
|
1943
|
-
entity_instance = fn()
|
|
1944
|
-
self._registry.entity_instances[str(entity_id)] = entity_instance
|
|
1966
|
+
entity_instance = fn()
|
|
1945
1967
|
if not hasattr(entity_instance, operation):
|
|
1946
1968
|
raise AttributeError(f"Entity '{entity_id}' does not have operation '{operation}'")
|
|
1947
1969
|
method = getattr(entity_instance, operation)
|
|
@@ -17,10 +17,12 @@ durabletask/entities/entity_context.py
|
|
|
17
17
|
durabletask/entities/entity_instance_id.py
|
|
18
18
|
durabletask/entities/entity_lock.py
|
|
19
19
|
durabletask/entities/entity_metadata.py
|
|
20
|
+
durabletask/entities/entity_operation_failed_exception.py
|
|
20
21
|
durabletask/internal/entity_state_shim.py
|
|
21
22
|
durabletask/internal/exceptions.py
|
|
22
23
|
durabletask/internal/grpc_interceptor.py
|
|
23
24
|
durabletask/internal/helpers.py
|
|
25
|
+
durabletask/internal/json_encode_output_exception.py
|
|
24
26
|
durabletask/internal/orchestration_entity_context.py
|
|
25
27
|
durabletask/internal/orchestrator_service_pb2.py
|
|
26
28
|
durabletask/internal/orchestrator_service_pb2.pyi
|
|
@@ -1,42 +0,0 @@
|
|
|
1
|
-
class EntityInstanceId:
|
|
2
|
-
def __init__(self, entity: str, key: str):
|
|
3
|
-
self.entity = entity
|
|
4
|
-
self.key = key
|
|
5
|
-
|
|
6
|
-
def __str__(self) -> str:
|
|
7
|
-
return f"@{self.entity}@{self.key}"
|
|
8
|
-
|
|
9
|
-
def __eq__(self, other):
|
|
10
|
-
if not isinstance(other, EntityInstanceId):
|
|
11
|
-
return False
|
|
12
|
-
return self.entity == other.entity and self.key == other.key
|
|
13
|
-
|
|
14
|
-
def __lt__(self, other):
|
|
15
|
-
if not isinstance(other, EntityInstanceId):
|
|
16
|
-
return self < other
|
|
17
|
-
return str(self) < str(other)
|
|
18
|
-
|
|
19
|
-
@staticmethod
|
|
20
|
-
def parse(entity_id: str) -> "EntityInstanceId":
|
|
21
|
-
"""Parse a string representation of an entity ID into an EntityInstanceId object.
|
|
22
|
-
|
|
23
|
-
Parameters
|
|
24
|
-
----------
|
|
25
|
-
entity_id : str
|
|
26
|
-
The string representation of the entity ID, in the format '@entity@key'.
|
|
27
|
-
|
|
28
|
-
Returns
|
|
29
|
-
-------
|
|
30
|
-
EntityInstanceId
|
|
31
|
-
The parsed EntityInstanceId object.
|
|
32
|
-
|
|
33
|
-
Raises
|
|
34
|
-
------
|
|
35
|
-
ValueError
|
|
36
|
-
If the input string is not in the correct format.
|
|
37
|
-
"""
|
|
38
|
-
try:
|
|
39
|
-
_, entity, key = entity_id.split("@", 2)
|
|
40
|
-
return EntityInstanceId(entity=entity, key=key)
|
|
41
|
-
except ValueError as ex:
|
|
42
|
-
raise ValueError(f"Invalid entity ID format: {entity_id}", ex)
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
{durabletask-0.0.0.dev37 → durabletask-0.0.0.dev39}/durabletask/internal/entity_state_shim.py
RENAMED
|
File without changes
|
|
File without changes
|
{durabletask-0.0.0.dev37 → durabletask-0.0.0.dev39}/durabletask/internal/grpc_interceptor.py
RENAMED
|
File without changes
|
|
File without changes
|
{durabletask-0.0.0.dev37 → durabletask-0.0.0.dev39}/durabletask/internal/orchestrator_service_pb2.py
RENAMED
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
{durabletask-0.0.0.dev37 → durabletask-0.0.0.dev39}/durabletask.egg-info/dependency_links.txt
RENAMED
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|