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
|
"""Module that contains functions for editing case-attribute data"""
from pathlib import Path
from typing import Any, Optional, Tuple
from dataclasses import dataclass
from enum import Enum, auto
import os
import json
import pickle
import lmdb
import MySQLdb
@dataclass
class CaseAttributeEdit:
"""Represents an edit operation for case attributes in the database.
Attributes:
inbredset_id (int): The ID of the inbred set associated with
the edit.
user_id (str): The ID of the user performing the edit.
changes (dict): A dictionary containing the changes to be
applied to the case attributes.
"""
inbredset_id: int
user_id: str
changes: dict
class EditStatus(Enum):
"""Enumeration for the status of the edits."""
review = auto() # pylint: disable=[invalid-name]
approved = auto() # pylint: disable=[invalid-name]
rejected = auto() # pylint: disable=[invalid-name]
def __str__(self):
"""Print out human-readable form."""
return self.name
def queue_edit(cursor, directory: Path, edit: CaseAttributeEdit) -> int:
"""Queues a case attribute edit for review by inserting it into
the audit table and storing its review ID in an LMDB database.
Args:
cursor: A database cursor for executing SQL queries.
directory (Path): The base directory path for the LMDB database.
edit (CaseAttributeEdit): A dataclass containing the edit details, including
inbredset_id, user_id, and changes.
Returns:
int: An id the particular case-attribute that was updated.
Notes:
- Inserts the edit into the `caseattributes_audit` table with status set to
`EditStatus.review`.
- Uses LMDB to store review IDs under the key b"review" for the given
inbredset_id.
- The LMDB map_size is set to 8 MB.
"""
cursor.execute(
"INSERT INTO "
"caseattributes_audit(status, editor, json_diff_data) "
"VALUES (%s, %s, %s) "
"ON DUPLICATE KEY UPDATE status=%s",
(str(EditStatus.review),
edit.user_id, json.dumps(edit.changes), str(EditStatus.review),))
directory = f"{directory}/case-attributes/{edit.inbredset_id}"
if not os.path.exists(directory):
os.makedirs(directory)
env = lmdb.open(directory, map_size=8_000_000) # 1 MB
with env.begin(write=True) as txn:
review_ids = set()
if reviews := txn.get(b"review"):
review_ids = pickle.loads(reviews)
review_ids.add(cursor.lastrowid)
txn.put(b"review", pickle.dumps(review_ids))
return review_ids
def get_case_attributes(conn) -> Optional[Tuple]:
"""Get all the case attributes from the database."""
with conn.cursor() as cursor:
cursor.execute("SELECT Id, Name, Description FROM CaseAttribute")
return cursor.fetchall()
def get_unreviewed_diffs(conn: Any) -> Optional[tuple]:
"""Fetch all case attributes in GN"""
with conn.cursor() as cursor:
cursor.execute(
"SELECT id, editor, json_diff_data FROM "
"caseattributes_audit WHERE status = 'review'"
)
return cursor.fetchall()
def insert_case_attribute_audit(
conn: Any, status: str, author: str, data: str
) -> int:
"""Update the case_attribute_audit table"""
rowcount = 0
try:
with conn.cursor() as cursor:
cursor.execute(
"INSERT INTO caseattributes_audit "
"(status, editor, json_diff_data) "
"VALUES (%s, %s, %s)",
(status, author, data,),
)
rowcount = cursor.rowcount
except Exception as _e:
raise MySQLdb.Error(_e) from _e
return rowcount
def reject_case_attribute(conn: Any, case_attr_audit_id: int) -> int:
"""Given the id of the json_diff in the case_attribute_audit table, reject
it"""
rowcount = 0
try:
with conn.cursor() as cursor:
cursor.execute(
"UPDATE caseattributes_audit SET "
"status = 'rejected' WHERE id = %s",
(case_attr_audit_id,),
)
rowcount = cursor.rowcount
except Exception as _e:
raise MySQLdb.Error(_e) from _e
return rowcount
def approve_case_attribute(conn: Any, case_attr_audit_id: int) -> int:
"""Given the id of the json_diff in the case_attribute_audit table,
approve it
"""
rowcount = 0
try:
with conn.cursor() as cursor:
cursor.execute(
"SELECT json_diff_data FROM caseattributes_audit "
"WHERE id = %s",
(case_attr_audit_id,),
)
diff_data = cursor.fetchone()
if diff_data:
diff_data = json.loads(diff_data[0])
# Insert (Most Important)
if diff_data.get("Insert"):
data = diff_data.get("Insert")
cursor.execute(
"INSERT INTO CaseAttribute "
"(Name, Description) VALUES "
"(%s, %s)",
(
data.get("name").strip(),
data.get("description").strip(),
),
)
# Delete
elif diff_data.get("Deletion"):
data = diff_data.get("Deletion")
cursor.execute(
"DELETE FROM CaseAttribute WHERE Id = %s",
(data.get("id"),),
)
# Modification
elif diff_data.get("Modification"):
data = diff_data.get("Modification")
if desc_ := data.get("description"):
cursor.execute(
"UPDATE CaseAttribute SET "
"Description = %s WHERE Id = %s",
(
desc_.get("Current"),
diff_data.get("id"),
),
)
if name_ := data.get("name"):
cursor.execute(
"UPDATE CaseAttribute SET "
"Name = %s WHERE Id = %s",
(
name_.get("Current"),
diff_data.get("id"),
),
)
if cursor.rowcount:
cursor.execute(
"UPDATE caseattributes_audit SET "
"status = 'approved' WHERE id = %s",
(case_attr_audit_id,),
)
rowcount = cursor.rowcount
except Exception as _e:
raise MySQLdb.Error(_e) from _e
return rowcount
|