@orion-js/dogs 4.6.7 → 4.6.8

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Orionjs Team
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/index.cjs

@@ -524,6 +524,17 @@ var JobsRepo = class {
     );
     return result.matchedCount > 0;
   }
+  async rescheduleAfterExecutionGuardAcquisitionFailure(jobId, lockId, nextRunAt) {
+    const result = await this.jobs.updateOne(
+      { _id: jobId, lockId, tries: { $gte: 1 } },
+      {
+        $set: { nextRunAt },
+        $inc: { tries: -1 },
+        $unset: { lockId: "", lockedUntil: "", claimWasStale: "" }
+      }
+    );
+    return result.matchedCount > 0;
+  }
   async deleteEventJob(jobId, lockId) {
     const result = await this.jobs.deleteOne({
       _id: jobId,
@@ -1124,6 +1135,42 @@ var Executor = class {
     }
     return false;
   }
+  async handleExecutionGuardAcquisitionFailure(error, config, jobToRun, context) {
+    context.logger.error(`Error acquiring execution guard for job "${jobToRun.name}"`, { error });
+    const nextRunAt = new Date(Date.now() + (config.executionGuardRetryDelayMs ?? 1e3));
+    try {
+      const didReschedule = await this.jobsRepo.rescheduleAfterExecutionGuardAcquisitionFailure(
+        jobToRun.jobId,
+        jobToRun.lockId,
+        nextRunAt
+      );
+      if (!didReschedule) {
+        context.logger.warn(
+          `Could not requeue job "${jobToRun.name}" after execution guard acquisition failed because its lock is no longer owned`
+        );
+      }
+    } catch (rescheduleError) {
+      context.logger.error(
+        `Error requeueing job "${jobToRun.name}" after execution guard acquisition failed`,
+        { error: rescheduleError }
+      );
+    }
+  }
+  async releaseExecutionGuardLease(lease, jobToRun, context) {
+    try {
+      await lease.release();
+    } catch (error) {
+      context.logger.error(`Error releasing execution guard for job "${jobToRun.name}"`, { error });
+    }
+  }
+  async runGuardedResolver(job, jobToRun, context, lease) {
+    try {
+      return await job.resolve(jobToRun.params, context);
+    } finally {
+      context.clearStaleTimeout();
+      await this.releaseExecutionGuardLease(lease, jobToRun, context);
+    }
+  }
   async executeJob(config, jobToRun, onExecutionStale) {
     const job = this.getJobDefinition(jobToRun, config.jobs);
     if (!job) return;
@@ -1205,13 +1252,36 @@ var Executor = class {
           params: jobToRun.params
         };
         await (0, import_logger3.runWithOrionAsyncContext)(extraContext, async () => {
-          try {
+          let executionGuardLease;
+          if (config.executionGuard) {
             (0, import_logger3.updateOrionAsyncContext)({
               jobName: jobToRun.name,
               jobId: jobToRun.jobId,
               params: jobToRun.params
             });
-            const result = await job.resolve(jobToRun.params, context);
+            try {
+              executionGuardLease = await config.executionGuard.acquire(jobToRun);
+            } catch (error) {
+              context.clearStaleTimeout();
+              await this.handleExecutionGuardAcquisitionFailure(error, config, jobToRun, context);
+              if (executionStatus === "stale") await staleHandlingPromise;
+              return;
+            }
+            if (executionStatus === "stale") {
+              await staleHandlingPromise;
+              await this.releaseExecutionGuardLease(executionGuardLease, jobToRun, context);
+              return;
+            }
+          }
+          try {
+            if (!config.executionGuard) {
+              (0, import_logger3.updateOrionAsyncContext)({
+                jobName: jobToRun.name,
+                jobId: jobToRun.jobId,
+                params: jobToRun.params
+              });
+            }
+            const result = executionGuardLease ? await this.runGuardedResolver(job, jobToRun, context, executionGuardLease) : await job.resolve(jobToRun.params, context);
             context.clearStaleTimeout();
             if (executionStatus === "stale") {
               await staleHandlingPromise;
@@ -1390,7 +1460,11 @@ var WorkerService = class {
       jobs: config.jobs,
       maxTries: config.maxTries,
       maxTriesReachedRetentionMs: config.maxTriesReachedRetentionMs,
-      onMaxTriesReached: config.onMaxTriesReached
+      onMaxTriesReached: config.onMaxTriesReached,
+      ...config.executionGuard ? {
+        executionGuard: config.executionGuard,
+        executionGuardRetryDelayMs: Math.max(config.pollInterval, 1e3)
+      } : {}
     };
     import_logger4.logger.debug(`Running scheduler loop for jobs "${jobNames.join(", ")}"...`);
     let consecutivePartitionMisses = 0;