-
Notifications
You must be signed in to change notification settings - Fork 4
Expand file tree
/
Copy pathrepository.py
More file actions
441 lines (381 loc) · 15.2 KB
/
repository.py
File metadata and controls
441 lines (381 loc) · 15.2 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
import sys
from typing import Iterator, List, Optional, Type
from botocore.exceptions import ClientError
from pydantic import ValidationError
from nrlf.core.boto import get_dynamodb_resource, get_dynamodb_table
from nrlf.core.codes import SpineErrorConcept
from nrlf.core.constants import SYSTEM_SHORT_IDS, TYPE_CATEGORIES
from nrlf.core.dynamodb.model import DocumentPointer, DynamoDBModel # noqa: F401
from nrlf.core.errors import OperationOutcomeError
from nrlf.core.logger import LogReference, logger
def _get_sk_ids_for_type(pointer_type: str) -> tuple:
if pointer_type not in TYPE_CATEGORIES:
raise ValueError(f"Cannot find category for pointer type: {pointer_type}")
category = TYPE_CATEGORIES[pointer_type]
category_system, category_code = category.split("|")
if category_system not in SYSTEM_SHORT_IDS:
raise ValueError(f"Unknown system for category: {category_system}")
category_id = SYSTEM_SHORT_IDS[category_system] + "-" + category_code
type_system, type_code = pointer_type.split("|")
if type_system not in SYSTEM_SHORT_IDS:
raise ValueError(f"Unknown system for type: {type_system}")
type_id = SYSTEM_SHORT_IDS[type_system] + "-" + type_code
return category_id, type_id
class Repository[T: DynamoDBModel]:
ITEM_TYPE: Type[T]
def __init__(self, table_name: str):
self.dynamodb = get_dynamodb_resource()
self.table_name = table_name
self.table = get_dynamodb_table(self.table_name)
logger.log(
LogReference.REPOSITORY001,
table_name=self.table_name,
item_type=self.ITEM_TYPE.__name__,
)
class DocumentPointerRepository(Repository[DocumentPointer]):
ITEM_TYPE = DocumentPointer
def create(self, item: DocumentPointer) -> DocumentPointer:
"""
Create a DocumentPointer resource
"""
logger.log(
LogReference.REPOSITORY002,
indexes=item.indexes,
type=item.type,
source=item.source,
version=item.version,
)
try:
result = self.table.put_item(
Item=item.model_dump(),
ConditionExpression="attribute_not_exists(pk) AND attribute_not_exists(sk)",
ReturnConsumedCapacity="INDEXES",
)
logger.log(LogReference.REPOSITORY003, result=result)
except ClientError as exc:
if (
exc.response.get("Error", {}).get("Code")
== "ConditionalCheckFailedException"
):
logger.log(LogReference.REPOSITORY004)
raise OperationOutcomeError(
status_code="409",
severity="error",
code="conflict",
details=SpineErrorConcept.from_code("DUPLICATE_REJECTED"),
) from None
logger.log(
LogReference.REPOSITORY005,
exc_info=sys.exc_info(),
stacklevel=5,
error=str(exc),
)
raise exc
return item
def get_by_id(self, id: str) -> Optional[DocumentPointer]:
"""
Get a DocumentPointer resource by ID
"""
doc_key = f"D#{id}"
try:
result = self.table.get_item(
Key={"pk": doc_key, "sk": doc_key},
ReturnConsumedCapacity="INDEXES",
)
except ClientError as exc:
logger.log(
LogReference.REPOSITORY007,
exc_info=sys.exc_info(),
stacklevel=5,
error=str(exc),
)
raise exc
if "Item" not in result:
logger.log(LogReference.REPOSITORY012)
return None
item = result["Item"]
try:
parsed_item = self.ITEM_TYPE.model_validate({"_from_dynamo": True, **item})
logger.log(LogReference.REPOSITORY011)
logger.log(LogReference.REPOSITORY011a, result=parsed_item.model_dump())
return parsed_item
except ValidationError as exc:
logger.log(
LogReference.REPOSITORY010,
exc_info=sys.exc_info(),
stacklevel=5,
error=str(exc),
)
raise OperationOutcomeError(
status_code="500",
severity="error",
code="exception",
details=SpineErrorConcept.from_code("INTERNAL_SERVER_ERROR"),
) from exc
def count_by_nhs_number(
self,
nhs_number: str,
pointer_types: Optional[List[str]] = None,
) -> int:
"""
Count all DocumentPointer records by NHS number
"""
logger.log(
LogReference.REPOSITORY013,
nhs_number=nhs_number,
pointer_types=pointer_types,
)
key_conditions = ["patient_key = :patient_key"]
filter_expressions = []
expression_names = {}
expression_values = {":patient_key": f"P#{nhs_number}"}
if len(pointer_types) == 1:
# Optimisation for single pointer type
category_id, type_id = _get_sk_ids_for_type(pointer_types[0])
patient_sort = f"C#{category_id}#T#{type_id}"
key_conditions.append("begins_with(patient_sort, :patient_sort)")
expression_values[":patient_sort"] = patient_sort
# Handle multiple categories and pointer types with filter expressions
if len(pointer_types) > 1:
expression_names["#pointer_type"] = "type"
types_filters = [
f"#pointer_type = :type_{i}" for i in range(len(pointer_types))
]
types_filter_values = {
f":type_{i}": pointer_types[i] for i in range(len(pointer_types))
}
filter_expressions.append(f"({' OR '.join(types_filters)})")
expression_values.update(types_filter_values)
query = {
"IndexName": "patient_gsi",
"KeyConditionExpression": " AND ".join(key_conditions),
"ExpressionAttributeValues": expression_values,
"Select": "COUNT",
"ReturnConsumedCapacity": "INDEXES",
}
if filter_expressions:
query["FilterExpression"] = " AND ".join(filter_expressions)
if expression_names:
query["ExpressionAttributeNames"] = expression_names
logger.log(LogReference.REPOSITORY017, query=query)
try:
result = self.table.query(**query)
except ClientError as exc:
logger.log(
LogReference.REPOSITORY019,
exc_info=sys.exc_info(),
stacklevel=5,
error=str(exc),
)
raise OperationOutcomeError(
status_code="500",
severity="error",
code="exception",
details=SpineErrorConcept.from_code("INTERNAL_SERVER_ERROR"),
) from exc
logger.log(LogReference.REPOSITORY018, count=result["Count"])
logger.log(LogReference.REPOSITORY018a, result=result)
return result["Count"]
def search(
self,
nhs_number: str,
custodian: Optional[str] = None,
pointer_types: Optional[List[str]] = [],
categories: Optional[List[str]] = [],
) -> Iterator[DocumentPointer]:
""""""
logger.log(
LogReference.REPOSITORY020,
nhs_number=nhs_number,
custodian=custodian,
pointer_types=pointer_types,
categories=categories,
)
key_conditions = ["patient_key = :patient_key"]
filter_expressions = []
expression_names = {}
expression_values = {":patient_key": f"P#{nhs_number}"}
# Add pointer_types filter if provided
if pointer_types:
if len(pointer_types) == 1:
# Optimisation for single pointer type
category_id, type_id = _get_sk_ids_for_type(pointer_types[0])
patient_sort = f"C#{category_id}#T#{type_id}"
key_conditions.append("begins_with(patient_sort, :patient_sort)")
expression_values[":patient_sort"] = patient_sort
else:
expression_names["#pointer_type"] = "type"
types_filters = [
f"#pointer_type = :type_{i}" for i in range(len(pointer_types))
]
types_filter_values = {
f":type_{i}": pointer_types[i] for i in range(len(pointer_types))
}
filter_expressions.append(f"({' OR '.join(types_filters)})")
expression_values.update(types_filter_values)
# Add categories filter if provided
if categories:
expression_names["#category"] = "category"
category_filters = [
f"#category = :category_{i}" for i in range(len(categories))
]
category_filter_values = {
f":category_{i}": categories[i] for i in range(len(categories))
}
filter_expressions.append(f"({' OR '.join(category_filters)})")
expression_values.update(category_filter_values)
if custodian:
logger.log(
LogReference.REPOSITORY016,
expression="custodian = :custodian",
values=["custodian"],
)
filter_expressions.append("custodian = :custodian")
expression_values[":custodian"] = custodian
query = {
"IndexName": "patient_gsi",
"KeyConditionExpression": " AND ".join(key_conditions),
"ExpressionAttributeValues": expression_values,
"ReturnConsumedCapacity": "INDEXES",
}
if filter_expressions:
query["FilterExpression"] = " AND ".join(filter_expressions)
if expression_names:
query["ExpressionAttributeNames"] = expression_names
yield from self._query(**query)
def save(self, item: DocumentPointer) -> DocumentPointer:
"""
Save a DocumentPointer resource
"""
if not item._from_dynamo:
logger.log(LogReference.REPOSITORY023)
return self.create(item)
logger.log(LogReference.REPOSITORY024)
return self.update(item)
def supersede(
self,
item: DocumentPointer,
ids_to_delete: List[str],
can_ignore_delete_fail: bool = False,
) -> DocumentPointer:
""" """
saved_item = self.create(item)
for id_ in ids_to_delete:
self.delete_by_id(id_, can_ignore_delete_fail)
return saved_item
def delete(self, item: DocumentPointer) -> None:
"""
Delete a DocumentPointer
"""
logger.log(LogReference.REPOSITORY025, partition_key=item.pk, sort_key=item.sk)
try:
result = self.table.delete_item(
Key={"pk": item.pk, "sk": item.sk},
ConditionExpression="attribute_exists(pk) AND attribute_exists(sk)",
ReturnConsumedCapacity="INDEXES",
)
logger.log(LogReference.REPOSITORY027, result=result)
except ClientError as exc:
logger.log(
LogReference.REPOSITORY026,
exc_info=sys.exc_info(),
stacklevel=5,
error=str(exc),
)
raise OperationOutcomeError(
status_code="500",
severity="error",
code="exception",
details=SpineErrorConcept.from_code("INTERNAL_SERVER_ERROR"),
) from exc
def delete_by_id(self, id_: str, can_ignore_delete_fail: bool = False):
""" """
key = f"D#{id_}"
try:
self.table.delete_item(Key={"pk": key, "sk": key})
logger.log(LogReference.REPOSITORY027, id=id_)
except Exception as exc:
logger.log(
(
LogReference.REPOSITORY026a
if can_ignore_delete_fail
else LogReference.REPOSITORY026b
),
exc_info=sys.exc_info(),
stacklevel=5,
error=str(exc),
)
def _query(self, **kwargs) -> Iterator[DocumentPointer]:
"""
Wrapper around DynamoDB query method to handle pagination
Returns an iterator of DocumentPointer objects
"""
# Remove empty fields from the search query
query = {key: value for key, value in kwargs.items() if value}
logger.log(LogReference.REPOSITORY021, query=query, table=self.table_name)
try:
paginator = self.dynamodb.meta.client.get_paginator("query")
response_iterator = paginator.paginate(TableName=self.table_name, **query)
for page in response_iterator:
logger.log(
LogReference.REPOSITORY028,
stats={
"count": page["Count"],
"scanned_count": page["ScannedCount"],
"last_evaluated_key": page.get("LastEvaluatedKey"),
},
)
logger.log(LogReference.REPOSITORY028a, result=page)
for item in page["Items"]:
try:
yield self.ITEM_TYPE.model_validate(
{"_from_dynamo": True, **item}
)
except ValidationError as exc:
logger.log(
LogReference.REPOSITORY010,
exc_info=sys.exc_info(),
stacklevel=5,
error=str(exc),
)
raise OperationOutcomeError(
status_code="500",
severity="error",
code="exception",
details=SpineErrorConcept.from_code(
"INTERNAL_SERVER_ERROR"
),
) from exc
except ClientError as exc:
logger.log(
LogReference.REPOSITORY022,
exc_info=sys.exc_info(),
stacklevel=5,
error=str(exc),
)
raise exc
def update(self, item: DocumentPointer) -> DocumentPointer:
"""
Update a DocumentPointer resource
"""
try:
result = self.table.put_item(
Item=item.model_dump(),
ConditionExpression="attribute_exists(pk) AND attribute_exists(sk)",
ReturnConsumedCapacity="INDEXES",
)
logger.log(LogReference.REPOSITORY029a, result=result)
except ClientError as exc:
logger.log(
LogReference.REPOSITORY023,
exc_info=sys.exc_info(),
stacklevel=5,
error=str(exc),
)
raise OperationOutcomeError(
status_code="500",
severity="error",
code="exception",
details=SpineErrorConcept.from_code("INTERNAL_SERVER_ERROR"),
) from exc
return item