@adminforth/background-jobs 1.4.1 → 1.6.0

package/build.log

@@ -11,5 +11,5 @@ custom/StateToIcon.vue
 custom/tsconfig.json
 custom/utils.ts
 
-sent 12,535 bytes  received 134 bytes  25,338.00 bytes/sec
-total size is 12,050  speedup is 0.95
+sent 13,135 bytes  received 134 bytes  26,538.00 bytes/sec
+total size is 12,650  speedup is 0.95

package/custom/JobInfoPopup.vue

@@ -111,7 +111,7 @@ async function getJobTasks(limit: number = 10, offset: number = 0): Promise<{sta
       },
     });
     if (res.ok) {
-      return res.tasks;
+      return res.data;
     } else {
       console.error('Error fetching job tasks:', res.error);
       return [];

package/custom/StateToIcon.vue

@@ -1,40 +1,53 @@
 <template>
-  <Tooltip v-if="job.status === 'IN_PROGRESS'">
+  <Tooltip v-if="job?.status === 'IN_PROGRESS' || status === 'IN_PROGRESS'">
     <Spinner class="w-5 h-5 ml-2" />
     <template #tooltip>
       {{ t('In progress') }}
     </template>
   </Tooltip>
-  <Tooltip v-else-if="job.status === 'DONE'">
+  <Tooltip v-else-if="job?.status === 'DONE' || status === 'DONE'">
     <IconCheckCircleOutline  class="w-6 h-6 ml-2 text-green-500" />
     <template #tooltip>
       {{ t('Done') }}
     </template>
   </Tooltip>
-  <Tooltip v-else-if="job.status === 'CANCELLED'">
+  <Tooltip v-else-if="job?.status === 'CANCELLED' || status === 'CANCELLED'">
     <IconCloseCircleOutline class="w-6 h-6 ml-2 text-red-500" />
     <template #tooltip>
       {{ t('Cancelled') }}
     </template>
   </Tooltip>
-  <Tooltip v-else-if="job.status === 'DONE_WITH_ERRORS'">
+  <Tooltip v-else-if="job?.status === 'DONE_WITH_ERRORS' || status === 'DONE_WITH_ERRORS'">
     <IconExclamationCircleOutline class="w-6 h-6 ml-2 text-yellow-500" />
     <template #tooltip>
       {{ t('Done with errors') }}
     </template>
   </Tooltip>
+  <Tooltip v-else-if="status === 'FAILED'">
+    <IconCloseCircleOutline class="w-6 h-6 ml-2 text-red-500" />
+    <template #tooltip>
+      {{ t('Failed') }}
+    </template>
+  </Tooltip>
+  <Tooltip v-else-if="status === 'SCHEDULED'">
+    <IconClockOutline class="w-6 h-6 ml-2 text-blue-500" />
+    <template #tooltip>
+      {{ t('Scheduled') }}
+    </template>
+  </Tooltip>
 </template>
 
 
 <script setup lang="ts">
   import type { IJob } from './utils';
-  import { IconCheckCircleOutline, IconCloseCircleOutline, IconExclamationCircleOutline } from '@iconify-prerendered/vue-flowbite';
+  import { IconCheckCircleOutline, IconCloseCircleOutline, IconExclamationCircleOutline, IconClockOutline } from '@iconify-prerendered/vue-flowbite';
   import { Spinner, Tooltip } from '@/afcl';
   import { useI18n } from 'vue-i18n';
 
   const { t } = useI18n();
 
   const props = defineProps<{
-    job: IJob;
+    job?: IJob;
+    status?: 'SCHEDULED' | 'IN_PROGRESS' | 'DONE' | 'FAILED' | 'CANCELLED' | 'DONE_WITH_ERRORS';
   }>();
 </script>

package/dist/custom/JobInfoPopup.vue

@@ -111,7 +111,7 @@ async function getJobTasks(limit: number = 10, offset: number = 0): Promise<{sta
       },
     });
     if (res.ok) {
-      return res.tasks;
+      return res.data;
     } else {
       console.error('Error fetching job tasks:', res.error);
       return [];

package/dist/custom/StateToIcon.vue

@@ -1,40 +1,53 @@
 <template>
-  <Tooltip v-if="job.status === 'IN_PROGRESS'">
+  <Tooltip v-if="job?.status === 'IN_PROGRESS' || status === 'IN_PROGRESS'">
     <Spinner class="w-5 h-5 ml-2" />
     <template #tooltip>
       {{ t('In progress') }}
     </template>
   </Tooltip>
-  <Tooltip v-else-if="job.status === 'DONE'">
+  <Tooltip v-else-if="job?.status === 'DONE' || status === 'DONE'">
     <IconCheckCircleOutline  class="w-6 h-6 ml-2 text-green-500" />
     <template #tooltip>
       {{ t('Done') }}
     </template>
   </Tooltip>
-  <Tooltip v-else-if="job.status === 'CANCELLED'">
+  <Tooltip v-else-if="job?.status === 'CANCELLED' || status === 'CANCELLED'">
     <IconCloseCircleOutline class="w-6 h-6 ml-2 text-red-500" />
     <template #tooltip>
       {{ t('Cancelled') }}
     </template>
   </Tooltip>
-  <Tooltip v-else-if="job.status === 'DONE_WITH_ERRORS'">
+  <Tooltip v-else-if="job?.status === 'DONE_WITH_ERRORS' || status === 'DONE_WITH_ERRORS'">
     <IconExclamationCircleOutline class="w-6 h-6 ml-2 text-yellow-500" />
     <template #tooltip>
       {{ t('Done with errors') }}
     </template>
   </Tooltip>
+  <Tooltip v-else-if="status === 'FAILED'">
+    <IconCloseCircleOutline class="w-6 h-6 ml-2 text-red-500" />
+    <template #tooltip>
+      {{ t('Failed') }}
+    </template>
+  </Tooltip>
+  <Tooltip v-else-if="status === 'SCHEDULED'">
+    <IconClockOutline class="w-6 h-6 ml-2 text-blue-500" />
+    <template #tooltip>
+      {{ t('Scheduled') }}
+    </template>
+  </Tooltip>
 </template>
 
 
 <script setup lang="ts">
   import type { IJob } from './utils';
-  import { IconCheckCircleOutline, IconCloseCircleOutline, IconExclamationCircleOutline } from '@iconify-prerendered/vue-flowbite';
+  import { IconCheckCircleOutline, IconCloseCircleOutline, IconExclamationCircleOutline, IconClockOutline } from '@iconify-prerendered/vue-flowbite';
   import { Spinner, Tooltip } from '@/afcl';
   import { useI18n } from 'vue-i18n';
 
   const { t } = useI18n();
 
   const props = defineProps<{
-    job: IJob;
+    job?: IJob;
+    status?: 'SCHEDULED' | 'IN_PROGRESS' | 'DONE' | 'FAILED' | 'CANCELLED' | 'DONE_WITH_ERRORS';
   }>();
 </script>

package/dist/index.js

@@ -13,7 +13,6 @@ import pLimit from 'p-limit';
 import { Level } from 'level';
 import fs from 'fs/promises';
 import { Mutex } from 'async-mutex';
-const mutex = new Mutex();
 export default class BackgroundJobsPlugin extends AdminForthPlugin {
     constructor(options) {
         super(options, import.meta.url);
@@ -21,6 +20,7 @@ export default class BackgroundJobsPlugin extends AdminForthPlugin {
         this.jobCustomComponents = {};
         this.jobParallelLimits = {};
         this.levelDbInstances = {};
+        this.jobStateMutexes = {};
         this.options = options;
         this.shouldHaveSingleInstancePerWholeApp = () => true;
     }
@@ -39,7 +39,6 @@ export default class BackgroundJobsPlugin extends AdminForthPlugin {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b;
             _super.modifyResourceConfig.call(this, adminforth, resourceConfig);
-            console.log('Modifying resource config for Background Jobs Plugin');
             if (!((_b = (_a = adminforth.config.customization) === null || _a === void 0 ? void 0 : _a.globalInjections) === null || _b === void 0 ? void 0 : _b.header)) {
                 adminforth.config.customization.globalInjections.header = [];
             }
@@ -49,6 +48,12 @@ export default class BackgroundJobsPlugin extends AdminForthPlugin {
                     pluginInstanceId: this.pluginInstanceId,
                 }
             });
+            if (!this.adminforth.config.componentsToExplicitRegister) {
+                this.adminforth.config.componentsToExplicitRegister = [];
+            }
+            this.adminforth.config.componentsToExplicitRegister.push({
+                file: this.componentPath('StateToIcon.vue')
+            });
             if (!this.resourceConfig.hooks) {
                 this.resourceConfig.hooks = {};
             }
@@ -66,6 +71,8 @@ export default class BackgroundJobsPlugin extends AdminForthPlugin {
                     yield jobLevelDb.close();
                     delete this.levelDbInstances[recordId];
                 }
+                // cleanup per-job mutex as well
+                delete this.jobStateMutexes[recordId];
                 //delete level db folder for the job
                 yield fs.rm(levelDbPath, {
                     recursive: true,
@@ -75,6 +82,12 @@ export default class BackgroundJobsPlugin extends AdminForthPlugin {
             }));
         });
     }
