@adminforth/background-jobs 1.11.6 → 1.12.0

package/build.log

@@ -13,5 +13,5 @@ custom/tsconfig.json
 custom/useBackgroundJobApi.ts
 custom/utils.ts
 
-sent 18,507 bytes  received 172 bytes  37,358.00 bytes/sec
-total size is 17,874  speedup is 0.96
+sent 18,730 bytes  received 172 bytes  37,804.00 bytes/sec
+total size is 18,097  speedup is 0.96

package/custom/JobInfoPopup.vue

@@ -67,6 +67,7 @@ import { getTimeAgoString, callAdminForthApi, getCustomComponent} from '@/utils'
 import { useI18n } from 'vue-i18n';
 import StateToIcon from './StateToIcon.vue';
 import { useAdminforth } from '@/adminforth';
+import { watch } from 'vue';
 
 
 const { t } = useI18n();
@@ -133,6 +134,19 @@ async function getJobTasks(limit: number = 10, offset: number = 0): Promise<{sta
   }
 }
 
+watch(
+  () => props.job.state?.error,
+  (error) => {
+    if (error) {
+      adminforth.alert({
+        message: error,
+        variant: 'danger',
+      });
+    }
+  },
+  { immediate: true }
+);
+
 
 
 </script>

package/dist/custom/JobInfoPopup.vue

@@ -67,6 +67,7 @@ import { getTimeAgoString, callAdminForthApi, getCustomComponent} from '@/utils'
 import { useI18n } from 'vue-i18n';
 import StateToIcon from './StateToIcon.vue';
 import { useAdminforth } from '@/adminforth';
+import { watch } from 'vue';
 
 
 const { t } = useI18n();
@@ -133,6 +134,19 @@ async function getJobTasks(limit: number = 10, offset: number = 0): Promise<{sta
   }
 }
 
+watch(
+  () => props.job.state?.error,
+  (error) => {
+    if (error) {
+      adminforth.alert({
+        message: error,
+        variant: 'danger',
+      });
+    }
+  },
+  { immediate: true }
+);
+
 
 
 </script>

package/dist/index.js

@@ -17,6 +17,7 @@ export default class BackgroundJobsPlugin extends AdminForthPlugin {
     constructor(options) {
         super(options, import.meta.url);
         this.taskHandlers = {};
+        this.onAllTasksDoneHandlers = {};
         this.jobCustomComponents = {};
         this.jobParallelLimits = {};
         this.levelDbInstances = {};
@@ -152,10 +153,48 @@ export default class BackgroundJobsPlugin extends AdminForthPlugin {
             return count ? parseInt(count, 10) : 0;
         });
     }
