@adminforth/background-jobs 1.4.0 → 1.5.0

package/build.log

@@ -11,5 +11,5 @@ custom/StateToIcon.vue
 custom/tsconfig.json
 custom/utils.ts
 
-sent 12,501 bytes  received 134 bytes  25,270.00 bytes/sec
-total size is 12,016  speedup is 0.95
+sent 12,535 bytes  received 134 bytes  25,338.00 bytes/sec
+total size is 12,050  speedup is 0.95

package/custom/JobInfoPopup.vue

@@ -1,7 +1,7 @@
 <template> 
     <div class="flex flex-col w-full min-w-96">
       <div class="flex items-center mb-1">
-        <div class="flex flex-col items-start">
+        <div class="flex flex-col items-start justify-end h-12">
           <h2 class="text-lg font-semibold dark:text-white">{{ job.name }}</h2>
           <Tooltip>
             <p class="text-xs text-gray-600 dark:text-gray-200 h-full">{{ t('Created:') }} {{ getTimeAgoString(new Date(job.createdAt)) }}</p>
@@ -10,7 +10,7 @@
             </template>
           </Tooltip>
         </div>
-        <div class="ml-auto flex flex-col items-start">
+        <div class="ml-auto flex flex-col items-start justify-end h-12">
           <div class="flex items-center">
             <p class=" text-gray-800 dark:text-white h-full"> {{  t('Progress:')  }} <span class="font-semibold" >{{ job.progress }}%</span></p>
             <StateToIcon :job="job" />

package/dist/custom/JobInfoPopup.vue

@@ -1,7 +1,7 @@
 <template> 
     <div class="flex flex-col w-full min-w-96">
       <div class="flex items-center mb-1">
-        <div class="flex flex-col items-start">
+        <div class="flex flex-col items-start justify-end h-12">
           <h2 class="text-lg font-semibold dark:text-white">{{ job.name }}</h2>
           <Tooltip>
             <p class="text-xs text-gray-600 dark:text-gray-200 h-full">{{ t('Created:') }} {{ getTimeAgoString(new Date(job.createdAt)) }}</p>
@@ -10,7 +10,7 @@
             </template>
           </Tooltip>
         </div>
-        <div class="ml-auto flex flex-col items-start">
+        <div class="ml-auto flex flex-col items-start justify-end h-12">
           <div class="flex items-center">
             <p class=" text-gray-800 dark:text-white h-full"> {{  t('Progress:')  }} <span class="font-semibold" >{{ job.progress }}%</span></p>
             <StateToIcon :job="job" />

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;
     }
@@ -66,6 +66,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 +77,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.`);
@@ -247,6 +255,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 +263,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 +354,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();

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);
@@ -73,6 +72,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 +85,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.`);
@@ -279,12 +288,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 +383,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'));

package/package.json

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