+    cleanupJobMutexIfTerminalStatus(jobId, status) {
+        // Keep mutex while job is active to preserve atomicity between concurrent tasks.
+        if (status === 'DONE' || status === 'DONE_WITH_ERRORS' || status === 'CANCELLED') {
+            delete this.jobStateMutexes[jobId];
+        }
+    }
     checkIfFieldInResource(resourceConfig, fieldName, fieldString) {
         if (!fieldName) {
             throw new Error(`Field name for ${fieldString} is not provided. Please check your plugin options.`);
@@ -126,6 +139,12 @@ export default class BackgroundJobsPlugin extends AdminForthPlugin {
             return Promise.resolve(null);
         });
     }
+    getTotalTasksInLevelDb(levelDb) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const count = yield levelDb.get('_meta:count');
+            return count ? parseInt(count, 10) : 0;
+        });
+    }
     registerTaskHandler({ jobHandlerName, handler, parallelLimit = 3, }) {
         //register the handler in a map with jobHandlerName as key and handler as value
         this.taskHandlers[jobHandlerName] = handler;
@@ -171,6 +190,7 @@ export default class BackgroundJobsPlugin extends AdminForthPlugin {
             //create a level db instance for the job with name as jobId
             const jobLevelDb = new Level(`${this.options.levelDbPath || './background-jobs-dbs/'}job_${jobId}`, { valueEncoding: 'json' });
             this.levelDbInstances[jobId] = jobLevelDb;
+            yield jobLevelDb.put('_meta:count', `${tasks.length}`);
             const limit2 = pLimit(parrallelLimit);
             const createTaskRecordsPromises = tasks.map((task, index) => {
                 return limit2(() => this.createLevelDbTaskRecord(jobLevelDb, index.toString(), task.state));
@@ -247,6 +267,7 @@ export default class BackgroundJobsPlugin extends AdminForthPlugin {
                     [this.options.finishedAtField]: (new Date()).toISOString(),
                 });
                 this.adminforth.websocket.publish('/background-jobs', { jobId, status: 'DONE', finishedAt: (new Date()).toISOString() });
+                this.cleanupJobMutexIfTerminalStatus(jobId, 'DONE');
             }
             else if (failedTasks > 0) {
                 yield this.adminforth.resource(this.getResourceId()).update(jobId, {
@@ -254,6 +275,7 @@ export default class BackgroundJobsPlugin extends AdminForthPlugin {
                     [this.options.finishedAtField]: (new Date()).toISOString(),
                 });
                 this.adminforth.websocket.publish('/background-jobs', { jobId, status: 'DONE_WITH_ERRORS' });
+                this.cleanupJobMutexIfTerminalStatus(jobId, 'DONE_WITH_ERRORS');
             }
         });
     }
