Add log cleanup features

sist2-admin/frontend/src/Sist2AdminApi.js

@@ -112,6 +112,16 @@ class Sist2AdminApi {
     getSist2AdminInfo() {
         return axios.get(`${this.baseUrl}/api/`);
     }
+
+    getLogsToDelete(jobName, n) {
+        return axios.get(`${this.baseUrl}/api/job/${jobName}/logs_to_delete`, {
+            params: {n: n}
+        });
+    }
+
+    deleteTaskLogs(taskId) {
+        return axios.post(`${this.baseUrl}/api/task/${taskId}/delete_logs`);
+    }
 }
 
 export default new Sist2AdminApi()

sist2-admin/frontend/src/components/JobOptions.vue

@@ -9,18 +9,31 @@
         </b-form-checkbox>
 
         <label>{{ $t("jobOptions.cron") }}</label>
-    <b-form-input class="text-monospace" :state="cronValid" v-model="job.cron_expression" :disabled="!job.schedule_enabled" @change="update()"></b-form-input>
+        <b-form-input class="text-monospace" :state="cronValid" v-model="job.cron_expression"
+                      :disabled="!job.schedule_enabled" @change="update()"></b-form-input>
+
+        <label>{{ $t("jobOptions.keepNLogs") }}</label>
+        <b-input-group>
+            <b-form-input type="number" v-model="job.keep_last_n_logs" @change="update()"></b-form-input>
+            <b-input-group-append>
+                <b-button variant="danger" @click="onDeleteNowClick()">{{ $t("jobOptions.deleteNow") }}</b-button>
+            </b-input-group-append>
+        </b-input-group>
+
     </div>
 </template>
 
 <script>
 
+import Sist2AdminApi from "@/Sist2AdminApi";
+
 export default {
     name: "JobOptions",
     props: ["job"],
     data() {
         return {
-      cronValid: undefined
+            cronValid: undefined,
+            logsToDelete: null
         }
     },
     computed: {
@@ -52,6 +65,30 @@ export default {
                 this.$emit("change", this.job);
             }
         },
+        onDeleteNowClick() {
+            Sist2AdminApi.getLogsToDelete(this.job.name, this.job.keep_last_n_logs).then(resp => {
+                const toDelete = resp.data;
+                const message = `Delete ${toDelete.length} log files?`;
+
+                this.$bvModal.msgBoxConfirm(message, {
+                    title: this.$t("confirmation"),
+                    size: "sm",
+                    buttonSize: "sm",
+                    okVariant: "danger",
+                    okTitle: this.$t("delete"),
+                    cancelTitle: this.$t("cancel"),
+                    footerClass: "p-2",
+                    hideHeaderClose: false,
+                    centered: true
+                }).then(value => {
+                    if (value) {
+                        toDelete.forEach(row => {
+                            Sist2AdminApi.deleteTaskLogs(row["id"]);
+                        });
+                    }
+                });
+            })
+        }
     },
 }
 </script>

sist2-admin/frontend/src/i18n/messages.js

