@nexrender/worker 1.42.3 → 1.43.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nexrender/worker",
-  "version": "1.42.3",
+  "version": "1.43.0",
   "author": "inlife",
   "main": "src/index.js",
   "scripts": {
@@ -11,13 +11,13 @@
   },
   "pkg": {
     "targets": [
-      "node14-macos-x64",
-      "node14-win-x64"
+      "node18-macos-x64",
+      "node18-win-x64"
     ]
   },
   "dependencies": {
     "@nexrender/api": "^1.42.2",
-    "@nexrender/core": "^1.42.2",
+    "@nexrender/core": "^1.43.0",
     "@nexrender/types": "^1.42.2",
     "arg": "^4.1.0",
     "chalk": "^2.4.2",
@@ -26,5 +26,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "148263d6f733edb7058cfd8e05af8114a1ce71a8"
+  "gitHead": "5a13aa8b32ad67c24100311be671224cfdb525a2"
 }

package/readme.md

@@ -81,6 +81,8 @@ Available settings (almost same as for `nexrender-core`):
 * `addLicense` - boolean, providing false will disable ae_render_only_node.txt license file auto-creation (true by default)
 * `forceCommandLinePatch` - boolean, providing true will force patch re-installation
 * `stopOnError` - boolean, stop the pick-up-and-render process if an error occurs (false by default)
+* `exitOnEmptyQueue` - boolean, stop the worker if too many empty queues are detected (false by default)
+* `tolerateEmptyQueues` - number, amount of empty queues to tolerate before exiting (defults to zero).If specified will be used instead of NEXRENDER_TOLERATE_EMPTY_QUEUES env variable
 * `polling` - number, amount of miliseconds to wait before checking queued projects from the api, if specified will be used instead of NEXRENDER_API_POLLING env variable
 * `header` - string, Define custom header that the worker will use to communicate with nexrender-server. Accepted format follows curl or wget request header definition, eg. `--header="Some-Custom-Header: myCustomValue"`.
 * `tagSelector` - string, (optional) provide the string tags (example `primary,plugins,halowell` : comma delimited) to pickup the job with specific tags. Leave it false to ignore and pick a random job from the server with no specific tags. Tags name must be an alphanumeric.

package/src/bin.js

@@ -24,7 +24,9 @@ const args = arg({
     '--cache-path':             String,
 
     '--stop-on-error':          Boolean,
-
+    '--exit-on-empty-queue':    Boolean,
+    '--tolerate-empty-queues':  Number,
+    
     '--skip-cleanup':           Boolean,
     '--skip-render':            Boolean,
     '--no-license':             Boolean,
@@ -108,6 +110,13 @@ if (args['--help']) {
     --stop-on-error                         forces worker to stop if processing/rendering error occures,
                                             otherwise worker will report an error, and continue working
 
+    --exit-on-empty-queue                   worker will exit when too many empty queues (see --tolerate-empty-queues) have been detected.
+                                            Useful when running on AWS EC2, to allow the instance to self-terminate and reduce compute costs
+
+    --tolerate-empty-queues                 worker will check an empty queue this many times before exiting (if that option has
+                                            been set using --exit-on-empty-queues). Defaults to zero. If specified will be used instead of
+                                            NEXRENDER_TOLERATE_EMPTY_QUEUES env variable
+
     --no-license                            prevents creation of the ae_render_only_node.txt file (enabled by default),
                                             which allows free usage of trial version of Adobe After Effects
 
@@ -200,6 +209,8 @@ opt('debug',                '--debug');
 opt('multiFrames',          '--multi-frames');
 opt('reuse',                '--reuse');
 opt('stopOnError',          '--stop-on-error');
+opt('tolerateEmptyQueues',  '--tolerate-empty-queues');
+opt('exitOnEmptyQueue',     '--exit-on-empty-queue');
 opt('maxMemoryPercent',     '--max-memory-percent');
 opt('imageCachePercent',    '--image-cache-percent');
 opt('polling',              '--polling');

package/src/index.js

@@ -3,6 +3,8 @@ const { init, render } = require('@nexrender/core')
 const { getRenderingStatus } = require('@nexrender/types/job')
 
 const NEXRENDER_API_POLLING = process.env.NEXRENDER_API_POLLING || 30 * 1000;
+const NEXRENDER_TOLERATE_EMPTY_QUEUES = process.env.NEXRENDER_TOLERATE_EMPTY_QUEUES;
+var emptyReturns = 0;
 
 /* TODO: possibly add support for graceful shutdown */
 let active = true;
@@ -20,8 +22,14 @@ const nextJob = async (client, settings) => {
             );
 
             if (job && job.uid) {
+                emptyReturns = 0;
                 return job
+            } else {
+                // no job was returned by the server. If enough checks have passed, and the exit option is set, deactivate the worker
+                emptyReturns++;
+                if (settings.exitOnEmptyQueue && emptyReturns > settings.tolerateEmptyQueues) active = false;
             }
+
         } catch (err) {
             if (settings.stopOnError) {
                 throw err;
@@ -32,7 +40,7 @@ const nextJob = async (client, settings) => {
             }
         }
 
-        await delay(settings.polling || NEXRENDER_API_POLLING)
+        if (active) await delay(settings.polling || NEXRENDER_API_POLLING)
     } while (active)
 }
 
@@ -52,14 +60,22 @@ const start = async (host, secret, settings, headers) => {
     if (typeof settings.tagSelector == 'string') {
         settings.tagSelector = settings.tagSelector.replace(/[^a-z0-9, ]/gi, '')
     }
-
+    // if there is no setting for how many empty queues to tolerate, make one from the
+    // environment variable, or the default (which is zero)
+    if (!(typeof settings.tolerateEmptyQueues == 'number')) {
+        settings.tolerateEmptyQueues = NEXRENDER_TOLERATE_EMPTY_QUEUES;
+    }
+    
     const client = createClient({ host, secret, headers });
 
     do {
-        let job = await nextJob(client, settings); {
-            job.state = 'started';
-            job.startedAt = new Date()
-        }
+        let job = await nextJob(client, settings);
+
+        // if the worker has been deactivated, exit this loop
+        if (!active) break;
+
+        job.state = 'started';
+        job.startedAt = new Date()
 
         try {
             await client.updateJob(job.uid, job)