@@ -344,6 +366,26 @@ export default class BackgroundJobsPlugin extends AdminForthPlugin {
             return JSON.parse(state);
         });
     }
+    updateJobFieldsAtomicly(jobId, updateFunction) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!jobId) {
+                throw new Error('updateJobFieldsAtomicly: jobId is required');
+            }
+            if (typeof updateFunction !== 'function') {
+                throw new Error('updateJobFieldsAtomicly: updateFunction must be a function');
+            }
+            // Ensure updates are atomic per jobId.
+            // Different jobs are not blocked by each other.
+            let mutex = this.jobStateMutexes[jobId];
+            if (!mutex) {
+                mutex = new Mutex();
+                this.jobStateMutexes[jobId] = mutex;
+            }
+            return mutex.runExclusive(() => __awaiter(this, void 0, void 0, function* () {
+                yield updateFunction();
+            }));
+        });
+    }
     processAllUnfinishedJobs() {
         return __awaiter(this, void 0, void 0, function* () {
             const resourceId = this.getResourceId();
@@ -465,7 +507,8 @@ export default class BackgroundJobsPlugin extends AdminForthPlugin {
                     tasks.push(parsedTaskData);
                     taskIndex++;
                 }
-                return { ok: true, tasks };
+                const total = yield this.getTotalTasksInLevelDb(jobLevelDb);
+                return { ok: true, data: { tasks, total } };
             })
         });
     }

