-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathroutes.py
More file actions
683 lines (513 loc) · 19 KB
/
routes.py
File metadata and controls
683 lines (513 loc) · 19 KB
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
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
"""Strongly-typed route parsing system for HTTP request routing."""
from __future__ import annotations
from dataclasses import dataclass
from aws_durable_execution_sdk_python_testing.exceptions import (
UnknownRouteError,
)
@dataclass(frozen=True)
class Route:
"""Base route with segments and pattern matching capabilities."""
raw_path: str
segments: list[str]
@classmethod
def from_route(cls, _route: Route) -> Route:
"""Create a typed route from a base Route.
Note: Call is_match(route, method) first to ensure the route is valid for this type.
Args:
route: Base route to convert
Returns:
Typed route instance
Raises:
NotImplementedError: This is an abstract method that must be implemented by subclasses
"""
msg = "Subclasses must implement from_route()"
raise NotImplementedError(msg)
@classmethod
def from_string(cls, path: str) -> Route:
"""Create a Route from a string.
Args:
path: The raw path string
Returns:
Route instance with parsed segments
"""
# Remove leading/trailing slashes and split into segments
segments = [s for s in path.strip("/").split("/") if s]
return cls(raw_path=path, segments=segments)
def matches_pattern(self, pattern: list[str]) -> bool:
"""Check if route matches the given pattern.
Args:
pattern: List of pattern segments. Use '*' for wildcards.
Returns:
True if the route matches the pattern
"""
if len(self.segments) != len(pattern):
return False
for segment, pattern_part in zip(self.segments, pattern, strict=False):
if pattern_part not in ("*", segment):
return False
return True
@classmethod
def is_match(cls, _route: Route, _method: str) -> bool:
"""Check if the route and HTTP method match this route type.
Args:
_route: Route to check
_method: HTTP method to check
Returns:
True if the route and method match
Raises:
NotImplementedError: This is an abstract method that must be implemented by subclasses
"""
msg = "Subclasses must implement is_match()"
raise NotImplementedError(msg)
@dataclass(frozen=True)
class StartExecutionRoute(Route):
"""Route: POST /start-durable-execution"""
@classmethod
def is_match(cls, route: Route, method: str) -> bool:
"""Check if the route and HTTP method match this route type.
Args:
route: Route to check
method: HTTP method to check
Returns:
True if the route and method match
"""
return route.raw_path == "/start-durable-execution" and method == "POST"
@classmethod
def from_route(cls, route: Route) -> StartExecutionRoute:
"""Create a StartExecutionRoute from a base Route.
Note: Call is_match(route, method) first to ensure the route is valid for this type.
Args:
route: Base route to convert
Returns:
StartExecutionRoute instance
"""
return cls(raw_path=route.raw_path, segments=route.segments)
@dataclass(frozen=True)
class GetDurableExecutionRoute(Route):
"""Route: GET /2025-12-01/durable-executions/{arn}"""
arn: str
@classmethod
def is_match(cls, route: Route, method: str) -> bool:
"""Check if the route and HTTP method match this route type.
Args:
route: Route to check
method: HTTP method to check
Returns:
True if the route and method match
"""
return (
route.matches_pattern(["2025-12-01", "durable-executions", "*"])
and method == "GET"
)
@classmethod
def from_route(cls, route: Route) -> GetDurableExecutionRoute:
"""Create a GetDurableExecutionRoute from a base Route.
Note: Call is_match(route, method) first to ensure the route is valid for this type.
Args:
route: Base route to convert
Returns:
GetDurableExecutionRoute instance with extracted ARN
"""
return cls(
raw_path=route.raw_path,
segments=route.segments,
arn=route.segments[2],
)
@dataclass(frozen=True)
class CheckpointDurableExecutionRoute(Route):
"""Route: POST /2025-12-01/durable-executions/{arn}/checkpoint"""
arn: str
@classmethod
def is_match(cls, route: Route, method: str) -> bool:
"""Check if the route and HTTP method match this route type.
Args:
route: Route to check
method: HTTP method to check
Returns:
True if the route and method match
"""
return (
route.matches_pattern(
["2025-12-01", "durable-executions", "*", "checkpoint"]
)
and method == "POST"
)
@classmethod
def from_route(cls, route: Route) -> CheckpointDurableExecutionRoute:
"""Create a CheckpointDurableExecutionRoute from a base Route.
Note: Call is_match(route, method) first to ensure the route is valid for this type.
Args:
route: Base route to convert
Returns:
CheckpointDurableExecutionRoute instance with extracted ARN
"""
return cls(
raw_path=route.raw_path,
segments=route.segments,
arn=route.segments[2],
)
@dataclass(frozen=True)
class StopDurableExecutionRoute(Route):
"""Route: POST /2025-12-01/durable-executions/{arn}/stop"""
arn: str
@classmethod
def is_match(cls, route: Route, method: str) -> bool:
"""Check if the route and HTTP method match this route type.
Args:
route: Route to check
method: HTTP method to check
Returns:
True if the route and method match
"""
return (
route.matches_pattern(["2025-12-01", "durable-executions", "*", "stop"])
and method == "POST"
)
@classmethod
def from_route(cls, route: Route) -> StopDurableExecutionRoute:
"""Create a StopDurableExecutionRoute from a base Route.
Note: Call is_match(route, method) first to ensure the route is valid for this type.
Args:
route: Base route to convert
Returns:
StopDurableExecutionRoute instance with extracted ARN
"""
return cls(
raw_path=route.raw_path,
segments=route.segments,
arn=route.segments[2],
)
@dataclass(frozen=True)
class GetDurableExecutionStateRoute(Route):
"""Route: GET /2025-12-01/durable-executions/{arn}/state"""
arn: str
@classmethod
def is_match(cls, route: Route, method: str) -> bool:
"""Check if the route and HTTP method match this route type.
Args:
route: Route to check
method: HTTP method to check
Returns:
True if the route and method match
"""
return (
route.matches_pattern(["2025-12-01", "durable-executions", "*", "state"])
and method == "GET"
)
@classmethod
def from_route(cls, route: Route) -> GetDurableExecutionStateRoute:
"""Create a GetDurableExecutionStateRoute from a base Route.
Note: Call is_match(route, method) first to ensure the route is valid for this type.
Args:
route: Base route to convert
Returns:
GetDurableExecutionStateRoute instance with extracted ARN
"""
return cls(
raw_path=route.raw_path,
segments=route.segments,
arn=route.segments[2],
)
@dataclass(frozen=True)
class GetDurableExecutionHistoryRoute(Route):
"""Route: GET /2025-12-01/durable-executions/{arn}/history"""
arn: str
@classmethod
def is_match(cls, route: Route, method: str) -> bool:
"""Check if the route and HTTP method match this route type.
Args:
route: Route to check
method: HTTP method to check
Returns:
True if the route and method match
"""
return (
route.matches_pattern(["2025-12-01", "durable-executions", "*", "history"])
and method == "GET"
)
@classmethod
def from_route(cls, route: Route) -> GetDurableExecutionHistoryRoute:
"""Create a GetDurableExecutionHistoryRoute from a base Route.
Note: Call is_match(route, method) first to ensure the route is valid for this type.
Args:
route: Base route to convert
Returns:
GetDurableExecutionHistoryRoute instance with extracted ARN
"""
return cls(
raw_path=route.raw_path,
segments=route.segments,
arn=route.segments[2],
)
@dataclass(frozen=True)
class ListDurableExecutionsRoute(Route):
"""Route: GET /2025-12-01/durable-executions"""
@classmethod
def is_match(cls, route: Route, method: str) -> bool:
"""Check if the route and HTTP method match this route type.
Args:
route: Route to check
method: HTTP method to check
Returns:
True if the route and method match
"""
return (
route.matches_pattern(["2025-12-01", "durable-executions"])
and method == "GET"
)
@classmethod
def from_route(cls, route: Route) -> ListDurableExecutionsRoute:
"""Create a ListDurableExecutionsRoute from a base Route.
Note: Call is_match(route, method) first to ensure the route is valid for this type.
Args:
route: Base route to convert
Returns:
ListDurableExecutionsRoute instance
"""
return cls(raw_path=route.raw_path, segments=route.segments)
@dataclass(frozen=True)
class ListDurableExecutionsByFunctionRoute(Route):
"""Route: GET /2025-12-01/functions/{function_name}/durable-executions"""
function_name: str
@classmethod
def is_match(cls, route: Route, method: str) -> bool:
"""Check if the route and HTTP method match this route type.
Args:
route: Route to check
method: HTTP method to check
Returns:
True if the route and method match
"""
return (
route.matches_pattern(
["2025-12-01", "functions", "*", "durable-executions"]
)
and method == "GET"
)
@classmethod
def from_route(cls, route: Route) -> ListDurableExecutionsByFunctionRoute:
"""Create a ListDurableExecutionsByFunctionRoute from a base Route.
Note: Call is_match(route, method) first to ensure the route is valid for this type.
Args:
route: Base route to convert
Returns:
ListDurableExecutionsByFunctionRoute instance with extracted function name
"""
return cls(
raw_path=route.raw_path,
segments=route.segments,
function_name=route.segments[2],
)
@dataclass(frozen=True)
class BytesPayloadRoute(Route):
"""Base class for routes that handle raw bytes payloads instead of JSON."""
@dataclass(frozen=True)
class CallbackSuccessRoute(BytesPayloadRoute):
"""Route: POST /2025-12-01/durable-execution-callbacks/{callback_id}/succeed"""
callback_id: str
@classmethod
def is_match(cls, route: Route, method: str) -> bool:
"""Check if the route and HTTP method match this route type.
Args:
route: Route to check
method: HTTP method to check
Returns:
True if the route and method match
"""
return (
route.matches_pattern(
["2025-12-01", "durable-execution-callbacks", "*", "succeed"]
)
and method == "POST"
)
@classmethod
def from_route(cls, route: Route) -> CallbackSuccessRoute:
"""Create a CallbackSuccessRoute from a base Route.
Note: Call is_match(route, method) first to ensure the route is valid for this type.
Args:
route: Base route to convert
Returns:
CallbackSuccessRoute instance with extracted callback ID
"""
return cls(
raw_path=route.raw_path,
segments=route.segments,
callback_id=route.segments[2],
)
@dataclass(frozen=True)
class CallbackFailureRoute(BytesPayloadRoute):
"""Route: POST /2025-12-01/durable-execution-callbacks/{callback_id}/fail"""
callback_id: str
@classmethod
def is_match(cls, route: Route, method: str) -> bool:
"""Check if the route and HTTP method match this route type.
Args:
route: Route to check
method: HTTP method to check
Returns:
True if the route and method match
"""
return (
route.matches_pattern(
["2025-12-01", "durable-execution-callbacks", "*", "fail"]
)
and method == "POST"
)
@classmethod
def from_route(cls, route: Route) -> CallbackFailureRoute:
"""Create a CallbackFailureRoute from a base Route.
Note: Call is_match(route, method) first to ensure the route is valid for this type.
Args:
route: Base route to convert
Returns:
CallbackFailureRoute instance with extracted callback ID
"""
return cls(
raw_path=route.raw_path,
segments=route.segments,
callback_id=route.segments[2],
)
@dataclass(frozen=True)
class CallbackHeartbeatRoute(Route):
"""Route: POST /2025-12-01/durable-execution-callbacks/{callback_id}/heartbeat"""
callback_id: str
@classmethod
def is_match(cls, route: Route, method: str) -> bool:
"""Check if the route and HTTP method match this route type.
Args:
route: Route to check
method: HTTP method to check
Returns:
True if the route and method match
"""
return (
route.matches_pattern(
["2025-12-01", "durable-execution-callbacks", "*", "heartbeat"]
)
and method == "POST"
)
@classmethod
def from_route(cls, route: Route) -> CallbackHeartbeatRoute:
"""Create a CallbackHeartbeatRoute from a base Route.
Note: Call is_match(route, method) first to ensure the route is valid for this type.
Args:
route: Base route to convert
Returns:
CallbackHeartbeatRoute instance with extracted callback ID
"""
return cls(
raw_path=route.raw_path,
segments=route.segments,
callback_id=route.segments[2],
)
@dataclass(frozen=True)
class HealthRoute(Route):
"""Route: GET /health"""
@classmethod
def is_match(cls, route: Route, method: str) -> bool:
"""Check if the route and HTTP method match this route type.
Args:
route: Route to check
method: HTTP method to check
Returns:
True if the route and method match
"""
return route.raw_path == "/health" and method == "GET"
@classmethod
def from_route(cls, route: Route) -> HealthRoute:
"""Create a HealthRoute from a base Route.
Note: Call is_match(route, method) first to ensure the route is valid for this type.
Args:
route: Base route to convert
Returns:
HealthRoute instance
"""
return cls(raw_path=route.raw_path, segments=route.segments)
@dataclass(frozen=True)
class UpdateLambdaEndpointRoute(Route):
"""Route: PUT /lambda-endpoint"""
@classmethod
def is_match(cls, route: Route, method: str) -> bool:
"""Check if the route and HTTP method match this route type.
Args:
route: Route to check
method: HTTP method to check
Returns:
True if the route and method match
"""
return route.raw_path == "/lambda-endpoint" and method == "PUT"
@classmethod
def from_route(cls, route: Route) -> UpdateLambdaEndpointRoute:
"""Create UpdateLambdaEndpointRoute from base route.
Args:
route: Base route to convert
Returns:
UpdateLambdaEndpointRoute instance
"""
return cls(raw_path=route.raw_path, segments=route.segments)
@dataclass(frozen=True)
class MetricsRoute(Route):
"""Route: GET /metrics"""
@classmethod
def is_match(cls, route: Route, method: str) -> bool:
"""Check if the route and HTTP method match this route type.
Args:
route: Route to check
method: HTTP method to check
Returns:
True if the route and method match
"""
return route.raw_path == "/metrics" and method == "GET"
@classmethod
def from_route(cls, route: Route) -> MetricsRoute:
"""Create a MetricsRoute from a base Route.
Note: Call is_match(route, method) first to ensure the route is valid for this type.
Args:
route: Base route to convert
Returns:
MetricsRoute instance
"""
return cls(raw_path=route.raw_path, segments=route.segments)
# Default registry of all route types for matching
DEFAULT_ROUTE_TYPES: list[type[Route]] = [
StartExecutionRoute,
GetDurableExecutionRoute,
CheckpointDurableExecutionRoute,
StopDurableExecutionRoute,
GetDurableExecutionStateRoute,
GetDurableExecutionHistoryRoute,
ListDurableExecutionsRoute,
ListDurableExecutionsByFunctionRoute,
CallbackSuccessRoute,
CallbackFailureRoute,
CallbackHeartbeatRoute,
HealthRoute,
UpdateLambdaEndpointRoute,
MetricsRoute,
]
class Router:
"""HTTP request router that matches routes to strongly-typed route objects."""
def __init__(self, route_types: list[type[Route]] | None = None) -> None:
"""Initialize the router with route types.
Args:
route_types: List of route type classes to use for matching.
If None, uses the default route types.
"""
self._route_types = (
route_types if route_types is not None else DEFAULT_ROUTE_TYPES
)
def find_route(self, path: str, method: str) -> Route:
"""Find a matching route for the given path and HTTP method.
Args:
path: The raw path string to parse
method: The HTTP method (GET, POST, etc.)
Returns:
Strongly-typed Route instance
Raises:
UnknownRouteError: If the path and method don't match any known pattern
"""
base_route = Route.from_string(path)
for route_type in self._route_types:
if route_type.is_match(base_route, method):
return route_type.from_route(base_route)
raise UnknownRouteError(method, path)