chore(background-job): adjust log path to jobs dir and hashed id (#4081)

* docs(backup): add guide to backup background jobs dir

* docs(backup): apply review to use new job path

* chore(background-job): use jobs and hashed id as job path

* chore: use updated path

Author: zwpaper

ee/tabby-webserver/src/path.rs

@@ -16,8 +16,8 @@ pub fn db_file() -> PathBuf {
 
 pub fn background_jobs_dir() -> PathBuf {
     if cfg!(feature = "prod") {
-        tabby_ee_root().join("background-jobs")
+        tabby_ee_root().join("jobs")
     } else {
-        tabby_ee_root().join("dev-background-jobs")
+        tabby_ee_root().join("dev-jobs")
     }
 }

ee/tabby-webserver/src/service/background_job/helper/logger.rs

@@ -2,6 +2,7 @@ use std::{fs::File, io::Write};
 
 use anyhow::Result;
 use tabby_db::DbConn;
+use tabby_schema::AsID;
 use tracing::warn;
 
 use crate::path::background_jobs_dir;
@@ -37,7 +38,7 @@ struct DbTarget {
 
 impl DbTarget {
     fn new(db: DbConn, id: i64) -> Result<(Self, tokio::task::JoinHandle<()>)> {
-        let job_dir = background_jobs_dir().join(format!("{}", id));
+        let job_dir = background_jobs_dir().join(id.as_id().to_string());
         std::fs::create_dir_all(&job_dir)?;
         let stdout_path = job_dir.join("stdout.log");
         let file = File::create(&stdout_path)?;

ee/tabby-webserver/src/service/job.rs

@@ -71,7 +71,7 @@ impl JobService for JobControllerImpl {
         for job in jobs.iter_mut() {
             if job.stdout.is_empty() {
                 // it is possible that the job is starting to run and the stdout is not yet available
-                if let Ok(stdout) = self.read_job_stdout(job.id.as_rowid()?).await {
+                if let Ok(stdout) = self.read_job_stdout(job.id.clone().to_string()).await {
                     job.stdout = stdout;
                 }
             }
@@ -92,7 +92,7 @@ impl JobService for JobControllerImpl {
 
         if job_run.stdout.is_empty() {
             // it is possible that the job is starting to run and the stdout is not yet available
-            if let Ok(stdout) = self.read_job_stdout(job_run.id.as_rowid()?).await {
+            if let Ok(stdout) = self.read_job_stdout(job_run.id.to_string()).await {
                 job_run.stdout = stdout;
             }
         }
@@ -114,10 +114,8 @@ impl JobService for JobControllerImpl {
 }
 
 impl JobControllerImpl {
-    async fn read_job_stdout(&self, id: i64) -> Result<String> {
-        let log_file = background_jobs_dir()
-            .join(format!("{}", id))
-            .join("stdout.log");
+    async fn read_job_stdout(&self, id: String) -> Result<String> {
+        let log_file = background_jobs_dir().join(id).join("stdout.log");
 
         if log_file.exists() {
             match read_to_string(log_file).await {

website/docs/administration/backup.md

@@ -45,4 +45,15 @@ Tabby stores all event logs in the `~/.tabby/events` directory. These events, st
 2023-12-04.json 2023-12-19.json 2024-01-26.json 2024-02-07.json 2024-02-18.json 2024-03-02.json
 2023-12-05.json 2023-12-20.json 2024-01-27.json 2024-02-08.json 2024-02-19.json 2024-03-03.json
 2023-12-07.json 2023-12-22.json 2024-01-30.json 2024-02-09.json 2024-02-20.json 2024-03-05.json
+```
+
+## Background Job Logs Backup
+
+Starting with version v0.27.0, Tabby saves all background job logs in the `~/.tabby/ee/jobs` directory.
+To display the logs in the management UI, it is essential to back up this directory.
+
+```
+% ls ~/.tabby/ee/jobs
+
+DGJ7Xw  JGODZw  L1Pp41  nwY59w
 ```