package/index.ts

@@ -5,9 +5,7 @@ import { afLogger } from "adminforth";
 import pLimit from 'p-limit';
 import { Level } from 'level';
 import fs from 'fs/promises';
-import {Mutex, MutexInterface, Semaphore, SemaphoreInterface, withTimeout} from 'async-mutex';
-
-const mutex = new Mutex();
+import { Mutex } from 'async-mutex';
 
 type TaskStatus = 'SCHEDULED' | 'IN_PROGRESS' | 'DONE' | 'FAILED';
 type setStateFieldParams = (state: Record<string, any>) => void;
@@ -24,6 +22,7 @@ export default class BackgroundJobsPlugin extends AdminForthPlugin {
   private jobCustomComponents: Record<string, AdminForthComponentDeclarationFull> = {};
   private jobParallelLimits: Record<string, number> = {};
   private levelDbInstances: Record<string, Level> = {};
+  private jobStateMutexes: Record<string, Mutex> = {};
 
   constructor(options: PluginOptions) {
     super(options, import.meta.url);
@@ -42,7 +41,6 @@ export default class BackgroundJobsPlugin extends AdminForthPlugin {
 
   async modifyResourceConfig(adminforth: IAdminForth, resourceConfig: AdminForthResource) {
     super.modifyResourceConfig(adminforth, resourceConfig);
-    console.log('Modifying resource config for Background Jobs Plugin');
     if (!adminforth.config.customization?.globalInjections?.header) {
       adminforth.config.customization.globalInjections.header = [];
     }
@@ -53,6 +51,15 @@ export default class BackgroundJobsPlugin extends AdminForthPlugin {
       }
     });
 
+    if (!this.adminforth.config.componentsToExplicitRegister) {
+      this.adminforth.config.componentsToExplicitRegister = [];
+    }
+    this.adminforth.config.componentsToExplicitRegister.push(
+      {
+        file: this.componentPath('StateToIcon.vue')
+      }
+    );
+
     if (!this.resourceConfig.hooks) {
       this.resourceConfig.hooks = {};
     }
@@ -73,6 +80,9 @@ export default class BackgroundJobsPlugin extends AdminForthPlugin {
         delete this.levelDbInstances[recordId];
       }
 
+      // cleanup per-job mutex as well
+      delete this.jobStateMutexes[recordId];
+
       //delete level db folder for the job
       await fs.rm(levelDbPath, {
         recursive: true,
@@ -83,6 +93,13 @@ export default class BackgroundJobsPlugin extends AdminForthPlugin {
     })
   }
 
+  private cleanupJobMutexIfTerminalStatus(jobId: string, status: string) {
+    // Keep mutex while job is active to preserve atomicity between concurrent tasks.
+    if (status === 'DONE' || status === 'DONE_WITH_ERRORS' || status === 'CANCELLED') {
+      delete this.jobStateMutexes[jobId];
+    }
+  }
+
   private checkIfFieldInResource(resourceConfig: AdminForthResource, fieldName: string, fieldString?: string) {
     if (!fieldName) {
       throw new Error(`Field name for ${fieldString} is not provided. Please check your plugin options.`);
@@ -129,6 +146,11 @@ export default class BackgroundJobsPlugin extends AdminForthPlugin {
     }
     return Promise.resolve(null);
   }
+
+  private async getTotalTasksInLevelDb(levelDb: Level): Promise<number> {
+    const count = await levelDb.get('_meta:count');
+    return count ? parseInt(count, 10) : 0;
+  }
   
   public registerTaskHandler({ jobHandlerName, handler, parallelLimit = 3,
   }:{jobHandlerName: string, handler: taskHandlerType, parallelLimit?: number}) {
@@ -188,7 +210,7 @@ export default class BackgroundJobsPlugin extends AdminForthPlugin {
     //create a level db instance for the job with name as jobId
     const jobLevelDb = new Level(`${this.options.levelDbPath || './background-jobs-dbs/'}job_${jobId}`, { valueEncoding: 'json' });
     this.levelDbInstances[jobId] = jobLevelDb;
-
+    await jobLevelDb.put('_meta:count', `${tasks.length}`);
     const limit2 = pLimit(parrallelLimit);
     const createTaskRecordsPromises = tasks.map((task, index) => {
       return limit2(() => this.createLevelDbTaskRecord(jobLevelDb, index.toString(), task.state));
@@ -279,12 +301,14 @@ export default class BackgroundJobsPlugin extends AdminForthPlugin {
         [this.options.finishedAtField]: (new Date()).toISOString(),
       })
       this.adminforth.websocket.publish('/background-jobs', { jobId, status: 'DONE', finishedAt: (new Date()).toISOString() });
+      this.cleanupJobMutexIfTerminalStatus(jobId, 'DONE');
     } else if (failedTasks > 0) {
       await this.adminforth.resource(this.getResourceId()).update(jobId, {
         [this.options.statusField]: 'DONE_WITH_ERRORS',
         [this.options.finishedAtField]: (new Date()).toISOString(),
       })
       this.adminforth.websocket.publish('/background-jobs', { jobId, status: 'DONE_WITH_ERRORS' });
+      this.cleanupJobMutexIfTerminalStatus(jobId, 'DONE_WITH_ERRORS');
     }
   }
 
@@ -372,6 +396,27 @@ export default class BackgroundJobsPlugin extends AdminForthPlugin {
     return JSON.parse(state);
   }
 
+  public async updateJobFieldsAtomicly(jobId: string, updateFunction: () => Promise<void>) {
+    if (!jobId) {
+      throw new Error('updateJobFieldsAtomicly: jobId is required');
+    }
+    if (typeof updateFunction !== 'function') {
+      throw new Error('updateJobFieldsAtomicly: updateFunction must be a function');
+    }
+
+    // Ensure updates are atomic per jobId.
+    // Different jobs are not blocked by each other.
+    let mutex = this.jobStateMutexes[jobId];
+    if (!mutex) {
+      mutex = new Mutex();
+      this.jobStateMutexes[jobId] = mutex;
+    }
+
+    return mutex.runExclusive(async () => {
+      await updateFunction();
+    });
+  }
+
   private async processAllUnfinishedJobs() {
     const resourceId = this.getResourceId();
     const unprocessedJobs = await this.adminforth.resource(resourceId).list(Filters.EQ(this.options.statusField, 'IN_PROGRESS'));
@@ -494,7 +539,9 @@ export default class BackgroundJobsPlugin extends AdminForthPlugin {
           tasks.push(parsedTaskData);
           taskIndex++;
         }
-        return { ok: true, tasks };
+          
+        const total = await this.getTotalTasksInLevelDb(jobLevelDb);
+        return { ok: true, data: { tasks, total } };
       }
     });
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adminforth/background-jobs",
-  "version": "1.4.1",
+  "version": "1.6.0",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "type": "module",
@@ -20,7 +20,7 @@
   },
   "dependencies": {
     "@vueuse/core": "^14.2.1",
-    "adminforth": "latest",
+    "adminforth": "^2.24.0",
     "async-mutex": "^0.5.0",
     "level": "^10.0.0",
     "p-limit": "^7.3.0"