-    registerTaskHandler({ jobHandlerName, handler, parallelLimit = 3, }) {
+    getAllTasksDoneStatus(levelDb) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const totalTasks = yield this.getTotalTasksInLevelDb(levelDb);
+            let failedTasks = 0;
+            let succeededTasks = 0;
+            for (let taskIndex = 0; taskIndex < totalTasks; taskIndex++) {
+                const status = yield this.getLevelDbTaskStatusField(levelDb, taskIndex.toString());
+                if (status === 'FAILED') {
+                    failedTasks++;
+                }
+                else if (status === 'DONE') {
+                    succeededTasks++;
+                }
+            }
+            return { failedTasks, succeededTasks };
+        });
+    }
+    triggerOnAllTasksDone(onAllTasksDone, levelDb, jobId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!onAllTasksDone) {
+                return;
+            }
+            try {
+                const status = yield this.getAllTasksDoneStatus(levelDb);
+                yield onAllTasksDone(Object.assign({ jobId }, status));
+            }
+            catch (error) {
+                const errorMessage = error instanceof Error ? error.message : String(error);
+                afLogger.error(`Error in onAllTasksDone callback for job ${jobId}: ${errorMessage}`);
+            }
+        });
+    }
+    registerTaskHandler({ jobHandlerName, handler, parallelLimit = 3, onAllTasksDone, }) {
         //register the handler in a map with jobHandlerName as key and handler as value
         this.taskHandlers[jobHandlerName] = handler;
         this.jobParallelLimits[jobHandlerName] = parallelLimit;
+        if (onAllTasksDone) {
+            this.onAllTasksDoneHandlers[jobHandlerName] = onAllTasksDone;
+        }
+        else {
+            delete this.onAllTasksDoneHandlers[jobHandlerName];
+        }
     }
     registerTaskDetailsComponent({ jobHandlerName, component, }) {
         this.jobCustomComponents[jobHandlerName] = component;
@@ -163,6 +202,7 @@ export default class BackgroundJobsPlugin extends AdminForthPlugin {
     startNewJob(jobName, adminUser, tasks, jobHandlerName) {
         return __awaiter(this, void 0, void 0, function* () {
             const handleTask = this.taskHandlers[jobHandlerName];
+            const onAllTasksDone = this.onAllTasksDoneHandlers[jobHandlerName];
             if (!handleTask) {
                 throw new Error(`No handler registered for jobHandler ${jobHandlerName}. Please register a handler using the registerTaskHandler method before starting a job with this jobHandler.`);
             }
@@ -203,11 +243,11 @@ export default class BackgroundJobsPlugin extends AdminForthPlugin {
                 return limit2(() => this.createLevelDbTaskRecord(jobLevelDb, index.toString(), task.state));
             });
             yield Promise.all(createTaskRecordsPromises);
-            this.runProcessingTasks(tasks, jobLevelDb, jobId, handleTask, parrallelLimit);
+            this.runProcessingTasks(tasks, jobLevelDb, jobId, handleTask, parrallelLimit, onAllTasksDone);
             return jobId;
         });
     }
-    runProcessingTasks(tasks, jobLevelDb, jobId, handleTask, parrallelLimit) {
+    runProcessingTasks(tasks, jobLevelDb, jobId, handleTask, parrallelLimit, onAllTasksDone) {
         return __awaiter(this, void 0, void 0, function* () {
             const totalTasks = tasks.length;
             let completedTasks = 0;
@@ -246,7 +286,9 @@ export default class BackgroundJobsPlugin extends AdminForthPlugin {
                     this.adminforth.websocket.publish(`/background-jobs-task-update/${jobId}`, { taskIndex, status: "DONE" });
                 }
                 catch (error) {
-                    afLogger.error(`Error in handling task ${taskIndex} of job ${jobId}: ${error}`);
+                    const errorMessage = (error === null || error === void 0 ? void 0 : error.message) || 'Unknown error';
+                    afLogger.error(`Error in handling task ${taskIndex} of job ${jobId}: ${errorMessage}`);
+                    yield this.setJobField(jobId, 'error', errorMessage);
                     yield this.setLevelDbTaskStatusField(jobLevelDb, taskIndex.toString(), 'FAILED');
                     this.adminforth.websocket.publish(`/background-jobs-task-update/${jobId}`, { taskIndex, status: "FAILED" });
                     failedTasks++;
@@ -275,6 +317,7 @@ export default class BackgroundJobsPlugin extends AdminForthPlugin {
                 });
                 this.adminforth.websocket.publish('/background-jobs', { jobId, status: 'DONE', finishedAt: (new Date()).toISOString() });
                 this.cleanupJobMutexIfTerminalStatus(jobId, 'DONE');
+                yield this.triggerOnAllTasksDone(onAllTasksDone, jobLevelDb, jobId);
             }
             else if (failedTasks > 0) {
                 yield this.adminforth.resource(this.getResourceId()).update(jobId, {
@@ -283,6 +326,7 @@ export default class BackgroundJobsPlugin extends AdminForthPlugin {
                 });
                 this.adminforth.websocket.publish('/background-jobs', { jobId, status: 'DONE_WITH_ERRORS' });
                 this.cleanupJobMutexIfTerminalStatus(jobId, 'DONE_WITH_ERRORS');
+                yield this.triggerOnAllTasksDone(onAllTasksDone, jobLevelDb, jobId);
             }
         });
     }
@@ -319,6 +363,7 @@ export default class BackgroundJobsPlugin extends AdminForthPlugin {
                 return;
             }
             const parrallelLimit = this.jobParallelLimits[jobHandlerName] || 3;
+            const onAllTasksDone = this.onAllTasksDoneHandlers[jobHandlerName];
             const unfinishedTasks = [];
             let taskIndex = 0;
             while (true) {
@@ -343,7 +388,7 @@ export default class BackgroundJobsPlugin extends AdminForthPlugin {
                 }
                 taskIndex++;
             }
-            yield this.runProcessingTasks(unfinishedTasks, jobLevelDb, job[this.getResourcePk()], handleTask, parrallelLimit);
+            yield this.runProcessingTasks(unfinishedTasks, jobLevelDb, job[this.getResourcePk()], handleTask, parrallelLimit, onAllTasksDone);
         });
     }
     setJobField(jobId, key, value) {

package/index.ts

@@ -11,6 +11,12 @@ type TaskStatus = 'SCHEDULED' | 'IN_PROGRESS' | 'DONE' | 'FAILED';
 type setStateFieldParams = (state: Record<string, any>) => void;
 type getStateFieldParams = () => any;
 type taskHandlerType = ( { jobId, setTaskStateField, getTaskStateField }: { jobId: string; setTaskStateField: setStateFieldParams; getTaskStateField: getStateFieldParams } ) => Promise<void>;
+type allTasksDoneStatusType = {
+  jobId: string;
+  failedTasks: number;
+  succeededTasks: number;
+};
+type onAllTasksDoneType = (status: allTasksDoneStatusType) => Promise<void> | void;
 type taskType = {
   skip?: boolean;
   state: Record<string, any>;
@@ -19,6 +25,7 @@ type taskType = {
 export default class BackgroundJobsPlugin extends AdminForthPlugin {
   options: PluginOptions;
   private taskHandlers: Record<string, taskHandlerType> = {};
+  private onAllTasksDoneHandlers: Partial<Record<string, onAllTasksDoneType>> = {};
   private jobCustomComponents: Record<string, AdminForthComponentDeclarationFull> = {};
   private jobParallelLimits: Record<string, number> = {};
   private levelDbInstances: Record<string, Level> = {};
@@ -159,12 +166,48 @@ export default class BackgroundJobsPlugin extends AdminForthPlugin {
     const count = await levelDb.get('_meta:count');
     return count ? parseInt(count, 10) : 0;
   }
+
+  private async getAllTasksDoneStatus(levelDb: Level): Promise<Omit<allTasksDoneStatusType, 'jobId'>> {
+    const totalTasks = await this.getTotalTasksInLevelDb(levelDb);
+    let failedTasks = 0;
+    let succeededTasks = 0;
+
+    for (let taskIndex = 0; taskIndex < totalTasks; taskIndex++) {
+      const status = await this.getLevelDbTaskStatusField(levelDb, taskIndex.toString());
+      if (status === 'FAILED') {
+        failedTasks++;
+      } else if (status === 'DONE') {
+        succeededTasks++;
+      }
+    }
+
+    return { failedTasks, succeededTasks };
+  }
+
+  private async triggerOnAllTasksDone(onAllTasksDone: onAllTasksDoneType | undefined, levelDb: Level, jobId: string) {
+    if (!onAllTasksDone) {
+      return;
+    }
+
+    try {
+      const status = await this.getAllTasksDoneStatus(levelDb);
+      await onAllTasksDone({ jobId, ...status });
+    } catch (error) {
+      const errorMessage = error instanceof Error ? error.message : String(error);
+      afLogger.error(`Error in onAllTasksDone callback for job ${jobId}: ${errorMessage}`);
+    }
+  }
   
-  public registerTaskHandler({ jobHandlerName, handler, parallelLimit = 3,
-  }:{jobHandlerName: string, handler: taskHandlerType, parallelLimit?: number}) {
+  public registerTaskHandler({ jobHandlerName, handler, parallelLimit = 3, onAllTasksDone,
+  }:{jobHandlerName: string, handler: taskHandlerType, parallelLimit?: number, onAllTasksDone?: onAllTasksDoneType}) {
     //register the handler in a map with jobHandlerName as key and handler as value
     this.taskHandlers[jobHandlerName] = handler;
     this.jobParallelLimits[jobHandlerName] = parallelLimit;
+    if (onAllTasksDone) {
+      this.onAllTasksDoneHandlers[jobHandlerName] = onAllTasksDone;
+    } else {
+      delete this.onAllTasksDoneHandlers[jobHandlerName];
+    }
   }
 
   public registerTaskDetailsComponent({
@@ -182,6 +225,7 @@ export default class BackgroundJobsPlugin extends AdminForthPlugin {
   ): Promise<string> {
 
     const handleTask: taskHandlerType = this.taskHandlers[jobHandlerName];
+    const onAllTasksDone = this.onAllTasksDoneHandlers[jobHandlerName];
     if (!handleTask) {
       throw new Error(`No handler registered for jobHandler ${jobHandlerName}. Please register a handler using the registerTaskHandler method before starting a job with this jobHandler.`);
     }
@@ -226,7 +270,7 @@ export default class BackgroundJobsPlugin extends AdminForthPlugin {
 
     await Promise.all(createTaskRecordsPromises);
 
-    this.runProcessingTasks(tasks, jobLevelDb, jobId, handleTask, parrallelLimit);
+    this.runProcessingTasks(tasks, jobLevelDb, jobId, handleTask, parrallelLimit, onAllTasksDone);
     return jobId;
   }
 
@@ -236,6 +280,7 @@ export default class BackgroundJobsPlugin extends AdminForthPlugin {
     jobId: string,
     handleTask: taskHandlerType,
     parrallelLimit: number,
+    onAllTasksDone?: onAllTasksDoneType,
   ) {
     const totalTasks = tasks.length;
     let completedTasks = 0;
@@ -279,7 +324,9 @@ export default class BackgroundJobsPlugin extends AdminForthPlugin {
         await this.setLevelDbTaskStatusField(jobLevelDb, taskIndex.toString(), 'DONE');
         this.adminforth.websocket.publish(`/background-jobs-task-update/${jobId}`, { taskIndex, status: "DONE" });
       } catch (error) {
-        afLogger.error(`Error in handling task ${taskIndex} of job ${jobId}: ${error}`, );
+        const errorMessage = error?.message || 'Unknown error';
+        afLogger.error(`Error in handling task ${taskIndex} of job ${jobId}: ${errorMessage}`, );
+        await this.setJobField(jobId, 'error', errorMessage);
         await this.setLevelDbTaskStatusField(jobLevelDb, taskIndex.toString(), 'FAILED');
         this.adminforth.websocket.publish(`/background-jobs-task-update/${jobId}`, { taskIndex, status: "FAILED" });
         failedTasks++;
@@ -310,6 +357,7 @@ export default class BackgroundJobsPlugin extends AdminForthPlugin {
       })
       this.adminforth.websocket.publish('/background-jobs', { jobId, status: 'DONE', finishedAt: (new Date()).toISOString() });
       this.cleanupJobMutexIfTerminalStatus(jobId, 'DONE');
+      await this.triggerOnAllTasksDone(onAllTasksDone, jobLevelDb, jobId);
     } else if (failedTasks > 0) {
       await this.adminforth.resource(this.getResourceId()).update(jobId, {
         [this.options.statusField]: 'DONE_WITH_ERRORS',
@@ -317,6 +365,7 @@ export default class BackgroundJobsPlugin extends AdminForthPlugin {
       })
       this.adminforth.websocket.publish('/background-jobs', { jobId, status: 'DONE_WITH_ERRORS' });
       this.cleanupJobMutexIfTerminalStatus(jobId, 'DONE_WITH_ERRORS');
+      await this.triggerOnAllTasksDone(onAllTasksDone, jobLevelDb, jobId);
     }
   }
 
@@ -353,6 +402,7 @@ export default class BackgroundJobsPlugin extends AdminForthPlugin {
       return;
     }
     const parrallelLimit = this.jobParallelLimits[jobHandlerName] || 3;
+    const onAllTasksDone = this.onAllTasksDoneHandlers[jobHandlerName];
     
     const unfinishedTasks: taskType[] = [];
     let taskIndex = 0;
@@ -376,7 +426,7 @@ export default class BackgroundJobsPlugin extends AdminForthPlugin {
       }
       taskIndex++;
     }
-    await this.runProcessingTasks(unfinishedTasks, jobLevelDb, job[this.getResourcePk()], handleTask, parrallelLimit);
+    await this.runProcessingTasks(unfinishedTasks, jobLevelDb, job[this.getResourcePk()], handleTask, parrallelLimit, onAllTasksDone);
 
   }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adminforth/background-jobs",
-  "version": "1.11.6",
+  "version": "1.12.0",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "type": "module",