@@ -5,10 +5,13 @@ export default {
         go: "Go",
         online: "online",
         offline: "offline",
+        view: "View",
         delete: "Delete",
         runNow: "Index now",
         create: "Create",
+        cancel: "Cancel",
         test: "Test",
+        confirmation: "Confirmation",
 
         jobTitle: "job configuration",
         tasks: "Tasks",
@@ -99,6 +102,8 @@ export default {
         jobOptions: {
             title: "Job options",
             cron: "Job schedule",
+            keepNLogs: "Keep last N log files. Set to -1 to keep all logs.",
+            deleteNow: "Delete now",
             scheduleEnabled: "Enable scheduled re-scan",
             noJobAvailable: "No jobs available.",
             desktopNotifications: "Desktop notifications"

sist2-admin/frontend/src/views/Tasks.vue

@@ -23,7 +23,18 @@
                     :per-page="10"
             >
                 <template #cell(logs)="data">
-          <router-link :to="`/log/${data.item.logs}`">{{ $t("logs") }}</router-link>
+                    <template v-if="data.item._row.has_logs">
+                        <b-button variant="link" size="sm" :to="`/log/${data.item.id}`">
+                            {{ $t("view") }}
+                        </b-button>
+                        /
+                        <b-button variant="link" size="sm" @click="deleteLogs(data.item.id)">
+                            {{ $t("delete") }}
+                        </b-button>
+                    </template>
+                </template>
+
+                <template #cell(delete)="data">
                 </template>
 
             </b-table>
@@ -122,8 +133,9 @@ export default {
                     name: row.name,
                     duration: this.taskDuration(row),
                     time: moment.utc(row.started).local().format("dd, MMM Do YYYY, HH:mm:ss"),
-          logs: row.id,
+                    logs: null,
-          status: row.return_code === 0 ? "ok" : "failed"
+                    status: row.return_code === 0 ? "ok" : "failed",
+                    _row: row
                 }));
             });
         },
@@ -137,6 +149,11 @@ export default {
             const end = moment.utc(task.ended);
 
             return humanDuration(end.diff(start))
+        },
+        deleteLogs(taskId) {
+            Sist2AdminApi.deleteTaskLogs(taskId).then(() => {
+                this.updateHistory();
+            })
         }
     }
 }
@@ -147,4 +164,8 @@ export default {
     font-family: monospace;
     font-size: 12px;
 }
+
+.btn-link {
+    padding: 0;
+}
 </style>

sist2-admin/sist2_admin/app.py

@@ -21,7 +21,8 @@ from config import LOG_FOLDER, logger, WEBSERVER_PORT, DATA_FOLDER, SIST2_BINARY
 from jobs import Sist2Job, Sist2ScanTask, TaskQueue, Sist2IndexTask, JobStatus
 from notifications import Subscribe, Notifications
 from sist2 import Sist2
-from state import migrate_v1_to_v2, RUNNING_FRONTENDS, TESSERACT_LANGS, DB_SCHEMA_VERSION
+from state import migrate_v1_to_v2, RUNNING_FRONTENDS, TESSERACT_LANGS, DB_SCHEMA_VERSION, migrate_v3_to_v4, \
+    get_log_files_to_remove, delete_log_file
 from web import Sist2Frontend
 
 sist2 = Sist2(SIST2_BINARY, DATA_FOLDER)
@@ -80,7 +81,6 @@ async def get_jobs():
 
 @app.put("/api/job/{name:str}")
 async def update_job(name: str, new_job: Sist2Job):
-
     new_job.last_modified = datetime.utcnow()
     job = db["jobs"][name]
     if not job:
@@ -133,6 +133,16 @@ async def kill_job(task_id: str):
     return task_queue.kill_task(task_id)
 
 
+@app.post("/api/task/{task_id:str}/delete_logs")
+async def delete_task_logs(task_id: str):
+    if not db["task_done"][task_id]:
+        raise HTTPException(status_code=404)
+
+    delete_log_file(db, task_id)
+
+    return "ok"
+
+
 def _run_job(job: Sist2Job):
     job.last_modified = datetime.utcnow()
     if job.status == JobStatus("created"):
@@ -157,6 +167,11 @@ async def run_job(name: str):
     return "ok"
 
 
+@app.get("/api/job/{name:str}/logs_to_delete")
+async def task_history(n: int, name: str):
+    return get_log_files_to_remove(db, name, n)
+
+
 @app.delete("/api/job/{name:str}")
 async def delete_job(name: str):
     job = db["jobs"][name]
@@ -320,7 +335,6 @@ async def ws_tail_log(websocket: WebSocket):
         async with Subscribe(notifications) as ob:
             async for notification in ob.notifications():
                 await websocket.send_json(notification)
-                print(notification)
 
     except ConnectionClosed:
         return
