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 | def deactivate_local(
*,
task_group_activity_id: int,
task_group_id: int,
) -> None:
"""
Deactivate a task group venv.
This function is run as a background task, therefore exceptions must be
handled.
Arguments:
task_group_id:
task_group_activity_id:
"""
with TemporaryDirectory() as tmpdir:
log_file_path = get_log_path(Path(tmpdir))
logger = set_logger(
logger_name=LOGGER_NAME,
log_file_path=log_file_path,
)
with next(get_sync_db()) as db:
# Get main objects from db
activity = db.get(TaskGroupActivityV2, task_group_activity_id)
task_group = db.get(TaskGroupV2, task_group_id)
if activity is None or task_group is None:
# Use `logging` directly
logging.error(
"Cannot find database rows with "
f"{task_group_id=} and {task_group_activity_id=}:\n"
f"{task_group=}\n{activity=}. Exit."
)
return
# Log some info
logger.debug("START")
for key, value in task_group.model_dump().items():
logger.debug(f"task_group.{key}: {value}")
# Check that the (local) task_group venv_path does exist
if not Path(task_group.venv_path).exists():
error_msg = f"{task_group.venv_path} does not exist."
logger.error(error_msg)
fail_and_cleanup(
task_group=task_group,
task_group_activity=activity,
logger_name=LOGGER_NAME,
log_file_path=log_file_path,
exception=FileNotFoundError(error_msg),
db=db,
)
return
try:
activity.status = TaskGroupActivityStatusV2.ONGOING
activity = add_commit_refresh(obj=activity, db=db)
if task_group.pip_freeze is None:
logger.warning(
"Recreate pip-freeze information, since "
f"{task_group.pip_freeze=}. NOTE: this should only "
"happen for task groups created before 2.9.0."
)
# Prepare replacements for templates
replacements = get_collection_replacements(
task_group=task_group,
python_bin="/not/applicable",
)
# Prepare common arguments for _customize_and_run_template
common_args = dict(
replacements=replacements,
script_dir=(
Path(task_group.path) / SCRIPTS_SUBFOLDER
).as_posix(),
prefix=(
f"{int(time.time())}_"
f"{TaskGroupActivityActionV2.DEACTIVATE}_"
),
logger_name=LOGGER_NAME,
)
# Update pip-freeze data
pip_freeze_stdout = _customize_and_run_template(
template_filename="3_pip_freeze.sh",
**common_args,
)
logger.info("Add pip freeze stdout to TaskGroupV2 - start")
activity.log = get_current_log(log_file_path)
activity = add_commit_refresh(obj=activity, db=db)
task_group.pip_freeze = pip_freeze_stdout
task_group = add_commit_refresh(obj=task_group, db=db)
logger.info("Add pip freeze stdout to TaskGroupV2 - end")
# Handle some specific cases for wheel-file case
if task_group.origin == TaskGroupV2OriginEnum.WHEELFILE:
logger.info(
f"Handle specific cases for {task_group.origin=}."
)
# Blocking situation: `wheel_path` is not set or points
# to a missing path
if (
task_group.wheel_path is None
or not Path(task_group.wheel_path).exists()
):
error_msg = (
"Invalid wheel path for task group with "
f"{task_group_id=}. {task_group.wheel_path=} is "
"unset or does not exist."
)
logger.error(error_msg)
fail_and_cleanup(
task_group=task_group,
task_group_activity=activity,
logger_name=LOGGER_NAME,
log_file_path=log_file_path,
exception=FileNotFoundError(error_msg),
db=db,
)
return
# Recoverable situation: `wheel_path` was not yet copied
# over to the correct server-side folder
wheel_path_parent_dir = Path(task_group.wheel_path).parent
if wheel_path_parent_dir != Path(task_group.path):
logger.warning(
f"{wheel_path_parent_dir.as_posix()} differs from "
f"{task_group.path}. NOTE: this should only "
"happen for task groups created before 2.9.0."
)
if task_group.wheel_path not in task_group.pip_freeze:
raise ValueError(
f"Cannot find {task_group.wheel_path=} in "
"pip-freeze data. Exit."
)
logger.info(
f"Now copy wheel file into {task_group.path}."
)
new_wheel_path = (
Path(task_group.path)
/ Path(task_group.wheel_path).name
).as_posix()
shutil.copy(task_group.wheel_path, new_wheel_path)
logger.info(f"Copied wheel file to {new_wheel_path}.")
task_group.wheel_path = new_wheel_path
new_pip_freeze = task_group.pip_freeze.replace(
task_group.wheel_path,
new_wheel_path,
)
task_group.pip_freeze = new_pip_freeze
task_group = add_commit_refresh(obj=task_group, db=db)
logger.info(
"Updated `wheel_path` and `pip_freeze` "
"task-group attributes."
)
# Fail if `pip_freeze` includes "github.com", see
# https://github.com/fractal-analytics-platform/fractal-server/issues/2142
for forbidden_string in FORBIDDEN_DEPENDENCY_STRINGS:
if forbidden_string in task_group.pip_freeze:
raise ValueError(
"Deactivation and reactivation of task packages "
f"with direct {forbidden_string} dependencies "
"are not currently supported. Exit."
)
# We now have all required information for reactivating the
# virtual environment at a later point
# Actually mark the task group as non-active
logger.info("Now setting `active=False`.")
task_group.active = False
task_group = add_commit_refresh(obj=task_group, db=db)
# Proceed with deactivation
logger.info(f"Now removing {task_group.venv_path}.")
shutil.rmtree(task_group.venv_path)
logger.info(f"All good, {task_group.venv_path} removed.")
activity.status = TaskGroupActivityStatusV2.OK
activity.log = get_current_log(log_file_path)
activity.timestamp_ended = get_timestamp()
activity = add_commit_refresh(obj=activity, db=db)
except Exception as e:
fail_and_cleanup(
task_group=task_group,
task_group_activity=activity,
logger_name=LOGGER_NAME,
log_file_path=log_file_path,
exception=e,
db=db,
)
return
|