@nexrender/core 1.44.1 → 1.45.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nexrender/core",
-  "version": "1.44.1",
+  "version": "1.45.5",
   "main": "src/index.js",
   "author": "Inlife",
   "homepage": "https://github.com/inlife/nexrender",
@@ -36,5 +36,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "db4b6d36c4f0daa85b022538ca654539d2ddce96"
+  "gitHead": "45cf9d9c1ba6f343474348fcbf6a7d81ac7f244d"
 }

package/src/helpers/analytics.js

@@ -37,6 +37,12 @@ const forceSyncRequest = (settings, event, properties) => {
     })
 }
 
+// cache for combined events
+let cache = {
+    job_id: null,
+    data: {},
+}
+
 /**
  * Tracking function for analytics
  *
@@ -75,9 +81,32 @@ const track = async (settings, event, properties = {}, isRemote) => {
         return forceSyncRequest(settings, event, properties)
     }
 
+    // anonymize job_id (we are doing it after the forced check,
+    // to ensure we won't be hashing the same value twice)
+    if (properties.job_id) {
+        properties.job_id = hash(properties.job_id, settings.analyticsId)
+    }
+
+    // we are not sending the event itself, but rather combining it with other events of the same type
+    // and sending it as a single event when flush is triggered
+    if (properties.combined === true) {
+        delete properties.combined
+
+        // remove any data from previous jobs
+        if (cache.job_id != properties.job_id) {
+            cache.job_id = properties.job_id
+            cache.data = {}
+        }
+
+        cache.data[event] = cache.data[event] || []
+        cache.data[event].push(properties)
+
+        return;
+    }
+
     // collect system info
     if (!settings.systemInfo) {
-        if (isRemote) console.log('collectiing systeminfo')
+        // if (isRemote) console.log('collecting systeminfo')
 
         settings.systemInfo = await si.get({
             cpu: 'manufacturer,brand,cores',
@@ -102,9 +131,45 @@ const track = async (settings, event, properties = {}, isRemote) => {
         }
     }
 
-    // anonymize job_id
-    if (properties.job_id) {
-        properties.job_id = hash(properties.job_id, settings.analyticsId)
+    if (event == 'Job Cleanup') {
+        const events = Object.keys(cache.data)
+
+        for (let i = 0; i < events.length; i++) {
+            const combinedEvent = events[i]
+            const combinedProperties = cache.data[combinedEvent]
+
+            switch (combinedEvent) {
+                case 'Asset Download':
+                    properties.assets_total = combinedProperties.length
+
+                    for (let j = 0; j < combinedProperties.length; j++) {
+                        const asset = combinedProperties[j]
+                        const byProtocol = `assets_by_protocol_${asset.asset_protocol}`
+                        const byExtension = `assets_by_extension_${asset.asset_extension}`
+                        properties[byProtocol] = (properties[byProtocol] || 0) + 1
+                        properties[byExtension] = (properties[byExtension] || 0) + 1
+                    }
+
+                    break;
+
+                case 'Asset Script Wraps':
+                    properties.assets_script_wraps = combinedProperties.length
+
+                    for (let j = 0; j < combinedProperties.length; j++) {
+                        const script = combinedProperties[j]
+                        const byType = `assets_by_type_${script.script_type}`
+                        const byComposition = `assets_by_composition_set_${script.script_composition_set ? 'true' : 'false'}`
+                        const byLayerStrategy = `assets_by_layer_strategy_${script.script_layer_strat || 'none'}`
+                        const byValueStrategy = `assets_by_value_strategy_${script.script_value_strat || 'none'}`
+                        properties[byType] = (properties[byType] || 0) + 1
+                        properties[byComposition] = (properties[byComposition] || 0) + 1
+                        properties[byLayerStrategy] = (properties[byLayerStrategy] || 0) + 1
+                        properties[byValueStrategy] = (properties[byValueStrategy] || 0) + 1
+                    }
+
+                    break;
+            }
+        }
     }
 
     const params = {
@@ -119,6 +184,8 @@ const track = async (settings, event, properties = {}, isRemote) => {
         }, properties)
     }
 
+    // console.log('tracking event:', params)
+
     analytics.capture(params);
     await analytics.flush();
 }

package/src/index.js

@@ -41,6 +41,7 @@ const init = (settings) => {
     settings = Object.assign({}, settings);
     settings.logger = settings.logger || console;
     settings.track = (...args) => track(settings, ...args);
+    settings.trackCombined = (event, params) => track(settings, event, { combined: true, ...params });
     settings.trackSync = (event, params) => track(settings, event, { forced: true, ...params })
 
     // set default process name for analytics

package/src/tasks/cleanup.js

@@ -5,6 +5,8 @@ const path = require('path')
  * Clean up all workpath files and remove folder
  */
 module.exports = function(job, settings) {
+    settings.track('Job Cleanup');
+
     if (settings.skipCleanup) {
         settings.logger.log(`[${job.uid}] skipping the clean up...`);
         return Promise.resolve(job)

package/src/tasks/download.js

@@ -48,7 +48,7 @@ const download = (job, settings, asset) => {
 
     asset.dest = path.join(job.workpath, destName);
 
-    settings.track('Job Asset Download Started', {
+    settings.trackCombined('Asset Download', {
         job_id: job.uid, // anonymized internally
         asset_type: asset.type,
         asset_protocol: protocol,
@@ -95,7 +95,8 @@ const download = (job, settings, asset) => {
 
                         asset.extension = fileExt
                         const destHasExtension = path.extname(asset.dest) ? true : false
-                        //don't do this if asset.dest already has extension else it gives you example.jpg.jpg  like file in case of  assets and aep/aepx file
+                        // don't do this if asset.dest already has extension else it gives you example.jpg.jpg
+                        // like file in case of assets and aep/aepx file
                         if (asset.extension && !destHasExtension) {
                             asset.dest += `.${fileExt}`
                         }

package/src/tasks/render.js

@@ -75,7 +75,16 @@ Estimated date of change to the new behavior: 2023-06-01.\n`);
 
     option(params, '-r', jobScriptFile);
 
-    if (!settings.skipRender && settings.multiFrames) params.push('-mfr', 'ON', settings.multiFramesCPU);
+    if (!settings.skipRender && settings.multiFrames) {
+        const afterEffects = path.dirname(settings.binary)
+        const afterEffectsYearMatch = afterEffects.match(/(20[0-9]{2})/);
+
+        if (afterEffectsYearMatch && afterEffectsYearMatch[0] >= "2022") {
+            params.push('-mfr', 'ON', settings.multiFramesCPU);
+        } else {
+            params.push('-mp');
+        }
+    }
     if (settings.reuse) params.push('-reuse');
     if (job.template.continueOnMissing) params.push('-continueOnMissingFootage')
 

package/src/tasks/script.js

@@ -432,7 +432,7 @@ module.exports = (job, settings) => {
     const base = job.workpath;
 
     job.assets.map(asset => {
-        settings.track('Job Script Asset Wrap', {
+        settings.trackCombined('Asset Script Wraps', {
             job_id: job.uid, // anonymized internally
             script_type: asset.type,
             script_compostion_set: asset.composition !== undefined,

package/test/index-mock.js

@@ -0,0 +1,28 @@
+// simple test code
+const {render} = require('../src')
+
+process.env.NEXRENDER_ENABLE_AELOG_PROJECT_FOLDER = true
+
+const job = {
+    template: {
+        src: 'data:text/plain,Hello, World!',
+        composition: 'test',
+        output: __dirname + '/index.js',
+    },
+    assets: [
+        {
+            type: 'image',
+            src: 'data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==',
+            layerName: 'test',
+        }
+    ]
+}
+
+const settings = {
+    binary: __dirname + '/aerender',
+    workpath: __dirname + '/workpath',
+}
+
+render(job, settings)
+    .then(() => console.log('rendered successfully'))
+    .catch(console.error)

package/test/index.js

@@ -1,28 +1,2 @@
-// simple test code
-const {render} = require('../src')
-
-process.env.NEXRENDER_ENABLE_AELOG_PROJECT_FOLDER = true
-
-const job = {
-    template: {
-        src: 'data:text/plain,Hello, World!',
-        composition: 'test',
-        output: __dirname + '/index.js',
-    },
-    assets: [
-        {
-            type: 'image',
-            src: 'data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==',
-            layerName: 'test',
-        }
-    ]
-}
-
-const settings = {
-    binary: __dirname + '/aerender',
-    workpath: __dirname + '/workpath',
-}
-
-render(job, settings)
-    .then(() => console.log('rendered successfully'))
-    .catch(console.error)
+// simple syntax test
+require('../src')

package/test/workpath/7LyC6arUCXaJkBo7IORV-/aerender.log

@@ -0,0 +1,4 @@
+imitating rendering with aerender :p
+rendering... 0%
+rendering... 50%
+rendering... 100%

package/test/workpath/7LyC6arUCXaJkBo7IORV-/nexrender-7LyC6arUCXaJkBo7IORV--script.jsx

@@ -0,0 +1,259 @@
+
+try{Object.defineProperty({},'a',{value:0})}catch(err){(function(){var defineProperty=Object.defineProperty;Object.defineProperty=function(object,property,descriptor){delete descriptor.configurable;delete descriptor.enumerable;delete descriptor.writable;try{return defineProperty(object,property,descriptor)}catch(err){object[property]=descriptor.value}}}())}Object.defineProperties||(Object.defineProperties=function defineProperties(object,descriptors){var property;for(property in descriptors){Object.defineProperty(object,property,descriptors[property])}return object});var lambda=function(l){var fn=l.match(/((.*))s*=>s*(.*)/);var p=[];var b="";if(fn.length>0){fn.shift()}if(fn.length>0){b=fn.pop()}if(fn.length>0){p=fn.pop().replace(/^s*|s(?=s)|s*$|,/g,'').split(' ')}fn=((!/s*returns+/.test(b))?"return ":"")+b;p.push(fn);try{return Function.apply({},p)}catch(e){return null}};if(typeof(Array.prototype.where)==='undefined'){Array.prototype.where=function(f){var fn=f;if(typeof f=="string"){if((fn=lambda(fn))===null){throw "Syntax error in lambda string: "+f}}var res=[];var l=this.length;var p=[0,0,res];for(var i=1;i<arguments.length;i+=1){p.push(arguments[i])}for(var j=0;j<l;j+=1){if(typeof this[j]=="undefined"){continue}p[0]=this[j];p[1]=j;if(!!fn.apply(this,p)){res.push(this[j])}}return res}}if(!Array.prototype.forEach){Array.prototype.forEach=function(callback,thisArg){var T,k;if(this===null){throw new TypeError(' this is null or not defined')}var O=Object(this);var len=O.length>>>0;if(typeof callback!=="function"){throw new TypeError(callback+' is not a function')}if(arguments.length>1){T=thisArg}k=0;while(k<len){var kValue;if(k in O){kValue=O[k];callback.call(T,kValue,k,O)}k+=1}}}if(!Array.prototype.filter){Array.prototype.filter=function(fun ){'use strict';if(this===void 0||this===null){throw new TypeError()}var t=Object(this);var len=t.length>>>0;if(typeof fun!=='function'){throw new TypeError()}var res=[];var thisArg=arguments.length>=2?arguments[1]:void 0;for(var i=0;i<len;i+=1){if(i in t){var val=t[i];if(fun.call(thisArg,val,i,t)){res.push(val)}}}return res}}if(!Array.prototype.indexOf){Array.prototype.indexOf=function(searchElement,fromIndex){var k;if(this===null){throw new TypeError('"this" is null or not defined')}var O=Object(this);var len=O.length>>>0;if(len===0){return -1}var n= +fromIndex||0;if(Math.abs(n)===Infinity){n=0}if(n>=len){return -1}k=Math.max(n>=0?n:len-Math.abs(n),0);while(k<len){var kValue;if(k in O&&O[k]===searchElement){return k}k+=1}return -1}}if(typeof(String.prototype.localeCompare)==='undefined'){String.prototype.localeCompare=function(str,locale,options){return((this==str)?0:((this>str)?1:-1))}}
+(function(){function r(e,n,t){function o(i,f){if(!n[i]){if(!e[i]){var c="function"==typeof require&&require;if(!f&&c)return c(i,!0);if(u)return u(i,!0);var a=new Error("Cannot find module '"+i+"'");throw a.code="MODULE_NOT_FOUND",a}var p=n[i]={exports:{}};e[i][0].call(p.exports,function(r){var n=e[i][1][r];return o(n||r)},p,p.exports,r,e,n,t)}return n[i].exports}for(var u="function"==typeof require&&require,i=0;i<t.length;i++)o(t[i]);return o}return r})()({1:[function(require,module,exports){
+"use strict";
+
+/* start of nexrender script */
+
+var nexrender = {
+    renderCompositionName: 'test',
+    defaultCompositionName: '*',
+    types: [CompItem, FolderItem, FootageItem, AVLayer, ShapeLayer, TextLayer, CameraLayer, LightLayer, Property, PropertyGroup],
+};
+
+nexrender.typesMatch = function (types, layer) {
+    return nexrender.types.filter(function (t) {
+        return layer instanceof t;
+    }).length > 0;
+};
+
+nexrender.replaceFootage = function (layer, filepath) {
+    if (!layer) { return false; }
+
+    var file = new File(filepath);
+
+    if (!file.exists) {
+        throw new Error("nexrender: Trying to create a file replacement for an unknown file: " + filepath);
+    }
+
+    var importOptions = new ImportOptions(file);
+    //importOptions.importAs = ImportAsType.COMP; // you can do stuff like this at this point for PSDs
+    var theImport = app.project.importFile(importOptions);
+    layer.replaceSource(theImport, true);
+
+    return true;
+};
+
+/* invoke callback for every composition matching specific name */
+nexrender.selectCompositionsByName = function(name, callback) {
+    var items = [];
+    var nameChain = name.split("->");
+    var name = nameChain.pop();
+
+    function isNestedComp(comp, name, parentChain) {
+        if (
+          name &&
+          comp.name === name &&
+          parentChain &&
+          parentChain.length > 0 &&
+          comp.usedIn.length > 0
+        ) {
+          var parentComp = null;
+          for (var i = 0; i < comp.usedIn.length; i++) {
+            if (
+              comp.usedIn[i] instanceof CompItem &&
+              comp.usedIn[i].name === parentChain[parentChain.length - 1]
+            ) {
+              parentComp = comp.usedIn[i];
+              break;
+            }
+          }
+
+          if (parentComp) {
+            if (parentChain.length === 1) {
+              return true;
+            } else {
+              return isNestedComp(
+                parentComp,
+                parentChain.pop(),
+                parentChain
+              );
+            }
+          }
+        }
+        return false;
+    }
+
+    /* step 1: collect all matching compositions */
+    var len = app.project.items.length;
+    for (var i = 1; i <= len; i++) {
+        var item = app.project.items[i];
+        if (!(item instanceof CompItem)) continue;
+
+        if (name !== "*" && item.name !== name) {
+            continue;
+        } else if (nameChain.length === 0) { // if the comp name wasn't hierarchical
+            items.push(item);
+        } else if (isNestedComp(item, name, nameChain)) { // otherwise only add the comp if it matches the hierarchical position defined in the comp name
+            items.push(item);
+        } else {
+            continue;
+        }
+    }
+
+    /* step 2: invoke callback for every match */
+    var len = items.length;
+    for (var i = 0; i < len; i++) {
+        callback(items[i]);
+    }
+
+    if (len == 0) {
+        throw new Error("nexrender: Couldn't find any compositions by provided name (" + name + ")");
+    }
+};
+
+/* call callback for an every layer matching specific name and composition */
+nexrender.selectLayersByName = function(compositionName, name, callback, types, continueOnMissing) {
+    var foundOnce = false;
+
+    if (!compositionName) compositionName = nexrender.defaultCompositionName;
+    if (!types) types = nexrender.types;
+
+    nexrender.selectCompositionsByName(compositionName, function(comp) {
+        var items = [];
+
+        /* step 1: collect all matching layers */
+        for (var j = 1; j <= comp.numLayers; j++) {
+            var layer = comp.layer(j);
+            if (layer.name !== name) continue;
+
+            if (nexrender.typesMatch(types, layer)) {
+                foundOnce = true;
+                items.push(layer);
+            }
+        }
+
+        /* step 2: invoke callback for every match */
+        var len = items.length;
+        for (var i = 0; i < len; i++) {
+            callback(items[i], name);
+        }
+    });
+
+    if (!foundOnce && !continueOnMissing) {
+        throw new Error("nexrender: Couldn't find any layers by provided name (" + name + ") inside a composition: " + compositionName);
+    }
+};
+
+/* call callback for every layer matching specific type and composition */
+nexrender.selectLayersByType = function(
+  compositionName,
+  type,
+  callback,
+  types,
+  continueOnMissing
+) {
+  var foundOnce = false;
+
+  if (!compositionName) compositionName = nexrender.defaultCompositionName;
+  if (!types) types = nexrender.types;
+
+  nexrender.selectCompositionsByName(compositionName, function(comp) {
+    var items = [];
+
+    /* step 1: collect all matching layers */
+    for (var j = 1; j <= comp.numLayers; j++) {
+      var layer = comp.layer(j);
+
+      if (!(layer instanceof type)) continue;
+
+      if (nexrender.typesMatch(types, layer)) {
+        foundOnce = true;
+        items.push(layer);
+      }
+    }
+
+    /* step 2: invoke callback for every match */
+    var len = items.length;
+    for (var i = 0; i < len; i++) {
+      callback(items[i]);
+    }
+  });
+
+  if (!foundOnce && !continueOnMissing) {
+    throw new Error( 
+      "nexrender: Couldn't find any layers by provided type (" 
+      + type +
+      ") inside a composition: " 
+      + compositionName
+    ); 
+  }
+};
+
+/* call callback for an every layer matching specific index and composition */
+nexrender.selectLayersByIndex = function(compositionName, index, callback, types, continueOnMissing) {
+    var foundOnce = false;
+
+    if (!compositionName) compositionName = nexrender.defaultCompositionName;
+    if (!types) types = nexrender.types;
+
+    nexrender.selectCompositionsByName(compositionName, function(comp) {
+        var layer = comp.layer(index)
+        if (layer) {
+            callback(layer, index);
+            foundOnce = true;
+        }
+    })
+
+    if (!foundOnce && !continueOnMissing) {
+        throw new Error("nexrender: Couldn't find any layers by provided index (" + index + ") inside a composition: " + compositionName);
+    }
+};
+
+/* ensure that eval only gets a minimal variable scope */
+nexrender.evaluate = function (layer, expression) {
+    return eval(expression);
+}
+
+nexrender.changeValueForKeypath = function (layer, keys, val) {
+    function change(o, keys, val) {
+        if (keys.length == 0) {
+            val.changed = false;
+            return val;
+        } else {
+            var key = keys[0];
+            if ("property" in o && o.property(key)) {
+                var prop = o.property(key)
+                if ("value" in prop) {
+                    var pval = prop.value;
+                    var v = change(pval, keys.slice(1), val)
+                    if ("value" in v) {
+                        prop.setValue(v.value)
+                    } else {
+                        prop.expression = v.expression
+                    }
+                } else {
+                    change(prop, keys.slice(1), val)
+                }
+                return { "value": o, "changed": true };
+            } else if (key in o) {
+                var v = change(o[key], keys.slice(1), val)
+                if (!v.changed) {
+                    if ("value" in v) {
+                        o[key] = v.value;
+                    } else {
+                        o[key] = nexrender.evaluate(layer, v.expression)
+                    }
+                }
+                return { "value": o, "changed": true };
+            } else {
+                throw new Error("nexrender: Can't find a property sequence " + keys.join('.') + " for key: " + key + "within layer: " + layer.name);
+            }
+        }
+    }
+    change(layer, keys, val);
+};
+
+
+/* end of nexrender script */
+/* start of custom user script */
+
+(function() {
+    nexrender.selectLayersByName(null, 'test', function(layer) {
+        nexrender.replaceFootage(layer, '/Users/inlife/Projects/nexrender/packages/nexrender-core/test/workpath/7LyC6arUCXaJkBo7IORV-/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==.png')
+    }, null, undefined);
+})();
+
+
+/* end of custom user script */
+},{}]},{},[1]);

package/test/workpath/7LyC6arUCXaJkBo7IORV-/shuo3xcefe8.txt

@@ -0,0 +1 @@
+Hello, World!

package/test/workpath/8jeh3u9dpLHjoGpI6rjx2/aerender.log

@@ -0,0 +1,4 @@
+imitating rendering with aerender :p
+rendering... 0%
+rendering... 50%
+rendering... 100%