-
Notifications
You must be signed in to change notification settings - Fork 3
/
types.py
236 lines (192 loc) · 8.75 KB
/
types.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
# Copyright (c) 2012 Memoto AB
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to
# deal in the Software without restriction, including without limitation the
# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
# sell copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in all
# copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
# THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
import time
from boto.swf.exceptions import SWFTypeAlreadyExistsError
from flowser import serializing
from flowser.exceptions import Error
from flowser.exceptions import EmptyTaskPollResult
from flowser import decisions
ONE_HOUR = 60 * 60
ONE_DAY = ONE_HOUR * 24
def _raise_if_empty_poll_result(result):
"""Return result or raise ``EmptyTaskPollResult``. """
if 'taskToken' not in result:
raise EmptyTaskPollResult('empty result (no task token)')
return result
class Type(object):
"""Base class for Simple Workflow types (activities, workflows).
Subclasses must set ``name``, ``version`` and ``task_list`` properties. They
must also implement ``get_id_from_input``.
"""
# Override this in a subclass to the name (string) of a register method on
# the connection object (as returned by boto.connect_swf).
_reg_func_name = None
def __init__(self, domain):
for needed_prop in ['name', 'task_list', 'version']:
if not hasattr(self, needed_prop):
raise Error(needed_prop)
self._domain = domain
self._conn = domain.conn
def _register(self, raise_exists=False):
assert self._reg_func_name is not None, "no reg func configured"
reg_func = getattr(self._conn, self._reg_func_name)
try:
reg_func(self._domain.name, self.name, self.version)
except SWFTypeAlreadyExistsError:
if raise_exists:
raise Error(self)
@staticmethod
def get_id_from_input(input):
"""Get id from input.
This class method is used to get unique workflow and activity ids.
A typical implementation may retrieve and id field from the input and
append it to the class's task list.
:param input: Input used when starting and scheduling
workflows and tasks.
"""
raise NotImplementedError('implement in subclass')
def _poll_for_activity_task(self, identity=None):
"""Low-level wrapper for boto's method with the same name.
This method raises an exception if no task is returned.
:raises: EmptyTaskPollResult
"""
result = self._conn.poll_for_activity_task(
self._domain.name, self.task_list, identity)
return _raise_if_empty_poll_result(result)
def _poll_for_decision_task(self, identity=None, maximum_page_size=None,
next_page_token=None, reverse_order=None):
"""Low-level wrapper for boto's method with the same name.
This method raises an exception if no task is returned.
:raises: EmptyTaskPollResult
"""
result = self._conn.poll_for_decision_task(
self._domain.name, self.task_list, identity, maximum_page_size,
next_page_token, reverse_order)
return _raise_if_empty_poll_result(result)
class Activity(Type):
"""Base class for activity types.
Subclasses must set ``name``, ``task_list`` and ``version`` properties and
implement a ``schedule`` class method.
"""
_reg_func_name = 'register_activity_type'
heartbeat_timeout = str(ONE_HOUR)
schedule_to_close_timeout = str(ONE_HOUR)
schedule_to_start_timeout = str(ONE_HOUR)
start_to_close_timeout = str(ONE_HOUR)
@classmethod
def schedule(cls, input, control=None):
"Called from subclasses' ``schedule`` class method. "
dec, attrs = decisions.skeleton("ScheduleActivityTask")
attrs['activityId'] = cls.get_id_from_input(input)
attrs['activityType'] = {
'name': cls.name,
'version': cls.version}
attrs['taskList'] = {'name': cls.task_list}
attrs['input'] = serializing.dumps(input)
attrs['heartbeatTimeout'] = cls.heartbeat_timeout
attrs['scheduleToCloseTimeout'] = cls.schedule_to_close_timeout
attrs['scheduleToStartTimeout'] = cls.schedule_to_start_timeout
attrs['startToCloseTimeout'] = cls.start_to_close_timeout
if control is not None:
attrs['control'] = serializing.dumps(control)
return dec
class Workflow(Type):
"""Base class for workflow types.
Subclasses must set ``name`` and ``task_list`` properties and implement
a ``start`` method and a ``start_child`` class method.
"""
_reg_func_name = 'register_workflow_type'
# These may be overridden in subclasses.
execution_start_to_close_timeout = '600'
task_start_to_close_timeout = '120'
child_policy = 'TERMINATE'
default_filter_tag = None
default_tag_list = None
def _get_static_start_kwargs(self):
"Get start execeution arguments that never change. "
return {
'domain': self._domain.name,
'workflow_name': self.name,
'workflow_version': self.version,
'execution_start_to_close_timeout': \
self.execution_start_to_close_timeout,
'task_start_to_close_timeout': \
self.task_start_to_close_timeout,
'child_policy': self.child_policy,
'tag_list': self.default_tag_list,
'task_list': self.task_list,
}
@classmethod
def _get_static_child_start_attrs(cls):
attrs = {}
attrs['childPolicy'] = cls.child_policy
attrs['executionStartToCloseTimeout'] = \
cls.execution_start_to_close_timeout
attrs['workflowType'] = {'name': cls.name, 'version': cls.version}
if cls.default_tag_list:
attrs['tagList'] = cls.default_tag_list
attrs['taskList'] = {'name': cls.task_list}
attrs['taskStartToCloseTimeout'] = \
cls.task_start_to_close_timeout
return attrs
def _list_open(self, latest_date=None, oldest_date=None):
if latest_date is None:
latest_date = time.time()
if oldest_date is None:
oldest_date = latest_date - ONE_DAY
return self._conn.list_open_workflow_executions(
self._domain.name,
latest_date=latest_date,
oldest_date=oldest_date,
workflow_name=self.name,
tag=self.default_filter_tag)
def _list_closed(self, start_latest_date=None, start_oldest_date=None):
if start_latest_date is None:
start_latest_date = time.time()
if start_oldest_date is None:
start_oldest_date = start_latest_date - ONE_DAY
return self._conn.list_closed_workflow_executions(
self._domain.name,
start_latest_date=start_latest_date,
start_oldest_date=start_oldest_date,
workflow_name=self.name,
tag=self.default_filter_tag)
def _start(self, input):
"""Start workflow execution.
``input`` is serialized and a workflow id is generated from it
using ``get_id_from_input``.
"""
kwargs = self._get_static_start_kwargs()
kwargs['workflow_id'] = self.get_id_from_input(input)
kwargs['input'] = serializing.dumps(input)
return self._conn.start_workflow_execution(**kwargs)
@classmethod
def start_child(cls, input, control=None):
"""Start child workflow execution.
``input`` is serialized and a workflow id is generated from it
using ``get_id_from_input``.
"""
dec, attrs = decisions.skeleton("StartChildWorkflowExecution")
attrs.update(cls._get_static_child_start_attrs())
attrs['workflowId'] = cls.get_id_from_input(input)
attrs['input'] = serializing.dumps(input)
if control is not None:
attrs['control'] = serializing.dumps(control)
return dec