@@ -380,6 +394,9 @@ if __name__ == '__main__':
     if db["sist2_admin"]["info"]["version"] == "2":
         logger.error("Cannot migrate database from v2 to v3. Delete state.db to proceed.")
         exit(-1)
+    if db["sist2_admin"]["info"]["version"] == "3":
+        logger.info("Migrating to v4 database schema")
+        migrate_v3_to_v4(db)
 
     start_frontends()
     cron.initialize(db, _run_job)

sist2-admin/sist2_admin/jobs.py

@@ -16,7 +16,7 @@ from pydantic import BaseModel
 from config import logger, LOG_FOLDER
 from notifications import Notifications
 from sist2 import ScanOptions, IndexOptions, Sist2
-from state import RUNNING_FRONTENDS
+from state import RUNNING_FRONTENDS, get_log_files_to_remove, delete_log_file
 from web import Sist2Frontend
 
 
@@ -35,6 +35,8 @@ class Sist2Job(BaseModel):
     cron_expression: str
     schedule_enabled: bool = False
 
+    keep_last_n_logs: int = -1
+
     previous_index: str = None
     index_path: str = None
     previous_index_path: str = None
@@ -301,8 +303,14 @@ class TaskQueue:
                 "ended": task.ended,
                 "started": task.started,
                 "name": task.display_name,
-                "return_code": task_result
+                "return_code": task_result,
+                "has_logs": 1
             }
+
+            logs_to_delete = get_log_files_to_remove(self._db, task.job.name, task.job.keep_last_n_logs)
+            for row in logs_to_delete:
+                delete_log_file(self._db, row["id"])
+
         if isinstance(task, Sist2IndexTask):
             self._notifications.notify({
                 "message": "notifications.indexCompleted",

sist2-admin/sist2_admin/state.py

@@ -1,16 +1,19 @@
 from typing import Dict
+import os
 import shutil
 
 from hexlib.db import Table, PersistentState
 import pickle
 
 from tesseract import get_tesseract_langs
+import sqlite3
+from config import LOG_FOLDER
 
 RUNNING_FRONTENDS: Dict[str, int] = {}
 
 TESSERACT_LANGS = get_tesseract_langs()
 
-DB_SCHEMA_VERSION = "3"
+DB_SCHEMA_VERSION = "4"
 
 from pydantic import BaseModel
 
@@ -50,8 +53,35 @@ class PickleTable(Table):
             yield dict((k, _deserialize(v)) for k, v in row.items())
 
 
-def migrate_v1_to_v2(db: PersistentState):
+def get_log_files_to_remove(db: PersistentState, job_name: str, n: int):
+    if n < 0:
+        return []
 
+    counter = 0
+    to_remove = []
+
+    for row in db["task_done"].sql("WHERE has_logs=1 ORDER BY started DESC"):
+        if row["name"].endswith(f"[{job_name}]"):
+            counter += 1
+
+        if counter > n:
+            to_remove.append(row)
+
+    return to_remove
+
+
+def delete_log_file(db: PersistentState, task_id: str):
+    db["task_done"][task_id] = {
+        "has_logs": 0
+    }
+
+    try:
+        os.remove(os.path.join(LOG_FOLDER, f"sist2-{task_id}.log"))
+    except:
+        pass
+
+
+def migrate_v1_to_v2(db: PersistentState):
     shutil.copy(db.dbfile, db.dbfile + "-before-migrate-v2.bak")
 
     # Frontends
@@ -77,3 +107,16 @@ def migrate_v1_to_v2(db: PersistentState):
     db["sist2_admin"]["info"] = {
         "version": "2"
     }
+
+
+def migrate_v3_to_v4(db: PersistentState):
+    shutil.copy(db.dbfile, db.dbfile + "-before-migrate-v4.bak")
+
+    conn = sqlite3.connect(db.dbfile)
+    conn.execute("ALTER TABLE task_done ADD COLUMN has_logs INTEGER DEFAULT 1")
+    conn.commit()
+    conn.close()
+
+    db["sist2_admin"]["info"] = {
+        "version": "4"
+    }