@adminforth/background-jobs 1.13.1 → 1.14.0

package/build.log

@@ -13,5 +13,5 @@ custom/tsconfig.json
 custom/useBackgroundJobApi.ts
 custom/utils.ts
 
-sent 22,184 bytes  received 172 bytes  44,712.00 bytes/sec
-total size is 21,551  speedup is 0.96
+sent 23,563 bytes  received 172 bytes  47,470.00 bytes/sec
+total size is 22,930  speedup is 0.97

package/custom/GlobalJobApi.vue

@@ -27,6 +27,7 @@ import { useBackgroundJobApi } from './useBackgroundJobApi';
 const jobStore = useBackgroundJobApi();
 
 const dialogRef = ref<any>(null);
+let unsubscribeJobUpdates: (() => void) | undefined;
 
 const props = defineProps<{
   meta: {
@@ -69,7 +70,7 @@ onMounted(() => {
   // @ts-ignore
   window.OpenJobInfoPopup = openJobInfo;
 
-  websocket.subscribe('/background-jobs', (data) => {
+  unsubscribeJobUpdates = websocket.subscribe('/background-jobs-job-update', (data) => {
     if (data.jobId === jobStore.currentJob?.id) {
       if (data.status) { 
         jobStore.updateCurrentJob({ status: data.status });
@@ -90,6 +91,6 @@ onBeforeUnmount(() => {
   // eslint-disable-next-line @typescript-eslint/ban-ts-comment
   // @ts-ignore
   if (window.OpenJobInfoPopup) delete window.OpenJobInfoPopup;
-  websocket.unsubscribe('/background-jobs');
+  unsubscribeJobUpdates?.();
 });
 </script>

package/custom/JobInfoPopup.vue

@@ -69,7 +69,7 @@ import { getTimeAgoString, callAdminForthApi, getCustomComponent} from '@/utils'
 import { useI18n } from 'vue-i18n';
 import StateToIcon from './StateToIcon.vue';
 import { useAdminforth } from '@/adminforth';
-import { onBeforeUnmount, ref, watch } from 'vue';
+import { onBeforeUnmount, onMounted, ref, watch } from 'vue';
 import websocket from '@/websocket';
 import { useBackgroundJobApi } from './useBackgroundJobApi';
 
@@ -115,13 +115,11 @@ function createStateFieldSubscription(
   callback: (data: any) => void,
 ) {
   const paths = getUniqueFieldNames(fieldNames).map(pathFactory);
-  for (const path of paths) {
-    websocket.subscribe(path, callback);
-  }
+  const pathCleanups = paths.map((path) => websocket.subscribe(path, callback));
 
   const unsubscribe = () => {
-    for (const path of paths) {
-      websocket.unsubscribe(path);
+    for (const cleanup of pathCleanups) {
+      cleanup();
     }
     subscriptionCleanups.delete(unsubscribe);
   };
@@ -155,6 +153,50 @@ function handleTaskStateFieldUpdate(data: TaskStateFieldUpdate) {
   };
 }
 
+function handleTaskStatusUpdate(data: { taskIndex: number; status: string }) {
+  if (!jobTasks.value[data.taskIndex]) {
+    return;
+  }
+
+  jobTasks.value[data.taskIndex].status = data.status;
+}
+
+function handleJobUpdate(data: {
+  jobId: string;
+  status?: IJob['status'];
+  progress?: string;
+  finishedAt?: Date;
+  state?: Record<string, any>;
+}) {
+  if (data.jobId !== props.job.id) {
+    return;
+  }
+
+  if (data.status) {
+    props.job.status = data.status;
+  }
+  if (data.progress !== undefined) {
+    props.job.progress = data.progress;
+  }
+  if (data.finishedAt) {
+    props.job.finishedAt = data.finishedAt;
+  }
+  if (data.state) {
+    props.job.state = {
+      ...props.job.state,
+      ...data.state,
+    };
+  }
+  if (jobStore.currentJob?.id === props.job.id) {
+    jobStore.updateCurrentJob({
+      status: props.job.status,
+      progress: props.job.progress,
+      finishedAt: props.job.finishedAt,
+      state: props.job.state,
+    });
+  }
+}
+
 function subscribeToJobStateFields(fieldNames: string[]) {
   return createStateFieldSubscription(
     fieldNames,
@@ -241,6 +283,13 @@ watch(
   { immediate: true }
 );
 
+onMounted(() => {
+  const taskStatusPath = `/background-jobs-task-update/${props.job.id}`;
+  subscriptionCleanups.add(websocket.subscribe(taskStatusPath, handleTaskStatusUpdate));
+
+  subscriptionCleanups.add(websocket.subscribe('/background-jobs-job-update', handleJobUpdate));
+});
+
 onBeforeUnmount(() => {
   for (const unsubscribe of Array.from(subscriptionCleanups)) {
     unsubscribe();

package/custom/NavbarJobs.vue

@@ -3,7 +3,7 @@
     <div class="cursor-pointer hover:scale-110 transition-transform" @click="isDropdownOpen = !isDropdownOpen">
       <div class="relative flex items-center justify-center" v-if="jobs.length > 0">
         <Tooltip>
-          <IconBriefcaseSolid class="w-7 h-7 text-lightNavbarIcons dark:text-darkNavbarIcons" />
+          <IconCheckCircleOutline class="w-7 h-7 text-lightNavbarIcons dark:text-darkNavbarIcons" />
           <template #tooltip>
             {{ t('All jobs completed') }}
           </template>
@@ -48,8 +48,8 @@
 <script setup lang="ts">
   import type { AdminUser } from 'adminforth';
   import { onMounted, onUnmounted, ref, computed } from 'vue';
-  import { IconCheckCircleOutline, IconBriefcaseSolid } from '@iconify-prerendered/vue-flowbite';
   import { Tooltip } from '@/afcl';
+  import { IconCheckCircleOutline } from '@iconify-prerendered/vue-flowbite';
   import { useI18n } from 'vue-i18n';
   import JobsList from './JobsList.vue';
   import type { IJob } from './utils';
@@ -69,6 +69,7 @@
   const isDropdownOpen = ref(false);
   const jobs = ref<IJob[]>([]);
   const dropdownRef = ref<HTMLElement | null>(null);
+  let unsubscribeJobUpdates: (() => void) | undefined;
 
   onClickOutside(dropdownRef, () => {
     isDropdownOpen.value = false;
@@ -85,7 +86,7 @@
 
 
   onMounted(async () => {
-    websocket.subscribe('/background-jobs', (data) => {
+    unsubscribeJobUpdates = websocket.subscribe('/background-jobs-job-update', (data) => {
       const jobIndex = jobs.value.findIndex(job => job.id === data.jobId);
       if (jobIndex !== -1) {
         if (data.status) {
@@ -130,7 +131,7 @@
 
 
   onUnmounted(() => {
-    websocket.unsubscribe('/background-jobs');
+    unsubscribeJobUpdates?.();
   });
 
 </script>
@@ -147,4 +148,4 @@
     opacity: 0;
   }
 }
-</style>
+</style>

package/dist/custom/GlobalJobApi.vue

@@ -27,6 +27,7 @@ import { useBackgroundJobApi } from './useBackgroundJobApi';
 const jobStore = useBackgroundJobApi();
 
 const dialogRef = ref<any>(null);
+let unsubscribeJobUpdates: (() => void) | undefined;
 
 const props = defineProps<{
   meta: {
@@ -69,7 +70,7 @@ onMounted(() => {
   // @ts-ignore
   window.OpenJobInfoPopup = openJobInfo;
 
-  websocket.subscribe('/background-jobs', (data) => {
+  unsubscribeJobUpdates = websocket.subscribe('/background-jobs-job-update', (data) => {
     if (data.jobId === jobStore.currentJob?.id) {
       if (data.status) { 
         jobStore.updateCurrentJob({ status: data.status });
@@ -90,6 +91,6 @@ onBeforeUnmount(() => {
   // eslint-disable-next-line @typescript-eslint/ban-ts-comment
   // @ts-ignore
   if (window.OpenJobInfoPopup) delete window.OpenJobInfoPopup;
-  websocket.unsubscribe('/background-jobs');
+  unsubscribeJobUpdates?.();
 });
 </script>

package/dist/custom/JobInfoPopup.vue

@@ -69,7 +69,7 @@ import { getTimeAgoString, callAdminForthApi, getCustomComponent} from '@/utils'
 import { useI18n } from 'vue-i18n';
 import StateToIcon from './StateToIcon.vue';
 import { useAdminforth } from '@/adminforth';
-import { onBeforeUnmount, ref, watch } from 'vue';
+import { onBeforeUnmount, onMounted, ref, watch } from 'vue';
 import websocket from '@/websocket';
 import { useBackgroundJobApi } from './useBackgroundJobApi';
 
@@ -115,13 +115,11 @@ function createStateFieldSubscription(
   callback: (data: any) => void,
 ) {
   const paths = getUniqueFieldNames(fieldNames).map(pathFactory);
-  for (const path of paths) {
-    websocket.subscribe(path, callback);
-  }
+  const pathCleanups = paths.map((path) => websocket.subscribe(path, callback));
 
   const unsubscribe = () => {
-    for (const path of paths) {
-      websocket.unsubscribe(path);
+    for (const cleanup of pathCleanups) {
+      cleanup();
     }
     subscriptionCleanups.delete(unsubscribe);
   };
@@ -155,6 +153,50 @@ function handleTaskStateFieldUpdate(data: TaskStateFieldUpdate) {
   };
 }
 
+function handleTaskStatusUpdate(data: { taskIndex: number; status: string }) {
+  if (!jobTasks.value[data.taskIndex]) {
+    return;
+  }
+
+  jobTasks.value[data.taskIndex].status = data.status;
+}
+
+function handleJobUpdate(data: {
+  jobId: string;
+  status?: IJob['status'];
+  progress?: string;
+  finishedAt?: Date;
+  state?: Record<string, any>;
+}) {
+  if (data.jobId !== props.job.id) {
+    return;
+  }
+
+  if (data.status) {
+    props.job.status = data.status;
+  }
+  if (data.progress !== undefined) {
+    props.job.progress = data.progress;
+  }
+  if (data.finishedAt) {
+    props.job.finishedAt = data.finishedAt;
+  }
+  if (data.state) {
+    props.job.state = {
+      ...props.job.state,
+      ...data.state,
+    };
+  }
+  if (jobStore.currentJob?.id === props.job.id) {
+    jobStore.updateCurrentJob({
+      status: props.job.status,
+      progress: props.job.progress,
+      finishedAt: props.job.finishedAt,
+      state: props.job.state,
+    });
+  }
+}
+
 function subscribeToJobStateFields(fieldNames: string[]) {
   return createStateFieldSubscription(
     fieldNames,
@@ -241,6 +283,13 @@ watch(
   { immediate: true }
 );
 
+onMounted(() => {
+  const taskStatusPath = `/background-jobs-task-update/${props.job.id}`;
+  subscriptionCleanups.add(websocket.subscribe(taskStatusPath, handleTaskStatusUpdate));
+
+  subscriptionCleanups.add(websocket.subscribe('/background-jobs-job-update', handleJobUpdate));
+});
+
 onBeforeUnmount(() => {
   for (const unsubscribe of Array.from(subscriptionCleanups)) {
     unsubscribe();

package/dist/custom/NavbarJobs.vue

@@ -3,7 +3,7 @@
     <div class="cursor-pointer hover:scale-110 transition-transform" @click="isDropdownOpen = !isDropdownOpen">
       <div class="relative flex items-center justify-center" v-if="jobs.length > 0">
         <Tooltip>
-          <IconBriefcaseSolid class="w-7 h-7 text-lightNavbarIcons dark:text-darkNavbarIcons" />
+          <IconCheckCircleOutline class="w-7 h-7 text-lightNavbarIcons dark:text-darkNavbarIcons" />
           <template #tooltip>
             {{ t('All jobs completed') }}
           </template>
@@ -48,8 +48,8 @@
 <script setup lang="ts">
   import type { AdminUser } from 'adminforth';
   import { onMounted, onUnmounted, ref, computed } from 'vue';
-  import { IconCheckCircleOutline, IconBriefcaseSolid } from '@iconify-prerendered/vue-flowbite';
   import { Tooltip } from '@/afcl';
+  import { IconCheckCircleOutline } from '@iconify-prerendered/vue-flowbite';
   import { useI18n } from 'vue-i18n';
   import JobsList from './JobsList.vue';
   import type { IJob } from './utils';
@@ -69,6 +69,7 @@
   const isDropdownOpen = ref(false);
   const jobs = ref<IJob[]>([]);
   const dropdownRef = ref<HTMLElement | null>(null);
+  let unsubscribeJobUpdates: (() => void) | undefined;
 
   onClickOutside(dropdownRef, () => {
     isDropdownOpen.value = false;
@@ -85,7 +86,7 @@
 
 
   onMounted(async () => {
-    websocket.subscribe('/background-jobs', (data) => {
+    unsubscribeJobUpdates = websocket.subscribe('/background-jobs-job-update', (data) => {
       const jobIndex = jobs.value.findIndex(job => job.id === data.jobId);
       if (jobIndex !== -1) {
         if (data.status) {
@@ -130,7 +131,7 @@
 
 
   onUnmounted(() => {
-    websocket.unsubscribe('/background-jobs');
+    unsubscribeJobUpdates?.();
   });
 
 </script>
@@ -147,4 +148,4 @@
     opacity: 0;
   }
 }
-</style>
+</style>

package/dist/index.js

@@ -25,6 +25,7 @@ export default class BackgroundJobsPlugin extends AdminForthPlugin {
         this.jobParallelLimits = {};
         this.levelDbInstances = {};
         this.jobStateMutexes = {};
+        this.deprecatedWarningsShown = new Set();
         this.options = options;
         this.shouldHaveSingleInstancePerWholeApp = () => true;
     }
@@ -190,6 +191,13 @@ export default class BackgroundJobsPlugin extends AdminForthPlugin {
             });
         }
     }
+    warnDeprecatedOnce(key, message) {
+        if (this.deprecatedWarningsShown.has(key)) {
+            return;
+        }
+        this.deprecatedWarningsShown.add(key);
+        afLogger.warn(message);
+    }
     triggerOnAllTasksDone(onAllTasksDone, levelDb, jobId) {
         return __awaiter(this, void 0, void 0, function* () {
             if (!onAllTasksDone) {
@@ -219,8 +227,8 @@ export default class BackgroundJobsPlugin extends AdminForthPlugin {
     registerTaskDetailsComponent({ jobHandlerName, component, }) {
         this.jobCustomComponents[jobHandlerName] = component;
     }
-    startNewJob(jobName, adminUser, tasks, jobHandlerName) {
-        return __awaiter(this, void 0, void 0, function* () {
+    startNewJob(jobName_1, adminUser_1, tasks_1, jobHandlerName_1) {
+        return __awaiter(this, arguments, void 0, function* (jobName, adminUser, tasks, jobHandlerName, initialState = {}) {
             const handleTask = this.taskHandlers[jobHandlerName];
             const onAllTasksDone = this.onAllTasksDoneHandlers[jobHandlerName];
             if (!handleTask) {
@@ -235,7 +243,7 @@ export default class BackgroundJobsPlugin extends AdminForthPlugin {
                 [this.options.progressField]: 0,
                 [this.options.statusField]: 'IN_PROGRESS',
                 [this.options.jobHandlerField]: jobHandlerName,
-                [this.options.stateField]: '{}'
+                [this.options.stateField]: initialState
             };
             const creationResult = yield this.adminforth.resource(this.getResourceId()).create(objectToSave);
             let createdRecord = null;
@@ -246,7 +254,7 @@ export default class BackgroundJobsPlugin extends AdminForthPlugin {
                 throw new Error(`Failed to create a record for the job. Error: ${creationResult.error}`);
             }
             const jobId = createdRecord[this.getResourcePk()];
-            this.adminforth.websocket.publish('/background-jobs', {
+            this.adminforth.websocket.publish('/background-jobs-job-update', {
                 jobId,
                 status: 'IN_PROGRESS',
                 name: jobName,
@@ -288,19 +296,34 @@ export default class BackgroundJobsPlugin extends AdminForthPlugin {
                     afLogger.info(`Job ${jobId} was cancelled. Skipping task ${taskIndex}.`);
                     return;
                 }
-                //define the setTaskStateField and getTaskStateField functions to pass to the task
-                const setTaskStateField = (state) => __awaiter(this, void 0, void 0, function* () {
-                    yield this.setLevelDbTaskStateField(jobLevelDb, taskIndex.toString(), state);
-                    this.publishTaskStateFields(jobId, taskIndex, state);
-                });
-                const getTaskStateField = () => __awaiter(this, void 0, void 0, function* () {
+                const getState = () => __awaiter(this, void 0, void 0, function* () {
                     return yield this.getLevelDbTaskStateField(jobLevelDb, taskIndex.toString());
                 });
+                const setTaskStateField = (fieldNameOrState, value) => __awaiter(this, void 0, void 0, function* () {
+                    if (typeof fieldNameOrState === 'string') {
+                        const state = yield getState();
+                        const updatedState = Object.assign(Object.assign({}, state), { [fieldNameOrState]: value });
+                        yield this.setLevelDbTaskStateField(jobLevelDb, taskIndex.toString(), updatedState);
+                        this.publishTaskStateFields(jobId, taskIndex, { [fieldNameOrState]: value });
+                        return;
+                    }
+                    this.warnDeprecatedOnce('setTaskStateField-object', 'BackgroundJobsPlugin: setTaskStateField(stateObject) is deprecated and will be removed soon. Use setTaskStateField(fieldName: string, value: any) instead. Use getState() when you need the full task state.');
+                    yield this.setLevelDbTaskStateField(jobLevelDb, taskIndex.toString(), fieldNameOrState);
+                    this.publishTaskStateFields(jobId, taskIndex, fieldNameOrState);
+                });
+                const getTaskStateField = (fieldName) => __awaiter(this, void 0, void 0, function* () {
+                    const state = yield getState();
+                    if (typeof fieldName === 'string') {
+                        return state[fieldName];
+                    }
+                    this.warnDeprecatedOnce('getTaskStateField-no-args', 'BackgroundJobsPlugin: getTaskStateField() without a field name is deprecated and will be removed soon. Use getTaskStateField(fieldName: string) for one field, or getState() for the full task state.');
+                    return state;
+                });
                 yield this.setLevelDbTaskStatusField(jobLevelDb, taskIndex.toString(), 'IN_PROGRESS');
                 this.adminforth.websocket.publish(`/background-jobs-task-update/${jobId}`, { taskIndex, status: "IN_PROGRESS" });
                 //handling the task 
                 try {
-                    yield handleTask({ jobId, setTaskStateField, getTaskStateField });
+                    yield handleTask({ jobId, setTaskStateField, getTaskStateField, getState });
                     //Set task status to completed in level db
                     yield this.setLevelDbTaskStatusField(jobLevelDb, taskIndex.toString(), 'DONE');
                     this.adminforth.websocket.publish(`/background-jobs-task-update/${jobId}`, { taskIndex, status: "DONE" });
@@ -308,7 +331,7 @@ export default class BackgroundJobsPlugin extends AdminForthPlugin {
                 catch (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.setJobStateField(jobId, 'error', errorMessage);
                     yield this.setLevelDbTaskStatusField(jobLevelDb, taskIndex.toString(), 'FAILED');
                     this.adminforth.websocket.publish(`/background-jobs-task-update/${jobId}`, { taskIndex, status: "FAILED" });
                     failedTasks++;
@@ -335,7 +358,7 @@ export default class BackgroundJobsPlugin extends AdminForthPlugin {
                     [this.options.statusField]: 'DONE',
                     [this.options.finishedAtField]: (new Date()).toISOString(),
                 });
-                this.adminforth.websocket.publish('/background-jobs', { jobId, status: 'DONE', finishedAt: (new Date()).toISOString() });
+                this.adminforth.websocket.publish('/background-jobs-job-update', { jobId, status: 'DONE', finishedAt: (new Date()).toISOString() });
                 this.cleanupJobMutexIfTerminalStatus(jobId, 'DONE');
                 yield this.triggerOnAllTasksDone(onAllTasksDone, jobLevelDb, jobId);
             }
@@ -344,7 +367,7 @@ export default class BackgroundJobsPlugin extends AdminForthPlugin {
                     [this.options.statusField]: 'DONE_WITH_ERRORS',
                     [this.options.finishedAtField]: (new Date()).toISOString(),
                 });
-                this.adminforth.websocket.publish('/background-jobs', { jobId, status: 'DONE_WITH_ERRORS' });
+                this.adminforth.websocket.publish('/background-jobs-job-update', { jobId, status: 'DONE_WITH_ERRORS' });
                 this.cleanupJobMutexIfTerminalStatus(jobId, 'DONE_WITH_ERRORS');
                 yield this.triggerOnAllTasksDone(onAllTasksDone, jobLevelDb, jobId);
             }
@@ -367,7 +390,7 @@ export default class BackgroundJobsPlugin extends AdminForthPlugin {
             yield this.adminforth.resource(this.getResourceId()).update(jobId, {
                 [this.options.progressField]: progress,
             });
-            this.adminforth.websocket.publish('/background-jobs', { jobId, progress });
+            this.adminforth.websocket.publish('/background-jobs-job-update', { jobId, progress });
             return completedTasks;
         });
     }
@@ -411,31 +434,40 @@ export default class BackgroundJobsPlugin extends AdminForthPlugin {
             yield this.runProcessingTasks(unfinishedTasks, jobLevelDb, job[this.getResourcePk()], handleTask, parrallelLimit, onAllTasksDone);
         });
     }
-    setJobField(jobId, key, value) {
+    setJobStateField(jobId, key, value) {
         return __awaiter(this, void 0, void 0, function* () {
             const jobRecord = yield this.adminforth.resource(this.getResourceId()).get(Filters.EQ(this.getResourcePk(), jobId));
             const state = jobRecord[this.options.stateField];
-            const parsedState = JSON.parse(state);
-            parsedState[key] = value;
+            state[key] = value;
             yield this.adminforth.resource(this.getResourceId()).update(jobId, {
-                [this.options.stateField]: JSON.stringify(parsedState),
+                [this.options.stateField]: state,
             });
             this.publishJobStateField(jobId, key, value);
         });
     }
-    getJobField(jobId, key) {
+    getJobStateField(jobId, key) {
         return __awaiter(this, void 0, void 0, function* () {
             const jobRecord = yield this.adminforth.resource(this.getResourceId()).get(Filters.EQ(this.getResourcePk(), jobId));
             const state = jobRecord[this.options.stateField];
-            const parsedState = JSON.parse(state);
-            return parsedState[key];
+            return state[key];
         });
     }
     getJobState(jobId) {
         return __awaiter(this, void 0, void 0, function* () {
             const jobRecord = yield this.adminforth.resource(this.getResourceId()).get(Filters.EQ(this.getResourcePk(), jobId));
-            const state = jobRecord[this.options.stateField];
-            return JSON.parse(state);
+            return jobRecord[this.options.stateField];
+        });
+    }
+    setJobField(jobId, key, value) {
+        return __awaiter(this, void 0, void 0, function* () {
+            this.warnDeprecatedOnce('setJobField', 'BackgroundJobsPlugin: setJobField(jobId, key, value) is deprecated and will be removed soon. Use setJobStateField(jobId, fieldName: string, value: any) instead.');
+            return this.setJobStateField(jobId, key, value);
+        });
+    }
+    getJobField(jobId, key) {
+        return __awaiter(this, void 0, void 0, function* () {
+            this.warnDeprecatedOnce('getJobField', 'BackgroundJobsPlugin: getJobField(jobId, key) is deprecated and will be removed soon. Use getJobStateField(jobId, fieldName: string) instead.');
+            return this.getJobStateField(jobId, key);
         });
     }
     updateJobFieldsAtomically(jobId, updateFunction) {
@@ -504,7 +536,6 @@ export default class BackgroundJobsPlugin extends AdminForthPlugin {
                         createdAt: job[this.options.createdAtField],
                         finishedAt: job[this.options.finishedAtField] || null,
                         status: job[this.options.statusField],
-                        state: JSON.parse(job[this.options.stateField]),
                         progress: job[this.options.progressField],
                         customComponent: this.jobCustomComponents[job[this.options.jobHandlerField]],
                     };
@@ -527,7 +558,7 @@ export default class BackgroundJobsPlugin extends AdminForthPlugin {
                     createdAt: job[this.options.createdAtField],
                     finishedAt: job[this.options.finishedAtField] || null,
                     status: job[this.options.statusField],
-                    state: JSON.parse(job[this.options.stateField]),
+                    state: job[this.options.stateField],
                     progress: job[this.options.progressField],
                     customComponent: this.jobCustomComponents[job[this.options.jobHandlerField]],
                 };
@@ -549,7 +580,7 @@ export default class BackgroundJobsPlugin extends AdminForthPlugin {
                         [this.options.statusField]: 'CANCELLED',
                         [this.options.finishedAtField]: (new Date()).toISOString(),
                     });
-                    this.adminforth.websocket.publish('/background-jobs', {
+                    this.adminforth.websocket.publish('/background-jobs-job-update', {
                         jobId,
                         status: 'CANCELLED',
                     });

package/index.ts

@@ -8,9 +8,16 @@ import fs from 'fs/promises';
 import { Mutex } from 'async-mutex';
 
 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 setStateFieldParams = {
+  (fieldName: string, value: any): Promise<void>;
+  (state: Record<string, any>): Promise<void>;
+};
+type getStateFieldParams = {
+  (fieldName: string): Promise<any>;
+  (): Promise<Record<string, any>>;
+};
+type getStateParams = () => Promise<Record<string, any>>;
+type taskHandlerType = ( { jobId, setTaskStateField, getTaskStateField, getState }: { jobId: string; setTaskStateField: setStateFieldParams; getTaskStateField: getStateFieldParams; getState: getStateParams } ) => Promise<void>;
 type allTasksDoneStatusType = {
   jobId: string;
   failedTasks: number;
@@ -34,6 +41,7 @@ export default class BackgroundJobsPlugin extends AdminForthPlugin {
   private jobParallelLimits: Record<string, number> = {};
   private levelDbInstances: Record<string, Level> = {};
   private jobStateMutexes: Record<string, Mutex> = {};
+  private deprecatedWarningsShown = new Set<string>();
 
   constructor(options: PluginOptions) {
     super(options, import.meta.url);
@@ -207,6 +215,15 @@ export default class BackgroundJobsPlugin extends AdminForthPlugin {
     }
   }
 
+  private warnDeprecatedOnce(key: string, message: string) {
+    if (this.deprecatedWarningsShown.has(key)) {
+      return;
+    }
+
+    this.deprecatedWarningsShown.add(key);
+    afLogger.warn(message);
+  }
+
   private async triggerOnAllTasksDone(onAllTasksDone: onAllTasksDoneType | undefined, levelDb: Level, jobId: string) {
     if (!onAllTasksDone) {
       return;
@@ -245,6 +262,7 @@ export default class BackgroundJobsPlugin extends AdminForthPlugin {
     adminUser: AdminUser,
     tasks: taskType[],
     jobHandlerName: string,
+    initialState: Record<string, any> = {},
   ): Promise<string> {
 
     const handleTask: taskHandlerType = this.taskHandlers[jobHandlerName];
@@ -261,7 +279,7 @@ export default class BackgroundJobsPlugin extends AdminForthPlugin {
       [this.options.progressField]: 0,
       [this.options.statusField]: 'IN_PROGRESS',
       [this.options.jobHandlerField]: jobHandlerName,
-      [this.options.stateField]: '{}'
+      [this.options.stateField]: initialState
     }
 
     const creationResult = await this.adminforth.resource(this.getResourceId()).create(objectToSave);
@@ -273,7 +291,7 @@ export default class BackgroundJobsPlugin extends AdminForthPlugin {
     }    
     const jobId = createdRecord[this.getResourcePk()];
     
-    this.adminforth.websocket.publish('/background-jobs', { 
+    this.adminforth.websocket.publish('/background-jobs-job-update', { 
       jobId, 
       status: 'IN_PROGRESS', 
       name: jobName,
@@ -327,21 +345,47 @@ export default class BackgroundJobsPlugin extends AdminForthPlugin {
         return;
       }
 
-      //define the setTaskStateField and getTaskStateField functions to pass to the task
-      const setTaskStateField = async (state: Record<string, any>) => {
-        await this.setLevelDbTaskStateField(jobLevelDb, taskIndex.toString(), state);
-        this.publishTaskStateFields(jobId, taskIndex, state);
-      }
-      const getTaskStateField = async () => {
+      const getState = async () => {
         return await this.getLevelDbTaskStateField(jobLevelDb, taskIndex.toString());
       }
+      const setTaskStateField: setStateFieldParams = async (fieldNameOrState: string | Record<string, any>, value?: any) => {
+        if (typeof fieldNameOrState === 'string') {
+          const state = await getState();
+          const updatedState = {
+            ...state,
+            [fieldNameOrState]: value,
+          };
+          await this.setLevelDbTaskStateField(jobLevelDb, taskIndex.toString(), updatedState);
+          this.publishTaskStateFields(jobId, taskIndex, { [fieldNameOrState]: value });
+          return;
+        }
+
+        this.warnDeprecatedOnce(
+          'setTaskStateField-object',
+          'BackgroundJobsPlugin: setTaskStateField(stateObject) is deprecated and will be removed soon. Use setTaskStateField(fieldName: string, value: any) instead. Use getState() when you need the full task state.',
+        );
+        await this.setLevelDbTaskStateField(jobLevelDb, taskIndex.toString(), fieldNameOrState);
+        this.publishTaskStateFields(jobId, taskIndex, fieldNameOrState);
+      }
+      const getTaskStateField: getStateFieldParams = async (fieldName?: string) => {
+        const state = await getState();
+        if (typeof fieldName === 'string') {
+          return state[fieldName];
+        }
+
+        this.warnDeprecatedOnce(
+          'getTaskStateField-no-args',
+          'BackgroundJobsPlugin: getTaskStateField() without a field name is deprecated and will be removed soon. Use getTaskStateField(fieldName: string) for one field, or getState() for the full task state.',
+        );
+        return state;
+      }
 
       await this.setLevelDbTaskStatusField(jobLevelDb, taskIndex.toString(), 'IN_PROGRESS');
       this.adminforth.websocket.publish(`/background-jobs-task-update/${jobId}`, { taskIndex, status: "IN_PROGRESS" });
 
       //handling the task 
       try {
-        await handleTask({ jobId, setTaskStateField, getTaskStateField });
+        await handleTask({ jobId, setTaskStateField, getTaskStateField, getState });
 
         //Set task status to completed in level db
         await this.setLevelDbTaskStatusField(jobLevelDb, taskIndex.toString(), 'DONE');
@@ -349,7 +393,7 @@ export default class BackgroundJobsPlugin extends AdminForthPlugin {
       } catch (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.setJobStateField(jobId, 'error', errorMessage);
         await this.setLevelDbTaskStatusField(jobLevelDb, taskIndex.toString(), 'FAILED');
         this.adminforth.websocket.publish(`/background-jobs-task-update/${jobId}`, { taskIndex, status: "FAILED" });
         failedTasks++;
@@ -378,7 +422,7 @@ export default class BackgroundJobsPlugin extends AdminForthPlugin {
         [this.options.statusField]: 'DONE',
         [this.options.finishedAtField]: (new Date()).toISOString(),
       })
-      this.adminforth.websocket.publish('/background-jobs', { jobId, status: 'DONE', finishedAt: (new Date()).toISOString() });
+      this.adminforth.websocket.publish('/background-jobs-job-update', { jobId, status: 'DONE', finishedAt: (new Date()).toISOString() });
       this.cleanupJobMutexIfTerminalStatus(jobId, 'DONE');
       await this.triggerOnAllTasksDone(onAllTasksDone, jobLevelDb, jobId);
     } else if (failedTasks > 0) {
@@ -386,7 +430,7 @@ export default class BackgroundJobsPlugin extends AdminForthPlugin {
         [this.options.statusField]: 'DONE_WITH_ERRORS',
         [this.options.finishedAtField]: (new Date()).toISOString(),
       })
-      this.adminforth.websocket.publish('/background-jobs', { jobId, status: 'DONE_WITH_ERRORS' });
+      this.adminforth.websocket.publish('/background-jobs-job-update', { jobId, status: 'DONE_WITH_ERRORS' });
       this.cleanupJobMutexIfTerminalStatus(jobId, 'DONE_WITH_ERRORS');
       await this.triggerOnAllTasksDone(onAllTasksDone, jobLevelDb, jobId);
     }
@@ -407,7 +451,7 @@ export default class BackgroundJobsPlugin extends AdminForthPlugin {
     await this.adminforth.resource(this.getResourceId()).update(jobId, {
       [this.options.progressField]: progress,
     })
-    this.adminforth.websocket.publish('/background-jobs', { jobId, progress });
+    this.adminforth.websocket.publish('/background-jobs-job-update', { jobId, progress });
     return completedTasks;
   }
 
@@ -453,28 +497,41 @@ export default class BackgroundJobsPlugin extends AdminForthPlugin {
 
   }
 
-  public async setJobField(jobId: string, key: string, value: any) {
+  public async setJobStateField(jobId: string, key: string, value: any) {
     const jobRecord = await this.adminforth.resource(this.getResourceId()).get(Filters.EQ(this.getResourcePk(), jobId));
     const state = jobRecord[this.options.stateField];
-    const parsedState = JSON.parse(state);
-    parsedState[key] = value;
+    state[key] = value;
     await this.adminforth.resource(this.getResourceId()).update(jobId, {
-      [this.options.stateField]: JSON.stringify(parsedState),
+      [this.options.stateField]: state,
     });
     this.publishJobStateField(jobId, key, value);
   }
 
-  public async getJobField(jobId: string, key: string) {
+  public async getJobStateField(jobId: string, key: string) {
     const jobRecord = await this.adminforth.resource(this.getResourceId()).get(Filters.EQ(this.getResourcePk(), jobId));
     const state = jobRecord[this.options.stateField];
-    const parsedState = JSON.parse(state);
-    return parsedState[key];
+    return state[key];
   }
 
   public async getJobState(jobId: string) {
     const jobRecord = await this.adminforth.resource(this.getResourceId()).get(Filters.EQ(this.getResourcePk(), jobId));
-    const state = jobRecord[this.options.stateField];
-    return JSON.parse(state);
+    return jobRecord[this.options.stateField];
+  }
+
+  public async setJobField(jobId: string, key: string, value: any) {
+    this.warnDeprecatedOnce(
+      'setJobField',
+      'BackgroundJobsPlugin: setJobField(jobId, key, value) is deprecated and will be removed soon. Use setJobStateField(jobId, fieldName: string, value: any) instead.',
+    );
+    return this.setJobStateField(jobId, key, value);
+  }
+
+  public async getJobField(jobId: string, key: string) {
+    this.warnDeprecatedOnce(
+      'getJobField',
+      'BackgroundJobsPlugin: getJobField(jobId, key) is deprecated and will be removed soon. Use getJobStateField(jobId, fieldName: string) instead.',
+    );
+    return this.getJobStateField(jobId, key);
   }
 
   public async updateJobFieldsAtomically(jobId: string, updateFunction: () => Promise<void>) {
@@ -547,7 +604,6 @@ export default class BackgroundJobsPlugin extends AdminForthPlugin {
             createdAt: job[this.options.createdAtField],
             finishedAt: job[this.options.finishedAtField] || null,
             status: job[this.options.statusField],
-            state: JSON.parse(job[this.options.stateField]),
             progress: job[this.options.progressField],
             customComponent: this.jobCustomComponents[job[this.options.jobHandlerField]],
           }
@@ -572,7 +628,7 @@ export default class BackgroundJobsPlugin extends AdminForthPlugin {
           createdAt: job[this.options.createdAtField],
           finishedAt: job[this.options.finishedAtField] || null,
           status: job[this.options.statusField],
-          state: JSON.parse(job[this.options.stateField]),
+          state: job[this.options.stateField],
           progress: job[this.options.progressField],
           customComponent: this.jobCustomComponents[job[this.options.jobHandlerField]],
         };
@@ -596,7 +652,7 @@ export default class BackgroundJobsPlugin extends AdminForthPlugin {
             [this.options.statusField]: 'CANCELLED',
             [this.options.finishedAtField]: (new Date()).toISOString(),
           });
-          this.adminforth.websocket.publish('/background-jobs', { 
+          this.adminforth.websocket.publish('/background-jobs-job-update', { 
             jobId, 
             status: 'CANCELLED', 
           });

package/package.json

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