Maintenance Service
MaintenanceService は、beautyspot システムの管理・運用に特化したサービスレイヤーです。データの整合性を保ち、ストレージ使用量を管理するためのすべてのクリーンアップ操作を処理します。
beautyspot.maintenance
MaintenanceService
Service layer for administrative tasks, dashboard support, and system assembly.
Source code in src/beautyspot/maintenance.py
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 | |
clean_garbage(orphans=None, tmp_max_age_seconds=86400, orphan_grace_seconds=60.0)
期限切れのタスク(DBレコード)と孤立したBlobファイルを削除します。 また、アトミック書き込み時に残留した古い一時ファイル (.spot_tmp) の クリーンアップも同時に行います。
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
orphans
|
Optional[list[str]]
|
事前にスキャンされた孤立ファイルのリスト。 |
None
|
tmp_max_age_seconds
|
int
|
一時ファイルを削除対象とするまでの猶予期間(秒)。デフォルトは24時間。 |
86400
|
orphan_grace_seconds
|
float
|
孤立ファイルを判定する際の猶予期間(秒)。デフォルトは60秒。 |
60.0
|
Returns:
| Type | Description |
|---|---|
tuple[int, int]
|
tuple[int, int]: (削除された期限切れタスクの数, 削除された孤立ファイルの数) |
Source code in src/beautyspot/maintenance.py
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 | |
close()
DB バックエンドをシャットダウンする。
from_path で作成された場合のみ DB をシャットダウンします。
外部から注入された DB は呼び出し元の責務でシャットダウンしてください。
delete_expired_tasks()
delete_project_storage(path)
staticmethod
Recursively delete a project storage directory.
Source code in src/beautyspot/maintenance.py
delete_task(cache_key)
Delete a task record and its associated blob file.
Source code in src/beautyspot/maintenance.py
from_path(db_path, blob_dir=None)
classmethod
Factory method to assemble the system components (SQLite + Msgpack + Storage) from a database path.
Source code in src/beautyspot/maintenance.py
get_history(limit=1000)
get_task_detail(cache_key, *, include_expired=False)
Retrieve task details and decode the blob data if available. Returns the record dict with an extra 'decoded_data' key.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
include_expired
|
bool
|
If True, return expired records as well (for dashboard/debugging). |
False
|
Source code in src/beautyspot/maintenance.py
resolve_key_prefix(prefix)
Resolve a potentially shortened key to a full cache key.
Returns:
| Name | Type | Description |
|---|---|---|
str |
str | list[str] | None
|
The single matching full key (Exact match or unique prefix match). |
str | list[str] | None
|
list[str]: A list of conflicting candidates (Ambiguous). |
|
None |
str | list[str] | None
|
No match found. |
Source code in src/beautyspot/maintenance.py
scan_garbage(grace_period=60.0)
Scan for orphaned blob files that are not referenced in the database.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
grace_period
|
float
|
Minimum age of a blob (in seconds) to be considered an orphan. This prevents deleting blobs that were just created but not yet registered in the database (background saves). |
60.0
|
Source code in src/beautyspot/maintenance.py
scan_orphan_projects(workspace_dir)
staticmethod
Scan for blob directories in .beautyspot/blobs/ that have no corresponding .db file. Returns a list of Path objects for the orphan directories.
Source code in src/beautyspot/maintenance.py
アーキテクチャ
このサービスは、論理レイヤー(データベースレコード)と物理レイヤー(Blobストレージ)を分離して管理します。
削除戦略
- トランザクション安全性: タスクを削除する際、
beautyspotはデータベースレコードを削除する 前 に、物理Blobファイルの削除を試みます。ただし、Blob削除が失敗した場合(例: S3のネットワークエラー)でも、壊れたデータを提供しないようにDBレコードは削除されます。これにより「孤立したファイル」が残る可能性があるため、cleanコマンドが用意されています。 - 寛容な削除 (Tolerant Deletion):
delete_task操作は「寛容」です。つまり、物理ファイルが既に存在しない場合でもエラーを発生させず、DBレコードの削除を完了させます。
ライフサイクル管理
データの保持期間(Retention)は、以下の2つの方法で管理できます。
-
明示的な Pruning (
pruneコマンド):updated_atタイムスタンプに基づいてタスクを削除します。- バッチ処理スクリプトなどでの定期実行に適しています。
-
TTL / 有効期限 (将来の機能):
@mark(retention=...)デコレータによって、タスクにexpires_atフィールドを設定できます。MaintenanceServiceはdelete_expired_tasks()を提供し、これらのレコードを物理削除します。- 注: 現在、有効期限は読み取り時に遅延チェックされます。物理的な削除を行うには、クリーンアップジョブを実行する必要があります。
ゾンビプロジェクト (gc)
「ゾンビプロジェクト」とは、Blobストレージルート(例: .beautyspot/blobs/<name>)内のサブディレクトリのうち、対応するSQLiteデータベースファイル(.beautyspot/<name>.db)を持たないものを指します。
gc コマンドは、ワークスペースを浅くスキャン (Shallow Scan) し、これらのディレクトリを特定して削除します。