@nexrender/worker 1.43.3 → 1.44.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nexrender/worker",
-  "version": "1.43.3",
+  "version": "1.44.0",
   "author": "inlife",
   "main": "src/index.js",
   "scripts": {
@@ -17,7 +17,7 @@
   },
   "dependencies": {
     "@nexrender/api": "^1.43.1",
-    "@nexrender/core": "^1.43.3",
+    "@nexrender/core": "^1.44.0",
     "@nexrender/types": "^1.43.1",
     "arg": "^4.1.0",
     "chalk": "^2.4.2",
@@ -26,5 +26,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "9f836119c0636690b8ab32f73e4fb6919ae484f5"
+  "gitHead": "10534b5ae73c920a6ea3c5cc7c3d6ac542112319"
 }

package/readme.md

@@ -88,6 +88,7 @@ Available settings (almost same as for `nexrender-core`):
 * `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.
 * `wslMap` - string, drive letter of your WSL mapping in Windows
 * `aeParams` - array of strings, any additional params that will be passed to the aerender binary, a name-value parameter pair separated by a space,
+* `noAnalytics` - boolean, enables or disables built-in fully-anonymous analytics, false by default
 * `actions` - an object with keys corresponding to the `module` field when defining an action, value should be a function matching expected signature of an action. Used for defining actions programmatically without needing to package the action as a separate package
 * `cache` - boolean or string. Set the cache folder used by HTTP assets. If `true` will use the default path of `${workpath}/http-cache`, if set to a string it will be interpreted as a filesystem path to the cache folder.
 

package/src/bin.js

@@ -30,6 +30,7 @@ const args = arg({
     '--skip-cleanup':           Boolean,
     '--skip-render':            Boolean,
     '--no-license':             Boolean,
+    '--no-analytics':           Boolean,
     '--force-patch':            Boolean,
     '--debug':                  Boolean,
     '--multi-frames':           Boolean,
@@ -120,6 +121,9 @@ if (args['--help']) {
     --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
 
+    --no-analytics                          prevents collection of fully anonymous analytics by nexrender (enabled by default),
+                                            this data is used to improve nexrender and its features, read on what is collected in the readme
+
     --force-patch                           forces commandLineRenderer.jsx patch (re)installation
 
     --debug                                 enables command dump for aerender, and other debugging stuff
@@ -198,6 +202,7 @@ if (settings.hasOwnProperty('ae-params')) {
 opt('binary',               '--binary');
 opt('workpath',             '--workpath');
 opt('no-license',           '--no-license');
+opt('no-analytics',         '--no-analytics');
 opt('skipCleanup',          '--skip-cleanup');
 opt('skipRender',           '--skip-render');
 opt('forceCommandLinePatch','--force-patch');
@@ -247,6 +252,13 @@ if (settings['no-license']) {
     settings.addLicense = true;
 }
 
+if (settings['no-analytics']) {
+    settings.noAnalytics = true;
+    delete settings['no-analytics'];
+}
+
+settings['process'] = 'nexrender-worker-cli';
+
 const headers = {};
 if (args['--header']){
     args['--header'].forEach((header) => {

package/src/index.js

@@ -53,7 +53,7 @@ const nextJob = async (client, settings) => {
  * @return {Promise}
  */
 const start = async (host, secret, settings, headers) => {
-    settings = init(Object.assign({}, settings, {
+    settings = init(Object.assign({ process: 'nexrender-worker' }, settings, {
         logger: console,
     }))
 
@@ -73,12 +73,24 @@ const start = async (host, secret, settings, headers) => {
 
     const client = createClient({ host, secret, headers });
 
+    settings.track('Worker Started', {
+        worker_tags_set: !!settings.tagSelector,
+        worker_setting_tolerate_empty_queues: settings.tolerateEmptyQueues,
+        worker_setting_exit_on_empty_queue: settings.exitOnEmptyQueue,
+        worker_setting_polling: settings.polling,
+        worker_setting_stop_on_error: settings.stopOnError,
+    })
+
     do {
         let job = await nextJob(client, settings);
 
         // if the worker has been deactivated, exit this loop
         if (!active) break;
 
+        settings.track('Worker Job Started', {
+            job_id: job.uid, // anonymized internally
+        })
+
         job.state = 'started';
         job.startedAt = new Date()
 
@@ -115,12 +127,16 @@ const start = async (host, secret, settings, headers) => {
                 job.finishedAt = new Date()
             }
 
+            settings.track('Worker Job Finished', { job_id: job.uid })
+
             await client.updateJob(job.uid, getRenderingStatus(job))
         } catch (err) {
             job.error = [].concat(job.error || [], [err.toString()]);
             job.errorAt = new Date();
             job.state = 'error';
 
+            settings.track('Worker Job Error', { job_id: job.uid })
+
             await client.updateJob(job.uid, getRenderingStatus(job)).catch((err) => {
                 if (settings.stopOnError) {
                     throw err;